blob: 242287ca9b930c6a33a8bd9b523b8b48d22da856 [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
Ashish Kumar11234062017-08-11 11:09:14 +0530315- ARM Platform Bus Type(CCI):
316 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
317 provides full cache coherency between two clusters of multi-core
318 CPUs and I/O coherency for devices and I/O masters
319
320 CONFIG_SYS_FSL_HAS_CCI400
321
322 Defined For SoC that has cache coherent interconnect
323 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000324
Ashish Kumar97393d62017-08-18 10:54:36 +0530325 CONFIG_SYS_FSL_HAS_CCN504
326
327 Defined for SoC that has cache coherent interconnect CCN-504
328
wdenkc6097192002-11-03 00:24:07 +0000329The following options need to be configured:
330
Kim Phillips203fee32007-08-10 13:28:25 -0500331- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000332
Kim Phillips203fee32007-08-10 13:28:25 -0500333- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200334
Lei Wen20014762011-02-09 18:06:58 +0530335- Marvell Family Member
336 CONFIG_SYS_MVFS - define it if you want to enable
337 multiple fs option at one time
338 for marvell soc family
339
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600340- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000341 CONFIG_SYS_PPC64
342
343 Specifies that the core is a 64-bit PowerPC implementation (implements
344 the "64" category of the Power ISA). This is necessary for ePAPR
345 compliance, among other possible reasons.
346
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600347 CONFIG_SYS_FSL_TBCLK_DIV
348
349 Defines the core time base clock divider ratio compared to the
350 system clock. On most PQ3 devices this is 8, on newer QorIQ
351 devices it can be 16 or 32. The ratio varies from SoC to Soc.
352
Kumar Gala179b1b22011-05-20 00:39:21 -0500353 CONFIG_SYS_FSL_PCIE_COMPAT
354
355 Defines the string to utilize when trying to match PCIe device
356 tree nodes for the given platform.
357
Scott Wood80806962012-08-14 10:14:53 +0000358 CONFIG_SYS_FSL_ERRATUM_A004510
359
360 Enables a workaround for erratum A004510. If set,
361 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
362 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
363
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
366
367 Defines one or two SoC revisions (low 8 bits of SVR)
368 for which the A004510 workaround should be applied.
369
370 The rest of SVR is either not relevant to the decision
371 of whether the erratum is present (e.g. p2040 versus
372 p2041) or is implied by the build target, which controls
373 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
374
375 See Freescale App Note 4493 for more information about
376 this erratum.
377
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530378 CONFIG_A003399_NOR_WORKAROUND
379 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800380 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530381
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530382 CONFIG_A008044_WORKAROUND
383 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800384 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530385
Scott Wood80806962012-08-14 10:14:53 +0000386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
387
388 This is the value to write into CCSR offset 0x18600
389 according to the A004510 workaround.
390
Priyanka Jainc73b9032013-07-02 09:21:04 +0530391 CONFIG_SYS_FSL_DSP_DDR_ADDR
392 This value denotes start offset of DDR memory which is
393 connected exclusively to the DSP cores.
394
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530395 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
396 This value denotes start offset of M2 memory
397 which is directly connected to the DSP core.
398
Priyanka Jainc73b9032013-07-02 09:21:04 +0530399 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
400 This value denotes start offset of M3 memory which is directly
401 connected to the DSP core.
402
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530403 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
404 This value denotes start offset of DSP CCSR space.
405
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530406 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
407 Single Source Clock is clocking mode present in some of FSL SoC's.
408 In this mode, a single differential clock is used to supply
409 clocks to the sysclock, ddrclock and usbclock.
410
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530411 CONFIG_SYS_CPC_REINIT_F
412 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800413 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530414
Tang Yuantiana7364af2014-04-17 15:33:46 +0800415 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800416 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800417 supported, core will start to execute uboot when wakes up.
418
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000419- Generic CPU options:
420 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
421
422 Defines the endianess of the CPU. Implementation of those
423 values is arch specific.
424
York Sunf0626592013-09-30 09:22:09 -0700425 CONFIG_SYS_FSL_DDR
426 Freescale DDR driver in use. This type of DDR controller is
427 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
428 SoCs.
429
430 CONFIG_SYS_FSL_DDR_ADDR
431 Freescale DDR memory-mapped register base.
432
433 CONFIG_SYS_FSL_DDR_EMU
434 Specify emulator support for DDR. Some DDR features such as
435 deskew training are not available.
436
437 CONFIG_SYS_FSL_DDRC_GEN1
438 Freescale DDR1 controller.
439
440 CONFIG_SYS_FSL_DDRC_GEN2
441 Freescale DDR2 controller.
442
443 CONFIG_SYS_FSL_DDRC_GEN3
444 Freescale DDR3 controller.
445
York Sun2896cb72014-03-27 17:54:47 -0700446 CONFIG_SYS_FSL_DDRC_GEN4
447 Freescale DDR4 controller.
448
York Sun461c9392013-09-30 14:20:51 -0700449 CONFIG_SYS_FSL_DDRC_ARM_GEN3
450 Freescale DDR3 controller for ARM-based SoCs.
451
York Sunf0626592013-09-30 09:22:09 -0700452 CONFIG_SYS_FSL_DDR1
453 Board config to use DDR1. It can be enabled for SoCs with
454 Freescale DDR1 or DDR2 controllers, depending on the board
455 implemetation.
456
457 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400458 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700459 Freescale DDR2 or DDR3 controllers, depending on the board
460 implementation.
461
462 CONFIG_SYS_FSL_DDR3
463 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700464 Freescale DDR3 or DDR3L controllers.
465
466 CONFIG_SYS_FSL_DDR3L
467 Board config to use DDR3L. It can be enabled for SoCs with
468 DDR3L controllers.
469
470 CONFIG_SYS_FSL_DDR4
471 Board config to use DDR4. It can be enabled for SoCs with
472 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700473
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530474 CONFIG_SYS_FSL_IFC_BE
475 Defines the IFC controller register space as Big Endian
476
477 CONFIG_SYS_FSL_IFC_LE
478 Defines the IFC controller register space as Little Endian
479
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530480 CONFIG_SYS_FSL_IFC_CLK_DIV
481 Defines divider of platform clock(clock input to IFC controller).
482
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530483 CONFIG_SYS_FSL_LBC_CLK_DIV
484 Defines divider of platform clock(clock input to eLBC controller).
485
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530486 CONFIG_SYS_FSL_PBL_PBI
487 It enables addition of RCW (Power on reset configuration) in built image.
488 Please refer doc/README.pblimage for more details
489
490 CONFIG_SYS_FSL_PBL_RCW
491 It adds PBI(pre-boot instructions) commands in u-boot build image.
492 PBI commands can be used to configure SoC before it starts the execution.
493 Please refer doc/README.pblimage for more details
494
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530495 CONFIG_SPL_FSL_PBL
496 It adds a target to create boot binary having SPL binary in PBI format
497 concatenated with u-boot binary.
498
York Sun29647ab2014-02-10 13:59:42 -0800499 CONFIG_SYS_FSL_DDR_BE
500 Defines the DDR controller register space as Big Endian
501
502 CONFIG_SYS_FSL_DDR_LE
503 Defines the DDR controller register space as Little Endian
504
York Sun3a0916d2014-02-10 13:59:43 -0800505 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
506 Physical address from the view of DDR controllers. It is the
507 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
508 it could be different for ARM SoCs.
509
York Sunc459ae62014-02-10 13:59:44 -0800510 CONFIG_SYS_FSL_DDR_INTLV_256B
511 DDR controller interleaving on 256-byte. This is a special
512 interleaving mode, handled by Dickens for Freescale layerscape
513 SoCs with ARM core.
514
York Sun79a779b2014-08-01 15:51:00 -0700515 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
516 Number of controllers used as main memory.
517
518 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
519 Number of controllers used for other than main memory.
520
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530521 CONFIG_SYS_FSL_HAS_DP_DDR
522 Defines the SoC has DP-DDR used for DPAA.
523
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530524 CONFIG_SYS_FSL_SEC_BE
525 Defines the SEC controller register space as Big Endian
526
527 CONFIG_SYS_FSL_SEC_LE
528 Defines the SEC controller register space as Little Endian
529
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200530- MIPS CPU options:
531 CONFIG_SYS_INIT_SP_OFFSET
532
533 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
534 pointer. This is needed for the temporary stack before
535 relocation.
536
537 CONFIG_SYS_MIPS_CACHE_MODE
538
539 Cache operation mode for the MIPS CPU.
540 See also arch/mips/include/asm/mipsregs.h.
541 Possible values are:
542 CONF_CM_CACHABLE_NO_WA
543 CONF_CM_CACHABLE_WA
544 CONF_CM_UNCACHED
545 CONF_CM_CACHABLE_NONCOHERENT
546 CONF_CM_CACHABLE_CE
547 CONF_CM_CACHABLE_COW
548 CONF_CM_CACHABLE_CUW
549 CONF_CM_CACHABLE_ACCELERATED
550
551 CONFIG_SYS_XWAY_EBU_BOOTCFG
552
553 Special option for Lantiq XWAY SoCs for booting from NOR flash.
554 See also arch/mips/cpu/mips32/start.S.
555
556 CONFIG_XWAY_SWAP_BYTES
557
558 Enable compilation of tools/xway-swap-bytes needed for Lantiq
559 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
560 be swapped if a flash programmer is used.
561
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000562- ARM options:
563 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
564
565 Select high exception vectors of the ARM core, e.g., do not
566 clear the V bit of the c1 register of CP15.
567
York Sun77a10972015-03-20 19:28:08 -0700568 COUNTER_FREQUENCY
569 Generic timer clock source frequency.
570
571 COUNTER_FREQUENCY_REAL
572 Generic timer clock source frequency if the real clock is
573 different from COUNTER_FREQUENCY, and can only be determined
574 at run time.
575
Stephen Warren8d1fb312015-01-19 16:25:52 -0700576- Tegra SoC options:
577 CONFIG_TEGRA_SUPPORT_NON_SECURE
578
579 Support executing U-Boot in non-secure (NS) mode. Certain
580 impossible actions will be skipped if the CPU is in NS mode,
581 such as ARM architectural timer initialization.
582
wdenk9b7f3842003-10-09 20:09:04 +0000583- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000584 CONFIG_CLOCKS_IN_MHZ
585
586 U-Boot stores all clock information in Hz
587 internally. For binary compatibility with older Linux
588 kernels (which expect the clocks passed in the
589 bd_info data to be in MHz) the environment variable
590 "clocks_in_mhz" can be defined so that U-Boot
591 converts clock data to MHZ before passing it to the
592 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000593 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100594 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000595 default environment.
596
wdenk9b7f3842003-10-09 20:09:04 +0000597 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
598
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800599 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000600 expect it to be in bytes, others in MB.
601 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
602
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400603 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200604
605 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400606 passed using flattened device trees (based on open firmware
607 concepts).
608
609 CONFIG_OF_LIBFDT
610 * New libfdt-based support
611 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500612 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400613
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200614 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600615 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200616
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200617 boards with QUICC Engines require OF_QE to set UCC MAC
618 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500619
Kumar Gala1e26aa52006-01-11 13:54:17 -0600620 CONFIG_OF_BOARD_SETUP
621
622 Board code has addition modification that it wants to make
623 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000624
Simon Glass6c0be912014-10-23 18:58:54 -0600625 CONFIG_OF_SYSTEM_SETUP
626
627 Other code has addition modification that it wants to make
628 to the flat device tree before handing it off to the kernel.
629 This causes ft_system_setup() to be called before booting
630 the kernel.
631
Heiko Schocherffb293a2009-09-23 07:56:08 +0200632 CONFIG_OF_IDE_FIXUP
633
634 U-Boot can detect if an IDE device is present or not.
635 If not, and this new config option is activated, U-Boot
636 removes the ATA node from the DTS before booting Linux,
637 so the Linux IDE driver does not probe the device and
638 crash. This is needed for buggy hardware (uc101) where
639 no pull down resistor is connected to the signal IDE5V_DD7.
640
Igor Grinberg06890672011-07-14 05:45:07 +0000641 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
642
643 This setting is mandatory for all boards that have only one
644 machine type and must be used to specify the machine type
645 number as it appears in the ARM machine registry
646 (see http://www.arm.linux.org.uk/developer/machines/).
647 Only boards that have multiple machine types supported
648 in a single configuration file and the machine type is
649 runtime discoverable, do not have to use this setting.
650
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100651- vxWorks boot parameters:
652
653 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700654 environments variables: bootdev, bootfile, ipaddr, netmask,
655 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100656 It loads the vxWorks image pointed bootfile.
657
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100658 Note: If a "bootargs" environment is defined, it will overwride
659 the defaults discussed just above.
660
Aneesh V960f5c02011-06-16 23:30:47 +0000661- Cache Configuration:
662 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
663 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
664 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
665
Aneesh V686a0752011-06-16 23:30:51 +0000666- Cache Configuration for ARM:
667 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
668 controller
669 CONFIG_SYS_PL310_BASE - Physical base address of PL310
670 controller register space
671
wdenkda04a8b2004-08-02 23:22:59 +0000672- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200673 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000674
675 Define this if you want support for Amba PrimeCell PL010 UARTs.
676
Andreas Engel0813b122008-09-08 14:30:53 +0200677 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000678
679 Define this if you want support for Amba PrimeCell PL011 UARTs.
680
681 CONFIG_PL011_CLOCK
682
683 If you have Amba PrimeCell PL011 UARTs, set this variable to
684 the clock speed of the UARTs.
685
686 CONFIG_PL01x_PORTS
687
688 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
689 define this to a list of base addresses for each (supported)
690 port. See e.g. include/configs/versatile.h
691
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400692 CONFIG_SERIAL_HW_FLOW_CONTROL
693
694 Define this variable to enable hw flow control in serial driver.
695 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000696
wdenkc6097192002-11-03 00:24:07 +0000697- Console Baudrate:
698 CONFIG_BAUDRATE - in bps
699 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200700 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000701
wdenkc6097192002-11-03 00:24:07 +0000702- Autoboot Command:
703 CONFIG_BOOTCOMMAND
704 Only needed when CONFIG_BOOTDELAY is enabled;
705 define a command string that is automatically executed
706 when no character is read on the console interface
707 within "Boot Delay" after reset.
708
wdenkc6097192002-11-03 00:24:07 +0000709 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000710 The value of these goes into the environment as
711 "ramboot" and "nfsboot" respectively, and can be used
712 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200713 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000714
Heiko Schocher040c5c32013-11-04 14:04:59 +0100715- Bootcount:
716 CONFIG_BOOTCOUNT_LIMIT
717 Implements a mechanism for detecting a repeating reboot
718 cycle, see:
719 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
720
721 CONFIG_BOOTCOUNT_ENV
722 If no softreset save registers are found on the hardware
723 "bootcount" is stored in the environment. To prevent a
724 saveenv on all reboots, the environment variable
725 "upgrade_available" is used. If "upgrade_available" is
726 0, "bootcount" is always 0, if "upgrade_available" is
727 1 "bootcount" is incremented in the environment.
728 So the Userspace Applikation must set the "upgrade_available"
729 and "bootcount" variable to 0, if a boot was successfully.
730
wdenkc6097192002-11-03 00:24:07 +0000731- Pre-Boot Commands:
732 CONFIG_PREBOOT
733
734 When this option is #defined, the existence of the
735 environment variable "preboot" will be checked
736 immediately before starting the CONFIG_BOOTDELAY
737 countdown and/or running the auto-boot command resp.
738 entering interactive mode.
739
740 This feature is especially useful when "preboot" is
741 automatically generated or modified. For an example
742 see the LWMON board specific code: here "preboot" is
743 modified when the user holds down a certain
744 combination of keys on the (special) keyboard when
745 booting the systems
746
747- Serial Download Echo Mode:
748 CONFIG_LOADS_ECHO
749 If defined to 1, all characters received during a
750 serial download (using the "loads" command) are
751 echoed back. This might be needed by some terminal
752 emulations (like "cu"), but may as well just take
753 time on others. This setting #define's the initial
754 value of the "loads_echo" environment variable.
755
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500756- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000757 CONFIG_KGDB_BAUDRATE
758 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200759 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000760
Simon Glassaa34ef22016-03-13 19:07:28 -0600761- Removal of commands
762 If no commands are needed to boot, you can disable
763 CONFIG_CMDLINE to remove them. In this case, the command line
764 will not be available, and when U-Boot wants to execute the
765 boot command (on start-up) it will call board_run_command()
766 instead. This can reduce image size significantly for very
767 simple boot procedures.
768
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000769- Regular expression support:
770 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200771 If this variable is defined, U-Boot is linked against
772 the SLRE (Super Light Regular Expression) library,
773 which adds regex support to some commands, as for
774 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000775
Simon Glass3d686442011-10-15 05:48:20 +0000776- Device tree:
777 CONFIG_OF_CONTROL
778 If this variable is defined, U-Boot will use a device tree
779 to configure its devices, instead of relying on statically
780 compiled #defines in the board file. This option is
781 experimental and only available on a few boards. The device
782 tree is available in the global data as gd->fdt_blob.
783
Simon Glass5cb34db2011-10-24 19:15:31 +0000784 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700785 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000786
787 CONFIG_OF_EMBED
788 If this variable is defined, U-Boot will embed a device tree
789 binary in its image. This device tree file should be in the
790 board directory and called <soc>-<board>.dts. The binary file
791 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900792 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000793
Simon Glass5cb34db2011-10-24 19:15:31 +0000794 CONFIG_OF_SEPARATE
795 If this variable is defined, U-Boot will build a device tree
796 binary. It will be called u-boot.dtb. Architecture-specific
797 code will locate it at run-time. Generally this works by:
798
799 cat u-boot.bin u-boot.dtb >image.bin
800
801 and in fact, U-Boot does this for you, creating a file called
802 u-boot-dtb.bin which is useful in the common case. You can
803 still use the individual files if you need something more
804 exotic.
805
Alex Deymo5b661ec2017-04-02 01:25:20 -0700806 CONFIG_OF_BOARD
807 If this variable is defined, U-Boot will use the device tree
808 provided by the board at runtime instead of embedding one with
809 the image. Only boards defining board_fdt_blob_setup() support
810 this option (see include/fdtdec.h file).
811
wdenkc6097192002-11-03 00:24:07 +0000812- Watchdog:
813 CONFIG_WATCHDOG
814 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000815 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200816 specific code for a watchdog. For the 8xx
817 CPUs, the SIU Watchdog feature is enabled in the SYPCR
818 register. When supported for a specific SoC is
819 available, then no further board specific code should
820 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000821
822 CONFIG_HW_WATCHDOG
823 When using a watchdog circuitry external to the used
824 SoC, then define this variable and provide board
825 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000826
Heiko Schocher735326c2015-01-21 08:38:22 +0100827 CONFIG_AT91_HW_WDT_TIMEOUT
828 specify the timeout in seconds. default 2 seconds.
829
stroeseb9c17c52003-04-04 15:53:41 +0000830- U-Boot Version:
831 CONFIG_VERSION_VARIABLE
832 If this variable is defined, an environment variable
833 named "ver" is created by U-Boot showing the U-Boot
834 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200835 Any change to this variable will be reverted at the
836 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000837
wdenkc6097192002-11-03 00:24:07 +0000838- Real-Time Clock:
839
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500840 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000841 has to be selected, too. Define exactly one of the
842 following options:
843
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000845 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000847 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000848 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000849 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200850 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000851 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100852 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000853 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200854 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200855 CONFIG_SYS_RV3029_TCR - enable trickle charger on
856 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000857
wdenkb9bbd242003-06-30 16:24:52 +0000858 Note that if the RTC uses I2C, then the I2C interface
859 must also be configured. See I2C Support, below.
860
Peter Tyser9902e422008-12-17 16:36:21 -0600861- GPIO Support:
862 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600863
Chris Packham9b383202010-12-19 10:12:13 +0000864 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
865 chip-ngpio pairs that tell the PCA953X driver the number of
866 pins supported by a particular chip.
867
Peter Tyser9902e422008-12-17 16:36:21 -0600868 Note that if the GPIO device uses I2C, then the I2C interface
869 must also be configured. See I2C Support, below.
870
Simon Glass4dc47ca2014-06-11 23:29:41 -0600871- I/O tracing:
872 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
873 accesses and can checksum them or write a list of them out
874 to memory. See the 'iotrace' command for details. This is
875 useful for testing device drivers since it can confirm that
876 the driver behaves the same way before and after a code
877 change. Currently this is supported on sandbox and arm. To
878 add support for your architecture, add '#include <iotrace.h>'
879 to the bottom of arch/<arch>/include/asm/io.h and test.
880
881 Example output from the 'iotrace stats' command is below.
882 Note that if the trace buffer is exhausted, the checksum will
883 still continue to operate.
884
885 iotrace is enabled
886 Start: 10000000 (buffer start address)
887 Size: 00010000 (buffer size)
888 Offset: 00000120 (current buffer offset)
889 Output: 10000120 (start + offset)
890 Count: 00000018 (number of trace records)
891 CRC32: 9526fb66 (CRC32 of all trace records)
892
wdenkc6097192002-11-03 00:24:07 +0000893- Timestamp Support:
894
wdenk4a5c8a72003-03-06 00:02:04 +0000895 When CONFIG_TIMESTAMP is selected, the timestamp
896 (date and time) of an image is printed by image
897 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500898 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000899
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000900- Partition Labels (disklabels) Supported:
901 Zero or more of the following:
902 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000903 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
904 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
905 bootloader. Note 2TB partition limit; see
906 disk/part_efi.c
907 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000908
Simon Glassb569a012017-05-17 03:25:30 -0600909 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -0600910 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000911 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000912
913- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000914 CONFIG_IDE_RESET_ROUTINE - this is defined in several
915 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000916
wdenk369d43d2004-03-14 14:09:05 +0000917 CONFIG_IDE_RESET - is this is defined, IDE Reset will
918 be performed by calling the function
919 ide_set_reset(int reset)
920 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000921
922- ATAPI Support:
923 CONFIG_ATAPI
924
925 Set this to enable ATAPI support.
926
wdenkf602aa02004-03-13 23:29:43 +0000927- LBA48 Support
928 CONFIG_LBA48
929
930 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100931 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000932 Whithout these , LBA48 support uses 32bit variables and will 'only'
933 support disks up to 2.1TB.
934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200935 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000936 When enabled, makes the IDE subsystem use 64bit sector addresses.
937 Default is 32bit.
938
wdenkc6097192002-11-03 00:24:07 +0000939- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200940 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
941 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
942 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000943 maximum numbers of LUNs, SCSI ID's and target
944 devices.
wdenkc6097192002-11-03 00:24:07 +0000945
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200946 The environment variable 'scsidevs' is set to the number of
947 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000948
wdenkc6097192002-11-03 00:24:07 +0000949- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000950 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000951 Support for Intel 8254x/8257x gigabit chips.
952
953 CONFIG_E1000_SPI
954 Utility code for direct access to the SPI bus on Intel 8257x.
955 This does not do anything useful unless you set at least one
956 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
957
958 CONFIG_E1000_SPI_GENERIC
959 Allow generic access to the SPI bus on the Intel 8257x, for
960 example with the "sspi" command.
961
wdenkc6097192002-11-03 00:24:07 +0000962 CONFIG_EEPRO100
963 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200964 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000965 write routine for first time initialisation.
966
967 CONFIG_TULIP
968 Support for Digital 2114x chips.
969 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
970 modem chip initialisation (KS8761/QS6611).
971
972 CONFIG_NATSEMI
973 Support for National dp83815 chips.
974
975 CONFIG_NS8382X
976 Support for National dp8382[01] gigabit chips.
977
wdenkaa603362003-05-12 21:50:16 +0000978- NETWORK Support (other):
979
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100980 CONFIG_DRIVER_AT91EMAC
981 Support for AT91RM9200 EMAC.
982
983 CONFIG_RMII
984 Define this to use reduced MII inteface
985
986 CONFIG_DRIVER_AT91EMAC_QUIET
987 If this defined, the driver is quiet.
988 The driver doen't show link status messages.
989
Rob Herringc9830dc2011-12-15 11:15:49 +0000990 CONFIG_CALXEDA_XGMAC
991 Support for the Calxeda XGMAC device
992
Ashok93fb8722012-10-15 06:20:47 +0000993 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000994 Support for SMSC's LAN91C96 chips.
995
wdenkaa603362003-05-12 21:50:16 +0000996 CONFIG_LAN91C96_USE_32_BIT
997 Define this to enable 32 bit addressing
998
Ashok93fb8722012-10-15 06:20:47 +0000999 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001000 Support for SMSC's LAN91C111 chip
1001
1002 CONFIG_SMC91111_BASE
1003 Define this to hold the physical address
1004 of the device (I/O space)
1005
1006 CONFIG_SMC_USE_32_BIT
1007 Define this if data bus is 32 bits
1008
1009 CONFIG_SMC_USE_IOFUNCS
1010 Define this to use i/o functions instead of macros
1011 (some hardware wont work with macros)
1012
Heiko Schocher7d037f72011-11-15 10:00:04 -05001013 CONFIG_DRIVER_TI_EMAC
1014 Support for davinci emac
1015
1016 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1017 Define this if you have more then 3 PHYs.
1018
Macpaul Lin199c6252010-12-21 16:59:46 +08001019 CONFIG_FTGMAC100
1020 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1021
1022 CONFIG_FTGMAC100_EGIGA
1023 Define this to use GE link update with gigabit PHY.
1024 Define this if FTGMAC100 is connected to gigabit PHY.
1025 If your system has 10/100 PHY only, it might not occur
1026 wrong behavior. Because PHY usually return timeout or
1027 useless data when polling gigabit status and gigabit
1028 control registers. This behavior won't affect the
1029 correctnessof 10/100 link speed update.
1030
Mike Rapoportf4761af2009-11-11 10:03:03 +02001031 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001032 Support for SMSC's LAN911x and LAN921x chips
1033
Mike Rapoportf4761af2009-11-11 10:03:03 +02001034 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001035 Define this to hold the physical address
1036 of the device (I/O space)
1037
Mike Rapoportf4761af2009-11-11 10:03:03 +02001038 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001039 Define this if data bus is 32 bits
1040
Mike Rapoportf4761af2009-11-11 10:03:03 +02001041 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001042 Define this if data bus is 16 bits. If your processor
1043 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001044 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001045
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001046 CONFIG_SH_ETHER
1047 Support for Renesas on-chip Ethernet controller
1048
1049 CONFIG_SH_ETHER_USE_PORT
1050 Define the number of ports to be used
1051
1052 CONFIG_SH_ETHER_PHY_ADDR
1053 Define the ETH PHY's address
1054
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001055 CONFIG_SH_ETHER_CACHE_WRITEBACK
1056 If this option is set, the driver enables cache flush.
1057
Heiko Schocher2b387762014-07-18 06:07:19 +02001058- PWM Support:
1059 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001060 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001061
Vadim Bendeburydac69642011-10-17 08:36:14 +00001062- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001063 CONFIG_TPM
1064 Support TPM devices.
1065
Christophe Ricard8759ff82015-10-06 22:54:41 +02001066 CONFIG_TPM_TIS_INFINEON
1067 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001068 per system is supported at this time.
1069
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001070 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1071 Define the burst count bytes upper limit
1072
Christophe Ricard88249232016-01-21 23:27:13 +01001073 CONFIG_TPM_ST33ZP24
1074 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1075
1076 CONFIG_TPM_ST33ZP24_I2C
1077 Support for STMicroelectronics ST33ZP24 I2C devices.
1078 Requires TPM_ST33ZP24 and I2C.
1079
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001080 CONFIG_TPM_ST33ZP24_SPI
1081 Support for STMicroelectronics ST33ZP24 SPI devices.
1082 Requires TPM_ST33ZP24 and SPI.
1083
Dirk Eibach20489092013-06-26 15:55:15 +02001084 CONFIG_TPM_ATMEL_TWI
1085 Support for Atmel TWI TPM device. Requires I2C support.
1086
Che-liang Chiouacea5702013-04-12 11:04:34 +00001087 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001088 Support for generic parallel port TPM devices. Only one device
1089 per system is supported at this time.
1090
1091 CONFIG_TPM_TIS_BASE_ADDRESS
1092 Base address where the generic TPM device is mapped
1093 to. Contemporary x86 systems usually map it at
1094 0xfed40000.
1095
Reinhard Pfau4fece432013-06-26 15:55:13 +02001096 CONFIG_TPM
1097 Define this to enable the TPM support library which provides
1098 functional interfaces to some TPM commands.
1099 Requires support for a TPM device.
1100
1101 CONFIG_TPM_AUTH_SESSIONS
1102 Define this to enable authorized functions in the TPM library.
1103 Requires CONFIG_TPM and CONFIG_SHA1.
1104
wdenkc6097192002-11-03 00:24:07 +00001105- USB Support:
1106 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001107 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001108 CONFIG_USB_UHCI to enable it.
1109 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001110 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001111 storage devices.
1112 Note:
1113 Supported are USB Keyboards and USB Floppy drives
1114 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001115
Simon Glass5978cdb2012-02-27 10:52:47 +00001116 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1117 txfilltuning field in the EHCI controller on reset.
1118
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001119 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1120 HW module registers.
1121
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001122- USB Device:
1123 Define the below if you wish to use the USB console.
1124 Once firmware is rebuilt from a serial console issue the
1125 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001126 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001127 it has found a new device. The environment variable usbtty
1128 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001129 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001130 Common Device Class Abstract Control Model serial device.
1131 If you select usbtty = gserial you should be able to enumerate
1132 a Linux host by
1133 # modprobe usbserial vendor=0xVendorID product=0xProductID
1134 else if using cdc_acm, simply setting the environment
1135 variable usbtty to be cdc_acm should suffice. The following
1136 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001137
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001138 CONFIG_USB_DEVICE
1139 Define this to build a UDC device
1140
1141 CONFIG_USB_TTY
1142 Define this to have a tty type of device available to
1143 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001144
Vipin KUMARbdb17702012-03-26 15:38:06 +05301145 CONFIG_USBD_HS
1146 Define this to enable the high speed support for usb
1147 device and usbtty. If this feature is enabled, a routine
1148 int is_usbd_high_speed(void)
1149 also needs to be defined by the driver to dynamically poll
1150 whether the enumeration has succeded at high speed or full
1151 speed.
1152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001153 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001154 Define this if you want stdin, stdout &/or stderr to
1155 be set to usbtty.
1156
Wolfgang Denke2601822006-06-14 18:14:56 +02001157 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001158 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001159 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001160 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1161 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1162 should pretend to be a Linux device to it's target host.
1163
1164 CONFIG_USBD_MANUFACTURER
1165 Define this string as the name of your company for
1166 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001167
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001168 CONFIG_USBD_PRODUCT_NAME
1169 Define this string as the name of your product
1170 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001171
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001172 CONFIG_USBD_VENDORID
1173 Define this as your assigned Vendor ID from the USB
1174 Implementors Forum. This *must* be a genuine Vendor ID
1175 to avoid polluting the USB namespace.
1176 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001177
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001178 CONFIG_USBD_PRODUCTID
1179 Define this as the unique Product ID
1180 for your device
1181 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001182
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001183- ULPI Layer Support:
1184 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1185 the generic ULPI layer. The generic layer accesses the ULPI PHY
1186 via the platform viewport, so you need both the genric layer and
1187 the viewport enabled. Currently only Chipidea/ARC based
1188 viewport is supported.
1189 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1190 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001191 If your ULPI phy needs a different reference clock than the
1192 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1193 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001194
wdenk7a428cc2003-06-15 22:40:42 +00001195- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001196 The MMC controller on the Intel PXA is supported. To
1197 enable this define CONFIG_MMC. The MMC can be
1198 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001199 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001200 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1201 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001202
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001203 CONFIG_SH_MMCIF
1204 Support for Renesas on-chip MMCIF controller
1205
1206 CONFIG_SH_MMCIF_ADDR
1207 Define the base address of MMCIF registers
1208
1209 CONFIG_SH_MMCIF_CLK
1210 Define the clock frequency for MMCIF
1211
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001212 CONFIG_SUPPORT_EMMC_BOOT
1213 Enable some additional features of the eMMC boot partitions.
1214
1215 CONFIG_SUPPORT_EMMC_RPMB
1216 Enable the commands for reading, writing and programming the
1217 key for the Replay Protection Memory Block partition in eMMC.
1218
Tom Rini58a8d322013-03-14 05:32:47 +00001219- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001220 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001221 This enables the USB portion of the DFU USB class
1222
Tom Rini58a8d322013-03-14 05:32:47 +00001223 CONFIG_DFU_MMC
1224 This enables support for exposing (e)MMC devices via DFU.
1225
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001226 CONFIG_DFU_NAND
1227 This enables support for exposing NAND devices via DFU.
1228
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301229 CONFIG_DFU_RAM
1230 This enables support for exposing RAM via DFU.
1231 Note: DFU spec refer to non-volatile memory usage, but
1232 allow usages beyond the scope of spec - here RAM usage,
1233 one that would help mostly the developer.
1234
Heiko Schochera2f831e2013-06-12 06:05:51 +02001235 CONFIG_SYS_DFU_DATA_BUF_SIZE
1236 Dfu transfer uses a buffer before writing data to the
1237 raw storage device. Make the size (in bytes) of this buffer
1238 configurable. The size of this buffer is also configurable
1239 through the "dfu_bufsiz" environment variable.
1240
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001241 CONFIG_SYS_DFU_MAX_FILE_SIZE
1242 When updating files rather than the raw storage device,
1243 we use a static buffer to copy the file into and then write
1244 the buffer once we've been given the whole file. Define
1245 this to the maximum filesize (in bytes) for the buffer.
1246 Default is 4 MiB if undefined.
1247
Heiko Schochere1ba1512014-03-18 08:09:56 +01001248 DFU_DEFAULT_POLL_TIMEOUT
1249 Poll timeout [ms], is the timeout a device can send to the
1250 host. The host must wait for this timeout before sending
1251 a subsequent DFU_GET_STATUS request to the device.
1252
1253 DFU_MANIFEST_POLL_TIMEOUT
1254 Poll timeout [ms], which the device sends to the host when
1255 entering dfuMANIFEST state. Host waits this timeout, before
1256 sending again an USB request to the device.
1257
wdenkda04a8b2004-08-02 23:22:59 +00001258- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001259 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001260 Define these for a default partition on a NAND device
1261
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001262 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1263 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001264 Define these for a default partition on a NOR device
1265
wdenkc6097192002-11-03 00:24:07 +00001266- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001267 See Kconfig help for available keyboard drivers.
1268
1269 CONFIG_KEYBOARD
1270
1271 Define this to enable a custom keyboard support.
1272 This simply calls drv_keyboard_init() which must be
1273 defined in your board-specific files. This option is deprecated
1274 and is only used by novena. For new boards, use driver model
1275 instead.
wdenkc6097192002-11-03 00:24:07 +00001276
1277- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001278 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001279 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001280 SOCs that have a DIU should define this macro to enable DIU
1281 support, and should also define these other macros:
1282
1283 CONFIG_SYS_DIU_ADDR
1284 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001285 CONFIG_CFB_CONSOLE
1286 CONFIG_VIDEO_SW_CURSOR
1287 CONFIG_VGA_AS_SINGLE_DEVICE
1288 CONFIG_VIDEO_LOGO
1289 CONFIG_VIDEO_BMP_LOGO
1290
Timur Tabi32f709e2011-04-11 14:18:22 -05001291 The DIU driver will look for the 'video-mode' environment
1292 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001293 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001294 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001295
wdenkc6097192002-11-03 00:24:07 +00001296- LCD Support: CONFIG_LCD
1297
1298 Define this to enable LCD support (for output to LCD
1299 display); also select one of the supported displays
1300 by defining one of these:
1301
Stelian Popf6f86652008-05-09 21:57:18 +02001302 CONFIG_ATMEL_LCD:
1303
1304 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1305
wdenkc0d54ae2003-11-25 16:55:19 +00001306 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001307
wdenkc0d54ae2003-11-25 16:55:19 +00001308 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001309
wdenkc0d54ae2003-11-25 16:55:19 +00001310 CONFIG_NEC_NL6448BC20
1311
1312 NEC NL6448BC20-08. 6.5", 640x480.
1313 Active, color, single scan.
1314
1315 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001316
wdenkc0d54ae2003-11-25 16:55:19 +00001317 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001318 Active, color, single scan.
1319
1320 CONFIG_SHARP_16x9
1321
1322 Sharp 320x240. Active, color, single scan.
1323 It isn't 16x9, and I am not sure what it is.
1324
1325 CONFIG_SHARP_LQ64D341
1326
1327 Sharp LQ64D341 display, 640x480.
1328 Active, color, single scan.
1329
1330 CONFIG_HLD1045
1331
1332 HLD1045 display, 640x480.
1333 Active, color, single scan.
1334
1335 CONFIG_OPTREX_BW
1336
1337 Optrex CBL50840-2 NF-FW 99 22 M5
1338 or
1339 Hitachi LMG6912RPFC-00T
1340 or
1341 Hitachi SP14Q002
1342
1343 320x240. Black & white.
1344
Simon Glass599a4df2012-10-17 13:24:54 +00001345 CONFIG_LCD_ALIGNMENT
1346
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001347 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001348 defined then the LCD will be aligned to this value instead.
1349 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1350 here, since it is cheaper to change data cache settings on
1351 a per-section basis.
1352
1353
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001354 CONFIG_LCD_ROTATION
1355
1356 Sometimes, for example if the display is mounted in portrait
1357 mode or even if it's mounted landscape but rotated by 180degree,
1358 we need to rotate our content of the display relative to the
1359 framebuffer, so that user can read the messages which are
1360 printed out.
1361 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1362 initialized with a given rotation from "vl_rot" out of
1363 "vidinfo_t" which is provided by the board specific code.
1364 The value for vl_rot is coded as following (matching to
1365 fbcon=rotate:<n> linux-kernel commandline):
1366 0 = no rotation respectively 0 degree
1367 1 = 90 degree rotation
1368 2 = 180 degree rotation
1369 3 = 270 degree rotation
1370
1371 If CONFIG_LCD_ROTATION is not defined, the console will be
1372 initialized with 0degree rotation.
1373
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001374 CONFIG_LCD_BMP_RLE8
1375
1376 Support drawing of RLE8-compressed bitmaps on the LCD.
1377
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001378 CONFIG_I2C_EDID
1379
1380 Enables an 'i2c edid' command which can read EDID
1381 information over I2C from an attached LCD display.
1382
wdenkeb20ad32003-09-05 23:19:14 +00001383- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001384
wdenk57b2d802003-06-27 21:31:46 +00001385 If this option is set, the environment is checked for
1386 a variable "splashimage". If found, the usual display
1387 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001388 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001389 specified in "splashimage" is loaded instead. The
1390 console is redirected to the "nulldev", too. This
1391 allows for a "silent" boot where a splash screen is
1392 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001393
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001394 CONFIG_SPLASHIMAGE_GUARD
1395
1396 If this option is set, then U-Boot will prevent the environment
1397 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001398 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001399 This option is useful for targets where, due to alignment
1400 restrictions, an improperly aligned BMP image will cause a data
1401 abort. If you think you will not have problems with unaligned
1402 accesses (for example because your toolchain prevents them)
1403 there is no need to set this option.
1404
Matthias Weisser53884182009-07-09 16:07:30 +02001405 CONFIG_SPLASH_SCREEN_ALIGN
1406
1407 If this option is set the splash image can be freely positioned
1408 on the screen. Environment variable "splashpos" specifies the
1409 position as "x,y". If a positive number is given it is used as
1410 number of pixel from left/top. If a negative number is given it
1411 is used as number of pixel from right/bottom. You can also
1412 specify 'm' for centering the image.
1413
1414 Example:
1415 setenv splashpos m,m
1416 => image at center of screen
1417
1418 setenv splashpos 30,20
1419 => image at x = 30 and y = 20
1420
1421 setenv splashpos -10,m
1422 => vertically centered image
1423 at x = dspWidth - bmpWidth - 9
1424
Stefan Roesed9d97742005-09-22 09:04:17 +02001425- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1426
1427 If this option is set, additionally to standard BMP
1428 images, gzipped BMP images can be displayed via the
1429 splashscreen support or the bmp command.
1430
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001431- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1432
1433 If this option is set, 8-bit RLE compressed BMP images
1434 can be displayed via the splashscreen support or the
1435 bmp command.
1436
wdenk710e3502003-08-29 20:57:53 +00001437- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001438 CONFIG_GZIP
1439
1440 Enabled by default to support gzip compressed images.
1441
wdenk710e3502003-08-29 20:57:53 +00001442 CONFIG_BZIP2
1443
1444 If this option is set, support for bzip2 compressed
1445 images is included. If not, only uncompressed and gzip
1446 compressed images are supported.
1447
wdenk9c53f402003-10-15 23:53:47 +00001448 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001449 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001450 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001451
wdenk0e2bd9c2004-06-06 21:51:03 +00001452- MII/PHY support:
1453 CONFIG_PHY_ADDR
1454
1455 The address of PHY on MII bus.
1456
1457 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1458
1459 The clock frequency of the MII bus
1460
wdenk0e2bd9c2004-06-06 21:51:03 +00001461 CONFIG_PHY_RESET_DELAY
1462
1463 Some PHY like Intel LXT971A need extra delay after
1464 reset before any MII register access is possible.
1465 For such PHY, set this option to the usec delay
1466 required. (minimum 300usec for LXT971A)
1467
1468 CONFIG_PHY_CMD_DELAY (ppc4xx)
1469
1470 Some PHY like Intel LXT971A need extra delay after
1471 command issued before MII status register can be read
1472
wdenkc6097192002-11-03 00:24:07 +00001473- IP address:
1474 CONFIG_IPADDR
1475
1476 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001477 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001478 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001479 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001480
1481- Server IP address:
1482 CONFIG_SERVERIP
1483
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001484 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001485 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001486 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001487
Robin Getz470a6d42009-07-21 12:15:28 -04001488 CONFIG_KEEP_SERVERADDR
1489
1490 Keeps the server's MAC address, in the env 'serveraddr'
1491 for passing to bootargs (like Linux's netconsole option)
1492
Wolfgang Denk26da2992011-10-26 10:21:22 +00001493- Gateway IP address:
1494 CONFIG_GATEWAYIP
1495
1496 Defines a default value for the IP address of the
1497 default router where packets to other networks are
1498 sent to.
1499 (Environment variable "gatewayip")
1500
1501- Subnet mask:
1502 CONFIG_NETMASK
1503
1504 Defines a default value for the subnet mask (or
1505 routing prefix) which is used to determine if an IP
1506 address belongs to the local subnet or needs to be
1507 forwarded through a router.
1508 (Environment variable "netmask")
1509
David Updegraff7280da72007-06-11 10:41:07 -05001510- Multicast TFTP Mode:
1511 CONFIG_MCAST_TFTP
1512
1513 Defines whether you want to support multicast TFTP as per
1514 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001515 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001516 driver in use must provide a function: mcast() to join/leave a
1517 multicast group.
1518
wdenkc6097192002-11-03 00:24:07 +00001519- BOOTP Recovery Mode:
1520 CONFIG_BOOTP_RANDOM_DELAY
1521
1522 If you have many targets in a network that try to
1523 boot using BOOTP, you may want to avoid that all
1524 systems send out BOOTP requests at precisely the same
1525 moment (which would happen for instance at recovery
1526 from a power failure, when all systems will try to
1527 boot, thus flooding the BOOTP server. Defining
1528 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1529 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001530 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001531
1532 1st BOOTP request: delay 0 ... 1 sec
1533 2nd BOOTP request: delay 0 ... 2 sec
1534 3rd BOOTP request: delay 0 ... 4 sec
1535 4th and following
1536 BOOTP requests: delay 0 ... 8 sec
1537
Thierry Reding8977cda2014-08-19 10:21:24 +02001538 CONFIG_BOOTP_ID_CACHE_SIZE
1539
1540 BOOTP packets are uniquely identified using a 32-bit ID. The
1541 server will copy the ID from client requests to responses and
1542 U-Boot will use this to determine if it is the destination of
1543 an incoming response. Some servers will check that addresses
1544 aren't in use before handing them out (usually using an ARP
1545 ping) and therefore take up to a few hundred milliseconds to
1546 respond. Network congestion may also influence the time it
1547 takes for a response to make it back to the client. If that
1548 time is too long, U-Boot will retransmit requests. In order
1549 to allow earlier responses to still be accepted after these
1550 retransmissions, U-Boot's BOOTP client keeps a small cache of
1551 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1552 cache. The default is to keep IDs for up to four outstanding
1553 requests. Increasing this will allow U-Boot to accept offers
1554 from a BOOTP client in networks with unusually high latency.
1555
stroesee0aadfb2003-08-28 14:17:32 +00001556- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001557 You can fine tune the DHCP functionality by defining
1558 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001559
Jon Loeliger5336a762007-07-09 22:08:34 -05001560 CONFIG_BOOTP_SUBNETMASK
1561 CONFIG_BOOTP_GATEWAY
1562 CONFIG_BOOTP_HOSTNAME
1563 CONFIG_BOOTP_NISDOMAIN
1564 CONFIG_BOOTP_BOOTPATH
1565 CONFIG_BOOTP_BOOTFILESIZE
1566 CONFIG_BOOTP_DNS
1567 CONFIG_BOOTP_DNS2
1568 CONFIG_BOOTP_SEND_HOSTNAME
1569 CONFIG_BOOTP_NTPSERVER
1570 CONFIG_BOOTP_TIMEOFFSET
1571 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001572 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001573
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001574 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1575 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001576
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001577 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1578 after the configured retry count, the call will fail
1579 instead of starting over. This can be used to fail over
1580 to Link-local IP address configuration if the DHCP server
1581 is not available.
1582
stroesee0aadfb2003-08-28 14:17:32 +00001583 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1584 serverip from a DHCP server, it is possible that more
1585 than one DNS serverip is offered to the client.
1586 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1587 serverip will be stored in the additional environment
1588 variable "dnsip2". The first DNS serverip is always
1589 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001590 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001591
1592 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1593 to do a dynamic update of a DNS server. To do this, they
1594 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001595 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001596 of the "hostname" environment variable is passed as
1597 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001598
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001599 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1600
1601 A 32bit value in microseconds for a delay between
1602 receiving a "DHCP Offer" and sending the "DHCP Request".
1603 This fixes a problem with certain DHCP servers that don't
1604 respond 100% of the time to a "DHCP request". E.g. On an
1605 AT91RM9200 processor running at 180MHz, this delay needed
1606 to be *at least* 15,000 usec before a Windows Server 2003
1607 DHCP server would reply 100% of the time. I recommend at
1608 least 50,000 usec to be safe. The alternative is to hope
1609 that one of the retries will be successful but note that
1610 the DHCP timeout and retry process takes a longer than
1611 this delay.
1612
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001613 - Link-local IP address negotiation:
1614 Negotiate with other link-local clients on the local network
1615 for an address that doesn't require explicit configuration.
1616 This is especially useful if a DHCP server cannot be guaranteed
1617 to exist in all environments that the device must operate.
1618
1619 See doc/README.link-local for more information.
1620
wdenk145d2c12004-04-15 21:48:45 +00001621 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001622 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001623
1624 The device id used in CDP trigger frames.
1625
1626 CONFIG_CDP_DEVICE_ID_PREFIX
1627
1628 A two character string which is prefixed to the MAC address
1629 of the device.
1630
1631 CONFIG_CDP_PORT_ID
1632
1633 A printf format string which contains the ascii name of
1634 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001635 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001636
1637 CONFIG_CDP_CAPABILITIES
1638
1639 A 32bit integer which indicates the device capabilities;
1640 0x00000010 for a normal host which does not forwards.
1641
1642 CONFIG_CDP_VERSION
1643
1644 An ascii string containing the version of the software.
1645
1646 CONFIG_CDP_PLATFORM
1647
1648 An ascii string containing the name of the platform.
1649
1650 CONFIG_CDP_TRIGGER
1651
1652 A 32bit integer sent on the trigger.
1653
1654 CONFIG_CDP_POWER_CONSUMPTION
1655
1656 A 16bit integer containing the power consumption of the
1657 device in .1 of milliwatts.
1658
1659 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1660
1661 A byte containing the id of the VLAN.
1662
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001663- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001664
1665 Several configurations allow to display the current
1666 status using a LED. For instance, the LED will blink
1667 fast while running U-Boot code, stop blinking as
1668 soon as a reply to a BOOTP request was received, and
1669 start blinking slow once the Linux kernel is running
1670 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001671 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001672 feature in U-Boot.
1673
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001674 Additional options:
1675
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001676 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001677 The status LED can be connected to a GPIO pin.
1678 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001679 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001680 to include the gpio_led driver in the U-Boot binary.
1681
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001682 CONFIG_GPIO_LED_INVERTED_TABLE
1683 Some GPIO connected LEDs may have inverted polarity in which
1684 case the GPIO high value corresponds to LED off state and
1685 GPIO low value corresponds to LED on state.
1686 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1687 with a list of GPIO LEDs that have inverted polarity.
1688
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001689- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001690
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001691 This enable the NEW i2c subsystem, and will allow you to use
1692 i2c commands at the u-boot command line (as long as you set
1693 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1694 based realtime clock chips or other i2c devices. See
1695 common/cmd_i2c.c for a description of the command line
1696 interface.
1697
1698 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001699 - drivers/i2c/soft_i2c.c:
1700 - activate first bus with CONFIG_SYS_I2C_SOFT define
1701 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1702 for defining speed and slave address
1703 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1704 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1705 for defining speed and slave address
1706 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1707 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1708 for defining speed and slave address
1709 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1710 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1711 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001712
Heiko Schocherf2850742012-10-24 13:48:22 +02001713 - drivers/i2c/fsl_i2c.c:
1714 - activate i2c driver with CONFIG_SYS_I2C_FSL
1715 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1716 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1717 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1718 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001719 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001720 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1721 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1722 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1723 second bus.
1724
Simon Glass026fefb2012-10-30 07:28:53 +00001725 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001726 - activate this driver with CONFIG_SYS_I2C_TEGRA
1727 - This driver adds 4 i2c buses with a fix speed from
1728 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001729
Dirk Eibach42b204f2013-04-25 02:40:01 +00001730 - drivers/i2c/ppc4xx_i2c.c
1731 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1732 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1733 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1734
trema49f40a2013-09-21 18:13:35 +02001735 - drivers/i2c/i2c_mxc.c
1736 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001737 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1738 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1739 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1740 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001741 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1742 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1743 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1744 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1745 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1746 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001747 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1748 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001749 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001750 for speed, and 0 for slave.
1751
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001752 - drivers/i2c/rcar_i2c.c:
1753 - activate this driver with CONFIG_SYS_I2C_RCAR
1754 - This driver adds 4 i2c buses
1755
1756 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1757 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1758 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1759 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1760 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1761 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1762 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1763 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1764 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1765
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001766 - drivers/i2c/sh_i2c.c:
1767 - activate this driver with CONFIG_SYS_I2C_SH
1768 - This driver adds from 2 to 5 i2c buses
1769
1770 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1771 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1772 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1773 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1774 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1775 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1776 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1777 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1778 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1779 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001780 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001781
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001782 - drivers/i2c/omap24xx_i2c.c
1783 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1784 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1785 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1786 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1787 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1788 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1789 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1790 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1791 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1792 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1793 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1794
Heiko Schocher465819a2013-11-08 07:30:53 +01001795 - drivers/i2c/zynq_i2c.c
1796 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1797 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1798 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1799
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301800 - drivers/i2c/s3c24x0_i2c.c:
1801 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1802 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1803 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1804 with a fix speed from 100000 and the slave addr 0!
1805
Dirk Eibachb9577432014-07-03 09:28:18 +02001806 - drivers/i2c/ihs_i2c.c
1807 - activate this driver with CONFIG_SYS_I2C_IHS
1808 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1809 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1810 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1811 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1812 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1813 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1814 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1815 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1816 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1817 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1818 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1819 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001820 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1821 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1822 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1823 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1824 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1825 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1826 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1827 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1828 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001829
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001830 additional defines:
1831
1832 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001833 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001834
1835 CONFIG_SYS_I2C_DIRECT_BUS
1836 define this, if you don't use i2c muxes on your hardware.
1837 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1838 omit this define.
1839
1840 CONFIG_SYS_I2C_MAX_HOPS
1841 define how many muxes are maximal consecutively connected
1842 on one i2c bus. If you not use i2c muxes, omit this
1843 define.
1844
1845 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001846 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001847 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1848 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1849 CONFIG_SYS_NUM_I2C_BUSES = 9:
1850
1851 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1852 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1853 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1854 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1855 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1856 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1857 {1, {I2C_NULL_HOP}}, \
1858 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1859 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1860 }
1861
1862 which defines
1863 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001864 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1865 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1866 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1867 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1868 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001869 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001870 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1871 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001872
1873 If you do not have i2c muxes on your board, omit this define.
1874
Simon Glass3efce392017-05-12 21:10:00 -06001875- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001876 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001877 then the following macros need to be defined (examples are
1878 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001879
1880 I2C_INIT
1881
wdenkb9bbd242003-06-30 16:24:52 +00001882 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001883 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001884
wdenk544e9732004-02-06 23:19:44 +00001885 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001886
wdenkc6097192002-11-03 00:24:07 +00001887 I2C_ACTIVE
1888
1889 The code necessary to make the I2C data line active
1890 (driven). If the data line is open collector, this
1891 define can be null.
1892
wdenkb9bbd242003-06-30 16:24:52 +00001893 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1894
wdenkc6097192002-11-03 00:24:07 +00001895 I2C_TRISTATE
1896
1897 The code necessary to make the I2C data line tri-stated
1898 (inactive). If the data line is open collector, this
1899 define can be null.
1900
wdenkb9bbd242003-06-30 16:24:52 +00001901 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1902
wdenkc6097192002-11-03 00:24:07 +00001903 I2C_READ
1904
York Sun4a598092013-04-01 11:29:11 -07001905 Code that returns true if the I2C data line is high,
1906 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001907
wdenkb9bbd242003-06-30 16:24:52 +00001908 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1909
wdenkc6097192002-11-03 00:24:07 +00001910 I2C_SDA(bit)
1911
York Sun4a598092013-04-01 11:29:11 -07001912 If <bit> is true, sets the I2C data line high. If it
1913 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001914
wdenkb9bbd242003-06-30 16:24:52 +00001915 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001916 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001917 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001918
wdenkc6097192002-11-03 00:24:07 +00001919 I2C_SCL(bit)
1920
York Sun4a598092013-04-01 11:29:11 -07001921 If <bit> is true, sets the I2C clock line high. If it
1922 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001923
wdenkb9bbd242003-06-30 16:24:52 +00001924 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001925 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001926 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001927
wdenkc6097192002-11-03 00:24:07 +00001928 I2C_DELAY
1929
1930 This delay is invoked four times per clock cycle so this
1931 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001932 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001933 like:
1934
wdenkb9bbd242003-06-30 16:24:52 +00001935 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001936
Mike Frysingeree12d542010-07-21 13:38:02 -04001937 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1938
1939 If your arch supports the generic GPIO framework (asm/gpio.h),
1940 then you may alternatively define the two GPIOs that are to be
1941 used as SCL / SDA. Any of the previous I2C_xxx macros will
1942 have GPIO-based defaults assigned to them as appropriate.
1943
1944 You should define these to the GPIO value as given directly to
1945 the generic GPIO functions.
1946
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001947 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001948
wdenk57b2d802003-06-27 21:31:46 +00001949 When a board is reset during an i2c bus transfer
1950 chips might think that the current transfer is still
1951 in progress. On some boards it is possible to access
1952 the i2c SCLK line directly, either by using the
1953 processor pin as a GPIO or by having a second pin
1954 connected to the bus. If this option is defined a
1955 custom i2c_init_board() routine in boards/xxx/board.c
1956 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001957
Ben Warren45657152006-09-07 16:50:54 -04001958 CONFIG_I2C_MULTI_BUS
1959
1960 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001961 must have a controller. At any point in time, only one bus is
1962 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001963 Note that bus numbering is zero-based.
1964
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001965 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001966
1967 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001968 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001969 is set, specify a list of bus-device pairs. Otherwise, specify
1970 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001971
1972 e.g.
1973 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001974 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001975
1976 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1977
Wolfgang Denk092ae952011-10-26 10:21:21 +00001978 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001979 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001980
1981 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1982
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001983 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001984
1985 If defined, then this indicates the I2C bus number for DDR SPD.
1986 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001988 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001989
1990 If defined, then this indicates the I2C bus number for the RTC.
1991 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1992
Andrew Dyer58c41f92008-12-29 17:36:01 -06001993 CONFIG_SOFT_I2C_READ_REPEATED_START
1994
1995 defining this will force the i2c_read() function in
1996 the soft_i2c driver to perform an I2C repeated start
1997 between writing the address pointer and reading the
1998 data. If this define is omitted the default behaviour
1999 of doing a stop-start sequence will be used. Most I2C
2000 devices can use either method, but some require one or
2001 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002002
wdenkc6097192002-11-03 00:24:07 +00002003- SPI Support: CONFIG_SPI
2004
2005 Enables SPI driver (so far only tested with
2006 SPI EEPROM, also an instance works with Crystal A/D and
2007 D/As on the SACSng board)
2008
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002009 CONFIG_SH_SPI
2010
2011 Enables the driver for SPI controller on SuperH. Currently
2012 only SH7757 is supported.
2013
wdenkc6097192002-11-03 00:24:07 +00002014 CONFIG_SOFT_SPI
2015
wdenk4a5c8a72003-03-06 00:02:04 +00002016 Enables a software (bit-bang) SPI driver rather than
2017 using hardware support. This is a general purpose
2018 driver that only requires three general I/O port pins
2019 (two outputs, one input) to function. If this is
2020 defined, the board configuration must define several
2021 SPI configuration items (port pins to use, etc). For
2022 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002023
Ben Warren7efe9272008-01-16 22:37:35 -05002024 CONFIG_HARD_SPI
2025
2026 Enables a hardware SPI driver for general-purpose reads
2027 and writes. As with CONFIG_SOFT_SPI, the board configuration
2028 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002029 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002030 example, see include/configs/mpc8349emds.h.
2031
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002032 CONFIG_MXC_SPI
2033
2034 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002035 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002036
Heiko Schocherb77c8882014-07-14 10:22:11 +02002037 CONFIG_SYS_SPI_MXC_WAIT
2038 Timeout for waiting until spi transfer completed.
2039 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2040
Matthias Fuchsa4400872007-12-27 17:12:34 +01002041- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002042
Matthias Fuchsa4400872007-12-27 17:12:34 +01002043 Enables FPGA subsystem.
2044
2045 CONFIG_FPGA_<vendor>
2046
2047 Enables support for specific chip vendors.
2048 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002049
Matthias Fuchsa4400872007-12-27 17:12:34 +01002050 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002051
Matthias Fuchsa4400872007-12-27 17:12:34 +01002052 Enables support for FPGA family.
2053 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2054
2055 CONFIG_FPGA_COUNT
2056
2057 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002059 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002060
wdenk57b2d802003-06-27 21:31:46 +00002061 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002063 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002064
wdenk4a5c8a72003-03-06 00:02:04 +00002065 Enable checks on FPGA configuration interface busy
2066 status by the configuration function. This option
2067 will require a board or device specific function to
2068 be written.
wdenkc6097192002-11-03 00:24:07 +00002069
2070 CONFIG_FPGA_DELAY
2071
2072 If defined, a function that provides delays in the FPGA
2073 configuration driver.
2074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002075 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002076 Allow Control-C to interrupt FPGA configuration
2077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002078 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002079
wdenk4a5c8a72003-03-06 00:02:04 +00002080 Check for configuration errors during FPGA bitfile
2081 loading. For example, abort during Virtex II
2082 configuration if the INIT_B line goes low (which
2083 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002085 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002086
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002087 Maximum time to wait for the INIT_B line to de-assert
2088 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002089 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002090 ms.
wdenkc6097192002-11-03 00:24:07 +00002091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002092 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002093
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002094 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002095 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002097 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002098
wdenk4a5c8a72003-03-06 00:02:04 +00002099 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002100 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002101
2102- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002103 CONFIG_BUILD_TARGET
2104
2105 Some SoCs need special image types (e.g. U-Boot binary
2106 with a special header) as build targets. By defining
2107 CONFIG_BUILD_TARGET in the SoC / board header, this
2108 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002109 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002110
wdenkc6097192002-11-03 00:24:07 +00002111 CONFIG_IDENT_STRING
2112
wdenk4a5c8a72003-03-06 00:02:04 +00002113 If defined, this string will be added to the U-Boot
2114 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002115
2116- Vendor Parameter Protection:
2117
wdenk4a5c8a72003-03-06 00:02:04 +00002118 U-Boot considers the values of the environment
2119 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002120 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002121 are set once by the board vendor / manufacturer, and
2122 protects these variables from casual modification by
2123 the user. Once set, these variables are read-only,
2124 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002125 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002126
2127 If CONFIG_ENV_OVERWRITE is #defined in your config
2128 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002129 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002130 these parameters.
2131
Joe Hershberger76f353e2015-05-04 14:55:14 -05002132 Alternatively, if you define _both_ an ethaddr in the
2133 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002134 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002135 which can be changed exactly ONCE by the user. [The
2136 serial# is unaffected by this, i. e. it remains
2137 read-only.]
2138
Joe Hershberger71497d02012-12-11 22:16:31 -06002139 The same can be accomplished in a more flexible way
2140 for any variable by configuring the type of access
2141 to allow for those variables in the ".flags" variable
2142 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2143
wdenkc6097192002-11-03 00:24:07 +00002144- Protected RAM:
2145 CONFIG_PRAM
2146
2147 Define this variable to enable the reservation of
2148 "protected RAM", i. e. RAM which is not overwritten
2149 by U-Boot. Define CONFIG_PRAM to hold the number of
2150 kB you want to reserve for pRAM. You can overwrite
2151 this default value by defining an environment
2152 variable "pram" to the number of kB you want to
2153 reserve. Note that the board info structure will
2154 still show the full amount of RAM. If pRAM is
2155 reserved, a new environment variable "mem" will
2156 automatically be defined to hold the amount of
2157 remaining RAM in a form that can be passed as boot
2158 argument to Linux, for instance like that:
2159
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002160 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002161 saveenv
2162
2163 This way you can tell Linux not to use this memory,
2164 either, which results in a memory region that will
2165 not be affected by reboots.
2166
2167 *WARNING* If your board configuration uses automatic
2168 detection of the RAM size, you must make sure that
2169 this memory test is non-destructive. So far, the
2170 following board configurations are known to be
2171 "pRAM-clean":
2172
Heiko Schocher65d94db2017-06-07 17:33:09 +02002173 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002174 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002175 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002176
Gabe Blacka2f3a932012-12-02 04:55:18 +00002177- Access to physical memory region (> 4GB)
2178 Some basic support is provided for operations on memory not
2179 normally accessible to U-Boot - e.g. some architectures
2180 support access to more than 4GB of memory on 32-bit
2181 machines using physical address extension or similar.
2182 Define CONFIG_PHYSMEM to access this basic support, which
2183 currently only supports clearing the memory.
2184
wdenkc6097192002-11-03 00:24:07 +00002185- Error Recovery:
2186 CONFIG_PANIC_HANG
2187
2188 Define this variable to stop the system in case of a
2189 fatal error, so that you have to reset it manually.
2190 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002191 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002192 automatically as fast as possible, but it may be
2193 useful during development since you can try to debug
2194 the conditions that lead to the situation.
2195
2196 CONFIG_NET_RETRY_COUNT
2197
wdenk4a5c8a72003-03-06 00:02:04 +00002198 This variable defines the number of retries for
2199 network operations like ARP, RARP, TFTP, or BOOTP
2200 before giving up the operation. If not defined, a
2201 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002202
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002203 CONFIG_ARP_TIMEOUT
2204
2205 Timeout waiting for an ARP reply in milliseconds.
2206
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002207 CONFIG_NFS_TIMEOUT
2208
2209 Timeout in milliseconds used in NFS protocol.
2210 If you encounter "ERROR: Cannot umount" in nfs command,
2211 try longer timeout such as
2212 #define CONFIG_NFS_TIMEOUT 10000UL
2213
wdenkc6097192002-11-03 00:24:07 +00002214- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002215 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002216
2217 Enable auto completion of commands using TAB.
2218
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002219 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002220
2221 This defines the secondary prompt string, which is
2222 printed when the command interpreter needs more input
2223 to complete a command. Usually "> ".
2224
2225 Note:
2226
wdenk57b2d802003-06-27 21:31:46 +00002227 In the current implementation, the local variables
2228 space and global environment variables space are
2229 separated. Local variables are those you define by
2230 simply typing `name=value'. To access a local
2231 variable later on, you have write `$name' or
2232 `${name}'; to execute the contents of a variable
2233 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002234
wdenk4a5c8a72003-03-06 00:02:04 +00002235 Global environment variables are those you use
2236 setenv/printenv to work with. To run a command stored
2237 in such a variable, you need to use the run command,
2238 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002239
2240 To store commands and special characters in a
2241 variable, please use double quotation marks
2242 surrounding the whole text of the variable, instead
2243 of the backslashes before semicolons and special
2244 symbols.
2245
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002246- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002247 CONFIG_CMDLINE_EDITING
2248
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002249 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002250 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002251
Marek Vasut734fb042016-01-27 04:47:55 +01002252- Command Line PS1/PS2 support:
2253 CONFIG_CMDLINE_PS_SUPPORT
2254
2255 Enable support for changing the command prompt string
2256 at run-time. Only static string is supported so far.
2257 The string is obtained from environment variables PS1
2258 and PS2.
2259
wdenkc0aa5c52003-12-06 19:49:23 +00002260- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002261 CONFIG_EXTRA_ENV_SETTINGS
2262
wdenk4a5c8a72003-03-06 00:02:04 +00002263 Define this to contain any number of null terminated
2264 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002265 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002266
wdenk4a5c8a72003-03-06 00:02:04 +00002267 For example, place something like this in your
2268 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002269
2270 #define CONFIG_EXTRA_ENV_SETTINGS \
2271 "myvar1=value1\0" \
2272 "myvar2=value2\0"
2273
wdenk4a5c8a72003-03-06 00:02:04 +00002274 Warning: This method is based on knowledge about the
2275 internal format how the environment is stored by the
2276 U-Boot code. This is NOT an official, exported
2277 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002278 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002279 You better know what you are doing here.
2280
wdenk4a5c8a72003-03-06 00:02:04 +00002281 Note: overly (ab)use of the default environment is
2282 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002283 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002284 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002285
Stephen Warren1465d5f2012-05-22 09:21:54 +00002286 CONFIG_ENV_VARS_UBOOT_CONFIG
2287
2288 Define this in order to add variables describing the
2289 U-Boot build configuration to the default environment.
2290 These will be named arch, cpu, board, vendor, and soc.
2291
2292 Enabling this option will cause the following to be defined:
2293
2294 - CONFIG_SYS_ARCH
2295 - CONFIG_SYS_CPU
2296 - CONFIG_SYS_BOARD
2297 - CONFIG_SYS_VENDOR
2298 - CONFIG_SYS_SOC
2299
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002300 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2301
2302 Define this in order to add variables describing certain
2303 run-time determined information about the hardware to the
2304 environment. These will be named board_name, board_rev.
2305
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002306 CONFIG_DELAY_ENVIRONMENT
2307
2308 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002309 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002310 that so that the environment is not available until
2311 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2312 this is instead controlled by the value of
2313 /config/load-environment.
2314
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002315- Serial Flash support
Simon Glass663b0cc2017-08-04 16:35:06 -06002316 Usage requires an initial 'sf probe' to define the serial
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002317 flash parameters, followed by read/write/erase/update
2318 commands.
2319
2320 The following defaults may be provided by the platform
2321 to handle the common case when only a single serial
2322 flash is present on the system.
2323
2324 CONFIG_SF_DEFAULT_BUS Bus identifier
2325 CONFIG_SF_DEFAULT_CS Chip-select
2326 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2327 CONFIG_SF_DEFAULT_SPEED in Hz
2328
wdenkef893942004-02-23 16:11:30 +00002329 CONFIG_SYSTEMACE
2330
2331 Adding this option adds support for Xilinx SystemACE
2332 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002333 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002334 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002335
2336 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002337 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002338
2339 When SystemACE support is added, the "ace" device type
2340 becomes available to the fat commands, i.e. fatls.
2341
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002342- TFTP Fixed UDP Port:
2343 CONFIG_TFTP_PORT
2344
Wolfgang Denk227b5192005-09-24 23:25:46 +02002345 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002346 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002347 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002348 number generator is used.
2349
Wolfgang Denk227b5192005-09-24 23:25:46 +02002350 Also, the environment variable tftpdstp is used to supply
2351 the TFTP UDP destination port value. If tftpdstp isn't
2352 defined, the normal port 69 is used.
2353
2354 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002355 blindly start the TFTP transfer using the pre-configured
2356 target IP address and UDP port. This has the effect of
2357 "punching through" the (Windows XP) firewall, allowing
2358 the remainder of the TFTP transfer to proceed normally.
2359 A better solution is to properly configure the firewall,
2360 but sometimes that is not allowed.
2361
Heiko Schocher443ca402014-01-25 07:27:13 +01002362- bootcount support:
2363 CONFIG_BOOTCOUNT_LIMIT
2364
2365 This enables the bootcounter support, see:
2366 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2367
2368 CONFIG_AT91SAM9XE
2369 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002370 CONFIG_SOC_DA8XX
2371 enable special bootcounter support on da850 based boards.
2372 CONFIG_BOOTCOUNT_RAM
2373 enable support for the bootcounter in RAM
2374 CONFIG_BOOTCOUNT_I2C
2375 enable support for the bootcounter on an i2c (like RTC) device.
2376 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2377 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2378 the bootcounter.
2379 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002380
wdenkc0aa5c52003-12-06 19:49:23 +00002381- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002382 CONFIG_SHOW_BOOT_PROGRESS
2383
wdenk4a5c8a72003-03-06 00:02:04 +00002384 Defining this option allows to add some board-
2385 specific code (calling a user-provided function
2386 "show_boot_progress(int)") that enables you to show
2387 the system's boot progress on some display (for
2388 example, some LED's) on your board. At the moment,
2389 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002390
Simon Glass0fa36a42012-09-28 08:56:37 +00002391
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002392Legacy uImage format:
2393
wdenkc6097192002-11-03 00:24:07 +00002394 Arg Where When
2395 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002396 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002397 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002398 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002399 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002400 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002401 4 common/cmd_bootm.c Image data has correct checksum
2402 -4 common/cmd_bootm.c Image is for unsupported architecture
2403 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002404 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002405 6 common/cmd_bootm.c Image Type check OK
2406 -6 common/cmd_bootm.c gunzip uncompression error
2407 -7 common/cmd_bootm.c Unimplemented compression type
2408 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002409 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002410 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002411
2412 9 common/image.c Start initial ramdisk verification
2413 -10 common/image.c Ramdisk header has bad magic number
2414 -11 common/image.c Ramdisk header has bad checksum
2415 10 common/image.c Ramdisk header is OK
2416 -12 common/image.c Ramdisk data has bad checksum
2417 11 common/image.c Ramdisk data has correct checksum
2418 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002419 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002420 13 common/image.c Start multifile image verification
2421 14 common/image.c No initial ramdisk, no multifile, continue.
2422
Wolfgang Denk092ae952011-10-26 10:21:21 +00002423 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002424
Stefan Roese88fbf932010-04-15 16:07:28 +02002425 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002426 -31 post/post.c POST test failed, detected by post_output_backlog()
2427 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002428
Heiko Schocher633e03a2007-06-22 19:11:54 +02002429 34 common/cmd_doc.c before loading a Image from a DOC device
2430 -35 common/cmd_doc.c Bad usage of "doc" command
2431 35 common/cmd_doc.c correct usage of "doc" command
2432 -36 common/cmd_doc.c No boot device
2433 36 common/cmd_doc.c correct boot device
2434 -37 common/cmd_doc.c Unknown Chip ID on boot device
2435 37 common/cmd_doc.c correct chip ID found, device available
2436 -38 common/cmd_doc.c Read Error on boot device
2437 38 common/cmd_doc.c reading Image header from DOC device OK
2438 -39 common/cmd_doc.c Image header has bad magic number
2439 39 common/cmd_doc.c Image header has correct magic number
2440 -40 common/cmd_doc.c Error reading Image from DOC device
2441 40 common/cmd_doc.c Image header has correct magic number
2442 41 common/cmd_ide.c before loading a Image from a IDE device
2443 -42 common/cmd_ide.c Bad usage of "ide" command
2444 42 common/cmd_ide.c correct usage of "ide" command
2445 -43 common/cmd_ide.c No boot device
2446 43 common/cmd_ide.c boot device found
2447 -44 common/cmd_ide.c Device not available
2448 44 common/cmd_ide.c Device available
2449 -45 common/cmd_ide.c wrong partition selected
2450 45 common/cmd_ide.c partition selected
2451 -46 common/cmd_ide.c Unknown partition table
2452 46 common/cmd_ide.c valid partition table found
2453 -47 common/cmd_ide.c Invalid partition type
2454 47 common/cmd_ide.c correct partition type
2455 -48 common/cmd_ide.c Error reading Image Header on boot device
2456 48 common/cmd_ide.c reading Image Header from IDE device OK
2457 -49 common/cmd_ide.c Image header has bad magic number
2458 49 common/cmd_ide.c Image header has correct magic number
2459 -50 common/cmd_ide.c Image header has bad checksum
2460 50 common/cmd_ide.c Image header has correct checksum
2461 -51 common/cmd_ide.c Error reading Image from IDE device
2462 51 common/cmd_ide.c reading Image from IDE device OK
2463 52 common/cmd_nand.c before loading a Image from a NAND device
2464 -53 common/cmd_nand.c Bad usage of "nand" command
2465 53 common/cmd_nand.c correct usage of "nand" command
2466 -54 common/cmd_nand.c No boot device
2467 54 common/cmd_nand.c boot device found
2468 -55 common/cmd_nand.c Unknown Chip ID on boot device
2469 55 common/cmd_nand.c correct chip ID found, device available
2470 -56 common/cmd_nand.c Error reading Image Header on boot device
2471 56 common/cmd_nand.c reading Image Header from NAND device OK
2472 -57 common/cmd_nand.c Image header has bad magic number
2473 57 common/cmd_nand.c Image header has correct magic number
2474 -58 common/cmd_nand.c Error reading Image from NAND device
2475 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002476
Heiko Schocher633e03a2007-06-22 19:11:54 +02002477 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002478
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002479 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002480 -64 net/eth.c no Ethernet found.
2481 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002482
Heiko Schocher633e03a2007-06-22 19:11:54 +02002483 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002484 80 common/cmd_net.c before calling net_loop()
2485 -81 common/cmd_net.c some error in net_loop() occurred
2486 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002487 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2488 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002489 83 common/cmd_net.c running "source" command
2490 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002491 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002492
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002493FIT uImage format:
2494
2495 Arg Where When
2496 100 common/cmd_bootm.c Kernel FIT Image has correct format
2497 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2498 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2499 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2500 102 common/cmd_bootm.c Kernel unit name specified
2501 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002502 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002503 104 common/cmd_bootm.c Got kernel subimage node offset
2504 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2505 105 common/cmd_bootm.c Kernel subimage hash verification OK
2506 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2507 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002508 -106 common/cmd_bootm.c Kernel subimage has wrong type
2509 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002510 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2511 108 common/cmd_bootm.c Got kernel subimage data/size
2512 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2513 -109 common/cmd_bootm.c Can't get kernel subimage type
2514 -110 common/cmd_bootm.c Can't get kernel subimage comp
2515 -111 common/cmd_bootm.c Can't get kernel subimage os
2516 -112 common/cmd_bootm.c Can't get kernel subimage load address
2517 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2518
2519 120 common/image.c Start initial ramdisk verification
2520 -120 common/image.c Ramdisk FIT image has incorrect format
2521 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002522 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002523 -122 common/image.c Can't get configuration for ramdisk subimage
2524 123 common/image.c Ramdisk unit name specified
2525 -124 common/image.c Can't get ramdisk subimage node offset
2526 125 common/image.c Got ramdisk subimage node offset
2527 -125 common/image.c Ramdisk subimage hash verification failed
2528 126 common/image.c Ramdisk subimage hash verification OK
2529 -126 common/image.c Ramdisk subimage for unsupported architecture
2530 127 common/image.c Architecture check OK
2531 -127 common/image.c Can't get ramdisk subimage data/size
2532 128 common/image.c Got ramdisk subimage data/size
2533 129 common/image.c Can't get ramdisk load address
2534 -129 common/image.c Got ramdisk load address
2535
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002536 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002537 131 common/cmd_doc.c FIT image format OK
2538
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002539 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002540 141 common/cmd_ide.c FIT image format OK
2541
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002542 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002543 151 common/cmd_nand.c FIT image format OK
2544
Heiko Schocher515eb122014-05-28 11:33:33 +02002545- legacy image format:
2546 CONFIG_IMAGE_FORMAT_LEGACY
2547 enables the legacy image format support in U-Boot.
2548
2549 Default:
2550 enabled if CONFIG_FIT_SIGNATURE is not defined.
2551
2552 CONFIG_DISABLE_IMAGE_LEGACY
2553 disable the legacy image format
2554
2555 This define is introduced, as the legacy image format is
2556 enabled per default for backward compatibility.
2557
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002558- Standalone program support:
2559 CONFIG_STANDALONE_LOAD_ADDR
2560
Wolfgang Denk23f78482011-10-09 21:06:34 +02002561 This option defines a board specific value for the
2562 address where standalone program gets loaded, thus
2563 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002564 settings.
2565
2566- Frame Buffer Address:
2567 CONFIG_FB_ADDR
2568
2569 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002570 address for frame buffer. This is typically the case
2571 when using a graphics controller has separate video
2572 memory. U-Boot will then place the frame buffer at
2573 the given address instead of dynamically reserving it
2574 in system RAM by calling lcd_setmem(), which grabs
2575 the memory for the frame buffer depending on the
2576 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002577
2578 Please see board_init_f function.
2579
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002580- Automatic software updates via TFTP server
2581 CONFIG_UPDATE_TFTP
2582 CONFIG_UPDATE_TFTP_CNT_MAX
2583 CONFIG_UPDATE_TFTP_MSEC_MAX
2584
2585 These options enable and control the auto-update feature;
2586 for a more detailed description refer to doc/README.update.
2587
2588- MTD Support (mtdparts command, UBI support)
2589 CONFIG_MTD_DEVICE
2590
2591 Adds the MTD device infrastructure from the Linux kernel.
2592 Needed for mtdparts command support.
2593
2594 CONFIG_MTD_PARTITIONS
2595
2596 Adds the MTD partitioning infrastructure from the Linux
2597 kernel. Needed for UBI support.
2598
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002599- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002600 CONFIG_UBI_SILENCE_MSG
2601
2602 Make the verbose messages from UBI stop printing. This leaves
2603 warnings and errors enabled.
2604
Heiko Schocherf5895d12014-06-24 10:10:04 +02002605
2606 CONFIG_MTD_UBI_WL_THRESHOLD
2607 This parameter defines the maximum difference between the highest
2608 erase counter value and the lowest erase counter value of eraseblocks
2609 of UBI devices. When this threshold is exceeded, UBI starts performing
2610 wear leveling by means of moving data from eraseblock with low erase
2611 counter to eraseblocks with high erase counter.
2612
2613 The default value should be OK for SLC NAND flashes, NOR flashes and
2614 other flashes which have eraseblock life-cycle 100000 or more.
2615 However, in case of MLC NAND flashes which typically have eraseblock
2616 life-cycle less than 10000, the threshold should be lessened (e.g.,
2617 to 128 or 256, although it does not have to be power of 2).
2618
2619 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002620
Heiko Schocherf5895d12014-06-24 10:10:04 +02002621 CONFIG_MTD_UBI_BEB_LIMIT
2622 This option specifies the maximum bad physical eraseblocks UBI
2623 expects on the MTD device (per 1024 eraseblocks). If the
2624 underlying flash does not admit of bad eraseblocks (e.g. NOR
2625 flash), this value is ignored.
2626
2627 NAND datasheets often specify the minimum and maximum NVM
2628 (Number of Valid Blocks) for the flashes' endurance lifetime.
2629 The maximum expected bad eraseblocks per 1024 eraseblocks
2630 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2631 which gives 20 for most NANDs (MaxNVB is basically the total
2632 count of eraseblocks on the chip).
2633
2634 To put it differently, if this value is 20, UBI will try to
2635 reserve about 1.9% of physical eraseblocks for bad blocks
2636 handling. And that will be 1.9% of eraseblocks on the entire
2637 NAND chip, not just the MTD partition UBI attaches. This means
2638 that if you have, say, a NAND flash chip admits maximum 40 bad
2639 eraseblocks, and it is split on two MTD partitions of the same
2640 size, UBI will reserve 40 eraseblocks when attaching a
2641 partition.
2642
2643 default: 20
2644
2645 CONFIG_MTD_UBI_FASTMAP
2646 Fastmap is a mechanism which allows attaching an UBI device
2647 in nearly constant time. Instead of scanning the whole MTD device it
2648 only has to locate a checkpoint (called fastmap) on the device.
2649 The on-flash fastmap contains all information needed to attach
2650 the device. Using fastmap makes only sense on large devices where
2651 attaching by scanning takes long. UBI will not automatically install
2652 a fastmap on old images, but you can set the UBI parameter
2653 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2654 that fastmap-enabled images are still usable with UBI implementations
2655 without fastmap support. On typical flash devices the whole fastmap
2656 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2657
2658 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2659 Set this parameter to enable fastmap automatically on images
2660 without a fastmap.
2661 default: 0
2662
Heiko Schocher94b66de2015-10-22 06:19:21 +02002663 CONFIG_MTD_UBI_FM_DEBUG
2664 Enable UBI fastmap debug
2665 default: 0
2666
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002667- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002668 CONFIG_UBIFS_SILENCE_MSG
2669
2670 Make the verbose messages from UBIFS stop printing. This leaves
2671 warnings and errors enabled.
2672
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002673- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002674 CONFIG_SPL
2675 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002676
Tom Rini36853852012-02-14 07:29:40 +00002677 CONFIG_SPL_LDSCRIPT
2678 LDSCRIPT for linking the SPL binary.
2679
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002680 CONFIG_SPL_MAX_FOOTPRINT
2681 Maximum size in memory allocated to the SPL, BSS included.
2682 When defined, the linker checks that the actual memory
2683 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002684 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002685 must not be both defined at the same time.
2686
Tom Rini36853852012-02-14 07:29:40 +00002687 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002688 Maximum size of the SPL image (text, data, rodata, and
2689 linker lists sections), BSS excluded.
2690 When defined, the linker checks that the actual size does
2691 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002692
Wolfgang Denk825223d2011-09-11 21:24:09 +02002693 CONFIG_SPL_TEXT_BASE
2694 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002695
Scott Woodc4f0d002012-09-20 19:05:12 -05002696 CONFIG_SPL_RELOC_TEXT_BASE
2697 Address to relocate to. If unspecified, this is equal to
2698 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2699
Tom Rini36853852012-02-14 07:29:40 +00002700 CONFIG_SPL_BSS_START_ADDR
2701 Link address for the BSS within the SPL binary.
2702
2703 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002704 Maximum size in memory allocated to the SPL BSS.
2705 When defined, the linker checks that the actual memory used
2706 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002707 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002708 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002709
2710 CONFIG_SPL_STACK
2711 Adress of the start of the stack SPL will use
2712
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002713 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2714 When defined, SPL will panic() if the image it has
2715 loaded does not have a signature.
2716 Defining this is useful when code which loads images
2717 in SPL cannot guarantee that absolutely all read errors
2718 will be caught.
2719 An example is the LPC32XX MLC NAND driver, which will
2720 consider that a completely unreadable NAND block is bad,
2721 and thus should be skipped silently.
2722
Scott Woodc4f0d002012-09-20 19:05:12 -05002723 CONFIG_SPL_RELOC_STACK
2724 Adress of the start of the stack SPL will use after
2725 relocation. If unspecified, this is equal to
2726 CONFIG_SPL_STACK.
2727
Tom Rini36853852012-02-14 07:29:40 +00002728 CONFIG_SYS_SPL_MALLOC_START
2729 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002730 When this option is set the full malloc is used in SPL and
2731 it is set up by spl_init() and before that, the simple malloc()
2732 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002733
2734 CONFIG_SYS_SPL_MALLOC_SIZE
2735 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002736
Tom Rini28591df2012-08-13 12:03:19 -07002737 CONFIG_SPL_FRAMEWORK
2738 Enable the SPL framework under common/. This framework
2739 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2740 NAND loading of the Linux Kernel.
2741
Tom Rinic2b76002014-03-28 12:03:39 -04002742 CONFIG_SPL_OS_BOOT
2743 Enable booting directly to an OS from SPL.
2744 See also: doc/README.falcon
2745
Tom Rinife3b0c72012-08-13 11:37:56 -07002746 CONFIG_SPL_DISPLAY_PRINT
2747 For ARM, enable an optional function to print more information
2748 about the running system.
2749
Scott Wood7c810902012-09-20 16:35:21 -05002750 CONFIG_SPL_INIT_MINIMAL
2751 Arch init code should be built for a very small image
2752
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002753 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2754 Partition on the MMC to load U-Boot from when the MMC is being
2755 used in raw mode
2756
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002757 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2758 Sector to load kernel uImage from when MMC is being
2759 used in raw mode (for Falcon mode)
2760
2761 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2762 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2763 Sector and number of sectors to load kernel argument
2764 parameters from when MMC is being used in raw mode
2765 (for falcon mode)
2766
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002767 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2768 Partition on the MMC to load U-Boot from when the MMC is being
2769 used in fs mode
2770
Guillaume GARDET5065b712014-10-15 17:53:13 +02002771 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2772 Filename to read to load U-Boot when reading from filesystem
2773
2774 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002775 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002776 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002777
Guillaume GARDET5065b712014-10-15 17:53:13 +02002778 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002779 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002780 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002781
Scott Wood2b36fbb2012-12-06 13:33:17 +00002782 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2783 Set this for NAND SPL on PPC mpc83xx targets, so that
2784 start.S waits for the rest of the SPL to load before
2785 continuing (the hardware starts execution after just
2786 loading the first page rather than the full 4K).
2787
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302788 CONFIG_SPL_SKIP_RELOCATE
2789 Avoid SPL relocation
2790
Scott Woodc352a0c2012-09-20 19:09:07 -05002791 CONFIG_SPL_NAND_BASE
2792 Include nand_base.c in the SPL. Requires
2793 CONFIG_SPL_NAND_DRIVERS.
2794
2795 CONFIG_SPL_NAND_DRIVERS
2796 SPL uses normal NAND drivers, not minimal drivers.
2797
2798 CONFIG_SPL_NAND_ECC
2799 Include standard software ECC in the SPL
2800
Tom Rini36853852012-02-14 07:29:40 +00002801 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002802 Support for NAND boot using simple NAND drivers that
2803 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002804
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002805 CONFIG_SPL_UBI
2806 Support for a lightweight UBI (fastmap) scanner and
2807 loader
2808
Heiko Schochercf000272014-10-31 08:31:00 +01002809 CONFIG_SPL_NAND_RAW_ONLY
2810 Support to boot only raw u-boot.bin images. Use this only
2811 if you need to save space.
2812
Ying Zhangdfb2b152013-08-16 15:16:12 +08002813 CONFIG_SPL_COMMON_INIT_DDR
2814 Set for common ddr init with serial presence detect in
2815 SPL binary.
2816
Tom Rini36853852012-02-14 07:29:40 +00002817 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2818 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2819 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2820 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2821 CONFIG_SYS_NAND_ECCBYTES
2822 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002823 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002824
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302825 CONFIG_SPL_NAND_BOOT
2826 Add support NAND boot
2827
Tom Rini36853852012-02-14 07:29:40 +00002828 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002829 Location in NAND to read U-Boot from
2830
2831 CONFIG_SYS_NAND_U_BOOT_DST
2832 Location in memory to load U-Boot to
2833
2834 CONFIG_SYS_NAND_U_BOOT_SIZE
2835 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002836
2837 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002838 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002839
2840 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2841 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002842 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002843
Pavel Machekde997252012-08-30 22:42:11 +02002844 CONFIG_SPL_RAM_DEVICE
2845 Support for running image already present in ram, in SPL binary
2846
Scott Woodeb7bd972012-12-06 13:33:16 +00002847 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002848 Image offset to which the SPL should be padded before appending
2849 the SPL payload. By default, this is defined as
2850 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2851 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2852 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002853
Scott Woodf147eb72012-09-21 16:27:32 -05002854 CONFIG_SPL_TARGET
2855 Final target image containing SPL and payload. Some SPLs
2856 use an arch-specific makefile fragment instead, for
2857 example if more than one image needs to be produced.
2858
Simon Glass82d94532013-05-08 08:05:59 +00002859 CONFIG_FIT_SPL_PRINT
2860 Printing information about a FIT image adds quite a bit of
2861 code to SPL. So this is normally disabled in SPL. Use this
2862 option to re-enable it. This will affect the output of the
2863 bootm command when booting a FIT image.
2864
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002865- TPL framework
2866 CONFIG_TPL
2867 Enable building of TPL globally.
2868
2869 CONFIG_TPL_PAD_TO
2870 Image offset to which the TPL should be padded before appending
2871 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002872 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2873 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2874 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002875
wdenkc0aa5c52003-12-06 19:49:23 +00002876- Interrupt support (PPC):
2877
wdenk1ebf41e2004-01-02 14:00:00 +00002878 There are common interrupt_init() and timer_interrupt()
2879 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002880 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002881 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002882 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002883 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002884 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002885 specific handling. If board has watchdog / status_led
2886 / other_activity_monitor it works automatically from
2887 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002888
wdenkc6097192002-11-03 00:24:07 +00002889
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002890Board initialization settings:
2891------------------------------
2892
2893During Initialization u-boot calls a number of board specific functions
2894to allow the preparation of board specific prerequisites, e.g. pin setup
2895before drivers are initialized. To enable these callbacks the
2896following configuration macros have to be defined. Currently this is
2897architecture specific, so please check arch/your_architecture/lib/board.c
2898typically in board_init_f() and board_init_r().
2899
2900- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2901- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2902- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2903- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002904
wdenkc6097192002-11-03 00:24:07 +00002905Configuration Settings:
2906-----------------------
2907
York Sun6c480012014-02-26 17:03:19 -08002908- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2909 Optionally it can be defined to support 64-bit memory commands.
2910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002911- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002912 undefine this when you're short of memory.
2913
Peter Tyserdfb72b82009-01-27 18:03:12 -06002914- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2915 width of the commands listed in the 'help' command output.
2916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002917- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002918 prompt for user input.
2919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002920- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002922- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002924- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002926- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002927 the application (usually a Linux kernel) when it is
2928 booted
2929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002930- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002931 List of legal baudrate settings for this board.
2932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002933- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002934 Begin and End addresses of the area used by the
2935 simple memory test.
2936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002937- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002938 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002939
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002940- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002941 Scratch address used by the alternate memory test
2942 You only need to set this if address zero isn't writeable
2943
York Sun5d286cd2015-12-04 11:57:07 -08002944- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002945 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002946 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2947 is substracted from total RAM and won't be reported to OS.
2948 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002949 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002950 the RAM base is not zero, or RAM is divided into banks,
2951 this variable needs to be recalcuated to get the address.
2952
York Sun50739372015-12-07 11:05:29 -08002953- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002954 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002955 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002956 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002957 fixing up gd->ram_size the Linux kernel should gets passed
2958 the now "corrected" memory size and won't touch it either.
2959 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002960 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002961 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002962 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002963
2964 This option can be used as a workaround for the 440EPx/GRx
2965 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2966 be touched.
2967
2968 WARNING: Please make sure that this value is a multiple of
2969 the Linux page size (normally 4k). If this is not the case,
2970 then the end address of the Linux memory will be located at a
2971 non page size aligned address and this could cause major
2972 problems.
2973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002974- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002975 Enable temporary baudrate change while serial download
2976
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002977- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002978 Physical start address of SDRAM. _Must_ be 0 here.
2979
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002980- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002981 Physical start address of Flash memory.
2982
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002983- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002984 Physical start address of boot monitor code (set by
2985 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002986 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002987 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002988
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002989- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002990 Size of memory reserved for monitor code, used to
2991 determine _at_compile_time_ (!) if the environment is
2992 embedded within the U-Boot image, or in a separate
2993 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002995- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002996 Size of DRAM reserved for malloc() use.
2997
Simon Glass863e4042014-07-10 22:23:28 -06002998- CONFIG_SYS_MALLOC_F_LEN
2999 Size of the malloc() pool for use before relocation. If
3000 this is defined, then a very simple malloc() implementation
3001 will become available before relocation. The address is just
3002 below the global data, and the stack is moved down to make
3003 space.
3004
3005 This feature allocates regions with increasing addresses
3006 within the region. calloc() is supported, but realloc()
3007 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003008 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003009 U-Boot relocates itself.
3010
Simon Glass9fa901b2014-11-10 17:16:54 -07003011- CONFIG_SYS_MALLOC_SIMPLE
3012 Provides a simple and small malloc() and calloc() for those
3013 boards which do not use the full malloc in SPL (which is
3014 enabled with CONFIG_SYS_SPL_MALLOC_START).
3015
Thierry Redingc97d9742014-12-09 22:25:22 -07003016- CONFIG_SYS_NONCACHED_MEMORY:
3017 Size of non-cached memory area. This area of memory will be
3018 typically located right below the malloc() area and mapped
3019 uncached in the MMU. This is useful for drivers that would
3020 otherwise require a lot of explicit cache maintenance. For
3021 some drivers it's also impossible to properly maintain the
3022 cache. For example if the regions that need to be flushed
3023 are not a multiple of the cache-line size, *and* padding
3024 cannot be allocated between the regions to align them (i.e.
3025 if the HW requires a contiguous array of regions, and the
3026 size of each region is not cache-aligned), then a flush of
3027 one region may result in overwriting data that hardware has
3028 written to another region in the same cache-line. This can
3029 happen for example in network drivers where descriptors for
3030 buffers are typically smaller than the CPU cache-line (e.g.
3031 16 bytes vs. 32 or 64 bytes).
3032
3033 Non-cached memory is only supported on 32-bit ARM at present.
3034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003035- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003036 Normally compressed uImages are limited to an
3037 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003038 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003039 to adjust this setting to your needs.
3040
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003041- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003042 Maximum size of memory mapped by the startup code of
3043 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003044 the Linux kernel (bd_info, boot arguments, FDT blob if
3045 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003046 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003047 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003048 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003049 variable "bootm_mapsize" will override the value of
3050 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3051 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003052
John Rigbyeea8e692010-10-13 13:57:35 -06003053- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3054 Enable initrd_high functionality. If defined then the
3055 initrd_high feature is enabled and the bootm ramdisk subcommand
3056 is enabled.
3057
3058- CONFIG_SYS_BOOT_GET_CMDLINE:
3059 Enables allocating and saving kernel cmdline in space between
3060 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3061
3062- CONFIG_SYS_BOOT_GET_KBD:
3063 Enables allocating and saving a kernel copy of the bd_info in
3064 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003066- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003067 Max number of Flash memory banks
3068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003069- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003070 Max number of sectors on a Flash chip
3071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003073 Timeout for Flash erase operations (in ms)
3074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003075- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003076 Timeout for Flash write operations (in ms)
3077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003079 Timeout for Flash set sector lock bit operation (in ms)
3080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003081- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003082 Timeout for Flash clear lock bits operation (in ms)
3083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003084- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003085 If defined, hardware flash sectors protection is used
3086 instead of U-Boot software protection.
3087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003088- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003089
3090 Enable TFTP transfers directly to flash memory;
3091 without this option such a download has to be
3092 performed in two steps: (1) download to RAM, and (2)
3093 copy from RAM to flash.
3094
3095 The two-step approach is usually more reliable, since
3096 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003097 the flash, but in some situations (when system RAM is
3098 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003099 downloaded image) this option may be very useful.
3100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003101- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003102 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003103 common flash structure for storing flash geometry.
3104
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003105- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003106 This option also enables the building of the cfi_flash driver
3107 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003108
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003109- CONFIG_FLASH_CFI_MTD
3110 This option enables the building of the cfi_mtd driver
3111 in the drivers directory. The driver exports CFI flash
3112 to the MTD layer.
3113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003114- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003115 Use buffered writes to flash.
3116
3117- CONFIG_FLASH_SPANSION_S29WS_N
3118 s29ws-n MirrorBit flash has non-standard addresses for buffered
3119 write commands.
3120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003121- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003122 If this option is defined, the common CFI flash doesn't
3123 print it's warning upon not recognized FLASH banks. This
3124 is useful, if some of the configured banks are only
3125 optionally available.
3126
Jerry Van Barenaae73572008-03-08 13:48:01 -05003127- CONFIG_FLASH_SHOW_PROGRESS
3128 If defined (must be an integer), print out countdown
3129 digits and dots. Recommended value: 45 (9..1) for 80
3130 column displays, 15 (3..1) for 40 column displays.
3131
Stefan Roesed20cba52013-04-04 15:53:14 +02003132- CONFIG_FLASH_VERIFY
3133 If defined, the content of the flash (destination) is compared
3134 against the source after the write operation. An error message
3135 will be printed when the contents are not identical.
3136 Please note that this option is useless in nearly all cases,
3137 since such flash programming errors usually are detected earlier
3138 while unprotecting/erasing/programming. Please only enable
3139 this option if you really know what you are doing.
3140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003141- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003142 Defines the number of Ethernet receive buffers. On some
3143 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003144 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3145 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003146 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003147 Defaults to 4 if not defined.
3148
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003149- CONFIG_ENV_MAX_ENTRIES
3150
Wolfgang Denk1136f692010-10-27 22:48:30 +02003151 Maximum number of entries in the hash table that is used
3152 internally to store the environment settings. The default
3153 setting is supposed to be generous and should work in most
3154 cases. This setting can be used to tune behaviour; see
3155 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003156
Joe Hershberger71497d02012-12-11 22:16:31 -06003157- CONFIG_ENV_FLAGS_LIST_DEFAULT
3158- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003159 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003160 calling env set. Variables can be restricted to only decimal,
3161 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3162 the variables can also be restricted to IP address or MAC address.
3163
3164 The format of the list is:
3165 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003166 access_attribute = [a|r|o|c]
3167 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003168 entry = variable_name[:attributes]
3169 list = entry[,list]
3170
3171 The type attributes are:
3172 s - String (default)
3173 d - Decimal
3174 x - Hexadecimal
3175 b - Boolean ([1yYtT|0nNfF])
3176 i - IP address
3177 m - MAC address
3178
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003179 The access attributes are:
3180 a - Any (default)
3181 r - Read-only
3182 o - Write-once
3183 c - Change-default
3184
Joe Hershberger71497d02012-12-11 22:16:31 -06003185 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3186 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003187 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003188
3189 - CONFIG_ENV_FLAGS_LIST_STATIC
3190 Define this to a list (string) to define validation that
3191 should be done if an entry is not found in the ".flags"
3192 environment variable. To override a setting in the static
3193 list, simply add an entry for the same variable name to the
3194 ".flags" variable.
3195
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003196 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3197 regular expression. This allows multiple variables to define the same
3198 flags without explicitly listing them for each variable.
3199
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003200- CONFIG_ENV_ACCESS_IGNORE_FORCE
3201 If defined, don't allow the -f switch to env set override variable
3202 access flags.
3203
Gabe Black3687fe42014-10-15 04:38:30 -06003204- CONFIG_USE_STDINT
3205 If stdint.h is available with your toolchain you can define this
3206 option to enable it. You can provide option 'USE_STDINT=1' when
3207 building U-Boot to enable this.
3208
wdenkc6097192002-11-03 00:24:07 +00003209The following definitions that deal with the placement and management
3210of environment data (variable area); in general, we support the
3211following configurations:
3212
Mike Frysinger63b8f122011-07-08 10:44:25 +00003213- CONFIG_BUILD_ENVCRC:
3214
3215 Builds up envcrc with the target environment so that external utils
3216 may easily extract it and embed it in final U-Boot images.
3217
wdenkc6097192002-11-03 00:24:07 +00003218BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003219in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003220console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003221U-Boot will hang.
3222
3223Please note that even with NVRAM we still use a copy of the
3224environment in RAM: we could work on NVRAM directly, but we want to
3225keep settings there always unmodified except somebody uses "saveenv"
3226to save the current settings.
3227
Liu Gang85bcd732012-03-08 00:33:20 +00003228BE CAREFUL! For some special cases, the local device can not use
3229"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003230environment stored in a remote NOR flash by SRIO or PCIE link,
3231but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003232
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003233- CONFIG_NAND_ENV_DST
3234
3235 Defines address in RAM to which the nand_spl code should copy the
3236 environment. If redundant environment is used, it will be copied to
3237 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3238
Bruce Adleredecc942007-11-02 13:15:42 -07003239Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003240has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06003241created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003242until then to read environment variables.
3243
wdenk8dba0502003-03-31 16:34:49 +00003244The environment is protected by a CRC32 checksum. Before the monitor
3245is relocated into RAM, as a result of a bad CRC you will be working
3246with the compiled-in default environment - *silently*!!! [This is
3247necessary, because the first environment variable we need is the
3248"baudrate" setting for the console - if we have a bad CRC, we don't
3249have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003250
3251Note: once the monitor has been relocated, then it will complain if
3252the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003253use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003255- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003256 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003258 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003259 also needs to be defined.
3260
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003261- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003262 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003263
Ron Madriddfa028a2009-02-18 14:30:44 -08003264- CONFIG_NS16550_MIN_FUNCTIONS:
3265 Define this if you desire to only have use of the NS16550_init
3266 and NS16550_putc functions for the serial driver located at
3267 drivers/serial/ns16550.c. This option is useful for saving
3268 space for already greatly restricted images, including but not
3269 limited to NAND_SPL configurations.
3270
Simon Glass28a9e332012-11-30 13:01:18 +00003271- CONFIG_DISPLAY_BOARDINFO
3272 Display information about the board that U-Boot is running on
3273 when U-Boot starts up. The board function checkboard() is called
3274 to do this.
3275
Simon Glasse8822012012-11-30 13:01:19 +00003276- CONFIG_DISPLAY_BOARDINFO_LATE
3277 Similar to the previous option, but display this information
3278 later, once stdio is running and output goes to the LCD, if
3279 present.
3280
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003281- CONFIG_BOARD_SIZE_LIMIT:
3282 Maximum size of the U-Boot image. When defined, the
3283 build system checks that the actual size does not
3284 exceed it.
3285
wdenkc6097192002-11-03 00:24:07 +00003286Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003287---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003288
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003289- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003290 Cache Line Size of the CPU.
3291
Timur Tabid8f341c2011-08-04 18:03:41 -05003292- CONFIG_SYS_CCSRBAR_DEFAULT:
3293 Default (power-on reset) physical address of CCSR on Freescale
3294 PowerPC SOCs.
3295
3296- CONFIG_SYS_CCSRBAR:
3297 Virtual address of CCSR. On a 32-bit build, this is typically
3298 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3299
Timur Tabid8f341c2011-08-04 18:03:41 -05003300- CONFIG_SYS_CCSRBAR_PHYS:
3301 Physical address of CCSR. CCSR can be relocated to a new
3302 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003303 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003304 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3305 is typically relocated on 36-bit builds. It is recommended
3306 that this macro be defined via the _HIGH and _LOW macros:
3307
3308 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3309 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3310
3311- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003312 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3313 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003314 used in assembly code, so it must not contain typecasts or
3315 integer size suffixes (e.g. "ULL").
3316
3317- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3318 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3319 used in assembly code, so it must not contain typecasts or
3320 integer size suffixes (e.g. "ULL").
3321
3322- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3323 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3324 forced to a value that ensures that CCSR is not relocated.
3325
wdenk1272e232002-11-10 22:06:23 +00003326- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003327 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003328
3329 the default drive number (default value 0)
3330
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003331 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003333 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003334 (default value 1)
3335
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003336 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003337
wdenk4a5c8a72003-03-06 00:02:04 +00003338 defines the offset of register from address. It
3339 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003340 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003341
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003342 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3343 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003344 default value.
wdenk1272e232002-11-10 22:06:23 +00003345
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003346 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003347 fdc_hw_init() is called at the beginning of the FDC
3348 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003349 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003350 initializations.
wdenk1272e232002-11-10 22:06:23 +00003351
Macpaul Lind1e49942011-04-11 20:45:32 +00003352- CONFIG_IDE_AHB:
3353 Most IDE controllers were designed to be connected with PCI
3354 interface. Only few of them were designed for AHB interface.
3355 When software is doing ATA command and data transfer to
3356 IDE devices through IDE-AHB controller, some additional
3357 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003358 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003359
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003360- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003361 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003362 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003363
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003364- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003365
wdenkeb20ad32003-09-05 23:19:14 +00003366 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003367 initial data and stack; please note that this must be
3368 writable memory that is working WITHOUT special
3369 initialization, i. e. you CANNOT use normal RAM which
3370 will become available only after programming the
3371 memory controller and running certain initialization
3372 sequences.
3373
3374 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003375 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003376
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003377- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003378
3379 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003380 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3381 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003382 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003383 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003384 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003385 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3386 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003387
3388 Note:
3389 On the MPC824X (or other systems that use the data
3390 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003391 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003392 point to an otherwise UNUSED address space between
3393 the top of RAM and the start of the PCI space.
3394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003395- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003397- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003398 SDRAM timing
3399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003400- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003401 periodic timer for refresh
3402
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003403- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3404 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3405 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3406 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003407 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3408
3409- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003410 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3411 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003412 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3413
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003414- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003415 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003416 Don't do any setup work, presumably because someone or
3417 something has already done it, and we don't need to do it
3418 a second time. Useful for platforms that are pre-booted
3419 by coreboot or similar.
3420
Gabor Juhosb4458732013-05-30 07:06:12 +00003421- CONFIG_PCI_INDIRECT_BRIDGE:
3422 Enable support for indirect PCI bridges.
3423
Kumar Gala8975d7a2010-12-30 12:09:53 -06003424- CONFIG_SYS_SRIO:
3425 Chip has SRIO or not
3426
3427- CONFIG_SRIO1:
3428 Board has SRIO 1 port available
3429
3430- CONFIG_SRIO2:
3431 Board has SRIO 2 port available
3432
Liu Gang27afb9c2013-05-07 16:30:46 +08003433- CONFIG_SRIO_PCIE_BOOT_MASTER
3434 Board can support master function for Boot from SRIO and PCIE
3435
Kumar Gala8975d7a2010-12-30 12:09:53 -06003436- CONFIG_SYS_SRIOn_MEM_VIRT:
3437 Virtual Address of SRIO port 'n' memory region
3438
3439- CONFIG_SYS_SRIOn_MEM_PHYS:
3440 Physical Address of SRIO port 'n' memory region
3441
3442- CONFIG_SYS_SRIOn_MEM_SIZE:
3443 Size of SRIO port 'n' memory region
3444
Fabio Estevamf17e8782013-04-11 09:35:34 +00003445- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3446 Defined to tell the NAND controller that the NAND chip is using
3447 a 16 bit bus.
3448 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003449 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003450 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003451 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003452
3453- CONFIG_SYS_NDFC_EBC0_CFG
3454 Sets the EBC0_CFG register for the NDFC. If not defined
3455 a default value will be used.
3456
Ben Warren45657152006-09-07 16:50:54 -04003457- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003458 Get DDR timing information from an I2C EEPROM. Common
3459 with pluggable memory modules such as SODIMMs
3460
Ben Warren45657152006-09-07 16:50:54 -04003461 SPD_EEPROM_ADDRESS
3462 I2C address of the SPD EEPROM
3463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003464- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003465 If SPD EEPROM is on an I2C bus other than the first
3466 one, specify here. Note that the value must resolve
3467 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003468
York Sune73cc042011-06-07 09:42:16 +08003469- CONFIG_SYS_DDR_RAW_TIMING
3470 Get DDR timing information from other than SPD. Common with
3471 soldered DDR chips onboard without SPD. DDR raw timing
3472 parameters are extracted from datasheet and hard-coded into
3473 header files or board specific files.
3474
York Sunbd495cf2011-09-16 13:21:35 -07003475- CONFIG_FSL_DDR_INTERACTIVE
3476 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3477
York Sun8ced0502015-01-06 13:18:55 -08003478- CONFIG_FSL_DDR_SYNC_REFRESH
3479 Enable sync of refresh for multiple controllers.
3480
York Sunb6a35f82015-03-19 09:30:28 -07003481- CONFIG_FSL_DDR_BIST
3482 Enable built-in memory test for Freescale DDR controllers.
3483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003484- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003485 Only for 83xx systems. If specified, then DDR should
3486 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003487
wdenk6203e402004-04-18 10:13:26 +00003488- CONFIG_RMII
3489 Enable RMII mode for all FECs.
3490 Note that this is a global option, we can't
3491 have one FEC in standard MII mode and another in RMII mode.
3492
wdenk20c98a62004-04-23 20:32:05 +00003493- CONFIG_CRC32_VERIFY
3494 Add a verify option to the crc32 command.
3495 The syntax is:
3496
3497 => crc32 -v <address> <count> <crc32>
3498
3499 Where address/count indicate a memory area
3500 and crc32 is the correct crc32 which the
3501 area should have.
3502
wdenk64519362004-07-11 17:40:54 +00003503- CONFIG_LOOPW
3504 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003505 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003506
stroesecc3af832004-12-16 18:46:55 +00003507- CONFIG_MX_CYCLIC
3508 Add the "mdc" and "mwc" memory commands. These are cyclic
3509 "md/mw" commands.
3510 Examples:
3511
wdenk07d7e6b2004-12-16 21:44:03 +00003512 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003513 This command will print 4 bytes (10,11,12,13) each 500 ms.
3514
wdenk07d7e6b2004-12-16 21:44:03 +00003515 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003516 This command will write 12345678 to address 100 all 10 ms.
3517
wdenk07d7e6b2004-12-16 21:44:03 +00003518 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003519 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003520
wdenk3d3d99f2005-04-04 12:44:11 +00003521- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003522 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003523 low level initializations (like setting up the memory
3524 controller) are omitted and/or U-Boot does not
3525 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003526
Wolfgang Denk302141d2010-11-27 23:30:56 +01003527 Normally this variable MUST NOT be defined. The only
3528 exception is when U-Boot is loaded (to RAM) by some
3529 other boot loader or by a debugger which performs
3530 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003531
Simon Glass90844072016-05-05 07:28:06 -06003532- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3533 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003534 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003535 instruction cache) is still performed.
3536
Aneesh V552a3192011-07-13 05:11:07 +00003537- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003538 Modifies the behaviour of start.S when compiling a loader
3539 that is executed before the actual U-Boot. E.g. when
3540 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003541
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003542- CONFIG_TPL_BUILD
3543 Modifies the behaviour of start.S when compiling a loader
3544 that is executed after the SPL and before the actual U-Boot.
3545 It is loaded by the SPL.
3546
Ying Zhang0d4f5442013-05-20 14:07:23 +08003547- CONFIG_SYS_MPC85XX_NO_RESETVEC
3548 Only for 85xx systems. If this variable is specified, the section
3549 .resetvec is not kept and the section .bootpg is placed in the
3550 previous 4k of the .text section.
3551
Simon Glass17dabf02013-02-24 17:33:14 +00003552- CONFIG_ARCH_MAP_SYSMEM
3553 Generally U-Boot (and in particular the md command) uses
3554 effective address. It is therefore not necessary to regard
3555 U-Boot address as virtual addresses that need to be translated
3556 to physical addresses. However, sandbox requires this, since
3557 it maintains its own little RAM buffer which contains all
3558 addressable memory. This option causes some memory accesses
3559 to be mapped through map_sysmem() / unmap_sysmem().
3560
Simon Glassbfb59802013-02-14 04:18:54 +00003561- CONFIG_X86_RESET_VECTOR
3562 If defined, the x86 reset vector code is included. This is not
3563 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003564
Heiko Schocher2233e462013-11-04 14:05:00 +01003565- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3566 Enables the RTC32K OSC on AM33xx based plattforms
3567
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003568- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3569 Option to disable subpage write in NAND driver
3570 driver that uses this:
3571 drivers/mtd/nand/davinci_nand.c
3572
Timur Tabi275f4bb2011-11-22 09:21:25 -06003573Freescale QE/FMAN Firmware Support:
3574-----------------------------------
3575
3576The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3577loading of "firmware", which is encoded in the QE firmware binary format.
3578This firmware often needs to be loaded during U-Boot booting, so macros
3579are used to identify the storage device (NOR flash, SPI, etc) and the address
3580within that device.
3581
Zhao Qiang83a90842014-03-21 16:21:44 +08003582- CONFIG_SYS_FMAN_FW_ADDR
3583 The address in the storage device where the FMAN microcode is located. The
3584 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3585 is also specified.
3586
3587- CONFIG_SYS_QE_FW_ADDR
3588 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003589 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3590 is also specified.
3591
3592- CONFIG_SYS_QE_FMAN_FW_LENGTH
3593 The maximum possible size of the firmware. The firmware binary format
3594 has a field that specifies the actual size of the firmware, but it
3595 might not be possible to read any part of the firmware unless some
3596 local storage is allocated to hold the entire firmware first.
3597
3598- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3599 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3600 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3601 virtual address in NOR flash.
3602
3603- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3604 Specifies that QE/FMAN firmware is located in NAND flash.
3605 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3606
3607- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3608 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3609 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3610
Liu Gang1e084582012-03-08 00:33:18 +00003611- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3612 Specifies that QE/FMAN firmware is located in the remote (master)
3613 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003614 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3615 window->master inbound window->master LAW->the ucode address in
3616 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003617
J. German Rivera8ff14b72014-06-23 15:15:55 -07003618Freescale Layerscape Management Complex Firmware Support:
3619---------------------------------------------------------
3620The Freescale Layerscape Management Complex (MC) supports the loading of
3621"firmware".
3622This firmware often needs to be loaded during U-Boot booting, so macros
3623are used to identify the storage device (NOR flash, SPI, etc) and the address
3624within that device.
3625
3626- CONFIG_FSL_MC_ENET
3627 Enable the MC driver for Layerscape SoCs.
3628
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303629Freescale Layerscape Debug Server Support:
3630-------------------------------------------
3631The Freescale Layerscape Debug Server Support supports the loading of
3632"Debug Server firmware" and triggering SP boot-rom.
3633This firmware often needs to be loaded during U-Boot booting.
3634
York Sun928b6812015-12-07 11:08:58 -08003635- CONFIG_SYS_MC_RSV_MEM_ALIGN
3636 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303637
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003638Reproducible builds
3639-------------------
3640
3641In order to achieve reproducible builds, timestamps used in the U-Boot build
3642process have to be set to a fixed value.
3643
3644This is done using the SOURCE_DATE_EPOCH environment variable.
3645SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3646option for U-Boot or an environment variable in U-Boot.
3647
3648SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3649
wdenkc6097192002-11-03 00:24:07 +00003650Building the Software:
3651======================
3652
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003653Building U-Boot has been tested in several native build environments
3654and in many different cross environments. Of course we cannot support
3655all possibly existing versions of cross development tools in all
3656(potentially obsolete) versions. In case of tool chain problems we
3657recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3658which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003659
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003660If you are not using a native environment, it is assumed that you
3661have GNU cross compiling tools available in your path. In this case,
3662you must set the environment variable CROSS_COMPILE in your shell.
3663Note that no changes to the Makefile or any other source files are
3664necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003665
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003666 $ CROSS_COMPILE=ppc_4xx-
3667 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003668
Peter Tyserb06976d2009-03-13 18:54:51 -05003669Note: If you wish to generate Windows versions of the utilities in
3670 the tools directory you can use the MinGW toolchain
3671 (http://www.mingw.org). Set your HOST tools to the MinGW
3672 toolchain and execute 'make tools'. For example:
3673
3674 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3675
3676 Binaries such as tools/mkimage.exe will be created which can
3677 be executed on computers running Windows.
3678
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003679U-Boot is intended to be simple to build. After installing the
3680sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003681is done by typing:
3682
Holger Freyther7ba4e572014-08-04 09:26:05 +02003683 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003684
Holger Freyther7ba4e572014-08-04 09:26:05 +02003685where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003686rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003687
wdenk6c59edc2004-05-03 20:45:30 +00003688Note: for some board special configuration names may exist; check if
3689 additional information is available from the board vendor; for
3690 instance, the TQM823L systems are available without (standard)
3691 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003692 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003693
Holger Freyther7ba4e572014-08-04 09:26:05 +02003694 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003695 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003696
Holger Freyther7ba4e572014-08-04 09:26:05 +02003697 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003698 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk6c59edc2004-05-03 20:45:30 +00003700 etc.
wdenkc6097192002-11-03 00:24:07 +00003701
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk6c59edc2004-05-03 20:45:30 +00003703Finally, type "make all", and you should get some working U-Boot
3704images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk6c59edc2004-05-03 20:45:30 +00003706- "u-boot.bin" is a raw binary image
3707- "u-boot" is an image in ELF binary format
3708- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003709
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003710By default the build is performed locally and the objects are saved
3711in the source directory. One of the two methods can be used to change
3712this behavior and build U-Boot to some external directory:
3713
37141. Add O= to the make command line invocations:
3715
3716 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003717 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003718 make O=/tmp/build all
3719
Timo Ketolac8c67602014-11-06 14:39:05 +020037202. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003721
Timo Ketolac8c67602014-11-06 14:39:05 +02003722 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003723 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003724 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003725 make all
3726
Timo Ketolac8c67602014-11-06 14:39:05 +02003727Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003728variable.
3729
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk6c59edc2004-05-03 20:45:30 +00003731Please be aware that the Makefiles assume you are using GNU make, so
3732for instance on NetBSD you might need to use "gmake" instead of
3733native "make".
wdenkc6097192002-11-03 00:24:07 +00003734
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk6c59edc2004-05-03 20:45:30 +00003736If the system board that you have is not listed, then you will need
3737to port U-Boot to your hardware platform. To do this, follow these
3738steps:
wdenkc6097192002-11-03 00:24:07 +00003739
Phil Sutterc77b4882015-12-25 14:41:18 +010037401. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003741 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003742 the "Makefile" and a "<board>.c".
37432. Create a new configuration file "include/configs/<board>.h" for
3744 your board.
wdenk6c59edc2004-05-03 20:45:30 +000037453. If you're porting U-Boot to a new CPU, then also create a new
3746 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020037474. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000037485. Type "make", and you should get a working "u-boot.srec" file
3749 to be installed on your target system.
37506. Debug and solve any problems that might arise.
3751 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003752
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk6c59edc2004-05-03 20:45:30 +00003754Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3755==============================================================
wdenkc6097192002-11-03 00:24:07 +00003756
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003757If you have modified U-Boot sources (for instance added a new board
3758or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003759provide feedback to the other developers. The feedback normally takes
3760the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003761official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003762
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003763But before you submit such a patch, please verify that your modifi-
3764cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003765the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003766just run the buildman script (tools/buildman/buildman), which will
3767configure and build U-Boot for ALL supported system. Be warned, this
3768will take a while. Please see the buildman README, or run 'buildman -H'
3769for documentation.
wdenkc6097192002-11-03 00:24:07 +00003770
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003771
wdenk6c59edc2004-05-03 20:45:30 +00003772See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003773
wdenkc6097192002-11-03 00:24:07 +00003774
wdenk6c59edc2004-05-03 20:45:30 +00003775Monitor Commands - Overview:
3776============================
wdenkc6097192002-11-03 00:24:07 +00003777
wdenk6c59edc2004-05-03 20:45:30 +00003778go - start application at address 'addr'
3779run - run commands in an environment variable
3780bootm - boot application image from memory
3781bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003782bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003783tftpboot- boot image via network using TFTP protocol
3784 and env variables "ipaddr" and "serverip"
3785 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003786tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003787rarpboot- boot image via network using RARP/TFTP protocol
3788diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3789loads - load S-Record file over serial line
3790loadb - load binary file over serial line (kermit mode)
3791md - memory display
3792mm - memory modify (auto-incrementing)
3793nm - memory modify (constant address)
3794mw - memory write (fill)
3795cp - memory copy
3796cmp - memory compare
3797crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003798i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003799sspi - SPI utility commands
3800base - print or set address offset
3801printenv- print environment variables
3802setenv - set environment variables
3803saveenv - save environment variables to persistent storage
3804protect - enable or disable FLASH write protection
3805erase - erase FLASH memory
3806flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003807nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003808bdinfo - print Board Info structure
3809iminfo - print header information for application image
3810coninfo - print console devices and informations
3811ide - IDE sub-system
3812loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003813loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003814mtest - simple RAM test
3815icache - enable or disable instruction cache
3816dcache - enable or disable data cache
3817reset - Perform RESET of the CPU
3818echo - echo args to console
3819version - print monitor version
3820help - print online help
3821? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003822
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk6c59edc2004-05-03 20:45:30 +00003824Monitor Commands - Detailed Description:
3825========================================
wdenkc6097192002-11-03 00:24:07 +00003826
wdenk6c59edc2004-05-03 20:45:30 +00003827TODO.
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk6c59edc2004-05-03 20:45:30 +00003829For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003830
3831
wdenk6c59edc2004-05-03 20:45:30 +00003832Environment Variables:
3833======================
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk6c59edc2004-05-03 20:45:30 +00003835U-Boot supports user configuration using Environment Variables which
3836can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003837
wdenk6c59edc2004-05-03 20:45:30 +00003838Environment Variables are set using "setenv", printed using
3839"printenv", and saved to Flash using "saveenv". Using "setenv"
3840without a value can be used to delete a variable from the
3841environment. As long as you don't save the environment you are
3842working with an in-memory copy. In case the Flash area containing the
3843environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003844
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003845Some configuration options can be set using Environment Variables.
3846
3847List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk6c59edc2004-05-03 20:45:30 +00003849 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk6c59edc2004-05-03 20:45:30 +00003851 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003852
wdenk6c59edc2004-05-03 20:45:30 +00003853 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003854
wdenk6c59edc2004-05-03 20:45:30 +00003855 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003856
wdenk6c59edc2004-05-03 20:45:30 +00003857 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003858
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003859 bootm_low - Memory range available for image processing in the bootm
3860 command can be restricted. This variable is given as
3861 a hexadecimal number and defines lowest address allowed
3862 for use by the bootm command. See also "bootm_size"
3863 environment variable. Address defined by "bootm_low" is
3864 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003865 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3866 bootm_mapsize.
3867
Wolfgang Denk092ae952011-10-26 10:21:21 +00003868 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003869 This variable is given as a hexadecimal number and it
3870 defines the size of the memory region starting at base
3871 address bootm_low that is accessible by the Linux kernel
3872 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3873 as the default value if it is defined, and bootm_size is
3874 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003875
3876 bootm_size - Memory range available for image processing in the bootm
3877 command can be restricted. This variable is given as
3878 a hexadecimal number and defines the size of the region
3879 allowed for use by the bootm command. See also "bootm_low"
3880 environment variable.
3881
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003882 updatefile - Location of the software update file on a TFTP server, used
3883 by the automatic software update feature. Please refer to
3884 documentation in doc/README.update for more details.
3885
wdenk6c59edc2004-05-03 20:45:30 +00003886 autoload - if set to "no" (any string beginning with 'n'),
3887 "bootp" will just load perform a lookup of the
3888 configuration from the BOOTP server, but not try to
3889 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk6c59edc2004-05-03 20:45:30 +00003891 autostart - if set to "yes", an image loaded using the "bootp",
3892 "rarpboot", "tftpboot" or "diskboot" commands will
3893 be automatically started (by internally calling
3894 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk6c59edc2004-05-03 20:45:30 +00003896 If set to "no", a standalone image passed to the
3897 "bootm" command will be copied to the load address
3898 (and eventually uncompressed), but NOT be started.
3899 This can be used to load and uncompress arbitrary
3900 data.
wdenkc6097192002-11-03 00:24:07 +00003901
David A. Longd558a4e2011-07-09 16:40:19 -04003902 fdt_high - if set this restricts the maximum address that the
3903 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003904 For example, if you have a system with 1 GB memory
3905 at physical address 0x10000000, while Linux kernel
3906 only recognizes the first 704 MB as low memory, you
3907 may need to set fdt_high as 0x3C000000 to have the
3908 device tree blob be copied to the maximum address
3909 of the 704 MB low memory, so that Linux kernel can
3910 access it during the boot procedure.
3911
David A. Longd558a4e2011-07-09 16:40:19 -04003912 If this is set to the special value 0xFFFFFFFF then
3913 the fdt will not be copied at all on boot. For this
3914 to work it must reside in writable memory, have
3915 sufficient padding on the end of it for u-boot to
3916 add the information it needs into it, and the memory
3917 must be accessible by the kernel.
3918
Simon Glassdc6fa642011-10-24 19:15:34 +00003919 fdtcontroladdr- if set this is the address of the control flattened
3920 device tree used by U-Boot when CONFIG_OF_CONTROL is
3921 defined.
3922
wdenk0e2bd9c2004-06-06 21:51:03 +00003923 i2cfast - (PPC405GP|PPC405EP only)
3924 if set to 'y' configures Linux I2C driver for fast
3925 mode (400kHZ). This environment variable is used in
3926 initialization code. So, for changes to be effective
3927 it must be saved and board must be reset.
3928
wdenk6c59edc2004-05-03 20:45:30 +00003929 initrd_high - restrict positioning of initrd images:
3930 If this variable is not set, initrd images will be
3931 copied to the highest possible address in RAM; this
3932 is usually what you want since it allows for
3933 maximum initrd size. If for some reason you want to
3934 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003936 variable to a value of "no" or "off" or "0".
3937 Alternatively, you can set it to a maximum upper
3938 address to use (U-Boot will still check that it
3939 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk6c59edc2004-05-03 20:45:30 +00003941 For instance, when you have a system with 16 MB
3942 RAM, and want to reserve 4 MB from use by Linux,
3943 you can do this by adding "mem=12M" to the value of
3944 the "bootargs" variable. However, now you must make
3945 sure that the initrd image is placed in the first
3946 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003947
wdenk6c59edc2004-05-03 20:45:30 +00003948 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk6c59edc2004-05-03 20:45:30 +00003950 If you set initrd_high to 0xFFFFFFFF, this is an
3951 indication to U-Boot that all addresses are legal
3952 for the Linux kernel, including addresses in flash
3953 memory. In this case U-Boot will NOT COPY the
3954 ramdisk at all. This may be useful to reduce the
3955 boot time on your system, but requires that this
3956 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003957
wdenk6c59edc2004-05-03 20:45:30 +00003958 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk6c59edc2004-05-03 20:45:30 +00003960 loadaddr - Default load address for commands like "bootp",
3961 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk6c59edc2004-05-03 20:45:30 +00003963 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk6c59edc2004-05-03 20:45:30 +00003965 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003966
wdenk6c59edc2004-05-03 20:45:30 +00003967 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk6c59edc2004-05-03 20:45:30 +00003969 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk6c59edc2004-05-03 20:45:30 +00003971 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003972
Mike Frysingera23230c2011-10-02 10:01:27 +00003973 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003974
Mike Frysingera23230c2011-10-02 10:01:27 +00003975 ethact - controls which interface is currently active.
3976 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003977
Heiko Schocherc5e84052010-07-20 17:45:02 +02003978 => setenv ethact FEC
3979 => ping 192.168.0.1 # traffic sent on FEC
3980 => setenv ethact SCC
3981 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003982
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003983 ethrotate - When set to "no" U-Boot does not go through all
3984 available network interfaces.
3985 It just stays at the currently selected interface.
3986
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003987 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003988 either succeed or fail without retrying.
3989 When set to "once" the network operation will
3990 fail when all the available network interfaces
3991 are tried once without success.
3992 Useful on scripts which control the retry operation
3993 themselves.
wdenkc6097192002-11-03 00:24:07 +00003994
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003995 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003996
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003997 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003998 changing the console to be empty. If "yes" it will be
3999 made silent. If "no" it will not be made silent. If
4000 unset, then it will be made silent if the U-Boot console
4001 is silent.
4002
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004003 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004004 UDP source port.
4005
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004006 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004007 destination port instead of the Well Know Port 69.
4008
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004009 tftpblocksize - Block size to use for TFTP transfers; if not set,
4010 we use the TFTP server's default block size
4011
4012 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4013 seconds, minimum value is 1000 = 1 second). Defines
4014 when a packet is considered to be lost so it has to
4015 be retransmitted. The default is 5000 = 5 seconds.
4016 Lowering this value may make downloads succeed
4017 faster in networks with high packet loss rates or
4018 with unreliable TFTP servers.
4019
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004020 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4021 unit, minimum value = 0). Defines how many timeouts
4022 can happen during a single file transfer before that
4023 transfer is aborted. The default is 10, and 0 means
4024 'no timeouts allowed'. Increasing this value may help
4025 downloads succeed with high packet loss rates, or with
4026 unreliable TFTP servers or client hardware.
4027
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004028 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004029 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004030 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004031
Alexandre Messier15971322016-02-01 17:08:57 -05004032 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4033 Unsigned value, in milliseconds. If not set, the period will
4034 be either the default (28000), or a value based on
4035 CONFIG_NET_RETRY_COUNT, if defined. This value has
4036 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4037
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004038The following image location variables contain the location of images
4039used in booting. The "Image" column gives the role of the image and is
4040not an environment variable name. The other columns are environment
4041variable names. "File Name" gives the name of the file on a TFTP
4042server, "RAM Address" gives the location in RAM the image will be
4043loaded to, and "Flash Location" gives the image's address in NOR
4044flash or offset in NAND flash.
4045
4046*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004047boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004048boards use these variables for other purposes.
4049
Wolfgang Denk092ae952011-10-26 10:21:21 +00004050Image File Name RAM Address Flash Location
4051----- --------- ----------- --------------
4052u-boot u-boot u-boot_addr_r u-boot_addr
4053Linux kernel bootfile kernel_addr_r kernel_addr
4054device tree blob fdtfile fdt_addr_r fdt_addr
4055ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004056
wdenk6c59edc2004-05-03 20:45:30 +00004057The following environment variables may be used and automatically
4058updated by the network boot commands ("bootp" and "rarpboot"),
4059depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004060
wdenk6c59edc2004-05-03 20:45:30 +00004061 bootfile - see above
4062 dnsip - IP address of your Domain Name Server
4063 dnsip2 - IP address of your secondary Domain Name Server
4064 gatewayip - IP address of the Gateway (Router) to use
4065 hostname - Target hostname
4066 ipaddr - see above
4067 netmask - Subnet Mask
4068 rootpath - Pathname of the root filesystem on the NFS server
4069 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004070
wdenk145d2c12004-04-15 21:48:45 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004073
wdenk6c59edc2004-05-03 20:45:30 +00004074 serial# - contains hardware identification information such
4075 as type string and/or serial number
4076 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk6c59edc2004-05-03 20:45:30 +00004078These variables can be set only once (usually during manufacturing of
4079the board). U-Boot refuses to delete or overwrite these variables
4080once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004081
4082
wdenk6c59edc2004-05-03 20:45:30 +00004083Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk6c59edc2004-05-03 20:45:30 +00004085 ver - Contains the U-Boot version string as printed
4086 with the "version" command. This variable is
4087 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004088
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk6c59edc2004-05-03 20:45:30 +00004090Please note that changes to some configuration parameters may take
4091only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004092
stroeseb9c17c52003-04-04 15:53:41 +00004093
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004094Callback functions for environment variables:
4095---------------------------------------------
4096
4097For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004098when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004099be associated with arbitrary variables. On creation, overwrite, or
4100deletion, the callback will provide the opportunity for some side
4101effect to happen or for the change to be rejected.
4102
4103The callbacks are named and associated with a function using the
4104U_BOOT_ENV_CALLBACK macro in your board or driver code.
4105
4106These callbacks are associated with variables in one of two ways. The
4107static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4108in the board configuration to a string that defines a list of
4109associations. The list must be in the following format:
4110
4111 entry = variable_name[:callback_name]
4112 list = entry[,list]
4113
4114If the callback name is not specified, then the callback is deleted.
4115Spaces are also allowed anywhere in the list.
4116
4117Callbacks can also be associated by defining the ".callbacks" variable
4118with the same list format above. Any association in ".callbacks" will
4119override any association in the static list. You can define
4120CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004121".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004122
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004123If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4124regular expression. This allows multiple variables to be connected to
4125the same callback without explicitly listing them all out.
4126
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004127
wdenk6c59edc2004-05-03 20:45:30 +00004128Command Line Parsing:
4129=====================
stroeseb9c17c52003-04-04 15:53:41 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131There are two different command line parsers available with U-Boot:
4132the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk6c59edc2004-05-03 20:45:30 +00004134Old, simple command line parser:
4135--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk6c59edc2004-05-03 20:45:30 +00004137- supports environment variables (through setenv / saveenv commands)
4138- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004139- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004140- special characters ('$', ';') can be escaped by prefixing with '\',
4141 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004142 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004143- You can also escape text by enclosing in single apostrophes, for example:
4144 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk6c59edc2004-05-03 20:45:30 +00004146Hush shell:
4147-----------
wdenkf4688a22003-05-28 08:06:31 +00004148
wdenk6c59edc2004-05-03 20:45:30 +00004149- similar to Bourne shell, with control structures like
4150 if...then...else...fi, for...do...done; while...do...done,
4151 until...do...done, ...
4152- supports environment ("global") variables (through setenv / saveenv
4153 commands) and local shell variables (through standard shell syntax
4154 "name=value"); only environment variables can be used with "run"
4155 command
wdenkf4688a22003-05-28 08:06:31 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157General rules:
4158--------------
wdenkf4688a22003-05-28 08:06:31 +00004159
wdenk6c59edc2004-05-03 20:45:30 +00004160(1) If a command line (or an environment variable executed by a "run"
4161 command) contains several commands separated by semicolon, and
4162 one of these commands fails, then the remaining commands will be
4163 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004164
wdenk6c59edc2004-05-03 20:45:30 +00004165(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004166 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004167 command will cause "run" to terminate, i. e. the remaining
4168 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004169
wdenk6c59edc2004-05-03 20:45:30 +00004170Note for Redundant Ethernet Interfaces:
4171=======================================
wdenkf4688a22003-05-28 08:06:31 +00004172
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004173Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004174such configurations and is capable of automatic selection of a
4175"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004176
wdenk6c59edc2004-05-03 20:45:30 +00004177Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4178MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4179"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004180
wdenk6c59edc2004-05-03 20:45:30 +00004181If the network interface stores some valid MAC address (for instance
4182in SROM), this is used as default address if there is NO correspon-
4183ding setting in the environment; if the corresponding environment
4184variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004185
wdenk6c59edc2004-05-03 20:45:30 +00004186o If the SROM has a valid MAC address, and there is no address in the
4187 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk6c59edc2004-05-03 20:45:30 +00004189o If there is no valid address in the SROM, and a definition in the
4190 environment exists, then the value from the environment variable is
4191 used.
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk6c59edc2004-05-03 20:45:30 +00004193o If both the SROM and the environment contain a MAC address, and
4194 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004195
wdenk6c59edc2004-05-03 20:45:30 +00004196o If both the SROM and the environment contain a MAC address, and the
4197 addresses differ, the value from the environment is used and a
4198 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004199
wdenk6c59edc2004-05-03 20:45:30 +00004200o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004201 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4202 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004203
Ben Warren6db991a2010-04-26 11:11:46 -07004204If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004205will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004206may be skipped by setting the appropriate 'ethmacskip' environment variable.
4207The naming convention is as follows:
4208"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004209
wdenk6c59edc2004-05-03 20:45:30 +00004210Image Formats:
4211==============
wdenkc6097192002-11-03 00:24:07 +00004212
Marian Balakowicz18710b82008-03-12 12:13:13 +01004213U-Boot is capable of booting (and performing other auxiliary operations on)
4214images in two formats:
4215
4216New uImage format (FIT)
4217-----------------------
4218
4219Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4220to Flattened Device Tree). It allows the use of images with multiple
4221components (several kernels, ramdisks, etc.), with contents protected by
4222SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4223
4224
4225Old uImage format
4226-----------------
4227
4228Old image format is based on binary files which can be basically anything,
4229preceded by a special header; see the definitions in include/image.h for
4230details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk6c59edc2004-05-03 20:45:30 +00004232* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4233 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004234 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4235 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4236 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004237* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004238 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004239 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004240* Compression Type (uncompressed, gzip, bzip2)
4241* Load Address
4242* Entry Point
4243* Image Name
4244* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246The header is marked by a special Magic Number, and both the header
4247and the data portions of the image are secured against corruption by
4248CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004249
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk6c59edc2004-05-03 20:45:30 +00004251Linux Support:
4252==============
wdenkc6097192002-11-03 00:24:07 +00004253
wdenk6c59edc2004-05-03 20:45:30 +00004254Although U-Boot should support any OS or standalone application
4255easily, the main focus has always been on Linux during the design of
4256U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258U-Boot includes many features that so far have been part of some
4259special "boot loader" code within the Linux kernel. Also, any
4260"initrd" images to be used are no longer part of one big Linux image;
4261instead, kernel and "initrd" are separate images. This implementation
4262serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk6c59edc2004-05-03 20:45:30 +00004264- the same features can be used for other OS or standalone
4265 applications (for instance: using compressed images to reduce the
4266 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004267
wdenk6c59edc2004-05-03 20:45:30 +00004268- it becomes much easier to port new Linux kernel versions because
4269 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271- the same Linux kernel image can now be used with different "initrd"
4272 images; of course this also means that different kernel images can
4273 be run with the same "initrd". This makes testing easier (you don't
4274 have to build a new "zImage.initrd" Linux image when you just
4275 change a file in your "initrd"). Also, a field-upgrade of the
4276 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004277
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279Linux HOWTO:
4280============
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk6c59edc2004-05-03 20:45:30 +00004282Porting Linux to U-Boot based systems:
4283---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004284
wdenk6c59edc2004-05-03 20:45:30 +00004285U-Boot cannot save you from doing all the necessary modifications to
4286configure the Linux device drivers for use with your target hardware
4287(no, we don't intend to provide a full virtual machine interface to
4288Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004289
Stefan Roese88fbf932010-04-15 16:07:28 +02004290But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk6c59edc2004-05-03 20:45:30 +00004292Just make sure your machine specific header file (for instance
4293include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004294Information structure as we define in include/asm-<arch>/u-boot.h,
4295and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004296as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004297
Simon Glassd097e592014-06-11 23:29:46 -06004298Note that U-Boot now has a driver model, a unified model for drivers.
4299If you are adding a new driver, plumb it into driver model. If there
4300is no uclass available, you are encouraged to create one. See
4301doc/driver-model.
4302
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk6c59edc2004-05-03 20:45:30 +00004304Configuring the Linux kernel:
4305-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk6c59edc2004-05-03 20:45:30 +00004307No specific requirements for U-Boot. Make sure you have some root
4308device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004309
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk6c59edc2004-05-03 20:45:30 +00004311Building a Linux Image:
4312-----------------------
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk6c59edc2004-05-03 20:45:30 +00004314With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4315not used. If you use recent kernel source, a new build target
4316"uImage" will exist which automatically builds an image usable by
4317U-Boot. Most older kernels also have support for a "pImage" target,
4318which was introduced for our predecessor project PPCBoot and uses a
4319100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004320
wdenk6c59edc2004-05-03 20:45:30 +00004321Example:
wdenkc6097192002-11-03 00:24:07 +00004322
Holger Freyther7ba4e572014-08-04 09:26:05 +02004323 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004324 make oldconfig
4325 make dep
4326 make uImage
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk6c59edc2004-05-03 20:45:30 +00004328The "uImage" build target uses a special tool (in 'tools/mkimage') to
4329encapsulate a compressed Linux kernel image with header information,
4330CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk6c59edc2004-05-03 20:45:30 +00004334* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336 ${CROSS_COMPILE}-objcopy -O binary \
4337 -R .note -R .comment \
4338 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004341
wdenk6c59edc2004-05-03 20:45:30 +00004342 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004343
wdenk6c59edc2004-05-03 20:45:30 +00004344* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004345
wdenk6c59edc2004-05-03 20:45:30 +00004346 mkimage -A ppc -O linux -T kernel -C gzip \
4347 -a 0 -e 0 -n "Linux Kernel Image" \
4348 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004349
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk6c59edc2004-05-03 20:45:30 +00004351The "mkimage" tool can also be used to create ramdisk images for use
4352with U-Boot, either separated from the Linux kernel image, or
4353combined into one file. "mkimage" encapsulates the images with a 64
4354byte header containing information about target architecture,
4355operating system, image type, compression method, entry points, time
4356stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004357
wdenk6c59edc2004-05-03 20:45:30 +00004358"mkimage" can be called in two ways: to verify existing images and
4359print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004360
wdenk6c59edc2004-05-03 20:45:30 +00004361In the first form (with "-l" option) mkimage lists the information
4362contained in the header of an existing U-Boot image; this includes
4363checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365 tools/mkimage -l image
4366 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004367
wdenk6c59edc2004-05-03 20:45:30 +00004368The second form (with "-d" option) is used to build a U-Boot image
4369from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004370
wdenk6c59edc2004-05-03 20:45:30 +00004371 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4372 -n name -d data_file image
4373 -A ==> set architecture to 'arch'
4374 -O ==> set operating system to 'os'
4375 -T ==> set image type to 'type'
4376 -C ==> set compression type 'comp'
4377 -a ==> set load address to 'addr' (hex)
4378 -e ==> set entry point to 'ep' (hex)
4379 -n ==> set image name to 'name'
4380 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004381
wdenkcd914452004-05-29 16:53:29 +00004382Right now, all Linux kernels for PowerPC systems use the same load
4383address (0x00000000), but the entry point address depends on the
4384kernel version:
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk6c59edc2004-05-03 20:45:30 +00004386- 2.2.x kernels have the entry point at 0x0000000C,
4387- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk6c59edc2004-05-03 20:45:30 +00004389So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk6c59edc2004-05-03 20:45:30 +00004391 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4392 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004393 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004394 > examples/uImage.TQM850L
4395 Image Name: 2.4.4 kernel for TQM850L
4396 Created: Wed Jul 19 02:34:59 2000
4397 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4398 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4399 Load Address: 0x00000000
4400 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk6c59edc2004-05-03 20:45:30 +00004402To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404 -> tools/mkimage -l examples/uImage.TQM850L
4405 Image Name: 2.4.4 kernel for TQM850L
4406 Created: Wed Jul 19 02:34:59 2000
4407 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4408 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4409 Load Address: 0x00000000
4410 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004411
wdenk6c59edc2004-05-03 20:45:30 +00004412NOTE: for embedded systems where boot time is critical you can trade
4413speed for memory and install an UNCOMPRESSED image instead: this
4414needs more space in Flash, but boots much faster since it does not
4415need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004416
Stefan Roese88fbf932010-04-15 16:07:28 +02004417 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004418 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4419 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004420 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004421 > examples/uImage.TQM850L-uncompressed
4422 Image Name: 2.4.4 kernel for TQM850L
4423 Created: Wed Jul 19 02:34:59 2000
4424 Image Type: PowerPC Linux Kernel Image (uncompressed)
4425 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4426 Load Address: 0x00000000
4427 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004428
wdenkc6097192002-11-03 00:24:07 +00004429
wdenk6c59edc2004-05-03 20:45:30 +00004430Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4431when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk6c59edc2004-05-03 20:45:30 +00004433 -> tools/mkimage -n 'Simple Ramdisk Image' \
4434 > -A ppc -O linux -T ramdisk -C gzip \
4435 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4436 Image Name: Simple Ramdisk Image
4437 Created: Wed Jan 12 14:01:50 2000
4438 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4439 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4440 Load Address: 0x00000000
4441 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004442
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004443The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4444option performs the converse operation of the mkimage's second form (the "-d"
4445option). Given an image built by mkimage, the dumpimage extracts a "data file"
4446from the image:
4447
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004448 tools/dumpimage -i image -T type -p position data_file
4449 -i ==> extract from the 'image' a specific 'data_file'
4450 -T ==> set image type to 'type'
4451 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004452
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk6c59edc2004-05-03 20:45:30 +00004454Installing a Linux Image:
4455-------------------------
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk6c59edc2004-05-03 20:45:30 +00004457To downloading a U-Boot image over the serial (console) interface,
4458you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk6c59edc2004-05-03 20:45:30 +00004460 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462The 'objcopy' does not understand the information in the U-Boot
4463image header, so the resulting S-Record file will be relative to
4464address 0x00000000. To load it to a given address, you need to
4465specify the target address as 'offset' parameter with the 'loads'
4466command.
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk6c59edc2004-05-03 20:45:30 +00004468Example: install the image to address 0x40100000 (which on the
4469TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk6c59edc2004-05-03 20:45:30 +00004471 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk6c59edc2004-05-03 20:45:30 +00004473 .......... done
4474 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004475
wdenk6c59edc2004-05-03 20:45:30 +00004476 => loads 40100000
4477 ## Ready for S-Record download ...
4478 ~>examples/image.srec
4479 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4480 ...
4481 15989 15990 15991 15992
4482 [file transfer complete]
4483 [connected]
4484 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004485
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004488this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004489corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk6c59edc2004-05-03 20:45:30 +00004491 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004492
wdenk6c59edc2004-05-03 20:45:30 +00004493 ## Checking Image at 40100000 ...
4494 Image Name: 2.2.13 for initrd on TQM850L
4495 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4496 Data Size: 335725 Bytes = 327 kB = 0 MB
4497 Load Address: 00000000
4498 Entry Point: 0000000c
4499 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004500
4501
wdenk6c59edc2004-05-03 20:45:30 +00004502Boot Linux:
4503-----------
wdenkc6097192002-11-03 00:24:07 +00004504
wdenk6c59edc2004-05-03 20:45:30 +00004505The "bootm" command is used to boot an application that is stored in
4506memory (RAM or Flash). In case of a Linux kernel image, the contents
4507of the "bootargs" environment variable is passed to the kernel as
4508parameters. You can check and modify this variable using the
4509"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004510
wdenkc6097192002-11-03 00:24:07 +00004511
wdenk6c59edc2004-05-03 20:45:30 +00004512 => printenv bootargs
4513 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk6c59edc2004-05-03 20:45:30 +00004515 => 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 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517 => printenv bootargs
4518 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 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520 => bootm 40020000
4521 ## Booting Linux kernel at 40020000 ...
4522 Image Name: 2.2.13 for NFS on TQM850L
4523 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4524 Data Size: 381681 Bytes = 372 kB = 0 MB
4525 Load Address: 00000000
4526 Entry Point: 0000000c
4527 Verifying Checksum ... OK
4528 Uncompressing Kernel Image ... OK
4529 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
4530 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4531 time_init: decrementer frequency = 187500000/60
4532 Calibrating delay loop... 49.77 BogoMIPS
4533 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4534 ...
wdenkc6097192002-11-03 00:24:07 +00004535
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004536If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004537the memory addresses of both the kernel and the initrd image (PPBCOOT
4538format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542 ## Checking Image at 40100000 ...
4543 Image Name: 2.2.13 for initrd on TQM850L
4544 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4545 Data Size: 335725 Bytes = 327 kB = 0 MB
4546 Load Address: 00000000
4547 Entry Point: 0000000c
4548 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550 ## Checking Image at 40200000 ...
4551 Image Name: Simple Ramdisk Image
4552 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4553 Data Size: 566530 Bytes = 553 kB = 0 MB
4554 Load Address: 00000000
4555 Entry Point: 00000000
4556 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558 => bootm 40100000 40200000
4559 ## Booting Linux kernel at 40100000 ...
4560 Image Name: 2.2.13 for initrd on TQM850L
4561 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4562 Data Size: 335725 Bytes = 327 kB = 0 MB
4563 Load Address: 00000000
4564 Entry Point: 0000000c
4565 Verifying Checksum ... OK
4566 Uncompressing Kernel Image ... OK
4567 ## Loading RAMDisk Image at 40200000 ...
4568 Image Name: Simple Ramdisk Image
4569 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4570 Data Size: 566530 Bytes = 553 kB = 0 MB
4571 Load Address: 00000000
4572 Entry Point: 00000000
4573 Verifying Checksum ... OK
4574 Loading Ramdisk ... OK
4575 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
4576 Boot arguments: root=/dev/ram
4577 time_init: decrementer frequency = 187500000/60
4578 Calibrating delay loop... 49.77 BogoMIPS
4579 ...
4580 RAMDISK: Compressed image found at block 0
4581 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583 bash#
wdenkc6097192002-11-03 00:24:07 +00004584
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004585Boot Linux and pass a flat device tree:
4586-----------
4587
4588First, U-Boot must be compiled with the appropriate defines. See the section
4589titled "Linux Kernel Interface" above for a more in depth explanation. The
4590following is an example of how to start a kernel and pass an updated
4591flat device tree:
4592
4593=> print oftaddr
4594oftaddr=0x300000
4595=> print oft
4596oft=oftrees/mpc8540ads.dtb
4597=> tftp $oftaddr $oft
4598Speed: 1000, full duplex
4599Using TSEC0 device
4600TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4601Filename 'oftrees/mpc8540ads.dtb'.
4602Load address: 0x300000
4603Loading: #
4604done
4605Bytes transferred = 4106 (100a hex)
4606=> tftp $loadaddr $bootfile
4607Speed: 1000, full duplex
4608Using TSEC0 device
4609TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4610Filename 'uImage'.
4611Load address: 0x200000
4612Loading:############
4613done
4614Bytes transferred = 1029407 (fb51f hex)
4615=> print loadaddr
4616loadaddr=200000
4617=> print oftaddr
4618oftaddr=0x300000
4619=> bootm $loadaddr - $oftaddr
4620## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004621 Image Name: Linux-2.6.17-dirty
4622 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4623 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004624 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004625 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004626 Verifying Checksum ... OK
4627 Uncompressing Kernel Image ... OK
4628Booting using flat device tree at 0x300000
4629Using MPC85xx ADS machine description
4630Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4631[snip]
4632
4633
wdenk6c59edc2004-05-03 20:45:30 +00004634More About U-Boot Image Types:
4635------------------------------
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004638
wdenk6c59edc2004-05-03 20:45:30 +00004639 "Standalone Programs" are directly runnable in the environment
4640 provided by U-Boot; it is expected that (if they behave
4641 well) you can continue to work in U-Boot after return from
4642 the Standalone Program.
4643 "OS Kernel Images" are usually images of some Embedded OS which
4644 will take over control completely. Usually these programs
4645 will install their own set of exception handlers, device
4646 drivers, set up the MMU, etc. - this means, that you cannot
4647 expect to re-enter U-Boot except by resetting the CPU.
4648 "RAMDisk Images" are more or less just data blocks, and their
4649 parameters (address, size) are passed to an OS kernel that is
4650 being started.
4651 "Multi-File Images" contain several images, typically an OS
4652 (Linux) kernel image and one or more data images like
4653 RAMDisks. This construct is useful for instance when you want
4654 to boot over the network using BOOTP etc., where the boot
4655 server provides just a single image file, but you want to get
4656 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk6c59edc2004-05-03 20:45:30 +00004658 "Multi-File Images" start with a list of image sizes, each
4659 image size (in bytes) specified by an "uint32_t" in network
4660 byte order. This list is terminated by an "(uint32_t)0".
4661 Immediately after the terminating 0 follow the images, one by
4662 one, all aligned on "uint32_t" boundaries (size rounded up to
4663 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004664
wdenk6c59edc2004-05-03 20:45:30 +00004665 "Firmware Images" are binary images containing firmware (like
4666 U-Boot or FPGA images) which usually will be programmed to
4667 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004668
wdenk6c59edc2004-05-03 20:45:30 +00004669 "Script files" are command sequences that will be executed by
4670 U-Boot's command interpreter; this feature is especially
4671 useful when you configure U-Boot to use a real shell (hush)
4672 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004673
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004674Booting the Linux zImage:
4675-------------------------
4676
4677On some platforms, it's possible to boot Linux zImage. This is done
4678using the "bootz" command. The syntax of "bootz" command is the same
4679as the syntax of "bootm" command.
4680
Tom Rini45f46d12013-05-16 11:40:11 -04004681Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004682kernel with raw initrd images. The syntax is slightly different, the
4683address of the initrd must be augmented by it's size, in the following
4684format: "<initrd addres>:<initrd size>".
4685
stroeseb9c17c52003-04-04 15:53:41 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687Standalone HOWTO:
4688=================
stroeseb9c17c52003-04-04 15:53:41 +00004689
wdenk6c59edc2004-05-03 20:45:30 +00004690One of the features of U-Boot is that you can dynamically load and
4691run "standalone" applications, which can use some resources of
4692U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004693
wdenk6c59edc2004-05-03 20:45:30 +00004694Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696"Hello World" Demo:
4697-------------------
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk6c59edc2004-05-03 20:45:30 +00004699'examples/hello_world.c' contains a small "Hello World" Demo
4700application; it is automatically compiled when you build U-Boot.
4701It's configured to run at address 0x00040004, so you can play with it
4702like that:
wdenkc6097192002-11-03 00:24:07 +00004703
wdenk6c59edc2004-05-03 20:45:30 +00004704 => loads
4705 ## Ready for S-Record download ...
4706 ~>examples/hello_world.srec
4707 1 2 3 4 5 6 7 8 9 10 11 ...
4708 [file transfer complete]
4709 [connected]
4710 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004711
wdenk6c59edc2004-05-03 20:45:30 +00004712 => go 40004 Hello World! This is a test.
4713 ## Starting application at 0x00040004 ...
4714 Hello World
4715 argc = 7
4716 argv[0] = "40004"
4717 argv[1] = "Hello"
4718 argv[2] = "World!"
4719 argv[3] = "This"
4720 argv[4] = "is"
4721 argv[5] = "a"
4722 argv[6] = "test."
4723 argv[7] = "<NULL>"
4724 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk6c59edc2004-05-03 20:45:30 +00004726 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728Another example, which demonstrates how to register a CPM interrupt
4729handler with the U-Boot code, can be found in 'examples/timer.c'.
4730Here, a CPM timer is set up to generate an interrupt every second.
4731The interrupt service routine is trivial, just printing a '.'
4732character, but this is just a demo program. The application can be
4733controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735 ? - print current values og the CPM Timer registers
4736 b - enable interrupts and start timer
4737 e - stop timer and disable interrupts
4738 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740 => loads
4741 ## Ready for S-Record download ...
4742 ~>examples/timer.srec
4743 1 2 3 4 5 6 7 8 9 10 11 ...
4744 [file transfer complete]
4745 [connected]
4746 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk6c59edc2004-05-03 20:45:30 +00004748 => go 40004
4749 ## Starting application at 0x00040004 ...
4750 TIMERS=0xfff00980
4751 Using timer 1
4752 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk6c59edc2004-05-03 20:45:30 +00004754Hit 'b':
4755 [q, b, e, ?] Set interval 1000000 us
4756 Enabling timer
4757Hit '?':
4758 [q, b, e, ?] ........
4759 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4760Hit '?':
4761 [q, b, e, ?] .
4762 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4763Hit '?':
4764 [q, b, e, ?] .
4765 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4766Hit '?':
4767 [q, b, e, ?] .
4768 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4769Hit 'e':
4770 [q, b, e, ?] ...Stopping timer
4771Hit 'q':
4772 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004773
wdenkc6097192002-11-03 00:24:07 +00004774
wdenk6c59edc2004-05-03 20:45:30 +00004775Minicom warning:
4776================
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk6c59edc2004-05-03 20:45:30 +00004778Over time, many people have reported problems when trying to use the
4779"minicom" terminal emulation program for serial download. I (wd)
4780consider minicom to be broken, and recommend not to use it. Under
4781Unix, I recommend to use C-Kermit for general purpose use (and
4782especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004783use "cu" for S-Record download ("loads" command). See
4784http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4785for help with kermit.
4786
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788Nevertheless, if you absolutely want to use it try adding this
4789configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004790
wdenk6c59edc2004-05-03 20:45:30 +00004791 Name Program Name U/D FullScr IO-Red. Multi
4792 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4793 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004794
wdenk8dba0502003-03-31 16:34:49 +00004795
wdenk6c59edc2004-05-03 20:45:30 +00004796NetBSD Notes:
4797=============
wdenkc6097192002-11-03 00:24:07 +00004798
wdenk6c59edc2004-05-03 20:45:30 +00004799Starting at version 0.9.2, U-Boot supports NetBSD both as host
4800(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004801
wdenk6c59edc2004-05-03 20:45:30 +00004802Building requires a cross environment; it is known to work on
4803NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4804need gmake since the Makefiles are not compatible with BSD make).
4805Note that the cross-powerpc package does not install include files;
4806attempting to build U-Boot will fail because <machine/ansi.h> is
4807missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004808
wdenk6c59edc2004-05-03 20:45:30 +00004809 # cd /usr/pkg/cross/powerpc-netbsd/include
4810 # mkdir powerpc
4811 # ln -s powerpc machine
4812 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4813 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004814
wdenk6c59edc2004-05-03 20:45:30 +00004815Native builds *don't* work due to incompatibilities between native
4816and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818Booting assumes that (the first part of) the image booted is a
4819stage-2 loader which in turn loads and then invokes the kernel
4820proper. Loader sources will eventually appear in the NetBSD source
4821tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004822meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004823
wdenkc6097192002-11-03 00:24:07 +00004824
wdenk6c59edc2004-05-03 20:45:30 +00004825Implementation Internals:
4826=========================
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk6c59edc2004-05-03 20:45:30 +00004828The following is not intended to be a complete description of every
4829implementation detail. However, it should help to understand the
4830inner workings of U-Boot and make it easier to port it to custom
4831hardware.
wdenkc6097192002-11-03 00:24:07 +00004832
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834Initial Stack, Global Data:
4835---------------------------
wdenkc6097192002-11-03 00:24:07 +00004836
wdenk6c59edc2004-05-03 20:45:30 +00004837The implementation of U-Boot is complicated by the fact that U-Boot
4838starts running out of ROM (flash memory), usually without access to
4839system RAM (because the memory controller is not initialized yet).
4840This means that we don't have writable Data or BSS segments, and BSS
4841is not initialized as zero. To be able to get a C environment working
4842at all, we have to allocate at least a minimal stack. Implementation
4843options for this are defined and restricted by the CPU used: Some CPU
4844models provide on-chip memory (like the IMMR area on MPC8xx and
4845MPC826x processors), on others (parts of) the data cache can be
4846locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004847
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004848 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004849 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk6c59edc2004-05-03 20:45:30 +00004851 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4852 From: "Chris Hallinan" <clh@net1plus.com>
4853 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4854 ...
wdenkc6097192002-11-03 00:24:07 +00004855
wdenk6c59edc2004-05-03 20:45:30 +00004856 Correct me if I'm wrong, folks, but the way I understand it
4857 is this: Using DCACHE as initial RAM for Stack, etc, does not
4858 require any physical RAM backing up the cache. The cleverness
4859 is that the cache is being used as a temporary supply of
4860 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004861 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004862 can see how this works by studying the cache architecture and
4863 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk6c59edc2004-05-03 20:45:30 +00004865 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4866 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004867 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004868 option should work for you. Using CS 4 should be fine if your
4869 board designers haven't used it for something that would
4870 cause you grief during the initial boot! It is frequently not
4871 used.
wdenkc6097192002-11-03 00:24:07 +00004872
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004873 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004874 with your processor/board/system design. The default value
4875 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004876 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004877 than your SDRAM module. If you have a 64MB SDRAM module, set
4878 it above 400_0000. Just make sure your board has no resources
4879 that are supposed to respond to that address! That code in
4880 start.S has been around a while and should work as is when
4881 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883 -Chris Hallinan
4884 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886It is essential to remember this, since it has some impact on the C
4887code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889* Initialized global data (data segment) is read-only. Do not attempt
4890 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004891
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004892* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004893 as zero data - BSS segment) at all - this is undefined, initiali-
4894 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004895
wdenk6c59edc2004-05-03 20:45:30 +00004896* Stack space is very limited. Avoid big data buffers or things like
4897 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004898
wdenk6c59edc2004-05-03 20:45:30 +00004899Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004900normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004901turned out that the implementation of U-Boot can be greatly
4902simplified by making a global data structure (gd_t) available to all
4903functions. We could pass a pointer to this data as argument to _all_
4904functions, but this would bloat the code. Instead we use a feature of
4905the GCC compiler (Global Register Variables) to share the data: we
4906place a pointer (gd) to the global data into a register which we
4907reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909When choosing a register for such a purpose we are restricted by the
4910relevant (E)ABI specifications for the current architecture, and by
4911GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk6c59edc2004-05-03 20:45:30 +00004913For PowerPC, the following registers have specific use:
4914 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004915 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004916 R3-R4: parameter passing and return values
4917 R5-R10: parameter passing
4918 R13: small data area pointer
4919 R30: GOT pointer
4920 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004921
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004922 (U-Boot also uses R12 as internal GOT pointer. r12
4923 is a volatile register so r12 needs to be reset when
4924 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004925
Wolfgang Denk69c09642008-02-14 22:43:22 +01004926 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk6c59edc2004-05-03 20:45:30 +00004928 Note: on PPC, we could use a static initializer (since the
4929 address of the global data structure is known at compile time),
4930 but it turned out that reserving a register results in somewhat
4931 smaller code - although the code savings are not that big (on
4932 average for all boards 752 bytes for the whole U-Boot image,
4933 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk6c59edc2004-05-03 20:45:30 +00004937 R0: function argument word/integer result
4938 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004939 R9: platform specific
4940 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004941 R11: argument (frame) pointer
4942 R12: temporary workspace
4943 R13: stack pointer
4944 R14: link register
4945 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004946
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004947 ==> U-Boot will use R9 to hold a pointer to the global data
4948
4949 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004950
Thomas Chou8fa38582010-05-21 11:08:03 +08004951On Nios II, the ABI is documented here:
4952 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4953
4954 ==> U-Boot will use gp to hold a pointer to the global data
4955
4956 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4957 to access small data sections, so gp is free.
4958
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004959On NDS32, the following registers are used:
4960
4961 R0-R1: argument/return
4962 R2-R5: argument
4963 R15: temporary register for assembler
4964 R16: trampoline register
4965 R28: frame pointer (FP)
4966 R29: global pointer (GP)
4967 R30: link register (LP)
4968 R31: stack pointer (SP)
4969 PC: program counter (PC)
4970
4971 ==> U-Boot will use R10 to hold a pointer to the global data
4972
Wolfgang Denk6405a152006-03-31 18:32:53 +02004973NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4974or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976Memory Management:
4977------------------
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979U-Boot runs in system state and uses physical addresses, i.e. the
4980MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004981
wdenk6c59edc2004-05-03 20:45:30 +00004982The available memory is mapped to fixed addresses using the memory
4983controller. In this process, a contiguous block is formed for each
4984memory type (Flash, SDRAM, SRAM), even when it consists of several
4985physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk6c59edc2004-05-03 20:45:30 +00004987U-Boot is installed in the first 128 kB of the first Flash bank (on
4988TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4989booting and sizing and initializing DRAM, the code relocates itself
4990to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004991memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004992configuration setting]. Below that, a structure with global Board
4993Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995Additionally, some exception handler code is copied to the low 8 kB
4996of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004997
wdenk6c59edc2004-05-03 20:45:30 +00004998So a typical memory configuration with 16 MB of DRAM could look like
4999this:
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001 0x0000 0000 Exception Vector code
5002 :
5003 0x0000 1FFF
5004 0x0000 2000 Free for Application Use
5005 :
5006 :
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008 :
5009 :
5010 0x00FB FF20 Monitor Stack (Growing downward)
5011 0x00FB FFAC Board Info Data and permanent copy of global data
5012 0x00FC 0000 Malloc Arena
5013 :
5014 0x00FD FFFF
5015 0x00FE 0000 RAM Copy of Monitor Code
5016 ... eventually: LCD or video framebuffer
5017 ... eventually: pRAM (Protected RAM - unchanged by reset)
5018 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005019
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk6c59edc2004-05-03 20:45:30 +00005021System Initialization:
5022----------------------
wdenkc6097192002-11-03 00:24:07 +00005023
wdenk6c59edc2004-05-03 20:45:30 +00005024In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005025(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005026configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005027To be able to re-map memory U-Boot then jumps to its link address.
5028To be able to implement the initialization code in C, a (small!)
5029initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005030which provide such a feature like), or in a locked part of the data
5031cache. After that, U-Boot initializes the CPU core, the caches and
5032the SIU.
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034Next, all (potentially) available memory banks are mapped using a
5035preliminary mapping. For example, we put them on 512 MB boundaries
5036(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5037on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5038programmed for SDRAM access. Using the temporary configuration, a
5039simple memory test is run that determines the size of the SDRAM
5040banks.
wdenkc6097192002-11-03 00:24:07 +00005041
wdenk6c59edc2004-05-03 20:45:30 +00005042When there is more than one SDRAM bank, and the banks are of
5043different size, the largest is mapped first. For equal size, the first
5044bank (CS2#) is mapped first. The first mapping is always for address
50450x00000000, with any additional banks following immediately to create
5046contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048Then, the monitor installs itself at the upper end of the SDRAM area
5049and allocates memory for use by malloc() and for the global Board
5050Info data; also, the exception vector code is copied to the low RAM
5051pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053Only after this relocation will you have a "normal" C environment;
5054until that you are restricted in several ways, mostly because you are
5055running from ROM, and because the code will have to be relocated to a
5056new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005057
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059U-Boot Porting Guide:
5060----------------------
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5063list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005064
wdenkc6097192002-11-03 00:24:07 +00005065
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005066int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005067{
5068 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005069
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005070 signal(SIGALRM, no_more_time);
5071 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk6c59edc2004-05-03 20:45:30 +00005073 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005074 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005075 return 0;
5076 }
wdenkc6097192002-11-03 00:24:07 +00005077
wdenk6c59edc2004-05-03 20:45:30 +00005078 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005079
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005080 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005081
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005082 if (clueless)
5083 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk6c59edc2004-05-03 20:45:30 +00005085 while (learning) {
5086 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005087 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5088 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005089 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005090 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005091 }
wdenkc6097192002-11-03 00:24:07 +00005092
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005093 if (available_money > toLocalCurrency ($2500))
5094 Buy a BDI3000;
5095 else
wdenk6c59edc2004-05-03 20:45:30 +00005096 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005097
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005098 if (a similar board exists) { /* hopefully... */
5099 cp -a board/<similar> board/<myboard>
5100 cp include/configs/<similar>.h include/configs/<myboard>.h
5101 } else {
5102 Create your own board support subdirectory;
5103 Create your own board include/configs/<myboard>.h file;
5104 }
5105 Edit new board/<myboard> files
5106 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005107
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005108 while (!accepted) {
5109 while (!running) {
5110 do {
5111 Add / modify source code;
5112 } until (compiles);
5113 Debug;
5114 if (clueless)
5115 email("Hi, I am having problems...");
5116 }
5117 Send patch file to the U-Boot email list;
5118 if (reasonable critiques)
5119 Incorporate improvements from email list code review;
5120 else
5121 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005122 }
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk6c59edc2004-05-03 20:45:30 +00005124 return 0;
5125}
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk6c59edc2004-05-03 20:45:30 +00005127void no_more_time (int sig)
5128{
5129 hire_a_guru();
5130}
wdenkc6097192002-11-03 00:24:07 +00005131
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133Coding Standards:
5134-----------------
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005137coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005138"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005139
5140Source files originating from a different project (for example the
5141MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005142reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005143sources.
wdenkc6097192002-11-03 00:24:07 +00005144
Detlev Zundelaa63d482006-09-01 15:39:02 +02005145Please note that U-Boot is implemented in C (and to some small parts in
5146Assembler); no C++ is used, so please do not use C++ style comments (//)
5147in your code.
wdenkad276f22004-01-04 16:28:35 +00005148
wdenk6c59edc2004-05-03 20:45:30 +00005149Please also stick to the following formatting rules:
5150- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005151- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005152- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005153- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005154- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk6c59edc2004-05-03 20:45:30 +00005156Submissions which do not conform to the standards may be returned
5157with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005158
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk6c59edc2004-05-03 20:45:30 +00005160Submitting Patches:
5161-------------------
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163Since the number of patches for U-Boot is growing, we need to
5164establish some rules. Submissions which do not conform to these rules
5165may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005166
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005167Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005168
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005169Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5170see http://lists.denx.de/mailman/listinfo/u-boot
5171
wdenk6c59edc2004-05-03 20:45:30 +00005172When you send a patch, please include the following information with
5173it:
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175* For bug fixes: a description of the bug and how your patch fixes
5176 this bug. Please try to include a way of demonstrating that the
5177 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179* For new features: a description of the feature and your
5180 implementation.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005183
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005184* For major contributions, add a MAINTAINERS file with your
5185 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005186
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005187* When you add support for a new board, don't forget to add a
5188 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk6c59edc2004-05-03 20:45:30 +00005190* If your patch adds new configuration options, don't forget to
5191 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005192
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005193* The patch itself. If you are using git (which is *strongly*
5194 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005195 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005196 the U-Boot mailing list, you will avoid most of the common problems
5197 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005198
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005199 If you cannot use git, use "diff -purN OLD NEW". If your version of
5200 diff does not support these options, then get the latest version of
5201 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005202
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005203 The current directory when running this command shall be the parent
5204 directory of the U-Boot source tree (i. e. please make sure that
5205 your patch includes sufficient directory information for the
5206 affected files).
5207
5208 We prefer patches as plain text. MIME attachments are discouraged,
5209 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211* If one logical set of modifications affects or creates several
5212 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005213
wdenk6c59edc2004-05-03 20:45:30 +00005214* Changesets that contain different, unrelated modifications shall be
5215 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005216
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218Notes:
wdenkc6097192002-11-03 00:24:07 +00005219
Simon Glassdc27def2016-07-27 20:33:08 -06005220* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005221 source tree and make sure that no errors or warnings are reported
5222 for any of the boards.
5223
5224* Keep your modifications to the necessary minimum: A patch
5225 containing several unrelated changes or arbitrary reformats will be
5226 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk6c59edc2004-05-03 20:45:30 +00005228* If you modify existing code, make sure that your new code does not
5229 add to the memory footprint of the code ;-) Small is beautiful!
5230 When adding new features, these should compile conditionally only
5231 (using #ifdef), and the resulting code with the new feature
5232 disabled must not need more memory than the old code without your
5233 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005234
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005235* Remember that there is a size limit of 100 kB per message on the
5236 u-boot mailing list. Bigger patches will be moderated. If they are
5237 reasonable and not too big, they will be acknowledged. But patches
5238 bigger than the size limit should be avoided.