blob: 1527dee04063ed71624f87d9c4f7b3d11fd33e24 [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
813 CONFIG_CMD_NAND * NAND support
814 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200815 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600816 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000817 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500818 CONFIG_CMD_PCI * pciinfo
819 CONFIG_CMD_PCMCIA * PCMCIA support
820 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
821 host
822 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000823 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_REGINFO * Register dump
825 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000826 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500827 CONFIG_CMD_SAVES * save S record dump
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500828 CONFIG_CMD_SDRAM * print SDRAM configuration information
829 (requires CONFIG_CMD_I2C)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700830 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liu7d861d92013-02-05 19:05:41 +0800831 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200832 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500833 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000834 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000835 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000836 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
837 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500839 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000840 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200841 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +0200842 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000843
844 EXAMPLE: If you want all functions except of network
845 support you can write:
846
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500847 #include "config_cmd_all.h"
848 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000849
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400850 Other Commands:
851 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000852
853 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500854 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000855 what you (and your U-Boot users) are doing. Data
Heiko Schocher5b8e76c2017-06-07 17:33:09 +0200856 cache cannot be enabled on systems like the
Christophe Leroy907208c2017-07-06 10:23:22 +0200857 8xx (where accesses to the IMMR region must be
wdenk43d96162003-03-06 00:02:04 +0000858 uncached), and it cannot be disabled on all other
859 systems where we (mis-) use the data cache to hold an
860 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000861
862
863 XXX - this list needs to get updated!
864
Simon Glass302a6482016-03-13 19:07:28 -0600865- Removal of commands
866 If no commands are needed to boot, you can disable
867 CONFIG_CMDLINE to remove them. In this case, the command line
868 will not be available, and when U-Boot wants to execute the
869 boot command (on start-up) it will call board_run_command()
870 instead. This can reduce image size significantly for very
871 simple boot procedures.
872
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000873- Regular expression support:
874 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200875 If this variable is defined, U-Boot is linked against
876 the SLRE (Super Light Regular Expression) library,
877 which adds regex support to some commands, as for
878 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000879
Simon Glass45ba8072011-10-15 05:48:20 +0000880- Device tree:
881 CONFIG_OF_CONTROL
882 If this variable is defined, U-Boot will use a device tree
883 to configure its devices, instead of relying on statically
884 compiled #defines in the board file. This option is
885 experimental and only available on a few boards. The device
886 tree is available in the global data as gd->fdt_blob.
887
Simon Glass2c0f79e2011-10-24 19:15:31 +0000888 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700889 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000890
891 CONFIG_OF_EMBED
892 If this variable is defined, U-Boot will embed a device tree
893 binary in its image. This device tree file should be in the
894 board directory and called <soc>-<board>.dts. The binary file
895 is then picked up in board_init_f() and made available through
896 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000897
Simon Glass2c0f79e2011-10-24 19:15:31 +0000898 CONFIG_OF_SEPARATE
899 If this variable is defined, U-Boot will build a device tree
900 binary. It will be called u-boot.dtb. Architecture-specific
901 code will locate it at run-time. Generally this works by:
902
903 cat u-boot.bin u-boot.dtb >image.bin
904
905 and in fact, U-Boot does this for you, creating a file called
906 u-boot-dtb.bin which is useful in the common case. You can
907 still use the individual files if you need something more
908 exotic.
909
Alex Deymo82f766d2017-04-02 01:25:20 -0700910 CONFIG_OF_BOARD
911 If this variable is defined, U-Boot will use the device tree
912 provided by the board at runtime instead of embedding one with
913 the image. Only boards defining board_fdt_blob_setup() support
914 this option (see include/fdtdec.h file).
915
wdenkc6097192002-11-03 00:24:07 +0000916- Watchdog:
917 CONFIG_WATCHDOG
918 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000919 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200920 specific code for a watchdog. For the 8xx
921 CPUs, the SIU Watchdog feature is enabled in the SYPCR
922 register. When supported for a specific SoC is
923 available, then no further board specific code should
924 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000925
926 CONFIG_HW_WATCHDOG
927 When using a watchdog circuitry external to the used
928 SoC, then define this variable and provide board
929 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000930
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100931 CONFIG_AT91_HW_WDT_TIMEOUT
932 specify the timeout in seconds. default 2 seconds.
933
stroesec1551ea2003-04-04 15:53:41 +0000934- U-Boot Version:
935 CONFIG_VERSION_VARIABLE
936 If this variable is defined, an environment variable
937 named "ver" is created by U-Boot showing the U-Boot
938 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200939 Any change to this variable will be reverted at the
940 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000941
wdenkc6097192002-11-03 00:24:07 +0000942- Real-Time Clock:
943
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500944 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000945 has to be selected, too. Define exactly one of the
946 following options:
947
wdenkc6097192002-11-03 00:24:07 +0000948 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000949 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000950 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000951 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000952 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000953 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200954 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000955 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100956 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000957 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200958 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200959 CONFIG_SYS_RV3029_TCR - enable trickle charger on
960 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000961
wdenkb37c7e52003-06-30 16:24:52 +0000962 Note that if the RTC uses I2C, then the I2C interface
963 must also be configured. See I2C Support, below.
964
Peter Tysere92739d2008-12-17 16:36:21 -0600965- GPIO Support:
966 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600967
Chris Packham5dec49c2010-12-19 10:12:13 +0000968 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
969 chip-ngpio pairs that tell the PCA953X driver the number of
970 pins supported by a particular chip.
971
Peter Tysere92739d2008-12-17 16:36:21 -0600972 Note that if the GPIO device uses I2C, then the I2C interface
973 must also be configured. See I2C Support, below.
974
Simon Glassaa532332014-06-11 23:29:41 -0600975- I/O tracing:
976 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
977 accesses and can checksum them or write a list of them out
978 to memory. See the 'iotrace' command for details. This is
979 useful for testing device drivers since it can confirm that
980 the driver behaves the same way before and after a code
981 change. Currently this is supported on sandbox and arm. To
982 add support for your architecture, add '#include <iotrace.h>'
983 to the bottom of arch/<arch>/include/asm/io.h and test.
984
985 Example output from the 'iotrace stats' command is below.
986 Note that if the trace buffer is exhausted, the checksum will
987 still continue to operate.
988
989 iotrace is enabled
990 Start: 10000000 (buffer start address)
991 Size: 00010000 (buffer size)
992 Offset: 00000120 (current buffer offset)
993 Output: 10000120 (start + offset)
994 Count: 00000018 (number of trace records)
995 CRC32: 9526fb66 (CRC32 of all trace records)
996
wdenkc6097192002-11-03 00:24:07 +0000997- Timestamp Support:
998
wdenk43d96162003-03-06 00:02:04 +0000999 When CONFIG_TIMESTAMP is selected, the timestamp
1000 (date and time) of an image is printed by image
1001 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001003
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001004- Partition Labels (disklabels) Supported:
1005 Zero or more of the following:
1006 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001007 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1008 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1009 bootloader. Note 2TB partition limit; see
1010 disk/part_efi.c
1011 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001012
Simon Glassfc843a02017-05-17 03:25:30 -06001013 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001014 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001015 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001016
1017- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001018 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1019 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001020
wdenk4d13cba2004-03-14 14:09:05 +00001021 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1022 be performed by calling the function
1023 ide_set_reset(int reset)
1024 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001025
1026- ATAPI Support:
1027 CONFIG_ATAPI
1028
1029 Set this to enable ATAPI support.
1030
wdenkc40b2952004-03-13 23:29:43 +00001031- LBA48 Support
1032 CONFIG_LBA48
1033
1034 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001035 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001036 Whithout these , LBA48 support uses 32bit variables and will 'only'
1037 support disks up to 2.1TB.
1038
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001039 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001040 When enabled, makes the IDE subsystem use 64bit sector addresses.
1041 Default is 32bit.
1042
wdenkc6097192002-11-03 00:24:07 +00001043- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001044 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1045 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1046 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001047 maximum numbers of LUNs, SCSI ID's and target
1048 devices.
wdenkc6097192002-11-03 00:24:07 +00001049
Wolfgang Denk93e14592013-10-04 17:43:24 +02001050 The environment variable 'scsidevs' is set to the number of
1051 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001052
wdenkc6097192002-11-03 00:24:07 +00001053- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001054 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001055 Support for Intel 8254x/8257x gigabit chips.
1056
1057 CONFIG_E1000_SPI
1058 Utility code for direct access to the SPI bus on Intel 8257x.
1059 This does not do anything useful unless you set at least one
1060 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1061
1062 CONFIG_E1000_SPI_GENERIC
1063 Allow generic access to the SPI bus on the Intel 8257x, for
1064 example with the "sspi" command.
1065
1066 CONFIG_CMD_E1000
1067 Management command for E1000 devices. When used on devices
1068 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001069
wdenkc6097192002-11-03 00:24:07 +00001070 CONFIG_EEPRO100
1071 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001072 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001073 write routine for first time initialisation.
1074
1075 CONFIG_TULIP
1076 Support for Digital 2114x chips.
1077 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1078 modem chip initialisation (KS8761/QS6611).
1079
1080 CONFIG_NATSEMI
1081 Support for National dp83815 chips.
1082
1083 CONFIG_NS8382X
1084 Support for National dp8382[01] gigabit chips.
1085
wdenk45219c42003-05-12 21:50:16 +00001086- NETWORK Support (other):
1087
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001088 CONFIG_DRIVER_AT91EMAC
1089 Support for AT91RM9200 EMAC.
1090
1091 CONFIG_RMII
1092 Define this to use reduced MII inteface
1093
1094 CONFIG_DRIVER_AT91EMAC_QUIET
1095 If this defined, the driver is quiet.
1096 The driver doen't show link status messages.
1097
Rob Herringefdd7312011-12-15 11:15:49 +00001098 CONFIG_CALXEDA_XGMAC
1099 Support for the Calxeda XGMAC device
1100
Ashok3bb46d22012-10-15 06:20:47 +00001101 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001102 Support for SMSC's LAN91C96 chips.
1103
wdenk45219c42003-05-12 21:50:16 +00001104 CONFIG_LAN91C96_USE_32_BIT
1105 Define this to enable 32 bit addressing
1106
Ashok3bb46d22012-10-15 06:20:47 +00001107 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001108 Support for SMSC's LAN91C111 chip
1109
1110 CONFIG_SMC91111_BASE
1111 Define this to hold the physical address
1112 of the device (I/O space)
1113
1114 CONFIG_SMC_USE_32_BIT
1115 Define this if data bus is 32 bits
1116
1117 CONFIG_SMC_USE_IOFUNCS
1118 Define this to use i/o functions instead of macros
1119 (some hardware wont work with macros)
1120
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001121 CONFIG_DRIVER_TI_EMAC
1122 Support for davinci emac
1123
1124 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1125 Define this if you have more then 3 PHYs.
1126
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001127 CONFIG_FTGMAC100
1128 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1129
1130 CONFIG_FTGMAC100_EGIGA
1131 Define this to use GE link update with gigabit PHY.
1132 Define this if FTGMAC100 is connected to gigabit PHY.
1133 If your system has 10/100 PHY only, it might not occur
1134 wrong behavior. Because PHY usually return timeout or
1135 useless data when polling gigabit status and gigabit
1136 control registers. This behavior won't affect the
1137 correctnessof 10/100 link speed update.
1138
Mike Rapoportc2fff332009-11-11 10:03:03 +02001139 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001140 Support for SMSC's LAN911x and LAN921x chips
1141
Mike Rapoportc2fff332009-11-11 10:03:03 +02001142 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001143 Define this to hold the physical address
1144 of the device (I/O space)
1145
Mike Rapoportc2fff332009-11-11 10:03:03 +02001146 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001147 Define this if data bus is 32 bits
1148
Mike Rapoportc2fff332009-11-11 10:03:03 +02001149 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001150 Define this if data bus is 16 bits. If your processor
1151 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001152 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001153
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001154 CONFIG_SH_ETHER
1155 Support for Renesas on-chip Ethernet controller
1156
1157 CONFIG_SH_ETHER_USE_PORT
1158 Define the number of ports to be used
1159
1160 CONFIG_SH_ETHER_PHY_ADDR
1161 Define the ETH PHY's address
1162
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001163 CONFIG_SH_ETHER_CACHE_WRITEBACK
1164 If this option is set, the driver enables cache flush.
1165
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001166- PWM Support:
1167 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001168 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001169
Vadim Bendebury5e124722011-10-17 08:36:14 +00001170- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001171 CONFIG_TPM
1172 Support TPM devices.
1173
Christophe Ricard0766ad22015-10-06 22:54:41 +02001174 CONFIG_TPM_TIS_INFINEON
1175 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001176 per system is supported at this time.
1177
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001178 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1179 Define the burst count bytes upper limit
1180
Christophe Ricard3aa74082016-01-21 23:27:13 +01001181 CONFIG_TPM_ST33ZP24
1182 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1183
1184 CONFIG_TPM_ST33ZP24_I2C
1185 Support for STMicroelectronics ST33ZP24 I2C devices.
1186 Requires TPM_ST33ZP24 and I2C.
1187
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001188 CONFIG_TPM_ST33ZP24_SPI
1189 Support for STMicroelectronics ST33ZP24 SPI devices.
1190 Requires TPM_ST33ZP24 and SPI.
1191
Dirk Eibachc01939c2013-06-26 15:55:15 +02001192 CONFIG_TPM_ATMEL_TWI
1193 Support for Atmel TWI TPM device. Requires I2C support.
1194
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001195 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001196 Support for generic parallel port TPM devices. Only one device
1197 per system is supported at this time.
1198
1199 CONFIG_TPM_TIS_BASE_ADDRESS
1200 Base address where the generic TPM device is mapped
1201 to. Contemporary x86 systems usually map it at
1202 0xfed40000.
1203
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001204 CONFIG_CMD_TPM
1205 Add tpm monitor functions.
1206 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1207 provides monitor access to authorized functions.
1208
1209 CONFIG_TPM
1210 Define this to enable the TPM support library which provides
1211 functional interfaces to some TPM commands.
1212 Requires support for a TPM device.
1213
1214 CONFIG_TPM_AUTH_SESSIONS
1215 Define this to enable authorized functions in the TPM library.
1216 Requires CONFIG_TPM and CONFIG_SHA1.
1217
wdenkc6097192002-11-03 00:24:07 +00001218- USB Support:
1219 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001220 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001221 CONFIG_USB_UHCI to enable it.
1222 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001223 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001224 storage devices.
1225 Note:
1226 Supported are USB Keyboards and USB Floppy drives
1227 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001228
Simon Glass9ab4ce22012-02-27 10:52:47 +00001229 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1230 txfilltuning field in the EHCI controller on reset.
1231
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001232 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1233 HW module registers.
1234
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001235- USB Device:
1236 Define the below if you wish to use the USB console.
1237 Once firmware is rebuilt from a serial console issue the
1238 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001239 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001240 it has found a new device. The environment variable usbtty
1241 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001242 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001243 Common Device Class Abstract Control Model serial device.
1244 If you select usbtty = gserial you should be able to enumerate
1245 a Linux host by
1246 # modprobe usbserial vendor=0xVendorID product=0xProductID
1247 else if using cdc_acm, simply setting the environment
1248 variable usbtty to be cdc_acm should suffice. The following
1249 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001250
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001251 CONFIG_USB_DEVICE
1252 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001253
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001254 CONFIG_USB_TTY
1255 Define this to have a tty type of device available to
1256 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001257
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301258 CONFIG_USBD_HS
1259 Define this to enable the high speed support for usb
1260 device and usbtty. If this feature is enabled, a routine
1261 int is_usbd_high_speed(void)
1262 also needs to be defined by the driver to dynamically poll
1263 whether the enumeration has succeded at high speed or full
1264 speed.
1265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001266 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001267 Define this if you want stdin, stdout &/or stderr to
1268 be set to usbtty.
1269
Wolfgang Denk386eda02006-06-14 18:14:56 +02001270 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001271 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001272 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001273 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1274 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1275 should pretend to be a Linux device to it's target host.
1276
1277 CONFIG_USBD_MANUFACTURER
1278 Define this string as the name of your company for
1279 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001280
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001281 CONFIG_USBD_PRODUCT_NAME
1282 Define this string as the name of your product
1283 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1284
1285 CONFIG_USBD_VENDORID
1286 Define this as your assigned Vendor ID from the USB
1287 Implementors Forum. This *must* be a genuine Vendor ID
1288 to avoid polluting the USB namespace.
1289 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001290
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001291 CONFIG_USBD_PRODUCTID
1292 Define this as the unique Product ID
1293 for your device
1294 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001295
Igor Grinbergd70a5602011-12-12 12:08:35 +02001296- ULPI Layer Support:
1297 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1298 the generic ULPI layer. The generic layer accesses the ULPI PHY
1299 via the platform viewport, so you need both the genric layer and
1300 the viewport enabled. Currently only Chipidea/ARC based
1301 viewport is supported.
1302 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1303 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001304 If your ULPI phy needs a different reference clock than the
1305 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1306 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001307
1308- MMC Support:
1309 The MMC controller on the Intel PXA is supported. To
1310 enable this define CONFIG_MMC. The MMC can be
1311 accessed from the boot prompt by mapping the device
1312 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001313 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1314 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001315
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001316 CONFIG_SH_MMCIF
1317 Support for Renesas on-chip MMCIF controller
1318
1319 CONFIG_SH_MMCIF_ADDR
1320 Define the base address of MMCIF registers
1321
1322 CONFIG_SH_MMCIF_CLK
1323 Define the clock frequency for MMCIF
1324
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001325 CONFIG_SUPPORT_EMMC_BOOT
1326 Enable some additional features of the eMMC boot partitions.
1327
1328 CONFIG_SUPPORT_EMMC_RPMB
1329 Enable the commands for reading, writing and programming the
1330 key for the Replay Protection Memory Block partition in eMMC.
1331
Tom Rinib3ba6e92013-03-14 05:32:47 +00001332- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001333 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001334 This enables the USB portion of the DFU USB class
1335
1336 CONFIG_CMD_DFU
1337 This enables the command "dfu" which is used to have
1338 U-Boot create a DFU class device via USB. This command
1339 requires that the "dfu_alt_info" environment variable be
1340 set and define the alt settings to expose to the host.
1341
1342 CONFIG_DFU_MMC
1343 This enables support for exposing (e)MMC devices via DFU.
1344
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001345 CONFIG_DFU_NAND
1346 This enables support for exposing NAND devices via DFU.
1347
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301348 CONFIG_DFU_RAM
1349 This enables support for exposing RAM via DFU.
1350 Note: DFU spec refer to non-volatile memory usage, but
1351 allow usages beyond the scope of spec - here RAM usage,
1352 one that would help mostly the developer.
1353
Heiko Schochere7e75c72013-06-12 06:05:51 +02001354 CONFIG_SYS_DFU_DATA_BUF_SIZE
1355 Dfu transfer uses a buffer before writing data to the
1356 raw storage device. Make the size (in bytes) of this buffer
1357 configurable. The size of this buffer is also configurable
1358 through the "dfu_bufsiz" environment variable.
1359
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001360 CONFIG_SYS_DFU_MAX_FILE_SIZE
1361 When updating files rather than the raw storage device,
1362 we use a static buffer to copy the file into and then write
1363 the buffer once we've been given the whole file. Define
1364 this to the maximum filesize (in bytes) for the buffer.
1365 Default is 4 MiB if undefined.
1366
Heiko Schocher001a8312014-03-18 08:09:56 +01001367 DFU_DEFAULT_POLL_TIMEOUT
1368 Poll timeout [ms], is the timeout a device can send to the
1369 host. The host must wait for this timeout before sending
1370 a subsequent DFU_GET_STATUS request to the device.
1371
1372 DFU_MANIFEST_POLL_TIMEOUT
1373 Poll timeout [ms], which the device sends to the host when
1374 entering dfuMANIFEST state. Host waits this timeout, before
1375 sending again an USB request to the device.
1376
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001377- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001378 CONFIG_USB_FUNCTION_FASTBOOT
1379 This enables the USB part of the fastboot gadget
1380
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001381 CONFIG_CMD_FASTBOOT
1382 This enables the command "fastboot" which enables the Android
1383 fastboot mode for the platform's USB device. Fastboot is a USB
1384 protocol for downloading images, flashing and device control
1385 used on Android devices.
1386 See doc/README.android-fastboot for more information.
1387
1388 CONFIG_ANDROID_BOOT_IMAGE
1389 This enables support for booting images which use the Android
1390 image format header.
1391
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001392 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001393 The fastboot protocol requires a large memory buffer for
1394 downloads. Define this to the starting RAM address to use for
1395 downloaded images.
1396
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001397 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001398 The fastboot protocol requires a large memory buffer for
1399 downloads. This buffer should be as large as possible for a
1400 platform. Define this to the size available RAM for fastboot.
1401
Steve Raed1b5ed02014-08-26 11:47:28 -07001402 CONFIG_FASTBOOT_FLASH
1403 The fastboot protocol includes a "flash" command for writing
1404 the downloaded image to a non-volatile storage device. Define
1405 this to enable the "fastboot flash" command.
1406
1407 CONFIG_FASTBOOT_FLASH_MMC_DEV
1408 The fastboot "flash" command requires additional information
1409 regarding the non-volatile storage device. Define this to
1410 the eMMC device that fastboot should use to store the image.
1411
Steve Rae0ff7e582014-12-12 15:51:54 -08001412 CONFIG_FASTBOOT_GPT_NAME
1413 The fastboot "flash" command supports writing the downloaded
1414 image to the Protective MBR and the Primary GUID Partition
1415 Table. (Additionally, this downloaded image is post-processed
1416 to generate and write the Backup GUID Partition Table.)
1417 This occurs when the specified "partition name" on the
1418 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001419 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001420
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001421 CONFIG_FASTBOOT_MBR_NAME
1422 The fastboot "flash" command supports writing the downloaded
1423 image to DOS MBR.
1424 This occurs when the "partition name" specified on the
1425 "fastboot flash" command line matches this value.
1426 If not defined the default value "mbr" is used.
1427
wdenk6705d812004-08-02 23:22:59 +00001428- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001429 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001430 Define these for a default partition on a NAND device
1431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001432 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1433 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001434 Define these for a default partition on a NOR device
1435
wdenkc6097192002-11-03 00:24:07 +00001436- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001437 See Kconfig help for available keyboard drivers.
1438
1439 CONFIG_KEYBOARD
1440
1441 Define this to enable a custom keyboard support.
1442 This simply calls drv_keyboard_init() which must be
1443 defined in your board-specific files. This option is deprecated
1444 and is only used by novena. For new boards, use driver model
1445 instead.
wdenkc6097192002-11-03 00:24:07 +00001446
1447- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001448 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001449 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001450 SOCs that have a DIU should define this macro to enable DIU
1451 support, and should also define these other macros:
1452
1453 CONFIG_SYS_DIU_ADDR
1454 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001455 CONFIG_CFB_CONSOLE
1456 CONFIG_VIDEO_SW_CURSOR
1457 CONFIG_VGA_AS_SINGLE_DEVICE
1458 CONFIG_VIDEO_LOGO
1459 CONFIG_VIDEO_BMP_LOGO
1460
Timur Tabiba8e76b2011-04-11 14:18:22 -05001461 The DIU driver will look for the 'video-mode' environment
1462 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001463 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001464 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001465
wdenkc6097192002-11-03 00:24:07 +00001466- LCD Support: CONFIG_LCD
1467
1468 Define this to enable LCD support (for output to LCD
1469 display); also select one of the supported displays
1470 by defining one of these:
1471
Stelian Pop39cf4802008-05-09 21:57:18 +02001472 CONFIG_ATMEL_LCD:
1473
1474 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1475
wdenkfd3103b2003-11-25 16:55:19 +00001476 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001477
wdenkfd3103b2003-11-25 16:55:19 +00001478 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001479
wdenkfd3103b2003-11-25 16:55:19 +00001480 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001481
wdenkfd3103b2003-11-25 16:55:19 +00001482 NEC NL6448BC20-08. 6.5", 640x480.
1483 Active, color, single scan.
1484
1485 CONFIG_NEC_NL6448BC33_54
1486
1487 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001488 Active, color, single scan.
1489
1490 CONFIG_SHARP_16x9
1491
1492 Sharp 320x240. Active, color, single scan.
1493 It isn't 16x9, and I am not sure what it is.
1494
1495 CONFIG_SHARP_LQ64D341
1496
1497 Sharp LQ64D341 display, 640x480.
1498 Active, color, single scan.
1499
1500 CONFIG_HLD1045
1501
1502 HLD1045 display, 640x480.
1503 Active, color, single scan.
1504
1505 CONFIG_OPTREX_BW
1506
1507 Optrex CBL50840-2 NF-FW 99 22 M5
1508 or
1509 Hitachi LMG6912RPFC-00T
1510 or
1511 Hitachi SP14Q002
1512
1513 320x240. Black & white.
1514
Simon Glass676d3192012-10-17 13:24:54 +00001515 CONFIG_LCD_ALIGNMENT
1516
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001517 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001518 defined then the LCD will be aligned to this value instead.
1519 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1520 here, since it is cheaper to change data cache settings on
1521 a per-section basis.
1522
1523
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001524 CONFIG_LCD_ROTATION
1525
1526 Sometimes, for example if the display is mounted in portrait
1527 mode or even if it's mounted landscape but rotated by 180degree,
1528 we need to rotate our content of the display relative to the
1529 framebuffer, so that user can read the messages which are
1530 printed out.
1531 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1532 initialized with a given rotation from "vl_rot" out of
1533 "vidinfo_t" which is provided by the board specific code.
1534 The value for vl_rot is coded as following (matching to
1535 fbcon=rotate:<n> linux-kernel commandline):
1536 0 = no rotation respectively 0 degree
1537 1 = 90 degree rotation
1538 2 = 180 degree rotation
1539 3 = 270 degree rotation
1540
1541 If CONFIG_LCD_ROTATION is not defined, the console will be
1542 initialized with 0degree rotation.
1543
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001544 CONFIG_LCD_BMP_RLE8
1545
1546 Support drawing of RLE8-compressed bitmaps on the LCD.
1547
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001548 CONFIG_I2C_EDID
1549
1550 Enables an 'i2c edid' command which can read EDID
1551 information over I2C from an attached LCD display.
1552
wdenk7152b1d2003-09-05 23:19:14 +00001553- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001554
wdenk8bde7f72003-06-27 21:31:46 +00001555 If this option is set, the environment is checked for
1556 a variable "splashimage". If found, the usual display
1557 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001558 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001559 specified in "splashimage" is loaded instead. The
1560 console is redirected to the "nulldev", too. This
1561 allows for a "silent" boot where a splash screen is
1562 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001563
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001564 CONFIG_SPLASHIMAGE_GUARD
1565
1566 If this option is set, then U-Boot will prevent the environment
1567 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001568 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001569 This option is useful for targets where, due to alignment
1570 restrictions, an improperly aligned BMP image will cause a data
1571 abort. If you think you will not have problems with unaligned
1572 accesses (for example because your toolchain prevents them)
1573 there is no need to set this option.
1574
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001575 CONFIG_SPLASH_SCREEN_ALIGN
1576
1577 If this option is set the splash image can be freely positioned
1578 on the screen. Environment variable "splashpos" specifies the
1579 position as "x,y". If a positive number is given it is used as
1580 number of pixel from left/top. If a negative number is given it
1581 is used as number of pixel from right/bottom. You can also
1582 specify 'm' for centering the image.
1583
1584 Example:
1585 setenv splashpos m,m
1586 => image at center of screen
1587
1588 setenv splashpos 30,20
1589 => image at x = 30 and y = 20
1590
1591 setenv splashpos -10,m
1592 => vertically centered image
1593 at x = dspWidth - bmpWidth - 9
1594
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001595- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1596
1597 If this option is set, additionally to standard BMP
1598 images, gzipped BMP images can be displayed via the
1599 splashscreen support or the bmp command.
1600
Anatolij Gustschind5011762010-03-15 14:50:25 +01001601- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1602
1603 If this option is set, 8-bit RLE compressed BMP images
1604 can be displayed via the splashscreen support or the
1605 bmp command.
1606
wdenkc29fdfc2003-08-29 20:57:53 +00001607- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001608 CONFIG_GZIP
1609
1610 Enabled by default to support gzip compressed images.
1611
wdenkc29fdfc2003-08-29 20:57:53 +00001612 CONFIG_BZIP2
1613
1614 If this option is set, support for bzip2 compressed
1615 images is included. If not, only uncompressed and gzip
1616 compressed images are supported.
1617
wdenk42d1f032003-10-15 23:53:47 +00001618 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001619 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001620 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001621
wdenk17ea1172004-06-06 21:51:03 +00001622- MII/PHY support:
1623 CONFIG_PHY_ADDR
1624
1625 The address of PHY on MII bus.
1626
1627 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1628
1629 The clock frequency of the MII bus
1630
1631 CONFIG_PHY_GIGE
1632
1633 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001634 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001635
1636 CONFIG_PHY_RESET_DELAY
1637
1638 Some PHY like Intel LXT971A need extra delay after
1639 reset before any MII register access is possible.
1640 For such PHY, set this option to the usec delay
1641 required. (minimum 300usec for LXT971A)
1642
1643 CONFIG_PHY_CMD_DELAY (ppc4xx)
1644
1645 Some PHY like Intel LXT971A need extra delay after
1646 command issued before MII status register can be read
1647
wdenkc6097192002-11-03 00:24:07 +00001648- IP address:
1649 CONFIG_IPADDR
1650
1651 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001652 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001653 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001654 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001655
1656- Server IP address:
1657 CONFIG_SERVERIP
1658
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001659 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001660 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001661 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001662
Robin Getz97cfe862009-07-21 12:15:28 -04001663 CONFIG_KEEP_SERVERADDR
1664
1665 Keeps the server's MAC address, in the env 'serveraddr'
1666 for passing to bootargs (like Linux's netconsole option)
1667
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001668- Gateway IP address:
1669 CONFIG_GATEWAYIP
1670
1671 Defines a default value for the IP address of the
1672 default router where packets to other networks are
1673 sent to.
1674 (Environment variable "gatewayip")
1675
1676- Subnet mask:
1677 CONFIG_NETMASK
1678
1679 Defines a default value for the subnet mask (or
1680 routing prefix) which is used to determine if an IP
1681 address belongs to the local subnet or needs to be
1682 forwarded through a router.
1683 (Environment variable "netmask")
1684
David Updegraff53a5c422007-06-11 10:41:07 -05001685- Multicast TFTP Mode:
1686 CONFIG_MCAST_TFTP
1687
1688 Defines whether you want to support multicast TFTP as per
1689 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001690 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001691 driver in use must provide a function: mcast() to join/leave a
1692 multicast group.
1693
wdenkc6097192002-11-03 00:24:07 +00001694- BOOTP Recovery Mode:
1695 CONFIG_BOOTP_RANDOM_DELAY
1696
1697 If you have many targets in a network that try to
1698 boot using BOOTP, you may want to avoid that all
1699 systems send out BOOTP requests at precisely the same
1700 moment (which would happen for instance at recovery
1701 from a power failure, when all systems will try to
1702 boot, thus flooding the BOOTP server. Defining
1703 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1704 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001705 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001706
1707 1st BOOTP request: delay 0 ... 1 sec
1708 2nd BOOTP request: delay 0 ... 2 sec
1709 3rd BOOTP request: delay 0 ... 4 sec
1710 4th and following
1711 BOOTP requests: delay 0 ... 8 sec
1712
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001713 CONFIG_BOOTP_ID_CACHE_SIZE
1714
1715 BOOTP packets are uniquely identified using a 32-bit ID. The
1716 server will copy the ID from client requests to responses and
1717 U-Boot will use this to determine if it is the destination of
1718 an incoming response. Some servers will check that addresses
1719 aren't in use before handing them out (usually using an ARP
1720 ping) and therefore take up to a few hundred milliseconds to
1721 respond. Network congestion may also influence the time it
1722 takes for a response to make it back to the client. If that
1723 time is too long, U-Boot will retransmit requests. In order
1724 to allow earlier responses to still be accepted after these
1725 retransmissions, U-Boot's BOOTP client keeps a small cache of
1726 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1727 cache. The default is to keep IDs for up to four outstanding
1728 requests. Increasing this will allow U-Boot to accept offers
1729 from a BOOTP client in networks with unusually high latency.
1730
stroesefe389a82003-08-28 14:17:32 +00001731- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001732 You can fine tune the DHCP functionality by defining
1733 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001734
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001735 CONFIG_BOOTP_SUBNETMASK
1736 CONFIG_BOOTP_GATEWAY
1737 CONFIG_BOOTP_HOSTNAME
1738 CONFIG_BOOTP_NISDOMAIN
1739 CONFIG_BOOTP_BOOTPATH
1740 CONFIG_BOOTP_BOOTFILESIZE
1741 CONFIG_BOOTP_DNS
1742 CONFIG_BOOTP_DNS2
1743 CONFIG_BOOTP_SEND_HOSTNAME
1744 CONFIG_BOOTP_NTPSERVER
1745 CONFIG_BOOTP_TIMEOFFSET
1746 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001747 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001748
Wilson Callan5d110f02007-07-28 10:56:13 -04001749 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1750 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001751
Joe Hershberger2c00e092012-05-23 07:59:19 +00001752 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1753 after the configured retry count, the call will fail
1754 instead of starting over. This can be used to fail over
1755 to Link-local IP address configuration if the DHCP server
1756 is not available.
1757
stroesefe389a82003-08-28 14:17:32 +00001758 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1759 serverip from a DHCP server, it is possible that more
1760 than one DNS serverip is offered to the client.
1761 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1762 serverip will be stored in the additional environment
1763 variable "dnsip2". The first DNS serverip is always
1764 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001765 is defined.
stroesefe389a82003-08-28 14:17:32 +00001766
1767 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1768 to do a dynamic update of a DNS server. To do this, they
1769 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001770 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001771 of the "hostname" environment variable is passed as
1772 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001773
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001774 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1775
1776 A 32bit value in microseconds for a delay between
1777 receiving a "DHCP Offer" and sending the "DHCP Request".
1778 This fixes a problem with certain DHCP servers that don't
1779 respond 100% of the time to a "DHCP request". E.g. On an
1780 AT91RM9200 processor running at 180MHz, this delay needed
1781 to be *at least* 15,000 usec before a Windows Server 2003
1782 DHCP server would reply 100% of the time. I recommend at
1783 least 50,000 usec to be safe. The alternative is to hope
1784 that one of the retries will be successful but note that
1785 the DHCP timeout and retry process takes a longer than
1786 this delay.
1787
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001788 - Link-local IP address negotiation:
1789 Negotiate with other link-local clients on the local network
1790 for an address that doesn't require explicit configuration.
1791 This is especially useful if a DHCP server cannot be guaranteed
1792 to exist in all environments that the device must operate.
1793
1794 See doc/README.link-local for more information.
1795
wdenka3d991b2004-04-15 21:48:45 +00001796 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001797 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001798
1799 The device id used in CDP trigger frames.
1800
1801 CONFIG_CDP_DEVICE_ID_PREFIX
1802
1803 A two character string which is prefixed to the MAC address
1804 of the device.
1805
1806 CONFIG_CDP_PORT_ID
1807
1808 A printf format string which contains the ascii name of
1809 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001810 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001811
1812 CONFIG_CDP_CAPABILITIES
1813
1814 A 32bit integer which indicates the device capabilities;
1815 0x00000010 for a normal host which does not forwards.
1816
1817 CONFIG_CDP_VERSION
1818
1819 An ascii string containing the version of the software.
1820
1821 CONFIG_CDP_PLATFORM
1822
1823 An ascii string containing the name of the platform.
1824
1825 CONFIG_CDP_TRIGGER
1826
1827 A 32bit integer sent on the trigger.
1828
1829 CONFIG_CDP_POWER_CONSUMPTION
1830
1831 A 16bit integer containing the power consumption of the
1832 device in .1 of milliwatts.
1833
1834 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1835
1836 A byte containing the id of the VLAN.
1837
Uri Mashiach79267ed2017-01-19 10:51:05 +02001838- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001839
1840 Several configurations allow to display the current
1841 status using a LED. For instance, the LED will blink
1842 fast while running U-Boot code, stop blinking as
1843 soon as a reply to a BOOTP request was received, and
1844 start blinking slow once the Linux kernel is running
1845 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001846 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001847 feature in U-Boot.
1848
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001849 Additional options:
1850
Uri Mashiach79267ed2017-01-19 10:51:05 +02001851 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001852 The status LED can be connected to a GPIO pin.
1853 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001854 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001855 to include the gpio_led driver in the U-Boot binary.
1856
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001857 CONFIG_GPIO_LED_INVERTED_TABLE
1858 Some GPIO connected LEDs may have inverted polarity in which
1859 case the GPIO high value corresponds to LED off state and
1860 GPIO low value corresponds to LED on state.
1861 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1862 with a list of GPIO LEDs that have inverted polarity.
1863
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001864- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001865
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001866 This enable the NEW i2c subsystem, and will allow you to use
1867 i2c commands at the u-boot command line (as long as you set
1868 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1869 based realtime clock chips or other i2c devices. See
1870 common/cmd_i2c.c for a description of the command line
1871 interface.
1872
1873 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001874 - drivers/i2c/soft_i2c.c:
1875 - activate first bus with CONFIG_SYS_I2C_SOFT define
1876 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1877 for defining speed and slave address
1878 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1879 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1880 for defining speed and slave address
1881 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1882 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1883 for defining speed and slave address
1884 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1885 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1886 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001887
Heiko Schocher00f792e2012-10-24 13:48:22 +02001888 - drivers/i2c/fsl_i2c.c:
1889 - activate i2c driver with CONFIG_SYS_I2C_FSL
1890 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1891 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1892 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1893 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001894 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001895 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1896 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1897 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1898 second bus.
1899
Simon Glass1f2ba722012-10-30 07:28:53 +00001900 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001901 - activate this driver with CONFIG_SYS_I2C_TEGRA
1902 - This driver adds 4 i2c buses with a fix speed from
1903 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001904
Dirk Eibach880540d2013-04-25 02:40:01 +00001905 - drivers/i2c/ppc4xx_i2c.c
1906 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1907 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1908 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1909
tremfac96402013-09-21 18:13:35 +02001910 - drivers/i2c/i2c_mxc.c
1911 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001912 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1913 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1914 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1915 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001916 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1917 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1918 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1919 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1920 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1921 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001922 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1923 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001924 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001925 for speed, and 0 for slave.
1926
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001927 - drivers/i2c/rcar_i2c.c:
1928 - activate this driver with CONFIG_SYS_I2C_RCAR
1929 - This driver adds 4 i2c buses
1930
1931 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1932 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1933 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1934 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1935 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1936 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1937 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1938 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1939 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1940
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001941 - drivers/i2c/sh_i2c.c:
1942 - activate this driver with CONFIG_SYS_I2C_SH
1943 - This driver adds from 2 to 5 i2c buses
1944
1945 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1946 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1947 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1948 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1949 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1950 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1951 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1952 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1953 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1954 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001955 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001956
Heiko Schocher6789e842013-10-22 11:03:18 +02001957 - drivers/i2c/omap24xx_i2c.c
1958 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1959 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1960 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1961 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1962 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1963 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1964 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1965 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1966 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1967 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1968 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1969
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001970 - drivers/i2c/zynq_i2c.c
1971 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1972 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1973 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1974
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301975 - drivers/i2c/s3c24x0_i2c.c:
1976 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1977 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1978 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1979 with a fix speed from 100000 and the slave addr 0!
1980
Dirk Eibachb46226b2014-07-03 09:28:18 +02001981 - drivers/i2c/ihs_i2c.c
1982 - activate this driver with CONFIG_SYS_I2C_IHS
1983 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1984 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1985 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1986 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1987 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1988 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1989 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1990 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1991 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1992 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1993 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1994 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001995 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1996 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1997 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1998 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1999 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2000 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2001 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2002 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2003 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002004
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002005 additional defines:
2006
2007 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06002008 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002009
2010 CONFIG_SYS_I2C_DIRECT_BUS
2011 define this, if you don't use i2c muxes on your hardware.
2012 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2013 omit this define.
2014
2015 CONFIG_SYS_I2C_MAX_HOPS
2016 define how many muxes are maximal consecutively connected
2017 on one i2c bus. If you not use i2c muxes, omit this
2018 define.
2019
2020 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002021 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002022 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2023 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2024 CONFIG_SYS_NUM_I2C_BUSES = 9:
2025
2026 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2027 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2028 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2029 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2030 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2031 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2032 {1, {I2C_NULL_HOP}}, \
2033 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2034 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2035 }
2036
2037 which defines
2038 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002039 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2040 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2041 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2042 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2043 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002044 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002045 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2046 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002047
2048 If you do not have i2c muxes on your board, omit this define.
2049
Simon Glassce3b5d62017-05-12 21:10:00 -06002050- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01002051 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002052 then the following macros need to be defined (examples are
2053 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002054
2055 I2C_INIT
2056
wdenkb37c7e52003-06-30 16:24:52 +00002057 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002058 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002059
wdenkba56f622004-02-06 23:19:44 +00002060 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002061
wdenkc6097192002-11-03 00:24:07 +00002062 I2C_ACTIVE
2063
2064 The code necessary to make the I2C data line active
2065 (driven). If the data line is open collector, this
2066 define can be null.
2067
wdenkb37c7e52003-06-30 16:24:52 +00002068 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2069
wdenkc6097192002-11-03 00:24:07 +00002070 I2C_TRISTATE
2071
2072 The code necessary to make the I2C data line tri-stated
2073 (inactive). If the data line is open collector, this
2074 define can be null.
2075
wdenkb37c7e52003-06-30 16:24:52 +00002076 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2077
wdenkc6097192002-11-03 00:24:07 +00002078 I2C_READ
2079
York Sun472d5462013-04-01 11:29:11 -07002080 Code that returns true if the I2C data line is high,
2081 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002082
wdenkb37c7e52003-06-30 16:24:52 +00002083 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2084
wdenkc6097192002-11-03 00:24:07 +00002085 I2C_SDA(bit)
2086
York Sun472d5462013-04-01 11:29:11 -07002087 If <bit> is true, sets the I2C data line high. If it
2088 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002089
wdenkb37c7e52003-06-30 16:24:52 +00002090 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002091 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002092 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002093
wdenkc6097192002-11-03 00:24:07 +00002094 I2C_SCL(bit)
2095
York Sun472d5462013-04-01 11:29:11 -07002096 If <bit> is true, sets the I2C clock line high. If it
2097 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002098
wdenkb37c7e52003-06-30 16:24:52 +00002099 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002100 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002101 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002102
wdenkc6097192002-11-03 00:24:07 +00002103 I2C_DELAY
2104
2105 This delay is invoked four times per clock cycle so this
2106 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002107 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002108 like:
2109
wdenkb37c7e52003-06-30 16:24:52 +00002110 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002111
Mike Frysinger793b5722010-07-21 13:38:02 -04002112 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2113
2114 If your arch supports the generic GPIO framework (asm/gpio.h),
2115 then you may alternatively define the two GPIOs that are to be
2116 used as SCL / SDA. Any of the previous I2C_xxx macros will
2117 have GPIO-based defaults assigned to them as appropriate.
2118
2119 You should define these to the GPIO value as given directly to
2120 the generic GPIO functions.
2121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002122 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002123
wdenk8bde7f72003-06-27 21:31:46 +00002124 When a board is reset during an i2c bus transfer
2125 chips might think that the current transfer is still
2126 in progress. On some boards it is possible to access
2127 the i2c SCLK line directly, either by using the
2128 processor pin as a GPIO or by having a second pin
2129 connected to the bus. If this option is defined a
2130 custom i2c_init_board() routine in boards/xxx/board.c
2131 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002132
Ben Warrenbb99ad62006-09-07 16:50:54 -04002133 CONFIG_I2C_MULTI_BUS
2134
2135 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002136 must have a controller. At any point in time, only one bus is
2137 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002138 Note that bus numbering is zero-based.
2139
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002140 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002141
2142 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002143 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002144 is set, specify a list of bus-device pairs. Otherwise, specify
2145 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002146
2147 e.g.
2148 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002149 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002150
2151 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2152
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002153 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002154 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002155
2156 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2157
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002158 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002159
2160 If defined, then this indicates the I2C bus number for DDR SPD.
2161 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2162
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002163 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002164
2165 If defined, then this indicates the I2C bus number for the RTC.
2166 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2167
Andrew Dyer2ac69852008-12-29 17:36:01 -06002168 CONFIG_SOFT_I2C_READ_REPEATED_START
2169
2170 defining this will force the i2c_read() function in
2171 the soft_i2c driver to perform an I2C repeated start
2172 between writing the address pointer and reading the
2173 data. If this define is omitted the default behaviour
2174 of doing a stop-start sequence will be used. Most I2C
2175 devices can use either method, but some require one or
2176 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002177
wdenkc6097192002-11-03 00:24:07 +00002178- SPI Support: CONFIG_SPI
2179
2180 Enables SPI driver (so far only tested with
2181 SPI EEPROM, also an instance works with Crystal A/D and
2182 D/As on the SACSng board)
2183
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002184 CONFIG_SH_SPI
2185
2186 Enables the driver for SPI controller on SuperH. Currently
2187 only SH7757 is supported.
2188
wdenkc6097192002-11-03 00:24:07 +00002189 CONFIG_SOFT_SPI
2190
wdenk43d96162003-03-06 00:02:04 +00002191 Enables a software (bit-bang) SPI driver rather than
2192 using hardware support. This is a general purpose
2193 driver that only requires three general I/O port pins
2194 (two outputs, one input) to function. If this is
2195 defined, the board configuration must define several
2196 SPI configuration items (port pins to use, etc). For
2197 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002198
Ben Warren04a9e112008-01-16 22:37:35 -05002199 CONFIG_HARD_SPI
2200
2201 Enables a hardware SPI driver for general-purpose reads
2202 and writes. As with CONFIG_SOFT_SPI, the board configuration
2203 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002204 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002205 example, see include/configs/mpc8349emds.h.
2206
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002207 CONFIG_MXC_SPI
2208
2209 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002210 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002211
Heiko Schocherf659b572014-07-14 10:22:11 +02002212 CONFIG_SYS_SPI_MXC_WAIT
2213 Timeout for waiting until spi transfer completed.
2214 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2215
Matthias Fuchs01335022007-12-27 17:12:34 +01002216- FPGA Support: CONFIG_FPGA
2217
2218 Enables FPGA subsystem.
2219
2220 CONFIG_FPGA_<vendor>
2221
2222 Enables support for specific chip vendors.
2223 (ALTERA, XILINX)
2224
2225 CONFIG_FPGA_<family>
2226
2227 Enables support for FPGA family.
2228 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2229
2230 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002231
wdenk43d96162003-03-06 00:02:04 +00002232 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002234 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002235
wdenk8bde7f72003-06-27 21:31:46 +00002236 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002238 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002239
wdenk43d96162003-03-06 00:02:04 +00002240 Enable checks on FPGA configuration interface busy
2241 status by the configuration function. This option
2242 will require a board or device specific function to
2243 be written.
wdenkc6097192002-11-03 00:24:07 +00002244
2245 CONFIG_FPGA_DELAY
2246
2247 If defined, a function that provides delays in the FPGA
2248 configuration driver.
2249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002250 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002251 Allow Control-C to interrupt FPGA configuration
2252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002253 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002254
wdenk43d96162003-03-06 00:02:04 +00002255 Check for configuration errors during FPGA bitfile
2256 loading. For example, abort during Virtex II
2257 configuration if the INIT_B line goes low (which
2258 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002261
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002262 Maximum time to wait for the INIT_B line to de-assert
2263 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002264 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002265 ms.
wdenkc6097192002-11-03 00:24:07 +00002266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002267 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002268
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002269 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002270 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002272 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002273
wdenk43d96162003-03-06 00:02:04 +00002274 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002275 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002276
2277- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002278 CONFIG_BUILD_TARGET
2279
2280 Some SoCs need special image types (e.g. U-Boot binary
2281 with a special header) as build targets. By defining
2282 CONFIG_BUILD_TARGET in the SoC / board header, this
2283 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002284 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002285
wdenkc6097192002-11-03 00:24:07 +00002286 CONFIG_IDENT_STRING
2287
wdenk43d96162003-03-06 00:02:04 +00002288 If defined, this string will be added to the U-Boot
2289 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002290
2291- Vendor Parameter Protection:
2292
wdenk43d96162003-03-06 00:02:04 +00002293 U-Boot considers the values of the environment
2294 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002295 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002296 are set once by the board vendor / manufacturer, and
2297 protects these variables from casual modification by
2298 the user. Once set, these variables are read-only,
2299 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002300 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002301
2302 If CONFIG_ENV_OVERWRITE is #defined in your config
2303 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002304 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002305 these parameters.
2306
Joe Hershberger92ac5202015-05-04 14:55:14 -05002307 Alternatively, if you define _both_ an ethaddr in the
2308 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002309 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002310 which can be changed exactly ONCE by the user. [The
2311 serial# is unaffected by this, i. e. it remains
2312 read-only.]
2313
Joe Hershberger25980902012-12-11 22:16:31 -06002314 The same can be accomplished in a more flexible way
2315 for any variable by configuring the type of access
2316 to allow for those variables in the ".flags" variable
2317 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2318
wdenkc6097192002-11-03 00:24:07 +00002319- Protected RAM:
2320 CONFIG_PRAM
2321
2322 Define this variable to enable the reservation of
2323 "protected RAM", i. e. RAM which is not overwritten
2324 by U-Boot. Define CONFIG_PRAM to hold the number of
2325 kB you want to reserve for pRAM. You can overwrite
2326 this default value by defining an environment
2327 variable "pram" to the number of kB you want to
2328 reserve. Note that the board info structure will
2329 still show the full amount of RAM. If pRAM is
2330 reserved, a new environment variable "mem" will
2331 automatically be defined to hold the amount of
2332 remaining RAM in a form that can be passed as boot
2333 argument to Linux, for instance like that:
2334
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002335 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002336 saveenv
2337
2338 This way you can tell Linux not to use this memory,
2339 either, which results in a memory region that will
2340 not be affected by reboots.
2341
2342 *WARNING* If your board configuration uses automatic
2343 detection of the RAM size, you must make sure that
2344 this memory test is non-destructive. So far, the
2345 following board configurations are known to be
2346 "pRAM-clean":
2347
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002348 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002349 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002350 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002351
Gabe Black40fef042012-12-02 04:55:18 +00002352- Access to physical memory region (> 4GB)
2353 Some basic support is provided for operations on memory not
2354 normally accessible to U-Boot - e.g. some architectures
2355 support access to more than 4GB of memory on 32-bit
2356 machines using physical address extension or similar.
2357 Define CONFIG_PHYSMEM to access this basic support, which
2358 currently only supports clearing the memory.
2359
wdenkc6097192002-11-03 00:24:07 +00002360- Error Recovery:
2361 CONFIG_PANIC_HANG
2362
2363 Define this variable to stop the system in case of a
2364 fatal error, so that you have to reset it manually.
2365 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002367 automatically as fast as possible, but it may be
2368 useful during development since you can try to debug
2369 the conditions that lead to the situation.
2370
2371 CONFIG_NET_RETRY_COUNT
2372
wdenk43d96162003-03-06 00:02:04 +00002373 This variable defines the number of retries for
2374 network operations like ARP, RARP, TFTP, or BOOTP
2375 before giving up the operation. If not defined, a
2376 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002377
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002378 CONFIG_ARP_TIMEOUT
2379
2380 Timeout waiting for an ARP reply in milliseconds.
2381
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002382 CONFIG_NFS_TIMEOUT
2383
2384 Timeout in milliseconds used in NFS protocol.
2385 If you encounter "ERROR: Cannot umount" in nfs command,
2386 try longer timeout such as
2387 #define CONFIG_NFS_TIMEOUT 10000UL
2388
wdenkc6097192002-11-03 00:24:07 +00002389- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002390 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002391
2392 Enable auto completion of commands using TAB.
2393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002395
2396 This defines the secondary prompt string, which is
2397 printed when the command interpreter needs more input
2398 to complete a command. Usually "> ".
2399
2400 Note:
2401
wdenk8bde7f72003-06-27 21:31:46 +00002402 In the current implementation, the local variables
2403 space and global environment variables space are
2404 separated. Local variables are those you define by
2405 simply typing `name=value'. To access a local
2406 variable later on, you have write `$name' or
2407 `${name}'; to execute the contents of a variable
2408 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002409
wdenk43d96162003-03-06 00:02:04 +00002410 Global environment variables are those you use
2411 setenv/printenv to work with. To run a command stored
2412 in such a variable, you need to use the run command,
2413 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002414
2415 To store commands and special characters in a
2416 variable, please use double quotation marks
2417 surrounding the whole text of the variable, instead
2418 of the backslashes before semicolons and special
2419 symbols.
2420
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002421- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002422 CONFIG_CMDLINE_EDITING
2423
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002424 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002425 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002426
Marek Vasutf3b267b2016-01-27 04:47:55 +01002427- Command Line PS1/PS2 support:
2428 CONFIG_CMDLINE_PS_SUPPORT
2429
2430 Enable support for changing the command prompt string
2431 at run-time. Only static string is supported so far.
2432 The string is obtained from environment variables PS1
2433 and PS2.
2434
wdenka8c7c702003-12-06 19:49:23 +00002435- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002436 CONFIG_EXTRA_ENV_SETTINGS
2437
wdenk43d96162003-03-06 00:02:04 +00002438 Define this to contain any number of null terminated
2439 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002440 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002441
wdenk43d96162003-03-06 00:02:04 +00002442 For example, place something like this in your
2443 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002444
2445 #define CONFIG_EXTRA_ENV_SETTINGS \
2446 "myvar1=value1\0" \
2447 "myvar2=value2\0"
2448
wdenk43d96162003-03-06 00:02:04 +00002449 Warning: This method is based on knowledge about the
2450 internal format how the environment is stored by the
2451 U-Boot code. This is NOT an official, exported
2452 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002453 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002454 You better know what you are doing here.
2455
wdenk43d96162003-03-06 00:02:04 +00002456 Note: overly (ab)use of the default environment is
2457 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002458 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002459 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002460
Stephen Warren5e724ca2012-05-22 09:21:54 +00002461 CONFIG_ENV_VARS_UBOOT_CONFIG
2462
2463 Define this in order to add variables describing the
2464 U-Boot build configuration to the default environment.
2465 These will be named arch, cpu, board, vendor, and soc.
2466
2467 Enabling this option will cause the following to be defined:
2468
2469 - CONFIG_SYS_ARCH
2470 - CONFIG_SYS_CPU
2471 - CONFIG_SYS_BOARD
2472 - CONFIG_SYS_VENDOR
2473 - CONFIG_SYS_SOC
2474
Tom Rini7e27f892012-10-24 07:28:16 +00002475 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2476
2477 Define this in order to add variables describing certain
2478 run-time determined information about the hardware to the
2479 environment. These will be named board_name, board_rev.
2480
Simon Glass06fd8532012-11-30 13:01:17 +00002481 CONFIG_DELAY_ENVIRONMENT
2482
2483 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002484 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002485 that so that the environment is not available until
2486 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2487 this is instead controlled by the value of
2488 /config/load-environment.
2489
wdenka8c7c702003-12-06 19:49:23 +00002490- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002491 CONFIG_HAS_DATAFLASH
2492
wdenk8bde7f72003-06-27 21:31:46 +00002493 Defining this option enables DataFlash features and
2494 allows to read/write in Dataflash via the standard
2495 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002496
Eric Nelsonf61ec452012-01-31 10:52:08 -07002497- Serial Flash support
2498 CONFIG_CMD_SF
2499
2500 Defining this option enables SPI flash commands
2501 'sf probe/read/write/erase/update'.
2502
2503 Usage requires an initial 'probe' to define the serial
2504 flash parameters, followed by read/write/erase/update
2505 commands.
2506
2507 The following defaults may be provided by the platform
2508 to handle the common case when only a single serial
2509 flash is present on the system.
2510
2511 CONFIG_SF_DEFAULT_BUS Bus identifier
2512 CONFIG_SF_DEFAULT_CS Chip-select
2513 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2514 CONFIG_SF_DEFAULT_SPEED in Hz
2515
Simon Glass24007272012-10-08 13:16:02 +00002516 CONFIG_CMD_SF_TEST
2517
2518 Define this option to include a destructive SPI flash
2519 test ('sf test').
2520
wdenk3f85ce22004-02-23 16:11:30 +00002521- SystemACE Support:
2522 CONFIG_SYSTEMACE
2523
2524 Adding this option adds support for Xilinx SystemACE
2525 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002526 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002528
2529 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002530 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002531
2532 When SystemACE support is added, the "ace" device type
2533 becomes available to the fat commands, i.e. fatls.
2534
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002535- TFTP Fixed UDP Port:
2536 CONFIG_TFTP_PORT
2537
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002538 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002539 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002540 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002541 number generator is used.
2542
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002543 Also, the environment variable tftpdstp is used to supply
2544 the TFTP UDP destination port value. If tftpdstp isn't
2545 defined, the normal port 69 is used.
2546
2547 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002548 blindly start the TFTP transfer using the pre-configured
2549 target IP address and UDP port. This has the effect of
2550 "punching through" the (Windows XP) firewall, allowing
2551 the remainder of the TFTP transfer to proceed normally.
2552 A better solution is to properly configure the firewall,
2553 but sometimes that is not allowed.
2554
Heiko Schocher9e50c402014-01-25 07:27:13 +01002555- bootcount support:
2556 CONFIG_BOOTCOUNT_LIMIT
2557
2558 This enables the bootcounter support, see:
2559 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2560
2561 CONFIG_AT91SAM9XE
2562 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002563 CONFIG_SOC_DA8XX
2564 enable special bootcounter support on da850 based boards.
2565 CONFIG_BOOTCOUNT_RAM
2566 enable support for the bootcounter in RAM
2567 CONFIG_BOOTCOUNT_I2C
2568 enable support for the bootcounter on an i2c (like RTC) device.
2569 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2570 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2571 the bootcounter.
2572 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002573
wdenka8c7c702003-12-06 19:49:23 +00002574- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002575 CONFIG_SHOW_BOOT_PROGRESS
2576
wdenk43d96162003-03-06 00:02:04 +00002577 Defining this option allows to add some board-
2578 specific code (calling a user-provided function
2579 "show_boot_progress(int)") that enables you to show
2580 the system's boot progress on some display (for
2581 example, some LED's) on your board. At the moment,
2582 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002583
Simon Glass94fd1312012-09-28 08:56:37 +00002584
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002585Legacy uImage format:
2586
wdenkc6097192002-11-03 00:24:07 +00002587 Arg Where When
2588 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002589 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002590 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002591 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002592 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002593 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002594 4 common/cmd_bootm.c Image data has correct checksum
2595 -4 common/cmd_bootm.c Image is for unsupported architecture
2596 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002597 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002598 6 common/cmd_bootm.c Image Type check OK
2599 -6 common/cmd_bootm.c gunzip uncompression error
2600 -7 common/cmd_bootm.c Unimplemented compression type
2601 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002602 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002603 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002604
2605 9 common/image.c Start initial ramdisk verification
2606 -10 common/image.c Ramdisk header has bad magic number
2607 -11 common/image.c Ramdisk header has bad checksum
2608 10 common/image.c Ramdisk header is OK
2609 -12 common/image.c Ramdisk data has bad checksum
2610 11 common/image.c Ramdisk data has correct checksum
2611 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002612 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002613 13 common/image.c Start multifile image verification
2614 14 common/image.c No initial ramdisk, no multifile, continue.
2615
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002616 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002617
Stefan Roesea47a12b2010-04-15 16:07:28 +02002618 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002619 -31 post/post.c POST test failed, detected by post_output_backlog()
2620 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002621
Heiko Schocher566a4942007-06-22 19:11:54 +02002622 34 common/cmd_doc.c before loading a Image from a DOC device
2623 -35 common/cmd_doc.c Bad usage of "doc" command
2624 35 common/cmd_doc.c correct usage of "doc" command
2625 -36 common/cmd_doc.c No boot device
2626 36 common/cmd_doc.c correct boot device
2627 -37 common/cmd_doc.c Unknown Chip ID on boot device
2628 37 common/cmd_doc.c correct chip ID found, device available
2629 -38 common/cmd_doc.c Read Error on boot device
2630 38 common/cmd_doc.c reading Image header from DOC device OK
2631 -39 common/cmd_doc.c Image header has bad magic number
2632 39 common/cmd_doc.c Image header has correct magic number
2633 -40 common/cmd_doc.c Error reading Image from DOC device
2634 40 common/cmd_doc.c Image header has correct magic number
2635 41 common/cmd_ide.c before loading a Image from a IDE device
2636 -42 common/cmd_ide.c Bad usage of "ide" command
2637 42 common/cmd_ide.c correct usage of "ide" command
2638 -43 common/cmd_ide.c No boot device
2639 43 common/cmd_ide.c boot device found
2640 -44 common/cmd_ide.c Device not available
2641 44 common/cmd_ide.c Device available
2642 -45 common/cmd_ide.c wrong partition selected
2643 45 common/cmd_ide.c partition selected
2644 -46 common/cmd_ide.c Unknown partition table
2645 46 common/cmd_ide.c valid partition table found
2646 -47 common/cmd_ide.c Invalid partition type
2647 47 common/cmd_ide.c correct partition type
2648 -48 common/cmd_ide.c Error reading Image Header on boot device
2649 48 common/cmd_ide.c reading Image Header from IDE device OK
2650 -49 common/cmd_ide.c Image header has bad magic number
2651 49 common/cmd_ide.c Image header has correct magic number
2652 -50 common/cmd_ide.c Image header has bad checksum
2653 50 common/cmd_ide.c Image header has correct checksum
2654 -51 common/cmd_ide.c Error reading Image from IDE device
2655 51 common/cmd_ide.c reading Image from IDE device OK
2656 52 common/cmd_nand.c before loading a Image from a NAND device
2657 -53 common/cmd_nand.c Bad usage of "nand" command
2658 53 common/cmd_nand.c correct usage of "nand" command
2659 -54 common/cmd_nand.c No boot device
2660 54 common/cmd_nand.c boot device found
2661 -55 common/cmd_nand.c Unknown Chip ID on boot device
2662 55 common/cmd_nand.c correct chip ID found, device available
2663 -56 common/cmd_nand.c Error reading Image Header on boot device
2664 56 common/cmd_nand.c reading Image Header from NAND device OK
2665 -57 common/cmd_nand.c Image header has bad magic number
2666 57 common/cmd_nand.c Image header has correct magic number
2667 -58 common/cmd_nand.c Error reading Image from NAND device
2668 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002669
Heiko Schocher566a4942007-06-22 19:11:54 +02002670 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002671
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002672 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002673 -64 net/eth.c no Ethernet found.
2674 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002675
Heiko Schocher566a4942007-06-22 19:11:54 +02002676 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002677 80 common/cmd_net.c before calling net_loop()
2678 -81 common/cmd_net.c some error in net_loop() occurred
2679 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002680 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2681 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002682 83 common/cmd_net.c running "source" command
2683 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002684 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002685
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002686FIT uImage format:
2687
2688 Arg Where When
2689 100 common/cmd_bootm.c Kernel FIT Image has correct format
2690 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2691 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2692 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2693 102 common/cmd_bootm.c Kernel unit name specified
2694 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002695 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002696 104 common/cmd_bootm.c Got kernel subimage node offset
2697 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2698 105 common/cmd_bootm.c Kernel subimage hash verification OK
2699 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2700 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002701 -106 common/cmd_bootm.c Kernel subimage has wrong type
2702 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002703 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2704 108 common/cmd_bootm.c Got kernel subimage data/size
2705 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2706 -109 common/cmd_bootm.c Can't get kernel subimage type
2707 -110 common/cmd_bootm.c Can't get kernel subimage comp
2708 -111 common/cmd_bootm.c Can't get kernel subimage os
2709 -112 common/cmd_bootm.c Can't get kernel subimage load address
2710 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2711
2712 120 common/image.c Start initial ramdisk verification
2713 -120 common/image.c Ramdisk FIT image has incorrect format
2714 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002715 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002716 -122 common/image.c Can't get configuration for ramdisk subimage
2717 123 common/image.c Ramdisk unit name specified
2718 -124 common/image.c Can't get ramdisk subimage node offset
2719 125 common/image.c Got ramdisk subimage node offset
2720 -125 common/image.c Ramdisk subimage hash verification failed
2721 126 common/image.c Ramdisk subimage hash verification OK
2722 -126 common/image.c Ramdisk subimage for unsupported architecture
2723 127 common/image.c Architecture check OK
2724 -127 common/image.c Can't get ramdisk subimage data/size
2725 128 common/image.c Got ramdisk subimage data/size
2726 129 common/image.c Can't get ramdisk load address
2727 -129 common/image.c Got ramdisk load address
2728
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002729 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002730 131 common/cmd_doc.c FIT image format OK
2731
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002732 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002733 141 common/cmd_ide.c FIT image format OK
2734
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002735 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002736 151 common/cmd_nand.c FIT image format OK
2737
Heiko Schocher21d29f72014-05-28 11:33:33 +02002738- legacy image format:
2739 CONFIG_IMAGE_FORMAT_LEGACY
2740 enables the legacy image format support in U-Boot.
2741
2742 Default:
2743 enabled if CONFIG_FIT_SIGNATURE is not defined.
2744
2745 CONFIG_DISABLE_IMAGE_LEGACY
2746 disable the legacy image format
2747
2748 This define is introduced, as the legacy image format is
2749 enabled per default for backward compatibility.
2750
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002751- Standalone program support:
2752 CONFIG_STANDALONE_LOAD_ADDR
2753
Wolfgang Denk6feff892011-10-09 21:06:34 +02002754 This option defines a board specific value for the
2755 address where standalone program gets loaded, thus
2756 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002757 settings.
2758
2759- Frame Buffer Address:
2760 CONFIG_FB_ADDR
2761
2762 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002763 address for frame buffer. This is typically the case
2764 when using a graphics controller has separate video
2765 memory. U-Boot will then place the frame buffer at
2766 the given address instead of dynamically reserving it
2767 in system RAM by calling lcd_setmem(), which grabs
2768 the memory for the frame buffer depending on the
2769 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002770
2771 Please see board_init_f function.
2772
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002773- Automatic software updates via TFTP server
2774 CONFIG_UPDATE_TFTP
2775 CONFIG_UPDATE_TFTP_CNT_MAX
2776 CONFIG_UPDATE_TFTP_MSEC_MAX
2777
2778 These options enable and control the auto-update feature;
2779 for a more detailed description refer to doc/README.update.
2780
2781- MTD Support (mtdparts command, UBI support)
2782 CONFIG_MTD_DEVICE
2783
2784 Adds the MTD device infrastructure from the Linux kernel.
2785 Needed for mtdparts command support.
2786
2787 CONFIG_MTD_PARTITIONS
2788
2789 Adds the MTD partitioning infrastructure from the Linux
2790 kernel. Needed for UBI support.
2791
Joe Hershberger70c219c2013-04-08 10:32:48 +00002792- UBI support
Joe Hershberger147162d2013-04-08 10:32:49 +00002793 CONFIG_UBI_SILENCE_MSG
2794
2795 Make the verbose messages from UBI stop printing. This leaves
2796 warnings and errors enabled.
2797
Heiko Schocherff94bc42014-06-24 10:10:04 +02002798
2799 CONFIG_MTD_UBI_WL_THRESHOLD
2800 This parameter defines the maximum difference between the highest
2801 erase counter value and the lowest erase counter value of eraseblocks
2802 of UBI devices. When this threshold is exceeded, UBI starts performing
2803 wear leveling by means of moving data from eraseblock with low erase
2804 counter to eraseblocks with high erase counter.
2805
2806 The default value should be OK for SLC NAND flashes, NOR flashes and
2807 other flashes which have eraseblock life-cycle 100000 or more.
2808 However, in case of MLC NAND flashes which typically have eraseblock
2809 life-cycle less than 10000, the threshold should be lessened (e.g.,
2810 to 128 or 256, although it does not have to be power of 2).
2811
2812 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002813
Heiko Schocherff94bc42014-06-24 10:10:04 +02002814 CONFIG_MTD_UBI_BEB_LIMIT
2815 This option specifies the maximum bad physical eraseblocks UBI
2816 expects on the MTD device (per 1024 eraseblocks). If the
2817 underlying flash does not admit of bad eraseblocks (e.g. NOR
2818 flash), this value is ignored.
2819
2820 NAND datasheets often specify the minimum and maximum NVM
2821 (Number of Valid Blocks) for the flashes' endurance lifetime.
2822 The maximum expected bad eraseblocks per 1024 eraseblocks
2823 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2824 which gives 20 for most NANDs (MaxNVB is basically the total
2825 count of eraseblocks on the chip).
2826
2827 To put it differently, if this value is 20, UBI will try to
2828 reserve about 1.9% of physical eraseblocks for bad blocks
2829 handling. And that will be 1.9% of eraseblocks on the entire
2830 NAND chip, not just the MTD partition UBI attaches. This means
2831 that if you have, say, a NAND flash chip admits maximum 40 bad
2832 eraseblocks, and it is split on two MTD partitions of the same
2833 size, UBI will reserve 40 eraseblocks when attaching a
2834 partition.
2835
2836 default: 20
2837
2838 CONFIG_MTD_UBI_FASTMAP
2839 Fastmap is a mechanism which allows attaching an UBI device
2840 in nearly constant time. Instead of scanning the whole MTD device it
2841 only has to locate a checkpoint (called fastmap) on the device.
2842 The on-flash fastmap contains all information needed to attach
2843 the device. Using fastmap makes only sense on large devices where
2844 attaching by scanning takes long. UBI will not automatically install
2845 a fastmap on old images, but you can set the UBI parameter
2846 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2847 that fastmap-enabled images are still usable with UBI implementations
2848 without fastmap support. On typical flash devices the whole fastmap
2849 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2850
2851 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2852 Set this parameter to enable fastmap automatically on images
2853 without a fastmap.
2854 default: 0
2855
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002856 CONFIG_MTD_UBI_FM_DEBUG
2857 Enable UBI fastmap debug
2858 default: 0
2859
Joe Hershberger70c219c2013-04-08 10:32:48 +00002860- UBIFS support
Joe Hershberger147162d2013-04-08 10:32:49 +00002861 CONFIG_UBIFS_SILENCE_MSG
2862
2863 Make the verbose messages from UBIFS stop printing. This leaves
2864 warnings and errors enabled.
2865
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002866- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002867 CONFIG_SPL
2868 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002869
Tom Rini95579792012-02-14 07:29:40 +00002870 CONFIG_SPL_LDSCRIPT
2871 LDSCRIPT for linking the SPL binary.
2872
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002873 CONFIG_SPL_MAX_FOOTPRINT
2874 Maximum size in memory allocated to the SPL, BSS included.
2875 When defined, the linker checks that the actual memory
2876 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002877 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002878 must not be both defined at the same time.
2879
Tom Rini95579792012-02-14 07:29:40 +00002880 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002881 Maximum size of the SPL image (text, data, rodata, and
2882 linker lists sections), BSS excluded.
2883 When defined, the linker checks that the actual size does
2884 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002885
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002886 CONFIG_SPL_TEXT_BASE
2887 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002888
Scott Wood94a45bb2012-09-20 19:05:12 -05002889 CONFIG_SPL_RELOC_TEXT_BASE
2890 Address to relocate to. If unspecified, this is equal to
2891 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2892
Tom Rini95579792012-02-14 07:29:40 +00002893 CONFIG_SPL_BSS_START_ADDR
2894 Link address for the BSS within the SPL binary.
2895
2896 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002897 Maximum size in memory allocated to the SPL BSS.
2898 When defined, the linker checks that the actual memory used
2899 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002900 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002901 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002902
2903 CONFIG_SPL_STACK
2904 Adress of the start of the stack SPL will use
2905
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002906 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2907 When defined, SPL will panic() if the image it has
2908 loaded does not have a signature.
2909 Defining this is useful when code which loads images
2910 in SPL cannot guarantee that absolutely all read errors
2911 will be caught.
2912 An example is the LPC32XX MLC NAND driver, which will
2913 consider that a completely unreadable NAND block is bad,
2914 and thus should be skipped silently.
2915
Scott Wood94a45bb2012-09-20 19:05:12 -05002916 CONFIG_SPL_RELOC_STACK
2917 Adress of the start of the stack SPL will use after
2918 relocation. If unspecified, this is equal to
2919 CONFIG_SPL_STACK.
2920
Tom Rini95579792012-02-14 07:29:40 +00002921 CONFIG_SYS_SPL_MALLOC_START
2922 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002923 When this option is set the full malloc is used in SPL and
2924 it is set up by spl_init() and before that, the simple malloc()
2925 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002926
2927 CONFIG_SYS_SPL_MALLOC_SIZE
2928 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002929
Tom Rini47f7bca2012-08-13 12:03:19 -07002930 CONFIG_SPL_FRAMEWORK
2931 Enable the SPL framework under common/. This framework
2932 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2933 NAND loading of the Linux Kernel.
2934
Tom Rini9607faf2014-03-28 12:03:39 -04002935 CONFIG_SPL_OS_BOOT
2936 Enable booting directly to an OS from SPL.
2937 See also: doc/README.falcon
2938
Tom Rini861a86f2012-08-13 11:37:56 -07002939 CONFIG_SPL_DISPLAY_PRINT
2940 For ARM, enable an optional function to print more information
2941 about the running system.
2942
Scott Wood4b919722012-09-20 16:35:21 -05002943 CONFIG_SPL_INIT_MINIMAL
2944 Arch init code should be built for a very small image
2945
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002946 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2947 Partition on the MMC to load U-Boot from when the MMC is being
2948 used in raw mode
2949
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002950 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2951 Sector to load kernel uImage from when MMC is being
2952 used in raw mode (for Falcon mode)
2953
2954 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2955 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2956 Sector and number of sectors to load kernel argument
2957 parameters from when MMC is being used in raw mode
2958 (for falcon mode)
2959
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002960 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2961 Partition on the MMC to load U-Boot from when the MMC is being
2962 used in fs mode
2963
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002964 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2965 Filename to read to load U-Boot when reading from filesystem
2966
2967 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002968 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002969 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002970
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002971 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002972 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002973 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002974
Scott Wood06f60ae2012-12-06 13:33:17 +00002975 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2976 Set this for NAND SPL on PPC mpc83xx targets, so that
2977 start.S waits for the rest of the SPL to load before
2978 continuing (the hardware starts execution after just
2979 loading the first page rather than the full 4K).
2980
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302981 CONFIG_SPL_SKIP_RELOCATE
2982 Avoid SPL relocation
2983
Scott Wood6f2f01b2012-09-20 19:09:07 -05002984 CONFIG_SPL_NAND_BASE
2985 Include nand_base.c in the SPL. Requires
2986 CONFIG_SPL_NAND_DRIVERS.
2987
2988 CONFIG_SPL_NAND_DRIVERS
2989 SPL uses normal NAND drivers, not minimal drivers.
2990
2991 CONFIG_SPL_NAND_ECC
2992 Include standard software ECC in the SPL
2993
Tom Rini95579792012-02-14 07:29:40 +00002994 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002995 Support for NAND boot using simple NAND drivers that
2996 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002997
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002998 CONFIG_SPL_UBI
2999 Support for a lightweight UBI (fastmap) scanner and
3000 loader
3001
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003002 CONFIG_SPL_NAND_RAW_ONLY
3003 Support to boot only raw u-boot.bin images. Use this only
3004 if you need to save space.
3005
Ying Zhang7c8eea52013-08-16 15:16:12 +08003006 CONFIG_SPL_COMMON_INIT_DDR
3007 Set for common ddr init with serial presence detect in
3008 SPL binary.
3009
Tom Rini95579792012-02-14 07:29:40 +00003010 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3011 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3012 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3013 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3014 CONFIG_SYS_NAND_ECCBYTES
3015 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003016 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003017
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303018 CONFIG_SPL_NAND_BOOT
3019 Add support NAND boot
3020
Tom Rini95579792012-02-14 07:29:40 +00003021 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003022 Location in NAND to read U-Boot from
3023
3024 CONFIG_SYS_NAND_U_BOOT_DST
3025 Location in memory to load U-Boot to
3026
3027 CONFIG_SYS_NAND_U_BOOT_SIZE
3028 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003029
3030 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003031 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003032
3033 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3034 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003035 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003036
3037 CONFIG_SPL_OMAP3_ID_NAND
3038 Support for an OMAP3-specific set of functions to return the
3039 ID and MFR of the first attached NAND chip, if present.
3040
Pavel Machekc57b9532012-08-30 22:42:11 +02003041 CONFIG_SPL_RAM_DEVICE
3042 Support for running image already present in ram, in SPL binary
3043
Scott Wood74752ba2012-12-06 13:33:16 +00003044 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003045 Image offset to which the SPL should be padded before appending
3046 the SPL payload. By default, this is defined as
3047 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3048 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3049 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003050
Scott Woodca2fca22012-09-21 16:27:32 -05003051 CONFIG_SPL_TARGET
3052 Final target image containing SPL and payload. Some SPLs
3053 use an arch-specific makefile fragment instead, for
3054 example if more than one image needs to be produced.
3055
Simon Glass87ebee32013-05-08 08:05:59 +00003056 CONFIG_FIT_SPL_PRINT
3057 Printing information about a FIT image adds quite a bit of
3058 code to SPL. So this is normally disabled in SPL. Use this
3059 option to re-enable it. This will affect the output of the
3060 bootm command when booting a FIT image.
3061
Ying Zhang3aa29de2013-08-16 15:16:15 +08003062- TPL framework
3063 CONFIG_TPL
3064 Enable building of TPL globally.
3065
3066 CONFIG_TPL_PAD_TO
3067 Image offset to which the TPL should be padded before appending
3068 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003069 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3070 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3071 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003072
wdenka8c7c702003-12-06 19:49:23 +00003073- Interrupt support (PPC):
3074
wdenkd4ca31c2004-01-02 14:00:00 +00003075 There are common interrupt_init() and timer_interrupt()
3076 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003077 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003078 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003079 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003080 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003081 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003082 specific handling. If board has watchdog / status_led
3083 / other_activity_monitor it works automatically from
3084 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003085
wdenkc6097192002-11-03 00:24:07 +00003086
Helmut Raiger9660e442011-10-20 04:19:47 +00003087Board initialization settings:
3088------------------------------
3089
3090During Initialization u-boot calls a number of board specific functions
3091to allow the preparation of board specific prerequisites, e.g. pin setup
3092before drivers are initialized. To enable these callbacks the
3093following configuration macros have to be defined. Currently this is
3094architecture specific, so please check arch/your_architecture/lib/board.c
3095typically in board_init_f() and board_init_r().
3096
3097- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3098- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3099- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3100- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003101
wdenkc6097192002-11-03 00:24:07 +00003102Configuration Settings:
3103-----------------------
3104
York Sun4d1fd7f2014-02-26 17:03:19 -08003105- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3106 Optionally it can be defined to support 64-bit memory commands.
3107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003108- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003109 undefine this when you're short of memory.
3110
Peter Tyser2fb26042009-01-27 18:03:12 -06003111- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3112 width of the commands listed in the 'help' command output.
3113
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003114- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003115 prompt for user input.
3116
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003117- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003121- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003123- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003124 the application (usually a Linux kernel) when it is
3125 booted
3126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003127- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003128 List of legal baudrate settings for this board.
3129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003130- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003131 Begin and End addresses of the area used by the
3132 simple memory test.
3133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003134- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003135 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003137- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003138 Scratch address used by the alternate memory test
3139 You only need to set this if address zero isn't writeable
3140
York Sune8149522015-12-04 11:57:07 -08003141- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003142 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003143 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3144 is substracted from total RAM and won't be reported to OS.
3145 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003146 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003147 the RAM base is not zero, or RAM is divided into banks,
3148 this variable needs to be recalcuated to get the address.
3149
York Sunaabd7dd2015-12-07 11:05:29 -08003150- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003151 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003152 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003153 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003154 fixing up gd->ram_size the Linux kernel should gets passed
3155 the now "corrected" memory size and won't touch it either.
3156 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003157 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003158 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003159 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003160
3161 This option can be used as a workaround for the 440EPx/GRx
3162 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3163 be touched.
3164
3165 WARNING: Please make sure that this value is a multiple of
3166 the Linux page size (normally 4k). If this is not the case,
3167 then the end address of the Linux memory will be located at a
3168 non page size aligned address and this could cause major
3169 problems.
3170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003171- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003172 Enable temporary baudrate change while serial download
3173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003174- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003175 Physical start address of SDRAM. _Must_ be 0 here.
3176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003177- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003178 Physical start address of Flash memory.
3179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003180- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003181 Physical start address of boot monitor code (set by
3182 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003183 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003184 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003186- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003187 Size of memory reserved for monitor code, used to
3188 determine _at_compile_time_ (!) if the environment is
3189 embedded within the U-Boot image, or in a separate
3190 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003191
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003192- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003193 Size of DRAM reserved for malloc() use.
3194
Simon Glassd59476b2014-07-10 22:23:28 -06003195- CONFIG_SYS_MALLOC_F_LEN
3196 Size of the malloc() pool for use before relocation. If
3197 this is defined, then a very simple malloc() implementation
3198 will become available before relocation. The address is just
3199 below the global data, and the stack is moved down to make
3200 space.
3201
3202 This feature allocates regions with increasing addresses
3203 within the region. calloc() is supported, but realloc()
3204 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003205 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003206 U-Boot relocates itself.
3207
Simon Glass38687ae2014-11-10 17:16:54 -07003208- CONFIG_SYS_MALLOC_SIMPLE
3209 Provides a simple and small malloc() and calloc() for those
3210 boards which do not use the full malloc in SPL (which is
3211 enabled with CONFIG_SYS_SPL_MALLOC_START).
3212
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003213- CONFIG_SYS_NONCACHED_MEMORY:
3214 Size of non-cached memory area. This area of memory will be
3215 typically located right below the malloc() area and mapped
3216 uncached in the MMU. This is useful for drivers that would
3217 otherwise require a lot of explicit cache maintenance. For
3218 some drivers it's also impossible to properly maintain the
3219 cache. For example if the regions that need to be flushed
3220 are not a multiple of the cache-line size, *and* padding
3221 cannot be allocated between the regions to align them (i.e.
3222 if the HW requires a contiguous array of regions, and the
3223 size of each region is not cache-aligned), then a flush of
3224 one region may result in overwriting data that hardware has
3225 written to another region in the same cache-line. This can
3226 happen for example in network drivers where descriptors for
3227 buffers are typically smaller than the CPU cache-line (e.g.
3228 16 bytes vs. 32 or 64 bytes).
3229
3230 Non-cached memory is only supported on 32-bit ARM at present.
3231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003232- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003233 Normally compressed uImages are limited to an
3234 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003235 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003236 to adjust this setting to your needs.
3237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003238- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003239 Maximum size of memory mapped by the startup code of
3240 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003241 the Linux kernel (bd_info, boot arguments, FDT blob if
3242 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003243 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003244 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003245 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003246 variable "bootm_mapsize" will override the value of
3247 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3248 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003249
John Rigbyfca43cc2010-10-13 13:57:35 -06003250- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3251 Enable initrd_high functionality. If defined then the
3252 initrd_high feature is enabled and the bootm ramdisk subcommand
3253 is enabled.
3254
3255- CONFIG_SYS_BOOT_GET_CMDLINE:
3256 Enables allocating and saving kernel cmdline in space between
3257 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3258
3259- CONFIG_SYS_BOOT_GET_KBD:
3260 Enables allocating and saving a kernel copy of the bd_info in
3261 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003264 Max number of Flash memory banks
3265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003266- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003267 Max number of sectors on a Flash chip
3268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003269- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003270 Timeout for Flash erase operations (in ms)
3271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003272- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003273 Timeout for Flash write operations (in ms)
3274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003275- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003276 Timeout for Flash set sector lock bit operation (in ms)
3277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003279 Timeout for Flash clear lock bits operation (in ms)
3280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003281- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003282 If defined, hardware flash sectors protection is used
3283 instead of U-Boot software protection.
3284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003285- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003286
3287 Enable TFTP transfers directly to flash memory;
3288 without this option such a download has to be
3289 performed in two steps: (1) download to RAM, and (2)
3290 copy from RAM to flash.
3291
3292 The two-step approach is usually more reliable, since
3293 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003294 the flash, but in some situations (when system RAM is
3295 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003296 downloaded image) this option may be very useful.
3297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003298- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003299 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003300 common flash structure for storing flash geometry.
3301
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003302- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003303 This option also enables the building of the cfi_flash driver
3304 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003305
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003306- CONFIG_FLASH_CFI_MTD
3307 This option enables the building of the cfi_mtd driver
3308 in the drivers directory. The driver exports CFI flash
3309 to the MTD layer.
3310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003311- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003312 Use buffered writes to flash.
3313
3314- CONFIG_FLASH_SPANSION_S29WS_N
3315 s29ws-n MirrorBit flash has non-standard addresses for buffered
3316 write commands.
3317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003318- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003319 If this option is defined, the common CFI flash doesn't
3320 print it's warning upon not recognized FLASH banks. This
3321 is useful, if some of the configured banks are only
3322 optionally available.
3323
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003324- CONFIG_FLASH_SHOW_PROGRESS
3325 If defined (must be an integer), print out countdown
3326 digits and dots. Recommended value: 45 (9..1) for 80
3327 column displays, 15 (3..1) for 40 column displays.
3328
Stefan Roese352ef3f2013-04-04 15:53:14 +02003329- CONFIG_FLASH_VERIFY
3330 If defined, the content of the flash (destination) is compared
3331 against the source after the write operation. An error message
3332 will be printed when the contents are not identical.
3333 Please note that this option is useless in nearly all cases,
3334 since such flash programming errors usually are detected earlier
3335 while unprotecting/erasing/programming. Please only enable
3336 this option if you really know what you are doing.
3337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003338- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003339 Defines the number of Ethernet receive buffers. On some
3340 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003341 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3342 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003343 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003344 Defaults to 4 if not defined.
3345
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003346- CONFIG_ENV_MAX_ENTRIES
3347
Wolfgang Denk071bc922010-10-27 22:48:30 +02003348 Maximum number of entries in the hash table that is used
3349 internally to store the environment settings. The default
3350 setting is supposed to be generous and should work in most
3351 cases. This setting can be used to tune behaviour; see
3352 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003353
Joe Hershberger25980902012-12-11 22:16:31 -06003354- CONFIG_ENV_FLAGS_LIST_DEFAULT
3355- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003356 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003357 calling env set. Variables can be restricted to only decimal,
3358 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3359 the variables can also be restricted to IP address or MAC address.
3360
3361 The format of the list is:
3362 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003363 access_attribute = [a|r|o|c]
3364 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003365 entry = variable_name[:attributes]
3366 list = entry[,list]
3367
3368 The type attributes are:
3369 s - String (default)
3370 d - Decimal
3371 x - Hexadecimal
3372 b - Boolean ([1yYtT|0nNfF])
3373 i - IP address
3374 m - MAC address
3375
Joe Hershberger267541f2012-12-11 22:16:34 -06003376 The access attributes are:
3377 a - Any (default)
3378 r - Read-only
3379 o - Write-once
3380 c - Change-default
3381
Joe Hershberger25980902012-12-11 22:16:31 -06003382 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3383 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003384 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003385
3386 - CONFIG_ENV_FLAGS_LIST_STATIC
3387 Define this to a list (string) to define validation that
3388 should be done if an entry is not found in the ".flags"
3389 environment variable. To override a setting in the static
3390 list, simply add an entry for the same variable name to the
3391 ".flags" variable.
3392
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003393 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3394 regular expression. This allows multiple variables to define the same
3395 flags without explicitly listing them for each variable.
3396
Joe Hershberger267541f2012-12-11 22:16:34 -06003397- CONFIG_ENV_ACCESS_IGNORE_FORCE
3398 If defined, don't allow the -f switch to env set override variable
3399 access flags.
3400
Gabe Black0d296cc2014-10-15 04:38:30 -06003401- CONFIG_USE_STDINT
3402 If stdint.h is available with your toolchain you can define this
3403 option to enable it. You can provide option 'USE_STDINT=1' when
3404 building U-Boot to enable this.
3405
wdenkc6097192002-11-03 00:24:07 +00003406The following definitions that deal with the placement and management
3407of environment data (variable area); in general, we support the
3408following configurations:
3409
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003410- CONFIG_BUILD_ENVCRC:
3411
3412 Builds up envcrc with the target environment so that external utils
3413 may easily extract it and embed it in final U-Boot images.
3414
wdenkc6097192002-11-03 00:24:07 +00003415BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003416in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003417console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003418U-Boot will hang.
3419
3420Please note that even with NVRAM we still use a copy of the
3421environment in RAM: we could work on NVRAM directly, but we want to
3422keep settings there always unmodified except somebody uses "saveenv"
3423to save the current settings.
3424
Liu Gang0a85a9e2012-03-08 00:33:20 +00003425BE CAREFUL! For some special cases, the local device can not use
3426"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003427environment stored in a remote NOR flash by SRIO or PCIE link,
3428but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003429
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003430- CONFIG_NAND_ENV_DST
3431
3432 Defines address in RAM to which the nand_spl code should copy the
3433 environment. If redundant environment is used, it will be copied to
3434 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3435
Bruce Adlere881cb52007-11-02 13:15:42 -07003436Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003437has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003438created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003439until then to read environment variables.
3440
wdenk85ec0bc2003-03-31 16:34:49 +00003441The environment is protected by a CRC32 checksum. Before the monitor
3442is relocated into RAM, as a result of a bad CRC you will be working
3443with the compiled-in default environment - *silently*!!! [This is
3444necessary, because the first environment variable we need is the
3445"baudrate" setting for the console - if we have a bad CRC, we don't
3446have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003447
3448Note: once the monitor has been relocated, then it will complain if
3449the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003450use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003451
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003452- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003453 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003456 also needs to be defined.
3457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003458- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003459 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003460
Ron Madridf5675aa2009-02-18 14:30:44 -08003461- CONFIG_NS16550_MIN_FUNCTIONS:
3462 Define this if you desire to only have use of the NS16550_init
3463 and NS16550_putc functions for the serial driver located at
3464 drivers/serial/ns16550.c. This option is useful for saving
3465 space for already greatly restricted images, including but not
3466 limited to NAND_SPL configurations.
3467
Simon Glassb2b92f52012-11-30 13:01:18 +00003468- CONFIG_DISPLAY_BOARDINFO
3469 Display information about the board that U-Boot is running on
3470 when U-Boot starts up. The board function checkboard() is called
3471 to do this.
3472
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003473- CONFIG_DISPLAY_BOARDINFO_LATE
3474 Similar to the previous option, but display this information
3475 later, once stdio is running and output goes to the LCD, if
3476 present.
3477
Sascha Silbefeb85802013-08-11 16:40:43 +02003478- CONFIG_BOARD_SIZE_LIMIT:
3479 Maximum size of the U-Boot image. When defined, the
3480 build system checks that the actual size does not
3481 exceed it.
3482
wdenkc6097192002-11-03 00:24:07 +00003483Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003484---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003486- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003487 Cache Line Size of the CPU.
3488
Timur Tabie46fedf2011-08-04 18:03:41 -05003489- CONFIG_SYS_CCSRBAR_DEFAULT:
3490 Default (power-on reset) physical address of CCSR on Freescale
3491 PowerPC SOCs.
3492
3493- CONFIG_SYS_CCSRBAR:
3494 Virtual address of CCSR. On a 32-bit build, this is typically
3495 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3496
Timur Tabie46fedf2011-08-04 18:03:41 -05003497- CONFIG_SYS_CCSRBAR_PHYS:
3498 Physical address of CCSR. CCSR can be relocated to a new
3499 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003500 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003501 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3502 is typically relocated on 36-bit builds. It is recommended
3503 that this macro be defined via the _HIGH and _LOW macros:
3504
3505 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3506 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3507
3508- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003509 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3510 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003511 used in assembly code, so it must not contain typecasts or
3512 integer size suffixes (e.g. "ULL").
3513
3514- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3515 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3516 used in assembly code, so it must not contain typecasts or
3517 integer size suffixes (e.g. "ULL").
3518
3519- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3520 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3521 forced to a value that ensures that CCSR is not relocated.
3522
wdenk7f6c2cb2002-11-10 22:06:23 +00003523- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003525
3526 the default drive number (default value 0)
3527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003528 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003529
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003530 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003531 (default value 1)
3532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003533 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003534
wdenk43d96162003-03-06 00:02:04 +00003535 defines the offset of register from address. It
3536 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003537 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003539 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3540 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003541 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003543 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003544 fdc_hw_init() is called at the beginning of the FDC
3545 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003546 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003547 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003548
Macpaul Lin0abddf82011-04-11 20:45:32 +00003549- CONFIG_IDE_AHB:
3550 Most IDE controllers were designed to be connected with PCI
3551 interface. Only few of them were designed for AHB interface.
3552 When software is doing ATA command and data transfer to
3553 IDE devices through IDE-AHB controller, some additional
3554 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003555 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003556
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003557- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003558 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003559 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003561- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003562
wdenk7152b1d2003-09-05 23:19:14 +00003563 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003564 initial data and stack; please note that this must be
3565 writable memory that is working WITHOUT special
3566 initialization, i. e. you CANNOT use normal RAM which
3567 will become available only after programming the
3568 memory controller and running certain initialization
3569 sequences.
3570
3571 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003572 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003573
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003574- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003575
3576 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003577 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3578 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003579 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003580 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003581 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003582 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3583 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003584
3585 Note:
3586 On the MPC824X (or other systems that use the data
3587 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003588 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003589 point to an otherwise UNUSED address space between
3590 the top of RAM and the start of the PCI space.
3591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003592- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003594- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003595 SDRAM timing
3596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003597- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003598 periodic timer for refresh
3599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003600- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3601 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3602 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3603 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003604 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3605
3606- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003607 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3608 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003609 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3610
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003611- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003612 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003613 Don't do any setup work, presumably because someone or
3614 something has already done it, and we don't need to do it
3615 a second time. Useful for platforms that are pre-booted
3616 by coreboot or similar.
3617
Gabor Juhos842033e2013-05-30 07:06:12 +00003618- CONFIG_PCI_INDIRECT_BRIDGE:
3619 Enable support for indirect PCI bridges.
3620
Kumar Galaa09b9b62010-12-30 12:09:53 -06003621- CONFIG_SYS_SRIO:
3622 Chip has SRIO or not
3623
3624- CONFIG_SRIO1:
3625 Board has SRIO 1 port available
3626
3627- CONFIG_SRIO2:
3628 Board has SRIO 2 port available
3629
Liu Gangc8b28152013-05-07 16:30:46 +08003630- CONFIG_SRIO_PCIE_BOOT_MASTER
3631 Board can support master function for Boot from SRIO and PCIE
3632
Kumar Galaa09b9b62010-12-30 12:09:53 -06003633- CONFIG_SYS_SRIOn_MEM_VIRT:
3634 Virtual Address of SRIO port 'n' memory region
3635
3636- CONFIG_SYS_SRIOn_MEM_PHYS:
3637 Physical Address of SRIO port 'n' memory region
3638
3639- CONFIG_SYS_SRIOn_MEM_SIZE:
3640 Size of SRIO port 'n' memory region
3641
Fabio Estevam66bd1842013-04-11 09:35:34 +00003642- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3643 Defined to tell the NAND controller that the NAND chip is using
3644 a 16 bit bus.
3645 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003646 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003647 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003648 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003649
3650- CONFIG_SYS_NDFC_EBC0_CFG
3651 Sets the EBC0_CFG register for the NDFC. If not defined
3652 a default value will be used.
3653
Ben Warrenbb99ad62006-09-07 16:50:54 -04003654- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003655 Get DDR timing information from an I2C EEPROM. Common
3656 with pluggable memory modules such as SODIMMs
3657
Ben Warrenbb99ad62006-09-07 16:50:54 -04003658 SPD_EEPROM_ADDRESS
3659 I2C address of the SPD EEPROM
3660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003661- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003662 If SPD EEPROM is on an I2C bus other than the first
3663 one, specify here. Note that the value must resolve
3664 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003665
York Sun1b3e3c42011-06-07 09:42:16 +08003666- CONFIG_SYS_DDR_RAW_TIMING
3667 Get DDR timing information from other than SPD. Common with
3668 soldered DDR chips onboard without SPD. DDR raw timing
3669 parameters are extracted from datasheet and hard-coded into
3670 header files or board specific files.
3671
York Sun6f5e1dc2011-09-16 13:21:35 -07003672- CONFIG_FSL_DDR_INTERACTIVE
3673 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3674
York Sune32d59a2015-01-06 13:18:55 -08003675- CONFIG_FSL_DDR_SYNC_REFRESH
3676 Enable sync of refresh for multiple controllers.
3677
York Sun4516ff82015-03-19 09:30:28 -07003678- CONFIG_FSL_DDR_BIST
3679 Enable built-in memory test for Freescale DDR controllers.
3680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003681- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003682 Only for 83xx systems. If specified, then DDR should
3683 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003684
wdenkc26e4542004-04-18 10:13:26 +00003685- CONFIG_RMII
3686 Enable RMII mode for all FECs.
3687 Note that this is a global option, we can't
3688 have one FEC in standard MII mode and another in RMII mode.
3689
wdenk5cf91d62004-04-23 20:32:05 +00003690- CONFIG_CRC32_VERIFY
3691 Add a verify option to the crc32 command.
3692 The syntax is:
3693
3694 => crc32 -v <address> <count> <crc32>
3695
3696 Where address/count indicate a memory area
3697 and crc32 is the correct crc32 which the
3698 area should have.
3699
wdenk56523f12004-07-11 17:40:54 +00003700- CONFIG_LOOPW
3701 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003702 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003703
stroese7b466642004-12-16 18:46:55 +00003704- CONFIG_MX_CYCLIC
3705 Add the "mdc" and "mwc" memory commands. These are cyclic
3706 "md/mw" commands.
3707 Examples:
3708
wdenkefe2a4d2004-12-16 21:44:03 +00003709 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003710 This command will print 4 bytes (10,11,12,13) each 500 ms.
3711
wdenkefe2a4d2004-12-16 21:44:03 +00003712 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003713 This command will write 12345678 to address 100 all 10 ms.
3714
wdenkefe2a4d2004-12-16 21:44:03 +00003715 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003716 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003717
wdenk8aa1a2d2005-04-04 12:44:11 +00003718- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003719 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003720 low level initializations (like setting up the memory
3721 controller) are omitted and/or U-Boot does not
3722 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003723
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003724 Normally this variable MUST NOT be defined. The only
3725 exception is when U-Boot is loaded (to RAM) by some
3726 other boot loader or by a debugger which performs
3727 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003728
Simon Glassb5bd0982016-05-05 07:28:06 -06003729- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3730 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003731 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003732 instruction cache) is still performed.
3733
Aneesh V401bb302011-07-13 05:11:07 +00003734- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003735 Modifies the behaviour of start.S when compiling a loader
3736 that is executed before the actual U-Boot. E.g. when
3737 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003738
Ying Zhang3aa29de2013-08-16 15:16:15 +08003739- CONFIG_TPL_BUILD
3740 Modifies the behaviour of start.S when compiling a loader
3741 that is executed after the SPL and before the actual U-Boot.
3742 It is loaded by the SPL.
3743
Ying Zhang5df572f2013-05-20 14:07:23 +08003744- CONFIG_SYS_MPC85XX_NO_RESETVEC
3745 Only for 85xx systems. If this variable is specified, the section
3746 .resetvec is not kept and the section .bootpg is placed in the
3747 previous 4k of the .text section.
3748
Simon Glass4213fc22013-02-24 17:33:14 +00003749- CONFIG_ARCH_MAP_SYSMEM
3750 Generally U-Boot (and in particular the md command) uses
3751 effective address. It is therefore not necessary to regard
3752 U-Boot address as virtual addresses that need to be translated
3753 to physical addresses. However, sandbox requires this, since
3754 it maintains its own little RAM buffer which contains all
3755 addressable memory. This option causes some memory accesses
3756 to be mapped through map_sysmem() / unmap_sysmem().
3757
Simon Glass588a13f2013-02-14 04:18:54 +00003758- CONFIG_X86_RESET_VECTOR
3759 If defined, the x86 reset vector code is included. This is not
3760 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003761
Heiko Schocher16678eb2013-11-04 14:05:00 +01003762- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3763 Enables the RTC32K OSC on AM33xx based plattforms
3764
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003765- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3766 Option to disable subpage write in NAND driver
3767 driver that uses this:
3768 drivers/mtd/nand/davinci_nand.c
3769
Timur Tabif2717b42011-11-22 09:21:25 -06003770Freescale QE/FMAN Firmware Support:
3771-----------------------------------
3772
3773The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3774loading of "firmware", which is encoded in the QE firmware binary format.
3775This firmware often needs to be loaded during U-Boot booting, so macros
3776are used to identify the storage device (NOR flash, SPI, etc) and the address
3777within that device.
3778
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003779- CONFIG_SYS_FMAN_FW_ADDR
3780 The address in the storage device where the FMAN microcode is located. The
3781 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3782 is also specified.
3783
3784- CONFIG_SYS_QE_FW_ADDR
3785 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003786 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3787 is also specified.
3788
3789- CONFIG_SYS_QE_FMAN_FW_LENGTH
3790 The maximum possible size of the firmware. The firmware binary format
3791 has a field that specifies the actual size of the firmware, but it
3792 might not be possible to read any part of the firmware unless some
3793 local storage is allocated to hold the entire firmware first.
3794
3795- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3796 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3797 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3798 virtual address in NOR flash.
3799
3800- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3801 Specifies that QE/FMAN firmware is located in NAND flash.
3802 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3803
3804- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3805 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3806 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3807
Liu Gang292dc6c2012-03-08 00:33:18 +00003808- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3809 Specifies that QE/FMAN firmware is located in the remote (master)
3810 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003811 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3812 window->master inbound window->master LAW->the ucode address in
3813 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003814
J. German Riverab940ca62014-06-23 15:15:55 -07003815Freescale Layerscape Management Complex Firmware Support:
3816---------------------------------------------------------
3817The Freescale Layerscape Management Complex (MC) supports the loading of
3818"firmware".
3819This firmware often needs to be loaded during U-Boot booting, so macros
3820are used to identify the storage device (NOR flash, SPI, etc) and the address
3821within that device.
3822
3823- CONFIG_FSL_MC_ENET
3824 Enable the MC driver for Layerscape SoCs.
3825
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303826Freescale Layerscape Debug Server Support:
3827-------------------------------------------
3828The Freescale Layerscape Debug Server Support supports the loading of
3829"Debug Server firmware" and triggering SP boot-rom.
3830This firmware often needs to be loaded during U-Boot booting.
3831
York Sunc0492142015-12-07 11:08:58 -08003832- CONFIG_SYS_MC_RSV_MEM_ALIGN
3833 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303834
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003835Reproducible builds
3836-------------------
3837
3838In order to achieve reproducible builds, timestamps used in the U-Boot build
3839process have to be set to a fixed value.
3840
3841This is done using the SOURCE_DATE_EPOCH environment variable.
3842SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3843option for U-Boot or an environment variable in U-Boot.
3844
3845SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3846
wdenkc6097192002-11-03 00:24:07 +00003847Building the Software:
3848======================
3849
Wolfgang Denk218ca722008-03-26 10:40:12 +01003850Building U-Boot has been tested in several native build environments
3851and in many different cross environments. Of course we cannot support
3852all possibly existing versions of cross development tools in all
3853(potentially obsolete) versions. In case of tool chain problems we
3854recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3855which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003856
Wolfgang Denk218ca722008-03-26 10:40:12 +01003857If you are not using a native environment, it is assumed that you
3858have GNU cross compiling tools available in your path. In this case,
3859you must set the environment variable CROSS_COMPILE in your shell.
3860Note that no changes to the Makefile or any other source files are
3861necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003862
Wolfgang Denk218ca722008-03-26 10:40:12 +01003863 $ CROSS_COMPILE=ppc_4xx-
3864 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003865
Peter Tyser2f8d3962009-03-13 18:54:51 -05003866Note: If you wish to generate Windows versions of the utilities in
3867 the tools directory you can use the MinGW toolchain
3868 (http://www.mingw.org). Set your HOST tools to the MinGW
3869 toolchain and execute 'make tools'. For example:
3870
3871 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3872
3873 Binaries such as tools/mkimage.exe will be created which can
3874 be executed on computers running Windows.
3875
Wolfgang Denk218ca722008-03-26 10:40:12 +01003876U-Boot is intended to be simple to build. After installing the
3877sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003878is done by typing:
3879
Holger Freytherab584d62014-08-04 09:26:05 +02003880 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003881
Holger Freytherab584d62014-08-04 09:26:05 +02003882where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003883rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003884
wdenk2729af92004-05-03 20:45:30 +00003885Note: for some board special configuration names may exist; check if
3886 additional information is available from the board vendor; for
3887 instance, the TQM823L systems are available without (standard)
3888 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003889 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003890
Holger Freytherab584d62014-08-04 09:26:05 +02003891 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003892 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003893
Holger Freytherab584d62014-08-04 09:26:05 +02003894 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003895 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk2729af92004-05-03 20:45:30 +00003897 etc.
wdenkc6097192002-11-03 00:24:07 +00003898
wdenkc6097192002-11-03 00:24:07 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900Finally, type "make all", and you should get some working U-Boot
3901images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003902
wdenk2729af92004-05-03 20:45:30 +00003903- "u-boot.bin" is a raw binary image
3904- "u-boot" is an image in ELF binary format
3905- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003906
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003907By default the build is performed locally and the objects are saved
3908in the source directory. One of the two methods can be used to change
3909this behavior and build U-Boot to some external directory:
3910
39111. Add O= to the make command line invocations:
3912
3913 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003914 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003915 make O=/tmp/build all
3916
Timo Ketolaadbba992014-11-06 14:39:05 +020039172. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003918
Timo Ketolaadbba992014-11-06 14:39:05 +02003919 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003920 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003921 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003922 make all
3923
Timo Ketolaadbba992014-11-06 14:39:05 +02003924Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003925variable.
3926
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928Please be aware that the Makefiles assume you are using GNU make, so
3929for instance on NetBSD you might need to use "gmake" instead of
3930native "make".
wdenkc6097192002-11-03 00:24:07 +00003931
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933If the system board that you have is not listed, then you will need
3934to port U-Boot to your hardware platform. To do this, follow these
3935steps:
wdenkc6097192002-11-03 00:24:07 +00003936
Phil Sutter3c1496c2015-12-25 14:41:18 +010039371. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003938 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003939 the "Makefile" and a "<board>.c".
39402. Create a new configuration file "include/configs/<board>.h" for
3941 your board.
wdenk2729af92004-05-03 20:45:30 +000039423. If you're porting U-Boot to a new CPU, then also create a new
3943 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020039444. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000039455. Type "make", and you should get a working "u-boot.srec" file
3946 to be installed on your target system.
39476. Debug and solve any problems that might arise.
3948 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003949
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3952==============================================================
wdenkc6097192002-11-03 00:24:07 +00003953
Wolfgang Denk218ca722008-03-26 10:40:12 +01003954If you have modified U-Boot sources (for instance added a new board
3955or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003956provide feedback to the other developers. The feedback normally takes
3957the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003958official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003959
Wolfgang Denk218ca722008-03-26 10:40:12 +01003960But before you submit such a patch, please verify that your modifi-
3961cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003962the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003963just run the buildman script (tools/buildman/buildman), which will
3964configure and build U-Boot for ALL supported system. Be warned, this
3965will take a while. Please see the buildman README, or run 'buildman -H'
3966for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003967
3968
wdenk2729af92004-05-03 20:45:30 +00003969See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003970
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972Monitor Commands - Overview:
3973============================
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk2729af92004-05-03 20:45:30 +00003975go - start application at address 'addr'
3976run - run commands in an environment variable
3977bootm - boot application image from memory
3978bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003979bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003980tftpboot- boot image via network using TFTP protocol
3981 and env variables "ipaddr" and "serverip"
3982 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003983tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003984rarpboot- boot image via network using RARP/TFTP protocol
3985diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3986loads - load S-Record file over serial line
3987loadb - load binary file over serial line (kermit mode)
3988md - memory display
3989mm - memory modify (auto-incrementing)
3990nm - memory modify (constant address)
3991mw - memory write (fill)
3992cp - memory copy
3993cmp - memory compare
3994crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003995i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003996sspi - SPI utility commands
3997base - print or set address offset
3998printenv- print environment variables
3999setenv - set environment variables
4000saveenv - save environment variables to persistent storage
4001protect - enable or disable FLASH write protection
4002erase - erase FLASH memory
4003flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004004nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004005bdinfo - print Board Info structure
4006iminfo - print header information for application image
4007coninfo - print console devices and informations
4008ide - IDE sub-system
4009loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004010loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004011mtest - simple RAM test
4012icache - enable or disable instruction cache
4013dcache - enable or disable data cache
4014reset - Perform RESET of the CPU
4015echo - echo args to console
4016version - print monitor version
4017help - print online help
4018? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004019
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk2729af92004-05-03 20:45:30 +00004021Monitor Commands - Detailed Description:
4022========================================
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024TODO.
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004027
4028
wdenk2729af92004-05-03 20:45:30 +00004029Environment Variables:
4030======================
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk2729af92004-05-03 20:45:30 +00004032U-Boot supports user configuration using Environment Variables which
4033can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035Environment Variables are set using "setenv", printed using
4036"printenv", and saved to Flash using "saveenv". Using "setenv"
4037without a value can be used to delete a variable from the
4038environment. As long as you don't save the environment you are
4039working with an in-memory copy. In case the Flash area containing the
4040environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004041
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004042Some configuration options can be set using Environment Variables.
4043
4044List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004045
wdenk2729af92004-05-03 20:45:30 +00004046 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004053
wdenk2729af92004-05-03 20:45:30 +00004054 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004055
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004056 bootm_low - Memory range available for image processing in the bootm
4057 command can be restricted. This variable is given as
4058 a hexadecimal number and defines lowest address allowed
4059 for use by the bootm command. See also "bootm_size"
4060 environment variable. Address defined by "bootm_low" is
4061 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004062 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4063 bootm_mapsize.
4064
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004065 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004066 This variable is given as a hexadecimal number and it
4067 defines the size of the memory region starting at base
4068 address bootm_low that is accessible by the Linux kernel
4069 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4070 as the default value if it is defined, and bootm_size is
4071 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004072
4073 bootm_size - Memory range available for image processing in the bootm
4074 command can be restricted. This variable is given as
4075 a hexadecimal number and defines the size of the region
4076 allowed for use by the bootm command. See also "bootm_low"
4077 environment variable.
4078
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004079 updatefile - Location of the software update file on a TFTP server, used
4080 by the automatic software update feature. Please refer to
4081 documentation in doc/README.update for more details.
4082
wdenk2729af92004-05-03 20:45:30 +00004083 autoload - if set to "no" (any string beginning with 'n'),
4084 "bootp" will just load perform a lookup of the
4085 configuration from the BOOTP server, but not try to
4086 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004087
wdenk2729af92004-05-03 20:45:30 +00004088 autostart - if set to "yes", an image loaded using the "bootp",
4089 "rarpboot", "tftpboot" or "diskboot" commands will
4090 be automatically started (by internally calling
4091 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093 If set to "no", a standalone image passed to the
4094 "bootm" command will be copied to the load address
4095 (and eventually uncompressed), but NOT be started.
4096 This can be used to load and uncompress arbitrary
4097 data.
wdenkc6097192002-11-03 00:24:07 +00004098
David A. Longa28afca2011-07-09 16:40:19 -04004099 fdt_high - if set this restricts the maximum address that the
4100 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004101 For example, if you have a system with 1 GB memory
4102 at physical address 0x10000000, while Linux kernel
4103 only recognizes the first 704 MB as low memory, you
4104 may need to set fdt_high as 0x3C000000 to have the
4105 device tree blob be copied to the maximum address
4106 of the 704 MB low memory, so that Linux kernel can
4107 access it during the boot procedure.
4108
David A. Longa28afca2011-07-09 16:40:19 -04004109 If this is set to the special value 0xFFFFFFFF then
4110 the fdt will not be copied at all on boot. For this
4111 to work it must reside in writable memory, have
4112 sufficient padding on the end of it for u-boot to
4113 add the information it needs into it, and the memory
4114 must be accessible by the kernel.
4115
Simon Glasseea63e02011-10-24 19:15:34 +00004116 fdtcontroladdr- if set this is the address of the control flattened
4117 device tree used by U-Boot when CONFIG_OF_CONTROL is
4118 defined.
4119
wdenk17ea1172004-06-06 21:51:03 +00004120 i2cfast - (PPC405GP|PPC405EP only)
4121 if set to 'y' configures Linux I2C driver for fast
4122 mode (400kHZ). This environment variable is used in
4123 initialization code. So, for changes to be effective
4124 it must be saved and board must be reset.
4125
wdenk2729af92004-05-03 20:45:30 +00004126 initrd_high - restrict positioning of initrd images:
4127 If this variable is not set, initrd images will be
4128 copied to the highest possible address in RAM; this
4129 is usually what you want since it allows for
4130 maximum initrd size. If for some reason you want to
4131 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004132 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004133 variable to a value of "no" or "off" or "0".
4134 Alternatively, you can set it to a maximum upper
4135 address to use (U-Boot will still check that it
4136 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138 For instance, when you have a system with 16 MB
4139 RAM, and want to reserve 4 MB from use by Linux,
4140 you can do this by adding "mem=12M" to the value of
4141 the "bootargs" variable. However, now you must make
4142 sure that the initrd image is placed in the first
4143 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk2729af92004-05-03 20:45:30 +00004145 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004146
wdenk2729af92004-05-03 20:45:30 +00004147 If you set initrd_high to 0xFFFFFFFF, this is an
4148 indication to U-Boot that all addresses are legal
4149 for the Linux kernel, including addresses in flash
4150 memory. In this case U-Boot will NOT COPY the
4151 ramdisk at all. This may be useful to reduce the
4152 boot time on your system, but requires that this
4153 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157 loadaddr - Default load address for commands like "bootp",
4158 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004167
wdenk2729af92004-05-03 20:45:30 +00004168 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004169
Mike Frysingere2a53452011-10-02 10:01:27 +00004170 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004171
Mike Frysingere2a53452011-10-02 10:01:27 +00004172 ethact - controls which interface is currently active.
4173 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004174
Heiko Schocher48690d82010-07-20 17:45:02 +02004175 => setenv ethact FEC
4176 => ping 192.168.0.1 # traffic sent on FEC
4177 => setenv ethact SCC
4178 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004179
Matthias Fuchse1692572008-01-17 07:45:05 +01004180 ethrotate - When set to "no" U-Boot does not go through all
4181 available network interfaces.
4182 It just stays at the currently selected interface.
4183
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004184 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004185 either succeed or fail without retrying.
4186 When set to "once" the network operation will
4187 fail when all the available network interfaces
4188 are tried once without success.
4189 Useful on scripts which control the retry operation
4190 themselves.
wdenkc6097192002-11-03 00:24:07 +00004191
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004192 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004193
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004194 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07004195 changing the console to be empty. If "yes" it will be
4196 made silent. If "no" it will not be made silent. If
4197 unset, then it will be made silent if the U-Boot console
4198 is silent.
4199
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004200 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004201 UDP source port.
4202
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004203 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004204 destination port instead of the Well Know Port 69.
4205
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004206 tftpblocksize - Block size to use for TFTP transfers; if not set,
4207 we use the TFTP server's default block size
4208
4209 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4210 seconds, minimum value is 1000 = 1 second). Defines
4211 when a packet is considered to be lost so it has to
4212 be retransmitted. The default is 5000 = 5 seconds.
4213 Lowering this value may make downloads succeed
4214 faster in networks with high packet loss rates or
4215 with unreliable TFTP servers.
4216
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004217 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4218 unit, minimum value = 0). Defines how many timeouts
4219 can happen during a single file transfer before that
4220 transfer is aborted. The default is 10, and 0 means
4221 'no timeouts allowed'. Increasing this value may help
4222 downloads succeed with high packet loss rates, or with
4223 unreliable TFTP servers or client hardware.
4224
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004225 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004226 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004227 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004228
Alexandre Messier50768f52016-02-01 17:08:57 -05004229 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4230 Unsigned value, in milliseconds. If not set, the period will
4231 be either the default (28000), or a value based on
4232 CONFIG_NET_RETRY_COUNT, if defined. This value has
4233 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4234
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004235The following image location variables contain the location of images
4236used in booting. The "Image" column gives the role of the image and is
4237not an environment variable name. The other columns are environment
4238variable names. "File Name" gives the name of the file on a TFTP
4239server, "RAM Address" gives the location in RAM the image will be
4240loaded to, and "Flash Location" gives the image's address in NOR
4241flash or offset in NAND flash.
4242
4243*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004244boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004245boards use these variables for other purposes.
4246
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004247Image File Name RAM Address Flash Location
4248----- --------- ----------- --------------
4249u-boot u-boot u-boot_addr_r u-boot_addr
4250Linux kernel bootfile kernel_addr_r kernel_addr
4251device tree blob fdtfile fdt_addr_r fdt_addr
4252ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004253
wdenk2729af92004-05-03 20:45:30 +00004254The following environment variables may be used and automatically
4255updated by the network boot commands ("bootp" and "rarpboot"),
4256depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004257
wdenk2729af92004-05-03 20:45:30 +00004258 bootfile - see above
4259 dnsip - IP address of your Domain Name Server
4260 dnsip2 - IP address of your secondary Domain Name Server
4261 gatewayip - IP address of the Gateway (Router) to use
4262 hostname - Target hostname
4263 ipaddr - see above
4264 netmask - Subnet Mask
4265 rootpath - Pathname of the root filesystem on the NFS server
4266 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004267
wdenka3d991b2004-04-15 21:48:45 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk2729af92004-05-03 20:45:30 +00004271 serial# - contains hardware identification information such
4272 as type string and/or serial number
4273 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004274
wdenk2729af92004-05-03 20:45:30 +00004275These variables can be set only once (usually during manufacturing of
4276the board). U-Boot refuses to delete or overwrite these variables
4277once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004278
4279
wdenk2729af92004-05-03 20:45:30 +00004280Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk2729af92004-05-03 20:45:30 +00004282 ver - Contains the U-Boot version string as printed
4283 with the "version" command. This variable is
4284 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004285
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287Please note that changes to some configuration parameters may take
4288only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004289
stroesec1551ea2003-04-04 15:53:41 +00004290
Joe Hershberger170ab112012-12-11 22:16:24 -06004291Callback functions for environment variables:
4292---------------------------------------------
4293
4294For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004295when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004296be associated with arbitrary variables. On creation, overwrite, or
4297deletion, the callback will provide the opportunity for some side
4298effect to happen or for the change to be rejected.
4299
4300The callbacks are named and associated with a function using the
4301U_BOOT_ENV_CALLBACK macro in your board or driver code.
4302
4303These callbacks are associated with variables in one of two ways. The
4304static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4305in the board configuration to a string that defines a list of
4306associations. The list must be in the following format:
4307
4308 entry = variable_name[:callback_name]
4309 list = entry[,list]
4310
4311If the callback name is not specified, then the callback is deleted.
4312Spaces are also allowed anywhere in the list.
4313
4314Callbacks can also be associated by defining the ".callbacks" variable
4315with the same list format above. Any association in ".callbacks" will
4316override any association in the static list. You can define
4317CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004318".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004319
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004320If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4321regular expression. This allows multiple variables to be connected to
4322the same callback without explicitly listing them all out.
4323
Joe Hershberger170ab112012-12-11 22:16:24 -06004324
wdenk2729af92004-05-03 20:45:30 +00004325Command Line Parsing:
4326=====================
stroesec1551ea2003-04-04 15:53:41 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328There are two different command line parsers available with U-Boot:
4329the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331Old, simple command line parser:
4332--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk2729af92004-05-03 20:45:30 +00004334- supports environment variables (through setenv / saveenv commands)
4335- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004336- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004337- special characters ('$', ';') can be escaped by prefixing with '\',
4338 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004339 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004340- You can also escape text by enclosing in single apostrophes, for example:
4341 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343Hush shell:
4344-----------
wdenkf07771c2003-05-28 08:06:31 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346- similar to Bourne shell, with control structures like
4347 if...then...else...fi, for...do...done; while...do...done,
4348 until...do...done, ...
4349- supports environment ("global") variables (through setenv / saveenv
4350 commands) and local shell variables (through standard shell syntax
4351 "name=value"); only environment variables can be used with "run"
4352 command
wdenkf07771c2003-05-28 08:06:31 +00004353
wdenk2729af92004-05-03 20:45:30 +00004354General rules:
4355--------------
wdenkf07771c2003-05-28 08:06:31 +00004356
wdenk2729af92004-05-03 20:45:30 +00004357(1) If a command line (or an environment variable executed by a "run"
4358 command) contains several commands separated by semicolon, and
4359 one of these commands fails, then the remaining commands will be
4360 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004361
wdenk2729af92004-05-03 20:45:30 +00004362(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004363 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004364 command will cause "run" to terminate, i. e. the remaining
4365 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004366
wdenk2729af92004-05-03 20:45:30 +00004367Note for Redundant Ethernet Interfaces:
4368=======================================
wdenkf07771c2003-05-28 08:06:31 +00004369
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004370Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004371such configurations and is capable of automatic selection of a
4372"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4375MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4376"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004377
wdenk2729af92004-05-03 20:45:30 +00004378If the network interface stores some valid MAC address (for instance
4379in SROM), this is used as default address if there is NO correspon-
4380ding setting in the environment; if the corresponding environment
4381variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383o If the SROM has a valid MAC address, and there is no address in the
4384 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386o If there is no valid address in the SROM, and a definition in the
4387 environment exists, then the value from the environment variable is
4388 used.
wdenkc6097192002-11-03 00:24:07 +00004389
wdenk2729af92004-05-03 20:45:30 +00004390o If both the SROM and the environment contain a MAC address, and
4391 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393o If both the SROM and the environment contain a MAC address, and the
4394 addresses differ, the value from the environment is used and a
4395 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004398 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4399 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004400
Ben Warrenecee9322010-04-26 11:11:46 -07004401If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004402will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004403may be skipped by setting the appropriate 'ethmacskip' environment variable.
4404The naming convention is as follows:
4405"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407Image Formats:
4408==============
wdenkc6097192002-11-03 00:24:07 +00004409
Marian Balakowicz3310c542008-03-12 12:13:13 +01004410U-Boot is capable of booting (and performing other auxiliary operations on)
4411images in two formats:
4412
4413New uImage format (FIT)
4414-----------------------
4415
4416Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4417to Flattened Device Tree). It allows the use of images with multiple
4418components (several kernels, ramdisks, etc.), with contents protected by
4419SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4420
4421
4422Old uImage format
4423-----------------
4424
4425Old image format is based on binary files which can be basically anything,
4426preceded by a special header; see the definitions in include/image.h for
4427details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk2729af92004-05-03 20:45:30 +00004429* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4430 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004431 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4432 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4433 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004434* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004435 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004436 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004437* Compression Type (uncompressed, gzip, bzip2)
4438* Load Address
4439* Entry Point
4440* Image Name
4441* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004442
wdenk2729af92004-05-03 20:45:30 +00004443The header is marked by a special Magic Number, and both the header
4444and the data portions of the image are secured against corruption by
4445CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004446
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448Linux Support:
4449==============
wdenkc6097192002-11-03 00:24:07 +00004450
wdenk2729af92004-05-03 20:45:30 +00004451Although U-Boot should support any OS or standalone application
4452easily, the main focus has always been on Linux during the design of
4453U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455U-Boot includes many features that so far have been part of some
4456special "boot loader" code within the Linux kernel. Also, any
4457"initrd" images to be used are no longer part of one big Linux image;
4458instead, kernel and "initrd" are separate images. This implementation
4459serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk2729af92004-05-03 20:45:30 +00004461- the same features can be used for other OS or standalone
4462 applications (for instance: using compressed images to reduce the
4463 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk2729af92004-05-03 20:45:30 +00004465- it becomes much easier to port new Linux kernel versions because
4466 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468- the same Linux kernel image can now be used with different "initrd"
4469 images; of course this also means that different kernel images can
4470 be run with the same "initrd". This makes testing easier (you don't
4471 have to build a new "zImage.initrd" Linux image when you just
4472 change a file in your "initrd"). Also, a field-upgrade of the
4473 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004474
wdenkc6097192002-11-03 00:24:07 +00004475
wdenk2729af92004-05-03 20:45:30 +00004476Linux HOWTO:
4477============
wdenkc6097192002-11-03 00:24:07 +00004478
wdenk2729af92004-05-03 20:45:30 +00004479Porting Linux to U-Boot based systems:
4480---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004481
wdenk2729af92004-05-03 20:45:30 +00004482U-Boot cannot save you from doing all the necessary modifications to
4483configure the Linux device drivers for use with your target hardware
4484(no, we don't intend to provide a full virtual machine interface to
4485Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004486
Stefan Roesea47a12b2010-04-15 16:07:28 +02004487But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk2729af92004-05-03 20:45:30 +00004489Just make sure your machine specific header file (for instance
4490include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004491Information structure as we define in include/asm-<arch>/u-boot.h,
4492and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004493as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004494
Simon Glass2eb31b12014-06-11 23:29:46 -06004495Note that U-Boot now has a driver model, a unified model for drivers.
4496If you are adding a new driver, plumb it into driver model. If there
4497is no uclass available, you are encouraged to create one. See
4498doc/driver-model.
4499
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk2729af92004-05-03 20:45:30 +00004501Configuring the Linux kernel:
4502-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504No specific requirements for U-Boot. Make sure you have some root
4505device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004506
wdenkc6097192002-11-03 00:24:07 +00004507
wdenk2729af92004-05-03 20:45:30 +00004508Building a Linux Image:
4509-----------------------
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk2729af92004-05-03 20:45:30 +00004511With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4512not used. If you use recent kernel source, a new build target
4513"uImage" will exist which automatically builds an image usable by
4514U-Boot. Most older kernels also have support for a "pImage" target,
4515which was introduced for our predecessor project PPCBoot and uses a
4516100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518Example:
wdenkc6097192002-11-03 00:24:07 +00004519
Holger Freytherab584d62014-08-04 09:26:05 +02004520 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004521 make oldconfig
4522 make dep
4523 make uImage
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk2729af92004-05-03 20:45:30 +00004525The "uImage" build target uses a special tool (in 'tools/mkimage') to
4526encapsulate a compressed Linux kernel image with header information,
4527CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk2729af92004-05-03 20:45:30 +00004529* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk2729af92004-05-03 20:45:30 +00004531* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533 ${CROSS_COMPILE}-objcopy -O binary \
4534 -R .note -R .comment \
4535 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk2729af92004-05-03 20:45:30 +00004537* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004542
wdenk2729af92004-05-03 20:45:30 +00004543 mkimage -A ppc -O linux -T kernel -C gzip \
4544 -a 0 -e 0 -n "Linux Kernel Image" \
4545 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004546
wdenk24ee89b2002-11-03 17:56:27 +00004547
wdenk2729af92004-05-03 20:45:30 +00004548The "mkimage" tool can also be used to create ramdisk images for use
4549with U-Boot, either separated from the Linux kernel image, or
4550combined into one file. "mkimage" encapsulates the images with a 64
4551byte header containing information about target architecture,
4552operating system, image type, compression method, entry points, time
4553stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555"mkimage" can be called in two ways: to verify existing images and
4556print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004557
wdenk2729af92004-05-03 20:45:30 +00004558In the first form (with "-l" option) mkimage lists the information
4559contained in the header of an existing U-Boot image; this includes
4560checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004561
wdenk2729af92004-05-03 20:45:30 +00004562 tools/mkimage -l image
4563 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004564
wdenk2729af92004-05-03 20:45:30 +00004565The second form (with "-d" option) is used to build a U-Boot image
4566from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004567
wdenk2729af92004-05-03 20:45:30 +00004568 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4569 -n name -d data_file image
4570 -A ==> set architecture to 'arch'
4571 -O ==> set operating system to 'os'
4572 -T ==> set image type to 'type'
4573 -C ==> set compression type 'comp'
4574 -a ==> set load address to 'addr' (hex)
4575 -e ==> set entry point to 'ep' (hex)
4576 -n ==> set image name to 'name'
4577 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004578
wdenk69459792004-05-29 16:53:29 +00004579Right now, all Linux kernels for PowerPC systems use the same load
4580address (0x00000000), but the entry point address depends on the
4581kernel version:
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583- 2.2.x kernels have the entry point at 0x0000000C,
4584- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk2729af92004-05-03 20:45:30 +00004586So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004587
wdenk2729af92004-05-03 20:45:30 +00004588 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4589 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004590 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004591 > examples/uImage.TQM850L
4592 Image Name: 2.4.4 kernel for TQM850L
4593 Created: Wed Jul 19 02:34:59 2000
4594 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4595 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4596 Load Address: 0x00000000
4597 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004598
wdenk2729af92004-05-03 20:45:30 +00004599To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004600
wdenk2729af92004-05-03 20:45:30 +00004601 -> tools/mkimage -l examples/uImage.TQM850L
4602 Image Name: 2.4.4 kernel for TQM850L
4603 Created: Wed Jul 19 02:34:59 2000
4604 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4605 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4606 Load Address: 0x00000000
4607 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609NOTE: for embedded systems where boot time is critical you can trade
4610speed for memory and install an UNCOMPRESSED image instead: this
4611needs more space in Flash, but boots much faster since it does not
4612need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004613
Stefan Roesea47a12b2010-04-15 16:07:28 +02004614 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004615 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4616 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004617 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004618 > examples/uImage.TQM850L-uncompressed
4619 Image Name: 2.4.4 kernel for TQM850L
4620 Created: Wed Jul 19 02:34:59 2000
4621 Image Type: PowerPC Linux Kernel Image (uncompressed)
4622 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4623 Load Address: 0x00000000
4624 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004625
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk2729af92004-05-03 20:45:30 +00004627Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4628when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630 -> tools/mkimage -n 'Simple Ramdisk Image' \
4631 > -A ppc -O linux -T ramdisk -C gzip \
4632 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4633 Image Name: Simple Ramdisk Image
4634 Created: Wed Jan 12 14:01:50 2000
4635 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4636 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4637 Load Address: 0x00000000
4638 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004639
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004640The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4641option performs the converse operation of the mkimage's second form (the "-d"
4642option). Given an image built by mkimage, the dumpimage extracts a "data file"
4643from the image:
4644
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004645 tools/dumpimage -i image -T type -p position data_file
4646 -i ==> extract from the 'image' a specific 'data_file'
4647 -T ==> set image type to 'type'
4648 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004649
wdenkdb01a2e2004-04-15 23:14:49 +00004650
wdenk2729af92004-05-03 20:45:30 +00004651Installing a Linux Image:
4652-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004653
wdenk2729af92004-05-03 20:45:30 +00004654To downloading a U-Boot image over the serial (console) interface,
4655you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004656
wdenk2729af92004-05-03 20:45:30 +00004657 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004658
wdenk2729af92004-05-03 20:45:30 +00004659The 'objcopy' does not understand the information in the U-Boot
4660image header, so the resulting S-Record file will be relative to
4661address 0x00000000. To load it to a given address, you need to
4662specify the target address as 'offset' parameter with the 'loads'
4663command.
wdenkc6097192002-11-03 00:24:07 +00004664
wdenk2729af92004-05-03 20:45:30 +00004665Example: install the image to address 0x40100000 (which on the
4666TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk2729af92004-05-03 20:45:30 +00004668 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk2729af92004-05-03 20:45:30 +00004670 .......... done
4671 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004672
wdenk2729af92004-05-03 20:45:30 +00004673 => loads 40100000
4674 ## Ready for S-Record download ...
4675 ~>examples/image.srec
4676 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4677 ...
4678 15989 15990 15991 15992
4679 [file transfer complete]
4680 [connected]
4681 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004682
4683
wdenk2729af92004-05-03 20:45:30 +00004684You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004685this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004686corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk2729af92004-05-03 20:45:30 +00004688 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690 ## Checking Image at 40100000 ...
4691 Image Name: 2.2.13 for initrd on TQM850L
4692 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4693 Data Size: 335725 Bytes = 327 kB = 0 MB
4694 Load Address: 00000000
4695 Entry Point: 0000000c
4696 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004697
4698
wdenk2729af92004-05-03 20:45:30 +00004699Boot Linux:
4700-----------
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702The "bootm" command is used to boot an application that is stored in
4703memory (RAM or Flash). In case of a Linux kernel image, the contents
4704of the "bootargs" environment variable is passed to the kernel as
4705parameters. You can check and modify this variable using the
4706"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004707
4708
wdenk2729af92004-05-03 20:45:30 +00004709 => printenv bootargs
4710 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004711
wdenk2729af92004-05-03 20:45:30 +00004712 => 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 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714 => printenv bootargs
4715 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 +00004716
wdenk2729af92004-05-03 20:45:30 +00004717 => bootm 40020000
4718 ## Booting Linux kernel at 40020000 ...
4719 Image Name: 2.2.13 for NFS on TQM850L
4720 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4721 Data Size: 381681 Bytes = 372 kB = 0 MB
4722 Load Address: 00000000
4723 Entry Point: 0000000c
4724 Verifying Checksum ... OK
4725 Uncompressing Kernel Image ... OK
4726 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
4727 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4728 time_init: decrementer frequency = 187500000/60
4729 Calibrating delay loop... 49.77 BogoMIPS
4730 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4731 ...
wdenkc6097192002-11-03 00:24:07 +00004732
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004733If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004734the memory addresses of both the kernel and the initrd image (PPBCOOT
4735format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004736
wdenk2729af92004-05-03 20:45:30 +00004737 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk2729af92004-05-03 20:45:30 +00004739 ## Checking Image at 40100000 ...
4740 Image Name: 2.2.13 for initrd on TQM850L
4741 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4742 Data Size: 335725 Bytes = 327 kB = 0 MB
4743 Load Address: 00000000
4744 Entry Point: 0000000c
4745 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747 ## Checking Image at 40200000 ...
4748 Image Name: Simple Ramdisk Image
4749 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4750 Data Size: 566530 Bytes = 553 kB = 0 MB
4751 Load Address: 00000000
4752 Entry Point: 00000000
4753 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755 => bootm 40100000 40200000
4756 ## Booting Linux kernel at 40100000 ...
4757 Image Name: 2.2.13 for initrd on TQM850L
4758 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4759 Data Size: 335725 Bytes = 327 kB = 0 MB
4760 Load Address: 00000000
4761 Entry Point: 0000000c
4762 Verifying Checksum ... OK
4763 Uncompressing Kernel Image ... OK
4764 ## Loading RAMDisk Image at 40200000 ...
4765 Image Name: Simple Ramdisk Image
4766 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4767 Data Size: 566530 Bytes = 553 kB = 0 MB
4768 Load Address: 00000000
4769 Entry Point: 00000000
4770 Verifying Checksum ... OK
4771 Loading Ramdisk ... OK
4772 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
4773 Boot arguments: root=/dev/ram
4774 time_init: decrementer frequency = 187500000/60
4775 Calibrating delay loop... 49.77 BogoMIPS
4776 ...
4777 RAMDISK: Compressed image found at block 0
4778 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780 bash#
wdenkc6097192002-11-03 00:24:07 +00004781
Matthew McClintock02677682006-06-28 10:41:37 -05004782Boot Linux and pass a flat device tree:
4783-----------
4784
4785First, U-Boot must be compiled with the appropriate defines. See the section
4786titled "Linux Kernel Interface" above for a more in depth explanation. The
4787following is an example of how to start a kernel and pass an updated
4788flat device tree:
4789
4790=> print oftaddr
4791oftaddr=0x300000
4792=> print oft
4793oft=oftrees/mpc8540ads.dtb
4794=> tftp $oftaddr $oft
4795Speed: 1000, full duplex
4796Using TSEC0 device
4797TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4798Filename 'oftrees/mpc8540ads.dtb'.
4799Load address: 0x300000
4800Loading: #
4801done
4802Bytes transferred = 4106 (100a hex)
4803=> tftp $loadaddr $bootfile
4804Speed: 1000, full duplex
4805Using TSEC0 device
4806TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4807Filename 'uImage'.
4808Load address: 0x200000
4809Loading:############
4810done
4811Bytes transferred = 1029407 (fb51f hex)
4812=> print loadaddr
4813loadaddr=200000
4814=> print oftaddr
4815oftaddr=0x300000
4816=> bootm $loadaddr - $oftaddr
4817## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004818 Image Name: Linux-2.6.17-dirty
4819 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4820 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004821 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004822 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004823 Verifying Checksum ... OK
4824 Uncompressing Kernel Image ... OK
4825Booting using flat device tree at 0x300000
4826Using MPC85xx ADS machine description
4827Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4828[snip]
4829
4830
wdenk2729af92004-05-03 20:45:30 +00004831More About U-Boot Image Types:
4832------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836 "Standalone Programs" are directly runnable in the environment
4837 provided by U-Boot; it is expected that (if they behave
4838 well) you can continue to work in U-Boot after return from
4839 the Standalone Program.
4840 "OS Kernel Images" are usually images of some Embedded OS which
4841 will take over control completely. Usually these programs
4842 will install their own set of exception handlers, device
4843 drivers, set up the MMU, etc. - this means, that you cannot
4844 expect to re-enter U-Boot except by resetting the CPU.
4845 "RAMDisk Images" are more or less just data blocks, and their
4846 parameters (address, size) are passed to an OS kernel that is
4847 being started.
4848 "Multi-File Images" contain several images, typically an OS
4849 (Linux) kernel image and one or more data images like
4850 RAMDisks. This construct is useful for instance when you want
4851 to boot over the network using BOOTP etc., where the boot
4852 server provides just a single image file, but you want to get
4853 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004854
wdenk2729af92004-05-03 20:45:30 +00004855 "Multi-File Images" start with a list of image sizes, each
4856 image size (in bytes) specified by an "uint32_t" in network
4857 byte order. This list is terminated by an "(uint32_t)0".
4858 Immediately after the terminating 0 follow the images, one by
4859 one, all aligned on "uint32_t" boundaries (size rounded up to
4860 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862 "Firmware Images" are binary images containing firmware (like
4863 U-Boot or FPGA images) which usually will be programmed to
4864 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866 "Script files" are command sequences that will be executed by
4867 U-Boot's command interpreter; this feature is especially
4868 useful when you configure U-Boot to use a real shell (hush)
4869 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004870
Marek Vasut44f074c2012-03-14 21:52:45 +00004871Booting the Linux zImage:
4872-------------------------
4873
4874On some platforms, it's possible to boot Linux zImage. This is done
4875using the "bootz" command. The syntax of "bootz" command is the same
4876as the syntax of "bootm" command.
4877
Tom Rini8ac28562013-05-16 11:40:11 -04004878Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004879kernel with raw initrd images. The syntax is slightly different, the
4880address of the initrd must be augmented by it's size, in the following
4881format: "<initrd addres>:<initrd size>".
4882
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk2729af92004-05-03 20:45:30 +00004884Standalone HOWTO:
4885=================
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887One of the features of U-Boot is that you can dynamically load and
4888run "standalone" applications, which can use some resources of
4889U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893"Hello World" Demo:
4894-------------------
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk2729af92004-05-03 20:45:30 +00004896'examples/hello_world.c' contains a small "Hello World" Demo
4897application; it is automatically compiled when you build U-Boot.
4898It's configured to run at address 0x00040004, so you can play with it
4899like that:
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk2729af92004-05-03 20:45:30 +00004901 => loads
4902 ## Ready for S-Record download ...
4903 ~>examples/hello_world.srec
4904 1 2 3 4 5 6 7 8 9 10 11 ...
4905 [file transfer complete]
4906 [connected]
4907 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk2729af92004-05-03 20:45:30 +00004909 => go 40004 Hello World! This is a test.
4910 ## Starting application at 0x00040004 ...
4911 Hello World
4912 argc = 7
4913 argv[0] = "40004"
4914 argv[1] = "Hello"
4915 argv[2] = "World!"
4916 argv[3] = "This"
4917 argv[4] = "is"
4918 argv[5] = "a"
4919 argv[6] = "test."
4920 argv[7] = "<NULL>"
4921 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004922
wdenk2729af92004-05-03 20:45:30 +00004923 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk2729af92004-05-03 20:45:30 +00004925Another example, which demonstrates how to register a CPM interrupt
4926handler with the U-Boot code, can be found in 'examples/timer.c'.
4927Here, a CPM timer is set up to generate an interrupt every second.
4928The interrupt service routine is trivial, just printing a '.'
4929character, but this is just a demo program. The application can be
4930controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004931
wdenk2729af92004-05-03 20:45:30 +00004932 ? - print current values og the CPM Timer registers
4933 b - enable interrupts and start timer
4934 e - stop timer and disable interrupts
4935 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk2729af92004-05-03 20:45:30 +00004937 => loads
4938 ## Ready for S-Record download ...
4939 ~>examples/timer.srec
4940 1 2 3 4 5 6 7 8 9 10 11 ...
4941 [file transfer complete]
4942 [connected]
4943 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk2729af92004-05-03 20:45:30 +00004945 => go 40004
4946 ## Starting application at 0x00040004 ...
4947 TIMERS=0xfff00980
4948 Using timer 1
4949 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk2729af92004-05-03 20:45:30 +00004951Hit 'b':
4952 [q, b, e, ?] Set interval 1000000 us
4953 Enabling timer
4954Hit '?':
4955 [q, b, e, ?] ........
4956 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4957Hit '?':
4958 [q, b, e, ?] .
4959 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4960Hit '?':
4961 [q, b, e, ?] .
4962 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4963Hit '?':
4964 [q, b, e, ?] .
4965 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4966Hit 'e':
4967 [q, b, e, ?] ...Stopping timer
4968Hit 'q':
4969 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004970
4971
wdenk2729af92004-05-03 20:45:30 +00004972Minicom warning:
4973================
wdenk85ec0bc2003-03-31 16:34:49 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975Over time, many people have reported problems when trying to use the
4976"minicom" terminal emulation program for serial download. I (wd)
4977consider minicom to be broken, and recommend not to use it. Under
4978Unix, I recommend to use C-Kermit for general purpose use (and
4979especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004980use "cu" for S-Record download ("loads" command). See
4981http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4982for help with kermit.
4983
wdenk85ec0bc2003-03-31 16:34:49 +00004984
wdenk2729af92004-05-03 20:45:30 +00004985Nevertheless, if you absolutely want to use it try adding this
4986configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988 Name Program Name U/D FullScr IO-Red. Multi
4989 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4990 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004991
4992
wdenk2729af92004-05-03 20:45:30 +00004993NetBSD Notes:
4994=============
wdenkc6097192002-11-03 00:24:07 +00004995
wdenk2729af92004-05-03 20:45:30 +00004996Starting at version 0.9.2, U-Boot supports NetBSD both as host
4997(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk2729af92004-05-03 20:45:30 +00004999Building requires a cross environment; it is known to work on
5000NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5001need gmake since the Makefiles are not compatible with BSD make).
5002Note that the cross-powerpc package does not install include files;
5003attempting to build U-Boot will fail because <machine/ansi.h> is
5004missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk2729af92004-05-03 20:45:30 +00005006 # cd /usr/pkg/cross/powerpc-netbsd/include
5007 # mkdir powerpc
5008 # ln -s powerpc machine
5009 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5010 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005011
wdenk2729af92004-05-03 20:45:30 +00005012Native builds *don't* work due to incompatibilities between native
5013and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk2729af92004-05-03 20:45:30 +00005015Booting assumes that (the first part of) the image booted is a
5016stage-2 loader which in turn loads and then invokes the kernel
5017proper. Loader sources will eventually appear in the NetBSD source
5018tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005019meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005020
5021
wdenk2729af92004-05-03 20:45:30 +00005022Implementation Internals:
5023=========================
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025The following is not intended to be a complete description of every
5026implementation detail. However, it should help to understand the
5027inner workings of U-Boot and make it easier to port it to custom
5028hardware.
wdenkc6097192002-11-03 00:24:07 +00005029
5030
wdenk2729af92004-05-03 20:45:30 +00005031Initial Stack, Global Data:
5032---------------------------
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk2729af92004-05-03 20:45:30 +00005034The implementation of U-Boot is complicated by the fact that U-Boot
5035starts running out of ROM (flash memory), usually without access to
5036system RAM (because the memory controller is not initialized yet).
5037This means that we don't have writable Data or BSS segments, and BSS
5038is not initialized as zero. To be able to get a C environment working
5039at all, we have to allocate at least a minimal stack. Implementation
5040options for this are defined and restricted by the CPU used: Some CPU
5041models provide on-chip memory (like the IMMR area on MPC8xx and
5042MPC826x processors), on others (parts of) the data cache can be
5043locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005044
Wolfgang Denk218ca722008-03-26 10:40:12 +01005045 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005046 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005047
wdenk2729af92004-05-03 20:45:30 +00005048 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5049 From: "Chris Hallinan" <clh@net1plus.com>
5050 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5051 ...
wdenk43d96162003-03-06 00:02:04 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053 Correct me if I'm wrong, folks, but the way I understand it
5054 is this: Using DCACHE as initial RAM for Stack, etc, does not
5055 require any physical RAM backing up the cache. The cleverness
5056 is that the cache is being used as a temporary supply of
5057 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005058 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005059 can see how this works by studying the cache architecture and
5060 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005061
wdenk2729af92004-05-03 20:45:30 +00005062 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5063 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005064 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005065 option should work for you. Using CS 4 should be fine if your
5066 board designers haven't used it for something that would
5067 cause you grief during the initial boot! It is frequently not
5068 used.
wdenk43d96162003-03-06 00:02:04 +00005069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005070 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005071 with your processor/board/system design. The default value
5072 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005073 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005074 than your SDRAM module. If you have a 64MB SDRAM module, set
5075 it above 400_0000. Just make sure your board has no resources
5076 that are supposed to respond to that address! That code in
5077 start.S has been around a while and should work as is when
5078 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080 -Chris Hallinan
5081 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005082
wdenk2729af92004-05-03 20:45:30 +00005083It is essential to remember this, since it has some impact on the C
5084code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005085
wdenk2729af92004-05-03 20:45:30 +00005086* Initialized global data (data segment) is read-only. Do not attempt
5087 to write it.
wdenkc6097192002-11-03 00:24:07 +00005088
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005089* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00005090 as zero data - BSS segment) at all - this is undefined, initiali-
5091 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093* Stack space is very limited. Avoid big data buffers or things like
5094 that.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk2729af92004-05-03 20:45:30 +00005096Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005097normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00005098turned out that the implementation of U-Boot can be greatly
5099simplified by making a global data structure (gd_t) available to all
5100functions. We could pass a pointer to this data as argument to _all_
5101functions, but this would bloat the code. Instead we use a feature of
5102the GCC compiler (Global Register Variables) to share the data: we
5103place a pointer (gd) to the global data into a register which we
5104reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk2729af92004-05-03 20:45:30 +00005106When choosing a register for such a purpose we are restricted by the
5107relevant (E)ABI specifications for the current architecture, and by
5108GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110For PowerPC, the following registers have specific use:
5111 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005112 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005113 R3-R4: parameter passing and return values
5114 R5-R10: parameter passing
5115 R13: small data area pointer
5116 R30: GOT pointer
5117 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005118
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005119 (U-Boot also uses R12 as internal GOT pointer. r12
5120 is a volatile register so r12 needs to be reset when
5121 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005122
Wolfgang Denke7670f62008-02-14 22:43:22 +01005123 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125 Note: on PPC, we could use a static initializer (since the
5126 address of the global data structure is known at compile time),
5127 but it turned out that reserving a register results in somewhat
5128 smaller code - although the code savings are not that big (on
5129 average for all boards 752 bytes for the whole U-Boot image,
5130 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk2729af92004-05-03 20:45:30 +00005132On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk2729af92004-05-03 20:45:30 +00005134 R0: function argument word/integer result
5135 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005136 R9: platform specific
5137 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005138 R11: argument (frame) pointer
5139 R12: temporary workspace
5140 R13: stack pointer
5141 R14: link register
5142 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005143
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005144 ==> U-Boot will use R9 to hold a pointer to the global data
5145
5146 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005147
Thomas Chou0df01fd2010-05-21 11:08:03 +08005148On Nios II, the ABI is documented here:
5149 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5150
5151 ==> U-Boot will use gp to hold a pointer to the global data
5152
5153 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5154 to access small data sections, so gp is free.
5155
Macpaul Linafc1ce82011-10-19 20:41:11 +00005156On NDS32, the following registers are used:
5157
5158 R0-R1: argument/return
5159 R2-R5: argument
5160 R15: temporary register for assembler
5161 R16: trampoline register
5162 R28: frame pointer (FP)
5163 R29: global pointer (GP)
5164 R30: link register (LP)
5165 R31: stack pointer (SP)
5166 PC: program counter (PC)
5167
5168 ==> U-Boot will use R10 to hold a pointer to the global data
5169
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005170NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5171or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173Memory Management:
5174------------------
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176U-Boot runs in system state and uses physical addresses, i.e. the
5177MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk2729af92004-05-03 20:45:30 +00005179The available memory is mapped to fixed addresses using the memory
5180controller. In this process, a contiguous block is formed for each
5181memory type (Flash, SDRAM, SRAM), even when it consists of several
5182physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk2729af92004-05-03 20:45:30 +00005184U-Boot is installed in the first 128 kB of the first Flash bank (on
5185TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5186booting and sizing and initializing DRAM, the code relocates itself
5187to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005188memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005189configuration setting]. Below that, a structure with global Board
5190Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192Additionally, some exception handler code is copied to the low 8 kB
5193of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195So a typical memory configuration with 16 MB of DRAM could look like
5196this:
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198 0x0000 0000 Exception Vector code
5199 :
5200 0x0000 1FFF
5201 0x0000 2000 Free for Application Use
5202 :
5203 :
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk2729af92004-05-03 20:45:30 +00005205 :
5206 :
5207 0x00FB FF20 Monitor Stack (Growing downward)
5208 0x00FB FFAC Board Info Data and permanent copy of global data
5209 0x00FC 0000 Malloc Arena
5210 :
5211 0x00FD FFFF
5212 0x00FE 0000 RAM Copy of Monitor Code
5213 ... eventually: LCD or video framebuffer
5214 ... eventually: pRAM (Protected RAM - unchanged by reset)
5215 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005216
5217
wdenk2729af92004-05-03 20:45:30 +00005218System Initialization:
5219----------------------
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk2729af92004-05-03 20:45:30 +00005221In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005222(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005223configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005224To be able to re-map memory U-Boot then jumps to its link address.
5225To be able to implement the initialization code in C, a (small!)
5226initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02005227which provide such a feature like), or in a locked part of the data
5228cache. After that, U-Boot initializes the CPU core, the caches and
5229the SIU.
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231Next, all (potentially) available memory banks are mapped using a
5232preliminary mapping. For example, we put them on 512 MB boundaries
5233(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5234on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5235programmed for SDRAM access. Using the temporary configuration, a
5236simple memory test is run that determines the size of the SDRAM
5237banks.
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk2729af92004-05-03 20:45:30 +00005239When there is more than one SDRAM bank, and the banks are of
5240different size, the largest is mapped first. For equal size, the first
5241bank (CS2#) is mapped first. The first mapping is always for address
52420x00000000, with any additional banks following immediately to create
5243contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk2729af92004-05-03 20:45:30 +00005245Then, the monitor installs itself at the upper end of the SDRAM area
5246and allocates memory for use by malloc() and for the global Board
5247Info data; also, the exception vector code is copied to the low RAM
5248pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk2729af92004-05-03 20:45:30 +00005250Only after this relocation will you have a "normal" C environment;
5251until that you are restricted in several ways, mostly because you are
5252running from ROM, and because the code will have to be relocated to a
5253new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005254
5255
wdenk2729af92004-05-03 20:45:30 +00005256U-Boot Porting Guide:
5257----------------------
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk2729af92004-05-03 20:45:30 +00005259[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5260list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005261
5262
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005263int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005264{
5265 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005266
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005267 signal(SIGALRM, no_more_time);
5268 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk2729af92004-05-03 20:45:30 +00005270 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005271 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005272 return 0;
5273 }
5274
wdenk2729af92004-05-03 20:45:30 +00005275 Download latest U-Boot source;
5276
Wolfgang Denk06682362008-12-30 22:56:11 +01005277 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005278
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005279 if (clueless)
5280 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk2729af92004-05-03 20:45:30 +00005282 while (learning) {
5283 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005284 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5285 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005286 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005287 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005288 }
wdenkc6097192002-11-03 00:24:07 +00005289
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005290 if (available_money > toLocalCurrency ($2500))
5291 Buy a BDI3000;
5292 else
wdenk2729af92004-05-03 20:45:30 +00005293 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005294
5295 if (a similar board exists) { /* hopefully... */
5296 cp -a board/<similar> board/<myboard>
5297 cp include/configs/<similar>.h include/configs/<myboard>.h
5298 } else {
5299 Create your own board support subdirectory;
5300 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005301 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005302 Edit new board/<myboard> files
5303 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005304
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005305 while (!accepted) {
5306 while (!running) {
5307 do {
5308 Add / modify source code;
5309 } until (compiles);
5310 Debug;
5311 if (clueless)
5312 email("Hi, I am having problems...");
5313 }
5314 Send patch file to the U-Boot email list;
5315 if (reasonable critiques)
5316 Incorporate improvements from email list code review;
5317 else
5318 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005319 }
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk2729af92004-05-03 20:45:30 +00005321 return 0;
5322}
5323
5324void no_more_time (int sig)
5325{
5326 hire_a_guru();
5327}
wdenkc6097192002-11-03 00:24:07 +00005328
5329
wdenk2729af92004-05-03 20:45:30 +00005330Coding Standards:
5331-----------------
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk2729af92004-05-03 20:45:30 +00005333All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005334coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005335"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005336
Detlev Zundel2c051652006-09-01 15:39:02 +02005337Source files originating from a different project (for example the
5338MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005339reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005340sources.
5341
5342Please note that U-Boot is implemented in C (and to some small parts in
5343Assembler); no C++ is used, so please do not use C++ style comments (//)
5344in your code.
wdenk2729af92004-05-03 20:45:30 +00005345
5346Please also stick to the following formatting rules:
5347- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005348- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005349- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005350- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005351- do not add trailing empty lines to source files
5352
5353Submissions which do not conform to the standards may be returned
5354with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005355
5356
wdenk2729af92004-05-03 20:45:30 +00005357Submitting Patches:
5358-------------------
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk2729af92004-05-03 20:45:30 +00005360Since the number of patches for U-Boot is growing, we need to
5361establish some rules. Submissions which do not conform to these rules
5362may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005363
Magnus Lilja0d28f342008-08-06 19:32:33 +02005364Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005365
Wolfgang Denk06682362008-12-30 22:56:11 +01005366Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5367see http://lists.denx.de/mailman/listinfo/u-boot
5368
wdenk2729af92004-05-03 20:45:30 +00005369When you send a patch, please include the following information with
5370it:
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372* For bug fixes: a description of the bug and how your patch fixes
5373 this bug. Please try to include a way of demonstrating that the
5374 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376* For new features: a description of the feature and your
5377 implementation.
wdenkc6097192002-11-03 00:24:07 +00005378
wdenk2729af92004-05-03 20:45:30 +00005379* A CHANGELOG entry as plaintext (separate from the patch)
5380
Robert P. J. Day7207b362015-12-19 07:16:10 -05005381* For major contributions, add a MAINTAINERS file with your
5382 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005383
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005384* When you add support for a new board, don't forget to add a
5385 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005386
5387* If your patch adds new configuration options, don't forget to
5388 document these in the README file.
5389
Wolfgang Denk218ca722008-03-26 10:40:12 +01005390* The patch itself. If you are using git (which is *strongly*
5391 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005392 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005393 the U-Boot mailing list, you will avoid most of the common problems
5394 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005395
Wolfgang Denk218ca722008-03-26 10:40:12 +01005396 If you cannot use git, use "diff -purN OLD NEW". If your version of
5397 diff does not support these options, then get the latest version of
5398 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005399
Wolfgang Denk218ca722008-03-26 10:40:12 +01005400 The current directory when running this command shall be the parent
5401 directory of the U-Boot source tree (i. e. please make sure that
5402 your patch includes sufficient directory information for the
5403 affected files).
5404
5405 We prefer patches as plain text. MIME attachments are discouraged,
5406 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005407
5408* If one logical set of modifications affects or creates several
5409 files, all these changes shall be submitted in a SINGLE patch file.
5410
5411* Changesets that contain different, unrelated modifications shall be
5412 submitted as SEPARATE patches, one patch per changeset.
5413
5414
5415Notes:
5416
Simon Glass6de80f22016-07-27 20:33:08 -06005417* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005418 source tree and make sure that no errors or warnings are reported
5419 for any of the boards.
5420
5421* Keep your modifications to the necessary minimum: A patch
5422 containing several unrelated changes or arbitrary reformats will be
5423 returned with a request to re-formatting / split it.
5424
5425* If you modify existing code, make sure that your new code does not
5426 add to the memory footprint of the code ;-) Small is beautiful!
5427 When adding new features, these should compile conditionally only
5428 (using #ifdef), and the resulting code with the new feature
5429 disabled must not need more memory than the old code without your
5430 modification.
wdenk90dc6702005-05-03 14:12:25 +00005431
Wolfgang Denk06682362008-12-30 22:56:11 +01005432* Remember that there is a size limit of 100 kB per message on the
5433 u-boot mailing list. Bigger patches will be moderated. If they are
5434 reasonable and not too big, they will be acknowledged. But patches
5435 bigger than the size limit should be avoided.