blob: 083485067654c319b7f7b84227ae23c689467b1d [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000043
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050061The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010062git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Simon Glassaaef3bf2019-08-01 09:47:14 -060086 * ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500137 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000140 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400142 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200143 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800144 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500145 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400147 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148/api Machine/arch independent API for external apps
149/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800150/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500152/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/disk Code for disk drive partition handling
154/doc Documentation (don't expect too much)
155/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400156/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157/examples Example code for standalone applications, etc.
158/fs Filesystem code (cramfs, ext2, jffs2, etc.)
159/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500160/lib Library routines generic to all architectures
161/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500162/net Networking code
163/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500164/scripts Various build scripts and Makefiles
165/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000167
wdenkc6097192002-11-03 00:24:07 +0000168Software Configuration:
169=======================
170
171Configuration is usually done using C preprocessor defines; the
172rationale behind that is to avoid dead code whenever possible.
173
174There are two classes of configuration variables:
175
176* Configuration _OPTIONS_:
177 These are selectable by the user and have names beginning with
178 "CONFIG_".
179
180* Configuration _SETTINGS_:
181 These depend on the hardware etc. and should not be meddled with if
182 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200183 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000184
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500185Previously, all configuration was done by hand, which involved creating
186symbolic links and editing configuration files manually. More recently,
187U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188allowing you to use the "make menuconfig" command to configure your
189build.
wdenkc6097192002-11-03 00:24:07 +0000190
191
192Selection of Processor Architecture and Board Type:
193---------------------------------------------------
194
195For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200196configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000197
198Example: For a TQM823L module type:
199
200 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200201 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000202
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500203Note: If you're looking for the default configuration file for a board
204you're sure used to be there but is now missing, check the file
205doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000206
Simon Glass53552c92014-03-22 17:12:59 -0600207Sandbox Environment:
208--------------------
209
210U-Boot can be built natively to run on a Linux host using the 'sandbox'
211board. This allows feature development which is not board- or architecture-
212specific to be undertaken on a native platform. The sandbox is also used to
213run some of U-Boot's tests.
214
Keerthyfa002552019-07-29 13:52:04 +0530215See doc/arch/index.rst for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600216
217
Simon Glassd8711af2015-03-03 08:03:00 -0700218Board Initialisation Flow:
219--------------------------
220
221This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500222SPL and U-Boot proper (i.e. they both follow the same rules).
223
224Note: "SPL" stands for "Secondary Program Loader," which is explained in
225more detail later in this file.
226
227At present, SPL mostly uses a separate code path, but the function names
228and roles of each function are the same. Some boards or architectures
229may not conform to this. At least most ARM boards which use
230CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700231
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500232Execution typically starts with an architecture-specific (and possibly
233CPU-specific) start.S file, such as:
234
235 - arch/arm/cpu/armv7/start.S
236 - arch/powerpc/cpu/mpc83xx/start.S
237 - arch/mips/cpu/start.S
238
239and so on. From there, three functions are called; the purpose and
240limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700241
242lowlevel_init():
243 - purpose: essential init to permit execution to reach board_init_f()
244 - no global_data or BSS
245 - there is no stack (ARMv7 may have one but it will soon be removed)
246 - must not set up SDRAM or use console
247 - must only do the bare minimum to allow execution to continue to
248 board_init_f()
249 - this is almost never needed
250 - return normally from this function
251
252board_init_f():
253 - purpose: set up the machine ready for running board_init_r():
254 i.e. SDRAM and serial UART
255 - global_data is available
256 - stack is in SRAM
257 - BSS is not available, so you cannot use global/static variables,
258 only stack variables and global_data
259
260 Non-SPL-specific notes:
261 - dram_init() is called to set up DRAM. If already done in SPL this
262 can do nothing
263
264 SPL-specific notes:
265 - you can override the entire board_init_f() function with your own
266 version as needed.
267 - preloader_console_init() can be called here in extremis
268 - should set up SDRAM, and anything needed to make the UART work
269 - these is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg7673bed2019-08-08 12:54:49 -0500270 - for specific scenarios on certain architectures an early BSS *can*
271 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
272 of BSS prior to entering board_init_f()) but doing so is discouraged.
273 Instead it is strongly recommended to architect any code changes
274 or additions such to not depend on the availability of BSS during
275 board_init_f() as indicated in other sections of this README to
276 maintain compatibility and consistency across the entire code base.
Simon Glassd8711af2015-03-03 08:03:00 -0700277 - must return normally from this function (don't call board_init_r()
278 directly)
279
280Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
281this point the stack and global_data are relocated to below
282CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
283memory.
284
285board_init_r():
286 - purpose: main execution, common code
287 - global_data is available
288 - SDRAM is available
289 - BSS is available, all static/global variables can be used
290 - execution eventually continues to main_loop()
291
292 Non-SPL-specific notes:
293 - U-Boot is relocated to the top of memory and is now running from
294 there.
295
296 SPL-specific notes:
297 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
298 CONFIG_SPL_STACK_R_ADDR points into SDRAM
299 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800300 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700301 spl_board_init() function containing this call
302 - loads U-Boot or (in falcon mode) Linux
303
304
305
wdenkc6097192002-11-03 00:24:07 +0000306Configuration Options:
307----------------------
308
309Configuration depends on the combination of board and CPU type; all
310such information is kept in a configuration file
311"include/configs/<board_name>.h".
312
313Example: For a TQM823L module, all configuration settings are in
314"include/configs/TQM823L.h".
315
316
wdenk1272e232002-11-10 22:06:23 +0000317Many of the options are named exactly as the corresponding Linux
318kernel configuration options. The intention is to make it easier to
319build a config tool - later.
320
Ashish Kumar11234062017-08-11 11:09:14 +0530321- ARM Platform Bus Type(CCI):
322 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
323 provides full cache coherency between two clusters of multi-core
324 CPUs and I/O coherency for devices and I/O masters
325
326 CONFIG_SYS_FSL_HAS_CCI400
327
328 Defined For SoC that has cache coherent interconnect
329 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000330
Ashish Kumar97393d62017-08-18 10:54:36 +0530331 CONFIG_SYS_FSL_HAS_CCN504
332
333 Defined for SoC that has cache coherent interconnect CCN-504
334
wdenkc6097192002-11-03 00:24:07 +0000335The following options need to be configured:
336
Kim Phillips203fee32007-08-10 13:28:25 -0500337- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000338
Kim Phillips203fee32007-08-10 13:28:25 -0500339- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200340
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600341- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000342 CONFIG_SYS_PPC64
343
344 Specifies that the core is a 64-bit PowerPC implementation (implements
345 the "64" category of the Power ISA). This is necessary for ePAPR
346 compliance, among other possible reasons.
347
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600348 CONFIG_SYS_FSL_TBCLK_DIV
349
350 Defines the core time base clock divider ratio compared to the
351 system clock. On most PQ3 devices this is 8, on newer QorIQ
352 devices it can be 16 or 32. The ratio varies from SoC to Soc.
353
Kumar Gala179b1b22011-05-20 00:39:21 -0500354 CONFIG_SYS_FSL_PCIE_COMPAT
355
356 Defines the string to utilize when trying to match PCIe device
357 tree nodes for the given platform.
358
Scott Wood80806962012-08-14 10:14:53 +0000359 CONFIG_SYS_FSL_ERRATUM_A004510
360
361 Enables a workaround for erratum A004510. If set,
362 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
364
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
367
368 Defines one or two SoC revisions (low 8 bits of SVR)
369 for which the A004510 workaround should be applied.
370
371 The rest of SVR is either not relevant to the decision
372 of whether the erratum is present (e.g. p2040 versus
373 p2041) or is implied by the build target, which controls
374 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
375
376 See Freescale App Note 4493 for more information about
377 this erratum.
378
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530379 CONFIG_A003399_NOR_WORKAROUND
380 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800381 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530382
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530383 CONFIG_A008044_WORKAROUND
384 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800385 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530386
Scott Wood80806962012-08-14 10:14:53 +0000387 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
388
389 This is the value to write into CCSR offset 0x18600
390 according to the A004510 workaround.
391
Priyanka Jainc73b9032013-07-02 09:21:04 +0530392 CONFIG_SYS_FSL_DSP_DDR_ADDR
393 This value denotes start offset of DDR memory which is
394 connected exclusively to the DSP cores.
395
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530396 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397 This value denotes start offset of M2 memory
398 which is directly connected to the DSP core.
399
Priyanka Jainc73b9032013-07-02 09:21:04 +0530400 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401 This value denotes start offset of M3 memory which is directly
402 connected to the DSP core.
403
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530404 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405 This value denotes start offset of DSP CCSR space.
406
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530407 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408 Single Source Clock is clocking mode present in some of FSL SoC's.
409 In this mode, a single differential clock is used to supply
410 clocks to the sysclock, ddrclock and usbclock.
411
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530412 CONFIG_SYS_CPC_REINIT_F
413 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800414 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530415
Tang Yuantiana7364af2014-04-17 15:33:46 +0800416 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800417 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800418 supported, core will start to execute uboot when wakes up.
419
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000420- Generic CPU options:
421 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
422
423 Defines the endianess of the CPU. Implementation of those
424 values is arch specific.
425
York Sunf0626592013-09-30 09:22:09 -0700426 CONFIG_SYS_FSL_DDR
427 Freescale DDR driver in use. This type of DDR controller is
428 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
429 SoCs.
430
431 CONFIG_SYS_FSL_DDR_ADDR
432 Freescale DDR memory-mapped register base.
433
434 CONFIG_SYS_FSL_DDR_EMU
435 Specify emulator support for DDR. Some DDR features such as
436 deskew training are not available.
437
438 CONFIG_SYS_FSL_DDRC_GEN1
439 Freescale DDR1 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN2
442 Freescale DDR2 controller.
443
444 CONFIG_SYS_FSL_DDRC_GEN3
445 Freescale DDR3 controller.
446
York Sun2896cb72014-03-27 17:54:47 -0700447 CONFIG_SYS_FSL_DDRC_GEN4
448 Freescale DDR4 controller.
449
York Sun461c9392013-09-30 14:20:51 -0700450 CONFIG_SYS_FSL_DDRC_ARM_GEN3
451 Freescale DDR3 controller for ARM-based SoCs.
452
York Sunf0626592013-09-30 09:22:09 -0700453 CONFIG_SYS_FSL_DDR1
454 Board config to use DDR1. It can be enabled for SoCs with
455 Freescale DDR1 or DDR2 controllers, depending on the board
456 implemetation.
457
458 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400459 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700460 Freescale DDR2 or DDR3 controllers, depending on the board
461 implementation.
462
463 CONFIG_SYS_FSL_DDR3
464 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700465 Freescale DDR3 or DDR3L controllers.
466
467 CONFIG_SYS_FSL_DDR3L
468 Board config to use DDR3L. It can be enabled for SoCs with
469 DDR3L controllers.
470
471 CONFIG_SYS_FSL_DDR4
472 Board config to use DDR4. It can be enabled for SoCs with
473 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700474
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
477
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
480
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530481 CONFIG_SYS_FSL_IFC_CLK_DIV
482 Defines divider of platform clock(clock input to IFC controller).
483
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530484 CONFIG_SYS_FSL_LBC_CLK_DIV
485 Defines divider of platform clock(clock input to eLBC controller).
486
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530487 CONFIG_SYS_FSL_PBL_PBI
488 It enables addition of RCW (Power on reset configuration) in built image.
489 Please refer doc/README.pblimage for more details
490
491 CONFIG_SYS_FSL_PBL_RCW
492 It adds PBI(pre-boot instructions) commands in u-boot build image.
493 PBI commands can be used to configure SoC before it starts the execution.
494 Please refer doc/README.pblimage for more details
495
York Sun29647ab2014-02-10 13:59:42 -0800496 CONFIG_SYS_FSL_DDR_BE
497 Defines the DDR controller register space as Big Endian
498
499 CONFIG_SYS_FSL_DDR_LE
500 Defines the DDR controller register space as Little Endian
501
York Sun3a0916d2014-02-10 13:59:43 -0800502 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
503 Physical address from the view of DDR controllers. It is the
504 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
505 it could be different for ARM SoCs.
506
York Sunc459ae62014-02-10 13:59:44 -0800507 CONFIG_SYS_FSL_DDR_INTLV_256B
508 DDR controller interleaving on 256-byte. This is a special
509 interleaving mode, handled by Dickens for Freescale layerscape
510 SoCs with ARM core.
511
York Sun79a779b2014-08-01 15:51:00 -0700512 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
513 Number of controllers used as main memory.
514
515 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
516 Number of controllers used for other than main memory.
517
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530518 CONFIG_SYS_FSL_HAS_DP_DDR
519 Defines the SoC has DP-DDR used for DPAA.
520
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530521 CONFIG_SYS_FSL_SEC_BE
522 Defines the SEC controller register space as Big Endian
523
524 CONFIG_SYS_FSL_SEC_LE
525 Defines the SEC controller register space as Little Endian
526
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200527- MIPS CPU options:
528 CONFIG_SYS_INIT_SP_OFFSET
529
530 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
531 pointer. This is needed for the temporary stack before
532 relocation.
533
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200534 CONFIG_XWAY_SWAP_BYTES
535
536 Enable compilation of tools/xway-swap-bytes needed for Lantiq
537 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
538 be swapped if a flash programmer is used.
539
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000540- ARM options:
541 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
542
543 Select high exception vectors of the ARM core, e.g., do not
544 clear the V bit of the c1 register of CP15.
545
York Sun77a10972015-03-20 19:28:08 -0700546 COUNTER_FREQUENCY
547 Generic timer clock source frequency.
548
549 COUNTER_FREQUENCY_REAL
550 Generic timer clock source frequency if the real clock is
551 different from COUNTER_FREQUENCY, and can only be determined
552 at run time.
553
Stephen Warren8d1fb312015-01-19 16:25:52 -0700554- Tegra SoC options:
555 CONFIG_TEGRA_SUPPORT_NON_SECURE
556
557 Support executing U-Boot in non-secure (NS) mode. Certain
558 impossible actions will be skipped if the CPU is in NS mode,
559 such as ARM architectural timer initialization.
560
wdenk9b7f3842003-10-09 20:09:04 +0000561- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000562 CONFIG_CLOCKS_IN_MHZ
563
564 U-Boot stores all clock information in Hz
565 internally. For binary compatibility with older Linux
566 kernels (which expect the clocks passed in the
567 bd_info data to be in MHz) the environment variable
568 "clocks_in_mhz" can be defined so that U-Boot
569 converts clock data to MHZ before passing it to the
570 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000571 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100572 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000573 default environment.
574
wdenk9b7f3842003-10-09 20:09:04 +0000575 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
576
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800577 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000578 expect it to be in bytes, others in MB.
579 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
580
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400581 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200582
583 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400584 passed using flattened device trees (based on open firmware
585 concepts).
586
587 CONFIG_OF_LIBFDT
588 * New libfdt-based support
589 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500590 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400591
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200592 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600593 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200594
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200595 boards with QUICC Engines require OF_QE to set UCC MAC
596 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500597
Kumar Gala1e26aa52006-01-11 13:54:17 -0600598 CONFIG_OF_BOARD_SETUP
599
600 Board code has addition modification that it wants to make
601 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000602
Simon Glass6c0be912014-10-23 18:58:54 -0600603 CONFIG_OF_SYSTEM_SETUP
604
605 Other code has addition modification that it wants to make
606 to the flat device tree before handing it off to the kernel.
607 This causes ft_system_setup() to be called before booting
608 the kernel.
609
Heiko Schocherffb293a2009-09-23 07:56:08 +0200610 CONFIG_OF_IDE_FIXUP
611
612 U-Boot can detect if an IDE device is present or not.
613 If not, and this new config option is activated, U-Boot
614 removes the ATA node from the DTS before booting Linux,
615 so the Linux IDE driver does not probe the device and
616 crash. This is needed for buggy hardware (uc101) where
617 no pull down resistor is connected to the signal IDE5V_DD7.
618
Igor Grinberg06890672011-07-14 05:45:07 +0000619 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
620
621 This setting is mandatory for all boards that have only one
622 machine type and must be used to specify the machine type
623 number as it appears in the ARM machine registry
624 (see http://www.arm.linux.org.uk/developer/machines/).
625 Only boards that have multiple machine types supported
626 in a single configuration file and the machine type is
627 runtime discoverable, do not have to use this setting.
628
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100629- vxWorks boot parameters:
630
631 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700632 environments variables: bootdev, bootfile, ipaddr, netmask,
633 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100634 It loads the vxWorks image pointed bootfile.
635
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100636 Note: If a "bootargs" environment is defined, it will overwride
637 the defaults discussed just above.
638
Aneesh V960f5c02011-06-16 23:30:47 +0000639- Cache Configuration:
Aneesh V960f5c02011-06-16 23:30:47 +0000640 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
641
Aneesh V686a0752011-06-16 23:30:51 +0000642- Cache Configuration for ARM:
643 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
644 controller
645 CONFIG_SYS_PL310_BASE - Physical base address of PL310
646 controller register space
647
wdenkda04a8b2004-08-02 23:22:59 +0000648- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200649 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000650
651 Define this if you want support for Amba PrimeCell PL010 UARTs.
652
Andreas Engel0813b122008-09-08 14:30:53 +0200653 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000654
655 Define this if you want support for Amba PrimeCell PL011 UARTs.
656
657 CONFIG_PL011_CLOCK
658
659 If you have Amba PrimeCell PL011 UARTs, set this variable to
660 the clock speed of the UARTs.
661
662 CONFIG_PL01x_PORTS
663
664 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
665 define this to a list of base addresses for each (supported)
666 port. See e.g. include/configs/versatile.h
667
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400668 CONFIG_SERIAL_HW_FLOW_CONTROL
669
670 Define this variable to enable hw flow control in serial driver.
671 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000672
wdenkc6097192002-11-03 00:24:07 +0000673- Console Baudrate:
674 CONFIG_BAUDRATE - in bps
675 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200676 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000677
wdenkc6097192002-11-03 00:24:07 +0000678- Autoboot Command:
679 CONFIG_BOOTCOMMAND
680 Only needed when CONFIG_BOOTDELAY is enabled;
681 define a command string that is automatically executed
682 when no character is read on the console interface
683 within "Boot Delay" after reset.
684
wdenkc6097192002-11-03 00:24:07 +0000685 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000686 The value of these goes into the environment as
687 "ramboot" and "nfsboot" respectively, and can be used
688 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200689 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000690
wdenkc6097192002-11-03 00:24:07 +0000691- Serial Download Echo Mode:
692 CONFIG_LOADS_ECHO
693 If defined to 1, all characters received during a
694 serial download (using the "loads" command) are
695 echoed back. This might be needed by some terminal
696 emulations (like "cu"), but may as well just take
697 time on others. This setting #define's the initial
698 value of the "loads_echo" environment variable.
699
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500700- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000701 CONFIG_KGDB_BAUDRATE
702 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200703 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000704
Simon Glassaa34ef22016-03-13 19:07:28 -0600705- Removal of commands
706 If no commands are needed to boot, you can disable
707 CONFIG_CMDLINE to remove them. In this case, the command line
708 will not be available, and when U-Boot wants to execute the
709 boot command (on start-up) it will call board_run_command()
710 instead. This can reduce image size significantly for very
711 simple boot procedures.
712
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000713- Regular expression support:
714 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200715 If this variable is defined, U-Boot is linked against
716 the SLRE (Super Light Regular Expression) library,
717 which adds regex support to some commands, as for
718 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000719
Simon Glass3d686442011-10-15 05:48:20 +0000720- Device tree:
721 CONFIG_OF_CONTROL
722 If this variable is defined, U-Boot will use a device tree
723 to configure its devices, instead of relying on statically
724 compiled #defines in the board file. This option is
725 experimental and only available on a few boards. The device
726 tree is available in the global data as gd->fdt_blob.
727
Simon Glass5cb34db2011-10-24 19:15:31 +0000728 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700729 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000730
731 CONFIG_OF_EMBED
732 If this variable is defined, U-Boot will embed a device tree
733 binary in its image. This device tree file should be in the
734 board directory and called <soc>-<board>.dts. The binary file
735 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900736 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000737
Simon Glass5cb34db2011-10-24 19:15:31 +0000738 CONFIG_OF_SEPARATE
739 If this variable is defined, U-Boot will build a device tree
740 binary. It will be called u-boot.dtb. Architecture-specific
741 code will locate it at run-time. Generally this works by:
742
743 cat u-boot.bin u-boot.dtb >image.bin
744
745 and in fact, U-Boot does this for you, creating a file called
746 u-boot-dtb.bin which is useful in the common case. You can
747 still use the individual files if you need something more
748 exotic.
749
Alex Deymo5b661ec2017-04-02 01:25:20 -0700750 CONFIG_OF_BOARD
751 If this variable is defined, U-Boot will use the device tree
752 provided by the board at runtime instead of embedding one with
753 the image. Only boards defining board_fdt_blob_setup() support
754 this option (see include/fdtdec.h file).
755
wdenkc6097192002-11-03 00:24:07 +0000756- Watchdog:
757 CONFIG_WATCHDOG
758 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000759 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200760 specific code for a watchdog. For the 8xx
761 CPUs, the SIU Watchdog feature is enabled in the SYPCR
762 register. When supported for a specific SoC is
763 available, then no further board specific code should
764 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000765
766 CONFIG_HW_WATCHDOG
767 When using a watchdog circuitry external to the used
768 SoC, then define this variable and provide board
769 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000770
771- Real-Time Clock:
772
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500773 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000774 has to be selected, too. Define exactly one of the
775 following options:
776
wdenkc6097192002-11-03 00:24:07 +0000777 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000778 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000779 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000780 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000781 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000782 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200783 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000784 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100785 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000786 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200787 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200788 CONFIG_SYS_RV3029_TCR - enable trickle charger on
789 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000790
wdenkb9bbd242003-06-30 16:24:52 +0000791 Note that if the RTC uses I2C, then the I2C interface
792 must also be configured. See I2C Support, below.
793
Peter Tyser9902e422008-12-17 16:36:21 -0600794- GPIO Support:
795 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600796
Chris Packham9b383202010-12-19 10:12:13 +0000797 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
798 chip-ngpio pairs that tell the PCA953X driver the number of
799 pins supported by a particular chip.
800
Peter Tyser9902e422008-12-17 16:36:21 -0600801 Note that if the GPIO device uses I2C, then the I2C interface
802 must also be configured. See I2C Support, below.
803
Simon Glass4dc47ca2014-06-11 23:29:41 -0600804- I/O tracing:
805 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
806 accesses and can checksum them or write a list of them out
807 to memory. See the 'iotrace' command for details. This is
808 useful for testing device drivers since it can confirm that
809 the driver behaves the same way before and after a code
810 change. Currently this is supported on sandbox and arm. To
811 add support for your architecture, add '#include <iotrace.h>'
812 to the bottom of arch/<arch>/include/asm/io.h and test.
813
814 Example output from the 'iotrace stats' command is below.
815 Note that if the trace buffer is exhausted, the checksum will
816 still continue to operate.
817
818 iotrace is enabled
819 Start: 10000000 (buffer start address)
820 Size: 00010000 (buffer size)
821 Offset: 00000120 (current buffer offset)
822 Output: 10000120 (start + offset)
823 Count: 00000018 (number of trace records)
824 CRC32: 9526fb66 (CRC32 of all trace records)
825
wdenkc6097192002-11-03 00:24:07 +0000826- Timestamp Support:
827
wdenk4a5c8a72003-03-06 00:02:04 +0000828 When CONFIG_TIMESTAMP is selected, the timestamp
829 (date and time) of an image is printed by image
830 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500831 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000832
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000833- Partition Labels (disklabels) Supported:
834 Zero or more of the following:
835 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000836 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
837 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
838 bootloader. Note 2TB partition limit; see
839 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600840 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000841 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000842
843- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000844 CONFIG_IDE_RESET_ROUTINE - this is defined in several
845 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000846
wdenk369d43d2004-03-14 14:09:05 +0000847 CONFIG_IDE_RESET - is this is defined, IDE Reset will
848 be performed by calling the function
849 ide_set_reset(int reset)
850 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000851
852- ATAPI Support:
853 CONFIG_ATAPI
854
855 Set this to enable ATAPI support.
856
wdenkf602aa02004-03-13 23:29:43 +0000857- LBA48 Support
858 CONFIG_LBA48
859
860 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100861 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000862 Whithout these , LBA48 support uses 32bit variables and will 'only'
863 support disks up to 2.1TB.
864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200865 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000866 When enabled, makes the IDE subsystem use 64bit sector addresses.
867 Default is 32bit.
868
wdenkc6097192002-11-03 00:24:07 +0000869- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200870 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
871 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
872 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000873 maximum numbers of LUNs, SCSI ID's and target
874 devices.
wdenkc6097192002-11-03 00:24:07 +0000875
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200876 The environment variable 'scsidevs' is set to the number of
877 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000878
wdenkc6097192002-11-03 00:24:07 +0000879- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000880 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000881 Support for Intel 8254x/8257x gigabit chips.
882
883 CONFIG_E1000_SPI
884 Utility code for direct access to the SPI bus on Intel 8257x.
885 This does not do anything useful unless you set at least one
886 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
887
888 CONFIG_E1000_SPI_GENERIC
889 Allow generic access to the SPI bus on the Intel 8257x, for
890 example with the "sspi" command.
891
wdenkc6097192002-11-03 00:24:07 +0000892 CONFIG_EEPRO100
893 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200894 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000895 write routine for first time initialisation.
896
897 CONFIG_TULIP
898 Support for Digital 2114x chips.
899 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
900 modem chip initialisation (KS8761/QS6611).
901
902 CONFIG_NATSEMI
903 Support for National dp83815 chips.
904
905 CONFIG_NS8382X
906 Support for National dp8382[01] gigabit chips.
907
wdenkaa603362003-05-12 21:50:16 +0000908- NETWORK Support (other):
909
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100910 CONFIG_DRIVER_AT91EMAC
911 Support for AT91RM9200 EMAC.
912
913 CONFIG_RMII
914 Define this to use reduced MII inteface
915
916 CONFIG_DRIVER_AT91EMAC_QUIET
917 If this defined, the driver is quiet.
918 The driver doen't show link status messages.
919
Rob Herringc9830dc2011-12-15 11:15:49 +0000920 CONFIG_CALXEDA_XGMAC
921 Support for the Calxeda XGMAC device
922
Ashok93fb8722012-10-15 06:20:47 +0000923 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000924 Support for SMSC's LAN91C96 chips.
925
wdenkaa603362003-05-12 21:50:16 +0000926 CONFIG_LAN91C96_USE_32_BIT
927 Define this to enable 32 bit addressing
928
Ashok93fb8722012-10-15 06:20:47 +0000929 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000930 Support for SMSC's LAN91C111 chip
931
932 CONFIG_SMC91111_BASE
933 Define this to hold the physical address
934 of the device (I/O space)
935
936 CONFIG_SMC_USE_32_BIT
937 Define this if data bus is 32 bits
938
939 CONFIG_SMC_USE_IOFUNCS
940 Define this to use i/o functions instead of macros
941 (some hardware wont work with macros)
942
Heiko Schocher7d037f72011-11-15 10:00:04 -0500943 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
944 Define this if you have more then 3 PHYs.
945
Macpaul Lin199c6252010-12-21 16:59:46 +0800946 CONFIG_FTGMAC100
947 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
948
949 CONFIG_FTGMAC100_EGIGA
950 Define this to use GE link update with gigabit PHY.
951 Define this if FTGMAC100 is connected to gigabit PHY.
952 If your system has 10/100 PHY only, it might not occur
953 wrong behavior. Because PHY usually return timeout or
954 useless data when polling gigabit status and gigabit
955 control registers. This behavior won't affect the
956 correctnessof 10/100 link speed update.
957
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900958 CONFIG_SH_ETHER
959 Support for Renesas on-chip Ethernet controller
960
961 CONFIG_SH_ETHER_USE_PORT
962 Define the number of ports to be used
963
964 CONFIG_SH_ETHER_PHY_ADDR
965 Define the ETH PHY's address
966
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900967 CONFIG_SH_ETHER_CACHE_WRITEBACK
968 If this option is set, the driver enables cache flush.
969
Vadim Bendeburydac69642011-10-17 08:36:14 +0000970- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000971 CONFIG_TPM
972 Support TPM devices.
973
Christophe Ricard8759ff82015-10-06 22:54:41 +0200974 CONFIG_TPM_TIS_INFINEON
975 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000976 per system is supported at this time.
977
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000978 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
979 Define the burst count bytes upper limit
980
Christophe Ricard88249232016-01-21 23:27:13 +0100981 CONFIG_TPM_ST33ZP24
982 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
983
984 CONFIG_TPM_ST33ZP24_I2C
985 Support for STMicroelectronics ST33ZP24 I2C devices.
986 Requires TPM_ST33ZP24 and I2C.
987
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100988 CONFIG_TPM_ST33ZP24_SPI
989 Support for STMicroelectronics ST33ZP24 SPI devices.
990 Requires TPM_ST33ZP24 and SPI.
991
Dirk Eibach20489092013-06-26 15:55:15 +0200992 CONFIG_TPM_ATMEL_TWI
993 Support for Atmel TWI TPM device. Requires I2C support.
994
Che-liang Chiouacea5702013-04-12 11:04:34 +0000995 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000996 Support for generic parallel port TPM devices. Only one device
997 per system is supported at this time.
998
999 CONFIG_TPM_TIS_BASE_ADDRESS
1000 Base address where the generic TPM device is mapped
1001 to. Contemporary x86 systems usually map it at
1002 0xfed40000.
1003
Reinhard Pfau4fece432013-06-26 15:55:13 +02001004 CONFIG_TPM
1005 Define this to enable the TPM support library which provides
1006 functional interfaces to some TPM commands.
1007 Requires support for a TPM device.
1008
1009 CONFIG_TPM_AUTH_SESSIONS
1010 Define this to enable authorized functions in the TPM library.
1011 Requires CONFIG_TPM and CONFIG_SHA1.
1012
wdenkc6097192002-11-03 00:24:07 +00001013- USB Support:
1014 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001015 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_USB_UHCI to enable it.
1017 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001018 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001019 storage devices.
1020 Note:
1021 Supported are USB Keyboards and USB Floppy drives
1022 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001023
Simon Glass5978cdb2012-02-27 10:52:47 +00001024 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1025 txfilltuning field in the EHCI controller on reset.
1026
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001027 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1028 HW module registers.
1029
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001030- USB Device:
1031 Define the below if you wish to use the USB console.
1032 Once firmware is rebuilt from a serial console issue the
1033 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001034 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001035 it has found a new device. The environment variable usbtty
1036 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001037 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001038 Common Device Class Abstract Control Model serial device.
1039 If you select usbtty = gserial you should be able to enumerate
1040 a Linux host by
1041 # modprobe usbserial vendor=0xVendorID product=0xProductID
1042 else if using cdc_acm, simply setting the environment
1043 variable usbtty to be cdc_acm should suffice. The following
1044 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001045
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001046 CONFIG_USB_DEVICE
1047 Define this to build a UDC device
1048
1049 CONFIG_USB_TTY
1050 Define this to have a tty type of device available to
1051 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001052
Vipin KUMARbdb17702012-03-26 15:38:06 +05301053 CONFIG_USBD_HS
1054 Define this to enable the high speed support for usb
1055 device and usbtty. If this feature is enabled, a routine
1056 int is_usbd_high_speed(void)
1057 also needs to be defined by the driver to dynamically poll
1058 whether the enumeration has succeded at high speed or full
1059 speed.
1060
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001061 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001062 Define this if you want stdin, stdout &/or stderr to
1063 be set to usbtty.
1064
Wolfgang Denke2601822006-06-14 18:14:56 +02001065 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001066 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001067 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001068 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1069 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1070 should pretend to be a Linux device to it's target host.
1071
1072 CONFIG_USBD_MANUFACTURER
1073 Define this string as the name of your company for
1074 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001075
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001076 CONFIG_USBD_PRODUCT_NAME
1077 Define this string as the name of your product
1078 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001079
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001080 CONFIG_USBD_VENDORID
1081 Define this as your assigned Vendor ID from the USB
1082 Implementors Forum. This *must* be a genuine Vendor ID
1083 to avoid polluting the USB namespace.
1084 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001085
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001086 CONFIG_USBD_PRODUCTID
1087 Define this as the unique Product ID
1088 for your device
1089 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001090
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001091- ULPI Layer Support:
1092 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1093 the generic ULPI layer. The generic layer accesses the ULPI PHY
1094 via the platform viewport, so you need both the genric layer and
1095 the viewport enabled. Currently only Chipidea/ARC based
1096 viewport is supported.
1097 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1098 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001099 If your ULPI phy needs a different reference clock than the
1100 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1101 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001102
wdenk7a428cc2003-06-15 22:40:42 +00001103- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001104 The MMC controller on the Intel PXA is supported. To
1105 enable this define CONFIG_MMC. The MMC can be
1106 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001107 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001108 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1109 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001110
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001111 CONFIG_SH_MMCIF
1112 Support for Renesas on-chip MMCIF controller
1113
1114 CONFIG_SH_MMCIF_ADDR
1115 Define the base address of MMCIF registers
1116
1117 CONFIG_SH_MMCIF_CLK
1118 Define the clock frequency for MMCIF
1119
Tom Rini58a8d322013-03-14 05:32:47 +00001120- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001121 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001122 This enables the USB portion of the DFU USB class
1123
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001124 CONFIG_DFU_NAND
1125 This enables support for exposing NAND devices via DFU.
1126
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301127 CONFIG_DFU_RAM
1128 This enables support for exposing RAM via DFU.
1129 Note: DFU spec refer to non-volatile memory usage, but
1130 allow usages beyond the scope of spec - here RAM usage,
1131 one that would help mostly the developer.
1132
Heiko Schochera2f831e2013-06-12 06:05:51 +02001133 CONFIG_SYS_DFU_DATA_BUF_SIZE
1134 Dfu transfer uses a buffer before writing data to the
1135 raw storage device. Make the size (in bytes) of this buffer
1136 configurable. The size of this buffer is also configurable
1137 through the "dfu_bufsiz" environment variable.
1138
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001139 CONFIG_SYS_DFU_MAX_FILE_SIZE
1140 When updating files rather than the raw storage device,
1141 we use a static buffer to copy the file into and then write
1142 the buffer once we've been given the whole file. Define
1143 this to the maximum filesize (in bytes) for the buffer.
1144 Default is 4 MiB if undefined.
1145
Heiko Schochere1ba1512014-03-18 08:09:56 +01001146 DFU_DEFAULT_POLL_TIMEOUT
1147 Poll timeout [ms], is the timeout a device can send to the
1148 host. The host must wait for this timeout before sending
1149 a subsequent DFU_GET_STATUS request to the device.
1150
1151 DFU_MANIFEST_POLL_TIMEOUT
1152 Poll timeout [ms], which the device sends to the host when
1153 entering dfuMANIFEST state. Host waits this timeout, before
1154 sending again an USB request to the device.
1155
wdenkda04a8b2004-08-02 23:22:59 +00001156- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001157 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001158 Define these for a default partition on a NAND device
1159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001160 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1161 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001162 Define these for a default partition on a NOR device
1163
wdenkc6097192002-11-03 00:24:07 +00001164- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001165 See Kconfig help for available keyboard drivers.
1166
1167 CONFIG_KEYBOARD
1168
1169 Define this to enable a custom keyboard support.
1170 This simply calls drv_keyboard_init() which must be
1171 defined in your board-specific files. This option is deprecated
1172 and is only used by novena. For new boards, use driver model
1173 instead.
wdenkc6097192002-11-03 00:24:07 +00001174
1175- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001176 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001177 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001178 SOCs that have a DIU should define this macro to enable DIU
1179 support, and should also define these other macros:
1180
1181 CONFIG_SYS_DIU_ADDR
1182 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001183 CONFIG_CFB_CONSOLE
1184 CONFIG_VIDEO_SW_CURSOR
1185 CONFIG_VGA_AS_SINGLE_DEVICE
1186 CONFIG_VIDEO_LOGO
1187 CONFIG_VIDEO_BMP_LOGO
1188
Timur Tabi32f709e2011-04-11 14:18:22 -05001189 The DIU driver will look for the 'video-mode' environment
1190 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001191 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001192 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001193
wdenkc6097192002-11-03 00:24:07 +00001194- LCD Support: CONFIG_LCD
1195
1196 Define this to enable LCD support (for output to LCD
1197 display); also select one of the supported displays
1198 by defining one of these:
1199
Stelian Popf6f86652008-05-09 21:57:18 +02001200 CONFIG_ATMEL_LCD:
1201
1202 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1203
wdenkc0d54ae2003-11-25 16:55:19 +00001204 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001205
wdenkc0d54ae2003-11-25 16:55:19 +00001206 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001207
wdenkc0d54ae2003-11-25 16:55:19 +00001208 CONFIG_NEC_NL6448BC20
1209
1210 NEC NL6448BC20-08. 6.5", 640x480.
1211 Active, color, single scan.
1212
1213 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001214
wdenkc0d54ae2003-11-25 16:55:19 +00001215 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001216 Active, color, single scan.
1217
1218 CONFIG_SHARP_16x9
1219
1220 Sharp 320x240. Active, color, single scan.
1221 It isn't 16x9, and I am not sure what it is.
1222
1223 CONFIG_SHARP_LQ64D341
1224
1225 Sharp LQ64D341 display, 640x480.
1226 Active, color, single scan.
1227
1228 CONFIG_HLD1045
1229
1230 HLD1045 display, 640x480.
1231 Active, color, single scan.
1232
1233 CONFIG_OPTREX_BW
1234
1235 Optrex CBL50840-2 NF-FW 99 22 M5
1236 or
1237 Hitachi LMG6912RPFC-00T
1238 or
1239 Hitachi SP14Q002
1240
1241 320x240. Black & white.
1242
Simon Glass599a4df2012-10-17 13:24:54 +00001243 CONFIG_LCD_ALIGNMENT
1244
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001245 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001246 defined then the LCD will be aligned to this value instead.
1247 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1248 here, since it is cheaper to change data cache settings on
1249 a per-section basis.
1250
1251
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001252 CONFIG_LCD_ROTATION
1253
1254 Sometimes, for example if the display is mounted in portrait
1255 mode or even if it's mounted landscape but rotated by 180degree,
1256 we need to rotate our content of the display relative to the
1257 framebuffer, so that user can read the messages which are
1258 printed out.
1259 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1260 initialized with a given rotation from "vl_rot" out of
1261 "vidinfo_t" which is provided by the board specific code.
1262 The value for vl_rot is coded as following (matching to
1263 fbcon=rotate:<n> linux-kernel commandline):
1264 0 = no rotation respectively 0 degree
1265 1 = 90 degree rotation
1266 2 = 180 degree rotation
1267 3 = 270 degree rotation
1268
1269 If CONFIG_LCD_ROTATION is not defined, the console will be
1270 initialized with 0degree rotation.
1271
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001272 CONFIG_LCD_BMP_RLE8
1273
1274 Support drawing of RLE8-compressed bitmaps on the LCD.
1275
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001276 CONFIG_I2C_EDID
1277
1278 Enables an 'i2c edid' command which can read EDID
1279 information over I2C from an attached LCD display.
1280
wdenkeb20ad32003-09-05 23:19:14 +00001281- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001282
wdenk57b2d802003-06-27 21:31:46 +00001283 If this option is set, the environment is checked for
1284 a variable "splashimage". If found, the usual display
1285 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001286 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001287 specified in "splashimage" is loaded instead. The
1288 console is redirected to the "nulldev", too. This
1289 allows for a "silent" boot where a splash screen is
1290 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001291
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001292 CONFIG_SPLASHIMAGE_GUARD
1293
1294 If this option is set, then U-Boot will prevent the environment
1295 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001296 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001297 This option is useful for targets where, due to alignment
1298 restrictions, an improperly aligned BMP image will cause a data
1299 abort. If you think you will not have problems with unaligned
1300 accesses (for example because your toolchain prevents them)
1301 there is no need to set this option.
1302
Matthias Weisser53884182009-07-09 16:07:30 +02001303 CONFIG_SPLASH_SCREEN_ALIGN
1304
1305 If this option is set the splash image can be freely positioned
1306 on the screen. Environment variable "splashpos" specifies the
1307 position as "x,y". If a positive number is given it is used as
1308 number of pixel from left/top. If a negative number is given it
1309 is used as number of pixel from right/bottom. You can also
1310 specify 'm' for centering the image.
1311
1312 Example:
1313 setenv splashpos m,m
1314 => image at center of screen
1315
1316 setenv splashpos 30,20
1317 => image at x = 30 and y = 20
1318
1319 setenv splashpos -10,m
1320 => vertically centered image
1321 at x = dspWidth - bmpWidth - 9
1322
Stefan Roesed9d97742005-09-22 09:04:17 +02001323- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1324
1325 If this option is set, additionally to standard BMP
1326 images, gzipped BMP images can be displayed via the
1327 splashscreen support or the bmp command.
1328
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001329- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1330
1331 If this option is set, 8-bit RLE compressed BMP images
1332 can be displayed via the splashscreen support or the
1333 bmp command.
1334
wdenk710e3502003-08-29 20:57:53 +00001335- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001336 CONFIG_GZIP
1337
1338 Enabled by default to support gzip compressed images.
1339
wdenk710e3502003-08-29 20:57:53 +00001340 CONFIG_BZIP2
1341
1342 If this option is set, support for bzip2 compressed
1343 images is included. If not, only uncompressed and gzip
1344 compressed images are supported.
1345
wdenk9c53f402003-10-15 23:53:47 +00001346 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001347 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001348 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001349
wdenk0e2bd9c2004-06-06 21:51:03 +00001350- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001351 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1352
1353 The clock frequency of the MII bus
1354
wdenk0e2bd9c2004-06-06 21:51:03 +00001355 CONFIG_PHY_RESET_DELAY
1356
1357 Some PHY like Intel LXT971A need extra delay after
1358 reset before any MII register access is possible.
1359 For such PHY, set this option to the usec delay
1360 required. (minimum 300usec for LXT971A)
1361
1362 CONFIG_PHY_CMD_DELAY (ppc4xx)
1363
1364 Some PHY like Intel LXT971A need extra delay after
1365 command issued before MII status register can be read
1366
wdenkc6097192002-11-03 00:24:07 +00001367- IP address:
1368 CONFIG_IPADDR
1369
1370 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001371 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001372 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001373 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001374
1375- Server IP address:
1376 CONFIG_SERVERIP
1377
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001378 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001379 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001380 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001381
Robin Getz470a6d42009-07-21 12:15:28 -04001382 CONFIG_KEEP_SERVERADDR
1383
1384 Keeps the server's MAC address, in the env 'serveraddr'
1385 for passing to bootargs (like Linux's netconsole option)
1386
Wolfgang Denk26da2992011-10-26 10:21:22 +00001387- Gateway IP address:
1388 CONFIG_GATEWAYIP
1389
1390 Defines a default value for the IP address of the
1391 default router where packets to other networks are
1392 sent to.
1393 (Environment variable "gatewayip")
1394
1395- Subnet mask:
1396 CONFIG_NETMASK
1397
1398 Defines a default value for the subnet mask (or
1399 routing prefix) which is used to determine if an IP
1400 address belongs to the local subnet or needs to be
1401 forwarded through a router.
1402 (Environment variable "netmask")
1403
wdenkc6097192002-11-03 00:24:07 +00001404- BOOTP Recovery Mode:
1405 CONFIG_BOOTP_RANDOM_DELAY
1406
1407 If you have many targets in a network that try to
1408 boot using BOOTP, you may want to avoid that all
1409 systems send out BOOTP requests at precisely the same
1410 moment (which would happen for instance at recovery
1411 from a power failure, when all systems will try to
1412 boot, thus flooding the BOOTP server. Defining
1413 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1414 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001415 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001416
1417 1st BOOTP request: delay 0 ... 1 sec
1418 2nd BOOTP request: delay 0 ... 2 sec
1419 3rd BOOTP request: delay 0 ... 4 sec
1420 4th and following
1421 BOOTP requests: delay 0 ... 8 sec
1422
Thierry Reding8977cda2014-08-19 10:21:24 +02001423 CONFIG_BOOTP_ID_CACHE_SIZE
1424
1425 BOOTP packets are uniquely identified using a 32-bit ID. The
1426 server will copy the ID from client requests to responses and
1427 U-Boot will use this to determine if it is the destination of
1428 an incoming response. Some servers will check that addresses
1429 aren't in use before handing them out (usually using an ARP
1430 ping) and therefore take up to a few hundred milliseconds to
1431 respond. Network congestion may also influence the time it
1432 takes for a response to make it back to the client. If that
1433 time is too long, U-Boot will retransmit requests. In order
1434 to allow earlier responses to still be accepted after these
1435 retransmissions, U-Boot's BOOTP client keeps a small cache of
1436 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1437 cache. The default is to keep IDs for up to four outstanding
1438 requests. Increasing this will allow U-Boot to accept offers
1439 from a BOOTP client in networks with unusually high latency.
1440
stroesee0aadfb2003-08-28 14:17:32 +00001441- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001442 You can fine tune the DHCP functionality by defining
1443 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001444
Jon Loeliger5336a762007-07-09 22:08:34 -05001445 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001446 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001447 CONFIG_BOOTP_SEND_HOSTNAME
1448 CONFIG_BOOTP_NTPSERVER
1449 CONFIG_BOOTP_TIMEOFFSET
1450 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001451 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001452
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001453 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1454 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001455
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001456 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1457 after the configured retry count, the call will fail
1458 instead of starting over. This can be used to fail over
1459 to Link-local IP address configuration if the DHCP server
1460 is not available.
1461
stroesee0aadfb2003-08-28 14:17:32 +00001462 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1463 to do a dynamic update of a DNS server. To do this, they
1464 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001465 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001466 of the "hostname" environment variable is passed as
1467 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001468
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001469 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1470
1471 A 32bit value in microseconds for a delay between
1472 receiving a "DHCP Offer" and sending the "DHCP Request".
1473 This fixes a problem with certain DHCP servers that don't
1474 respond 100% of the time to a "DHCP request". E.g. On an
1475 AT91RM9200 processor running at 180MHz, this delay needed
1476 to be *at least* 15,000 usec before a Windows Server 2003
1477 DHCP server would reply 100% of the time. I recommend at
1478 least 50,000 usec to be safe. The alternative is to hope
1479 that one of the retries will be successful but note that
1480 the DHCP timeout and retry process takes a longer than
1481 this delay.
1482
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001483 - Link-local IP address negotiation:
1484 Negotiate with other link-local clients on the local network
1485 for an address that doesn't require explicit configuration.
1486 This is especially useful if a DHCP server cannot be guaranteed
1487 to exist in all environments that the device must operate.
1488
1489 See doc/README.link-local for more information.
1490
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301491 - MAC address from environment variables
1492
1493 FDT_SEQ_MACADDR_FROM_ENV
1494
1495 Fix-up device tree with MAC addresses fetched sequentially from
1496 environment variables. This config work on assumption that
1497 non-usable ethernet node of device-tree are either not present
1498 or their status has been marked as "disabled".
1499
wdenk145d2c12004-04-15 21:48:45 +00001500 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001501 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001502
1503 The device id used in CDP trigger frames.
1504
1505 CONFIG_CDP_DEVICE_ID_PREFIX
1506
1507 A two character string which is prefixed to the MAC address
1508 of the device.
1509
1510 CONFIG_CDP_PORT_ID
1511
1512 A printf format string which contains the ascii name of
1513 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001514 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001515
1516 CONFIG_CDP_CAPABILITIES
1517
1518 A 32bit integer which indicates the device capabilities;
1519 0x00000010 for a normal host which does not forwards.
1520
1521 CONFIG_CDP_VERSION
1522
1523 An ascii string containing the version of the software.
1524
1525 CONFIG_CDP_PLATFORM
1526
1527 An ascii string containing the name of the platform.
1528
1529 CONFIG_CDP_TRIGGER
1530
1531 A 32bit integer sent on the trigger.
1532
1533 CONFIG_CDP_POWER_CONSUMPTION
1534
1535 A 16bit integer containing the power consumption of the
1536 device in .1 of milliwatts.
1537
1538 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1539
1540 A byte containing the id of the VLAN.
1541
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001542- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001543
1544 Several configurations allow to display the current
1545 status using a LED. For instance, the LED will blink
1546 fast while running U-Boot code, stop blinking as
1547 soon as a reply to a BOOTP request was received, and
1548 start blinking slow once the Linux kernel is running
1549 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001550 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001551 feature in U-Boot.
1552
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001553 Additional options:
1554
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001555 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001556 The status LED can be connected to a GPIO pin.
1557 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001558 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001559 to include the gpio_led driver in the U-Boot binary.
1560
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001561 CONFIG_GPIO_LED_INVERTED_TABLE
1562 Some GPIO connected LEDs may have inverted polarity in which
1563 case the GPIO high value corresponds to LED off state and
1564 GPIO low value corresponds to LED on state.
1565 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1566 with a list of GPIO LEDs that have inverted polarity.
1567
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001568- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001569
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001570 This enable the NEW i2c subsystem, and will allow you to use
1571 i2c commands at the u-boot command line (as long as you set
1572 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1573 based realtime clock chips or other i2c devices. See
1574 common/cmd_i2c.c for a description of the command line
1575 interface.
1576
1577 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001578 - drivers/i2c/soft_i2c.c:
1579 - activate first bus with CONFIG_SYS_I2C_SOFT define
1580 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1581 for defining speed and slave address
1582 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1583 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1584 for defining speed and slave address
1585 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1586 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1587 for defining speed and slave address
1588 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1589 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1590 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001591
Heiko Schocherf2850742012-10-24 13:48:22 +02001592 - drivers/i2c/fsl_i2c.c:
1593 - activate i2c driver with CONFIG_SYS_I2C_FSL
1594 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1595 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1596 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1597 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001598 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001599 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1600 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1601 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1602 second bus.
1603
Simon Glass026fefb2012-10-30 07:28:53 +00001604 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001605 - activate this driver with CONFIG_SYS_I2C_TEGRA
1606 - This driver adds 4 i2c buses with a fix speed from
1607 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001608
Dirk Eibach42b204f2013-04-25 02:40:01 +00001609 - drivers/i2c/ppc4xx_i2c.c
1610 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1611 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1612 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1613
trema49f40a2013-09-21 18:13:35 +02001614 - drivers/i2c/i2c_mxc.c
1615 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001616 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1617 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1618 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1619 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001620 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1621 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1622 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1623 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1624 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1625 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001626 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1627 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001628 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001629 for speed, and 0 for slave.
1630
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001631 - drivers/i2c/rcar_i2c.c:
1632 - activate this driver with CONFIG_SYS_I2C_RCAR
1633 - This driver adds 4 i2c buses
1634
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001635 - drivers/i2c/sh_i2c.c:
1636 - activate this driver with CONFIG_SYS_I2C_SH
1637 - This driver adds from 2 to 5 i2c buses
1638
1639 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1640 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1641 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1642 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1643 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1644 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1645 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1646 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1647 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1648 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001649 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001650
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001651 - drivers/i2c/omap24xx_i2c.c
1652 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1653 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1654 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1655 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1656 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1657 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1658 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1659 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1660 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1661 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1662 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1663
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301664 - drivers/i2c/s3c24x0_i2c.c:
1665 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1666 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1667 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1668 with a fix speed from 100000 and the slave addr 0!
1669
Dirk Eibachb9577432014-07-03 09:28:18 +02001670 - drivers/i2c/ihs_i2c.c
1671 - activate this driver with CONFIG_SYS_I2C_IHS
1672 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1673 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1674 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1675 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1676 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1677 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1678 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1679 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1680 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1681 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1682 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1683 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001684 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1685 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1686 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1687 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1688 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1689 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1690 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1691 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1692 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001693
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001694 additional defines:
1695
1696 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001697 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001698
1699 CONFIG_SYS_I2C_DIRECT_BUS
1700 define this, if you don't use i2c muxes on your hardware.
1701 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1702 omit this define.
1703
1704 CONFIG_SYS_I2C_MAX_HOPS
1705 define how many muxes are maximal consecutively connected
1706 on one i2c bus. If you not use i2c muxes, omit this
1707 define.
1708
1709 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001710 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001711 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1712 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1713 CONFIG_SYS_NUM_I2C_BUSES = 9:
1714
1715 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1716 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1717 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1718 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1719 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1720 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1721 {1, {I2C_NULL_HOP}}, \
1722 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1723 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1724 }
1725
1726 which defines
1727 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001728 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1729 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1730 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1731 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1732 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001733 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001734 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1735 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001736
1737 If you do not have i2c muxes on your board, omit this define.
1738
Simon Glass3efce392017-05-12 21:10:00 -06001739- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001740 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001741 then the following macros need to be defined (examples are
1742 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001743
1744 I2C_INIT
1745
wdenkb9bbd242003-06-30 16:24:52 +00001746 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001747 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001748
wdenk544e9732004-02-06 23:19:44 +00001749 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001750
wdenkc6097192002-11-03 00:24:07 +00001751 I2C_ACTIVE
1752
1753 The code necessary to make the I2C data line active
1754 (driven). If the data line is open collector, this
1755 define can be null.
1756
wdenkb9bbd242003-06-30 16:24:52 +00001757 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1758
wdenkc6097192002-11-03 00:24:07 +00001759 I2C_TRISTATE
1760
1761 The code necessary to make the I2C data line tri-stated
1762 (inactive). If the data line is open collector, this
1763 define can be null.
1764
wdenkb9bbd242003-06-30 16:24:52 +00001765 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1766
wdenkc6097192002-11-03 00:24:07 +00001767 I2C_READ
1768
York Sun4a598092013-04-01 11:29:11 -07001769 Code that returns true if the I2C data line is high,
1770 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001771
wdenkb9bbd242003-06-30 16:24:52 +00001772 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1773
wdenkc6097192002-11-03 00:24:07 +00001774 I2C_SDA(bit)
1775
York Sun4a598092013-04-01 11:29:11 -07001776 If <bit> is true, sets the I2C data line high. If it
1777 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001778
wdenkb9bbd242003-06-30 16:24:52 +00001779 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001780 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001781 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001782
wdenkc6097192002-11-03 00:24:07 +00001783 I2C_SCL(bit)
1784
York Sun4a598092013-04-01 11:29:11 -07001785 If <bit> is true, sets the I2C clock line high. If it
1786 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001787
wdenkb9bbd242003-06-30 16:24:52 +00001788 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001789 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001790 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001791
wdenkc6097192002-11-03 00:24:07 +00001792 I2C_DELAY
1793
1794 This delay is invoked four times per clock cycle so this
1795 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001796 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001797 like:
1798
wdenkb9bbd242003-06-30 16:24:52 +00001799 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001800
Mike Frysingeree12d542010-07-21 13:38:02 -04001801 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1802
1803 If your arch supports the generic GPIO framework (asm/gpio.h),
1804 then you may alternatively define the two GPIOs that are to be
1805 used as SCL / SDA. Any of the previous I2C_xxx macros will
1806 have GPIO-based defaults assigned to them as appropriate.
1807
1808 You should define these to the GPIO value as given directly to
1809 the generic GPIO functions.
1810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001811 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001812
wdenk57b2d802003-06-27 21:31:46 +00001813 When a board is reset during an i2c bus transfer
1814 chips might think that the current transfer is still
1815 in progress. On some boards it is possible to access
1816 the i2c SCLK line directly, either by using the
1817 processor pin as a GPIO or by having a second pin
1818 connected to the bus. If this option is defined a
1819 custom i2c_init_board() routine in boards/xxx/board.c
1820 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001821
Ben Warren45657152006-09-07 16:50:54 -04001822 CONFIG_I2C_MULTI_BUS
1823
1824 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001825 must have a controller. At any point in time, only one bus is
1826 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001827 Note that bus numbering is zero-based.
1828
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001829 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001830
1831 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001832 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001833 is set, specify a list of bus-device pairs. Otherwise, specify
1834 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001835
1836 e.g.
1837 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001838 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001839
1840 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1841
Wolfgang Denk092ae952011-10-26 10:21:21 +00001842 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001843 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001844
1845 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001847 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001848
1849 If defined, then this indicates the I2C bus number for DDR SPD.
1850 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1851
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001852 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001853
1854 If defined, then this indicates the I2C bus number for the RTC.
1855 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1856
Andrew Dyer58c41f92008-12-29 17:36:01 -06001857 CONFIG_SOFT_I2C_READ_REPEATED_START
1858
1859 defining this will force the i2c_read() function in
1860 the soft_i2c driver to perform an I2C repeated start
1861 between writing the address pointer and reading the
1862 data. If this define is omitted the default behaviour
1863 of doing a stop-start sequence will be used. Most I2C
1864 devices can use either method, but some require one or
1865 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001866
wdenkc6097192002-11-03 00:24:07 +00001867- SPI Support: CONFIG_SPI
1868
1869 Enables SPI driver (so far only tested with
1870 SPI EEPROM, also an instance works with Crystal A/D and
1871 D/As on the SACSng board)
1872
wdenkc6097192002-11-03 00:24:07 +00001873 CONFIG_SOFT_SPI
1874
wdenk4a5c8a72003-03-06 00:02:04 +00001875 Enables a software (bit-bang) SPI driver rather than
1876 using hardware support. This is a general purpose
1877 driver that only requires three general I/O port pins
1878 (two outputs, one input) to function. If this is
1879 defined, the board configuration must define several
1880 SPI configuration items (port pins to use, etc). For
1881 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001882
Heiko Schocherb77c8882014-07-14 10:22:11 +02001883 CONFIG_SYS_SPI_MXC_WAIT
1884 Timeout for waiting until spi transfer completed.
1885 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1886
Matthias Fuchsa4400872007-12-27 17:12:34 +01001887- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001888
Matthias Fuchsa4400872007-12-27 17:12:34 +01001889 Enables FPGA subsystem.
1890
1891 CONFIG_FPGA_<vendor>
1892
1893 Enables support for specific chip vendors.
1894 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001895
Matthias Fuchsa4400872007-12-27 17:12:34 +01001896 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001897
Matthias Fuchsa4400872007-12-27 17:12:34 +01001898 Enables support for FPGA family.
1899 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1900
1901 CONFIG_FPGA_COUNT
1902
1903 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001904
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001905 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001906
wdenk57b2d802003-06-27 21:31:46 +00001907 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001909 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001910
wdenk4a5c8a72003-03-06 00:02:04 +00001911 Enable checks on FPGA configuration interface busy
1912 status by the configuration function. This option
1913 will require a board or device specific function to
1914 be written.
wdenkc6097192002-11-03 00:24:07 +00001915
1916 CONFIG_FPGA_DELAY
1917
1918 If defined, a function that provides delays in the FPGA
1919 configuration driver.
1920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001921 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001922 Allow Control-C to interrupt FPGA configuration
1923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001924 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001925
wdenk4a5c8a72003-03-06 00:02:04 +00001926 Check for configuration errors during FPGA bitfile
1927 loading. For example, abort during Virtex II
1928 configuration if the INIT_B line goes low (which
1929 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001931 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001932
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001933 Maximum time to wait for the INIT_B line to de-assert
1934 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001935 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001936 ms.
wdenkc6097192002-11-03 00:24:07 +00001937
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001938 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001939
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001940 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001941 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001942
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001943 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001944
wdenk4a5c8a72003-03-06 00:02:04 +00001945 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001946 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001947
1948- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02001949
wdenkc6097192002-11-03 00:24:07 +00001950 CONFIG_IDENT_STRING
1951
wdenk4a5c8a72003-03-06 00:02:04 +00001952 If defined, this string will be added to the U-Boot
1953 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001954
1955- Vendor Parameter Protection:
1956
wdenk4a5c8a72003-03-06 00:02:04 +00001957 U-Boot considers the values of the environment
1958 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001959 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001960 are set once by the board vendor / manufacturer, and
1961 protects these variables from casual modification by
1962 the user. Once set, these variables are read-only,
1963 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001964 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001965
1966 If CONFIG_ENV_OVERWRITE is #defined in your config
1967 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001968 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001969 these parameters.
1970
Joe Hershberger76f353e2015-05-04 14:55:14 -05001971 Alternatively, if you define _both_ an ethaddr in the
1972 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001973 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001974 which can be changed exactly ONCE by the user. [The
1975 serial# is unaffected by this, i. e. it remains
1976 read-only.]
1977
Joe Hershberger71497d02012-12-11 22:16:31 -06001978 The same can be accomplished in a more flexible way
1979 for any variable by configuring the type of access
1980 to allow for those variables in the ".flags" variable
1981 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1982
wdenkc6097192002-11-03 00:24:07 +00001983- Protected RAM:
1984 CONFIG_PRAM
1985
1986 Define this variable to enable the reservation of
1987 "protected RAM", i. e. RAM which is not overwritten
1988 by U-Boot. Define CONFIG_PRAM to hold the number of
1989 kB you want to reserve for pRAM. You can overwrite
1990 this default value by defining an environment
1991 variable "pram" to the number of kB you want to
1992 reserve. Note that the board info structure will
1993 still show the full amount of RAM. If pRAM is
1994 reserved, a new environment variable "mem" will
1995 automatically be defined to hold the amount of
1996 remaining RAM in a form that can be passed as boot
1997 argument to Linux, for instance like that:
1998
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001999 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002000 saveenv
2001
2002 This way you can tell Linux not to use this memory,
2003 either, which results in a memory region that will
2004 not be affected by reboots.
2005
2006 *WARNING* If your board configuration uses automatic
2007 detection of the RAM size, you must make sure that
2008 this memory test is non-destructive. So far, the
2009 following board configurations are known to be
2010 "pRAM-clean":
2011
Heiko Schocher65d94db2017-06-07 17:33:09 +02002012 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002013 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002014 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002015
Gabe Blacka2f3a932012-12-02 04:55:18 +00002016- Access to physical memory region (> 4GB)
2017 Some basic support is provided for operations on memory not
2018 normally accessible to U-Boot - e.g. some architectures
2019 support access to more than 4GB of memory on 32-bit
2020 machines using physical address extension or similar.
2021 Define CONFIG_PHYSMEM to access this basic support, which
2022 currently only supports clearing the memory.
2023
wdenkc6097192002-11-03 00:24:07 +00002024- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002025 CONFIG_NET_RETRY_COUNT
2026
wdenk4a5c8a72003-03-06 00:02:04 +00002027 This variable defines the number of retries for
2028 network operations like ARP, RARP, TFTP, or BOOTP
2029 before giving up the operation. If not defined, a
2030 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002031
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002032 CONFIG_ARP_TIMEOUT
2033
2034 Timeout waiting for an ARP reply in milliseconds.
2035
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002036 CONFIG_NFS_TIMEOUT
2037
2038 Timeout in milliseconds used in NFS protocol.
2039 If you encounter "ERROR: Cannot umount" in nfs command,
2040 try longer timeout such as
2041 #define CONFIG_NFS_TIMEOUT 10000UL
2042
wdenkc6097192002-11-03 00:24:07 +00002043- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002044 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002045
2046 This defines the secondary prompt string, which is
2047 printed when the command interpreter needs more input
2048 to complete a command. Usually "> ".
2049
2050 Note:
2051
wdenk57b2d802003-06-27 21:31:46 +00002052 In the current implementation, the local variables
2053 space and global environment variables space are
2054 separated. Local variables are those you define by
2055 simply typing `name=value'. To access a local
2056 variable later on, you have write `$name' or
2057 `${name}'; to execute the contents of a variable
2058 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002059
wdenk4a5c8a72003-03-06 00:02:04 +00002060 Global environment variables are those you use
2061 setenv/printenv to work with. To run a command stored
2062 in such a variable, you need to use the run command,
2063 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002064
2065 To store commands and special characters in a
2066 variable, please use double quotation marks
2067 surrounding the whole text of the variable, instead
2068 of the backslashes before semicolons and special
2069 symbols.
2070
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002071- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01002072 CONFIG_CMDLINE_PS_SUPPORT
2073
2074 Enable support for changing the command prompt string
2075 at run-time. Only static string is supported so far.
2076 The string is obtained from environment variables PS1
2077 and PS2.
2078
wdenkc0aa5c52003-12-06 19:49:23 +00002079- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002080 CONFIG_EXTRA_ENV_SETTINGS
2081
wdenk4a5c8a72003-03-06 00:02:04 +00002082 Define this to contain any number of null terminated
2083 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002084 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002085
wdenk4a5c8a72003-03-06 00:02:04 +00002086 For example, place something like this in your
2087 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002088
2089 #define CONFIG_EXTRA_ENV_SETTINGS \
2090 "myvar1=value1\0" \
2091 "myvar2=value2\0"
2092
wdenk4a5c8a72003-03-06 00:02:04 +00002093 Warning: This method is based on knowledge about the
2094 internal format how the environment is stored by the
2095 U-Boot code. This is NOT an official, exported
2096 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002097 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002098 You better know what you are doing here.
2099
wdenk4a5c8a72003-03-06 00:02:04 +00002100 Note: overly (ab)use of the default environment is
2101 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002102 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002103 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002104
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002105 CONFIG_DELAY_ENVIRONMENT
2106
2107 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002108 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002109 that so that the environment is not available until
2110 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2111 this is instead controlled by the value of
2112 /config/load-environment.
2113
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002114- TFTP Fixed UDP Port:
2115 CONFIG_TFTP_PORT
2116
Wolfgang Denk227b5192005-09-24 23:25:46 +02002117 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002118 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002119 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002120 number generator is used.
2121
Wolfgang Denk227b5192005-09-24 23:25:46 +02002122 Also, the environment variable tftpdstp is used to supply
2123 the TFTP UDP destination port value. If tftpdstp isn't
2124 defined, the normal port 69 is used.
2125
2126 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002127 blindly start the TFTP transfer using the pre-configured
2128 target IP address and UDP port. This has the effect of
2129 "punching through" the (Windows XP) firewall, allowing
2130 the remainder of the TFTP transfer to proceed normally.
2131 A better solution is to properly configure the firewall,
2132 but sometimes that is not allowed.
2133
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002134 CONFIG_STANDALONE_LOAD_ADDR
2135
Wolfgang Denk23f78482011-10-09 21:06:34 +02002136 This option defines a board specific value for the
2137 address where standalone program gets loaded, thus
2138 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002139 settings.
2140
2141- Frame Buffer Address:
2142 CONFIG_FB_ADDR
2143
2144 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002145 address for frame buffer. This is typically the case
2146 when using a graphics controller has separate video
2147 memory. U-Boot will then place the frame buffer at
2148 the given address instead of dynamically reserving it
2149 in system RAM by calling lcd_setmem(), which grabs
2150 the memory for the frame buffer depending on the
2151 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002152
2153 Please see board_init_f function.
2154
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002155- Automatic software updates via TFTP server
2156 CONFIG_UPDATE_TFTP
2157 CONFIG_UPDATE_TFTP_CNT_MAX
2158 CONFIG_UPDATE_TFTP_MSEC_MAX
2159
2160 These options enable and control the auto-update feature;
2161 for a more detailed description refer to doc/README.update.
2162
2163- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02002164 CONFIG_MTD_UBI_WL_THRESHOLD
2165 This parameter defines the maximum difference between the highest
2166 erase counter value and the lowest erase counter value of eraseblocks
2167 of UBI devices. When this threshold is exceeded, UBI starts performing
2168 wear leveling by means of moving data from eraseblock with low erase
2169 counter to eraseblocks with high erase counter.
2170
2171 The default value should be OK for SLC NAND flashes, NOR flashes and
2172 other flashes which have eraseblock life-cycle 100000 or more.
2173 However, in case of MLC NAND flashes which typically have eraseblock
2174 life-cycle less than 10000, the threshold should be lessened (e.g.,
2175 to 128 or 256, although it does not have to be power of 2).
2176
2177 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002178
Heiko Schocherf5895d12014-06-24 10:10:04 +02002179 CONFIG_MTD_UBI_BEB_LIMIT
2180 This option specifies the maximum bad physical eraseblocks UBI
2181 expects on the MTD device (per 1024 eraseblocks). If the
2182 underlying flash does not admit of bad eraseblocks (e.g. NOR
2183 flash), this value is ignored.
2184
2185 NAND datasheets often specify the minimum and maximum NVM
2186 (Number of Valid Blocks) for the flashes' endurance lifetime.
2187 The maximum expected bad eraseblocks per 1024 eraseblocks
2188 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2189 which gives 20 for most NANDs (MaxNVB is basically the total
2190 count of eraseblocks on the chip).
2191
2192 To put it differently, if this value is 20, UBI will try to
2193 reserve about 1.9% of physical eraseblocks for bad blocks
2194 handling. And that will be 1.9% of eraseblocks on the entire
2195 NAND chip, not just the MTD partition UBI attaches. This means
2196 that if you have, say, a NAND flash chip admits maximum 40 bad
2197 eraseblocks, and it is split on two MTD partitions of the same
2198 size, UBI will reserve 40 eraseblocks when attaching a
2199 partition.
2200
2201 default: 20
2202
2203 CONFIG_MTD_UBI_FASTMAP
2204 Fastmap is a mechanism which allows attaching an UBI device
2205 in nearly constant time. Instead of scanning the whole MTD device it
2206 only has to locate a checkpoint (called fastmap) on the device.
2207 The on-flash fastmap contains all information needed to attach
2208 the device. Using fastmap makes only sense on large devices where
2209 attaching by scanning takes long. UBI will not automatically install
2210 a fastmap on old images, but you can set the UBI parameter
2211 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2212 that fastmap-enabled images are still usable with UBI implementations
2213 without fastmap support. On typical flash devices the whole fastmap
2214 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2215
2216 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2217 Set this parameter to enable fastmap automatically on images
2218 without a fastmap.
2219 default: 0
2220
Heiko Schocher94b66de2015-10-22 06:19:21 +02002221 CONFIG_MTD_UBI_FM_DEBUG
2222 Enable UBI fastmap debug
2223 default: 0
2224
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002225- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002226 CONFIG_SPL
2227 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002228
Tom Rini36853852012-02-14 07:29:40 +00002229 CONFIG_SPL_LDSCRIPT
2230 LDSCRIPT for linking the SPL binary.
2231
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002232 CONFIG_SPL_MAX_FOOTPRINT
2233 Maximum size in memory allocated to the SPL, BSS included.
2234 When defined, the linker checks that the actual memory
2235 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002236 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002237 must not be both defined at the same time.
2238
Tom Rini36853852012-02-14 07:29:40 +00002239 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002240 Maximum size of the SPL image (text, data, rodata, and
2241 linker lists sections), BSS excluded.
2242 When defined, the linker checks that the actual size does
2243 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002244
Scott Woodc4f0d002012-09-20 19:05:12 -05002245 CONFIG_SPL_RELOC_TEXT_BASE
2246 Address to relocate to. If unspecified, this is equal to
2247 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2248
Tom Rini36853852012-02-14 07:29:40 +00002249 CONFIG_SPL_BSS_START_ADDR
2250 Link address for the BSS within the SPL binary.
2251
2252 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002253 Maximum size in memory allocated to the SPL BSS.
2254 When defined, the linker checks that the actual memory used
2255 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002256 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002257 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002258
2259 CONFIG_SPL_STACK
2260 Adress of the start of the stack SPL will use
2261
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002262 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2263 When defined, SPL will panic() if the image it has
2264 loaded does not have a signature.
2265 Defining this is useful when code which loads images
2266 in SPL cannot guarantee that absolutely all read errors
2267 will be caught.
2268 An example is the LPC32XX MLC NAND driver, which will
2269 consider that a completely unreadable NAND block is bad,
2270 and thus should be skipped silently.
2271
Scott Woodc4f0d002012-09-20 19:05:12 -05002272 CONFIG_SPL_RELOC_STACK
2273 Adress of the start of the stack SPL will use after
2274 relocation. If unspecified, this is equal to
2275 CONFIG_SPL_STACK.
2276
Tom Rini36853852012-02-14 07:29:40 +00002277 CONFIG_SYS_SPL_MALLOC_START
2278 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002279 When this option is set the full malloc is used in SPL and
2280 it is set up by spl_init() and before that, the simple malloc()
2281 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002282
2283 CONFIG_SYS_SPL_MALLOC_SIZE
2284 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002285
Tom Rinic2b76002014-03-28 12:03:39 -04002286 CONFIG_SPL_OS_BOOT
2287 Enable booting directly to an OS from SPL.
2288 See also: doc/README.falcon
2289
Tom Rinife3b0c72012-08-13 11:37:56 -07002290 CONFIG_SPL_DISPLAY_PRINT
2291 For ARM, enable an optional function to print more information
2292 about the running system.
2293
Scott Wood7c810902012-09-20 16:35:21 -05002294 CONFIG_SPL_INIT_MINIMAL
2295 Arch init code should be built for a very small image
2296
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002297 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2298 Partition on the MMC to load U-Boot from when the MMC is being
2299 used in raw mode
2300
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002301 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2302 Sector to load kernel uImage from when MMC is being
2303 used in raw mode (for Falcon mode)
2304
2305 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2306 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2307 Sector and number of sectors to load kernel argument
2308 parameters from when MMC is being used in raw mode
2309 (for falcon mode)
2310
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002311 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2312 Partition on the MMC to load U-Boot from when the MMC is being
2313 used in fs mode
2314
Guillaume GARDET5065b712014-10-15 17:53:13 +02002315 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2316 Filename to read to load U-Boot when reading from filesystem
2317
2318 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002319 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002320 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002321
Guillaume GARDET5065b712014-10-15 17:53:13 +02002322 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002323 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002324 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002325
Scott Wood2b36fbb2012-12-06 13:33:17 +00002326 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2327 Set this for NAND SPL on PPC mpc83xx targets, so that
2328 start.S waits for the rest of the SPL to load before
2329 continuing (the hardware starts execution after just
2330 loading the first page rather than the full 4K).
2331
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302332 CONFIG_SPL_SKIP_RELOCATE
2333 Avoid SPL relocation
2334
Scott Woodc352a0c2012-09-20 19:09:07 -05002335 CONFIG_SPL_NAND_BASE
2336 Include nand_base.c in the SPL. Requires
2337 CONFIG_SPL_NAND_DRIVERS.
2338
2339 CONFIG_SPL_NAND_DRIVERS
2340 SPL uses normal NAND drivers, not minimal drivers.
2341
Jörg Krause6f8190f2018-01-14 19:26:38 +01002342 CONFIG_SPL_NAND_IDENT
2343 SPL uses the chip ID list to identify the NAND flash.
2344 Requires CONFIG_SPL_NAND_BASE.
2345
Scott Woodc352a0c2012-09-20 19:09:07 -05002346 CONFIG_SPL_NAND_ECC
2347 Include standard software ECC in the SPL
2348
Tom Rini36853852012-02-14 07:29:40 +00002349 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002350 Support for NAND boot using simple NAND drivers that
2351 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002352
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002353 CONFIG_SPL_UBI
2354 Support for a lightweight UBI (fastmap) scanner and
2355 loader
2356
Heiko Schochercf000272014-10-31 08:31:00 +01002357 CONFIG_SPL_NAND_RAW_ONLY
2358 Support to boot only raw u-boot.bin images. Use this only
2359 if you need to save space.
2360
Ying Zhangdfb2b152013-08-16 15:16:12 +08002361 CONFIG_SPL_COMMON_INIT_DDR
2362 Set for common ddr init with serial presence detect in
2363 SPL binary.
2364
Tom Rini36853852012-02-14 07:29:40 +00002365 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2366 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2367 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2368 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2369 CONFIG_SYS_NAND_ECCBYTES
2370 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002371 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002372
2373 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002374 Location in NAND to read U-Boot from
2375
2376 CONFIG_SYS_NAND_U_BOOT_DST
2377 Location in memory to load U-Boot to
2378
2379 CONFIG_SYS_NAND_U_BOOT_SIZE
2380 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002381
2382 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002383 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002384
2385 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2386 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002387 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002388
Pavel Machekde997252012-08-30 22:42:11 +02002389 CONFIG_SPL_RAM_DEVICE
2390 Support for running image already present in ram, in SPL binary
2391
Scott Woodeb7bd972012-12-06 13:33:16 +00002392 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002393 Image offset to which the SPL should be padded before appending
2394 the SPL payload. By default, this is defined as
2395 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2396 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2397 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002398
Scott Woodf147eb72012-09-21 16:27:32 -05002399 CONFIG_SPL_TARGET
2400 Final target image containing SPL and payload. Some SPLs
2401 use an arch-specific makefile fragment instead, for
2402 example if more than one image needs to be produced.
2403
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002404 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002405 Printing information about a FIT image adds quite a bit of
2406 code to SPL. So this is normally disabled in SPL. Use this
2407 option to re-enable it. This will affect the output of the
2408 bootm command when booting a FIT image.
2409
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002410- TPL framework
2411 CONFIG_TPL
2412 Enable building of TPL globally.
2413
2414 CONFIG_TPL_PAD_TO
2415 Image offset to which the TPL should be padded before appending
2416 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002417 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2418 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2419 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002420
wdenkc0aa5c52003-12-06 19:49:23 +00002421- Interrupt support (PPC):
2422
wdenk1ebf41e2004-01-02 14:00:00 +00002423 There are common interrupt_init() and timer_interrupt()
2424 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002425 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002426 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002427 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002428 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002429 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002430 specific handling. If board has watchdog / status_led
2431 / other_activity_monitor it works automatically from
2432 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002433
wdenkc6097192002-11-03 00:24:07 +00002434
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002435Board initialization settings:
2436------------------------------
2437
2438During Initialization u-boot calls a number of board specific functions
2439to allow the preparation of board specific prerequisites, e.g. pin setup
2440before drivers are initialized. To enable these callbacks the
2441following configuration macros have to be defined. Currently this is
2442architecture specific, so please check arch/your_architecture/lib/board.c
2443typically in board_init_f() and board_init_r().
2444
2445- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2446- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2447- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2448- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002449
wdenkc6097192002-11-03 00:24:07 +00002450Configuration Settings:
2451-----------------------
2452
Simon Glass8927bf22019-12-28 10:45:10 -07002453- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08002454 Optionally it can be defined to support 64-bit memory commands.
2455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002456- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002457 undefine this when you're short of memory.
2458
Peter Tyserdfb72b82009-01-27 18:03:12 -06002459- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2460 width of the commands listed in the 'help' command output.
2461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002462- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002463 prompt for user input.
2464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002465- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002468
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002469- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002471- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002472 the application (usually a Linux kernel) when it is
2473 booted
2474
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002475- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002476 List of legal baudrate settings for this board.
2477
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002478- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002479 Begin and End addresses of the area used by the
2480 simple memory test.
2481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002482- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002483 Scratch address used by the alternate memory test
2484 You only need to set this if address zero isn't writeable
2485
York Sun5d286cd2015-12-04 11:57:07 -08002486- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002487 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002488 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2489 is substracted from total RAM and won't be reported to OS.
2490 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002491 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002492 the RAM base is not zero, or RAM is divided into banks,
2493 this variable needs to be recalcuated to get the address.
2494
York Sun50739372015-12-07 11:05:29 -08002495- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002496 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002497 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002498 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002499 fixing up gd->ram_size the Linux kernel should gets passed
2500 the now "corrected" memory size and won't touch it either.
2501 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002502 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002503 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002504 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002505
2506 This option can be used as a workaround for the 440EPx/GRx
2507 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2508 be touched.
2509
2510 WARNING: Please make sure that this value is a multiple of
2511 the Linux page size (normally 4k). If this is not the case,
2512 then the end address of the Linux memory will be located at a
2513 non page size aligned address and this could cause major
2514 problems.
2515
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002516- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002517 Enable temporary baudrate change while serial download
2518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002519- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002520 Physical start address of SDRAM. _Must_ be 0 here.
2521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002522- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002523 Physical start address of Flash memory.
2524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002525- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002526 Physical start address of boot monitor code (set by
2527 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002528 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002529 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002532 Size of memory reserved for monitor code, used to
2533 determine _at_compile_time_ (!) if the environment is
2534 embedded within the U-Boot image, or in a separate
2535 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002536
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002537- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002538 Size of DRAM reserved for malloc() use.
2539
Simon Glass863e4042014-07-10 22:23:28 -06002540- CONFIG_SYS_MALLOC_F_LEN
2541 Size of the malloc() pool for use before relocation. If
2542 this is defined, then a very simple malloc() implementation
2543 will become available before relocation. The address is just
2544 below the global data, and the stack is moved down to make
2545 space.
2546
2547 This feature allocates regions with increasing addresses
2548 within the region. calloc() is supported, but realloc()
2549 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002550 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002551 U-Boot relocates itself.
2552
Simon Glass9fa901b2014-11-10 17:16:54 -07002553- CONFIG_SYS_MALLOC_SIMPLE
2554 Provides a simple and small malloc() and calloc() for those
2555 boards which do not use the full malloc in SPL (which is
2556 enabled with CONFIG_SYS_SPL_MALLOC_START).
2557
Thierry Redingc97d9742014-12-09 22:25:22 -07002558- CONFIG_SYS_NONCACHED_MEMORY:
2559 Size of non-cached memory area. This area of memory will be
2560 typically located right below the malloc() area and mapped
2561 uncached in the MMU. This is useful for drivers that would
2562 otherwise require a lot of explicit cache maintenance. For
2563 some drivers it's also impossible to properly maintain the
2564 cache. For example if the regions that need to be flushed
2565 are not a multiple of the cache-line size, *and* padding
2566 cannot be allocated between the regions to align them (i.e.
2567 if the HW requires a contiguous array of regions, and the
2568 size of each region is not cache-aligned), then a flush of
2569 one region may result in overwriting data that hardware has
2570 written to another region in the same cache-line. This can
2571 happen for example in network drivers where descriptors for
2572 buffers are typically smaller than the CPU cache-line (e.g.
2573 16 bytes vs. 32 or 64 bytes).
2574
2575 Non-cached memory is only supported on 32-bit ARM at present.
2576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002578 Normally compressed uImages are limited to an
2579 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002580 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002581 to adjust this setting to your needs.
2582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002583- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002584 Maximum size of memory mapped by the startup code of
2585 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002586 the Linux kernel (bd_info, boot arguments, FDT blob if
2587 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002588 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002589 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002590 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002591 variable "bootm_mapsize" will override the value of
2592 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2593 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002594
John Rigbyeea8e692010-10-13 13:57:35 -06002595- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2596 Enable initrd_high functionality. If defined then the
2597 initrd_high feature is enabled and the bootm ramdisk subcommand
2598 is enabled.
2599
2600- CONFIG_SYS_BOOT_GET_CMDLINE:
2601 Enables allocating and saving kernel cmdline in space between
2602 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2603
2604- CONFIG_SYS_BOOT_GET_KBD:
2605 Enables allocating and saving a kernel copy of the bd_info in
2606 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2607
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002608- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002609 Max number of Flash memory banks
2610
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002611- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002612 Max number of sectors on a Flash chip
2613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002614- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002615 Timeout for Flash erase operations (in ms)
2616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002617- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002618 Timeout for Flash write operations (in ms)
2619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002620- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002621 Timeout for Flash set sector lock bit operation (in ms)
2622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002623- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002624 Timeout for Flash clear lock bits operation (in ms)
2625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002626- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002627 If defined, hardware flash sectors protection is used
2628 instead of U-Boot software protection.
2629
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002630- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002631
2632 Enable TFTP transfers directly to flash memory;
2633 without this option such a download has to be
2634 performed in two steps: (1) download to RAM, and (2)
2635 copy from RAM to flash.
2636
2637 The two-step approach is usually more reliable, since
2638 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002639 the flash, but in some situations (when system RAM is
2640 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002641 downloaded image) this option may be very useful.
2642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002643- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002644 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002645 common flash structure for storing flash geometry.
2646
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002647- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002648 This option also enables the building of the cfi_flash driver
2649 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002650
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002651- CONFIG_FLASH_CFI_MTD
2652 This option enables the building of the cfi_mtd driver
2653 in the drivers directory. The driver exports CFI flash
2654 to the MTD layer.
2655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002656- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002657 Use buffered writes to flash.
2658
2659- CONFIG_FLASH_SPANSION_S29WS_N
2660 s29ws-n MirrorBit flash has non-standard addresses for buffered
2661 write commands.
2662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002663- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002664 If this option is defined, the common CFI flash doesn't
2665 print it's warning upon not recognized FLASH banks. This
2666 is useful, if some of the configured banks are only
2667 optionally available.
2668
Jerry Van Barenaae73572008-03-08 13:48:01 -05002669- CONFIG_FLASH_SHOW_PROGRESS
2670 If defined (must be an integer), print out countdown
2671 digits and dots. Recommended value: 45 (9..1) for 80
2672 column displays, 15 (3..1) for 40 column displays.
2673
Stefan Roesed20cba52013-04-04 15:53:14 +02002674- CONFIG_FLASH_VERIFY
2675 If defined, the content of the flash (destination) is compared
2676 against the source after the write operation. An error message
2677 will be printed when the contents are not identical.
2678 Please note that this option is useless in nearly all cases,
2679 since such flash programming errors usually are detected earlier
2680 while unprotecting/erasing/programming. Please only enable
2681 this option if you really know what you are doing.
2682
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002683- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002684 Defines the number of Ethernet receive buffers. On some
2685 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002686 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2687 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002688 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002689 Defaults to 4 if not defined.
2690
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002691- CONFIG_ENV_MAX_ENTRIES
2692
Wolfgang Denk1136f692010-10-27 22:48:30 +02002693 Maximum number of entries in the hash table that is used
2694 internally to store the environment settings. The default
2695 setting is supposed to be generous and should work in most
2696 cases. This setting can be used to tune behaviour; see
2697 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002698
Joe Hershberger71497d02012-12-11 22:16:31 -06002699- CONFIG_ENV_FLAGS_LIST_DEFAULT
2700- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002701 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002702 calling env set. Variables can be restricted to only decimal,
2703 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2704 the variables can also be restricted to IP address or MAC address.
2705
2706 The format of the list is:
2707 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002708 access_attribute = [a|r|o|c]
2709 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002710 entry = variable_name[:attributes]
2711 list = entry[,list]
2712
2713 The type attributes are:
2714 s - String (default)
2715 d - Decimal
2716 x - Hexadecimal
2717 b - Boolean ([1yYtT|0nNfF])
2718 i - IP address
2719 m - MAC address
2720
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002721 The access attributes are:
2722 a - Any (default)
2723 r - Read-only
2724 o - Write-once
2725 c - Change-default
2726
Joe Hershberger71497d02012-12-11 22:16:31 -06002727 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2728 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002729 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002730
2731 - CONFIG_ENV_FLAGS_LIST_STATIC
2732 Define this to a list (string) to define validation that
2733 should be done if an entry is not found in the ".flags"
2734 environment variable. To override a setting in the static
2735 list, simply add an entry for the same variable name to the
2736 ".flags" variable.
2737
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002738 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2739 regular expression. This allows multiple variables to define the same
2740 flags without explicitly listing them for each variable.
2741
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002742- CONFIG_ENV_ACCESS_IGNORE_FORCE
2743 If defined, don't allow the -f switch to env set override variable
2744 access flags.
2745
wdenkc6097192002-11-03 00:24:07 +00002746The following definitions that deal with the placement and management
2747of environment data (variable area); in general, we support the
2748following configurations:
2749
Mike Frysinger63b8f122011-07-08 10:44:25 +00002750- CONFIG_BUILD_ENVCRC:
2751
2752 Builds up envcrc with the target environment so that external utils
2753 may easily extract it and embed it in final U-Boot images.
2754
wdenkc6097192002-11-03 00:24:07 +00002755BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002756in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002757console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002758U-Boot will hang.
2759
2760Please note that even with NVRAM we still use a copy of the
2761environment in RAM: we could work on NVRAM directly, but we want to
2762keep settings there always unmodified except somebody uses "saveenv"
2763to save the current settings.
2764
Liu Gang85bcd732012-03-08 00:33:20 +00002765BE CAREFUL! For some special cases, the local device can not use
2766"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002767environment stored in a remote NOR flash by SRIO or PCIE link,
2768but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002769
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002770- CONFIG_NAND_ENV_DST
2771
2772 Defines address in RAM to which the nand_spl code should copy the
2773 environment. If redundant environment is used, it will be copied to
2774 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2775
Bruce Adleredecc942007-11-02 13:15:42 -07002776Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002777has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002778created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002779until then to read environment variables.
2780
wdenk8dba0502003-03-31 16:34:49 +00002781The environment is protected by a CRC32 checksum. Before the monitor
2782is relocated into RAM, as a result of a bad CRC you will be working
2783with the compiled-in default environment - *silently*!!! [This is
2784necessary, because the first environment variable we need is the
2785"baudrate" setting for the console - if we have a bad CRC, we don't
2786have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002787
2788Note: once the monitor has been relocated, then it will complain if
2789the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002790use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002792- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002793 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002794
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002795 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002796 also needs to be defined.
2797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002798- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002799 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002800
Ron Madriddfa028a2009-02-18 14:30:44 -08002801- CONFIG_NS16550_MIN_FUNCTIONS:
2802 Define this if you desire to only have use of the NS16550_init
2803 and NS16550_putc functions for the serial driver located at
2804 drivers/serial/ns16550.c. This option is useful for saving
2805 space for already greatly restricted images, including but not
2806 limited to NAND_SPL configurations.
2807
Simon Glass28a9e332012-11-30 13:01:18 +00002808- CONFIG_DISPLAY_BOARDINFO
2809 Display information about the board that U-Boot is running on
2810 when U-Boot starts up. The board function checkboard() is called
2811 to do this.
2812
Simon Glasse8822012012-11-30 13:01:19 +00002813- CONFIG_DISPLAY_BOARDINFO_LATE
2814 Similar to the previous option, but display this information
2815 later, once stdio is running and output goes to the LCD, if
2816 present.
2817
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002818- CONFIG_BOARD_SIZE_LIMIT:
2819 Maximum size of the U-Boot image. When defined, the
2820 build system checks that the actual size does not
2821 exceed it.
2822
wdenkc6097192002-11-03 00:24:07 +00002823Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002824---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002826- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002827 Cache Line Size of the CPU.
2828
Timur Tabid8f341c2011-08-04 18:03:41 -05002829- CONFIG_SYS_CCSRBAR_DEFAULT:
2830 Default (power-on reset) physical address of CCSR on Freescale
2831 PowerPC SOCs.
2832
2833- CONFIG_SYS_CCSRBAR:
2834 Virtual address of CCSR. On a 32-bit build, this is typically
2835 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2836
Timur Tabid8f341c2011-08-04 18:03:41 -05002837- CONFIG_SYS_CCSRBAR_PHYS:
2838 Physical address of CCSR. CCSR can be relocated to a new
2839 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002840 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002841 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2842 is typically relocated on 36-bit builds. It is recommended
2843 that this macro be defined via the _HIGH and _LOW macros:
2844
2845 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2846 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2847
2848- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002849 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2850 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002851 used in assembly code, so it must not contain typecasts or
2852 integer size suffixes (e.g. "ULL").
2853
2854- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2855 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2856 used in assembly code, so it must not contain typecasts or
2857 integer size suffixes (e.g. "ULL").
2858
2859- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2860 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2861 forced to a value that ensures that CCSR is not relocated.
2862
Macpaul Lind1e49942011-04-11 20:45:32 +00002863- CONFIG_IDE_AHB:
2864 Most IDE controllers were designed to be connected with PCI
2865 interface. Only few of them were designed for AHB interface.
2866 When software is doing ATA command and data transfer to
2867 IDE devices through IDE-AHB controller, some additional
2868 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002869 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00002870
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002871- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002872 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002873 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002874
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002875- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002876
wdenkeb20ad32003-09-05 23:19:14 +00002877 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002878 initial data and stack; please note that this must be
2879 writable memory that is working WITHOUT special
2880 initialization, i. e. you CANNOT use normal RAM which
2881 will become available only after programming the
2882 memory controller and running certain initialization
2883 sequences.
2884
2885 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002886 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002888- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002889
2890 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002891 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2892 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002893 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002894 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002895 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002896 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2897 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002898
2899 Note:
2900 On the MPC824X (or other systems that use the data
2901 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002902 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002903 point to an otherwise UNUSED address space between
2904 the top of RAM and the start of the PCI space.
2905
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002906- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002908- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002909 SDRAM timing
2910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002911- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002912 periodic timer for refresh
2913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002914- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2915 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2916 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2917 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002918 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2919
2920- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002921 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2922 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002923 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2924
Andrew Sharp61d47ca2012-08-29 14:16:32 +00002925- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002926 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00002927 Don't do any setup work, presumably because someone or
2928 something has already done it, and we don't need to do it
2929 a second time. Useful for platforms that are pre-booted
2930 by coreboot or similar.
2931
Gabor Juhosb4458732013-05-30 07:06:12 +00002932- CONFIG_PCI_INDIRECT_BRIDGE:
2933 Enable support for indirect PCI bridges.
2934
Kumar Gala8975d7a2010-12-30 12:09:53 -06002935- CONFIG_SYS_SRIO:
2936 Chip has SRIO or not
2937
2938- CONFIG_SRIO1:
2939 Board has SRIO 1 port available
2940
2941- CONFIG_SRIO2:
2942 Board has SRIO 2 port available
2943
Liu Gang27afb9c2013-05-07 16:30:46 +08002944- CONFIG_SRIO_PCIE_BOOT_MASTER
2945 Board can support master function for Boot from SRIO and PCIE
2946
Kumar Gala8975d7a2010-12-30 12:09:53 -06002947- CONFIG_SYS_SRIOn_MEM_VIRT:
2948 Virtual Address of SRIO port 'n' memory region
2949
Simon Glass970b61e2019-11-14 12:57:09 -07002950- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002951 Physical Address of SRIO port 'n' memory region
2952
2953- CONFIG_SYS_SRIOn_MEM_SIZE:
2954 Size of SRIO port 'n' memory region
2955
Fabio Estevamf17e8782013-04-11 09:35:34 +00002956- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2957 Defined to tell the NAND controller that the NAND chip is using
2958 a 16 bit bus.
2959 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002960 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002961 - drivers/mtd/nand/raw/ndfc.c
2962 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002963
2964- CONFIG_SYS_NDFC_EBC0_CFG
2965 Sets the EBC0_CFG register for the NDFC. If not defined
2966 a default value will be used.
2967
Ben Warren45657152006-09-07 16:50:54 -04002968- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002969 Get DDR timing information from an I2C EEPROM. Common
2970 with pluggable memory modules such as SODIMMs
2971
Ben Warren45657152006-09-07 16:50:54 -04002972 SPD_EEPROM_ADDRESS
2973 I2C address of the SPD EEPROM
2974
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002975- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002976 If SPD EEPROM is on an I2C bus other than the first
2977 one, specify here. Note that the value must resolve
2978 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002979
York Sune73cc042011-06-07 09:42:16 +08002980- CONFIG_SYS_DDR_RAW_TIMING
2981 Get DDR timing information from other than SPD. Common with
2982 soldered DDR chips onboard without SPD. DDR raw timing
2983 parameters are extracted from datasheet and hard-coded into
2984 header files or board specific files.
2985
York Sunbd495cf2011-09-16 13:21:35 -07002986- CONFIG_FSL_DDR_INTERACTIVE
2987 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2988
York Sun8ced0502015-01-06 13:18:55 -08002989- CONFIG_FSL_DDR_SYNC_REFRESH
2990 Enable sync of refresh for multiple controllers.
2991
York Sunb6a35f82015-03-19 09:30:28 -07002992- CONFIG_FSL_DDR_BIST
2993 Enable built-in memory test for Freescale DDR controllers.
2994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002995- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002996 Only for 83xx systems. If specified, then DDR should
2997 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002998
wdenk6203e402004-04-18 10:13:26 +00002999- CONFIG_RMII
3000 Enable RMII mode for all FECs.
3001 Note that this is a global option, we can't
3002 have one FEC in standard MII mode and another in RMII mode.
3003
wdenk20c98a62004-04-23 20:32:05 +00003004- CONFIG_CRC32_VERIFY
3005 Add a verify option to the crc32 command.
3006 The syntax is:
3007
3008 => crc32 -v <address> <count> <crc32>
3009
3010 Where address/count indicate a memory area
3011 and crc32 is the correct crc32 which the
3012 area should have.
3013
wdenk64519362004-07-11 17:40:54 +00003014- CONFIG_LOOPW
3015 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003016 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003017
Joel Johnsondb5a97e2020-01-29 09:17:18 -07003018- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00003019 Add the "mdc" and "mwc" memory commands. These are cyclic
3020 "md/mw" commands.
3021 Examples:
3022
wdenk07d7e6b2004-12-16 21:44:03 +00003023 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003024 This command will print 4 bytes (10,11,12,13) each 500 ms.
3025
wdenk07d7e6b2004-12-16 21:44:03 +00003026 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003027 This command will write 12345678 to address 100 all 10 ms.
3028
wdenk07d7e6b2004-12-16 21:44:03 +00003029 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003030 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003031
wdenk3d3d99f2005-04-04 12:44:11 +00003032- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chend7e6f922017-12-26 13:55:59 +08003033 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003034 low level initializations (like setting up the memory
3035 controller) are omitted and/or U-Boot does not
3036 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003037
Wolfgang Denk302141d2010-11-27 23:30:56 +01003038 Normally this variable MUST NOT be defined. The only
3039 exception is when U-Boot is loaded (to RAM) by some
3040 other boot loader or by a debugger which performs
3041 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003042
Simon Glass90844072016-05-05 07:28:06 -06003043- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3044 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003045 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003046 instruction cache) is still performed.
3047
Aneesh V552a3192011-07-13 05:11:07 +00003048- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08003049 Set when the currently-running compilation is for an artifact
3050 that will end up in the SPL (as opposed to the TPL or U-Boot
3051 proper). Code that needs stage-specific behavior should check
3052 this.
wdenk336b2bc2005-04-02 23:52:25 +00003053
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003054- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08003055 Set when the currently-running compilation is for an artifact
3056 that will end up in the TPL (as opposed to the SPL or U-Boot
3057 proper). Code that needs stage-specific behavior should check
3058 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003059
Ying Zhang0d4f5442013-05-20 14:07:23 +08003060- CONFIG_SYS_MPC85XX_NO_RESETVEC
3061 Only for 85xx systems. If this variable is specified, the section
3062 .resetvec is not kept and the section .bootpg is placed in the
3063 previous 4k of the .text section.
3064
Simon Glass17dabf02013-02-24 17:33:14 +00003065- CONFIG_ARCH_MAP_SYSMEM
3066 Generally U-Boot (and in particular the md command) uses
3067 effective address. It is therefore not necessary to regard
3068 U-Boot address as virtual addresses that need to be translated
3069 to physical addresses. However, sandbox requires this, since
3070 it maintains its own little RAM buffer which contains all
3071 addressable memory. This option causes some memory accesses
3072 to be mapped through map_sysmem() / unmap_sysmem().
3073
Simon Glassbfb59802013-02-14 04:18:54 +00003074- CONFIG_X86_RESET_VECTOR
3075 If defined, the x86 reset vector code is included. This is not
3076 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003077
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003078- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3079 Option to disable subpage write in NAND driver
3080 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02003081 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003082
Timur Tabi275f4bb2011-11-22 09:21:25 -06003083Freescale QE/FMAN Firmware Support:
3084-----------------------------------
3085
3086The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3087loading of "firmware", which is encoded in the QE firmware binary format.
3088This firmware often needs to be loaded during U-Boot booting, so macros
3089are used to identify the storage device (NOR flash, SPI, etc) and the address
3090within that device.
3091
Zhao Qiang83a90842014-03-21 16:21:44 +08003092- CONFIG_SYS_FMAN_FW_ADDR
3093 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04003094 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08003095 is also specified.
3096
3097- CONFIG_SYS_QE_FW_ADDR
3098 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04003099 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06003100 is also specified.
3101
3102- CONFIG_SYS_QE_FMAN_FW_LENGTH
3103 The maximum possible size of the firmware. The firmware binary format
3104 has a field that specifies the actual size of the firmware, but it
3105 might not be possible to read any part of the firmware unless some
3106 local storage is allocated to hold the entire firmware first.
3107
3108- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3109 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3110 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3111 virtual address in NOR flash.
3112
3113- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3114 Specifies that QE/FMAN firmware is located in NAND flash.
3115 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3116
3117- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3118 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3119 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3120
Liu Gang1e084582012-03-08 00:33:18 +00003121- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3122 Specifies that QE/FMAN firmware is located in the remote (master)
3123 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003124 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3125 window->master inbound window->master LAW->the ucode address in
3126 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003127
J. German Rivera8ff14b72014-06-23 15:15:55 -07003128Freescale Layerscape Management Complex Firmware Support:
3129---------------------------------------------------------
3130The Freescale Layerscape Management Complex (MC) supports the loading of
3131"firmware".
3132This firmware often needs to be loaded during U-Boot booting, so macros
3133are used to identify the storage device (NOR flash, SPI, etc) and the address
3134within that device.
3135
3136- CONFIG_FSL_MC_ENET
3137 Enable the MC driver for Layerscape SoCs.
3138
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303139Freescale Layerscape Debug Server Support:
3140-------------------------------------------
3141The Freescale Layerscape Debug Server Support supports the loading of
3142"Debug Server firmware" and triggering SP boot-rom.
3143This firmware often needs to be loaded during U-Boot booting.
3144
York Sun928b6812015-12-07 11:08:58 -08003145- CONFIG_SYS_MC_RSV_MEM_ALIGN
3146 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303147
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003148Reproducible builds
3149-------------------
3150
3151In order to achieve reproducible builds, timestamps used in the U-Boot build
3152process have to be set to a fixed value.
3153
3154This is done using the SOURCE_DATE_EPOCH environment variable.
3155SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3156option for U-Boot or an environment variable in U-Boot.
3157
3158SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3159
wdenkc6097192002-11-03 00:24:07 +00003160Building the Software:
3161======================
3162
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003163Building U-Boot has been tested in several native build environments
3164and in many different cross environments. Of course we cannot support
3165all possibly existing versions of cross development tools in all
3166(potentially obsolete) versions. In case of tool chain problems we
3167recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3168which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003169
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003170If you are not using a native environment, it is assumed that you
3171have GNU cross compiling tools available in your path. In this case,
3172you must set the environment variable CROSS_COMPILE in your shell.
3173Note that no changes to the Makefile or any other source files are
3174necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003175
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003176 $ CROSS_COMPILE=ppc_4xx-
3177 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003178
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003179U-Boot is intended to be simple to build. After installing the
3180sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003181is done by typing:
3182
Holger Freyther7ba4e572014-08-04 09:26:05 +02003183 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003184
Holger Freyther7ba4e572014-08-04 09:26:05 +02003185where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003186rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003187
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003188Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00003189 additional information is available from the board vendor; for
3190 instance, the TQM823L systems are available without (standard)
3191 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003192 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003193
Holger Freyther7ba4e572014-08-04 09:26:05 +02003194 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003195 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003196
Holger Freyther7ba4e572014-08-04 09:26:05 +02003197 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003198 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk6c59edc2004-05-03 20:45:30 +00003200 etc.
wdenkc6097192002-11-03 00:24:07 +00003201
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk6c59edc2004-05-03 20:45:30 +00003203Finally, type "make all", and you should get some working U-Boot
3204images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003205
wdenk6c59edc2004-05-03 20:45:30 +00003206- "u-boot.bin" is a raw binary image
3207- "u-boot" is an image in ELF binary format
3208- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003209
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003210By default the build is performed locally and the objects are saved
3211in the source directory. One of the two methods can be used to change
3212this behavior and build U-Boot to some external directory:
3213
32141. Add O= to the make command line invocations:
3215
3216 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003217 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003218 make O=/tmp/build all
3219
Timo Ketolac8c67602014-11-06 14:39:05 +020032202. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003221
Timo Ketolac8c67602014-11-06 14:39:05 +02003222 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003223 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003224 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003225 make all
3226
Timo Ketolac8c67602014-11-06 14:39:05 +02003227Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003228variable.
3229
Daniel Schwierzeck88484422018-01-26 16:31:04 +01003230User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3231setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3232For example to treat all compiler warnings as errors:
3233
3234 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk6c59edc2004-05-03 20:45:30 +00003236Please be aware that the Makefiles assume you are using GNU make, so
3237for instance on NetBSD you might need to use "gmake" instead of
3238native "make".
wdenkc6097192002-11-03 00:24:07 +00003239
wdenkc6097192002-11-03 00:24:07 +00003240
wdenk6c59edc2004-05-03 20:45:30 +00003241If the system board that you have is not listed, then you will need
3242to port U-Boot to your hardware platform. To do this, follow these
3243steps:
wdenkc6097192002-11-03 00:24:07 +00003244
Phil Sutterc77b4882015-12-25 14:41:18 +010032451. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003246 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003247 the "Makefile" and a "<board>.c".
32482. Create a new configuration file "include/configs/<board>.h" for
3249 your board.
wdenk6c59edc2004-05-03 20:45:30 +000032503. If you're porting U-Boot to a new CPU, then also create a new
3251 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020032524. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000032535. Type "make", and you should get a working "u-boot.srec" file
3254 to be installed on your target system.
32556. Debug and solve any problems that might arise.
3256 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003257
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk6c59edc2004-05-03 20:45:30 +00003259Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3260==============================================================
wdenkc6097192002-11-03 00:24:07 +00003261
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003262If you have modified U-Boot sources (for instance added a new board
3263or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003264provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08003265the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003266official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003267
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003268But before you submit such a patch, please verify that your modifi-
3269cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003270the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003271just run the buildman script (tools/buildman/buildman), which will
3272configure and build U-Boot for ALL supported system. Be warned, this
3273will take a while. Please see the buildman README, or run 'buildman -H'
3274for documentation.
wdenkc6097192002-11-03 00:24:07 +00003275
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003276
wdenk6c59edc2004-05-03 20:45:30 +00003277See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003278
wdenkc6097192002-11-03 00:24:07 +00003279
wdenk6c59edc2004-05-03 20:45:30 +00003280Monitor Commands - Overview:
3281============================
wdenkc6097192002-11-03 00:24:07 +00003282
wdenk6c59edc2004-05-03 20:45:30 +00003283go - start application at address 'addr'
3284run - run commands in an environment variable
3285bootm - boot application image from memory
3286bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003287bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003288tftpboot- boot image via network using TFTP protocol
3289 and env variables "ipaddr" and "serverip"
3290 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003291tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003292rarpboot- boot image via network using RARP/TFTP protocol
3293diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3294loads - load S-Record file over serial line
3295loadb - load binary file over serial line (kermit mode)
3296md - memory display
3297mm - memory modify (auto-incrementing)
3298nm - memory modify (constant address)
3299mw - memory write (fill)
3300cp - memory copy
3301cmp - memory compare
3302crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003303i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003304sspi - SPI utility commands
3305base - print or set address offset
3306printenv- print environment variables
3307setenv - set environment variables
3308saveenv - save environment variables to persistent storage
3309protect - enable or disable FLASH write protection
3310erase - erase FLASH memory
3311flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003312nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003313bdinfo - print Board Info structure
3314iminfo - print header information for application image
3315coninfo - print console devices and informations
3316ide - IDE sub-system
3317loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003318loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003319mtest - simple RAM test
3320icache - enable or disable instruction cache
3321dcache - enable or disable data cache
3322reset - Perform RESET of the CPU
3323echo - echo args to console
3324version - print monitor version
3325help - print online help
3326? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003327
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk6c59edc2004-05-03 20:45:30 +00003329Monitor Commands - Detailed Description:
3330========================================
wdenkc6097192002-11-03 00:24:07 +00003331
wdenk6c59edc2004-05-03 20:45:30 +00003332TODO.
wdenkc6097192002-11-03 00:24:07 +00003333
wdenk6c59edc2004-05-03 20:45:30 +00003334For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003335
3336
wdenk6c59edc2004-05-03 20:45:30 +00003337Environment Variables:
3338======================
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk6c59edc2004-05-03 20:45:30 +00003340U-Boot supports user configuration using Environment Variables which
3341can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk6c59edc2004-05-03 20:45:30 +00003343Environment Variables are set using "setenv", printed using
3344"printenv", and saved to Flash using "saveenv". Using "setenv"
3345without a value can be used to delete a variable from the
3346environment. As long as you don't save the environment you are
3347working with an in-memory copy. In case the Flash area containing the
3348environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003349
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003350Some configuration options can be set using Environment Variables.
3351
3352List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk6c59edc2004-05-03 20:45:30 +00003354 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003355
wdenk6c59edc2004-05-03 20:45:30 +00003356 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk6c59edc2004-05-03 20:45:30 +00003358 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003359
wdenk6c59edc2004-05-03 20:45:30 +00003360 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003361
wdenk6c59edc2004-05-03 20:45:30 +00003362 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003363
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003364 bootm_low - Memory range available for image processing in the bootm
3365 command can be restricted. This variable is given as
3366 a hexadecimal number and defines lowest address allowed
3367 for use by the bootm command. See also "bootm_size"
3368 environment variable. Address defined by "bootm_low" is
3369 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003370 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3371 bootm_mapsize.
3372
Wolfgang Denk092ae952011-10-26 10:21:21 +00003373 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003374 This variable is given as a hexadecimal number and it
3375 defines the size of the memory region starting at base
3376 address bootm_low that is accessible by the Linux kernel
3377 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3378 as the default value if it is defined, and bootm_size is
3379 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003380
3381 bootm_size - Memory range available for image processing in the bootm
3382 command can be restricted. This variable is given as
3383 a hexadecimal number and defines the size of the region
3384 allowed for use by the bootm command. See also "bootm_low"
3385 environment variable.
3386
Simon Glassa8cab882019-07-20 20:51:17 -06003387 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3388
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003389 updatefile - Location of the software update file on a TFTP server, used
3390 by the automatic software update feature. Please refer to
3391 documentation in doc/README.update for more details.
3392
wdenk6c59edc2004-05-03 20:45:30 +00003393 autoload - if set to "no" (any string beginning with 'n'),
3394 "bootp" will just load perform a lookup of the
3395 configuration from the BOOTP server, but not try to
3396 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003397
wdenk6c59edc2004-05-03 20:45:30 +00003398 autostart - if set to "yes", an image loaded using the "bootp",
3399 "rarpboot", "tftpboot" or "diskboot" commands will
3400 be automatically started (by internally calling
3401 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk6c59edc2004-05-03 20:45:30 +00003403 If set to "no", a standalone image passed to the
3404 "bootm" command will be copied to the load address
3405 (and eventually uncompressed), but NOT be started.
3406 This can be used to load and uncompress arbitrary
3407 data.
wdenkc6097192002-11-03 00:24:07 +00003408
David A. Longd558a4e2011-07-09 16:40:19 -04003409 fdt_high - if set this restricts the maximum address that the
3410 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003411 For example, if you have a system with 1 GB memory
3412 at physical address 0x10000000, while Linux kernel
3413 only recognizes the first 704 MB as low memory, you
3414 may need to set fdt_high as 0x3C000000 to have the
3415 device tree blob be copied to the maximum address
3416 of the 704 MB low memory, so that Linux kernel can
3417 access it during the boot procedure.
3418
David A. Longd558a4e2011-07-09 16:40:19 -04003419 If this is set to the special value 0xFFFFFFFF then
3420 the fdt will not be copied at all on boot. For this
3421 to work it must reside in writable memory, have
3422 sufficient padding on the end of it for u-boot to
3423 add the information it needs into it, and the memory
3424 must be accessible by the kernel.
3425
Simon Glassdc6fa642011-10-24 19:15:34 +00003426 fdtcontroladdr- if set this is the address of the control flattened
3427 device tree used by U-Boot when CONFIG_OF_CONTROL is
3428 defined.
3429
wdenk0e2bd9c2004-06-06 21:51:03 +00003430 i2cfast - (PPC405GP|PPC405EP only)
3431 if set to 'y' configures Linux I2C driver for fast
3432 mode (400kHZ). This environment variable is used in
3433 initialization code. So, for changes to be effective
3434 it must be saved and board must be reset.
3435
wdenk6c59edc2004-05-03 20:45:30 +00003436 initrd_high - restrict positioning of initrd images:
3437 If this variable is not set, initrd images will be
3438 copied to the highest possible address in RAM; this
3439 is usually what you want since it allows for
3440 maximum initrd size. If for some reason you want to
3441 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003442 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003443 variable to a value of "no" or "off" or "0".
3444 Alternatively, you can set it to a maximum upper
3445 address to use (U-Boot will still check that it
3446 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003447
wdenk6c59edc2004-05-03 20:45:30 +00003448 For instance, when you have a system with 16 MB
3449 RAM, and want to reserve 4 MB from use by Linux,
3450 you can do this by adding "mem=12M" to the value of
3451 the "bootargs" variable. However, now you must make
3452 sure that the initrd image is placed in the first
3453 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003454
wdenk6c59edc2004-05-03 20:45:30 +00003455 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk6c59edc2004-05-03 20:45:30 +00003457 If you set initrd_high to 0xFFFFFFFF, this is an
3458 indication to U-Boot that all addresses are legal
3459 for the Linux kernel, including addresses in flash
3460 memory. In this case U-Boot will NOT COPY the
3461 ramdisk at all. This may be useful to reduce the
3462 boot time on your system, but requires that this
3463 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003464
wdenk6c59edc2004-05-03 20:45:30 +00003465 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003466
wdenk6c59edc2004-05-03 20:45:30 +00003467 loadaddr - Default load address for commands like "bootp",
3468 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk6c59edc2004-05-03 20:45:30 +00003470 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003471
wdenk6c59edc2004-05-03 20:45:30 +00003472 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003473
wdenk6c59edc2004-05-03 20:45:30 +00003474 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003475
wdenk6c59edc2004-05-03 20:45:30 +00003476 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk6c59edc2004-05-03 20:45:30 +00003478 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003479
Mike Frysingera23230c2011-10-02 10:01:27 +00003480 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003481
Mike Frysingera23230c2011-10-02 10:01:27 +00003482 ethact - controls which interface is currently active.
3483 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003484
Heiko Schocherc5e84052010-07-20 17:45:02 +02003485 => setenv ethact FEC
3486 => ping 192.168.0.1 # traffic sent on FEC
3487 => setenv ethact SCC
3488 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003489
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003490 ethrotate - When set to "no" U-Boot does not go through all
3491 available network interfaces.
3492 It just stays at the currently selected interface.
3493
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003494 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003495 either succeed or fail without retrying.
3496 When set to "once" the network operation will
3497 fail when all the available network interfaces
3498 are tried once without success.
3499 Useful on scripts which control the retry operation
3500 themselves.
wdenkc6097192002-11-03 00:24:07 +00003501
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003502 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003503
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003504 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003505 changing the console to be empty. If "yes" it will be
3506 made silent. If "no" it will not be made silent. If
3507 unset, then it will be made silent if the U-Boot console
3508 is silent.
3509
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003510 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003511 UDP source port.
3512
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003513 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003514 destination port instead of the Well Know Port 69.
3515
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003516 tftpblocksize - Block size to use for TFTP transfers; if not set,
3517 we use the TFTP server's default block size
3518
3519 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3520 seconds, minimum value is 1000 = 1 second). Defines
3521 when a packet is considered to be lost so it has to
3522 be retransmitted. The default is 5000 = 5 seconds.
3523 Lowering this value may make downloads succeed
3524 faster in networks with high packet loss rates or
3525 with unreliable TFTP servers.
3526
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003527 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3528 unit, minimum value = 0). Defines how many timeouts
3529 can happen during a single file transfer before that
3530 transfer is aborted. The default is 10, and 0 means
3531 'no timeouts allowed'. Increasing this value may help
3532 downloads succeed with high packet loss rates, or with
3533 unreliable TFTP servers or client hardware.
3534
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003535 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003536 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003537 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003538
Alexandre Messier15971322016-02-01 17:08:57 -05003539 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3540 Unsigned value, in milliseconds. If not set, the period will
3541 be either the default (28000), or a value based on
3542 CONFIG_NET_RETRY_COUNT, if defined. This value has
3543 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3544
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003545The following image location variables contain the location of images
3546used in booting. The "Image" column gives the role of the image and is
3547not an environment variable name. The other columns are environment
3548variable names. "File Name" gives the name of the file on a TFTP
3549server, "RAM Address" gives the location in RAM the image will be
3550loaded to, and "Flash Location" gives the image's address in NOR
3551flash or offset in NAND flash.
3552
3553*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03003554boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003555boards use these variables for other purposes.
3556
Wolfgang Denk092ae952011-10-26 10:21:21 +00003557Image File Name RAM Address Flash Location
3558----- --------- ----------- --------------
3559u-boot u-boot u-boot_addr_r u-boot_addr
3560Linux kernel bootfile kernel_addr_r kernel_addr
3561device tree blob fdtfile fdt_addr_r fdt_addr
3562ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003563
wdenk6c59edc2004-05-03 20:45:30 +00003564The following environment variables may be used and automatically
3565updated by the network boot commands ("bootp" and "rarpboot"),
3566depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003567
wdenk6c59edc2004-05-03 20:45:30 +00003568 bootfile - see above
3569 dnsip - IP address of your Domain Name Server
3570 dnsip2 - IP address of your secondary Domain Name Server
3571 gatewayip - IP address of the Gateway (Router) to use
3572 hostname - Target hostname
3573 ipaddr - see above
3574 netmask - Subnet Mask
3575 rootpath - Pathname of the root filesystem on the NFS server
3576 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003577
wdenk145d2c12004-04-15 21:48:45 +00003578
wdenk6c59edc2004-05-03 20:45:30 +00003579There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk6c59edc2004-05-03 20:45:30 +00003581 serial# - contains hardware identification information such
3582 as type string and/or serial number
3583 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003584
wdenk6c59edc2004-05-03 20:45:30 +00003585These variables can be set only once (usually during manufacturing of
3586the board). U-Boot refuses to delete or overwrite these variables
3587once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003588
3589
wdenk6c59edc2004-05-03 20:45:30 +00003590Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk6c59edc2004-05-03 20:45:30 +00003592 ver - Contains the U-Boot version string as printed
3593 with the "version" command. This variable is
3594 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003595
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk6c59edc2004-05-03 20:45:30 +00003597Please note that changes to some configuration parameters may take
3598only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003599
stroeseb9c17c52003-04-04 15:53:41 +00003600
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003601Callback functions for environment variables:
3602---------------------------------------------
3603
3604For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003605when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003606be associated with arbitrary variables. On creation, overwrite, or
3607deletion, the callback will provide the opportunity for some side
3608effect to happen or for the change to be rejected.
3609
3610The callbacks are named and associated with a function using the
3611U_BOOT_ENV_CALLBACK macro in your board or driver code.
3612
3613These callbacks are associated with variables in one of two ways. The
3614static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3615in the board configuration to a string that defines a list of
3616associations. The list must be in the following format:
3617
3618 entry = variable_name[:callback_name]
3619 list = entry[,list]
3620
3621If the callback name is not specified, then the callback is deleted.
3622Spaces are also allowed anywhere in the list.
3623
3624Callbacks can also be associated by defining the ".callbacks" variable
3625with the same list format above. Any association in ".callbacks" will
3626override any association in the static list. You can define
3627CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003628".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003629
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003630If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3631regular expression. This allows multiple variables to be connected to
3632the same callback without explicitly listing them all out.
3633
Heinrich Schuchardtc141fa52018-07-29 11:08:14 +02003634The signature of the callback functions is:
3635
3636 int callback(const char *name, const char *value, enum env_op op, int flags)
3637
3638* name - changed environment variable
3639* value - new value of the environment variable
3640* op - operation (create, overwrite, or delete)
3641* flags - attributes of the environment variable change, see flags H_* in
3642 include/search.h
3643
3644The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003645
wdenk6c59edc2004-05-03 20:45:30 +00003646Command Line Parsing:
3647=====================
stroeseb9c17c52003-04-04 15:53:41 +00003648
wdenk6c59edc2004-05-03 20:45:30 +00003649There are two different command line parsers available with U-Boot:
3650the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003651
wdenk6c59edc2004-05-03 20:45:30 +00003652Old, simple command line parser:
3653--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003654
wdenk6c59edc2004-05-03 20:45:30 +00003655- supports environment variables (through setenv / saveenv commands)
3656- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003657- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003658- special characters ('$', ';') can be escaped by prefixing with '\',
3659 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003660 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003661- You can also escape text by enclosing in single apostrophes, for example:
3662 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk6c59edc2004-05-03 20:45:30 +00003664Hush shell:
3665-----------
wdenkf4688a22003-05-28 08:06:31 +00003666
wdenk6c59edc2004-05-03 20:45:30 +00003667- similar to Bourne shell, with control structures like
3668 if...then...else...fi, for...do...done; while...do...done,
3669 until...do...done, ...
3670- supports environment ("global") variables (through setenv / saveenv
3671 commands) and local shell variables (through standard shell syntax
3672 "name=value"); only environment variables can be used with "run"
3673 command
wdenkf4688a22003-05-28 08:06:31 +00003674
wdenk6c59edc2004-05-03 20:45:30 +00003675General rules:
3676--------------
wdenkf4688a22003-05-28 08:06:31 +00003677
wdenk6c59edc2004-05-03 20:45:30 +00003678(1) If a command line (or an environment variable executed by a "run"
3679 command) contains several commands separated by semicolon, and
3680 one of these commands fails, then the remaining commands will be
3681 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003682
wdenk6c59edc2004-05-03 20:45:30 +00003683(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003684 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003685 command will cause "run" to terminate, i. e. the remaining
3686 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003687
wdenk6c59edc2004-05-03 20:45:30 +00003688Note for Redundant Ethernet Interfaces:
3689=======================================
wdenkf4688a22003-05-28 08:06:31 +00003690
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003691Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003692such configurations and is capable of automatic selection of a
3693"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003694
wdenk6c59edc2004-05-03 20:45:30 +00003695Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3696MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3697"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003698
wdenk6c59edc2004-05-03 20:45:30 +00003699If the network interface stores some valid MAC address (for instance
3700in SROM), this is used as default address if there is NO correspon-
3701ding setting in the environment; if the corresponding environment
3702variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003703
wdenk6c59edc2004-05-03 20:45:30 +00003704o If the SROM has a valid MAC address, and there is no address in the
3705 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk6c59edc2004-05-03 20:45:30 +00003707o If there is no valid address in the SROM, and a definition in the
3708 environment exists, then the value from the environment variable is
3709 used.
wdenkc6097192002-11-03 00:24:07 +00003710
wdenk6c59edc2004-05-03 20:45:30 +00003711o If both the SROM and the environment contain a MAC address, and
3712 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk6c59edc2004-05-03 20:45:30 +00003714o If both the SROM and the environment contain a MAC address, and the
3715 addresses differ, the value from the environment is used and a
3716 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003717
wdenk6c59edc2004-05-03 20:45:30 +00003718o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05003719 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3720 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003721
Ben Warren6db991a2010-04-26 11:11:46 -07003722If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003723will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003724may be skipped by setting the appropriate 'ethmacskip' environment variable.
3725The naming convention is as follows:
3726"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk6c59edc2004-05-03 20:45:30 +00003728Image Formats:
3729==============
wdenkc6097192002-11-03 00:24:07 +00003730
Marian Balakowicz18710b82008-03-12 12:13:13 +01003731U-Boot is capable of booting (and performing other auxiliary operations on)
3732images in two formats:
3733
3734New uImage format (FIT)
3735-----------------------
3736
3737Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3738to Flattened Device Tree). It allows the use of images with multiple
3739components (several kernels, ramdisks, etc.), with contents protected by
3740SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3741
3742
3743Old uImage format
3744-----------------
3745
3746Old image format is based on binary files which can be basically anything,
3747preceded by a special header; see the definitions in include/image.h for
3748details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk6c59edc2004-05-03 20:45:30 +00003750* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3751 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003752 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3753 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3754 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003755* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003756 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003757 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003758* Compression Type (uncompressed, gzip, bzip2)
3759* Load Address
3760* Entry Point
3761* Image Name
3762* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk6c59edc2004-05-03 20:45:30 +00003764The header is marked by a special Magic Number, and both the header
3765and the data portions of the image are secured against corruption by
3766CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003767
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769Linux Support:
3770==============
wdenkc6097192002-11-03 00:24:07 +00003771
wdenk6c59edc2004-05-03 20:45:30 +00003772Although U-Boot should support any OS or standalone application
3773easily, the main focus has always been on Linux during the design of
3774U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk6c59edc2004-05-03 20:45:30 +00003776U-Boot includes many features that so far have been part of some
3777special "boot loader" code within the Linux kernel. Also, any
3778"initrd" images to be used are no longer part of one big Linux image;
3779instead, kernel and "initrd" are separate images. This implementation
3780serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk6c59edc2004-05-03 20:45:30 +00003782- the same features can be used for other OS or standalone
3783 applications (for instance: using compressed images to reduce the
3784 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003785
wdenk6c59edc2004-05-03 20:45:30 +00003786- it becomes much easier to port new Linux kernel versions because
3787 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk6c59edc2004-05-03 20:45:30 +00003789- the same Linux kernel image can now be used with different "initrd"
3790 images; of course this also means that different kernel images can
3791 be run with the same "initrd". This makes testing easier (you don't
3792 have to build a new "zImage.initrd" Linux image when you just
3793 change a file in your "initrd"). Also, a field-upgrade of the
3794 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003795
wdenkc6097192002-11-03 00:24:07 +00003796
wdenk6c59edc2004-05-03 20:45:30 +00003797Linux HOWTO:
3798============
wdenkc6097192002-11-03 00:24:07 +00003799
wdenk6c59edc2004-05-03 20:45:30 +00003800Porting Linux to U-Boot based systems:
3801---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003802
wdenk6c59edc2004-05-03 20:45:30 +00003803U-Boot cannot save you from doing all the necessary modifications to
3804configure the Linux device drivers for use with your target hardware
3805(no, we don't intend to provide a full virtual machine interface to
3806Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003807
Stefan Roese88fbf932010-04-15 16:07:28 +02003808But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003809
wdenk6c59edc2004-05-03 20:45:30 +00003810Just make sure your machine specific header file (for instance
3811include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003812Information structure as we define in include/asm-<arch>/u-boot.h,
3813and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003815
Simon Glassd097e592014-06-11 23:29:46 -06003816Note that U-Boot now has a driver model, a unified model for drivers.
3817If you are adding a new driver, plumb it into driver model. If there
3818is no uclass available, you are encouraged to create one. See
3819doc/driver-model.
3820
wdenkc6097192002-11-03 00:24:07 +00003821
wdenk6c59edc2004-05-03 20:45:30 +00003822Configuring the Linux kernel:
3823-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003824
wdenk6c59edc2004-05-03 20:45:30 +00003825No specific requirements for U-Boot. Make sure you have some root
3826device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003827
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk6c59edc2004-05-03 20:45:30 +00003829Building a Linux Image:
3830-----------------------
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk6c59edc2004-05-03 20:45:30 +00003832With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3833not used. If you use recent kernel source, a new build target
3834"uImage" will exist which automatically builds an image usable by
3835U-Boot. Most older kernels also have support for a "pImage" target,
3836which was introduced for our predecessor project PPCBoot and uses a
3837100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003838
wdenk6c59edc2004-05-03 20:45:30 +00003839Example:
wdenkc6097192002-11-03 00:24:07 +00003840
Holger Freyther7ba4e572014-08-04 09:26:05 +02003841 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003842 make oldconfig
3843 make dep
3844 make uImage
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk6c59edc2004-05-03 20:45:30 +00003846The "uImage" build target uses a special tool (in 'tools/mkimage') to
3847encapsulate a compressed Linux kernel image with header information,
3848CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk6c59edc2004-05-03 20:45:30 +00003850* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003851
wdenk6c59edc2004-05-03 20:45:30 +00003852* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003853
wdenk6c59edc2004-05-03 20:45:30 +00003854 ${CROSS_COMPILE}-objcopy -O binary \
3855 -R .note -R .comment \
3856 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003857
wdenk6c59edc2004-05-03 20:45:30 +00003858* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003859
wdenk6c59edc2004-05-03 20:45:30 +00003860 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003861
wdenk6c59edc2004-05-03 20:45:30 +00003862* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003863
wdenk6c59edc2004-05-03 20:45:30 +00003864 mkimage -A ppc -O linux -T kernel -C gzip \
3865 -a 0 -e 0 -n "Linux Kernel Image" \
3866 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003867
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869The "mkimage" tool can also be used to create ramdisk images for use
3870with U-Boot, either separated from the Linux kernel image, or
3871combined into one file. "mkimage" encapsulates the images with a 64
3872byte header containing information about target architecture,
3873operating system, image type, compression method, entry points, time
3874stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk6c59edc2004-05-03 20:45:30 +00003876"mkimage" can be called in two ways: to verify existing images and
3877print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003878
wdenk6c59edc2004-05-03 20:45:30 +00003879In the first form (with "-l" option) mkimage lists the information
3880contained in the header of an existing U-Boot image; this includes
3881checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883 tools/mkimage -l image
3884 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003885
wdenk6c59edc2004-05-03 20:45:30 +00003886The second form (with "-d" option) is used to build a U-Boot image
3887from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003888
wdenk6c59edc2004-05-03 20:45:30 +00003889 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3890 -n name -d data_file image
3891 -A ==> set architecture to 'arch'
3892 -O ==> set operating system to 'os'
3893 -T ==> set image type to 'type'
3894 -C ==> set compression type 'comp'
3895 -a ==> set load address to 'addr' (hex)
3896 -e ==> set entry point to 'ep' (hex)
3897 -n ==> set image name to 'name'
3898 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003899
wdenkcd914452004-05-29 16:53:29 +00003900Right now, all Linux kernels for PowerPC systems use the same load
3901address (0x00000000), but the entry point address depends on the
3902kernel version:
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk6c59edc2004-05-03 20:45:30 +00003904- 2.2.x kernels have the entry point at 0x0000000C,
3905- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003906
wdenk6c59edc2004-05-03 20:45:30 +00003907So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003908
wdenk6c59edc2004-05-03 20:45:30 +00003909 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3910 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003911 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003912 > examples/uImage.TQM850L
3913 Image Name: 2.4.4 kernel for TQM850L
3914 Created: Wed Jul 19 02:34:59 2000
3915 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3916 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3917 Load Address: 0x00000000
3918 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk6c59edc2004-05-03 20:45:30 +00003920To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003921
wdenk6c59edc2004-05-03 20:45:30 +00003922 -> tools/mkimage -l examples/uImage.TQM850L
3923 Image Name: 2.4.4 kernel for TQM850L
3924 Created: Wed Jul 19 02:34:59 2000
3925 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3926 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3927 Load Address: 0x00000000
3928 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk6c59edc2004-05-03 20:45:30 +00003930NOTE: for embedded systems where boot time is critical you can trade
3931speed for memory and install an UNCOMPRESSED image instead: this
3932needs more space in Flash, but boots much faster since it does not
3933need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003934
Stefan Roese88fbf932010-04-15 16:07:28 +02003935 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003936 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3937 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003938 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003939 > examples/uImage.TQM850L-uncompressed
3940 Image Name: 2.4.4 kernel for TQM850L
3941 Created: Wed Jul 19 02:34:59 2000
3942 Image Type: PowerPC Linux Kernel Image (uncompressed)
3943 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3944 Load Address: 0x00000000
3945 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003946
wdenkc6097192002-11-03 00:24:07 +00003947
wdenk6c59edc2004-05-03 20:45:30 +00003948Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3949when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk6c59edc2004-05-03 20:45:30 +00003951 -> tools/mkimage -n 'Simple Ramdisk Image' \
3952 > -A ppc -O linux -T ramdisk -C gzip \
3953 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3954 Image Name: Simple Ramdisk Image
3955 Created: Wed Jan 12 14:01:50 2000
3956 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3957 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3958 Load Address: 0x00000000
3959 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003960
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07003961The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3962option performs the converse operation of the mkimage's second form (the "-d"
3963option). Given an image built by mkimage, the dumpimage extracts a "data file"
3964from the image:
3965
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02003966 tools/dumpimage -i image -T type -p position data_file
3967 -i ==> extract from the 'image' a specific 'data_file'
3968 -T ==> set image type to 'type'
3969 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07003970
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk6c59edc2004-05-03 20:45:30 +00003972Installing a Linux Image:
3973-------------------------
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk6c59edc2004-05-03 20:45:30 +00003975To downloading a U-Boot image over the serial (console) interface,
3976you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003977
wdenk6c59edc2004-05-03 20:45:30 +00003978 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk6c59edc2004-05-03 20:45:30 +00003980The 'objcopy' does not understand the information in the U-Boot
3981image header, so the resulting S-Record file will be relative to
3982address 0x00000000. To load it to a given address, you need to
3983specify the target address as 'offset' parameter with the 'loads'
3984command.
wdenkc6097192002-11-03 00:24:07 +00003985
wdenk6c59edc2004-05-03 20:45:30 +00003986Example: install the image to address 0x40100000 (which on the
3987TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk6c59edc2004-05-03 20:45:30 +00003989 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk6c59edc2004-05-03 20:45:30 +00003991 .......... done
3992 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk6c59edc2004-05-03 20:45:30 +00003994 => loads 40100000
3995 ## Ready for S-Record download ...
3996 ~>examples/image.srec
3997 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3998 ...
3999 15989 15990 15991 15992
4000 [file transfer complete]
4001 [connected]
4002 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004003
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk6c59edc2004-05-03 20:45:30 +00004005You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004006this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004007corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004008
wdenk6c59edc2004-05-03 20:45:30 +00004009 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011 ## Checking Image at 40100000 ...
4012 Image Name: 2.2.13 for initrd on TQM850L
4013 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4014 Data Size: 335725 Bytes = 327 kB = 0 MB
4015 Load Address: 00000000
4016 Entry Point: 0000000c
4017 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004018
4019
wdenk6c59edc2004-05-03 20:45:30 +00004020Boot Linux:
4021-----------
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk6c59edc2004-05-03 20:45:30 +00004023The "bootm" command is used to boot an application that is stored in
4024memory (RAM or Flash). In case of a Linux kernel image, the contents
4025of the "bootargs" environment variable is passed to the kernel as
4026parameters. You can check and modify this variable using the
4027"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004028
wdenkc6097192002-11-03 00:24:07 +00004029
wdenk6c59edc2004-05-03 20:45:30 +00004030 => printenv bootargs
4031 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004032
wdenk6c59edc2004-05-03 20:45:30 +00004033 => 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 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035 => printenv bootargs
4036 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 +00004037
wdenk6c59edc2004-05-03 20:45:30 +00004038 => bootm 40020000
4039 ## Booting Linux kernel at 40020000 ...
4040 Image Name: 2.2.13 for NFS on TQM850L
4041 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4042 Data Size: 381681 Bytes = 372 kB = 0 MB
4043 Load Address: 00000000
4044 Entry Point: 0000000c
4045 Verifying Checksum ... OK
4046 Uncompressing Kernel Image ... OK
4047 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
4048 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4049 time_init: decrementer frequency = 187500000/60
4050 Calibrating delay loop... 49.77 BogoMIPS
4051 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4052 ...
wdenkc6097192002-11-03 00:24:07 +00004053
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004054If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004055the memory addresses of both the kernel and the initrd image (PPBCOOT
4056format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk6c59edc2004-05-03 20:45:30 +00004058 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004059
wdenk6c59edc2004-05-03 20:45:30 +00004060 ## Checking Image at 40100000 ...
4061 Image Name: 2.2.13 for initrd on TQM850L
4062 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4063 Data Size: 335725 Bytes = 327 kB = 0 MB
4064 Load Address: 00000000
4065 Entry Point: 0000000c
4066 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk6c59edc2004-05-03 20:45:30 +00004068 ## Checking Image at 40200000 ...
4069 Image Name: Simple Ramdisk Image
4070 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4071 Data Size: 566530 Bytes = 553 kB = 0 MB
4072 Load Address: 00000000
4073 Entry Point: 00000000
4074 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk6c59edc2004-05-03 20:45:30 +00004076 => bootm 40100000 40200000
4077 ## Booting Linux kernel at 40100000 ...
4078 Image Name: 2.2.13 for initrd on TQM850L
4079 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4080 Data Size: 335725 Bytes = 327 kB = 0 MB
4081 Load Address: 00000000
4082 Entry Point: 0000000c
4083 Verifying Checksum ... OK
4084 Uncompressing Kernel Image ... OK
4085 ## Loading RAMDisk Image at 40200000 ...
4086 Image Name: Simple Ramdisk Image
4087 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4088 Data Size: 566530 Bytes = 553 kB = 0 MB
4089 Load Address: 00000000
4090 Entry Point: 00000000
4091 Verifying Checksum ... OK
4092 Loading Ramdisk ... OK
4093 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
4094 Boot arguments: root=/dev/ram
4095 time_init: decrementer frequency = 187500000/60
4096 Calibrating delay loop... 49.77 BogoMIPS
4097 ...
4098 RAMDISK: Compressed image found at block 0
4099 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk6c59edc2004-05-03 20:45:30 +00004101 bash#
wdenkc6097192002-11-03 00:24:07 +00004102
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004103Boot Linux and pass a flat device tree:
4104-----------
4105
4106First, U-Boot must be compiled with the appropriate defines. See the section
4107titled "Linux Kernel Interface" above for a more in depth explanation. The
4108following is an example of how to start a kernel and pass an updated
4109flat device tree:
4110
4111=> print oftaddr
4112oftaddr=0x300000
4113=> print oft
4114oft=oftrees/mpc8540ads.dtb
4115=> tftp $oftaddr $oft
4116Speed: 1000, full duplex
4117Using TSEC0 device
4118TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4119Filename 'oftrees/mpc8540ads.dtb'.
4120Load address: 0x300000
4121Loading: #
4122done
4123Bytes transferred = 4106 (100a hex)
4124=> tftp $loadaddr $bootfile
4125Speed: 1000, full duplex
4126Using TSEC0 device
4127TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4128Filename 'uImage'.
4129Load address: 0x200000
4130Loading:############
4131done
4132Bytes transferred = 1029407 (fb51f hex)
4133=> print loadaddr
4134loadaddr=200000
4135=> print oftaddr
4136oftaddr=0x300000
4137=> bootm $loadaddr - $oftaddr
4138## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004139 Image Name: Linux-2.6.17-dirty
4140 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4141 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004142 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004143 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004144 Verifying Checksum ... OK
4145 Uncompressing Kernel Image ... OK
4146Booting using flat device tree at 0x300000
4147Using MPC85xx ADS machine description
4148Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4149[snip]
4150
4151
wdenk6c59edc2004-05-03 20:45:30 +00004152More About U-Boot Image Types:
4153------------------------------
wdenkc6097192002-11-03 00:24:07 +00004154
wdenk6c59edc2004-05-03 20:45:30 +00004155U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157 "Standalone Programs" are directly runnable in the environment
4158 provided by U-Boot; it is expected that (if they behave
4159 well) you can continue to work in U-Boot after return from
4160 the Standalone Program.
4161 "OS Kernel Images" are usually images of some Embedded OS which
4162 will take over control completely. Usually these programs
4163 will install their own set of exception handlers, device
4164 drivers, set up the MMU, etc. - this means, that you cannot
4165 expect to re-enter U-Boot except by resetting the CPU.
4166 "RAMDisk Images" are more or less just data blocks, and their
4167 parameters (address, size) are passed to an OS kernel that is
4168 being started.
4169 "Multi-File Images" contain several images, typically an OS
4170 (Linux) kernel image and one or more data images like
4171 RAMDisks. This construct is useful for instance when you want
4172 to boot over the network using BOOTP etc., where the boot
4173 server provides just a single image file, but you want to get
4174 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004175
wdenk6c59edc2004-05-03 20:45:30 +00004176 "Multi-File Images" start with a list of image sizes, each
4177 image size (in bytes) specified by an "uint32_t" in network
4178 byte order. This list is terminated by an "(uint32_t)0".
4179 Immediately after the terminating 0 follow the images, one by
4180 one, all aligned on "uint32_t" boundaries (size rounded up to
4181 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk6c59edc2004-05-03 20:45:30 +00004183 "Firmware Images" are binary images containing firmware (like
4184 U-Boot or FPGA images) which usually will be programmed to
4185 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004186
wdenk6c59edc2004-05-03 20:45:30 +00004187 "Script files" are command sequences that will be executed by
4188 U-Boot's command interpreter; this feature is especially
4189 useful when you configure U-Boot to use a real shell (hush)
4190 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004191
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004192Booting the Linux zImage:
4193-------------------------
4194
4195On some platforms, it's possible to boot Linux zImage. This is done
4196using the "bootz" command. The syntax of "bootz" command is the same
4197as the syntax of "bootm" command.
4198
Tom Rini45f46d12013-05-16 11:40:11 -04004199Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004200kernel with raw initrd images. The syntax is slightly different, the
4201address of the initrd must be augmented by it's size, in the following
4202format: "<initrd addres>:<initrd size>".
4203
stroeseb9c17c52003-04-04 15:53:41 +00004204
wdenk6c59edc2004-05-03 20:45:30 +00004205Standalone HOWTO:
4206=================
stroeseb9c17c52003-04-04 15:53:41 +00004207
wdenk6c59edc2004-05-03 20:45:30 +00004208One of the features of U-Boot is that you can dynamically load and
4209run "standalone" applications, which can use some resources of
4210U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004211
wdenk6c59edc2004-05-03 20:45:30 +00004212Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004213
wdenk6c59edc2004-05-03 20:45:30 +00004214"Hello World" Demo:
4215-------------------
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk6c59edc2004-05-03 20:45:30 +00004217'examples/hello_world.c' contains a small "Hello World" Demo
4218application; it is automatically compiled when you build U-Boot.
4219It's configured to run at address 0x00040004, so you can play with it
4220like that:
wdenkc6097192002-11-03 00:24:07 +00004221
wdenk6c59edc2004-05-03 20:45:30 +00004222 => loads
4223 ## Ready for S-Record download ...
4224 ~>examples/hello_world.srec
4225 1 2 3 4 5 6 7 8 9 10 11 ...
4226 [file transfer complete]
4227 [connected]
4228 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004229
wdenk6c59edc2004-05-03 20:45:30 +00004230 => go 40004 Hello World! This is a test.
4231 ## Starting application at 0x00040004 ...
4232 Hello World
4233 argc = 7
4234 argv[0] = "40004"
4235 argv[1] = "Hello"
4236 argv[2] = "World!"
4237 argv[3] = "This"
4238 argv[4] = "is"
4239 argv[5] = "a"
4240 argv[6] = "test."
4241 argv[7] = "<NULL>"
4242 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004243
wdenk6c59edc2004-05-03 20:45:30 +00004244 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246Another example, which demonstrates how to register a CPM interrupt
4247handler with the U-Boot code, can be found in 'examples/timer.c'.
4248Here, a CPM timer is set up to generate an interrupt every second.
4249The interrupt service routine is trivial, just printing a '.'
4250character, but this is just a demo program. The application can be
4251controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk6c59edc2004-05-03 20:45:30 +00004253 ? - print current values og the CPM Timer registers
4254 b - enable interrupts and start timer
4255 e - stop timer and disable interrupts
4256 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258 => loads
4259 ## Ready for S-Record download ...
4260 ~>examples/timer.srec
4261 1 2 3 4 5 6 7 8 9 10 11 ...
4262 [file transfer complete]
4263 [connected]
4264 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004265
wdenk6c59edc2004-05-03 20:45:30 +00004266 => go 40004
4267 ## Starting application at 0x00040004 ...
4268 TIMERS=0xfff00980
4269 Using timer 1
4270 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004271
wdenk6c59edc2004-05-03 20:45:30 +00004272Hit 'b':
4273 [q, b, e, ?] Set interval 1000000 us
4274 Enabling timer
4275Hit '?':
4276 [q, b, e, ?] ........
4277 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4278Hit '?':
4279 [q, b, e, ?] .
4280 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4281Hit '?':
4282 [q, b, e, ?] .
4283 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4284Hit '?':
4285 [q, b, e, ?] .
4286 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4287Hit 'e':
4288 [q, b, e, ?] ...Stopping timer
4289Hit 'q':
4290 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004291
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk6c59edc2004-05-03 20:45:30 +00004293Minicom warning:
4294================
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk6c59edc2004-05-03 20:45:30 +00004296Over time, many people have reported problems when trying to use the
4297"minicom" terminal emulation program for serial download. I (wd)
4298consider minicom to be broken, and recommend not to use it. Under
4299Unix, I recommend to use C-Kermit for general purpose use (and
4300especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004301use "cu" for S-Record download ("loads" command). See
4302http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4303for help with kermit.
4304
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306Nevertheless, if you absolutely want to use it try adding this
4307configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004308
wdenk6c59edc2004-05-03 20:45:30 +00004309 Name Program Name U/D FullScr IO-Red. Multi
4310 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4311 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004312
wdenk8dba0502003-03-31 16:34:49 +00004313
wdenk6c59edc2004-05-03 20:45:30 +00004314NetBSD Notes:
4315=============
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk6c59edc2004-05-03 20:45:30 +00004317Starting at version 0.9.2, U-Boot supports NetBSD both as host
4318(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004319
wdenk6c59edc2004-05-03 20:45:30 +00004320Building requires a cross environment; it is known to work on
4321NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4322need gmake since the Makefiles are not compatible with BSD make).
4323Note that the cross-powerpc package does not install include files;
4324attempting to build U-Boot will fail because <machine/ansi.h> is
4325missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327 # cd /usr/pkg/cross/powerpc-netbsd/include
4328 # mkdir powerpc
4329 # ln -s powerpc machine
4330 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4331 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004332
wdenk6c59edc2004-05-03 20:45:30 +00004333Native builds *don't* work due to incompatibilities between native
4334and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336Booting assumes that (the first part of) the image booted is a
4337stage-2 loader which in turn loads and then invokes the kernel
4338proper. Loader sources will eventually appear in the NetBSD source
4339tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004340meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004341
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk6c59edc2004-05-03 20:45:30 +00004343Implementation Internals:
4344=========================
wdenkc6097192002-11-03 00:24:07 +00004345
wdenk6c59edc2004-05-03 20:45:30 +00004346The following is not intended to be a complete description of every
4347implementation detail. However, it should help to understand the
4348inner workings of U-Boot and make it easier to port it to custom
4349hardware.
wdenkc6097192002-11-03 00:24:07 +00004350
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk6c59edc2004-05-03 20:45:30 +00004352Initial Stack, Global Data:
4353---------------------------
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk6c59edc2004-05-03 20:45:30 +00004355The implementation of U-Boot is complicated by the fact that U-Boot
4356starts running out of ROM (flash memory), usually without access to
4357system RAM (because the memory controller is not initialized yet).
4358This means that we don't have writable Data or BSS segments, and BSS
4359is not initialized as zero. To be able to get a C environment working
4360at all, we have to allocate at least a minimal stack. Implementation
4361options for this are defined and restricted by the CPU used: Some CPU
4362models provide on-chip memory (like the IMMR area on MPC8xx and
4363MPC826x processors), on others (parts of) the data cache can be
4364locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004365
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004366 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004367 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4370 From: "Chris Hallinan" <clh@net1plus.com>
4371 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4372 ...
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk6c59edc2004-05-03 20:45:30 +00004374 Correct me if I'm wrong, folks, but the way I understand it
4375 is this: Using DCACHE as initial RAM for Stack, etc, does not
4376 require any physical RAM backing up the cache. The cleverness
4377 is that the cache is being used as a temporary supply of
4378 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004379 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004380 can see how this works by studying the cache architecture and
4381 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4384 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004385 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004386 option should work for you. Using CS 4 should be fine if your
4387 board designers haven't used it for something that would
4388 cause you grief during the initial boot! It is frequently not
4389 used.
wdenkc6097192002-11-03 00:24:07 +00004390
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004391 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004392 with your processor/board/system design. The default value
4393 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004394 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004395 than your SDRAM module. If you have a 64MB SDRAM module, set
4396 it above 400_0000. Just make sure your board has no resources
4397 that are supposed to respond to that address! That code in
4398 start.S has been around a while and should work as is when
4399 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004400
wdenk6c59edc2004-05-03 20:45:30 +00004401 -Chris Hallinan
4402 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404It is essential to remember this, since it has some impact on the C
4405code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004406
wdenk6c59edc2004-05-03 20:45:30 +00004407* Initialized global data (data segment) is read-only. Do not attempt
4408 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004409
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004410* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004411 as zero data - BSS segment) at all - this is undefined, initiali-
4412 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004413
wdenk6c59edc2004-05-03 20:45:30 +00004414* Stack space is very limited. Avoid big data buffers or things like
4415 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004416
wdenk6c59edc2004-05-03 20:45:30 +00004417Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004418normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004419turned out that the implementation of U-Boot can be greatly
4420simplified by making a global data structure (gd_t) available to all
4421functions. We could pass a pointer to this data as argument to _all_
4422functions, but this would bloat the code. Instead we use a feature of
4423the GCC compiler (Global Register Variables) to share the data: we
4424place a pointer (gd) to the global data into a register which we
4425reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk6c59edc2004-05-03 20:45:30 +00004427When choosing a register for such a purpose we are restricted by the
4428relevant (E)ABI specifications for the current architecture, and by
4429GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk6c59edc2004-05-03 20:45:30 +00004431For PowerPC, the following registers have specific use:
4432 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004433 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004434 R3-R4: parameter passing and return values
4435 R5-R10: parameter passing
4436 R13: small data area pointer
4437 R30: GOT pointer
4438 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004439
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004440 (U-Boot also uses R12 as internal GOT pointer. r12
4441 is a volatile register so r12 needs to be reset when
4442 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004443
Wolfgang Denk69c09642008-02-14 22:43:22 +01004444 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004445
wdenk6c59edc2004-05-03 20:45:30 +00004446 Note: on PPC, we could use a static initializer (since the
4447 address of the global data structure is known at compile time),
4448 but it turned out that reserving a register results in somewhat
4449 smaller code - although the code savings are not that big (on
4450 average for all boards 752 bytes for the whole U-Boot image,
4451 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004452
wdenk6c59edc2004-05-03 20:45:30 +00004453On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk6c59edc2004-05-03 20:45:30 +00004455 R0: function argument word/integer result
4456 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004457 R9: platform specific
4458 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004459 R11: argument (frame) pointer
4460 R12: temporary workspace
4461 R13: stack pointer
4462 R14: link register
4463 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004464
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004465 ==> U-Boot will use R9 to hold a pointer to the global data
4466
4467 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004468
Thomas Chou8fa38582010-05-21 11:08:03 +08004469On Nios II, the ABI is documented here:
4470 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4471
4472 ==> U-Boot will use gp to hold a pointer to the global data
4473
4474 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4475 to access small data sections, so gp is free.
4476
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004477On NDS32, the following registers are used:
4478
4479 R0-R1: argument/return
4480 R2-R5: argument
4481 R15: temporary register for assembler
4482 R16: trampoline register
4483 R28: frame pointer (FP)
4484 R29: global pointer (GP)
4485 R30: link register (LP)
4486 R31: stack pointer (SP)
4487 PC: program counter (PC)
4488
4489 ==> U-Boot will use R10 to hold a pointer to the global data
4490
Wolfgang Denk6405a152006-03-31 18:32:53 +02004491NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4492or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004493
Rick Chend7e6f922017-12-26 13:55:59 +08004494On RISC-V, the following registers are used:
4495
4496 x0: hard-wired zero (zero)
4497 x1: return address (ra)
4498 x2: stack pointer (sp)
4499 x3: global pointer (gp)
4500 x4: thread pointer (tp)
4501 x5: link register (t0)
4502 x8: frame pointer (fp)
4503 x10-x11: arguments/return values (a0-1)
4504 x12-x17: arguments (a2-7)
4505 x28-31: temporaries (t3-6)
4506 pc: program counter (pc)
4507
4508 ==> U-Boot will use gp to hold a pointer to the global data
4509
wdenk6c59edc2004-05-03 20:45:30 +00004510Memory Management:
4511------------------
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk6c59edc2004-05-03 20:45:30 +00004513U-Boot runs in system state and uses physical addresses, i.e. the
4514MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk6c59edc2004-05-03 20:45:30 +00004516The available memory is mapped to fixed addresses using the memory
4517controller. In this process, a contiguous block is formed for each
4518memory type (Flash, SDRAM, SRAM), even when it consists of several
4519physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk6c59edc2004-05-03 20:45:30 +00004521U-Boot is installed in the first 128 kB of the first Flash bank (on
4522TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4523booting and sizing and initializing DRAM, the code relocates itself
4524to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004525memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004526configuration setting]. Below that, a structure with global Board
4527Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529Additionally, some exception handler code is copied to the low 8 kB
4530of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532So a typical memory configuration with 16 MB of DRAM could look like
4533this:
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535 0x0000 0000 Exception Vector code
4536 :
4537 0x0000 1FFF
4538 0x0000 2000 Free for Application Use
4539 :
4540 :
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542 :
4543 :
4544 0x00FB FF20 Monitor Stack (Growing downward)
4545 0x00FB FFAC Board Info Data and permanent copy of global data
4546 0x00FC 0000 Malloc Arena
4547 :
4548 0x00FD FFFF
4549 0x00FE 0000 RAM Copy of Monitor Code
4550 ... eventually: LCD or video framebuffer
4551 ... eventually: pRAM (Protected RAM - unchanged by reset)
4552 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004553
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk6c59edc2004-05-03 20:45:30 +00004555System Initialization:
4556----------------------
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004559(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004560configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00004561To be able to re-map memory U-Boot then jumps to its link address.
4562To be able to implement the initialization code in C, a (small!)
4563initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02004564which provide such a feature like), or in a locked part of the data
4565cache. After that, U-Boot initializes the CPU core, the caches and
4566the SIU.
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk6c59edc2004-05-03 20:45:30 +00004568Next, all (potentially) available memory banks are mapped using a
4569preliminary mapping. For example, we put them on 512 MB boundaries
4570(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4571on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4572programmed for SDRAM access. Using the temporary configuration, a
4573simple memory test is run that determines the size of the SDRAM
4574banks.
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk6c59edc2004-05-03 20:45:30 +00004576When there is more than one SDRAM bank, and the banks are of
4577different size, the largest is mapped first. For equal size, the first
4578bank (CS2#) is mapped first. The first mapping is always for address
45790x00000000, with any additional banks following immediately to create
4580contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004581
wdenk6c59edc2004-05-03 20:45:30 +00004582Then, the monitor installs itself at the upper end of the SDRAM area
4583and allocates memory for use by malloc() and for the global Board
4584Info data; also, the exception vector code is copied to the low RAM
4585pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk6c59edc2004-05-03 20:45:30 +00004587Only after this relocation will you have a "normal" C environment;
4588until that you are restricted in several ways, mostly because you are
4589running from ROM, and because the code will have to be relocated to a
4590new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004591
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk6c59edc2004-05-03 20:45:30 +00004593U-Boot Porting Guide:
4594----------------------
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk6c59edc2004-05-03 20:45:30 +00004596[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4597list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004598
wdenkc6097192002-11-03 00:24:07 +00004599
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004600int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004601{
4602 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004603
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004604 signal(SIGALRM, no_more_time);
4605 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004606
wdenk6c59edc2004-05-03 20:45:30 +00004607 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004608 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004609 return 0;
4610 }
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk6c59edc2004-05-03 20:45:30 +00004612 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004613
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004614 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004615
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004616 if (clueless)
4617 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk6c59edc2004-05-03 20:45:30 +00004619 while (learning) {
4620 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004621 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01004622 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00004623 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004624 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004625 }
wdenkc6097192002-11-03 00:24:07 +00004626
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004627 if (available_money > toLocalCurrency ($2500))
4628 Buy a BDI3000;
4629 else
wdenk6c59edc2004-05-03 20:45:30 +00004630 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004631
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004632 if (a similar board exists) { /* hopefully... */
4633 cp -a board/<similar> board/<myboard>
4634 cp include/configs/<similar>.h include/configs/<myboard>.h
4635 } else {
4636 Create your own board support subdirectory;
4637 Create your own board include/configs/<myboard>.h file;
4638 }
4639 Edit new board/<myboard> files
4640 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004641
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004642 while (!accepted) {
4643 while (!running) {
4644 do {
4645 Add / modify source code;
4646 } until (compiles);
4647 Debug;
4648 if (clueless)
4649 email("Hi, I am having problems...");
4650 }
4651 Send patch file to the U-Boot email list;
4652 if (reasonable critiques)
4653 Incorporate improvements from email list code review;
4654 else
4655 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004656 }
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk6c59edc2004-05-03 20:45:30 +00004658 return 0;
4659}
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661void no_more_time (int sig)
4662{
4663 hire_a_guru();
4664}
wdenkc6097192002-11-03 00:24:07 +00004665
wdenkc6097192002-11-03 00:24:07 +00004666
wdenk6c59edc2004-05-03 20:45:30 +00004667Coding Standards:
4668-----------------
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk6c59edc2004-05-03 20:45:30 +00004670All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02004671coding style; see the kernel coding style guide at
4672https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4673script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004674
4675Source files originating from a different project (for example the
4676MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004677reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02004678sources.
wdenkc6097192002-11-03 00:24:07 +00004679
Detlev Zundelaa63d482006-09-01 15:39:02 +02004680Please note that U-Boot is implemented in C (and to some small parts in
4681Assembler); no C++ is used, so please do not use C++ style comments (//)
4682in your code.
wdenkad276f22004-01-04 16:28:35 +00004683
wdenk6c59edc2004-05-03 20:45:30 +00004684Please also stick to the following formatting rules:
4685- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004686- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004687- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004688- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004689- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk6c59edc2004-05-03 20:45:30 +00004691Submissions which do not conform to the standards may be returned
4692with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004693
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk6c59edc2004-05-03 20:45:30 +00004695Submitting Patches:
4696-------------------
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698Since the number of patches for U-Boot is growing, we need to
4699establish some rules. Submissions which do not conform to these rules
4700may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004701
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004702Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004703
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004704Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08004705see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004706
wdenk6c59edc2004-05-03 20:45:30 +00004707When you send a patch, please include the following information with
4708it:
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710* For bug fixes: a description of the bug and how your patch fixes
4711 this bug. Please try to include a way of demonstrating that the
4712 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714* For new features: a description of the feature and your
4715 implementation.
wdenkc6097192002-11-03 00:24:07 +00004716
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05004717* For major contributions, add a MAINTAINERS file with your
4718 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00004719
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02004720* When you add support for a new board, don't forget to add a
4721 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723* If your patch adds new configuration options, don't forget to
4724 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004725
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004726* The patch itself. If you are using git (which is *strongly*
4727 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004728 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004729 the U-Boot mailing list, you will avoid most of the common problems
4730 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004731
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004732 If you cannot use git, use "diff -purN OLD NEW". If your version of
4733 diff does not support these options, then get the latest version of
4734 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004735
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004736 The current directory when running this command shall be the parent
4737 directory of the U-Boot source tree (i. e. please make sure that
4738 your patch includes sufficient directory information for the
4739 affected files).
4740
4741 We prefer patches as plain text. MIME attachments are discouraged,
4742 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004743
wdenk6c59edc2004-05-03 20:45:30 +00004744* If one logical set of modifications affects or creates several
4745 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747* Changesets that contain different, unrelated modifications shall be
4748 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004749
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk6c59edc2004-05-03 20:45:30 +00004751Notes:
wdenkc6097192002-11-03 00:24:07 +00004752
Simon Glassdc27def2016-07-27 20:33:08 -06004753* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00004754 source tree and make sure that no errors or warnings are reported
4755 for any of the boards.
4756
4757* Keep your modifications to the necessary minimum: A patch
4758 containing several unrelated changes or arbitrary reformats will be
4759 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk6c59edc2004-05-03 20:45:30 +00004761* If you modify existing code, make sure that your new code does not
4762 add to the memory footprint of the code ;-) Small is beautiful!
4763 When adding new features, these should compile conditionally only
4764 (using #ifdef), and the resulting code with the new feature
4765 disabled must not need more memory than the old code without your
4766 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004767
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004768* Remember that there is a size limit of 100 kB per message on the
4769 u-boot mailing list. Bigger patches will be moderated. If they are
4770 reasonable and not too big, they will be acknowledged. But patches
4771 bigger than the size limit should be avoided.