blob: 1edf3dbbd83bbc38587a13b5529d3e12f3631895 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-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 Denkeca3aeb2013-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
wdenke86e5a02004-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. Day7207b362015-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. Day7207b362015-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. Dayadb9d852012-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. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-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 Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500146 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500147 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400148 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500149/api Machine/arch independent API for external apps
150/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800151/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500152/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500153/configs Board default configuration files
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400157/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-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. Day7207b362015-12-19 07:16:10 -0500161/lib Library routines generic to all architectures
162/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500163/net Networking code
164/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500165/scripts Various build scripts and Makefiles
166/test Various unit test files
Peter Tyser8d321b82010-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200184 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000185
Robert P. J. Day7207b362015-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 Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200202 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000203
Robert P. J. Day7207b362015-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 Glass75b3c3a2014-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 Teki6b1978f2014-08-31 21:19:43 +0530216See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600217
218
Simon Glassdb910352015-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. Day7207b362015-12-19 07:16:10 -0500223SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700224
Robert P. J. Day7207b362015-12-19 07:16:10 -0500225Note: "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.
232
233Execution 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 Glassdb910352015-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 Tan0680f1b2017-05-03 17:13:32 +0800294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-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
wdenk7f6c2cb2002-11-10 22:06:23 +0000311Many of the options are named exactly as the corresponding Linux
312kernel configuration options. The intention is to make it easier to
313build a config tool - later.
314
315
wdenkc6097192002-11-03 00:24:07 +0000316The following options need to be configured:
317
Kim Phillips26281142007-08-10 13:28:25 -0500318- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000319
Kim Phillips26281142007-08-10 13:28:25 -0500320- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Kumar Gala66412c62011-02-18 05:40:54 -0600327- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000328 CONFIG_SYS_PPC64
329
330 Specifies that the core is a 64-bit PowerPC implementation (implements
331 the "64" category of the Power ISA). This is necessary for ePAPR
332 compliance, among other possible reasons.
333
Kumar Gala66412c62011-02-18 05:40:54 -0600334 CONFIG_SYS_FSL_TBCLK_DIV
335
336 Defines the core time base clock divider ratio compared to the
337 system clock. On most PQ3 devices this is 8, on newer QorIQ
338 devices it can be 16 or 32. The ratio varies from SoC to Soc.
339
Kumar Gala8f290842011-05-20 00:39:21 -0500340 CONFIG_SYS_FSL_PCIE_COMPAT
341
342 Defines the string to utilize when trying to match PCIe device
343 tree nodes for the given platform.
344
Scott Wood33eee332012-08-14 10:14:53 +0000345 CONFIG_SYS_FSL_ERRATUM_A004510
346
347 Enables a workaround for erratum A004510. If set,
348 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
350
351 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
352 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
353
354 Defines one or two SoC revisions (low 8 bits of SVR)
355 for which the A004510 workaround should be applied.
356
357 The rest of SVR is either not relevant to the decision
358 of whether the erratum is present (e.g. p2040 versus
359 p2041) or is implied by the build target, which controls
360 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
361
362 See Freescale App Note 4493 for more information about
363 this erratum.
364
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530365 CONFIG_A003399_NOR_WORKAROUND
366 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800367 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530368
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530369 CONFIG_A008044_WORKAROUND
370 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800371 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530372
Scott Wood33eee332012-08-14 10:14:53 +0000373 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
374
375 This is the value to write into CCSR offset 0x18600
376 according to the A004510 workaround.
377
Priyanka Jain64501c62013-07-02 09:21:04 +0530378 CONFIG_SYS_FSL_DSP_DDR_ADDR
379 This value denotes start offset of DDR memory which is
380 connected exclusively to the DSP cores.
381
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530382 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
383 This value denotes start offset of M2 memory
384 which is directly connected to the DSP core.
385
Priyanka Jain64501c62013-07-02 09:21:04 +0530386 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
387 This value denotes start offset of M3 memory which is directly
388 connected to the DSP core.
389
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530390 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391 This value denotes start offset of DSP CCSR space.
392
Priyanka Jainb1359912013-12-17 14:25:52 +0530393 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
394 Single Source Clock is clocking mode present in some of FSL SoC's.
395 In this mode, a single differential clock is used to supply
396 clocks to the sysclock, ddrclock and usbclock.
397
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530398 CONFIG_SYS_CPC_REINIT_F
399 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800400 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530401
Tang Yuantianaade2002014-04-17 15:33:46 +0800402 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800403 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800404 supported, core will start to execute uboot when wakes up.
405
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000406- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700407 CONFIG_SYS_GENERIC_GLOBAL_DATA
408 Defines global data is initialized in generic board board_init_f().
409 If this macro is defined, global data is created and cleared in
410 generic board board_init_f(). Without this macro, architecture/board
411 should initialize global data before calling board_init_f().
412
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000413 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
414
415 Defines the endianess of the CPU. Implementation of those
416 values is arch specific.
417
York Sun5614e712013-09-30 09:22:09 -0700418 CONFIG_SYS_FSL_DDR
419 Freescale DDR driver in use. This type of DDR controller is
420 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
421 SoCs.
422
423 CONFIG_SYS_FSL_DDR_ADDR
424 Freescale DDR memory-mapped register base.
425
426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
429
430 CONFIG_SYS_FSL_DDRC_GEN1
431 Freescale DDR1 controller.
432
433 CONFIG_SYS_FSL_DDRC_GEN2
434 Freescale DDR2 controller.
435
436 CONFIG_SYS_FSL_DDRC_GEN3
437 Freescale DDR3 controller.
438
York Sun34e026f2014-03-27 17:54:47 -0700439 CONFIG_SYS_FSL_DDRC_GEN4
440 Freescale DDR4 controller.
441
York Sun9ac4ffb2013-09-30 14:20:51 -0700442 CONFIG_SYS_FSL_DDRC_ARM_GEN3
443 Freescale DDR3 controller for ARM-based SoCs.
444
York Sun5614e712013-09-30 09:22:09 -0700445 CONFIG_SYS_FSL_DDR1
446 Board config to use DDR1. It can be enabled for SoCs with
447 Freescale DDR1 or DDR2 controllers, depending on the board
448 implemetation.
449
450 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400451 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700452 Freescale DDR2 or DDR3 controllers, depending on the board
453 implementation.
454
455 CONFIG_SYS_FSL_DDR3
456 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700457 Freescale DDR3 or DDR3L controllers.
458
459 CONFIG_SYS_FSL_DDR3L
460 Board config to use DDR3L. It can be enabled for SoCs with
461 DDR3L controllers.
462
463 CONFIG_SYS_FSL_DDR4
464 Board config to use DDR4. It can be enabled for SoCs with
465 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700466
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530467 CONFIG_SYS_FSL_IFC_BE
468 Defines the IFC controller register space as Big Endian
469
470 CONFIG_SYS_FSL_IFC_LE
471 Defines the IFC controller register space as Little Endian
472
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530473 CONFIG_SYS_FSL_IFC_CLK_DIV
474 Defines divider of platform clock(clock input to IFC controller).
475
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530476 CONFIG_SYS_FSL_LBC_CLK_DIV
477 Defines divider of platform clock(clock input to eLBC controller).
478
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530479 CONFIG_SYS_FSL_PBL_PBI
480 It enables addition of RCW (Power on reset configuration) in built image.
481 Please refer doc/README.pblimage for more details
482
483 CONFIG_SYS_FSL_PBL_RCW
484 It adds PBI(pre-boot instructions) commands in u-boot build image.
485 PBI commands can be used to configure SoC before it starts the execution.
486 Please refer doc/README.pblimage for more details
487
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530488 CONFIG_SPL_FSL_PBL
489 It adds a target to create boot binary having SPL binary in PBI format
490 concatenated with u-boot binary.
491
York Sun4e5b1bd2014-02-10 13:59:42 -0800492 CONFIG_SYS_FSL_DDR_BE
493 Defines the DDR controller register space as Big Endian
494
495 CONFIG_SYS_FSL_DDR_LE
496 Defines the DDR controller register space as Little Endian
497
York Sun6b9e3092014-02-10 13:59:43 -0800498 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
499 Physical address from the view of DDR controllers. It is the
500 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
501 it could be different for ARM SoCs.
502
York Sun6b1e1252014-02-10 13:59:44 -0800503 CONFIG_SYS_FSL_DDR_INTLV_256B
504 DDR controller interleaving on 256-byte. This is a special
505 interleaving mode, handled by Dickens for Freescale layerscape
506 SoCs with ARM core.
507
York Sun1d71efb2014-08-01 15:51:00 -0700508 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
509 Number of controllers used as main memory.
510
511 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
512 Number of controllers used for other than main memory.
513
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530514 CONFIG_SYS_FSL_HAS_DP_DDR
515 Defines the SoC has DP-DDR used for DPAA.
516
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530517 CONFIG_SYS_FSL_SEC_BE
518 Defines the SEC controller register space as Big Endian
519
520 CONFIG_SYS_FSL_SEC_LE
521 Defines the SEC controller register space as Little Endian
522
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200523- MIPS CPU options:
524 CONFIG_SYS_INIT_SP_OFFSET
525
526 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
527 pointer. This is needed for the temporary stack before
528 relocation.
529
530 CONFIG_SYS_MIPS_CACHE_MODE
531
532 Cache operation mode for the MIPS CPU.
533 See also arch/mips/include/asm/mipsregs.h.
534 Possible values are:
535 CONF_CM_CACHABLE_NO_WA
536 CONF_CM_CACHABLE_WA
537 CONF_CM_UNCACHED
538 CONF_CM_CACHABLE_NONCOHERENT
539 CONF_CM_CACHABLE_CE
540 CONF_CM_CACHABLE_COW
541 CONF_CM_CACHABLE_CUW
542 CONF_CM_CACHABLE_ACCELERATED
543
544 CONFIG_SYS_XWAY_EBU_BOOTCFG
545
546 Special option for Lantiq XWAY SoCs for booting from NOR flash.
547 See also arch/mips/cpu/mips32/start.S.
548
549 CONFIG_XWAY_SWAP_BYTES
550
551 Enable compilation of tools/xway-swap-bytes needed for Lantiq
552 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
553 be swapped if a flash programmer is used.
554
Christian Rieschb67d8812012-02-02 00:44:39 +0000555- ARM options:
556 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
557
558 Select high exception vectors of the ARM core, e.g., do not
559 clear the V bit of the c1 register of CP15.
560
York Sun207774b2015-03-20 19:28:08 -0700561 COUNTER_FREQUENCY
562 Generic timer clock source frequency.
563
564 COUNTER_FREQUENCY_REAL
565 Generic timer clock source frequency if the real clock is
566 different from COUNTER_FREQUENCY, and can only be determined
567 at run time.
568
Stephen Warren73c38932015-01-19 16:25:52 -0700569- Tegra SoC options:
570 CONFIG_TEGRA_SUPPORT_NON_SECURE
571
572 Support executing U-Boot in non-secure (NS) mode. Certain
573 impossible actions will be skipped if the CPU is in NS mode,
574 such as ARM architectural timer initialization.
575
wdenk5da627a2003-10-09 20:09:04 +0000576- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000577 CONFIG_CLOCKS_IN_MHZ
578
579 U-Boot stores all clock information in Hz
580 internally. For binary compatibility with older Linux
581 kernels (which expect the clocks passed in the
582 bd_info data to be in MHz) the environment variable
583 "clocks_in_mhz" can be defined so that U-Boot
584 converts clock data to MHZ before passing it to the
585 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000586 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100587 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000588 default environment.
589
wdenk5da627a2003-10-09 20:09:04 +0000590 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
591
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800592 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000593 expect it to be in bytes, others in MB.
594 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
595
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400596 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200597
598 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400599 passed using flattened device trees (based on open firmware
600 concepts).
601
602 CONFIG_OF_LIBFDT
603 * New libfdt-based support
604 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500605 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400606
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200607 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600608 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200609
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200610 boards with QUICC Engines require OF_QE to set UCC MAC
611 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500612
Kumar Gala4e253132006-01-11 13:54:17 -0600613 CONFIG_OF_BOARD_SETUP
614
615 Board code has addition modification that it wants to make
616 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000617
Simon Glassc654b512014-10-23 18:58:54 -0600618 CONFIG_OF_SYSTEM_SETUP
619
620 Other code has addition modification that it wants to make
621 to the flat device tree before handing it off to the kernel.
622 This causes ft_system_setup() to be called before booting
623 the kernel.
624
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200625 CONFIG_OF_IDE_FIXUP
626
627 U-Boot can detect if an IDE device is present or not.
628 If not, and this new config option is activated, U-Boot
629 removes the ATA node from the DTS before booting Linux,
630 so the Linux IDE driver does not probe the device and
631 crash. This is needed for buggy hardware (uc101) where
632 no pull down resistor is connected to the signal IDE5V_DD7.
633
Igor Grinberg7eb29392011-07-14 05:45:07 +0000634 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
635
636 This setting is mandatory for all boards that have only one
637 machine type and must be used to specify the machine type
638 number as it appears in the ARM machine registry
639 (see http://www.arm.linux.org.uk/developer/machines/).
640 Only boards that have multiple machine types supported
641 in a single configuration file and the machine type is
642 runtime discoverable, do not have to use this setting.
643
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100644- vxWorks boot parameters:
645
646 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700647 environments variables: bootdev, bootfile, ipaddr, netmask,
648 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100649 It loads the vxWorks image pointed bootfile.
650
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100651 Note: If a "bootargs" environment is defined, it will overwride
652 the defaults discussed just above.
653
Aneesh V2c451f72011-06-16 23:30:47 +0000654- Cache Configuration:
655 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
656 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
657 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
658
Aneesh V93bc2192011-06-16 23:30:51 +0000659- Cache Configuration for ARM:
660 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
661 controller
662 CONFIG_SYS_PL310_BASE - Physical base address of PL310
663 controller register space
664
wdenk6705d812004-08-02 23:22:59 +0000665- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200666 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL010 UARTs.
669
Andreas Engel48d01922008-09-08 14:30:53 +0200670 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000671
672 Define this if you want support for Amba PrimeCell PL011 UARTs.
673
674 CONFIG_PL011_CLOCK
675
676 If you have Amba PrimeCell PL011 UARTs, set this variable to
677 the clock speed of the UARTs.
678
679 CONFIG_PL01x_PORTS
680
681 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
682 define this to a list of base addresses for each (supported)
683 port. See e.g. include/configs/versatile.h
684
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400685 CONFIG_SERIAL_HW_FLOW_CONTROL
686
687 Define this variable to enable hw flow control in serial driver.
688 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000689
wdenkc6097192002-11-03 00:24:07 +0000690- Console Baudrate:
691 CONFIG_BAUDRATE - in bps
692 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200693 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000694
wdenkc6097192002-11-03 00:24:07 +0000695- Autoboot Command:
696 CONFIG_BOOTCOMMAND
697 Only needed when CONFIG_BOOTDELAY is enabled;
698 define a command string that is automatically executed
699 when no character is read on the console interface
700 within "Boot Delay" after reset.
701
702 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000703 This can be used to pass arguments to the bootm
704 command. The value of CONFIG_BOOTARGS goes into the
705 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000706
707 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000708 The value of these goes into the environment as
709 "ramboot" and "nfsboot" respectively, and can be used
710 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200711 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000712
Heiko Schochereda0ba32013-11-04 14:04:59 +0100713- Bootcount:
714 CONFIG_BOOTCOUNT_LIMIT
715 Implements a mechanism for detecting a repeating reboot
716 cycle, see:
717 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
718
719 CONFIG_BOOTCOUNT_ENV
720 If no softreset save registers are found on the hardware
721 "bootcount" is stored in the environment. To prevent a
722 saveenv on all reboots, the environment variable
723 "upgrade_available" is used. If "upgrade_available" is
724 0, "bootcount" is always 0, if "upgrade_available" is
725 1 "bootcount" is incremented in the environment.
726 So the Userspace Applikation must set the "upgrade_available"
727 and "bootcount" variable to 0, if a boot was successfully.
728
wdenkc6097192002-11-03 00:24:07 +0000729- Pre-Boot Commands:
730 CONFIG_PREBOOT
731
732 When this option is #defined, the existence of the
733 environment variable "preboot" will be checked
734 immediately before starting the CONFIG_BOOTDELAY
735 countdown and/or running the auto-boot command resp.
736 entering interactive mode.
737
738 This feature is especially useful when "preboot" is
739 automatically generated or modified. For an example
740 see the LWMON board specific code: here "preboot" is
741 modified when the user holds down a certain
742 combination of keys on the (special) keyboard when
743 booting the systems
744
745- Serial Download Echo Mode:
746 CONFIG_LOADS_ECHO
747 If defined to 1, all characters received during a
748 serial download (using the "loads" command) are
749 echoed back. This might be needed by some terminal
750 emulations (like "cu"), but may as well just take
751 time on others. This setting #define's the initial
752 value of the "loads_echo" environment variable.
753
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000755 CONFIG_KGDB_BAUDRATE
756 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200757 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000758
759- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500760 Monitor commands can be included or excluded
761 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000762 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500763 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000764
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500765 The default command configuration includes all commands
766 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000767
Marek Vasutb401b732014-03-05 19:58:39 +0100768 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500770 CONFIG_CMD_BDI bdinfo
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500771 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400772 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 CONFIG_CMD_CACHE * icache, dcache
774 CONFIG_CMD_CONSOLE coninfo
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500775 CONFIG_CMD_DHCP * DHCP support
776 CONFIG_CMD_DIAG * Diagnostics
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500777 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500778 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500779 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder88733e22013-10-22 19:07:34 -0500780 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500781 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000782 CONFIG_CMD_EXT2 * ext2 command support
783 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700784 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
785 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100786 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500787 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500788 CONFIG_CMD_FLASH flinfo, erase, protect
789 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500790 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000791 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500792 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500793 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000794 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200795 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500796 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000797 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200799 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000800 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
801 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500802 CONFIG_CMD_LOADB loadb
803 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200804 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400805 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000806 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500807 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000808 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200809 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500810 CONFIG_CMD_MISC Misc functions like sleep etc
811 CONFIG_CMD_MMC * MMC memory mapped support
812 CONFIG_CMD_MII * MII utility commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200814 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600815 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000816 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500817 CONFIG_CMD_PCI * pciinfo
818 CONFIG_CMD_PCMCIA * PCMCIA support
819 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
820 host
821 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000822 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_REGINFO * Register dump
824 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000825 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_SAVES * save S record dump
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500827 CONFIG_CMD_SDRAM * print SDRAM configuration information
828 (requires CONFIG_CMD_I2C)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700829 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liu7d861d92013-02-05 19:05:41 +0800830 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200831 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500832 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000833 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000834 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000835 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
836 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000839 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200840 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +0200841 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000842
843 EXAMPLE: If you want all functions except of network
844 support you can write:
845
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500846 #include "config_cmd_all.h"
847 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000848
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400849 Other Commands:
850 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000851
852 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500853 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000854 what you (and your U-Boot users) are doing. Data
Heiko Schocher5b8e76c2017-06-07 17:33:09 +0200855 cache cannot be enabled on systems like the
Christophe Leroy907208c2017-07-06 10:23:22 +0200856 8xx (where accesses to the IMMR region must be
wdenk43d96162003-03-06 00:02:04 +0000857 uncached), and it cannot be disabled on all other
858 systems where we (mis-) use the data cache to hold an
859 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000860
861
862 XXX - this list needs to get updated!
863
Simon Glass302a6482016-03-13 19:07:28 -0600864- Removal of commands
865 If no commands are needed to boot, you can disable
866 CONFIG_CMDLINE to remove them. In this case, the command line
867 will not be available, and when U-Boot wants to execute the
868 boot command (on start-up) it will call board_run_command()
869 instead. This can reduce image size significantly for very
870 simple boot procedures.
871
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000872- Regular expression support:
873 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200874 If this variable is defined, U-Boot is linked against
875 the SLRE (Super Light Regular Expression) library,
876 which adds regex support to some commands, as for
877 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000878
Simon Glass45ba8072011-10-15 05:48:20 +0000879- Device tree:
880 CONFIG_OF_CONTROL
881 If this variable is defined, U-Boot will use a device tree
882 to configure its devices, instead of relying on statically
883 compiled #defines in the board file. This option is
884 experimental and only available on a few boards. The device
885 tree is available in the global data as gd->fdt_blob.
886
Simon Glass2c0f79e2011-10-24 19:15:31 +0000887 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700888 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000889
890 CONFIG_OF_EMBED
891 If this variable is defined, U-Boot will embed a device tree
892 binary in its image. This device tree file should be in the
893 board directory and called <soc>-<board>.dts. The binary file
894 is then picked up in board_init_f() and made available through
895 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000896
Simon Glass2c0f79e2011-10-24 19:15:31 +0000897 CONFIG_OF_SEPARATE
898 If this variable is defined, U-Boot will build a device tree
899 binary. It will be called u-boot.dtb. Architecture-specific
900 code will locate it at run-time. Generally this works by:
901
902 cat u-boot.bin u-boot.dtb >image.bin
903
904 and in fact, U-Boot does this for you, creating a file called
905 u-boot-dtb.bin which is useful in the common case. You can
906 still use the individual files if you need something more
907 exotic.
908
Alex Deymo82f766d2017-04-02 01:25:20 -0700909 CONFIG_OF_BOARD
910 If this variable is defined, U-Boot will use the device tree
911 provided by the board at runtime instead of embedding one with
912 the image. Only boards defining board_fdt_blob_setup() support
913 this option (see include/fdtdec.h file).
914
wdenkc6097192002-11-03 00:24:07 +0000915- Watchdog:
916 CONFIG_WATCHDOG
917 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000918 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200919 specific code for a watchdog. For the 8xx
920 CPUs, the SIU Watchdog feature is enabled in the SYPCR
921 register. When supported for a specific SoC is
922 available, then no further board specific code should
923 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000924
925 CONFIG_HW_WATCHDOG
926 When using a watchdog circuitry external to the used
927 SoC, then define this variable and provide board
928 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000929
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100930 CONFIG_AT91_HW_WDT_TIMEOUT
931 specify the timeout in seconds. default 2 seconds.
932
stroesec1551ea2003-04-04 15:53:41 +0000933- U-Boot Version:
934 CONFIG_VERSION_VARIABLE
935 If this variable is defined, an environment variable
936 named "ver" is created by U-Boot showing the U-Boot
937 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200938 Any change to this variable will be reverted at the
939 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000940
wdenkc6097192002-11-03 00:24:07 +0000941- Real-Time Clock:
942
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500943 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000944 has to be selected, too. Define exactly one of the
945 following options:
946
wdenkc6097192002-11-03 00:24:07 +0000947 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000948 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000949 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000950 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000951 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000952 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200953 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000954 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100955 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000956 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200957 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200958 CONFIG_SYS_RV3029_TCR - enable trickle charger on
959 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000960
wdenkb37c7e52003-06-30 16:24:52 +0000961 Note that if the RTC uses I2C, then the I2C interface
962 must also be configured. See I2C Support, below.
963
Peter Tysere92739d2008-12-17 16:36:21 -0600964- GPIO Support:
965 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600966
Chris Packham5dec49c2010-12-19 10:12:13 +0000967 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
968 chip-ngpio pairs that tell the PCA953X driver the number of
969 pins supported by a particular chip.
970
Peter Tysere92739d2008-12-17 16:36:21 -0600971 Note that if the GPIO device uses I2C, then the I2C interface
972 must also be configured. See I2C Support, below.
973
Simon Glassaa532332014-06-11 23:29:41 -0600974- I/O tracing:
975 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
976 accesses and can checksum them or write a list of them out
977 to memory. See the 'iotrace' command for details. This is
978 useful for testing device drivers since it can confirm that
979 the driver behaves the same way before and after a code
980 change. Currently this is supported on sandbox and arm. To
981 add support for your architecture, add '#include <iotrace.h>'
982 to the bottom of arch/<arch>/include/asm/io.h and test.
983
984 Example output from the 'iotrace stats' command is below.
985 Note that if the trace buffer is exhausted, the checksum will
986 still continue to operate.
987
988 iotrace is enabled
989 Start: 10000000 (buffer start address)
990 Size: 00010000 (buffer size)
991 Offset: 00000120 (current buffer offset)
992 Output: 10000120 (start + offset)
993 Count: 00000018 (number of trace records)
994 CRC32: 9526fb66 (CRC32 of all trace records)
995
wdenkc6097192002-11-03 00:24:07 +0000996- Timestamp Support:
997
wdenk43d96162003-03-06 00:02:04 +0000998 When CONFIG_TIMESTAMP is selected, the timestamp
999 (date and time) of an image is printed by image
1000 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001001 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001002
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001003- Partition Labels (disklabels) Supported:
1004 Zero or more of the following:
1005 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001006 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1007 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1008 bootloader. Note 2TB partition limit; see
1009 disk/part_efi.c
1010 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001011
Simon Glassfc843a02017-05-17 03:25:30 -06001012 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001013 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001014 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001015
1016- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001017 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1018 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001019
wdenk4d13cba2004-03-14 14:09:05 +00001020 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1021 be performed by calling the function
1022 ide_set_reset(int reset)
1023 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001024
1025- ATAPI Support:
1026 CONFIG_ATAPI
1027
1028 Set this to enable ATAPI support.
1029
wdenkc40b2952004-03-13 23:29:43 +00001030- LBA48 Support
1031 CONFIG_LBA48
1032
1033 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001034 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001035 Whithout these , LBA48 support uses 32bit variables and will 'only'
1036 support disks up to 2.1TB.
1037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001038 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001039 When enabled, makes the IDE subsystem use 64bit sector addresses.
1040 Default is 32bit.
1041
wdenkc6097192002-11-03 00:24:07 +00001042- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001043 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1044 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1045 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001046 maximum numbers of LUNs, SCSI ID's and target
1047 devices.
wdenkc6097192002-11-03 00:24:07 +00001048
Wolfgang Denk93e14592013-10-04 17:43:24 +02001049 The environment variable 'scsidevs' is set to the number of
1050 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001051
wdenkc6097192002-11-03 00:24:07 +00001052- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001053 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001054 Support for Intel 8254x/8257x gigabit chips.
1055
1056 CONFIG_E1000_SPI
1057 Utility code for direct access to the SPI bus on Intel 8257x.
1058 This does not do anything useful unless you set at least one
1059 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1060
1061 CONFIG_E1000_SPI_GENERIC
1062 Allow generic access to the SPI bus on the Intel 8257x, for
1063 example with the "sspi" command.
1064
1065 CONFIG_CMD_E1000
1066 Management command for E1000 devices. When used on devices
1067 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001068
wdenkc6097192002-11-03 00:24:07 +00001069 CONFIG_EEPRO100
1070 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001071 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001072 write routine for first time initialisation.
1073
1074 CONFIG_TULIP
1075 Support for Digital 2114x chips.
1076 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1077 modem chip initialisation (KS8761/QS6611).
1078
1079 CONFIG_NATSEMI
1080 Support for National dp83815 chips.
1081
1082 CONFIG_NS8382X
1083 Support for National dp8382[01] gigabit chips.
1084
wdenk45219c42003-05-12 21:50:16 +00001085- NETWORK Support (other):
1086
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001087 CONFIG_DRIVER_AT91EMAC
1088 Support for AT91RM9200 EMAC.
1089
1090 CONFIG_RMII
1091 Define this to use reduced MII inteface
1092
1093 CONFIG_DRIVER_AT91EMAC_QUIET
1094 If this defined, the driver is quiet.
1095 The driver doen't show link status messages.
1096
Rob Herringefdd7312011-12-15 11:15:49 +00001097 CONFIG_CALXEDA_XGMAC
1098 Support for the Calxeda XGMAC device
1099
Ashok3bb46d22012-10-15 06:20:47 +00001100 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001101 Support for SMSC's LAN91C96 chips.
1102
wdenk45219c42003-05-12 21:50:16 +00001103 CONFIG_LAN91C96_USE_32_BIT
1104 Define this to enable 32 bit addressing
1105
Ashok3bb46d22012-10-15 06:20:47 +00001106 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001107 Support for SMSC's LAN91C111 chip
1108
1109 CONFIG_SMC91111_BASE
1110 Define this to hold the physical address
1111 of the device (I/O space)
1112
1113 CONFIG_SMC_USE_32_BIT
1114 Define this if data bus is 32 bits
1115
1116 CONFIG_SMC_USE_IOFUNCS
1117 Define this to use i/o functions instead of macros
1118 (some hardware wont work with macros)
1119
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001120 CONFIG_DRIVER_TI_EMAC
1121 Support for davinci emac
1122
1123 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1124 Define this if you have more then 3 PHYs.
1125
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001126 CONFIG_FTGMAC100
1127 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1128
1129 CONFIG_FTGMAC100_EGIGA
1130 Define this to use GE link update with gigabit PHY.
1131 Define this if FTGMAC100 is connected to gigabit PHY.
1132 If your system has 10/100 PHY only, it might not occur
1133 wrong behavior. Because PHY usually return timeout or
1134 useless data when polling gigabit status and gigabit
1135 control registers. This behavior won't affect the
1136 correctnessof 10/100 link speed update.
1137
Mike Rapoportc2fff332009-11-11 10:03:03 +02001138 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001139 Support for SMSC's LAN911x and LAN921x chips
1140
Mike Rapoportc2fff332009-11-11 10:03:03 +02001141 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001142 Define this to hold the physical address
1143 of the device (I/O space)
1144
Mike Rapoportc2fff332009-11-11 10:03:03 +02001145 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001146 Define this if data bus is 32 bits
1147
Mike Rapoportc2fff332009-11-11 10:03:03 +02001148 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001149 Define this if data bus is 16 bits. If your processor
1150 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001151 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001152
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001153 CONFIG_SH_ETHER
1154 Support for Renesas on-chip Ethernet controller
1155
1156 CONFIG_SH_ETHER_USE_PORT
1157 Define the number of ports to be used
1158
1159 CONFIG_SH_ETHER_PHY_ADDR
1160 Define the ETH PHY's address
1161
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001162 CONFIG_SH_ETHER_CACHE_WRITEBACK
1163 If this option is set, the driver enables cache flush.
1164
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001165- PWM Support:
1166 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001167 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001168
Vadim Bendebury5e124722011-10-17 08:36:14 +00001169- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001170 CONFIG_TPM
1171 Support TPM devices.
1172
Christophe Ricard0766ad22015-10-06 22:54:41 +02001173 CONFIG_TPM_TIS_INFINEON
1174 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001175 per system is supported at this time.
1176
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001177 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1178 Define the burst count bytes upper limit
1179
Christophe Ricard3aa74082016-01-21 23:27:13 +01001180 CONFIG_TPM_ST33ZP24
1181 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1182
1183 CONFIG_TPM_ST33ZP24_I2C
1184 Support for STMicroelectronics ST33ZP24 I2C devices.
1185 Requires TPM_ST33ZP24 and I2C.
1186
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001187 CONFIG_TPM_ST33ZP24_SPI
1188 Support for STMicroelectronics ST33ZP24 SPI devices.
1189 Requires TPM_ST33ZP24 and SPI.
1190
Dirk Eibachc01939c2013-06-26 15:55:15 +02001191 CONFIG_TPM_ATMEL_TWI
1192 Support for Atmel TWI TPM device. Requires I2C support.
1193
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001194 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001195 Support for generic parallel port TPM devices. Only one device
1196 per system is supported at this time.
1197
1198 CONFIG_TPM_TIS_BASE_ADDRESS
1199 Base address where the generic TPM device is mapped
1200 to. Contemporary x86 systems usually map it at
1201 0xfed40000.
1202
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001203 CONFIG_CMD_TPM
1204 Add tpm monitor functions.
1205 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1206 provides monitor access to authorized functions.
1207
1208 CONFIG_TPM
1209 Define this to enable the TPM support library which provides
1210 functional interfaces to some TPM commands.
1211 Requires support for a TPM device.
1212
1213 CONFIG_TPM_AUTH_SESSIONS
1214 Define this to enable authorized functions in the TPM library.
1215 Requires CONFIG_TPM and CONFIG_SHA1.
1216
wdenkc6097192002-11-03 00:24:07 +00001217- USB Support:
1218 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001219 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001220 CONFIG_USB_UHCI to enable it.
1221 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001222 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001223 storage devices.
1224 Note:
1225 Supported are USB Keyboards and USB Floppy drives
1226 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001227
Simon Glass9ab4ce22012-02-27 10:52:47 +00001228 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1229 txfilltuning field in the EHCI controller on reset.
1230
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001231 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1232 HW module registers.
1233
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001234- USB Device:
1235 Define the below if you wish to use the USB console.
1236 Once firmware is rebuilt from a serial console issue the
1237 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001238 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001239 it has found a new device. The environment variable usbtty
1240 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001241 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001242 Common Device Class Abstract Control Model serial device.
1243 If you select usbtty = gserial you should be able to enumerate
1244 a Linux host by
1245 # modprobe usbserial vendor=0xVendorID product=0xProductID
1246 else if using cdc_acm, simply setting the environment
1247 variable usbtty to be cdc_acm should suffice. The following
1248 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001249
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001250 CONFIG_USB_DEVICE
1251 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001252
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001253 CONFIG_USB_TTY
1254 Define this to have a tty type of device available to
1255 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001256
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301257 CONFIG_USBD_HS
1258 Define this to enable the high speed support for usb
1259 device and usbtty. If this feature is enabled, a routine
1260 int is_usbd_high_speed(void)
1261 also needs to be defined by the driver to dynamically poll
1262 whether the enumeration has succeded at high speed or full
1263 speed.
1264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001265 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001266 Define this if you want stdin, stdout &/or stderr to
1267 be set to usbtty.
1268
Wolfgang Denk386eda02006-06-14 18:14:56 +02001269 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001270 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001271 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001272 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1273 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1274 should pretend to be a Linux device to it's target host.
1275
1276 CONFIG_USBD_MANUFACTURER
1277 Define this string as the name of your company for
1278 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001279
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001280 CONFIG_USBD_PRODUCT_NAME
1281 Define this string as the name of your product
1282 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1283
1284 CONFIG_USBD_VENDORID
1285 Define this as your assigned Vendor ID from the USB
1286 Implementors Forum. This *must* be a genuine Vendor ID
1287 to avoid polluting the USB namespace.
1288 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001289
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001290 CONFIG_USBD_PRODUCTID
1291 Define this as the unique Product ID
1292 for your device
1293 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001294
Igor Grinbergd70a5602011-12-12 12:08:35 +02001295- ULPI Layer Support:
1296 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1297 the generic ULPI layer. The generic layer accesses the ULPI PHY
1298 via the platform viewport, so you need both the genric layer and
1299 the viewport enabled. Currently only Chipidea/ARC based
1300 viewport is supported.
1301 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1302 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001303 If your ULPI phy needs a different reference clock than the
1304 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1305 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001306
1307- MMC Support:
1308 The MMC controller on the Intel PXA is supported. To
1309 enable this define CONFIG_MMC. The MMC can be
1310 accessed from the boot prompt by mapping the device
1311 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001312 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1313 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001314
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001315 CONFIG_SH_MMCIF
1316 Support for Renesas on-chip MMCIF controller
1317
1318 CONFIG_SH_MMCIF_ADDR
1319 Define the base address of MMCIF registers
1320
1321 CONFIG_SH_MMCIF_CLK
1322 Define the clock frequency for MMCIF
1323
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001324 CONFIG_SUPPORT_EMMC_BOOT
1325 Enable some additional features of the eMMC boot partitions.
1326
1327 CONFIG_SUPPORT_EMMC_RPMB
1328 Enable the commands for reading, writing and programming the
1329 key for the Replay Protection Memory Block partition in eMMC.
1330
Tom Rinib3ba6e92013-03-14 05:32:47 +00001331- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001332 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001333 This enables the USB portion of the DFU USB class
1334
1335 CONFIG_CMD_DFU
1336 This enables the command "dfu" which is used to have
1337 U-Boot create a DFU class device via USB. This command
1338 requires that the "dfu_alt_info" environment variable be
1339 set and define the alt settings to expose to the host.
1340
1341 CONFIG_DFU_MMC
1342 This enables support for exposing (e)MMC devices via DFU.
1343
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001344 CONFIG_DFU_NAND
1345 This enables support for exposing NAND devices via DFU.
1346
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301347 CONFIG_DFU_RAM
1348 This enables support for exposing RAM via DFU.
1349 Note: DFU spec refer to non-volatile memory usage, but
1350 allow usages beyond the scope of spec - here RAM usage,
1351 one that would help mostly the developer.
1352
Heiko Schochere7e75c72013-06-12 06:05:51 +02001353 CONFIG_SYS_DFU_DATA_BUF_SIZE
1354 Dfu transfer uses a buffer before writing data to the
1355 raw storage device. Make the size (in bytes) of this buffer
1356 configurable. The size of this buffer is also configurable
1357 through the "dfu_bufsiz" environment variable.
1358
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001359 CONFIG_SYS_DFU_MAX_FILE_SIZE
1360 When updating files rather than the raw storage device,
1361 we use a static buffer to copy the file into and then write
1362 the buffer once we've been given the whole file. Define
1363 this to the maximum filesize (in bytes) for the buffer.
1364 Default is 4 MiB if undefined.
1365
Heiko Schocher001a8312014-03-18 08:09:56 +01001366 DFU_DEFAULT_POLL_TIMEOUT
1367 Poll timeout [ms], is the timeout a device can send to the
1368 host. The host must wait for this timeout before sending
1369 a subsequent DFU_GET_STATUS request to the device.
1370
1371 DFU_MANIFEST_POLL_TIMEOUT
1372 Poll timeout [ms], which the device sends to the host when
1373 entering dfuMANIFEST state. Host waits this timeout, before
1374 sending again an USB request to the device.
1375
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001376- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001377 CONFIG_USB_FUNCTION_FASTBOOT
1378 This enables the USB part of the fastboot gadget
1379
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001380 CONFIG_CMD_FASTBOOT
1381 This enables the command "fastboot" which enables the Android
1382 fastboot mode for the platform's USB device. Fastboot is a USB
1383 protocol for downloading images, flashing and device control
1384 used on Android devices.
1385 See doc/README.android-fastboot for more information.
1386
1387 CONFIG_ANDROID_BOOT_IMAGE
1388 This enables support for booting images which use the Android
1389 image format header.
1390
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001391 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001392 The fastboot protocol requires a large memory buffer for
1393 downloads. Define this to the starting RAM address to use for
1394 downloaded images.
1395
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001396 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001397 The fastboot protocol requires a large memory buffer for
1398 downloads. This buffer should be as large as possible for a
1399 platform. Define this to the size available RAM for fastboot.
1400
Steve Raed1b5ed02014-08-26 11:47:28 -07001401 CONFIG_FASTBOOT_FLASH
1402 The fastboot protocol includes a "flash" command for writing
1403 the downloaded image to a non-volatile storage device. Define
1404 this to enable the "fastboot flash" command.
1405
1406 CONFIG_FASTBOOT_FLASH_MMC_DEV
1407 The fastboot "flash" command requires additional information
1408 regarding the non-volatile storage device. Define this to
1409 the eMMC device that fastboot should use to store the image.
1410
Steve Rae0ff7e582014-12-12 15:51:54 -08001411 CONFIG_FASTBOOT_GPT_NAME
1412 The fastboot "flash" command supports writing the downloaded
1413 image to the Protective MBR and the Primary GUID Partition
1414 Table. (Additionally, this downloaded image is post-processed
1415 to generate and write the Backup GUID Partition Table.)
1416 This occurs when the specified "partition name" on the
1417 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001418 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001419
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001420 CONFIG_FASTBOOT_MBR_NAME
1421 The fastboot "flash" command supports writing the downloaded
1422 image to DOS MBR.
1423 This occurs when the "partition name" specified on the
1424 "fastboot flash" command line matches this value.
1425 If not defined the default value "mbr" is used.
1426
wdenk6705d812004-08-02 23:22:59 +00001427- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001428 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001429 Define these for a default partition on a NAND device
1430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001431 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1432 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001433 Define these for a default partition on a NOR device
1434
wdenkc6097192002-11-03 00:24:07 +00001435- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001436 See Kconfig help for available keyboard drivers.
1437
1438 CONFIG_KEYBOARD
1439
1440 Define this to enable a custom keyboard support.
1441 This simply calls drv_keyboard_init() which must be
1442 defined in your board-specific files. This option is deprecated
1443 and is only used by novena. For new boards, use driver model
1444 instead.
wdenkc6097192002-11-03 00:24:07 +00001445
1446- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001447 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001448 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001449 SOCs that have a DIU should define this macro to enable DIU
1450 support, and should also define these other macros:
1451
1452 CONFIG_SYS_DIU_ADDR
1453 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001454 CONFIG_CFB_CONSOLE
1455 CONFIG_VIDEO_SW_CURSOR
1456 CONFIG_VGA_AS_SINGLE_DEVICE
1457 CONFIG_VIDEO_LOGO
1458 CONFIG_VIDEO_BMP_LOGO
1459
Timur Tabiba8e76b2011-04-11 14:18:22 -05001460 The DIU driver will look for the 'video-mode' environment
1461 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001462 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001463 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001464
wdenkc6097192002-11-03 00:24:07 +00001465- LCD Support: CONFIG_LCD
1466
1467 Define this to enable LCD support (for output to LCD
1468 display); also select one of the supported displays
1469 by defining one of these:
1470
Stelian Pop39cf4802008-05-09 21:57:18 +02001471 CONFIG_ATMEL_LCD:
1472
1473 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1474
wdenkfd3103b2003-11-25 16:55:19 +00001475 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001476
wdenkfd3103b2003-11-25 16:55:19 +00001477 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001478
wdenkfd3103b2003-11-25 16:55:19 +00001479 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001480
wdenkfd3103b2003-11-25 16:55:19 +00001481 NEC NL6448BC20-08. 6.5", 640x480.
1482 Active, color, single scan.
1483
1484 CONFIG_NEC_NL6448BC33_54
1485
1486 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001487 Active, color, single scan.
1488
1489 CONFIG_SHARP_16x9
1490
1491 Sharp 320x240. Active, color, single scan.
1492 It isn't 16x9, and I am not sure what it is.
1493
1494 CONFIG_SHARP_LQ64D341
1495
1496 Sharp LQ64D341 display, 640x480.
1497 Active, color, single scan.
1498
1499 CONFIG_HLD1045
1500
1501 HLD1045 display, 640x480.
1502 Active, color, single scan.
1503
1504 CONFIG_OPTREX_BW
1505
1506 Optrex CBL50840-2 NF-FW 99 22 M5
1507 or
1508 Hitachi LMG6912RPFC-00T
1509 or
1510 Hitachi SP14Q002
1511
1512 320x240. Black & white.
1513
Simon Glass676d3192012-10-17 13:24:54 +00001514 CONFIG_LCD_ALIGNMENT
1515
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001516 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001517 defined then the LCD will be aligned to this value instead.
1518 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1519 here, since it is cheaper to change data cache settings on
1520 a per-section basis.
1521
1522
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001523 CONFIG_LCD_ROTATION
1524
1525 Sometimes, for example if the display is mounted in portrait
1526 mode or even if it's mounted landscape but rotated by 180degree,
1527 we need to rotate our content of the display relative to the
1528 framebuffer, so that user can read the messages which are
1529 printed out.
1530 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1531 initialized with a given rotation from "vl_rot" out of
1532 "vidinfo_t" which is provided by the board specific code.
1533 The value for vl_rot is coded as following (matching to
1534 fbcon=rotate:<n> linux-kernel commandline):
1535 0 = no rotation respectively 0 degree
1536 1 = 90 degree rotation
1537 2 = 180 degree rotation
1538 3 = 270 degree rotation
1539
1540 If CONFIG_LCD_ROTATION is not defined, the console will be
1541 initialized with 0degree rotation.
1542
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001543 CONFIG_LCD_BMP_RLE8
1544
1545 Support drawing of RLE8-compressed bitmaps on the LCD.
1546
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001547 CONFIG_I2C_EDID
1548
1549 Enables an 'i2c edid' command which can read EDID
1550 information over I2C from an attached LCD display.
1551
wdenk7152b1d2003-09-05 23:19:14 +00001552- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001553
wdenk8bde7f72003-06-27 21:31:46 +00001554 If this option is set, the environment is checked for
1555 a variable "splashimage". If found, the usual display
1556 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001557 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001558 specified in "splashimage" is loaded instead. The
1559 console is redirected to the "nulldev", too. This
1560 allows for a "silent" boot where a splash screen is
1561 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001562
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001563 CONFIG_SPLASHIMAGE_GUARD
1564
1565 If this option is set, then U-Boot will prevent the environment
1566 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001567 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001568 This option is useful for targets where, due to alignment
1569 restrictions, an improperly aligned BMP image will cause a data
1570 abort. If you think you will not have problems with unaligned
1571 accesses (for example because your toolchain prevents them)
1572 there is no need to set this option.
1573
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001574 CONFIG_SPLASH_SCREEN_ALIGN
1575
1576 If this option is set the splash image can be freely positioned
1577 on the screen. Environment variable "splashpos" specifies the
1578 position as "x,y". If a positive number is given it is used as
1579 number of pixel from left/top. If a negative number is given it
1580 is used as number of pixel from right/bottom. You can also
1581 specify 'm' for centering the image.
1582
1583 Example:
1584 setenv splashpos m,m
1585 => image at center of screen
1586
1587 setenv splashpos 30,20
1588 => image at x = 30 and y = 20
1589
1590 setenv splashpos -10,m
1591 => vertically centered image
1592 at x = dspWidth - bmpWidth - 9
1593
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001594- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1595
1596 If this option is set, additionally to standard BMP
1597 images, gzipped BMP images can be displayed via the
1598 splashscreen support or the bmp command.
1599
Anatolij Gustschind5011762010-03-15 14:50:25 +01001600- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1601
1602 If this option is set, 8-bit RLE compressed BMP images
1603 can be displayed via the splashscreen support or the
1604 bmp command.
1605
wdenkc29fdfc2003-08-29 20:57:53 +00001606- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001607 CONFIG_GZIP
1608
1609 Enabled by default to support gzip compressed images.
1610
wdenkc29fdfc2003-08-29 20:57:53 +00001611 CONFIG_BZIP2
1612
1613 If this option is set, support for bzip2 compressed
1614 images is included. If not, only uncompressed and gzip
1615 compressed images are supported.
1616
wdenk42d1f032003-10-15 23:53:47 +00001617 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001618 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001619 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001620
wdenk17ea1172004-06-06 21:51:03 +00001621- MII/PHY support:
1622 CONFIG_PHY_ADDR
1623
1624 The address of PHY on MII bus.
1625
1626 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1627
1628 The clock frequency of the MII bus
1629
1630 CONFIG_PHY_GIGE
1631
1632 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001633 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001634
1635 CONFIG_PHY_RESET_DELAY
1636
1637 Some PHY like Intel LXT971A need extra delay after
1638 reset before any MII register access is possible.
1639 For such PHY, set this option to the usec delay
1640 required. (minimum 300usec for LXT971A)
1641
1642 CONFIG_PHY_CMD_DELAY (ppc4xx)
1643
1644 Some PHY like Intel LXT971A need extra delay after
1645 command issued before MII status register can be read
1646
wdenkc6097192002-11-03 00:24:07 +00001647- IP address:
1648 CONFIG_IPADDR
1649
1650 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001651 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001652 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001653 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001654
1655- Server IP address:
1656 CONFIG_SERVERIP
1657
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001658 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001659 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001660 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001661
Robin Getz97cfe862009-07-21 12:15:28 -04001662 CONFIG_KEEP_SERVERADDR
1663
1664 Keeps the server's MAC address, in the env 'serveraddr'
1665 for passing to bootargs (like Linux's netconsole option)
1666
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001667- Gateway IP address:
1668 CONFIG_GATEWAYIP
1669
1670 Defines a default value for the IP address of the
1671 default router where packets to other networks are
1672 sent to.
1673 (Environment variable "gatewayip")
1674
1675- Subnet mask:
1676 CONFIG_NETMASK
1677
1678 Defines a default value for the subnet mask (or
1679 routing prefix) which is used to determine if an IP
1680 address belongs to the local subnet or needs to be
1681 forwarded through a router.
1682 (Environment variable "netmask")
1683
David Updegraff53a5c422007-06-11 10:41:07 -05001684- Multicast TFTP Mode:
1685 CONFIG_MCAST_TFTP
1686
1687 Defines whether you want to support multicast TFTP as per
1688 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001689 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001690 driver in use must provide a function: mcast() to join/leave a
1691 multicast group.
1692
wdenkc6097192002-11-03 00:24:07 +00001693- BOOTP Recovery Mode:
1694 CONFIG_BOOTP_RANDOM_DELAY
1695
1696 If you have many targets in a network that try to
1697 boot using BOOTP, you may want to avoid that all
1698 systems send out BOOTP requests at precisely the same
1699 moment (which would happen for instance at recovery
1700 from a power failure, when all systems will try to
1701 boot, thus flooding the BOOTP server. Defining
1702 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1703 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001704 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001705
1706 1st BOOTP request: delay 0 ... 1 sec
1707 2nd BOOTP request: delay 0 ... 2 sec
1708 3rd BOOTP request: delay 0 ... 4 sec
1709 4th and following
1710 BOOTP requests: delay 0 ... 8 sec
1711
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001712 CONFIG_BOOTP_ID_CACHE_SIZE
1713
1714 BOOTP packets are uniquely identified using a 32-bit ID. The
1715 server will copy the ID from client requests to responses and
1716 U-Boot will use this to determine if it is the destination of
1717 an incoming response. Some servers will check that addresses
1718 aren't in use before handing them out (usually using an ARP
1719 ping) and therefore take up to a few hundred milliseconds to
1720 respond. Network congestion may also influence the time it
1721 takes for a response to make it back to the client. If that
1722 time is too long, U-Boot will retransmit requests. In order
1723 to allow earlier responses to still be accepted after these
1724 retransmissions, U-Boot's BOOTP client keeps a small cache of
1725 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1726 cache. The default is to keep IDs for up to four outstanding
1727 requests. Increasing this will allow U-Boot to accept offers
1728 from a BOOTP client in networks with unusually high latency.
1729
stroesefe389a82003-08-28 14:17:32 +00001730- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001731 You can fine tune the DHCP functionality by defining
1732 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001733
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001734 CONFIG_BOOTP_SUBNETMASK
1735 CONFIG_BOOTP_GATEWAY
1736 CONFIG_BOOTP_HOSTNAME
1737 CONFIG_BOOTP_NISDOMAIN
1738 CONFIG_BOOTP_BOOTPATH
1739 CONFIG_BOOTP_BOOTFILESIZE
1740 CONFIG_BOOTP_DNS
1741 CONFIG_BOOTP_DNS2
1742 CONFIG_BOOTP_SEND_HOSTNAME
1743 CONFIG_BOOTP_NTPSERVER
1744 CONFIG_BOOTP_TIMEOFFSET
1745 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001746 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001747
Wilson Callan5d110f02007-07-28 10:56:13 -04001748 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1749 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001750
Joe Hershberger2c00e092012-05-23 07:59:19 +00001751 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1752 after the configured retry count, the call will fail
1753 instead of starting over. This can be used to fail over
1754 to Link-local IP address configuration if the DHCP server
1755 is not available.
1756
stroesefe389a82003-08-28 14:17:32 +00001757 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1758 serverip from a DHCP server, it is possible that more
1759 than one DNS serverip is offered to the client.
1760 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1761 serverip will be stored in the additional environment
1762 variable "dnsip2". The first DNS serverip is always
1763 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001764 is defined.
stroesefe389a82003-08-28 14:17:32 +00001765
1766 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1767 to do a dynamic update of a DNS server. To do this, they
1768 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001769 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001770 of the "hostname" environment variable is passed as
1771 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001772
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001773 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1774
1775 A 32bit value in microseconds for a delay between
1776 receiving a "DHCP Offer" and sending the "DHCP Request".
1777 This fixes a problem with certain DHCP servers that don't
1778 respond 100% of the time to a "DHCP request". E.g. On an
1779 AT91RM9200 processor running at 180MHz, this delay needed
1780 to be *at least* 15,000 usec before a Windows Server 2003
1781 DHCP server would reply 100% of the time. I recommend at
1782 least 50,000 usec to be safe. The alternative is to hope
1783 that one of the retries will be successful but note that
1784 the DHCP timeout and retry process takes a longer than
1785 this delay.
1786
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001787 - Link-local IP address negotiation:
1788 Negotiate with other link-local clients on the local network
1789 for an address that doesn't require explicit configuration.
1790 This is especially useful if a DHCP server cannot be guaranteed
1791 to exist in all environments that the device must operate.
1792
1793 See doc/README.link-local for more information.
1794
wdenka3d991b2004-04-15 21:48:45 +00001795 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001796 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001797
1798 The device id used in CDP trigger frames.
1799
1800 CONFIG_CDP_DEVICE_ID_PREFIX
1801
1802 A two character string which is prefixed to the MAC address
1803 of the device.
1804
1805 CONFIG_CDP_PORT_ID
1806
1807 A printf format string which contains the ascii name of
1808 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001809 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001810
1811 CONFIG_CDP_CAPABILITIES
1812
1813 A 32bit integer which indicates the device capabilities;
1814 0x00000010 for a normal host which does not forwards.
1815
1816 CONFIG_CDP_VERSION
1817
1818 An ascii string containing the version of the software.
1819
1820 CONFIG_CDP_PLATFORM
1821
1822 An ascii string containing the name of the platform.
1823
1824 CONFIG_CDP_TRIGGER
1825
1826 A 32bit integer sent on the trigger.
1827
1828 CONFIG_CDP_POWER_CONSUMPTION
1829
1830 A 16bit integer containing the power consumption of the
1831 device in .1 of milliwatts.
1832
1833 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1834
1835 A byte containing the id of the VLAN.
1836
Uri Mashiach79267ed2017-01-19 10:51:05 +02001837- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001838
1839 Several configurations allow to display the current
1840 status using a LED. For instance, the LED will blink
1841 fast while running U-Boot code, stop blinking as
1842 soon as a reply to a BOOTP request was received, and
1843 start blinking slow once the Linux kernel is running
1844 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001845 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001846 feature in U-Boot.
1847
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001848 Additional options:
1849
Uri Mashiach79267ed2017-01-19 10:51:05 +02001850 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001851 The status LED can be connected to a GPIO pin.
1852 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001853 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001854 to include the gpio_led driver in the U-Boot binary.
1855
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001856 CONFIG_GPIO_LED_INVERTED_TABLE
1857 Some GPIO connected LEDs may have inverted polarity in which
1858 case the GPIO high value corresponds to LED off state and
1859 GPIO low value corresponds to LED on state.
1860 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1861 with a list of GPIO LEDs that have inverted polarity.
1862
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001863- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001864
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001865 This enable the NEW i2c subsystem, and will allow you to use
1866 i2c commands at the u-boot command line (as long as you set
1867 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1868 based realtime clock chips or other i2c devices. See
1869 common/cmd_i2c.c for a description of the command line
1870 interface.
1871
1872 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001873 - drivers/i2c/soft_i2c.c:
1874 - activate first bus with CONFIG_SYS_I2C_SOFT define
1875 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1876 for defining speed and slave address
1877 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1878 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1879 for defining speed and slave address
1880 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1881 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1882 for defining speed and slave address
1883 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1884 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1885 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001886
Heiko Schocher00f792e2012-10-24 13:48:22 +02001887 - drivers/i2c/fsl_i2c.c:
1888 - activate i2c driver with CONFIG_SYS_I2C_FSL
1889 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1890 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1891 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1892 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001893 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001894 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1895 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1896 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1897 second bus.
1898
Simon Glass1f2ba722012-10-30 07:28:53 +00001899 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001900 - activate this driver with CONFIG_SYS_I2C_TEGRA
1901 - This driver adds 4 i2c buses with a fix speed from
1902 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001903
Dirk Eibach880540d2013-04-25 02:40:01 +00001904 - drivers/i2c/ppc4xx_i2c.c
1905 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1906 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1907 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1908
tremfac96402013-09-21 18:13:35 +02001909 - drivers/i2c/i2c_mxc.c
1910 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001911 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1912 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1913 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1914 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001915 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1916 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1917 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1918 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1919 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1920 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001921 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1922 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001923 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001924 for speed, and 0 for slave.
1925
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001926 - drivers/i2c/rcar_i2c.c:
1927 - activate this driver with CONFIG_SYS_I2C_RCAR
1928 - This driver adds 4 i2c buses
1929
1930 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1931 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1932 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1933 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1934 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1935 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1936 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1937 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1938 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1939
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001940 - drivers/i2c/sh_i2c.c:
1941 - activate this driver with CONFIG_SYS_I2C_SH
1942 - This driver adds from 2 to 5 i2c buses
1943
1944 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1945 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1946 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1947 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1948 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1949 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1950 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1951 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1952 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1953 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001954 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001955
Heiko Schocher6789e842013-10-22 11:03:18 +02001956 - drivers/i2c/omap24xx_i2c.c
1957 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1958 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1959 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1960 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1961 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1962 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1963 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1964 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1965 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1966 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1967 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1968
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001969 - drivers/i2c/zynq_i2c.c
1970 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1971 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1972 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1973
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301974 - drivers/i2c/s3c24x0_i2c.c:
1975 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1976 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1977 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1978 with a fix speed from 100000 and the slave addr 0!
1979
Dirk Eibachb46226b2014-07-03 09:28:18 +02001980 - drivers/i2c/ihs_i2c.c
1981 - activate this driver with CONFIG_SYS_I2C_IHS
1982 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1983 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1984 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1985 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1986 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1987 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1988 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1989 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1990 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1991 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1992 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1993 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001994 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1995 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1996 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1997 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1998 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1999 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2000 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2001 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2002 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002003
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002004 additional defines:
2005
2006 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06002007 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002008
2009 CONFIG_SYS_I2C_DIRECT_BUS
2010 define this, if you don't use i2c muxes on your hardware.
2011 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2012 omit this define.
2013
2014 CONFIG_SYS_I2C_MAX_HOPS
2015 define how many muxes are maximal consecutively connected
2016 on one i2c bus. If you not use i2c muxes, omit this
2017 define.
2018
2019 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002020 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002021 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2022 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2023 CONFIG_SYS_NUM_I2C_BUSES = 9:
2024
2025 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2026 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2027 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2028 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2029 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2030 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2031 {1, {I2C_NULL_HOP}}, \
2032 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2033 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2034 }
2035
2036 which defines
2037 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002038 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2039 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2040 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2041 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2042 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002043 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002044 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2045 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002046
2047 If you do not have i2c muxes on your board, omit this define.
2048
Simon Glassce3b5d62017-05-12 21:10:00 -06002049- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01002050 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002051 then the following macros need to be defined (examples are
2052 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002053
2054 I2C_INIT
2055
wdenkb37c7e52003-06-30 16:24:52 +00002056 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002057 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002058
wdenkba56f622004-02-06 23:19:44 +00002059 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002060
wdenkc6097192002-11-03 00:24:07 +00002061 I2C_ACTIVE
2062
2063 The code necessary to make the I2C data line active
2064 (driven). If the data line is open collector, this
2065 define can be null.
2066
wdenkb37c7e52003-06-30 16:24:52 +00002067 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2068
wdenkc6097192002-11-03 00:24:07 +00002069 I2C_TRISTATE
2070
2071 The code necessary to make the I2C data line tri-stated
2072 (inactive). If the data line is open collector, this
2073 define can be null.
2074
wdenkb37c7e52003-06-30 16:24:52 +00002075 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2076
wdenkc6097192002-11-03 00:24:07 +00002077 I2C_READ
2078
York Sun472d5462013-04-01 11:29:11 -07002079 Code that returns true if the I2C data line is high,
2080 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002081
wdenkb37c7e52003-06-30 16:24:52 +00002082 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2083
wdenkc6097192002-11-03 00:24:07 +00002084 I2C_SDA(bit)
2085
York Sun472d5462013-04-01 11:29:11 -07002086 If <bit> is true, sets the I2C data line high. If it
2087 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002088
wdenkb37c7e52003-06-30 16:24:52 +00002089 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002090 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002091 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002092
wdenkc6097192002-11-03 00:24:07 +00002093 I2C_SCL(bit)
2094
York Sun472d5462013-04-01 11:29:11 -07002095 If <bit> is true, sets the I2C clock line high. If it
2096 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002097
wdenkb37c7e52003-06-30 16:24:52 +00002098 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002099 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002100 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002101
wdenkc6097192002-11-03 00:24:07 +00002102 I2C_DELAY
2103
2104 This delay is invoked four times per clock cycle so this
2105 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002106 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002107 like:
2108
wdenkb37c7e52003-06-30 16:24:52 +00002109 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002110
Mike Frysinger793b5722010-07-21 13:38:02 -04002111 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2112
2113 If your arch supports the generic GPIO framework (asm/gpio.h),
2114 then you may alternatively define the two GPIOs that are to be
2115 used as SCL / SDA. Any of the previous I2C_xxx macros will
2116 have GPIO-based defaults assigned to them as appropriate.
2117
2118 You should define these to the GPIO value as given directly to
2119 the generic GPIO functions.
2120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002121 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002122
wdenk8bde7f72003-06-27 21:31:46 +00002123 When a board is reset during an i2c bus transfer
2124 chips might think that the current transfer is still
2125 in progress. On some boards it is possible to access
2126 the i2c SCLK line directly, either by using the
2127 processor pin as a GPIO or by having a second pin
2128 connected to the bus. If this option is defined a
2129 custom i2c_init_board() routine in boards/xxx/board.c
2130 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002131
Ben Warrenbb99ad62006-09-07 16:50:54 -04002132 CONFIG_I2C_MULTI_BUS
2133
2134 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002135 must have a controller. At any point in time, only one bus is
2136 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002137 Note that bus numbering is zero-based.
2138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002139 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002140
2141 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002142 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002143 is set, specify a list of bus-device pairs. Otherwise, specify
2144 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002145
2146 e.g.
2147 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002148 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002149
2150 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2151
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002152 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002153 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002154
2155 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002157 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002158
2159 If defined, then this indicates the I2C bus number for DDR SPD.
2160 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2161
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002162 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002163
2164 If defined, then this indicates the I2C bus number for the RTC.
2165 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2166
Andrew Dyer2ac69852008-12-29 17:36:01 -06002167 CONFIG_SOFT_I2C_READ_REPEATED_START
2168
2169 defining this will force the i2c_read() function in
2170 the soft_i2c driver to perform an I2C repeated start
2171 between writing the address pointer and reading the
2172 data. If this define is omitted the default behaviour
2173 of doing a stop-start sequence will be used. Most I2C
2174 devices can use either method, but some require one or
2175 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002176
wdenkc6097192002-11-03 00:24:07 +00002177- SPI Support: CONFIG_SPI
2178
2179 Enables SPI driver (so far only tested with
2180 SPI EEPROM, also an instance works with Crystal A/D and
2181 D/As on the SACSng board)
2182
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002183 CONFIG_SH_SPI
2184
2185 Enables the driver for SPI controller on SuperH. Currently
2186 only SH7757 is supported.
2187
wdenkc6097192002-11-03 00:24:07 +00002188 CONFIG_SOFT_SPI
2189
wdenk43d96162003-03-06 00:02:04 +00002190 Enables a software (bit-bang) SPI driver rather than
2191 using hardware support. This is a general purpose
2192 driver that only requires three general I/O port pins
2193 (two outputs, one input) to function. If this is
2194 defined, the board configuration must define several
2195 SPI configuration items (port pins to use, etc). For
2196 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002197
Ben Warren04a9e112008-01-16 22:37:35 -05002198 CONFIG_HARD_SPI
2199
2200 Enables a hardware SPI driver for general-purpose reads
2201 and writes. As with CONFIG_SOFT_SPI, the board configuration
2202 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002203 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002204 example, see include/configs/mpc8349emds.h.
2205
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002206 CONFIG_MXC_SPI
2207
2208 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002209 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002210
Heiko Schocherf659b572014-07-14 10:22:11 +02002211 CONFIG_SYS_SPI_MXC_WAIT
2212 Timeout for waiting until spi transfer completed.
2213 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2214
Matthias Fuchs01335022007-12-27 17:12:34 +01002215- FPGA Support: CONFIG_FPGA
2216
2217 Enables FPGA subsystem.
2218
2219 CONFIG_FPGA_<vendor>
2220
2221 Enables support for specific chip vendors.
2222 (ALTERA, XILINX)
2223
2224 CONFIG_FPGA_<family>
2225
2226 Enables support for FPGA family.
2227 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2228
2229 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002230
wdenk43d96162003-03-06 00:02:04 +00002231 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002232
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002233 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002234
wdenk8bde7f72003-06-27 21:31:46 +00002235 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002237 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk43d96162003-03-06 00:02:04 +00002239 Enable checks on FPGA configuration interface busy
2240 status by the configuration function. This option
2241 will require a board or device specific function to
2242 be written.
wdenkc6097192002-11-03 00:24:07 +00002243
2244 CONFIG_FPGA_DELAY
2245
2246 If defined, a function that provides delays in the FPGA
2247 configuration driver.
2248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002249 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002250 Allow Control-C to interrupt FPGA configuration
2251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002252 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002253
wdenk43d96162003-03-06 00:02:04 +00002254 Check for configuration errors during FPGA bitfile
2255 loading. For example, abort during Virtex II
2256 configuration if the INIT_B line goes low (which
2257 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002259 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002260
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002261 Maximum time to wait for the INIT_B line to de-assert
2262 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002263 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002264 ms.
wdenkc6097192002-11-03 00:24:07 +00002265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002266 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002267
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002268 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002269 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002272
wdenk43d96162003-03-06 00:02:04 +00002273 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002274 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002275
2276- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002277 CONFIG_BUILD_TARGET
2278
2279 Some SoCs need special image types (e.g. U-Boot binary
2280 with a special header) as build targets. By defining
2281 CONFIG_BUILD_TARGET in the SoC / board header, this
2282 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002283 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002284
wdenkc6097192002-11-03 00:24:07 +00002285 CONFIG_IDENT_STRING
2286
wdenk43d96162003-03-06 00:02:04 +00002287 If defined, this string will be added to the U-Boot
2288 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002289
2290- Vendor Parameter Protection:
2291
wdenk43d96162003-03-06 00:02:04 +00002292 U-Boot considers the values of the environment
2293 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002294 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002295 are set once by the board vendor / manufacturer, and
2296 protects these variables from casual modification by
2297 the user. Once set, these variables are read-only,
2298 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002299 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002300
2301 If CONFIG_ENV_OVERWRITE is #defined in your config
2302 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002303 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002304 these parameters.
2305
Joe Hershberger92ac5202015-05-04 14:55:14 -05002306 Alternatively, if you define _both_ an ethaddr in the
2307 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002308 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002309 which can be changed exactly ONCE by the user. [The
2310 serial# is unaffected by this, i. e. it remains
2311 read-only.]
2312
Joe Hershberger25980902012-12-11 22:16:31 -06002313 The same can be accomplished in a more flexible way
2314 for any variable by configuring the type of access
2315 to allow for those variables in the ".flags" variable
2316 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2317
wdenkc6097192002-11-03 00:24:07 +00002318- Protected RAM:
2319 CONFIG_PRAM
2320
2321 Define this variable to enable the reservation of
2322 "protected RAM", i. e. RAM which is not overwritten
2323 by U-Boot. Define CONFIG_PRAM to hold the number of
2324 kB you want to reserve for pRAM. You can overwrite
2325 this default value by defining an environment
2326 variable "pram" to the number of kB you want to
2327 reserve. Note that the board info structure will
2328 still show the full amount of RAM. If pRAM is
2329 reserved, a new environment variable "mem" will
2330 automatically be defined to hold the amount of
2331 remaining RAM in a form that can be passed as boot
2332 argument to Linux, for instance like that:
2333
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002334 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002335 saveenv
2336
2337 This way you can tell Linux not to use this memory,
2338 either, which results in a memory region that will
2339 not be affected by reboots.
2340
2341 *WARNING* If your board configuration uses automatic
2342 detection of the RAM size, you must make sure that
2343 this memory test is non-destructive. So far, the
2344 following board configurations are known to be
2345 "pRAM-clean":
2346
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002347 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002348 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002349 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002350
Gabe Black40fef042012-12-02 04:55:18 +00002351- Access to physical memory region (> 4GB)
2352 Some basic support is provided for operations on memory not
2353 normally accessible to U-Boot - e.g. some architectures
2354 support access to more than 4GB of memory on 32-bit
2355 machines using physical address extension or similar.
2356 Define CONFIG_PHYSMEM to access this basic support, which
2357 currently only supports clearing the memory.
2358
wdenkc6097192002-11-03 00:24:07 +00002359- Error Recovery:
2360 CONFIG_PANIC_HANG
2361
2362 Define this variable to stop the system in case of a
2363 fatal error, so that you have to reset it manually.
2364 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002365 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002366 automatically as fast as possible, but it may be
2367 useful during development since you can try to debug
2368 the conditions that lead to the situation.
2369
2370 CONFIG_NET_RETRY_COUNT
2371
wdenk43d96162003-03-06 00:02:04 +00002372 This variable defines the number of retries for
2373 network operations like ARP, RARP, TFTP, or BOOTP
2374 before giving up the operation. If not defined, a
2375 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002376
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002377 CONFIG_ARP_TIMEOUT
2378
2379 Timeout waiting for an ARP reply in milliseconds.
2380
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002381 CONFIG_NFS_TIMEOUT
2382
2383 Timeout in milliseconds used in NFS protocol.
2384 If you encounter "ERROR: Cannot umount" in nfs command,
2385 try longer timeout such as
2386 #define CONFIG_NFS_TIMEOUT 10000UL
2387
wdenkc6097192002-11-03 00:24:07 +00002388- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002389 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002390
2391 Enable auto completion of commands using TAB.
2392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002394
2395 This defines the secondary prompt string, which is
2396 printed when the command interpreter needs more input
2397 to complete a command. Usually "> ".
2398
2399 Note:
2400
wdenk8bde7f72003-06-27 21:31:46 +00002401 In the current implementation, the local variables
2402 space and global environment variables space are
2403 separated. Local variables are those you define by
2404 simply typing `name=value'. To access a local
2405 variable later on, you have write `$name' or
2406 `${name}'; to execute the contents of a variable
2407 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002408
wdenk43d96162003-03-06 00:02:04 +00002409 Global environment variables are those you use
2410 setenv/printenv to work with. To run a command stored
2411 in such a variable, you need to use the run command,
2412 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002413
2414 To store commands and special characters in a
2415 variable, please use double quotation marks
2416 surrounding the whole text of the variable, instead
2417 of the backslashes before semicolons and special
2418 symbols.
2419
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002420- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002421 CONFIG_CMDLINE_EDITING
2422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002423 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002424 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002425
Marek Vasutf3b267b2016-01-27 04:47:55 +01002426- Command Line PS1/PS2 support:
2427 CONFIG_CMDLINE_PS_SUPPORT
2428
2429 Enable support for changing the command prompt string
2430 at run-time. Only static string is supported so far.
2431 The string is obtained from environment variables PS1
2432 and PS2.
2433
wdenka8c7c702003-12-06 19:49:23 +00002434- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002435 CONFIG_EXTRA_ENV_SETTINGS
2436
wdenk43d96162003-03-06 00:02:04 +00002437 Define this to contain any number of null terminated
2438 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002439 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002440
wdenk43d96162003-03-06 00:02:04 +00002441 For example, place something like this in your
2442 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002443
2444 #define CONFIG_EXTRA_ENV_SETTINGS \
2445 "myvar1=value1\0" \
2446 "myvar2=value2\0"
2447
wdenk43d96162003-03-06 00:02:04 +00002448 Warning: This method is based on knowledge about the
2449 internal format how the environment is stored by the
2450 U-Boot code. This is NOT an official, exported
2451 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002452 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002453 You better know what you are doing here.
2454
wdenk43d96162003-03-06 00:02:04 +00002455 Note: overly (ab)use of the default environment is
2456 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002457 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002458 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002459
Stephen Warren5e724ca2012-05-22 09:21:54 +00002460 CONFIG_ENV_VARS_UBOOT_CONFIG
2461
2462 Define this in order to add variables describing the
2463 U-Boot build configuration to the default environment.
2464 These will be named arch, cpu, board, vendor, and soc.
2465
2466 Enabling this option will cause the following to be defined:
2467
2468 - CONFIG_SYS_ARCH
2469 - CONFIG_SYS_CPU
2470 - CONFIG_SYS_BOARD
2471 - CONFIG_SYS_VENDOR
2472 - CONFIG_SYS_SOC
2473
Tom Rini7e27f892012-10-24 07:28:16 +00002474 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2475
2476 Define this in order to add variables describing certain
2477 run-time determined information about the hardware to the
2478 environment. These will be named board_name, board_rev.
2479
Simon Glass06fd8532012-11-30 13:01:17 +00002480 CONFIG_DELAY_ENVIRONMENT
2481
2482 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002483 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002484 that so that the environment is not available until
2485 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2486 this is instead controlled by the value of
2487 /config/load-environment.
2488
wdenka8c7c702003-12-06 19:49:23 +00002489- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002490 CONFIG_HAS_DATAFLASH
2491
wdenk8bde7f72003-06-27 21:31:46 +00002492 Defining this option enables DataFlash features and
2493 allows to read/write in Dataflash via the standard
2494 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002495
Eric Nelsonf61ec452012-01-31 10:52:08 -07002496- Serial Flash support
2497 CONFIG_CMD_SF
2498
2499 Defining this option enables SPI flash commands
2500 'sf probe/read/write/erase/update'.
2501
2502 Usage requires an initial 'probe' to define the serial
2503 flash parameters, followed by read/write/erase/update
2504 commands.
2505
2506 The following defaults may be provided by the platform
2507 to handle the common case when only a single serial
2508 flash is present on the system.
2509
2510 CONFIG_SF_DEFAULT_BUS Bus identifier
2511 CONFIG_SF_DEFAULT_CS Chip-select
2512 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2513 CONFIG_SF_DEFAULT_SPEED in Hz
2514
Simon Glass24007272012-10-08 13:16:02 +00002515 CONFIG_CMD_SF_TEST
2516
2517 Define this option to include a destructive SPI flash
2518 test ('sf test').
2519
wdenk3f85ce22004-02-23 16:11:30 +00002520- SystemACE Support:
2521 CONFIG_SYSTEMACE
2522
2523 Adding this option adds support for Xilinx SystemACE
2524 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002525 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002526 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002527
2528 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002529 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002530
2531 When SystemACE support is added, the "ace" device type
2532 becomes available to the fat commands, i.e. fatls.
2533
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002534- TFTP Fixed UDP Port:
2535 CONFIG_TFTP_PORT
2536
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002537 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002538 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002539 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002540 number generator is used.
2541
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002542 Also, the environment variable tftpdstp is used to supply
2543 the TFTP UDP destination port value. If tftpdstp isn't
2544 defined, the normal port 69 is used.
2545
2546 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002547 blindly start the TFTP transfer using the pre-configured
2548 target IP address and UDP port. This has the effect of
2549 "punching through" the (Windows XP) firewall, allowing
2550 the remainder of the TFTP transfer to proceed normally.
2551 A better solution is to properly configure the firewall,
2552 but sometimes that is not allowed.
2553
Heiko Schocher9e50c402014-01-25 07:27:13 +01002554- bootcount support:
2555 CONFIG_BOOTCOUNT_LIMIT
2556
2557 This enables the bootcounter support, see:
2558 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2559
2560 CONFIG_AT91SAM9XE
2561 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002562 CONFIG_SOC_DA8XX
2563 enable special bootcounter support on da850 based boards.
2564 CONFIG_BOOTCOUNT_RAM
2565 enable support for the bootcounter in RAM
2566 CONFIG_BOOTCOUNT_I2C
2567 enable support for the bootcounter on an i2c (like RTC) device.
2568 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2569 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2570 the bootcounter.
2571 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002572
wdenka8c7c702003-12-06 19:49:23 +00002573- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002574 CONFIG_SHOW_BOOT_PROGRESS
2575
wdenk43d96162003-03-06 00:02:04 +00002576 Defining this option allows to add some board-
2577 specific code (calling a user-provided function
2578 "show_boot_progress(int)") that enables you to show
2579 the system's boot progress on some display (for
2580 example, some LED's) on your board. At the moment,
2581 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002582
Simon Glass94fd1312012-09-28 08:56:37 +00002583
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002584Legacy uImage format:
2585
wdenkc6097192002-11-03 00:24:07 +00002586 Arg Where When
2587 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002588 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002589 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002590 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002591 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002592 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002593 4 common/cmd_bootm.c Image data has correct checksum
2594 -4 common/cmd_bootm.c Image is for unsupported architecture
2595 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002596 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002597 6 common/cmd_bootm.c Image Type check OK
2598 -6 common/cmd_bootm.c gunzip uncompression error
2599 -7 common/cmd_bootm.c Unimplemented compression type
2600 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002601 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002602 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002603
2604 9 common/image.c Start initial ramdisk verification
2605 -10 common/image.c Ramdisk header has bad magic number
2606 -11 common/image.c Ramdisk header has bad checksum
2607 10 common/image.c Ramdisk header is OK
2608 -12 common/image.c Ramdisk data has bad checksum
2609 11 common/image.c Ramdisk data has correct checksum
2610 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002611 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002612 13 common/image.c Start multifile image verification
2613 14 common/image.c No initial ramdisk, no multifile, continue.
2614
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002615 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002616
Stefan Roesea47a12b2010-04-15 16:07:28 +02002617 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002618 -31 post/post.c POST test failed, detected by post_output_backlog()
2619 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002620
Heiko Schocher566a4942007-06-22 19:11:54 +02002621 34 common/cmd_doc.c before loading a Image from a DOC device
2622 -35 common/cmd_doc.c Bad usage of "doc" command
2623 35 common/cmd_doc.c correct usage of "doc" command
2624 -36 common/cmd_doc.c No boot device
2625 36 common/cmd_doc.c correct boot device
2626 -37 common/cmd_doc.c Unknown Chip ID on boot device
2627 37 common/cmd_doc.c correct chip ID found, device available
2628 -38 common/cmd_doc.c Read Error on boot device
2629 38 common/cmd_doc.c reading Image header from DOC device OK
2630 -39 common/cmd_doc.c Image header has bad magic number
2631 39 common/cmd_doc.c Image header has correct magic number
2632 -40 common/cmd_doc.c Error reading Image from DOC device
2633 40 common/cmd_doc.c Image header has correct magic number
2634 41 common/cmd_ide.c before loading a Image from a IDE device
2635 -42 common/cmd_ide.c Bad usage of "ide" command
2636 42 common/cmd_ide.c correct usage of "ide" command
2637 -43 common/cmd_ide.c No boot device
2638 43 common/cmd_ide.c boot device found
2639 -44 common/cmd_ide.c Device not available
2640 44 common/cmd_ide.c Device available
2641 -45 common/cmd_ide.c wrong partition selected
2642 45 common/cmd_ide.c partition selected
2643 -46 common/cmd_ide.c Unknown partition table
2644 46 common/cmd_ide.c valid partition table found
2645 -47 common/cmd_ide.c Invalid partition type
2646 47 common/cmd_ide.c correct partition type
2647 -48 common/cmd_ide.c Error reading Image Header on boot device
2648 48 common/cmd_ide.c reading Image Header from IDE device OK
2649 -49 common/cmd_ide.c Image header has bad magic number
2650 49 common/cmd_ide.c Image header has correct magic number
2651 -50 common/cmd_ide.c Image header has bad checksum
2652 50 common/cmd_ide.c Image header has correct checksum
2653 -51 common/cmd_ide.c Error reading Image from IDE device
2654 51 common/cmd_ide.c reading Image from IDE device OK
2655 52 common/cmd_nand.c before loading a Image from a NAND device
2656 -53 common/cmd_nand.c Bad usage of "nand" command
2657 53 common/cmd_nand.c correct usage of "nand" command
2658 -54 common/cmd_nand.c No boot device
2659 54 common/cmd_nand.c boot device found
2660 -55 common/cmd_nand.c Unknown Chip ID on boot device
2661 55 common/cmd_nand.c correct chip ID found, device available
2662 -56 common/cmd_nand.c Error reading Image Header on boot device
2663 56 common/cmd_nand.c reading Image Header from NAND device OK
2664 -57 common/cmd_nand.c Image header has bad magic number
2665 57 common/cmd_nand.c Image header has correct magic number
2666 -58 common/cmd_nand.c Error reading Image from NAND device
2667 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002668
Heiko Schocher566a4942007-06-22 19:11:54 +02002669 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002670
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002671 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002672 -64 net/eth.c no Ethernet found.
2673 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002674
Heiko Schocher566a4942007-06-22 19:11:54 +02002675 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002676 80 common/cmd_net.c before calling net_loop()
2677 -81 common/cmd_net.c some error in net_loop() occurred
2678 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002679 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2680 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002681 83 common/cmd_net.c running "source" command
2682 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002683 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002684
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002685FIT uImage format:
2686
2687 Arg Where When
2688 100 common/cmd_bootm.c Kernel FIT Image has correct format
2689 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2690 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2691 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2692 102 common/cmd_bootm.c Kernel unit name specified
2693 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002694 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002695 104 common/cmd_bootm.c Got kernel subimage node offset
2696 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2697 105 common/cmd_bootm.c Kernel subimage hash verification OK
2698 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2699 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002700 -106 common/cmd_bootm.c Kernel subimage has wrong type
2701 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002702 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2703 108 common/cmd_bootm.c Got kernel subimage data/size
2704 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2705 -109 common/cmd_bootm.c Can't get kernel subimage type
2706 -110 common/cmd_bootm.c Can't get kernel subimage comp
2707 -111 common/cmd_bootm.c Can't get kernel subimage os
2708 -112 common/cmd_bootm.c Can't get kernel subimage load address
2709 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2710
2711 120 common/image.c Start initial ramdisk verification
2712 -120 common/image.c Ramdisk FIT image has incorrect format
2713 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002714 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002715 -122 common/image.c Can't get configuration for ramdisk subimage
2716 123 common/image.c Ramdisk unit name specified
2717 -124 common/image.c Can't get ramdisk subimage node offset
2718 125 common/image.c Got ramdisk subimage node offset
2719 -125 common/image.c Ramdisk subimage hash verification failed
2720 126 common/image.c Ramdisk subimage hash verification OK
2721 -126 common/image.c Ramdisk subimage for unsupported architecture
2722 127 common/image.c Architecture check OK
2723 -127 common/image.c Can't get ramdisk subimage data/size
2724 128 common/image.c Got ramdisk subimage data/size
2725 129 common/image.c Can't get ramdisk load address
2726 -129 common/image.c Got ramdisk load address
2727
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002728 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002729 131 common/cmd_doc.c FIT image format OK
2730
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002731 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002732 141 common/cmd_ide.c FIT image format OK
2733
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002734 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002735 151 common/cmd_nand.c FIT image format OK
2736
Heiko Schocher21d29f72014-05-28 11:33:33 +02002737- legacy image format:
2738 CONFIG_IMAGE_FORMAT_LEGACY
2739 enables the legacy image format support in U-Boot.
2740
2741 Default:
2742 enabled if CONFIG_FIT_SIGNATURE is not defined.
2743
2744 CONFIG_DISABLE_IMAGE_LEGACY
2745 disable the legacy image format
2746
2747 This define is introduced, as the legacy image format is
2748 enabled per default for backward compatibility.
2749
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002750- Standalone program support:
2751 CONFIG_STANDALONE_LOAD_ADDR
2752
Wolfgang Denk6feff892011-10-09 21:06:34 +02002753 This option defines a board specific value for the
2754 address where standalone program gets loaded, thus
2755 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002756 settings.
2757
2758- Frame Buffer Address:
2759 CONFIG_FB_ADDR
2760
2761 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002762 address for frame buffer. This is typically the case
2763 when using a graphics controller has separate video
2764 memory. U-Boot will then place the frame buffer at
2765 the given address instead of dynamically reserving it
2766 in system RAM by calling lcd_setmem(), which grabs
2767 the memory for the frame buffer depending on the
2768 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002769
2770 Please see board_init_f function.
2771
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002772- Automatic software updates via TFTP server
2773 CONFIG_UPDATE_TFTP
2774 CONFIG_UPDATE_TFTP_CNT_MAX
2775 CONFIG_UPDATE_TFTP_MSEC_MAX
2776
2777 These options enable and control the auto-update feature;
2778 for a more detailed description refer to doc/README.update.
2779
2780- MTD Support (mtdparts command, UBI support)
2781 CONFIG_MTD_DEVICE
2782
2783 Adds the MTD device infrastructure from the Linux kernel.
2784 Needed for mtdparts command support.
2785
2786 CONFIG_MTD_PARTITIONS
2787
2788 Adds the MTD partitioning infrastructure from the Linux
2789 kernel. Needed for UBI support.
2790
Joe Hershberger70c219c2013-04-08 10:32:48 +00002791- UBI support
Joe Hershberger147162d2013-04-08 10:32:49 +00002792 CONFIG_UBI_SILENCE_MSG
2793
2794 Make the verbose messages from UBI stop printing. This leaves
2795 warnings and errors enabled.
2796
Heiko Schocherff94bc42014-06-24 10:10:04 +02002797
2798 CONFIG_MTD_UBI_WL_THRESHOLD
2799 This parameter defines the maximum difference between the highest
2800 erase counter value and the lowest erase counter value of eraseblocks
2801 of UBI devices. When this threshold is exceeded, UBI starts performing
2802 wear leveling by means of moving data from eraseblock with low erase
2803 counter to eraseblocks with high erase counter.
2804
2805 The default value should be OK for SLC NAND flashes, NOR flashes and
2806 other flashes which have eraseblock life-cycle 100000 or more.
2807 However, in case of MLC NAND flashes which typically have eraseblock
2808 life-cycle less than 10000, the threshold should be lessened (e.g.,
2809 to 128 or 256, although it does not have to be power of 2).
2810
2811 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002812
Heiko Schocherff94bc42014-06-24 10:10:04 +02002813 CONFIG_MTD_UBI_BEB_LIMIT
2814 This option specifies the maximum bad physical eraseblocks UBI
2815 expects on the MTD device (per 1024 eraseblocks). If the
2816 underlying flash does not admit of bad eraseblocks (e.g. NOR
2817 flash), this value is ignored.
2818
2819 NAND datasheets often specify the minimum and maximum NVM
2820 (Number of Valid Blocks) for the flashes' endurance lifetime.
2821 The maximum expected bad eraseblocks per 1024 eraseblocks
2822 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2823 which gives 20 for most NANDs (MaxNVB is basically the total
2824 count of eraseblocks on the chip).
2825
2826 To put it differently, if this value is 20, UBI will try to
2827 reserve about 1.9% of physical eraseblocks for bad blocks
2828 handling. And that will be 1.9% of eraseblocks on the entire
2829 NAND chip, not just the MTD partition UBI attaches. This means
2830 that if you have, say, a NAND flash chip admits maximum 40 bad
2831 eraseblocks, and it is split on two MTD partitions of the same
2832 size, UBI will reserve 40 eraseblocks when attaching a
2833 partition.
2834
2835 default: 20
2836
2837 CONFIG_MTD_UBI_FASTMAP
2838 Fastmap is a mechanism which allows attaching an UBI device
2839 in nearly constant time. Instead of scanning the whole MTD device it
2840 only has to locate a checkpoint (called fastmap) on the device.
2841 The on-flash fastmap contains all information needed to attach
2842 the device. Using fastmap makes only sense on large devices where
2843 attaching by scanning takes long. UBI will not automatically install
2844 a fastmap on old images, but you can set the UBI parameter
2845 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2846 that fastmap-enabled images are still usable with UBI implementations
2847 without fastmap support. On typical flash devices the whole fastmap
2848 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2849
2850 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2851 Set this parameter to enable fastmap automatically on images
2852 without a fastmap.
2853 default: 0
2854
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002855 CONFIG_MTD_UBI_FM_DEBUG
2856 Enable UBI fastmap debug
2857 default: 0
2858
Joe Hershberger70c219c2013-04-08 10:32:48 +00002859- UBIFS support
Joe Hershberger147162d2013-04-08 10:32:49 +00002860 CONFIG_UBIFS_SILENCE_MSG
2861
2862 Make the verbose messages from UBIFS stop printing. This leaves
2863 warnings and errors enabled.
2864
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002865- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002866 CONFIG_SPL
2867 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002868
Tom Rini95579792012-02-14 07:29:40 +00002869 CONFIG_SPL_LDSCRIPT
2870 LDSCRIPT for linking the SPL binary.
2871
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002872 CONFIG_SPL_MAX_FOOTPRINT
2873 Maximum size in memory allocated to the SPL, BSS included.
2874 When defined, the linker checks that the actual memory
2875 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002876 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002877 must not be both defined at the same time.
2878
Tom Rini95579792012-02-14 07:29:40 +00002879 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002880 Maximum size of the SPL image (text, data, rodata, and
2881 linker lists sections), BSS excluded.
2882 When defined, the linker checks that the actual size does
2883 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002884
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002885 CONFIG_SPL_TEXT_BASE
2886 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002887
Scott Wood94a45bb2012-09-20 19:05:12 -05002888 CONFIG_SPL_RELOC_TEXT_BASE
2889 Address to relocate to. If unspecified, this is equal to
2890 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2891
Tom Rini95579792012-02-14 07:29:40 +00002892 CONFIG_SPL_BSS_START_ADDR
2893 Link address for the BSS within the SPL binary.
2894
2895 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002896 Maximum size in memory allocated to the SPL BSS.
2897 When defined, the linker checks that the actual memory used
2898 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002899 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002900 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002901
2902 CONFIG_SPL_STACK
2903 Adress of the start of the stack SPL will use
2904
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002905 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2906 When defined, SPL will panic() if the image it has
2907 loaded does not have a signature.
2908 Defining this is useful when code which loads images
2909 in SPL cannot guarantee that absolutely all read errors
2910 will be caught.
2911 An example is the LPC32XX MLC NAND driver, which will
2912 consider that a completely unreadable NAND block is bad,
2913 and thus should be skipped silently.
2914
Scott Wood94a45bb2012-09-20 19:05:12 -05002915 CONFIG_SPL_RELOC_STACK
2916 Adress of the start of the stack SPL will use after
2917 relocation. If unspecified, this is equal to
2918 CONFIG_SPL_STACK.
2919
Tom Rini95579792012-02-14 07:29:40 +00002920 CONFIG_SYS_SPL_MALLOC_START
2921 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002922 When this option is set the full malloc is used in SPL and
2923 it is set up by spl_init() and before that, the simple malloc()
2924 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002925
2926 CONFIG_SYS_SPL_MALLOC_SIZE
2927 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002928
Tom Rini47f7bca2012-08-13 12:03:19 -07002929 CONFIG_SPL_FRAMEWORK
2930 Enable the SPL framework under common/. This framework
2931 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2932 NAND loading of the Linux Kernel.
2933
Tom Rini9607faf2014-03-28 12:03:39 -04002934 CONFIG_SPL_OS_BOOT
2935 Enable booting directly to an OS from SPL.
2936 See also: doc/README.falcon
2937
Tom Rini861a86f2012-08-13 11:37:56 -07002938 CONFIG_SPL_DISPLAY_PRINT
2939 For ARM, enable an optional function to print more information
2940 about the running system.
2941
Scott Wood4b919722012-09-20 16:35:21 -05002942 CONFIG_SPL_INIT_MINIMAL
2943 Arch init code should be built for a very small image
2944
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002945 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2946 Partition on the MMC to load U-Boot from when the MMC is being
2947 used in raw mode
2948
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002949 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2950 Sector to load kernel uImage from when MMC is being
2951 used in raw mode (for Falcon mode)
2952
2953 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2954 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2955 Sector and number of sectors to load kernel argument
2956 parameters from when MMC is being used in raw mode
2957 (for falcon mode)
2958
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002959 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2960 Partition on the MMC to load U-Boot from when the MMC is being
2961 used in fs mode
2962
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002963 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2964 Filename to read to load U-Boot when reading from filesystem
2965
2966 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002967 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002968 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002969
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002970 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002971 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002972 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002973
Scott Wood06f60ae2012-12-06 13:33:17 +00002974 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2975 Set this for NAND SPL on PPC mpc83xx targets, so that
2976 start.S waits for the rest of the SPL to load before
2977 continuing (the hardware starts execution after just
2978 loading the first page rather than the full 4K).
2979
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302980 CONFIG_SPL_SKIP_RELOCATE
2981 Avoid SPL relocation
2982
Scott Wood6f2f01b2012-09-20 19:09:07 -05002983 CONFIG_SPL_NAND_BASE
2984 Include nand_base.c in the SPL. Requires
2985 CONFIG_SPL_NAND_DRIVERS.
2986
2987 CONFIG_SPL_NAND_DRIVERS
2988 SPL uses normal NAND drivers, not minimal drivers.
2989
2990 CONFIG_SPL_NAND_ECC
2991 Include standard software ECC in the SPL
2992
Tom Rini95579792012-02-14 07:29:40 +00002993 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002994 Support for NAND boot using simple NAND drivers that
2995 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002996
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002997 CONFIG_SPL_UBI
2998 Support for a lightweight UBI (fastmap) scanner and
2999 loader
3000
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003001 CONFIG_SPL_NAND_RAW_ONLY
3002 Support to boot only raw u-boot.bin images. Use this only
3003 if you need to save space.
3004
Ying Zhang7c8eea52013-08-16 15:16:12 +08003005 CONFIG_SPL_COMMON_INIT_DDR
3006 Set for common ddr init with serial presence detect in
3007 SPL binary.
3008
Tom Rini95579792012-02-14 07:29:40 +00003009 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3010 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3011 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3012 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3013 CONFIG_SYS_NAND_ECCBYTES
3014 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003015 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003016
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303017 CONFIG_SPL_NAND_BOOT
3018 Add support NAND boot
3019
Tom Rini95579792012-02-14 07:29:40 +00003020 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003021 Location in NAND to read U-Boot from
3022
3023 CONFIG_SYS_NAND_U_BOOT_DST
3024 Location in memory to load U-Boot to
3025
3026 CONFIG_SYS_NAND_U_BOOT_SIZE
3027 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003028
3029 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003030 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003031
3032 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3033 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003034 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003035
3036 CONFIG_SPL_OMAP3_ID_NAND
3037 Support for an OMAP3-specific set of functions to return the
3038 ID and MFR of the first attached NAND chip, if present.
3039
Pavel Machekc57b9532012-08-30 22:42:11 +02003040 CONFIG_SPL_RAM_DEVICE
3041 Support for running image already present in ram, in SPL binary
3042
Scott Wood74752ba2012-12-06 13:33:16 +00003043 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003044 Image offset to which the SPL should be padded before appending
3045 the SPL payload. By default, this is defined as
3046 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3047 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3048 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003049
Scott Woodca2fca22012-09-21 16:27:32 -05003050 CONFIG_SPL_TARGET
3051 Final target image containing SPL and payload. Some SPLs
3052 use an arch-specific makefile fragment instead, for
3053 example if more than one image needs to be produced.
3054
Simon Glass87ebee32013-05-08 08:05:59 +00003055 CONFIG_FIT_SPL_PRINT
3056 Printing information about a FIT image adds quite a bit of
3057 code to SPL. So this is normally disabled in SPL. Use this
3058 option to re-enable it. This will affect the output of the
3059 bootm command when booting a FIT image.
3060
Ying Zhang3aa29de2013-08-16 15:16:15 +08003061- TPL framework
3062 CONFIG_TPL
3063 Enable building of TPL globally.
3064
3065 CONFIG_TPL_PAD_TO
3066 Image offset to which the TPL should be padded before appending
3067 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003068 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3069 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3070 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003071
wdenka8c7c702003-12-06 19:49:23 +00003072- Interrupt support (PPC):
3073
wdenkd4ca31c2004-01-02 14:00:00 +00003074 There are common interrupt_init() and timer_interrupt()
3075 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003076 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003077 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003078 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003079 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003080 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003081 specific handling. If board has watchdog / status_led
3082 / other_activity_monitor it works automatically from
3083 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003084
wdenkc6097192002-11-03 00:24:07 +00003085
Helmut Raiger9660e442011-10-20 04:19:47 +00003086Board initialization settings:
3087------------------------------
3088
3089During Initialization u-boot calls a number of board specific functions
3090to allow the preparation of board specific prerequisites, e.g. pin setup
3091before drivers are initialized. To enable these callbacks the
3092following configuration macros have to be defined. Currently this is
3093architecture specific, so please check arch/your_architecture/lib/board.c
3094typically in board_init_f() and board_init_r().
3095
3096- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3097- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3098- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3099- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003100
wdenkc6097192002-11-03 00:24:07 +00003101Configuration Settings:
3102-----------------------
3103
York Sun4d1fd7f2014-02-26 17:03:19 -08003104- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3105 Optionally it can be defined to support 64-bit memory commands.
3106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003107- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003108 undefine this when you're short of memory.
3109
Peter Tyser2fb26042009-01-27 18:03:12 -06003110- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3111 width of the commands listed in the 'help' command output.
3112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003113- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003114 prompt for user input.
3115
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003116- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003118- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003119
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003120- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003122- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003123 the application (usually a Linux kernel) when it is
3124 booted
3125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003126- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003127 List of legal baudrate settings for this board.
3128
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003129- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003130 Begin and End addresses of the area used by the
3131 simple memory test.
3132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003133- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003134 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003136- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003137 Scratch address used by the alternate memory test
3138 You only need to set this if address zero isn't writeable
3139
York Sune8149522015-12-04 11:57:07 -08003140- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003141 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003142 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3143 is substracted from total RAM and won't be reported to OS.
3144 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003145 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003146 the RAM base is not zero, or RAM is divided into banks,
3147 this variable needs to be recalcuated to get the address.
3148
York Sunaabd7dd2015-12-07 11:05:29 -08003149- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003150 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003151 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003152 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003153 fixing up gd->ram_size the Linux kernel should gets passed
3154 the now "corrected" memory size and won't touch it either.
3155 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003156 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003157 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003158 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003159
3160 This option can be used as a workaround for the 440EPx/GRx
3161 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3162 be touched.
3163
3164 WARNING: Please make sure that this value is a multiple of
3165 the Linux page size (normally 4k). If this is not the case,
3166 then the end address of the Linux memory will be located at a
3167 non page size aligned address and this could cause major
3168 problems.
3169
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003170- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003171 Enable temporary baudrate change while serial download
3172
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003173- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003174 Physical start address of SDRAM. _Must_ be 0 here.
3175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003176- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003177 Physical start address of Flash memory.
3178
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003179- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003180 Physical start address of boot monitor code (set by
3181 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003182 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003183 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003184
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003185- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003186 Size of memory reserved for monitor code, used to
3187 determine _at_compile_time_ (!) if the environment is
3188 embedded within the U-Boot image, or in a separate
3189 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003190
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003191- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003192 Size of DRAM reserved for malloc() use.
3193
Simon Glassd59476b2014-07-10 22:23:28 -06003194- CONFIG_SYS_MALLOC_F_LEN
3195 Size of the malloc() pool for use before relocation. If
3196 this is defined, then a very simple malloc() implementation
3197 will become available before relocation. The address is just
3198 below the global data, and the stack is moved down to make
3199 space.
3200
3201 This feature allocates regions with increasing addresses
3202 within the region. calloc() is supported, but realloc()
3203 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003204 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003205 U-Boot relocates itself.
3206
Simon Glass38687ae2014-11-10 17:16:54 -07003207- CONFIG_SYS_MALLOC_SIMPLE
3208 Provides a simple and small malloc() and calloc() for those
3209 boards which do not use the full malloc in SPL (which is
3210 enabled with CONFIG_SYS_SPL_MALLOC_START).
3211
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003212- CONFIG_SYS_NONCACHED_MEMORY:
3213 Size of non-cached memory area. This area of memory will be
3214 typically located right below the malloc() area and mapped
3215 uncached in the MMU. This is useful for drivers that would
3216 otherwise require a lot of explicit cache maintenance. For
3217 some drivers it's also impossible to properly maintain the
3218 cache. For example if the regions that need to be flushed
3219 are not a multiple of the cache-line size, *and* padding
3220 cannot be allocated between the regions to align them (i.e.
3221 if the HW requires a contiguous array of regions, and the
3222 size of each region is not cache-aligned), then a flush of
3223 one region may result in overwriting data that hardware has
3224 written to another region in the same cache-line. This can
3225 happen for example in network drivers where descriptors for
3226 buffers are typically smaller than the CPU cache-line (e.g.
3227 16 bytes vs. 32 or 64 bytes).
3228
3229 Non-cached memory is only supported on 32-bit ARM at present.
3230
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003231- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003232 Normally compressed uImages are limited to an
3233 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003235 to adjust this setting to your needs.
3236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003237- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003238 Maximum size of memory mapped by the startup code of
3239 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003240 the Linux kernel (bd_info, boot arguments, FDT blob if
3241 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003242 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003243 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003244 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003245 variable "bootm_mapsize" will override the value of
3246 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3247 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003248
John Rigbyfca43cc2010-10-13 13:57:35 -06003249- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3250 Enable initrd_high functionality. If defined then the
3251 initrd_high feature is enabled and the bootm ramdisk subcommand
3252 is enabled.
3253
3254- CONFIG_SYS_BOOT_GET_CMDLINE:
3255 Enables allocating and saving kernel cmdline in space between
3256 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3257
3258- CONFIG_SYS_BOOT_GET_KBD:
3259 Enables allocating and saving a kernel copy of the bd_info in
3260 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003262- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003263 Max number of Flash memory banks
3264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003265- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003266 Max number of sectors on a Flash chip
3267
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003268- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003269 Timeout for Flash erase operations (in ms)
3270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003271- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003272 Timeout for Flash write operations (in ms)
3273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003274- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003275 Timeout for Flash set sector lock bit operation (in ms)
3276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003277- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003278 Timeout for Flash clear lock bits operation (in ms)
3279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003280- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003281 If defined, hardware flash sectors protection is used
3282 instead of U-Boot software protection.
3283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003284- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003285
3286 Enable TFTP transfers directly to flash memory;
3287 without this option such a download has to be
3288 performed in two steps: (1) download to RAM, and (2)
3289 copy from RAM to flash.
3290
3291 The two-step approach is usually more reliable, since
3292 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003293 the flash, but in some situations (when system RAM is
3294 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003295 downloaded image) this option may be very useful.
3296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003297- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003298 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003299 common flash structure for storing flash geometry.
3300
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003301- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003302 This option also enables the building of the cfi_flash driver
3303 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003304
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003305- CONFIG_FLASH_CFI_MTD
3306 This option enables the building of the cfi_mtd driver
3307 in the drivers directory. The driver exports CFI flash
3308 to the MTD layer.
3309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003310- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003311 Use buffered writes to flash.
3312
3313- CONFIG_FLASH_SPANSION_S29WS_N
3314 s29ws-n MirrorBit flash has non-standard addresses for buffered
3315 write commands.
3316
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003317- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003318 If this option is defined, the common CFI flash doesn't
3319 print it's warning upon not recognized FLASH banks. This
3320 is useful, if some of the configured banks are only
3321 optionally available.
3322
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003323- CONFIG_FLASH_SHOW_PROGRESS
3324 If defined (must be an integer), print out countdown
3325 digits and dots. Recommended value: 45 (9..1) for 80
3326 column displays, 15 (3..1) for 40 column displays.
3327
Stefan Roese352ef3f2013-04-04 15:53:14 +02003328- CONFIG_FLASH_VERIFY
3329 If defined, the content of the flash (destination) is compared
3330 against the source after the write operation. An error message
3331 will be printed when the contents are not identical.
3332 Please note that this option is useless in nearly all cases,
3333 since such flash programming errors usually are detected earlier
3334 while unprotecting/erasing/programming. Please only enable
3335 this option if you really know what you are doing.
3336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003337- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003338 Defines the number of Ethernet receive buffers. On some
3339 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003340 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3341 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003342 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003343 Defaults to 4 if not defined.
3344
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003345- CONFIG_ENV_MAX_ENTRIES
3346
Wolfgang Denk071bc922010-10-27 22:48:30 +02003347 Maximum number of entries in the hash table that is used
3348 internally to store the environment settings. The default
3349 setting is supposed to be generous and should work in most
3350 cases. This setting can be used to tune behaviour; see
3351 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003352
Joe Hershberger25980902012-12-11 22:16:31 -06003353- CONFIG_ENV_FLAGS_LIST_DEFAULT
3354- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003355 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003356 calling env set. Variables can be restricted to only decimal,
3357 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3358 the variables can also be restricted to IP address or MAC address.
3359
3360 The format of the list is:
3361 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003362 access_attribute = [a|r|o|c]
3363 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003364 entry = variable_name[:attributes]
3365 list = entry[,list]
3366
3367 The type attributes are:
3368 s - String (default)
3369 d - Decimal
3370 x - Hexadecimal
3371 b - Boolean ([1yYtT|0nNfF])
3372 i - IP address
3373 m - MAC address
3374
Joe Hershberger267541f2012-12-11 22:16:34 -06003375 The access attributes are:
3376 a - Any (default)
3377 r - Read-only
3378 o - Write-once
3379 c - Change-default
3380
Joe Hershberger25980902012-12-11 22:16:31 -06003381 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3382 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003383 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003384
3385 - CONFIG_ENV_FLAGS_LIST_STATIC
3386 Define this to a list (string) to define validation that
3387 should be done if an entry is not found in the ".flags"
3388 environment variable. To override a setting in the static
3389 list, simply add an entry for the same variable name to the
3390 ".flags" variable.
3391
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003392 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3393 regular expression. This allows multiple variables to define the same
3394 flags without explicitly listing them for each variable.
3395
Joe Hershberger267541f2012-12-11 22:16:34 -06003396- CONFIG_ENV_ACCESS_IGNORE_FORCE
3397 If defined, don't allow the -f switch to env set override variable
3398 access flags.
3399
Gabe Black0d296cc2014-10-15 04:38:30 -06003400- CONFIG_USE_STDINT
3401 If stdint.h is available with your toolchain you can define this
3402 option to enable it. You can provide option 'USE_STDINT=1' when
3403 building U-Boot to enable this.
3404
wdenkc6097192002-11-03 00:24:07 +00003405The following definitions that deal with the placement and management
3406of environment data (variable area); in general, we support the
3407following configurations:
3408
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003409- CONFIG_BUILD_ENVCRC:
3410
3411 Builds up envcrc with the target environment so that external utils
3412 may easily extract it and embed it in final U-Boot images.
3413
wdenkc6097192002-11-03 00:24:07 +00003414BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003415in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003416console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003417U-Boot will hang.
3418
3419Please note that even with NVRAM we still use a copy of the
3420environment in RAM: we could work on NVRAM directly, but we want to
3421keep settings there always unmodified except somebody uses "saveenv"
3422to save the current settings.
3423
Liu Gang0a85a9e2012-03-08 00:33:20 +00003424BE CAREFUL! For some special cases, the local device can not use
3425"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003426environment stored in a remote NOR flash by SRIO or PCIE link,
3427but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003428
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003429- CONFIG_NAND_ENV_DST
3430
3431 Defines address in RAM to which the nand_spl code should copy the
3432 environment. If redundant environment is used, it will be copied to
3433 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3434
Bruce Adlere881cb52007-11-02 13:15:42 -07003435Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003436has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003437created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003438until then to read environment variables.
3439
wdenk85ec0bc2003-03-31 16:34:49 +00003440The environment is protected by a CRC32 checksum. Before the monitor
3441is relocated into RAM, as a result of a bad CRC you will be working
3442with the compiled-in default environment - *silently*!!! [This is
3443necessary, because the first environment variable we need is the
3444"baudrate" setting for the console - if we have a bad CRC, we don't
3445have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003446
3447Note: once the monitor has been relocated, then it will complain if
3448the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003449use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003450
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003451- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003452 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003454 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003455 also needs to be defined.
3456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003457- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003458 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003459
Ron Madridf5675aa2009-02-18 14:30:44 -08003460- CONFIG_NS16550_MIN_FUNCTIONS:
3461 Define this if you desire to only have use of the NS16550_init
3462 and NS16550_putc functions for the serial driver located at
3463 drivers/serial/ns16550.c. This option is useful for saving
3464 space for already greatly restricted images, including but not
3465 limited to NAND_SPL configurations.
3466
Simon Glassb2b92f52012-11-30 13:01:18 +00003467- CONFIG_DISPLAY_BOARDINFO
3468 Display information about the board that U-Boot is running on
3469 when U-Boot starts up. The board function checkboard() is called
3470 to do this.
3471
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003472- CONFIG_DISPLAY_BOARDINFO_LATE
3473 Similar to the previous option, but display this information
3474 later, once stdio is running and output goes to the LCD, if
3475 present.
3476
Sascha Silbefeb85802013-08-11 16:40:43 +02003477- CONFIG_BOARD_SIZE_LIMIT:
3478 Maximum size of the U-Boot image. When defined, the
3479 build system checks that the actual size does not
3480 exceed it.
3481
wdenkc6097192002-11-03 00:24:07 +00003482Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003483---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003484
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003485- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003486 Cache Line Size of the CPU.
3487
Timur Tabie46fedf2011-08-04 18:03:41 -05003488- CONFIG_SYS_CCSRBAR_DEFAULT:
3489 Default (power-on reset) physical address of CCSR on Freescale
3490 PowerPC SOCs.
3491
3492- CONFIG_SYS_CCSRBAR:
3493 Virtual address of CCSR. On a 32-bit build, this is typically
3494 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3495
Timur Tabie46fedf2011-08-04 18:03:41 -05003496- CONFIG_SYS_CCSRBAR_PHYS:
3497 Physical address of CCSR. CCSR can be relocated to a new
3498 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003499 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003500 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3501 is typically relocated on 36-bit builds. It is recommended
3502 that this macro be defined via the _HIGH and _LOW macros:
3503
3504 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3505 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3506
3507- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003508 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3509 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003510 used in assembly code, so it must not contain typecasts or
3511 integer size suffixes (e.g. "ULL").
3512
3513- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3514 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3515 used in assembly code, so it must not contain typecasts or
3516 integer size suffixes (e.g. "ULL").
3517
3518- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3519 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3520 forced to a value that ensures that CCSR is not relocated.
3521
wdenk7f6c2cb2002-11-10 22:06:23 +00003522- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003523 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003524
3525 the default drive number (default value 0)
3526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003528
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003529 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003530 (default value 1)
3531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003532 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003533
wdenk43d96162003-03-06 00:02:04 +00003534 defines the offset of register from address. It
3535 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003536 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003538 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3539 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003540 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003541
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003542 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003543 fdc_hw_init() is called at the beginning of the FDC
3544 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003545 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003546 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003547
Macpaul Lin0abddf82011-04-11 20:45:32 +00003548- CONFIG_IDE_AHB:
3549 Most IDE controllers were designed to be connected with PCI
3550 interface. Only few of them were designed for AHB interface.
3551 When software is doing ATA command and data transfer to
3552 IDE devices through IDE-AHB controller, some additional
3553 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003554 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003557 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003558 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003560- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003561
wdenk7152b1d2003-09-05 23:19:14 +00003562 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003563 initial data and stack; please note that this must be
3564 writable memory that is working WITHOUT special
3565 initialization, i. e. you CANNOT use normal RAM which
3566 will become available only after programming the
3567 memory controller and running certain initialization
3568 sequences.
3569
3570 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003571 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003573- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003574
3575 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003576 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3577 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003578 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003579 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003580 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003581 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3582 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003583
3584 Note:
3585 On the MPC824X (or other systems that use the data
3586 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003587 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003588 point to an otherwise UNUSED address space between
3589 the top of RAM and the start of the PCI space.
3590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003591- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003592
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003593- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003594 SDRAM timing
3595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003596- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003597 periodic timer for refresh
3598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003599- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3600 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3601 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3602 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003603 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3604
3605- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003606 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3607 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003608 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3609
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003610- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003611 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003612 Don't do any setup work, presumably because someone or
3613 something has already done it, and we don't need to do it
3614 a second time. Useful for platforms that are pre-booted
3615 by coreboot or similar.
3616
Gabor Juhos842033e2013-05-30 07:06:12 +00003617- CONFIG_PCI_INDIRECT_BRIDGE:
3618 Enable support for indirect PCI bridges.
3619
Kumar Galaa09b9b62010-12-30 12:09:53 -06003620- CONFIG_SYS_SRIO:
3621 Chip has SRIO or not
3622
3623- CONFIG_SRIO1:
3624 Board has SRIO 1 port available
3625
3626- CONFIG_SRIO2:
3627 Board has SRIO 2 port available
3628
Liu Gangc8b28152013-05-07 16:30:46 +08003629- CONFIG_SRIO_PCIE_BOOT_MASTER
3630 Board can support master function for Boot from SRIO and PCIE
3631
Kumar Galaa09b9b62010-12-30 12:09:53 -06003632- CONFIG_SYS_SRIOn_MEM_VIRT:
3633 Virtual Address of SRIO port 'n' memory region
3634
3635- CONFIG_SYS_SRIOn_MEM_PHYS:
3636 Physical Address of SRIO port 'n' memory region
3637
3638- CONFIG_SYS_SRIOn_MEM_SIZE:
3639 Size of SRIO port 'n' memory region
3640
Fabio Estevam66bd1842013-04-11 09:35:34 +00003641- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3642 Defined to tell the NAND controller that the NAND chip is using
3643 a 16 bit bus.
3644 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003645 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003646 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003647 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003648
3649- CONFIG_SYS_NDFC_EBC0_CFG
3650 Sets the EBC0_CFG register for the NDFC. If not defined
3651 a default value will be used.
3652
Ben Warrenbb99ad62006-09-07 16:50:54 -04003653- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003654 Get DDR timing information from an I2C EEPROM. Common
3655 with pluggable memory modules such as SODIMMs
3656
Ben Warrenbb99ad62006-09-07 16:50:54 -04003657 SPD_EEPROM_ADDRESS
3658 I2C address of the SPD EEPROM
3659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003660- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003661 If SPD EEPROM is on an I2C bus other than the first
3662 one, specify here. Note that the value must resolve
3663 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003664
York Sun1b3e3c42011-06-07 09:42:16 +08003665- CONFIG_SYS_DDR_RAW_TIMING
3666 Get DDR timing information from other than SPD. Common with
3667 soldered DDR chips onboard without SPD. DDR raw timing
3668 parameters are extracted from datasheet and hard-coded into
3669 header files or board specific files.
3670
York Sun6f5e1dc2011-09-16 13:21:35 -07003671- CONFIG_FSL_DDR_INTERACTIVE
3672 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3673
York Sune32d59a2015-01-06 13:18:55 -08003674- CONFIG_FSL_DDR_SYNC_REFRESH
3675 Enable sync of refresh for multiple controllers.
3676
York Sun4516ff82015-03-19 09:30:28 -07003677- CONFIG_FSL_DDR_BIST
3678 Enable built-in memory test for Freescale DDR controllers.
3679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003680- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003681 Only for 83xx systems. If specified, then DDR should
3682 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003683
wdenkc26e4542004-04-18 10:13:26 +00003684- CONFIG_RMII
3685 Enable RMII mode for all FECs.
3686 Note that this is a global option, we can't
3687 have one FEC in standard MII mode and another in RMII mode.
3688
wdenk5cf91d62004-04-23 20:32:05 +00003689- CONFIG_CRC32_VERIFY
3690 Add a verify option to the crc32 command.
3691 The syntax is:
3692
3693 => crc32 -v <address> <count> <crc32>
3694
3695 Where address/count indicate a memory area
3696 and crc32 is the correct crc32 which the
3697 area should have.
3698
wdenk56523f12004-07-11 17:40:54 +00003699- CONFIG_LOOPW
3700 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003701 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003702
stroese7b466642004-12-16 18:46:55 +00003703- CONFIG_MX_CYCLIC
3704 Add the "mdc" and "mwc" memory commands. These are cyclic
3705 "md/mw" commands.
3706 Examples:
3707
wdenkefe2a4d2004-12-16 21:44:03 +00003708 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003709 This command will print 4 bytes (10,11,12,13) each 500 ms.
3710
wdenkefe2a4d2004-12-16 21:44:03 +00003711 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003712 This command will write 12345678 to address 100 all 10 ms.
3713
wdenkefe2a4d2004-12-16 21:44:03 +00003714 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003715 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003716
wdenk8aa1a2d2005-04-04 12:44:11 +00003717- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003718 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003719 low level initializations (like setting up the memory
3720 controller) are omitted and/or U-Boot does not
3721 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003722
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003723 Normally this variable MUST NOT be defined. The only
3724 exception is when U-Boot is loaded (to RAM) by some
3725 other boot loader or by a debugger which performs
3726 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003727
Simon Glassb5bd0982016-05-05 07:28:06 -06003728- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3729 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003730 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003731 instruction cache) is still performed.
3732
Aneesh V401bb302011-07-13 05:11:07 +00003733- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003734 Modifies the behaviour of start.S when compiling a loader
3735 that is executed before the actual U-Boot. E.g. when
3736 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003737
Ying Zhang3aa29de2013-08-16 15:16:15 +08003738- CONFIG_TPL_BUILD
3739 Modifies the behaviour of start.S when compiling a loader
3740 that is executed after the SPL and before the actual U-Boot.
3741 It is loaded by the SPL.
3742
Ying Zhang5df572f2013-05-20 14:07:23 +08003743- CONFIG_SYS_MPC85XX_NO_RESETVEC
3744 Only for 85xx systems. If this variable is specified, the section
3745 .resetvec is not kept and the section .bootpg is placed in the
3746 previous 4k of the .text section.
3747
Simon Glass4213fc22013-02-24 17:33:14 +00003748- CONFIG_ARCH_MAP_SYSMEM
3749 Generally U-Boot (and in particular the md command) uses
3750 effective address. It is therefore not necessary to regard
3751 U-Boot address as virtual addresses that need to be translated
3752 to physical addresses. However, sandbox requires this, since
3753 it maintains its own little RAM buffer which contains all
3754 addressable memory. This option causes some memory accesses
3755 to be mapped through map_sysmem() / unmap_sysmem().
3756
Simon Glass588a13f2013-02-14 04:18:54 +00003757- CONFIG_X86_RESET_VECTOR
3758 If defined, the x86 reset vector code is included. This is not
3759 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003760
Heiko Schocher16678eb2013-11-04 14:05:00 +01003761- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3762 Enables the RTC32K OSC on AM33xx based plattforms
3763
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003764- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3765 Option to disable subpage write in NAND driver
3766 driver that uses this:
3767 drivers/mtd/nand/davinci_nand.c
3768
Timur Tabif2717b42011-11-22 09:21:25 -06003769Freescale QE/FMAN Firmware Support:
3770-----------------------------------
3771
3772The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3773loading of "firmware", which is encoded in the QE firmware binary format.
3774This firmware often needs to be loaded during U-Boot booting, so macros
3775are used to identify the storage device (NOR flash, SPI, etc) and the address
3776within that device.
3777
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003778- CONFIG_SYS_FMAN_FW_ADDR
3779 The address in the storage device where the FMAN microcode is located. The
3780 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3781 is also specified.
3782
3783- CONFIG_SYS_QE_FW_ADDR
3784 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003785 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3786 is also specified.
3787
3788- CONFIG_SYS_QE_FMAN_FW_LENGTH
3789 The maximum possible size of the firmware. The firmware binary format
3790 has a field that specifies the actual size of the firmware, but it
3791 might not be possible to read any part of the firmware unless some
3792 local storage is allocated to hold the entire firmware first.
3793
3794- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3795 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3796 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3797 virtual address in NOR flash.
3798
3799- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3800 Specifies that QE/FMAN firmware is located in NAND flash.
3801 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3802
3803- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3804 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3805 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3806
Liu Gang292dc6c2012-03-08 00:33:18 +00003807- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3808 Specifies that QE/FMAN firmware is located in the remote (master)
3809 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003810 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3811 window->master inbound window->master LAW->the ucode address in
3812 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003813
J. German Riverab940ca62014-06-23 15:15:55 -07003814Freescale Layerscape Management Complex Firmware Support:
3815---------------------------------------------------------
3816The Freescale Layerscape Management Complex (MC) supports the loading of
3817"firmware".
3818This firmware often needs to be loaded during U-Boot booting, so macros
3819are used to identify the storage device (NOR flash, SPI, etc) and the address
3820within that device.
3821
3822- CONFIG_FSL_MC_ENET
3823 Enable the MC driver for Layerscape SoCs.
3824
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303825Freescale Layerscape Debug Server Support:
3826-------------------------------------------
3827The Freescale Layerscape Debug Server Support supports the loading of
3828"Debug Server firmware" and triggering SP boot-rom.
3829This firmware often needs to be loaded during U-Boot booting.
3830
York Sunc0492142015-12-07 11:08:58 -08003831- CONFIG_SYS_MC_RSV_MEM_ALIGN
3832 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303833
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003834Reproducible builds
3835-------------------
3836
3837In order to achieve reproducible builds, timestamps used in the U-Boot build
3838process have to be set to a fixed value.
3839
3840This is done using the SOURCE_DATE_EPOCH environment variable.
3841SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3842option for U-Boot or an environment variable in U-Boot.
3843
3844SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3845
wdenkc6097192002-11-03 00:24:07 +00003846Building the Software:
3847======================
3848
Wolfgang Denk218ca722008-03-26 10:40:12 +01003849Building U-Boot has been tested in several native build environments
3850and in many different cross environments. Of course we cannot support
3851all possibly existing versions of cross development tools in all
3852(potentially obsolete) versions. In case of tool chain problems we
3853recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3854which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003855
Wolfgang Denk218ca722008-03-26 10:40:12 +01003856If you are not using a native environment, it is assumed that you
3857have GNU cross compiling tools available in your path. In this case,
3858you must set the environment variable CROSS_COMPILE in your shell.
3859Note that no changes to the Makefile or any other source files are
3860necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003861
Wolfgang Denk218ca722008-03-26 10:40:12 +01003862 $ CROSS_COMPILE=ppc_4xx-
3863 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003864
Peter Tyser2f8d3962009-03-13 18:54:51 -05003865Note: If you wish to generate Windows versions of the utilities in
3866 the tools directory you can use the MinGW toolchain
3867 (http://www.mingw.org). Set your HOST tools to the MinGW
3868 toolchain and execute 'make tools'. For example:
3869
3870 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3871
3872 Binaries such as tools/mkimage.exe will be created which can
3873 be executed on computers running Windows.
3874
Wolfgang Denk218ca722008-03-26 10:40:12 +01003875U-Boot is intended to be simple to build. After installing the
3876sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003877is done by typing:
3878
Holger Freytherab584d62014-08-04 09:26:05 +02003879 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003880
Holger Freytherab584d62014-08-04 09:26:05 +02003881where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003882rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884Note: for some board special configuration names may exist; check if
3885 additional information is available from the board vendor; for
3886 instance, the TQM823L systems are available without (standard)
3887 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003888 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003889
Holger Freytherab584d62014-08-04 09:26:05 +02003890 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003891 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003892
Holger Freytherab584d62014-08-04 09:26:05 +02003893 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003894 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896 etc.
wdenkc6097192002-11-03 00:24:07 +00003897
wdenkc6097192002-11-03 00:24:07 +00003898
wdenk2729af92004-05-03 20:45:30 +00003899Finally, type "make all", and you should get some working U-Boot
3900images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902- "u-boot.bin" is a raw binary image
3903- "u-boot" is an image in ELF binary format
3904- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003905
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003906By default the build is performed locally and the objects are saved
3907in the source directory. One of the two methods can be used to change
3908this behavior and build U-Boot to some external directory:
3909
39101. Add O= to the make command line invocations:
3911
3912 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003913 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003914 make O=/tmp/build all
3915
Timo Ketolaadbba992014-11-06 14:39:05 +020039162. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003917
Timo Ketolaadbba992014-11-06 14:39:05 +02003918 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003919 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003920 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003921 make all
3922
Timo Ketolaadbba992014-11-06 14:39:05 +02003923Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003924variable.
3925
wdenkc6097192002-11-03 00:24:07 +00003926
wdenk2729af92004-05-03 20:45:30 +00003927Please be aware that the Makefiles assume you are using GNU make, so
3928for instance on NetBSD you might need to use "gmake" instead of
3929native "make".
wdenkc6097192002-11-03 00:24:07 +00003930
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932If the system board that you have is not listed, then you will need
3933to port U-Boot to your hardware platform. To do this, follow these
3934steps:
wdenkc6097192002-11-03 00:24:07 +00003935
Phil Sutter3c1496c2015-12-25 14:41:18 +010039361. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003937 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003938 the "Makefile" and a "<board>.c".
39392. Create a new configuration file "include/configs/<board>.h" for
3940 your board.
wdenk2729af92004-05-03 20:45:30 +000039413. If you're porting U-Boot to a new CPU, then also create a new
3942 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020039434. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000039445. Type "make", and you should get a working "u-boot.srec" file
3945 to be installed on your target system.
39466. Debug and solve any problems that might arise.
3947 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003948
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3951==============================================================
wdenkc6097192002-11-03 00:24:07 +00003952
Wolfgang Denk218ca722008-03-26 10:40:12 +01003953If you have modified U-Boot sources (for instance added a new board
3954or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003955provide feedback to the other developers. The feedback normally takes
3956the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003957official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003958
Wolfgang Denk218ca722008-03-26 10:40:12 +01003959But before you submit such a patch, please verify that your modifi-
3960cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003961the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003962just run the buildman script (tools/buildman/buildman), which will
3963configure and build U-Boot for ALL supported system. Be warned, this
3964will take a while. Please see the buildman README, or run 'buildman -H'
3965for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003966
3967
wdenk2729af92004-05-03 20:45:30 +00003968See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003969
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk2729af92004-05-03 20:45:30 +00003971Monitor Commands - Overview:
3972============================
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk2729af92004-05-03 20:45:30 +00003974go - start application at address 'addr'
3975run - run commands in an environment variable
3976bootm - boot application image from memory
3977bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003978bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003979tftpboot- boot image via network using TFTP protocol
3980 and env variables "ipaddr" and "serverip"
3981 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003982tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003983rarpboot- boot image via network using RARP/TFTP protocol
3984diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3985loads - load S-Record file over serial line
3986loadb - load binary file over serial line (kermit mode)
3987md - memory display
3988mm - memory modify (auto-incrementing)
3989nm - memory modify (constant address)
3990mw - memory write (fill)
3991cp - memory copy
3992cmp - memory compare
3993crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003994i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003995sspi - SPI utility commands
3996base - print or set address offset
3997printenv- print environment variables
3998setenv - set environment variables
3999saveenv - save environment variables to persistent storage
4000protect - enable or disable FLASH write protection
4001erase - erase FLASH memory
4002flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004003nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004004bdinfo - print Board Info structure
4005iminfo - print header information for application image
4006coninfo - print console devices and informations
4007ide - IDE sub-system
4008loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004009loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004010mtest - simple RAM test
4011icache - enable or disable instruction cache
4012dcache - enable or disable data cache
4013reset - Perform RESET of the CPU
4014echo - echo args to console
4015version - print monitor version
4016help - print online help
4017? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004018
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk2729af92004-05-03 20:45:30 +00004020Monitor Commands - Detailed Description:
4021========================================
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk2729af92004-05-03 20:45:30 +00004023TODO.
wdenkc6097192002-11-03 00:24:07 +00004024
wdenk2729af92004-05-03 20:45:30 +00004025For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004026
4027
wdenk2729af92004-05-03 20:45:30 +00004028Environment Variables:
4029======================
wdenkc6097192002-11-03 00:24:07 +00004030
wdenk2729af92004-05-03 20:45:30 +00004031U-Boot supports user configuration using Environment Variables which
4032can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034Environment Variables are set using "setenv", printed using
4035"printenv", and saved to Flash using "saveenv". Using "setenv"
4036without a value can be used to delete a variable from the
4037environment. As long as you don't save the environment you are
4038working with an in-memory copy. In case the Flash area containing the
4039environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004040
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004041Some configuration options can be set using Environment Variables.
4042
4043List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004044
wdenk2729af92004-05-03 20:45:30 +00004045 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004046
wdenk2729af92004-05-03 20:45:30 +00004047 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004048
wdenk2729af92004-05-03 20:45:30 +00004049 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004052
wdenk2729af92004-05-03 20:45:30 +00004053 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004054
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004055 bootm_low - Memory range available for image processing in the bootm
4056 command can be restricted. This variable is given as
4057 a hexadecimal number and defines lowest address allowed
4058 for use by the bootm command. See also "bootm_size"
4059 environment variable. Address defined by "bootm_low" is
4060 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004061 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4062 bootm_mapsize.
4063
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004064 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004065 This variable is given as a hexadecimal number and it
4066 defines the size of the memory region starting at base
4067 address bootm_low that is accessible by the Linux kernel
4068 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4069 as the default value if it is defined, and bootm_size is
4070 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004071
4072 bootm_size - Memory range available for image processing in the bootm
4073 command can be restricted. This variable is given as
4074 a hexadecimal number and defines the size of the region
4075 allowed for use by the bootm command. See also "bootm_low"
4076 environment variable.
4077
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004078 updatefile - Location of the software update file on a TFTP server, used
4079 by the automatic software update feature. Please refer to
4080 documentation in doc/README.update for more details.
4081
wdenk2729af92004-05-03 20:45:30 +00004082 autoload - if set to "no" (any string beginning with 'n'),
4083 "bootp" will just load perform a lookup of the
4084 configuration from the BOOTP server, but not try to
4085 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087 autostart - if set to "yes", an image loaded using the "bootp",
4088 "rarpboot", "tftpboot" or "diskboot" commands will
4089 be automatically started (by internally calling
4090 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk2729af92004-05-03 20:45:30 +00004092 If set to "no", a standalone image passed to the
4093 "bootm" command will be copied to the load address
4094 (and eventually uncompressed), but NOT be started.
4095 This can be used to load and uncompress arbitrary
4096 data.
wdenkc6097192002-11-03 00:24:07 +00004097
David A. Longa28afca2011-07-09 16:40:19 -04004098 fdt_high - if set this restricts the maximum address that the
4099 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004100 For example, if you have a system with 1 GB memory
4101 at physical address 0x10000000, while Linux kernel
4102 only recognizes the first 704 MB as low memory, you
4103 may need to set fdt_high as 0x3C000000 to have the
4104 device tree blob be copied to the maximum address
4105 of the 704 MB low memory, so that Linux kernel can
4106 access it during the boot procedure.
4107
David A. Longa28afca2011-07-09 16:40:19 -04004108 If this is set to the special value 0xFFFFFFFF then
4109 the fdt will not be copied at all on boot. For this
4110 to work it must reside in writable memory, have
4111 sufficient padding on the end of it for u-boot to
4112 add the information it needs into it, and the memory
4113 must be accessible by the kernel.
4114
Simon Glasseea63e02011-10-24 19:15:34 +00004115 fdtcontroladdr- if set this is the address of the control flattened
4116 device tree used by U-Boot when CONFIG_OF_CONTROL is
4117 defined.
4118
wdenk17ea1172004-06-06 21:51:03 +00004119 i2cfast - (PPC405GP|PPC405EP only)
4120 if set to 'y' configures Linux I2C driver for fast
4121 mode (400kHZ). This environment variable is used in
4122 initialization code. So, for changes to be effective
4123 it must be saved and board must be reset.
4124
wdenk2729af92004-05-03 20:45:30 +00004125 initrd_high - restrict positioning of initrd images:
4126 If this variable is not set, initrd images will be
4127 copied to the highest possible address in RAM; this
4128 is usually what you want since it allows for
4129 maximum initrd size. If for some reason you want to
4130 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004131 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004132 variable to a value of "no" or "off" or "0".
4133 Alternatively, you can set it to a maximum upper
4134 address to use (U-Boot will still check that it
4135 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137 For instance, when you have a system with 16 MB
4138 RAM, and want to reserve 4 MB from use by Linux,
4139 you can do this by adding "mem=12M" to the value of
4140 the "bootargs" variable. However, now you must make
4141 sure that the initrd image is placed in the first
4142 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004143
wdenk2729af92004-05-03 20:45:30 +00004144 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk2729af92004-05-03 20:45:30 +00004146 If you set initrd_high to 0xFFFFFFFF, this is an
4147 indication to U-Boot that all addresses are legal
4148 for the Linux kernel, including addresses in flash
4149 memory. In this case U-Boot will NOT COPY the
4150 ramdisk at all. This may be useful to reduce the
4151 boot time on your system, but requires that this
4152 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004153
wdenk2729af92004-05-03 20:45:30 +00004154 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156 loadaddr - Default load address for commands like "bootp",
4157 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004160
wdenk2729af92004-05-03 20:45:30 +00004161 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004162
wdenk2729af92004-05-03 20:45:30 +00004163 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004164
wdenk2729af92004-05-03 20:45:30 +00004165 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004166
wdenk2729af92004-05-03 20:45:30 +00004167 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004168
Mike Frysingere2a53452011-10-02 10:01:27 +00004169 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004170
Mike Frysingere2a53452011-10-02 10:01:27 +00004171 ethact - controls which interface is currently active.
4172 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004173
Heiko Schocher48690d82010-07-20 17:45:02 +02004174 => setenv ethact FEC
4175 => ping 192.168.0.1 # traffic sent on FEC
4176 => setenv ethact SCC
4177 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004178
Matthias Fuchse1692572008-01-17 07:45:05 +01004179 ethrotate - When set to "no" U-Boot does not go through all
4180 available network interfaces.
4181 It just stays at the currently selected interface.
4182
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004183 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004184 either succeed or fail without retrying.
4185 When set to "once" the network operation will
4186 fail when all the available network interfaces
4187 are tried once without success.
4188 Useful on scripts which control the retry operation
4189 themselves.
wdenkc6097192002-11-03 00:24:07 +00004190
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004191 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004192
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004193 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07004194 changing the console to be empty. If "yes" it will be
4195 made silent. If "no" it will not be made silent. If
4196 unset, then it will be made silent if the U-Boot console
4197 is silent.
4198
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004199 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004200 UDP source port.
4201
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004202 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004203 destination port instead of the Well Know Port 69.
4204
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004205 tftpblocksize - Block size to use for TFTP transfers; if not set,
4206 we use the TFTP server's default block size
4207
4208 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4209 seconds, minimum value is 1000 = 1 second). Defines
4210 when a packet is considered to be lost so it has to
4211 be retransmitted. The default is 5000 = 5 seconds.
4212 Lowering this value may make downloads succeed
4213 faster in networks with high packet loss rates or
4214 with unreliable TFTP servers.
4215
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004216 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4217 unit, minimum value = 0). Defines how many timeouts
4218 can happen during a single file transfer before that
4219 transfer is aborted. The default is 10, and 0 means
4220 'no timeouts allowed'. Increasing this value may help
4221 downloads succeed with high packet loss rates, or with
4222 unreliable TFTP servers or client hardware.
4223
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004224 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004225 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004226 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004227
Alexandre Messier50768f52016-02-01 17:08:57 -05004228 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4229 Unsigned value, in milliseconds. If not set, the period will
4230 be either the default (28000), or a value based on
4231 CONFIG_NET_RETRY_COUNT, if defined. This value has
4232 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4233
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004234The following image location variables contain the location of images
4235used in booting. The "Image" column gives the role of the image and is
4236not an environment variable name. The other columns are environment
4237variable names. "File Name" gives the name of the file on a TFTP
4238server, "RAM Address" gives the location in RAM the image will be
4239loaded to, and "Flash Location" gives the image's address in NOR
4240flash or offset in NAND flash.
4241
4242*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004243boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004244boards use these variables for other purposes.
4245
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004246Image File Name RAM Address Flash Location
4247----- --------- ----------- --------------
4248u-boot u-boot u-boot_addr_r u-boot_addr
4249Linux kernel bootfile kernel_addr_r kernel_addr
4250device tree blob fdtfile fdt_addr_r fdt_addr
4251ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253The following environment variables may be used and automatically
4254updated by the network boot commands ("bootp" and "rarpboot"),
4255depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257 bootfile - see above
4258 dnsip - IP address of your Domain Name Server
4259 dnsip2 - IP address of your secondary Domain Name Server
4260 gatewayip - IP address of the Gateway (Router) to use
4261 hostname - Target hostname
4262 ipaddr - see above
4263 netmask - Subnet Mask
4264 rootpath - Pathname of the root filesystem on the NFS server
4265 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004266
wdenka3d991b2004-04-15 21:48:45 +00004267
wdenk2729af92004-05-03 20:45:30 +00004268There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004269
wdenk2729af92004-05-03 20:45:30 +00004270 serial# - contains hardware identification information such
4271 as type string and/or serial number
4272 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274These variables can be set only once (usually during manufacturing of
4275the board). U-Boot refuses to delete or overwrite these variables
4276once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004277
4278
wdenk2729af92004-05-03 20:45:30 +00004279Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281 ver - Contains the U-Boot version string as printed
4282 with the "version" command. This variable is
4283 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004284
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk2729af92004-05-03 20:45:30 +00004286Please note that changes to some configuration parameters may take
4287only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004288
stroesec1551ea2003-04-04 15:53:41 +00004289
Joe Hershberger170ab112012-12-11 22:16:24 -06004290Callback functions for environment variables:
4291---------------------------------------------
4292
4293For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004294when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004295be associated with arbitrary variables. On creation, overwrite, or
4296deletion, the callback will provide the opportunity for some side
4297effect to happen or for the change to be rejected.
4298
4299The callbacks are named and associated with a function using the
4300U_BOOT_ENV_CALLBACK macro in your board or driver code.
4301
4302These callbacks are associated with variables in one of two ways. The
4303static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4304in the board configuration to a string that defines a list of
4305associations. The list must be in the following format:
4306
4307 entry = variable_name[:callback_name]
4308 list = entry[,list]
4309
4310If the callback name is not specified, then the callback is deleted.
4311Spaces are also allowed anywhere in the list.
4312
4313Callbacks can also be associated by defining the ".callbacks" variable
4314with the same list format above. Any association in ".callbacks" will
4315override any association in the static list. You can define
4316CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004317".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004318
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004319If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4320regular expression. This allows multiple variables to be connected to
4321the same callback without explicitly listing them all out.
4322
Joe Hershberger170ab112012-12-11 22:16:24 -06004323
wdenk2729af92004-05-03 20:45:30 +00004324Command Line Parsing:
4325=====================
stroesec1551ea2003-04-04 15:53:41 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327There are two different command line parsers available with U-Boot:
4328the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004329
wdenk2729af92004-05-03 20:45:30 +00004330Old, simple command line parser:
4331--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333- supports environment variables (through setenv / saveenv commands)
4334- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004335- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004336- special characters ('$', ';') can be escaped by prefixing with '\',
4337 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004338 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004339- You can also escape text by enclosing in single apostrophes, for example:
4340 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004341
wdenk2729af92004-05-03 20:45:30 +00004342Hush shell:
4343-----------
wdenkf07771c2003-05-28 08:06:31 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345- similar to Bourne shell, with control structures like
4346 if...then...else...fi, for...do...done; while...do...done,
4347 until...do...done, ...
4348- supports environment ("global") variables (through setenv / saveenv
4349 commands) and local shell variables (through standard shell syntax
4350 "name=value"); only environment variables can be used with "run"
4351 command
wdenkf07771c2003-05-28 08:06:31 +00004352
wdenk2729af92004-05-03 20:45:30 +00004353General rules:
4354--------------
wdenkf07771c2003-05-28 08:06:31 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356(1) If a command line (or an environment variable executed by a "run"
4357 command) contains several commands separated by semicolon, and
4358 one of these commands fails, then the remaining commands will be
4359 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004360
wdenk2729af92004-05-03 20:45:30 +00004361(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004362 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004363 command will cause "run" to terminate, i. e. the remaining
4364 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004365
wdenk2729af92004-05-03 20:45:30 +00004366Note for Redundant Ethernet Interfaces:
4367=======================================
wdenkf07771c2003-05-28 08:06:31 +00004368
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004369Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004370such configurations and is capable of automatic selection of a
4371"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004372
wdenk2729af92004-05-03 20:45:30 +00004373Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4374MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4375"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377If the network interface stores some valid MAC address (for instance
4378in SROM), this is used as default address if there is NO correspon-
4379ding setting in the environment; if the corresponding environment
4380variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382o If the SROM has a valid MAC address, and there is no address in the
4383 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk2729af92004-05-03 20:45:30 +00004385o If there is no valid address in the SROM, and a definition in the
4386 environment exists, then the value from the environment variable is
4387 used.
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389o If both the SROM and the environment contain a MAC address, and
4390 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004391
wdenk2729af92004-05-03 20:45:30 +00004392o If both the SROM and the environment contain a MAC address, and the
4393 addresses differ, the value from the environment is used and a
4394 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004395
wdenk2729af92004-05-03 20:45:30 +00004396o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004397 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4398 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004399
Ben Warrenecee9322010-04-26 11:11:46 -07004400If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004401will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004402may be skipped by setting the appropriate 'ethmacskip' environment variable.
4403The naming convention is as follows:
4404"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406Image Formats:
4407==============
wdenkc6097192002-11-03 00:24:07 +00004408
Marian Balakowicz3310c542008-03-12 12:13:13 +01004409U-Boot is capable of booting (and performing other auxiliary operations on)
4410images in two formats:
4411
4412New uImage format (FIT)
4413-----------------------
4414
4415Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4416to Flattened Device Tree). It allows the use of images with multiple
4417components (several kernels, ramdisks, etc.), with contents protected by
4418SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4419
4420
4421Old uImage format
4422-----------------
4423
4424Old image format is based on binary files which can be basically anything,
4425preceded by a special header; see the definitions in include/image.h for
4426details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk2729af92004-05-03 20:45:30 +00004428* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4429 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004430 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4431 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4432 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004433* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004434 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004435 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004436* Compression Type (uncompressed, gzip, bzip2)
4437* Load Address
4438* Entry Point
4439* Image Name
4440* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442The header is marked by a special Magic Number, and both the header
4443and the data portions of the image are secured against corruption by
4444CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004445
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447Linux Support:
4448==============
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk2729af92004-05-03 20:45:30 +00004450Although U-Boot should support any OS or standalone application
4451easily, the main focus has always been on Linux during the design of
4452U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk2729af92004-05-03 20:45:30 +00004454U-Boot includes many features that so far have been part of some
4455special "boot loader" code within the Linux kernel. Also, any
4456"initrd" images to be used are no longer part of one big Linux image;
4457instead, kernel and "initrd" are separate images. This implementation
4458serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460- the same features can be used for other OS or standalone
4461 applications (for instance: using compressed images to reduce the
4462 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464- it becomes much easier to port new Linux kernel versions because
4465 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467- the same Linux kernel image can now be used with different "initrd"
4468 images; of course this also means that different kernel images can
4469 be run with the same "initrd". This makes testing easier (you don't
4470 have to build a new "zImage.initrd" Linux image when you just
4471 change a file in your "initrd"). Also, a field-upgrade of the
4472 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004473
wdenkc6097192002-11-03 00:24:07 +00004474
wdenk2729af92004-05-03 20:45:30 +00004475Linux HOWTO:
4476============
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk2729af92004-05-03 20:45:30 +00004478Porting Linux to U-Boot based systems:
4479---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk2729af92004-05-03 20:45:30 +00004481U-Boot cannot save you from doing all the necessary modifications to
4482configure the Linux device drivers for use with your target hardware
4483(no, we don't intend to provide a full virtual machine interface to
4484Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004485
Stefan Roesea47a12b2010-04-15 16:07:28 +02004486But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488Just make sure your machine specific header file (for instance
4489include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004490Information structure as we define in include/asm-<arch>/u-boot.h,
4491and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004492as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004493
Simon Glass2eb31b12014-06-11 23:29:46 -06004494Note that U-Boot now has a driver model, a unified model for drivers.
4495If you are adding a new driver, plumb it into driver model. If there
4496is no uclass available, you are encouraged to create one. See
4497doc/driver-model.
4498
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk2729af92004-05-03 20:45:30 +00004500Configuring the Linux kernel:
4501-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk2729af92004-05-03 20:45:30 +00004503No specific requirements for U-Boot. Make sure you have some root
4504device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004505
wdenkc6097192002-11-03 00:24:07 +00004506
wdenk2729af92004-05-03 20:45:30 +00004507Building a Linux Image:
4508-----------------------
wdenkc6097192002-11-03 00:24:07 +00004509
wdenk2729af92004-05-03 20:45:30 +00004510With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4511not used. If you use recent kernel source, a new build target
4512"uImage" will exist which automatically builds an image usable by
4513U-Boot. Most older kernels also have support for a "pImage" target,
4514which was introduced for our predecessor project PPCBoot and uses a
4515100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk2729af92004-05-03 20:45:30 +00004517Example:
wdenkc6097192002-11-03 00:24:07 +00004518
Holger Freytherab584d62014-08-04 09:26:05 +02004519 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004520 make oldconfig
4521 make dep
4522 make uImage
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524The "uImage" build target uses a special tool (in 'tools/mkimage') to
4525encapsulate a compressed Linux kernel image with header information,
4526CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk2729af92004-05-03 20:45:30 +00004528* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004529
wdenk2729af92004-05-03 20:45:30 +00004530* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk2729af92004-05-03 20:45:30 +00004532 ${CROSS_COMPILE}-objcopy -O binary \
4533 -R .note -R .comment \
4534 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk2729af92004-05-03 20:45:30 +00004538 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004541
wdenk2729af92004-05-03 20:45:30 +00004542 mkimage -A ppc -O linux -T kernel -C gzip \
4543 -a 0 -e 0 -n "Linux Kernel Image" \
4544 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004545
wdenk24ee89b2002-11-03 17:56:27 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547The "mkimage" tool can also be used to create ramdisk images for use
4548with U-Boot, either separated from the Linux kernel image, or
4549combined into one file. "mkimage" encapsulates the images with a 64
4550byte header containing information about target architecture,
4551operating system, image type, compression method, entry points, time
4552stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004553
wdenk2729af92004-05-03 20:45:30 +00004554"mkimage" can be called in two ways: to verify existing images and
4555print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004556
wdenk2729af92004-05-03 20:45:30 +00004557In the first form (with "-l" option) mkimage lists the information
4558contained in the header of an existing U-Boot image; this includes
4559checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004560
wdenk2729af92004-05-03 20:45:30 +00004561 tools/mkimage -l image
4562 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004563
wdenk2729af92004-05-03 20:45:30 +00004564The second form (with "-d" option) is used to build a U-Boot image
4565from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004566
wdenk2729af92004-05-03 20:45:30 +00004567 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4568 -n name -d data_file image
4569 -A ==> set architecture to 'arch'
4570 -O ==> set operating system to 'os'
4571 -T ==> set image type to 'type'
4572 -C ==> set compression type 'comp'
4573 -a ==> set load address to 'addr' (hex)
4574 -e ==> set entry point to 'ep' (hex)
4575 -n ==> set image name to 'name'
4576 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004577
wdenk69459792004-05-29 16:53:29 +00004578Right now, all Linux kernels for PowerPC systems use the same load
4579address (0x00000000), but the entry point address depends on the
4580kernel version:
wdenkc6097192002-11-03 00:24:07 +00004581
wdenk2729af92004-05-03 20:45:30 +00004582- 2.2.x kernels have the entry point at 0x0000000C,
4583- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004584
wdenk2729af92004-05-03 20:45:30 +00004585So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4588 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004589 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004590 > examples/uImage.TQM850L
4591 Image Name: 2.4.4 kernel for TQM850L
4592 Created: Wed Jul 19 02:34:59 2000
4593 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4594 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4595 Load Address: 0x00000000
4596 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600 -> tools/mkimage -l examples/uImage.TQM850L
4601 Image Name: 2.4.4 kernel for TQM850L
4602 Created: Wed Jul 19 02:34:59 2000
4603 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4604 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4605 Load Address: 0x00000000
4606 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608NOTE: for embedded systems where boot time is critical you can trade
4609speed for memory and install an UNCOMPRESSED image instead: this
4610needs more space in Flash, but boots much faster since it does not
4611need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004612
Stefan Roesea47a12b2010-04-15 16:07:28 +02004613 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004614 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4615 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004616 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004617 > examples/uImage.TQM850L-uncompressed
4618 Image Name: 2.4.4 kernel for TQM850L
4619 Created: Wed Jul 19 02:34:59 2000
4620 Image Type: PowerPC Linux Kernel Image (uncompressed)
4621 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4622 Load Address: 0x00000000
4623 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004624
wdenkc6097192002-11-03 00:24:07 +00004625
wdenk2729af92004-05-03 20:45:30 +00004626Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4627when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004628
wdenk2729af92004-05-03 20:45:30 +00004629 -> tools/mkimage -n 'Simple Ramdisk Image' \
4630 > -A ppc -O linux -T ramdisk -C gzip \
4631 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4632 Image Name: Simple Ramdisk Image
4633 Created: Wed Jan 12 14:01:50 2000
4634 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4635 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4636 Load Address: 0x00000000
4637 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004638
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004639The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4640option performs the converse operation of the mkimage's second form (the "-d"
4641option). Given an image built by mkimage, the dumpimage extracts a "data file"
4642from the image:
4643
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004644 tools/dumpimage -i image -T type -p position data_file
4645 -i ==> extract from the 'image' a specific 'data_file'
4646 -T ==> set image type to 'type'
4647 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004648
wdenkdb01a2e2004-04-15 23:14:49 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650Installing a Linux Image:
4651-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004652
wdenk2729af92004-05-03 20:45:30 +00004653To downloading a U-Boot image over the serial (console) interface,
4654you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004655
wdenk2729af92004-05-03 20:45:30 +00004656 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004657
wdenk2729af92004-05-03 20:45:30 +00004658The 'objcopy' does not understand the information in the U-Boot
4659image header, so the resulting S-Record file will be relative to
4660address 0x00000000. To load it to a given address, you need to
4661specify the target address as 'offset' parameter with the 'loads'
4662command.
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk2729af92004-05-03 20:45:30 +00004664Example: install the image to address 0x40100000 (which on the
4665TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004666
wdenk2729af92004-05-03 20:45:30 +00004667 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004668
wdenk2729af92004-05-03 20:45:30 +00004669 .......... done
4670 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672 => loads 40100000
4673 ## Ready for S-Record download ...
4674 ~>examples/image.srec
4675 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4676 ...
4677 15989 15990 15991 15992
4678 [file transfer complete]
4679 [connected]
4680 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004681
4682
wdenk2729af92004-05-03 20:45:30 +00004683You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004684this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004685corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk2729af92004-05-03 20:45:30 +00004687 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689 ## Checking Image at 40100000 ...
4690 Image Name: 2.2.13 for initrd on TQM850L
4691 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4692 Data Size: 335725 Bytes = 327 kB = 0 MB
4693 Load Address: 00000000
4694 Entry Point: 0000000c
4695 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004696
4697
wdenk2729af92004-05-03 20:45:30 +00004698Boot Linux:
4699-----------
wdenkc6097192002-11-03 00:24:07 +00004700
wdenk2729af92004-05-03 20:45:30 +00004701The "bootm" command is used to boot an application that is stored in
4702memory (RAM or Flash). In case of a Linux kernel image, the contents
4703of the "bootargs" environment variable is passed to the kernel as
4704parameters. You can check and modify this variable using the
4705"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004706
4707
wdenk2729af92004-05-03 20:45:30 +00004708 => printenv bootargs
4709 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004710
wdenk2729af92004-05-03 20:45:30 +00004711 => 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 +00004712
wdenk2729af92004-05-03 20:45:30 +00004713 => printenv bootargs
4714 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 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716 => bootm 40020000
4717 ## Booting Linux kernel at 40020000 ...
4718 Image Name: 2.2.13 for NFS on TQM850L
4719 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4720 Data Size: 381681 Bytes = 372 kB = 0 MB
4721 Load Address: 00000000
4722 Entry Point: 0000000c
4723 Verifying Checksum ... OK
4724 Uncompressing Kernel Image ... OK
4725 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
4726 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4727 time_init: decrementer frequency = 187500000/60
4728 Calibrating delay loop... 49.77 BogoMIPS
4729 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4730 ...
wdenkc6097192002-11-03 00:24:07 +00004731
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004732If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004733the memory addresses of both the kernel and the initrd image (PPBCOOT
4734format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004735
wdenk2729af92004-05-03 20:45:30 +00004736 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738 ## Checking Image at 40100000 ...
4739 Image Name: 2.2.13 for initrd on TQM850L
4740 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4741 Data Size: 335725 Bytes = 327 kB = 0 MB
4742 Load Address: 00000000
4743 Entry Point: 0000000c
4744 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004745
wdenk2729af92004-05-03 20:45:30 +00004746 ## Checking Image at 40200000 ...
4747 Image Name: Simple Ramdisk Image
4748 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4749 Data Size: 566530 Bytes = 553 kB = 0 MB
4750 Load Address: 00000000
4751 Entry Point: 00000000
4752 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk2729af92004-05-03 20:45:30 +00004754 => bootm 40100000 40200000
4755 ## Booting Linux kernel at 40100000 ...
4756 Image Name: 2.2.13 for initrd on TQM850L
4757 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4758 Data Size: 335725 Bytes = 327 kB = 0 MB
4759 Load Address: 00000000
4760 Entry Point: 0000000c
4761 Verifying Checksum ... OK
4762 Uncompressing Kernel Image ... OK
4763 ## Loading RAMDisk Image at 40200000 ...
4764 Image Name: Simple Ramdisk Image
4765 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4766 Data Size: 566530 Bytes = 553 kB = 0 MB
4767 Load Address: 00000000
4768 Entry Point: 00000000
4769 Verifying Checksum ... OK
4770 Loading Ramdisk ... OK
4771 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
4772 Boot arguments: root=/dev/ram
4773 time_init: decrementer frequency = 187500000/60
4774 Calibrating delay loop... 49.77 BogoMIPS
4775 ...
4776 RAMDISK: Compressed image found at block 0
4777 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779 bash#
wdenkc6097192002-11-03 00:24:07 +00004780
Matthew McClintock02677682006-06-28 10:41:37 -05004781Boot Linux and pass a flat device tree:
4782-----------
4783
4784First, U-Boot must be compiled with the appropriate defines. See the section
4785titled "Linux Kernel Interface" above for a more in depth explanation. The
4786following is an example of how to start a kernel and pass an updated
4787flat device tree:
4788
4789=> print oftaddr
4790oftaddr=0x300000
4791=> print oft
4792oft=oftrees/mpc8540ads.dtb
4793=> tftp $oftaddr $oft
4794Speed: 1000, full duplex
4795Using TSEC0 device
4796TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4797Filename 'oftrees/mpc8540ads.dtb'.
4798Load address: 0x300000
4799Loading: #
4800done
4801Bytes transferred = 4106 (100a hex)
4802=> tftp $loadaddr $bootfile
4803Speed: 1000, full duplex
4804Using TSEC0 device
4805TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4806Filename 'uImage'.
4807Load address: 0x200000
4808Loading:############
4809done
4810Bytes transferred = 1029407 (fb51f hex)
4811=> print loadaddr
4812loadaddr=200000
4813=> print oftaddr
4814oftaddr=0x300000
4815=> bootm $loadaddr - $oftaddr
4816## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004817 Image Name: Linux-2.6.17-dirty
4818 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4819 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004820 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004821 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004822 Verifying Checksum ... OK
4823 Uncompressing Kernel Image ... OK
4824Booting using flat device tree at 0x300000
4825Using MPC85xx ADS machine description
4826Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4827[snip]
4828
4829
wdenk2729af92004-05-03 20:45:30 +00004830More About U-Boot Image Types:
4831------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004832
wdenk2729af92004-05-03 20:45:30 +00004833U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004834
wdenk2729af92004-05-03 20:45:30 +00004835 "Standalone Programs" are directly runnable in the environment
4836 provided by U-Boot; it is expected that (if they behave
4837 well) you can continue to work in U-Boot after return from
4838 the Standalone Program.
4839 "OS Kernel Images" are usually images of some Embedded OS which
4840 will take over control completely. Usually these programs
4841 will install their own set of exception handlers, device
4842 drivers, set up the MMU, etc. - this means, that you cannot
4843 expect to re-enter U-Boot except by resetting the CPU.
4844 "RAMDisk Images" are more or less just data blocks, and their
4845 parameters (address, size) are passed to an OS kernel that is
4846 being started.
4847 "Multi-File Images" contain several images, typically an OS
4848 (Linux) kernel image and one or more data images like
4849 RAMDisks. This construct is useful for instance when you want
4850 to boot over the network using BOOTP etc., where the boot
4851 server provides just a single image file, but you want to get
4852 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004853
wdenk2729af92004-05-03 20:45:30 +00004854 "Multi-File Images" start with a list of image sizes, each
4855 image size (in bytes) specified by an "uint32_t" in network
4856 byte order. This list is terminated by an "(uint32_t)0".
4857 Immediately after the terminating 0 follow the images, one by
4858 one, all aligned on "uint32_t" boundaries (size rounded up to
4859 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004860
wdenk2729af92004-05-03 20:45:30 +00004861 "Firmware Images" are binary images containing firmware (like
4862 U-Boot or FPGA images) which usually will be programmed to
4863 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004864
wdenk2729af92004-05-03 20:45:30 +00004865 "Script files" are command sequences that will be executed by
4866 U-Boot's command interpreter; this feature is especially
4867 useful when you configure U-Boot to use a real shell (hush)
4868 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004869
Marek Vasut44f074c2012-03-14 21:52:45 +00004870Booting the Linux zImage:
4871-------------------------
4872
4873On some platforms, it's possible to boot Linux zImage. This is done
4874using the "bootz" command. The syntax of "bootz" command is the same
4875as the syntax of "bootm" command.
4876
Tom Rini8ac28562013-05-16 11:40:11 -04004877Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004878kernel with raw initrd images. The syntax is slightly different, the
4879address of the initrd must be augmented by it's size, in the following
4880format: "<initrd addres>:<initrd size>".
4881
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk2729af92004-05-03 20:45:30 +00004883Standalone HOWTO:
4884=================
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk2729af92004-05-03 20:45:30 +00004886One of the features of U-Boot is that you can dynamically load and
4887run "standalone" applications, which can use some resources of
4888U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk2729af92004-05-03 20:45:30 +00004892"Hello World" Demo:
4893-------------------
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk2729af92004-05-03 20:45:30 +00004895'examples/hello_world.c' contains a small "Hello World" Demo
4896application; it is automatically compiled when you build U-Boot.
4897It's configured to run at address 0x00040004, so you can play with it
4898like that:
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900 => loads
4901 ## Ready for S-Record download ...
4902 ~>examples/hello_world.srec
4903 1 2 3 4 5 6 7 8 9 10 11 ...
4904 [file transfer complete]
4905 [connected]
4906 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk2729af92004-05-03 20:45:30 +00004908 => go 40004 Hello World! This is a test.
4909 ## Starting application at 0x00040004 ...
4910 Hello World
4911 argc = 7
4912 argv[0] = "40004"
4913 argv[1] = "Hello"
4914 argv[2] = "World!"
4915 argv[3] = "This"
4916 argv[4] = "is"
4917 argv[5] = "a"
4918 argv[6] = "test."
4919 argv[7] = "<NULL>"
4920 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004921
wdenk2729af92004-05-03 20:45:30 +00004922 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk2729af92004-05-03 20:45:30 +00004924Another example, which demonstrates how to register a CPM interrupt
4925handler with the U-Boot code, can be found in 'examples/timer.c'.
4926Here, a CPM timer is set up to generate an interrupt every second.
4927The interrupt service routine is trivial, just printing a '.'
4928character, but this is just a demo program. The application can be
4929controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931 ? - print current values og the CPM Timer registers
4932 b - enable interrupts and start timer
4933 e - stop timer and disable interrupts
4934 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936 => loads
4937 ## Ready for S-Record download ...
4938 ~>examples/timer.srec
4939 1 2 3 4 5 6 7 8 9 10 11 ...
4940 [file transfer complete]
4941 [connected]
4942 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk2729af92004-05-03 20:45:30 +00004944 => go 40004
4945 ## Starting application at 0x00040004 ...
4946 TIMERS=0xfff00980
4947 Using timer 1
4948 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk2729af92004-05-03 20:45:30 +00004950Hit 'b':
4951 [q, b, e, ?] Set interval 1000000 us
4952 Enabling timer
4953Hit '?':
4954 [q, b, e, ?] ........
4955 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4956Hit '?':
4957 [q, b, e, ?] .
4958 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4959Hit '?':
4960 [q, b, e, ?] .
4961 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4962Hit '?':
4963 [q, b, e, ?] .
4964 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4965Hit 'e':
4966 [q, b, e, ?] ...Stopping timer
4967Hit 'q':
4968 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004969
4970
wdenk2729af92004-05-03 20:45:30 +00004971Minicom warning:
4972================
wdenk85ec0bc2003-03-31 16:34:49 +00004973
wdenk2729af92004-05-03 20:45:30 +00004974Over time, many people have reported problems when trying to use the
4975"minicom" terminal emulation program for serial download. I (wd)
4976consider minicom to be broken, and recommend not to use it. Under
4977Unix, I recommend to use C-Kermit for general purpose use (and
4978especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004979use "cu" for S-Record download ("loads" command). See
4980http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4981for help with kermit.
4982
wdenk85ec0bc2003-03-31 16:34:49 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984Nevertheless, if you absolutely want to use it try adding this
4985configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004986
wdenk2729af92004-05-03 20:45:30 +00004987 Name Program Name U/D FullScr IO-Red. Multi
4988 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4989 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004990
4991
wdenk2729af92004-05-03 20:45:30 +00004992NetBSD Notes:
4993=============
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk2729af92004-05-03 20:45:30 +00004995Starting at version 0.9.2, U-Boot supports NetBSD both as host
4996(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004997
wdenk2729af92004-05-03 20:45:30 +00004998Building requires a cross environment; it is known to work on
4999NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5000need gmake since the Makefiles are not compatible with BSD make).
5001Note that the cross-powerpc package does not install include files;
5002attempting to build U-Boot will fail because <machine/ansi.h> is
5003missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005 # cd /usr/pkg/cross/powerpc-netbsd/include
5006 # mkdir powerpc
5007 # ln -s powerpc machine
5008 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5009 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011Native builds *don't* work due to incompatibilities between native
5012and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk2729af92004-05-03 20:45:30 +00005014Booting assumes that (the first part of) the image booted is a
5015stage-2 loader which in turn loads and then invokes the kernel
5016proper. Loader sources will eventually appear in the NetBSD source
5017tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005018meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005019
5020
wdenk2729af92004-05-03 20:45:30 +00005021Implementation Internals:
5022=========================
wdenkc6097192002-11-03 00:24:07 +00005023
wdenk2729af92004-05-03 20:45:30 +00005024The following is not intended to be a complete description of every
5025implementation detail. However, it should help to understand the
5026inner workings of U-Boot and make it easier to port it to custom
5027hardware.
wdenkc6097192002-11-03 00:24:07 +00005028
5029
wdenk2729af92004-05-03 20:45:30 +00005030Initial Stack, Global Data:
5031---------------------------
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033The implementation of U-Boot is complicated by the fact that U-Boot
5034starts running out of ROM (flash memory), usually without access to
5035system RAM (because the memory controller is not initialized yet).
5036This means that we don't have writable Data or BSS segments, and BSS
5037is not initialized as zero. To be able to get a C environment working
5038at all, we have to allocate at least a minimal stack. Implementation
5039options for this are defined and restricted by the CPU used: Some CPU
5040models provide on-chip memory (like the IMMR area on MPC8xx and
5041MPC826x processors), on others (parts of) the data cache can be
5042locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005043
Wolfgang Denk218ca722008-03-26 10:40:12 +01005044 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005045 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5048 From: "Chris Hallinan" <clh@net1plus.com>
5049 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5050 ...
wdenk43d96162003-03-06 00:02:04 +00005051
wdenk2729af92004-05-03 20:45:30 +00005052 Correct me if I'm wrong, folks, but the way I understand it
5053 is this: Using DCACHE as initial RAM for Stack, etc, does not
5054 require any physical RAM backing up the cache. The cleverness
5055 is that the cache is being used as a temporary supply of
5056 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005057 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005058 can see how this works by studying the cache architecture and
5059 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5062 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005063 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005064 option should work for you. Using CS 4 should be fine if your
5065 board designers haven't used it for something that would
5066 cause you grief during the initial boot! It is frequently not
5067 used.
wdenk43d96162003-03-06 00:02:04 +00005068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005069 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005070 with your processor/board/system design. The default value
5071 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005072 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005073 than your SDRAM module. If you have a 64MB SDRAM module, set
5074 it above 400_0000. Just make sure your board has no resources
5075 that are supposed to respond to that address! That code in
5076 start.S has been around a while and should work as is when
5077 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005078
wdenk2729af92004-05-03 20:45:30 +00005079 -Chris Hallinan
5080 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082It is essential to remember this, since it has some impact on the C
5083code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085* Initialized global data (data segment) is read-only. Do not attempt
5086 to write it.
wdenkc6097192002-11-03 00:24:07 +00005087
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005088* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00005089 as zero data - BSS segment) at all - this is undefined, initiali-
5090 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092* Stack space is very limited. Avoid big data buffers or things like
5093 that.
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005096normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00005097turned out that the implementation of U-Boot can be greatly
5098simplified by making a global data structure (gd_t) available to all
5099functions. We could pass a pointer to this data as argument to _all_
5100functions, but this would bloat the code. Instead we use a feature of
5101the GCC compiler (Global Register Variables) to share the data: we
5102place a pointer (gd) to the global data into a register which we
5103reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005104
wdenk2729af92004-05-03 20:45:30 +00005105When choosing a register for such a purpose we are restricted by the
5106relevant (E)ABI specifications for the current architecture, and by
5107GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005108
wdenk2729af92004-05-03 20:45:30 +00005109For PowerPC, the following registers have specific use:
5110 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005111 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005112 R3-R4: parameter passing and return values
5113 R5-R10: parameter passing
5114 R13: small data area pointer
5115 R30: GOT pointer
5116 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005117
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005118 (U-Boot also uses R12 as internal GOT pointer. r12
5119 is a volatile register so r12 needs to be reset when
5120 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005121
Wolfgang Denke7670f62008-02-14 22:43:22 +01005122 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk2729af92004-05-03 20:45:30 +00005124 Note: on PPC, we could use a static initializer (since the
5125 address of the global data structure is known at compile time),
5126 but it turned out that reserving a register results in somewhat
5127 smaller code - although the code savings are not that big (on
5128 average for all boards 752 bytes for the whole U-Boot image,
5129 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk2729af92004-05-03 20:45:30 +00005133 R0: function argument word/integer result
5134 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005135 R9: platform specific
5136 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005137 R11: argument (frame) pointer
5138 R12: temporary workspace
5139 R13: stack pointer
5140 R14: link register
5141 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005142
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005143 ==> U-Boot will use R9 to hold a pointer to the global data
5144
5145 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005146
Thomas Chou0df01fd2010-05-21 11:08:03 +08005147On Nios II, the ABI is documented here:
5148 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5149
5150 ==> U-Boot will use gp to hold a pointer to the global data
5151
5152 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5153 to access small data sections, so gp is free.
5154
Macpaul Linafc1ce82011-10-19 20:41:11 +00005155On NDS32, the following registers are used:
5156
5157 R0-R1: argument/return
5158 R2-R5: argument
5159 R15: temporary register for assembler
5160 R16: trampoline register
5161 R28: frame pointer (FP)
5162 R29: global pointer (GP)
5163 R30: link register (LP)
5164 R31: stack pointer (SP)
5165 PC: program counter (PC)
5166
5167 ==> U-Boot will use R10 to hold a pointer to the global data
5168
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005169NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5170or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk2729af92004-05-03 20:45:30 +00005172Memory Management:
5173------------------
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175U-Boot runs in system state and uses physical addresses, i.e. the
5176MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178The available memory is mapped to fixed addresses using the memory
5179controller. In this process, a contiguous block is formed for each
5180memory type (Flash, SDRAM, SRAM), even when it consists of several
5181physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005182
wdenk2729af92004-05-03 20:45:30 +00005183U-Boot is installed in the first 128 kB of the first Flash bank (on
5184TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5185booting and sizing and initializing DRAM, the code relocates itself
5186to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005187memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005188configuration setting]. Below that, a structure with global Board
5189Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk2729af92004-05-03 20:45:30 +00005191Additionally, some exception handler code is copied to the low 8 kB
5192of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk2729af92004-05-03 20:45:30 +00005194So a typical memory configuration with 16 MB of DRAM could look like
5195this:
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk2729af92004-05-03 20:45:30 +00005197 0x0000 0000 Exception Vector code
5198 :
5199 0x0000 1FFF
5200 0x0000 2000 Free for Application Use
5201 :
5202 :
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204 :
5205 :
5206 0x00FB FF20 Monitor Stack (Growing downward)
5207 0x00FB FFAC Board Info Data and permanent copy of global data
5208 0x00FC 0000 Malloc Arena
5209 :
5210 0x00FD FFFF
5211 0x00FE 0000 RAM Copy of Monitor Code
5212 ... eventually: LCD or video framebuffer
5213 ... eventually: pRAM (Protected RAM - unchanged by reset)
5214 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005215
5216
wdenk2729af92004-05-03 20:45:30 +00005217System Initialization:
5218----------------------
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk2729af92004-05-03 20:45:30 +00005220In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005221(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005222configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005223To be able to re-map memory U-Boot then jumps to its link address.
5224To be able to implement the initialization code in C, a (small!)
5225initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02005226which provide such a feature like), or in a locked part of the data
5227cache. After that, U-Boot initializes the CPU core, the caches and
5228the SIU.
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230Next, all (potentially) available memory banks are mapped using a
5231preliminary mapping. For example, we put them on 512 MB boundaries
5232(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5233on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5234programmed for SDRAM access. Using the temporary configuration, a
5235simple memory test is run that determines the size of the SDRAM
5236banks.
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk2729af92004-05-03 20:45:30 +00005238When there is more than one SDRAM bank, and the banks are of
5239different size, the largest is mapped first. For equal size, the first
5240bank (CS2#) is mapped first. The first mapping is always for address
52410x00000000, with any additional banks following immediately to create
5242contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244Then, the monitor installs itself at the upper end of the SDRAM area
5245and allocates memory for use by malloc() and for the global Board
5246Info data; also, the exception vector code is copied to the low RAM
5247pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk2729af92004-05-03 20:45:30 +00005249Only after this relocation will you have a "normal" C environment;
5250until that you are restricted in several ways, mostly because you are
5251running from ROM, and because the code will have to be relocated to a
5252new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005253
5254
wdenk2729af92004-05-03 20:45:30 +00005255U-Boot Porting Guide:
5256----------------------
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5259list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005260
5261
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005262int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005263{
5264 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005265
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005266 signal(SIGALRM, no_more_time);
5267 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005270 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005271 return 0;
5272 }
5273
wdenk2729af92004-05-03 20:45:30 +00005274 Download latest U-Boot source;
5275
Wolfgang Denk06682362008-12-30 22:56:11 +01005276 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005277
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005278 if (clueless)
5279 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk2729af92004-05-03 20:45:30 +00005281 while (learning) {
5282 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005283 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5284 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005285 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005286 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005287 }
wdenkc6097192002-11-03 00:24:07 +00005288
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005289 if (available_money > toLocalCurrency ($2500))
5290 Buy a BDI3000;
5291 else
wdenk2729af92004-05-03 20:45:30 +00005292 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005293
5294 if (a similar board exists) { /* hopefully... */
5295 cp -a board/<similar> board/<myboard>
5296 cp include/configs/<similar>.h include/configs/<myboard>.h
5297 } else {
5298 Create your own board support subdirectory;
5299 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005300 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005301 Edit new board/<myboard> files
5302 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005303
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005304 while (!accepted) {
5305 while (!running) {
5306 do {
5307 Add / modify source code;
5308 } until (compiles);
5309 Debug;
5310 if (clueless)
5311 email("Hi, I am having problems...");
5312 }
5313 Send patch file to the U-Boot email list;
5314 if (reasonable critiques)
5315 Incorporate improvements from email list code review;
5316 else
5317 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005318 }
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk2729af92004-05-03 20:45:30 +00005320 return 0;
5321}
5322
5323void no_more_time (int sig)
5324{
5325 hire_a_guru();
5326}
wdenkc6097192002-11-03 00:24:07 +00005327
5328
wdenk2729af92004-05-03 20:45:30 +00005329Coding Standards:
5330-----------------
wdenkc6097192002-11-03 00:24:07 +00005331
wdenk2729af92004-05-03 20:45:30 +00005332All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005333coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005334"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005335
Detlev Zundel2c051652006-09-01 15:39:02 +02005336Source files originating from a different project (for example the
5337MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005338reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005339sources.
5340
5341Please note that U-Boot is implemented in C (and to some small parts in
5342Assembler); no C++ is used, so please do not use C++ style comments (//)
5343in your code.
wdenk2729af92004-05-03 20:45:30 +00005344
5345Please also stick to the following formatting rules:
5346- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005347- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005348- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005349- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005350- do not add trailing empty lines to source files
5351
5352Submissions which do not conform to the standards may be returned
5353with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005354
5355
wdenk2729af92004-05-03 20:45:30 +00005356Submitting Patches:
5357-------------------
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk2729af92004-05-03 20:45:30 +00005359Since the number of patches for U-Boot is growing, we need to
5360establish some rules. Submissions which do not conform to these rules
5361may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005362
Magnus Lilja0d28f342008-08-06 19:32:33 +02005363Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005364
Wolfgang Denk06682362008-12-30 22:56:11 +01005365Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5366see http://lists.denx.de/mailman/listinfo/u-boot
5367
wdenk2729af92004-05-03 20:45:30 +00005368When you send a patch, please include the following information with
5369it:
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk2729af92004-05-03 20:45:30 +00005371* For bug fixes: a description of the bug and how your patch fixes
5372 this bug. Please try to include a way of demonstrating that the
5373 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375* For new features: a description of the feature and your
5376 implementation.
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378* A CHANGELOG entry as plaintext (separate from the patch)
5379
Robert P. J. Day7207b362015-12-19 07:16:10 -05005380* For major contributions, add a MAINTAINERS file with your
5381 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005382
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005383* When you add support for a new board, don't forget to add a
5384 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005385
5386* If your patch adds new configuration options, don't forget to
5387 document these in the README file.
5388
Wolfgang Denk218ca722008-03-26 10:40:12 +01005389* The patch itself. If you are using git (which is *strongly*
5390 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005391 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005392 the U-Boot mailing list, you will avoid most of the common problems
5393 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005394
Wolfgang Denk218ca722008-03-26 10:40:12 +01005395 If you cannot use git, use "diff -purN OLD NEW". If your version of
5396 diff does not support these options, then get the latest version of
5397 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005398
Wolfgang Denk218ca722008-03-26 10:40:12 +01005399 The current directory when running this command shall be the parent
5400 directory of the U-Boot source tree (i. e. please make sure that
5401 your patch includes sufficient directory information for the
5402 affected files).
5403
5404 We prefer patches as plain text. MIME attachments are discouraged,
5405 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005406
5407* If one logical set of modifications affects or creates several
5408 files, all these changes shall be submitted in a SINGLE patch file.
5409
5410* Changesets that contain different, unrelated modifications shall be
5411 submitted as SEPARATE patches, one patch per changeset.
5412
5413
5414Notes:
5415
Simon Glass6de80f22016-07-27 20:33:08 -06005416* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005417 source tree and make sure that no errors or warnings are reported
5418 for any of the boards.
5419
5420* Keep your modifications to the necessary minimum: A patch
5421 containing several unrelated changes or arbitrary reformats will be
5422 returned with a request to re-formatting / split it.
5423
5424* If you modify existing code, make sure that your new code does not
5425 add to the memory footprint of the code ;-) Small is beautiful!
5426 When adding new features, these should compile conditionally only
5427 (using #ifdef), and the resulting code with the new feature
5428 disabled must not need more memory than the old code without your
5429 modification.
wdenk90dc6702005-05-03 14:12:25 +00005430
Wolfgang Denk06682362008-12-30 22:56:11 +01005431* Remember that there is a size limit of 100 kB per message on the
5432 u-boot mailing list. Bigger patches will be moderated. If they are
5433 reasonable and not too big, they will be acknowledged. But patches
5434 bigger than the size limit should be avoided.