blob: a5aee86211c2c813d17d3f4bf6aba9707236c054 [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- Autoboot Command:
674 CONFIG_BOOTCOMMAND
675 Only needed when CONFIG_BOOTDELAY is enabled;
676 define a command string that is automatically executed
677 when no character is read on the console interface
678 within "Boot Delay" after reset.
679
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000681 The value of these goes into the environment as
682 "ramboot" and "nfsboot" respectively, and can be used
683 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200684 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000685
wdenkc6097192002-11-03 00:24:07 +0000686- Serial Download Echo Mode:
687 CONFIG_LOADS_ECHO
688 If defined to 1, all characters received during a
689 serial download (using the "loads" command) are
690 echoed back. This might be needed by some terminal
691 emulations (like "cu"), but may as well just take
692 time on others. This setting #define's the initial
693 value of the "loads_echo" environment variable.
694
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500695- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000696 CONFIG_KGDB_BAUDRATE
697 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200698 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000699
Simon Glassaa34ef22016-03-13 19:07:28 -0600700- Removal of commands
701 If no commands are needed to boot, you can disable
702 CONFIG_CMDLINE to remove them. In this case, the command line
703 will not be available, and when U-Boot wants to execute the
704 boot command (on start-up) it will call board_run_command()
705 instead. This can reduce image size significantly for very
706 simple boot procedures.
707
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000708- Regular expression support:
709 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200710 If this variable is defined, U-Boot is linked against
711 the SLRE (Super Light Regular Expression) library,
712 which adds regex support to some commands, as for
713 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000714
Simon Glass3d686442011-10-15 05:48:20 +0000715- Device tree:
716 CONFIG_OF_CONTROL
717 If this variable is defined, U-Boot will use a device tree
718 to configure its devices, instead of relying on statically
719 compiled #defines in the board file. This option is
720 experimental and only available on a few boards. The device
721 tree is available in the global data as gd->fdt_blob.
722
Simon Glass5cb34db2011-10-24 19:15:31 +0000723 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700724 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000725
726 CONFIG_OF_EMBED
727 If this variable is defined, U-Boot will embed a device tree
728 binary in its image. This device tree file should be in the
729 board directory and called <soc>-<board>.dts. The binary file
730 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900731 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000732
Simon Glass5cb34db2011-10-24 19:15:31 +0000733 CONFIG_OF_SEPARATE
734 If this variable is defined, U-Boot will build a device tree
735 binary. It will be called u-boot.dtb. Architecture-specific
736 code will locate it at run-time. Generally this works by:
737
738 cat u-boot.bin u-boot.dtb >image.bin
739
740 and in fact, U-Boot does this for you, creating a file called
741 u-boot-dtb.bin which is useful in the common case. You can
742 still use the individual files if you need something more
743 exotic.
744
Alex Deymo5b661ec2017-04-02 01:25:20 -0700745 CONFIG_OF_BOARD
746 If this variable is defined, U-Boot will use the device tree
747 provided by the board at runtime instead of embedding one with
748 the image. Only boards defining board_fdt_blob_setup() support
749 this option (see include/fdtdec.h file).
750
wdenkc6097192002-11-03 00:24:07 +0000751- Watchdog:
752 CONFIG_WATCHDOG
753 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000754 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200755 specific code for a watchdog. For the 8xx
756 CPUs, the SIU Watchdog feature is enabled in the SYPCR
757 register. When supported for a specific SoC is
758 available, then no further board specific code should
759 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000760
761 CONFIG_HW_WATCHDOG
762 When using a watchdog circuitry external to the used
763 SoC, then define this variable and provide board
764 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000765
766- Real-Time Clock:
767
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500768 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000769 has to be selected, too. Define exactly one of the
770 following options:
771
wdenkc6097192002-11-03 00:24:07 +0000772 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000773 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000774 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000775 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000776 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000777 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200778 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000779 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100780 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000781 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200782 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200783 CONFIG_SYS_RV3029_TCR - enable trickle charger on
784 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000785
wdenkb9bbd242003-06-30 16:24:52 +0000786 Note that if the RTC uses I2C, then the I2C interface
787 must also be configured. See I2C Support, below.
788
Peter Tyser9902e422008-12-17 16:36:21 -0600789- GPIO Support:
790 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600791
Chris Packham9b383202010-12-19 10:12:13 +0000792 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
793 chip-ngpio pairs that tell the PCA953X driver the number of
794 pins supported by a particular chip.
795
Peter Tyser9902e422008-12-17 16:36:21 -0600796 Note that if the GPIO device uses I2C, then the I2C interface
797 must also be configured. See I2C Support, below.
798
Simon Glass4dc47ca2014-06-11 23:29:41 -0600799- I/O tracing:
800 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
801 accesses and can checksum them or write a list of them out
802 to memory. See the 'iotrace' command for details. This is
803 useful for testing device drivers since it can confirm that
804 the driver behaves the same way before and after a code
805 change. Currently this is supported on sandbox and arm. To
806 add support for your architecture, add '#include <iotrace.h>'
807 to the bottom of arch/<arch>/include/asm/io.h and test.
808
809 Example output from the 'iotrace stats' command is below.
810 Note that if the trace buffer is exhausted, the checksum will
811 still continue to operate.
812
813 iotrace is enabled
814 Start: 10000000 (buffer start address)
815 Size: 00010000 (buffer size)
816 Offset: 00000120 (current buffer offset)
817 Output: 10000120 (start + offset)
818 Count: 00000018 (number of trace records)
819 CRC32: 9526fb66 (CRC32 of all trace records)
820
wdenkc6097192002-11-03 00:24:07 +0000821- Timestamp Support:
822
wdenk4a5c8a72003-03-06 00:02:04 +0000823 When CONFIG_TIMESTAMP is selected, the timestamp
824 (date and time) of an image is printed by image
825 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000827
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000828- Partition Labels (disklabels) Supported:
829 Zero or more of the following:
830 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000831 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
832 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
833 bootloader. Note 2TB partition limit; see
834 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600835 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000836 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000837
838- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000839 CONFIG_IDE_RESET_ROUTINE - this is defined in several
840 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000841
wdenk369d43d2004-03-14 14:09:05 +0000842 CONFIG_IDE_RESET - is this is defined, IDE Reset will
843 be performed by calling the function
844 ide_set_reset(int reset)
845 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000846
847- ATAPI Support:
848 CONFIG_ATAPI
849
850 Set this to enable ATAPI support.
851
wdenkf602aa02004-03-13 23:29:43 +0000852- LBA48 Support
853 CONFIG_LBA48
854
855 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100856 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000857 Whithout these , LBA48 support uses 32bit variables and will 'only'
858 support disks up to 2.1TB.
859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200860 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000861 When enabled, makes the IDE subsystem use 64bit sector addresses.
862 Default is 32bit.
863
wdenkc6097192002-11-03 00:24:07 +0000864- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200865 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
866 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
867 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000868 maximum numbers of LUNs, SCSI ID's and target
869 devices.
wdenkc6097192002-11-03 00:24:07 +0000870
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200871 The environment variable 'scsidevs' is set to the number of
872 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000873
wdenkc6097192002-11-03 00:24:07 +0000874- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000875 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000876 Support for Intel 8254x/8257x gigabit chips.
877
878 CONFIG_E1000_SPI
879 Utility code for direct access to the SPI bus on Intel 8257x.
880 This does not do anything useful unless you set at least one
881 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
882
883 CONFIG_E1000_SPI_GENERIC
884 Allow generic access to the SPI bus on the Intel 8257x, for
885 example with the "sspi" command.
886
wdenkc6097192002-11-03 00:24:07 +0000887 CONFIG_TULIP
888 Support for Digital 2114x chips.
wdenkc6097192002-11-03 00:24:07 +0000889
890 CONFIG_NATSEMI
891 Support for National dp83815 chips.
892
893 CONFIG_NS8382X
894 Support for National dp8382[01] gigabit chips.
895
wdenkaa603362003-05-12 21:50:16 +0000896- NETWORK Support (other):
897
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100898 CONFIG_DRIVER_AT91EMAC
899 Support for AT91RM9200 EMAC.
900
901 CONFIG_RMII
902 Define this to use reduced MII inteface
903
904 CONFIG_DRIVER_AT91EMAC_QUIET
905 If this defined, the driver is quiet.
906 The driver doen't show link status messages.
907
Rob Herringc9830dc2011-12-15 11:15:49 +0000908 CONFIG_CALXEDA_XGMAC
909 Support for the Calxeda XGMAC device
910
Ashok93fb8722012-10-15 06:20:47 +0000911 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000912 Support for SMSC's LAN91C96 chips.
913
wdenkaa603362003-05-12 21:50:16 +0000914 CONFIG_LAN91C96_USE_32_BIT
915 Define this to enable 32 bit addressing
916
Ashok93fb8722012-10-15 06:20:47 +0000917 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000918 Support for SMSC's LAN91C111 chip
919
920 CONFIG_SMC91111_BASE
921 Define this to hold the physical address
922 of the device (I/O space)
923
924 CONFIG_SMC_USE_32_BIT
925 Define this if data bus is 32 bits
926
927 CONFIG_SMC_USE_IOFUNCS
928 Define this to use i/o functions instead of macros
929 (some hardware wont work with macros)
930
Heiko Schocher7d037f72011-11-15 10:00:04 -0500931 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
932 Define this if you have more then 3 PHYs.
933
Macpaul Lin199c6252010-12-21 16:59:46 +0800934 CONFIG_FTGMAC100
935 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
936
937 CONFIG_FTGMAC100_EGIGA
938 Define this to use GE link update with gigabit PHY.
939 Define this if FTGMAC100 is connected to gigabit PHY.
940 If your system has 10/100 PHY only, it might not occur
941 wrong behavior. Because PHY usually return timeout or
942 useless data when polling gigabit status and gigabit
943 control registers. This behavior won't affect the
944 correctnessof 10/100 link speed update.
945
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900946 CONFIG_SH_ETHER
947 Support for Renesas on-chip Ethernet controller
948
949 CONFIG_SH_ETHER_USE_PORT
950 Define the number of ports to be used
951
952 CONFIG_SH_ETHER_PHY_ADDR
953 Define the ETH PHY's address
954
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900955 CONFIG_SH_ETHER_CACHE_WRITEBACK
956 If this option is set, the driver enables cache flush.
957
Vadim Bendeburydac69642011-10-17 08:36:14 +0000958- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000959 CONFIG_TPM
960 Support TPM devices.
961
Christophe Ricard8759ff82015-10-06 22:54:41 +0200962 CONFIG_TPM_TIS_INFINEON
963 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000964 per system is supported at this time.
965
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000966 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
967 Define the burst count bytes upper limit
968
Christophe Ricard88249232016-01-21 23:27:13 +0100969 CONFIG_TPM_ST33ZP24
970 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
971
972 CONFIG_TPM_ST33ZP24_I2C
973 Support for STMicroelectronics ST33ZP24 I2C devices.
974 Requires TPM_ST33ZP24 and I2C.
975
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100976 CONFIG_TPM_ST33ZP24_SPI
977 Support for STMicroelectronics ST33ZP24 SPI devices.
978 Requires TPM_ST33ZP24 and SPI.
979
Dirk Eibach20489092013-06-26 15:55:15 +0200980 CONFIG_TPM_ATMEL_TWI
981 Support for Atmel TWI TPM device. Requires I2C support.
982
Che-liang Chiouacea5702013-04-12 11:04:34 +0000983 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000984 Support for generic parallel port TPM devices. Only one device
985 per system is supported at this time.
986
987 CONFIG_TPM_TIS_BASE_ADDRESS
988 Base address where the generic TPM device is mapped
989 to. Contemporary x86 systems usually map it at
990 0xfed40000.
991
Reinhard Pfau4fece432013-06-26 15:55:13 +0200992 CONFIG_TPM
993 Define this to enable the TPM support library which provides
994 functional interfaces to some TPM commands.
995 Requires support for a TPM device.
996
997 CONFIG_TPM_AUTH_SESSIONS
998 Define this to enable authorized functions in the TPM library.
999 Requires CONFIG_TPM and CONFIG_SHA1.
1000
wdenkc6097192002-11-03 00:24:07 +00001001- USB Support:
1002 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001003 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001004 CONFIG_USB_UHCI to enable it.
1005 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001006 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001007 storage devices.
1008 Note:
1009 Supported are USB Keyboards and USB Floppy drives
1010 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001011
Simon Glass5978cdb2012-02-27 10:52:47 +00001012 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1013 txfilltuning field in the EHCI controller on reset.
1014
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001015 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1016 HW module registers.
1017
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001018- USB Device:
1019 Define the below if you wish to use the USB console.
1020 Once firmware is rebuilt from a serial console issue the
1021 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001022 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001023 it has found a new device. The environment variable usbtty
1024 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001025 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001026 Common Device Class Abstract Control Model serial device.
1027 If you select usbtty = gserial you should be able to enumerate
1028 a Linux host by
1029 # modprobe usbserial vendor=0xVendorID product=0xProductID
1030 else if using cdc_acm, simply setting the environment
1031 variable usbtty to be cdc_acm should suffice. The following
1032 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001033
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001034 CONFIG_USB_DEVICE
1035 Define this to build a UDC device
1036
1037 CONFIG_USB_TTY
1038 Define this to have a tty type of device available to
1039 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001040
Vipin KUMARbdb17702012-03-26 15:38:06 +05301041 CONFIG_USBD_HS
1042 Define this to enable the high speed support for usb
1043 device and usbtty. If this feature is enabled, a routine
1044 int is_usbd_high_speed(void)
1045 also needs to be defined by the driver to dynamically poll
1046 whether the enumeration has succeded at high speed or full
1047 speed.
1048
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001049 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001050 Define this if you want stdin, stdout &/or stderr to
1051 be set to usbtty.
1052
Wolfgang Denke2601822006-06-14 18:14:56 +02001053 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001054 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001055 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001056 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1057 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1058 should pretend to be a Linux device to it's target host.
1059
1060 CONFIG_USBD_MANUFACTURER
1061 Define this string as the name of your company for
1062 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001063
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001064 CONFIG_USBD_PRODUCT_NAME
1065 Define this string as the name of your product
1066 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001067
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001068 CONFIG_USBD_VENDORID
1069 Define this as your assigned Vendor ID from the USB
1070 Implementors Forum. This *must* be a genuine Vendor ID
1071 to avoid polluting the USB namespace.
1072 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001073
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001074 CONFIG_USBD_PRODUCTID
1075 Define this as the unique Product ID
1076 for your device
1077 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001078
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001079- ULPI Layer Support:
1080 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1081 the generic ULPI layer. The generic layer accesses the ULPI PHY
1082 via the platform viewport, so you need both the genric layer and
1083 the viewport enabled. Currently only Chipidea/ARC based
1084 viewport is supported.
1085 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1086 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001087 If your ULPI phy needs a different reference clock than the
1088 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1089 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001090
wdenk7a428cc2003-06-15 22:40:42 +00001091- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001092 The MMC controller on the Intel PXA is supported. To
1093 enable this define CONFIG_MMC. The MMC can be
1094 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001095 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001096 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1097 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001098
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001099 CONFIG_SH_MMCIF
1100 Support for Renesas on-chip MMCIF controller
1101
1102 CONFIG_SH_MMCIF_ADDR
1103 Define the base address of MMCIF registers
1104
1105 CONFIG_SH_MMCIF_CLK
1106 Define the clock frequency for MMCIF
1107
Tom Rini58a8d322013-03-14 05:32:47 +00001108- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001109 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001110 This enables the USB portion of the DFU USB class
1111
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001112 CONFIG_DFU_NAND
1113 This enables support for exposing NAND devices via DFU.
1114
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301115 CONFIG_DFU_RAM
1116 This enables support for exposing RAM via DFU.
1117 Note: DFU spec refer to non-volatile memory usage, but
1118 allow usages beyond the scope of spec - here RAM usage,
1119 one that would help mostly the developer.
1120
Heiko Schochera2f831e2013-06-12 06:05:51 +02001121 CONFIG_SYS_DFU_DATA_BUF_SIZE
1122 Dfu transfer uses a buffer before writing data to the
1123 raw storage device. Make the size (in bytes) of this buffer
1124 configurable. The size of this buffer is also configurable
1125 through the "dfu_bufsiz" environment variable.
1126
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001127 CONFIG_SYS_DFU_MAX_FILE_SIZE
1128 When updating files rather than the raw storage device,
1129 we use a static buffer to copy the file into and then write
1130 the buffer once we've been given the whole file. Define
1131 this to the maximum filesize (in bytes) for the buffer.
1132 Default is 4 MiB if undefined.
1133
Heiko Schochere1ba1512014-03-18 08:09:56 +01001134 DFU_DEFAULT_POLL_TIMEOUT
1135 Poll timeout [ms], is the timeout a device can send to the
1136 host. The host must wait for this timeout before sending
1137 a subsequent DFU_GET_STATUS request to the device.
1138
1139 DFU_MANIFEST_POLL_TIMEOUT
1140 Poll timeout [ms], which the device sends to the host when
1141 entering dfuMANIFEST state. Host waits this timeout, before
1142 sending again an USB request to the device.
1143
wdenkda04a8b2004-08-02 23:22:59 +00001144- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001145 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001146 Define these for a default partition on a NAND device
1147
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001148 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1149 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001150 Define these for a default partition on a NOR device
1151
wdenkc6097192002-11-03 00:24:07 +00001152- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001153 See Kconfig help for available keyboard drivers.
1154
1155 CONFIG_KEYBOARD
1156
1157 Define this to enable a custom keyboard support.
1158 This simply calls drv_keyboard_init() which must be
1159 defined in your board-specific files. This option is deprecated
1160 and is only used by novena. For new boards, use driver model
1161 instead.
wdenkc6097192002-11-03 00:24:07 +00001162
1163- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001164 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001165 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001166 SOCs that have a DIU should define this macro to enable DIU
1167 support, and should also define these other macros:
1168
1169 CONFIG_SYS_DIU_ADDR
1170 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001171 CONFIG_CFB_CONSOLE
1172 CONFIG_VIDEO_SW_CURSOR
1173 CONFIG_VGA_AS_SINGLE_DEVICE
1174 CONFIG_VIDEO_LOGO
1175 CONFIG_VIDEO_BMP_LOGO
1176
Timur Tabi32f709e2011-04-11 14:18:22 -05001177 The DIU driver will look for the 'video-mode' environment
1178 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001179 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001180 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001181
wdenkc6097192002-11-03 00:24:07 +00001182- LCD Support: CONFIG_LCD
1183
1184 Define this to enable LCD support (for output to LCD
1185 display); also select one of the supported displays
1186 by defining one of these:
1187
Stelian Popf6f86652008-05-09 21:57:18 +02001188 CONFIG_ATMEL_LCD:
1189
1190 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1191
wdenkc0d54ae2003-11-25 16:55:19 +00001192 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001193
wdenkc0d54ae2003-11-25 16:55:19 +00001194 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001195
wdenkc0d54ae2003-11-25 16:55:19 +00001196 CONFIG_NEC_NL6448BC20
1197
1198 NEC NL6448BC20-08. 6.5", 640x480.
1199 Active, color, single scan.
1200
1201 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001202
wdenkc0d54ae2003-11-25 16:55:19 +00001203 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001204 Active, color, single scan.
1205
1206 CONFIG_SHARP_16x9
1207
1208 Sharp 320x240. Active, color, single scan.
1209 It isn't 16x9, and I am not sure what it is.
1210
1211 CONFIG_SHARP_LQ64D341
1212
1213 Sharp LQ64D341 display, 640x480.
1214 Active, color, single scan.
1215
1216 CONFIG_HLD1045
1217
1218 HLD1045 display, 640x480.
1219 Active, color, single scan.
1220
1221 CONFIG_OPTREX_BW
1222
1223 Optrex CBL50840-2 NF-FW 99 22 M5
1224 or
1225 Hitachi LMG6912RPFC-00T
1226 or
1227 Hitachi SP14Q002
1228
1229 320x240. Black & white.
1230
Simon Glass599a4df2012-10-17 13:24:54 +00001231 CONFIG_LCD_ALIGNMENT
1232
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001233 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001234 defined then the LCD will be aligned to this value instead.
1235 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1236 here, since it is cheaper to change data cache settings on
1237 a per-section basis.
1238
1239
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001240 CONFIG_LCD_ROTATION
1241
1242 Sometimes, for example if the display is mounted in portrait
1243 mode or even if it's mounted landscape but rotated by 180degree,
1244 we need to rotate our content of the display relative to the
1245 framebuffer, so that user can read the messages which are
1246 printed out.
1247 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1248 initialized with a given rotation from "vl_rot" out of
1249 "vidinfo_t" which is provided by the board specific code.
1250 The value for vl_rot is coded as following (matching to
1251 fbcon=rotate:<n> linux-kernel commandline):
1252 0 = no rotation respectively 0 degree
1253 1 = 90 degree rotation
1254 2 = 180 degree rotation
1255 3 = 270 degree rotation
1256
1257 If CONFIG_LCD_ROTATION is not defined, the console will be
1258 initialized with 0degree rotation.
1259
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001260 CONFIG_LCD_BMP_RLE8
1261
1262 Support drawing of RLE8-compressed bitmaps on the LCD.
1263
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001264 CONFIG_I2C_EDID
1265
1266 Enables an 'i2c edid' command which can read EDID
1267 information over I2C from an attached LCD display.
1268
wdenkeb20ad32003-09-05 23:19:14 +00001269- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001270
wdenk57b2d802003-06-27 21:31:46 +00001271 If this option is set, the environment is checked for
1272 a variable "splashimage". If found, the usual display
1273 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001274 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001275 specified in "splashimage" is loaded instead. The
1276 console is redirected to the "nulldev", too. This
1277 allows for a "silent" boot where a splash screen is
1278 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001279
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001280 CONFIG_SPLASHIMAGE_GUARD
1281
1282 If this option is set, then U-Boot will prevent the environment
1283 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001284 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001285 This option is useful for targets where, due to alignment
1286 restrictions, an improperly aligned BMP image will cause a data
1287 abort. If you think you will not have problems with unaligned
1288 accesses (for example because your toolchain prevents them)
1289 there is no need to set this option.
1290
Matthias Weisser53884182009-07-09 16:07:30 +02001291 CONFIG_SPLASH_SCREEN_ALIGN
1292
1293 If this option is set the splash image can be freely positioned
1294 on the screen. Environment variable "splashpos" specifies the
1295 position as "x,y". If a positive number is given it is used as
1296 number of pixel from left/top. If a negative number is given it
1297 is used as number of pixel from right/bottom. You can also
1298 specify 'm' for centering the image.
1299
1300 Example:
1301 setenv splashpos m,m
1302 => image at center of screen
1303
1304 setenv splashpos 30,20
1305 => image at x = 30 and y = 20
1306
1307 setenv splashpos -10,m
1308 => vertically centered image
1309 at x = dspWidth - bmpWidth - 9
1310
Stefan Roesed9d97742005-09-22 09:04:17 +02001311- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1312
1313 If this option is set, additionally to standard BMP
1314 images, gzipped BMP images can be displayed via the
1315 splashscreen support or the bmp command.
1316
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001317- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1318
1319 If this option is set, 8-bit RLE compressed BMP images
1320 can be displayed via the splashscreen support or the
1321 bmp command.
1322
wdenk0e2bd9c2004-06-06 21:51:03 +00001323- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001324 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1325
1326 The clock frequency of the MII bus
1327
wdenk0e2bd9c2004-06-06 21:51:03 +00001328 CONFIG_PHY_RESET_DELAY
1329
1330 Some PHY like Intel LXT971A need extra delay after
1331 reset before any MII register access is possible.
1332 For such PHY, set this option to the usec delay
1333 required. (minimum 300usec for LXT971A)
1334
1335 CONFIG_PHY_CMD_DELAY (ppc4xx)
1336
1337 Some PHY like Intel LXT971A need extra delay after
1338 command issued before MII status register can be read
1339
wdenkc6097192002-11-03 00:24:07 +00001340- IP address:
1341 CONFIG_IPADDR
1342
1343 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001344 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001345 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001346 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001347
1348- Server IP address:
1349 CONFIG_SERVERIP
1350
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001351 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001352 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001353 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001354
Robin Getz470a6d42009-07-21 12:15:28 -04001355 CONFIG_KEEP_SERVERADDR
1356
1357 Keeps the server's MAC address, in the env 'serveraddr'
1358 for passing to bootargs (like Linux's netconsole option)
1359
Wolfgang Denk26da2992011-10-26 10:21:22 +00001360- Gateway IP address:
1361 CONFIG_GATEWAYIP
1362
1363 Defines a default value for the IP address of the
1364 default router where packets to other networks are
1365 sent to.
1366 (Environment variable "gatewayip")
1367
1368- Subnet mask:
1369 CONFIG_NETMASK
1370
1371 Defines a default value for the subnet mask (or
1372 routing prefix) which is used to determine if an IP
1373 address belongs to the local subnet or needs to be
1374 forwarded through a router.
1375 (Environment variable "netmask")
1376
wdenkc6097192002-11-03 00:24:07 +00001377- BOOTP Recovery Mode:
1378 CONFIG_BOOTP_RANDOM_DELAY
1379
1380 If you have many targets in a network that try to
1381 boot using BOOTP, you may want to avoid that all
1382 systems send out BOOTP requests at precisely the same
1383 moment (which would happen for instance at recovery
1384 from a power failure, when all systems will try to
1385 boot, thus flooding the BOOTP server. Defining
1386 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1387 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001388 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001389
1390 1st BOOTP request: delay 0 ... 1 sec
1391 2nd BOOTP request: delay 0 ... 2 sec
1392 3rd BOOTP request: delay 0 ... 4 sec
1393 4th and following
1394 BOOTP requests: delay 0 ... 8 sec
1395
Thierry Reding8977cda2014-08-19 10:21:24 +02001396 CONFIG_BOOTP_ID_CACHE_SIZE
1397
1398 BOOTP packets are uniquely identified using a 32-bit ID. The
1399 server will copy the ID from client requests to responses and
1400 U-Boot will use this to determine if it is the destination of
1401 an incoming response. Some servers will check that addresses
1402 aren't in use before handing them out (usually using an ARP
1403 ping) and therefore take up to a few hundred milliseconds to
1404 respond. Network congestion may also influence the time it
1405 takes for a response to make it back to the client. If that
1406 time is too long, U-Boot will retransmit requests. In order
1407 to allow earlier responses to still be accepted after these
1408 retransmissions, U-Boot's BOOTP client keeps a small cache of
1409 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1410 cache. The default is to keep IDs for up to four outstanding
1411 requests. Increasing this will allow U-Boot to accept offers
1412 from a BOOTP client in networks with unusually high latency.
1413
stroesee0aadfb2003-08-28 14:17:32 +00001414- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001415 You can fine tune the DHCP functionality by defining
1416 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001417
Jon Loeliger5336a762007-07-09 22:08:34 -05001418 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001419 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001420 CONFIG_BOOTP_SEND_HOSTNAME
1421 CONFIG_BOOTP_NTPSERVER
1422 CONFIG_BOOTP_TIMEOFFSET
1423 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001424 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001425
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001426 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1427 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001428
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001429 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1430 after the configured retry count, the call will fail
1431 instead of starting over. This can be used to fail over
1432 to Link-local IP address configuration if the DHCP server
1433 is not available.
1434
stroesee0aadfb2003-08-28 14:17:32 +00001435 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1436 to do a dynamic update of a DNS server. To do this, they
1437 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001438 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001439 of the "hostname" environment variable is passed as
1440 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001441
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001442 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1443
1444 A 32bit value in microseconds for a delay between
1445 receiving a "DHCP Offer" and sending the "DHCP Request".
1446 This fixes a problem with certain DHCP servers that don't
1447 respond 100% of the time to a "DHCP request". E.g. On an
1448 AT91RM9200 processor running at 180MHz, this delay needed
1449 to be *at least* 15,000 usec before a Windows Server 2003
1450 DHCP server would reply 100% of the time. I recommend at
1451 least 50,000 usec to be safe. The alternative is to hope
1452 that one of the retries will be successful but note that
1453 the DHCP timeout and retry process takes a longer than
1454 this delay.
1455
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001456 - Link-local IP address negotiation:
1457 Negotiate with other link-local clients on the local network
1458 for an address that doesn't require explicit configuration.
1459 This is especially useful if a DHCP server cannot be guaranteed
1460 to exist in all environments that the device must operate.
1461
1462 See doc/README.link-local for more information.
1463
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301464 - MAC address from environment variables
1465
1466 FDT_SEQ_MACADDR_FROM_ENV
1467
1468 Fix-up device tree with MAC addresses fetched sequentially from
1469 environment variables. This config work on assumption that
1470 non-usable ethernet node of device-tree are either not present
1471 or their status has been marked as "disabled".
1472
wdenk145d2c12004-04-15 21:48:45 +00001473 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001474 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001475
1476 The device id used in CDP trigger frames.
1477
1478 CONFIG_CDP_DEVICE_ID_PREFIX
1479
1480 A two character string which is prefixed to the MAC address
1481 of the device.
1482
1483 CONFIG_CDP_PORT_ID
1484
1485 A printf format string which contains the ascii name of
1486 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001487 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001488
1489 CONFIG_CDP_CAPABILITIES
1490
1491 A 32bit integer which indicates the device capabilities;
1492 0x00000010 for a normal host which does not forwards.
1493
1494 CONFIG_CDP_VERSION
1495
1496 An ascii string containing the version of the software.
1497
1498 CONFIG_CDP_PLATFORM
1499
1500 An ascii string containing the name of the platform.
1501
1502 CONFIG_CDP_TRIGGER
1503
1504 A 32bit integer sent on the trigger.
1505
1506 CONFIG_CDP_POWER_CONSUMPTION
1507
1508 A 16bit integer containing the power consumption of the
1509 device in .1 of milliwatts.
1510
1511 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1512
1513 A byte containing the id of the VLAN.
1514
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001515- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001516
1517 Several configurations allow to display the current
1518 status using a LED. For instance, the LED will blink
1519 fast while running U-Boot code, stop blinking as
1520 soon as a reply to a BOOTP request was received, and
1521 start blinking slow once the Linux kernel is running
1522 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001523 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001524 feature in U-Boot.
1525
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001526 Additional options:
1527
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001528 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001529 The status LED can be connected to a GPIO pin.
1530 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001531 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001532 to include the gpio_led driver in the U-Boot binary.
1533
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001534 CONFIG_GPIO_LED_INVERTED_TABLE
1535 Some GPIO connected LEDs may have inverted polarity in which
1536 case the GPIO high value corresponds to LED off state and
1537 GPIO low value corresponds to LED on state.
1538 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1539 with a list of GPIO LEDs that have inverted polarity.
1540
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001541- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001542
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001543 This enable the NEW i2c subsystem, and will allow you to use
1544 i2c commands at the u-boot command line (as long as you set
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001545 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1546 for defining speed and slave address
1547 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1548 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1549 for defining speed and slave address
1550 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1551 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1552 for defining speed and slave address
1553 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1554 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1555 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001556
Heiko Schocherf2850742012-10-24 13:48:22 +02001557 - drivers/i2c/fsl_i2c.c:
1558 - activate i2c driver with CONFIG_SYS_I2C_FSL
1559 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1560 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1561 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1562 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001563 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001564 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1565 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1566 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1567 second bus.
1568
Simon Glass026fefb2012-10-30 07:28:53 +00001569 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001570 - activate this driver with CONFIG_SYS_I2C_TEGRA
1571 - This driver adds 4 i2c buses with a fix speed from
1572 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001573
Dirk Eibach42b204f2013-04-25 02:40:01 +00001574 - drivers/i2c/ppc4xx_i2c.c
1575 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1576 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1577 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1578
trema49f40a2013-09-21 18:13:35 +02001579 - drivers/i2c/i2c_mxc.c
1580 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001581 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1582 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1583 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1584 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001585 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1586 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1587 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1588 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1589 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1590 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001591 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1592 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001593 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001594 for speed, and 0 for slave.
1595
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001596 - drivers/i2c/rcar_i2c.c:
1597 - activate this driver with CONFIG_SYS_I2C_RCAR
1598 - This driver adds 4 i2c buses
1599
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001600 - drivers/i2c/sh_i2c.c:
1601 - activate this driver with CONFIG_SYS_I2C_SH
1602 - This driver adds from 2 to 5 i2c buses
1603
1604 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1605 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1606 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1607 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1608 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1609 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1610 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1611 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1612 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1613 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001614 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001615
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001616 - drivers/i2c/omap24xx_i2c.c
1617 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1618 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1619 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1620 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1621 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1622 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1623 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1624 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1625 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1626 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1627 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1628
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301629 - drivers/i2c/s3c24x0_i2c.c:
1630 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1631 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1632 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1633 with a fix speed from 100000 and the slave addr 0!
1634
Dirk Eibachb9577432014-07-03 09:28:18 +02001635 - drivers/i2c/ihs_i2c.c
1636 - activate this driver with CONFIG_SYS_I2C_IHS
1637 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1638 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1639 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1640 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1641 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1642 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1643 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1644 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1645 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1646 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1647 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1648 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001649 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1650 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1651 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1652 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1653 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1654 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1655 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1656 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1657 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001658
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001659 additional defines:
1660
1661 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001662 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001663
1664 CONFIG_SYS_I2C_DIRECT_BUS
1665 define this, if you don't use i2c muxes on your hardware.
1666 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1667 omit this define.
1668
1669 CONFIG_SYS_I2C_MAX_HOPS
1670 define how many muxes are maximal consecutively connected
1671 on one i2c bus. If you not use i2c muxes, omit this
1672 define.
1673
1674 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001675 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001676 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1677 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1678 CONFIG_SYS_NUM_I2C_BUSES = 9:
1679
1680 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1681 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1682 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1683 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1684 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1685 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1686 {1, {I2C_NULL_HOP}}, \
1687 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1688 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1689 }
1690
1691 which defines
1692 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001693 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1694 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1695 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1696 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1697 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001698 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001699 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1700 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001701
1702 If you do not have i2c muxes on your board, omit this define.
1703
Simon Glass3efce392017-05-12 21:10:00 -06001704- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001705 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001706 then the following macros need to be defined (examples are
1707 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001708
1709 I2C_INIT
1710
wdenkb9bbd242003-06-30 16:24:52 +00001711 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001712 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001713
wdenk544e9732004-02-06 23:19:44 +00001714 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001715
wdenkc6097192002-11-03 00:24:07 +00001716 I2C_ACTIVE
1717
1718 The code necessary to make the I2C data line active
1719 (driven). If the data line is open collector, this
1720 define can be null.
1721
wdenkb9bbd242003-06-30 16:24:52 +00001722 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1723
wdenkc6097192002-11-03 00:24:07 +00001724 I2C_TRISTATE
1725
1726 The code necessary to make the I2C data line tri-stated
1727 (inactive). If the data line is open collector, this
1728 define can be null.
1729
wdenkb9bbd242003-06-30 16:24:52 +00001730 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1731
wdenkc6097192002-11-03 00:24:07 +00001732 I2C_READ
1733
York Sun4a598092013-04-01 11:29:11 -07001734 Code that returns true if the I2C data line is high,
1735 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001736
wdenkb9bbd242003-06-30 16:24:52 +00001737 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1738
wdenkc6097192002-11-03 00:24:07 +00001739 I2C_SDA(bit)
1740
York Sun4a598092013-04-01 11:29:11 -07001741 If <bit> is true, sets the I2C data line high. If it
1742 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001743
wdenkb9bbd242003-06-30 16:24:52 +00001744 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001745 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001746 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001747
wdenkc6097192002-11-03 00:24:07 +00001748 I2C_SCL(bit)
1749
York Sun4a598092013-04-01 11:29:11 -07001750 If <bit> is true, sets the I2C clock line high. If it
1751 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001752
wdenkb9bbd242003-06-30 16:24:52 +00001753 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001754 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001755 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001756
wdenkc6097192002-11-03 00:24:07 +00001757 I2C_DELAY
1758
1759 This delay is invoked four times per clock cycle so this
1760 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001761 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001762 like:
1763
wdenkb9bbd242003-06-30 16:24:52 +00001764 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001765
Mike Frysingeree12d542010-07-21 13:38:02 -04001766 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1767
1768 If your arch supports the generic GPIO framework (asm/gpio.h),
1769 then you may alternatively define the two GPIOs that are to be
1770 used as SCL / SDA. Any of the previous I2C_xxx macros will
1771 have GPIO-based defaults assigned to them as appropriate.
1772
1773 You should define these to the GPIO value as given directly to
1774 the generic GPIO functions.
1775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001776 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001777
wdenk57b2d802003-06-27 21:31:46 +00001778 When a board is reset during an i2c bus transfer
1779 chips might think that the current transfer is still
1780 in progress. On some boards it is possible to access
1781 the i2c SCLK line directly, either by using the
1782 processor pin as a GPIO or by having a second pin
1783 connected to the bus. If this option is defined a
1784 custom i2c_init_board() routine in boards/xxx/board.c
1785 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001786
Ben Warren45657152006-09-07 16:50:54 -04001787 CONFIG_I2C_MULTI_BUS
1788
1789 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001790 must have a controller. At any point in time, only one bus is
1791 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001792 Note that bus numbering is zero-based.
1793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001794 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001795
1796 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001797 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001798 is set, specify a list of bus-device pairs. Otherwise, specify
1799 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001800
1801 e.g.
1802 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001803 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001804
1805 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1806
Wolfgang Denk092ae952011-10-26 10:21:21 +00001807 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001808 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001809
1810 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1811
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001812 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001813
1814 If defined, then this indicates the I2C bus number for DDR SPD.
1815 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001817 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001818
1819 If defined, then this indicates the I2C bus number for the RTC.
1820 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1821
Andrew Dyer58c41f92008-12-29 17:36:01 -06001822 CONFIG_SOFT_I2C_READ_REPEATED_START
1823
1824 defining this will force the i2c_read() function in
1825 the soft_i2c driver to perform an I2C repeated start
1826 between writing the address pointer and reading the
1827 data. If this define is omitted the default behaviour
1828 of doing a stop-start sequence will be used. Most I2C
1829 devices can use either method, but some require one or
1830 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001831
wdenkc6097192002-11-03 00:24:07 +00001832- SPI Support: CONFIG_SPI
1833
1834 Enables SPI driver (so far only tested with
1835 SPI EEPROM, also an instance works with Crystal A/D and
1836 D/As on the SACSng board)
1837
wdenkc6097192002-11-03 00:24:07 +00001838 CONFIG_SOFT_SPI
1839
wdenk4a5c8a72003-03-06 00:02:04 +00001840 Enables a software (bit-bang) SPI driver rather than
1841 using hardware support. This is a general purpose
1842 driver that only requires three general I/O port pins
1843 (two outputs, one input) to function. If this is
1844 defined, the board configuration must define several
1845 SPI configuration items (port pins to use, etc). For
1846 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001847
Heiko Schocherb77c8882014-07-14 10:22:11 +02001848 CONFIG_SYS_SPI_MXC_WAIT
1849 Timeout for waiting until spi transfer completed.
1850 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1851
Matthias Fuchsa4400872007-12-27 17:12:34 +01001852- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001853
Matthias Fuchsa4400872007-12-27 17:12:34 +01001854 Enables FPGA subsystem.
1855
1856 CONFIG_FPGA_<vendor>
1857
1858 Enables support for specific chip vendors.
1859 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001860
Matthias Fuchsa4400872007-12-27 17:12:34 +01001861 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001862
Matthias Fuchsa4400872007-12-27 17:12:34 +01001863 Enables support for FPGA family.
1864 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1865
1866 CONFIG_FPGA_COUNT
1867
1868 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001870 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001871
wdenk57b2d802003-06-27 21:31:46 +00001872 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001874 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001875
wdenk4a5c8a72003-03-06 00:02:04 +00001876 Enable checks on FPGA configuration interface busy
1877 status by the configuration function. This option
1878 will require a board or device specific function to
1879 be written.
wdenkc6097192002-11-03 00:24:07 +00001880
1881 CONFIG_FPGA_DELAY
1882
1883 If defined, a function that provides delays in the FPGA
1884 configuration driver.
1885
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001886 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001887 Allow Control-C to interrupt FPGA configuration
1888
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001889 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001890
wdenk4a5c8a72003-03-06 00:02:04 +00001891 Check for configuration errors during FPGA bitfile
1892 loading. For example, abort during Virtex II
1893 configuration if the INIT_B line goes low (which
1894 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001896 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001897
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001898 Maximum time to wait for the INIT_B line to de-assert
1899 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001900 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001901 ms.
wdenkc6097192002-11-03 00:24:07 +00001902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001903 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001904
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001905 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001906 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001908 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001909
wdenk4a5c8a72003-03-06 00:02:04 +00001910 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001911 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001912
1913- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02001914
wdenkc6097192002-11-03 00:24:07 +00001915 CONFIG_IDENT_STRING
1916
wdenk4a5c8a72003-03-06 00:02:04 +00001917 If defined, this string will be added to the U-Boot
1918 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001919
1920- Vendor Parameter Protection:
1921
wdenk4a5c8a72003-03-06 00:02:04 +00001922 U-Boot considers the values of the environment
1923 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001924 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001925 are set once by the board vendor / manufacturer, and
1926 protects these variables from casual modification by
1927 the user. Once set, these variables are read-only,
1928 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001929 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001930
1931 If CONFIG_ENV_OVERWRITE is #defined in your config
1932 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001933 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001934 these parameters.
1935
Joe Hershberger76f353e2015-05-04 14:55:14 -05001936 Alternatively, if you define _both_ an ethaddr in the
1937 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001938 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001939 which can be changed exactly ONCE by the user. [The
1940 serial# is unaffected by this, i. e. it remains
1941 read-only.]
1942
Joe Hershberger71497d02012-12-11 22:16:31 -06001943 The same can be accomplished in a more flexible way
1944 for any variable by configuring the type of access
1945 to allow for those variables in the ".flags" variable
1946 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1947
wdenkc6097192002-11-03 00:24:07 +00001948- Protected RAM:
1949 CONFIG_PRAM
1950
1951 Define this variable to enable the reservation of
1952 "protected RAM", i. e. RAM which is not overwritten
1953 by U-Boot. Define CONFIG_PRAM to hold the number of
1954 kB you want to reserve for pRAM. You can overwrite
1955 this default value by defining an environment
1956 variable "pram" to the number of kB you want to
1957 reserve. Note that the board info structure will
1958 still show the full amount of RAM. If pRAM is
1959 reserved, a new environment variable "mem" will
1960 automatically be defined to hold the amount of
1961 remaining RAM in a form that can be passed as boot
1962 argument to Linux, for instance like that:
1963
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001964 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001965 saveenv
1966
1967 This way you can tell Linux not to use this memory,
1968 either, which results in a memory region that will
1969 not be affected by reboots.
1970
1971 *WARNING* If your board configuration uses automatic
1972 detection of the RAM size, you must make sure that
1973 this memory test is non-destructive. So far, the
1974 following board configurations are known to be
1975 "pRAM-clean":
1976
Heiko Schocher65d94db2017-06-07 17:33:09 +02001977 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00001978 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02001979 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001980
Gabe Blacka2f3a932012-12-02 04:55:18 +00001981- Access to physical memory region (> 4GB)
1982 Some basic support is provided for operations on memory not
1983 normally accessible to U-Boot - e.g. some architectures
1984 support access to more than 4GB of memory on 32-bit
1985 machines using physical address extension or similar.
1986 Define CONFIG_PHYSMEM to access this basic support, which
1987 currently only supports clearing the memory.
1988
wdenkc6097192002-11-03 00:24:07 +00001989- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001990 CONFIG_NET_RETRY_COUNT
1991
wdenk4a5c8a72003-03-06 00:02:04 +00001992 This variable defines the number of retries for
1993 network operations like ARP, RARP, TFTP, or BOOTP
1994 before giving up the operation. If not defined, a
1995 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001996
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001997 CONFIG_ARP_TIMEOUT
1998
1999 Timeout waiting for an ARP reply in milliseconds.
2000
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002001 CONFIG_NFS_TIMEOUT
2002
2003 Timeout in milliseconds used in NFS protocol.
2004 If you encounter "ERROR: Cannot umount" in nfs command,
2005 try longer timeout such as
2006 #define CONFIG_NFS_TIMEOUT 10000UL
2007
wdenkc6097192002-11-03 00:24:07 +00002008- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002009 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002010
2011 This defines the secondary prompt string, which is
2012 printed when the command interpreter needs more input
2013 to complete a command. Usually "> ".
2014
2015 Note:
2016
wdenk57b2d802003-06-27 21:31:46 +00002017 In the current implementation, the local variables
2018 space and global environment variables space are
2019 separated. Local variables are those you define by
2020 simply typing `name=value'. To access a local
2021 variable later on, you have write `$name' or
2022 `${name}'; to execute the contents of a variable
2023 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002024
wdenk4a5c8a72003-03-06 00:02:04 +00002025 Global environment variables are those you use
2026 setenv/printenv to work with. To run a command stored
2027 in such a variable, you need to use the run command,
2028 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002029
2030 To store commands and special characters in a
2031 variable, please use double quotation marks
2032 surrounding the whole text of the variable, instead
2033 of the backslashes before semicolons and special
2034 symbols.
2035
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002036- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01002037 CONFIG_CMDLINE_PS_SUPPORT
2038
2039 Enable support for changing the command prompt string
2040 at run-time. Only static string is supported so far.
2041 The string is obtained from environment variables PS1
2042 and PS2.
2043
wdenkc0aa5c52003-12-06 19:49:23 +00002044- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002045 CONFIG_EXTRA_ENV_SETTINGS
2046
wdenk4a5c8a72003-03-06 00:02:04 +00002047 Define this to contain any number of null terminated
2048 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002049 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002050
wdenk4a5c8a72003-03-06 00:02:04 +00002051 For example, place something like this in your
2052 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002053
2054 #define CONFIG_EXTRA_ENV_SETTINGS \
2055 "myvar1=value1\0" \
2056 "myvar2=value2\0"
2057
wdenk4a5c8a72003-03-06 00:02:04 +00002058 Warning: This method is based on knowledge about the
2059 internal format how the environment is stored by the
2060 U-Boot code. This is NOT an official, exported
2061 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002062 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002063 You better know what you are doing here.
2064
wdenk4a5c8a72003-03-06 00:02:04 +00002065 Note: overly (ab)use of the default environment is
2066 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002067 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002068 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002069
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002070 CONFIG_DELAY_ENVIRONMENT
2071
2072 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002073 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002074 that so that the environment is not available until
2075 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2076 this is instead controlled by the value of
2077 /config/load-environment.
2078
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002079- TFTP Fixed UDP Port:
2080 CONFIG_TFTP_PORT
2081
Wolfgang Denk227b5192005-09-24 23:25:46 +02002082 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002083 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002084 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002085 number generator is used.
2086
Wolfgang Denk227b5192005-09-24 23:25:46 +02002087 Also, the environment variable tftpdstp is used to supply
2088 the TFTP UDP destination port value. If tftpdstp isn't
2089 defined, the normal port 69 is used.
2090
2091 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002092 blindly start the TFTP transfer using the pre-configured
2093 target IP address and UDP port. This has the effect of
2094 "punching through" the (Windows XP) firewall, allowing
2095 the remainder of the TFTP transfer to proceed normally.
2096 A better solution is to properly configure the firewall,
2097 but sometimes that is not allowed.
2098
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002099 CONFIG_STANDALONE_LOAD_ADDR
2100
Wolfgang Denk23f78482011-10-09 21:06:34 +02002101 This option defines a board specific value for the
2102 address where standalone program gets loaded, thus
2103 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002104 settings.
2105
2106- Frame Buffer Address:
2107 CONFIG_FB_ADDR
2108
2109 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002110 address for frame buffer. This is typically the case
2111 when using a graphics controller has separate video
2112 memory. U-Boot will then place the frame buffer at
2113 the given address instead of dynamically reserving it
2114 in system RAM by calling lcd_setmem(), which grabs
2115 the memory for the frame buffer depending on the
2116 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002117
2118 Please see board_init_f function.
2119
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002120- Automatic software updates via TFTP server
2121 CONFIG_UPDATE_TFTP
2122 CONFIG_UPDATE_TFTP_CNT_MAX
2123 CONFIG_UPDATE_TFTP_MSEC_MAX
2124
2125 These options enable and control the auto-update feature;
2126 for a more detailed description refer to doc/README.update.
2127
2128- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02002129 CONFIG_MTD_UBI_WL_THRESHOLD
2130 This parameter defines the maximum difference between the highest
2131 erase counter value and the lowest erase counter value of eraseblocks
2132 of UBI devices. When this threshold is exceeded, UBI starts performing
2133 wear leveling by means of moving data from eraseblock with low erase
2134 counter to eraseblocks with high erase counter.
2135
2136 The default value should be OK for SLC NAND flashes, NOR flashes and
2137 other flashes which have eraseblock life-cycle 100000 or more.
2138 However, in case of MLC NAND flashes which typically have eraseblock
2139 life-cycle less than 10000, the threshold should be lessened (e.g.,
2140 to 128 or 256, although it does not have to be power of 2).
2141
2142 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002143
Heiko Schocherf5895d12014-06-24 10:10:04 +02002144 CONFIG_MTD_UBI_BEB_LIMIT
2145 This option specifies the maximum bad physical eraseblocks UBI
2146 expects on the MTD device (per 1024 eraseblocks). If the
2147 underlying flash does not admit of bad eraseblocks (e.g. NOR
2148 flash), this value is ignored.
2149
2150 NAND datasheets often specify the minimum and maximum NVM
2151 (Number of Valid Blocks) for the flashes' endurance lifetime.
2152 The maximum expected bad eraseblocks per 1024 eraseblocks
2153 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2154 which gives 20 for most NANDs (MaxNVB is basically the total
2155 count of eraseblocks on the chip).
2156
2157 To put it differently, if this value is 20, UBI will try to
2158 reserve about 1.9% of physical eraseblocks for bad blocks
2159 handling. And that will be 1.9% of eraseblocks on the entire
2160 NAND chip, not just the MTD partition UBI attaches. This means
2161 that if you have, say, a NAND flash chip admits maximum 40 bad
2162 eraseblocks, and it is split on two MTD partitions of the same
2163 size, UBI will reserve 40 eraseblocks when attaching a
2164 partition.
2165
2166 default: 20
2167
2168 CONFIG_MTD_UBI_FASTMAP
2169 Fastmap is a mechanism which allows attaching an UBI device
2170 in nearly constant time. Instead of scanning the whole MTD device it
2171 only has to locate a checkpoint (called fastmap) on the device.
2172 The on-flash fastmap contains all information needed to attach
2173 the device. Using fastmap makes only sense on large devices where
2174 attaching by scanning takes long. UBI will not automatically install
2175 a fastmap on old images, but you can set the UBI parameter
2176 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2177 that fastmap-enabled images are still usable with UBI implementations
2178 without fastmap support. On typical flash devices the whole fastmap
2179 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2180
2181 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2182 Set this parameter to enable fastmap automatically on images
2183 without a fastmap.
2184 default: 0
2185
Heiko Schocher94b66de2015-10-22 06:19:21 +02002186 CONFIG_MTD_UBI_FM_DEBUG
2187 Enable UBI fastmap debug
2188 default: 0
2189
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002190- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002191 CONFIG_SPL
2192 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002193
Tom Rini36853852012-02-14 07:29:40 +00002194 CONFIG_SPL_LDSCRIPT
2195 LDSCRIPT for linking the SPL binary.
2196
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002197 CONFIG_SPL_MAX_FOOTPRINT
2198 Maximum size in memory allocated to the SPL, BSS included.
2199 When defined, the linker checks that the actual memory
2200 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002201 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002202 must not be both defined at the same time.
2203
Tom Rini36853852012-02-14 07:29:40 +00002204 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002205 Maximum size of the SPL image (text, data, rodata, and
2206 linker lists sections), BSS excluded.
2207 When defined, the linker checks that the actual size does
2208 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002209
Scott Woodc4f0d002012-09-20 19:05:12 -05002210 CONFIG_SPL_RELOC_TEXT_BASE
2211 Address to relocate to. If unspecified, this is equal to
2212 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2213
Tom Rini36853852012-02-14 07:29:40 +00002214 CONFIG_SPL_BSS_START_ADDR
2215 Link address for the BSS within the SPL binary.
2216
2217 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002218 Maximum size in memory allocated to the SPL BSS.
2219 When defined, the linker checks that the actual memory used
2220 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002221 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002222 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002223
2224 CONFIG_SPL_STACK
2225 Adress of the start of the stack SPL will use
2226
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002227 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2228 When defined, SPL will panic() if the image it has
2229 loaded does not have a signature.
2230 Defining this is useful when code which loads images
2231 in SPL cannot guarantee that absolutely all read errors
2232 will be caught.
2233 An example is the LPC32XX MLC NAND driver, which will
2234 consider that a completely unreadable NAND block is bad,
2235 and thus should be skipped silently.
2236
Scott Woodc4f0d002012-09-20 19:05:12 -05002237 CONFIG_SPL_RELOC_STACK
2238 Adress of the start of the stack SPL will use after
2239 relocation. If unspecified, this is equal to
2240 CONFIG_SPL_STACK.
2241
Tom Rini36853852012-02-14 07:29:40 +00002242 CONFIG_SYS_SPL_MALLOC_START
2243 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002244 When this option is set the full malloc is used in SPL and
2245 it is set up by spl_init() and before that, the simple malloc()
2246 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002247
2248 CONFIG_SYS_SPL_MALLOC_SIZE
2249 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002250
Tom Rinic2b76002014-03-28 12:03:39 -04002251 CONFIG_SPL_OS_BOOT
2252 Enable booting directly to an OS from SPL.
2253 See also: doc/README.falcon
2254
Tom Rinife3b0c72012-08-13 11:37:56 -07002255 CONFIG_SPL_DISPLAY_PRINT
2256 For ARM, enable an optional function to print more information
2257 about the running system.
2258
Scott Wood7c810902012-09-20 16:35:21 -05002259 CONFIG_SPL_INIT_MINIMAL
2260 Arch init code should be built for a very small image
2261
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002262 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2263 Partition on the MMC to load U-Boot from when the MMC is being
2264 used in raw mode
2265
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002266 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2267 Sector to load kernel uImage from when MMC is being
2268 used in raw mode (for Falcon mode)
2269
2270 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2271 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2272 Sector and number of sectors to load kernel argument
2273 parameters from when MMC is being used in raw mode
2274 (for falcon mode)
2275
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002276 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2277 Partition on the MMC to load U-Boot from when the MMC is being
2278 used in fs mode
2279
Guillaume GARDET5065b712014-10-15 17:53:13 +02002280 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2281 Filename to read to load U-Boot when reading from filesystem
2282
2283 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002284 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002285 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002286
Guillaume GARDET5065b712014-10-15 17:53:13 +02002287 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002288 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002289 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002290
Scott Wood2b36fbb2012-12-06 13:33:17 +00002291 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2292 Set this for NAND SPL on PPC mpc83xx targets, so that
2293 start.S waits for the rest of the SPL to load before
2294 continuing (the hardware starts execution after just
2295 loading the first page rather than the full 4K).
2296
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302297 CONFIG_SPL_SKIP_RELOCATE
2298 Avoid SPL relocation
2299
Scott Woodc352a0c2012-09-20 19:09:07 -05002300 CONFIG_SPL_NAND_BASE
2301 Include nand_base.c in the SPL. Requires
2302 CONFIG_SPL_NAND_DRIVERS.
2303
2304 CONFIG_SPL_NAND_DRIVERS
2305 SPL uses normal NAND drivers, not minimal drivers.
2306
Jörg Krause6f8190f2018-01-14 19:26:38 +01002307 CONFIG_SPL_NAND_IDENT
2308 SPL uses the chip ID list to identify the NAND flash.
2309 Requires CONFIG_SPL_NAND_BASE.
2310
Scott Woodc352a0c2012-09-20 19:09:07 -05002311 CONFIG_SPL_NAND_ECC
2312 Include standard software ECC in the SPL
2313
Tom Rini36853852012-02-14 07:29:40 +00002314 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002315 Support for NAND boot using simple NAND drivers that
2316 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002317
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002318 CONFIG_SPL_UBI
2319 Support for a lightweight UBI (fastmap) scanner and
2320 loader
2321
Heiko Schochercf000272014-10-31 08:31:00 +01002322 CONFIG_SPL_NAND_RAW_ONLY
2323 Support to boot only raw u-boot.bin images. Use this only
2324 if you need to save space.
2325
Ying Zhangdfb2b152013-08-16 15:16:12 +08002326 CONFIG_SPL_COMMON_INIT_DDR
2327 Set for common ddr init with serial presence detect in
2328 SPL binary.
2329
Tom Rini36853852012-02-14 07:29:40 +00002330 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2331 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2332 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2333 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2334 CONFIG_SYS_NAND_ECCBYTES
2335 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002336 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002337
2338 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002339 Location in NAND to read U-Boot from
2340
2341 CONFIG_SYS_NAND_U_BOOT_DST
2342 Location in memory to load U-Boot to
2343
2344 CONFIG_SYS_NAND_U_BOOT_SIZE
2345 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002346
2347 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002348 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002349
2350 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2351 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002352 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002353
Pavel Machekde997252012-08-30 22:42:11 +02002354 CONFIG_SPL_RAM_DEVICE
2355 Support for running image already present in ram, in SPL binary
2356
Scott Woodeb7bd972012-12-06 13:33:16 +00002357 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002358 Image offset to which the SPL should be padded before appending
2359 the SPL payload. By default, this is defined as
2360 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2361 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2362 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002363
Scott Woodf147eb72012-09-21 16:27:32 -05002364 CONFIG_SPL_TARGET
2365 Final target image containing SPL and payload. Some SPLs
2366 use an arch-specific makefile fragment instead, for
2367 example if more than one image needs to be produced.
2368
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002369 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002370 Printing information about a FIT image adds quite a bit of
2371 code to SPL. So this is normally disabled in SPL. Use this
2372 option to re-enable it. This will affect the output of the
2373 bootm command when booting a FIT image.
2374
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002375- TPL framework
2376 CONFIG_TPL
2377 Enable building of TPL globally.
2378
2379 CONFIG_TPL_PAD_TO
2380 Image offset to which the TPL should be padded before appending
2381 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002382 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2383 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2384 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002385
wdenkc0aa5c52003-12-06 19:49:23 +00002386- Interrupt support (PPC):
2387
wdenk1ebf41e2004-01-02 14:00:00 +00002388 There are common interrupt_init() and timer_interrupt()
2389 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002390 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002391 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002392 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002393 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002394 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002395 specific handling. If board has watchdog / status_led
2396 / other_activity_monitor it works automatically from
2397 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002398
wdenkc6097192002-11-03 00:24:07 +00002399
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002400Board initialization settings:
2401------------------------------
2402
2403During Initialization u-boot calls a number of board specific functions
2404to allow the preparation of board specific prerequisites, e.g. pin setup
2405before drivers are initialized. To enable these callbacks the
2406following configuration macros have to be defined. Currently this is
2407architecture specific, so please check arch/your_architecture/lib/board.c
2408typically in board_init_f() and board_init_r().
2409
2410- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2411- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2412- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2413- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002414
wdenkc6097192002-11-03 00:24:07 +00002415Configuration Settings:
2416-----------------------
2417
Simon Glass8927bf22019-12-28 10:45:10 -07002418- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08002419 Optionally it can be defined to support 64-bit memory commands.
2420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002421- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002422 undefine this when you're short of memory.
2423
Peter Tyserdfb72b82009-01-27 18:03:12 -06002424- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2425 width of the commands listed in the 'help' command output.
2426
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002427- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002428 prompt for user input.
2429
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002430- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002431
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002432- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002434- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002436- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002437 the application (usually a Linux kernel) when it is
2438 booted
2439
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002440- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002441 List of legal baudrate settings for this board.
2442
York Sun5d286cd2015-12-04 11:57:07 -08002443- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002444 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002445 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2446 is substracted from total RAM and won't be reported to OS.
2447 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002448 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002449 the RAM base is not zero, or RAM is divided into banks,
2450 this variable needs to be recalcuated to get the address.
2451
York Sun50739372015-12-07 11:05:29 -08002452- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002453 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002454 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002455 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002456 fixing up gd->ram_size the Linux kernel should gets passed
2457 the now "corrected" memory size and won't touch it either.
2458 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002459 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002460 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002461 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002462
2463 This option can be used as a workaround for the 440EPx/GRx
2464 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2465 be touched.
2466
2467 WARNING: Please make sure that this value is a multiple of
2468 the Linux page size (normally 4k). If this is not the case,
2469 then the end address of the Linux memory will be located at a
2470 non page size aligned address and this could cause major
2471 problems.
2472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002473- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002474 Enable temporary baudrate change while serial download
2475
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002476- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002477 Physical start address of SDRAM. _Must_ be 0 here.
2478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002479- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002480 Physical start address of Flash memory.
2481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002482- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002483 Physical start address of boot monitor code (set by
2484 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002485 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002486 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002487
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002488- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002489 Size of memory reserved for monitor code, used to
2490 determine _at_compile_time_ (!) if the environment is
2491 embedded within the U-Boot image, or in a separate
2492 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002495 Size of DRAM reserved for malloc() use.
2496
Simon Glass863e4042014-07-10 22:23:28 -06002497- CONFIG_SYS_MALLOC_F_LEN
2498 Size of the malloc() pool for use before relocation. If
2499 this is defined, then a very simple malloc() implementation
2500 will become available before relocation. The address is just
2501 below the global data, and the stack is moved down to make
2502 space.
2503
2504 This feature allocates regions with increasing addresses
2505 within the region. calloc() is supported, but realloc()
2506 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002507 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002508 U-Boot relocates itself.
2509
Simon Glass9fa901b2014-11-10 17:16:54 -07002510- CONFIG_SYS_MALLOC_SIMPLE
2511 Provides a simple and small malloc() and calloc() for those
2512 boards which do not use the full malloc in SPL (which is
2513 enabled with CONFIG_SYS_SPL_MALLOC_START).
2514
Thierry Redingc97d9742014-12-09 22:25:22 -07002515- CONFIG_SYS_NONCACHED_MEMORY:
2516 Size of non-cached memory area. This area of memory will be
2517 typically located right below the malloc() area and mapped
2518 uncached in the MMU. This is useful for drivers that would
2519 otherwise require a lot of explicit cache maintenance. For
2520 some drivers it's also impossible to properly maintain the
2521 cache. For example if the regions that need to be flushed
2522 are not a multiple of the cache-line size, *and* padding
2523 cannot be allocated between the regions to align them (i.e.
2524 if the HW requires a contiguous array of regions, and the
2525 size of each region is not cache-aligned), then a flush of
2526 one region may result in overwriting data that hardware has
2527 written to another region in the same cache-line. This can
2528 happen for example in network drivers where descriptors for
2529 buffers are typically smaller than the CPU cache-line (e.g.
2530 16 bytes vs. 32 or 64 bytes).
2531
2532 Non-cached memory is only supported on 32-bit ARM at present.
2533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002534- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002535 Normally compressed uImages are limited to an
2536 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002537 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002538 to adjust this setting to your needs.
2539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002540- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002541 Maximum size of memory mapped by the startup code of
2542 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002543 the Linux kernel (bd_info, boot arguments, FDT blob if
2544 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002545 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002546 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002547 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002548 variable "bootm_mapsize" will override the value of
2549 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2550 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002551
John Rigbyeea8e692010-10-13 13:57:35 -06002552- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2553 Enable initrd_high functionality. If defined then the
2554 initrd_high feature is enabled and the bootm ramdisk subcommand
2555 is enabled.
2556
2557- CONFIG_SYS_BOOT_GET_CMDLINE:
2558 Enables allocating and saving kernel cmdline in space between
2559 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2560
2561- CONFIG_SYS_BOOT_GET_KBD:
2562 Enables allocating and saving a kernel copy of the bd_info in
2563 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002565- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002566 Max number of Flash memory banks
2567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002568- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002569 Max number of sectors on a Flash chip
2570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002571- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002572 Timeout for Flash erase operations (in ms)
2573
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002574- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002575 Timeout for Flash write operations (in ms)
2576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002578 Timeout for Flash set sector lock bit operation (in ms)
2579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002580- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002581 Timeout for Flash clear lock bits operation (in ms)
2582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002583- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002584 If defined, hardware flash sectors protection is used
2585 instead of U-Boot software protection.
2586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002587- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002588
2589 Enable TFTP transfers directly to flash memory;
2590 without this option such a download has to be
2591 performed in two steps: (1) download to RAM, and (2)
2592 copy from RAM to flash.
2593
2594 The two-step approach is usually more reliable, since
2595 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002596 the flash, but in some situations (when system RAM is
2597 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002598 downloaded image) this option may be very useful.
2599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002600- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002601 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002602 common flash structure for storing flash geometry.
2603
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002604- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002605 This option also enables the building of the cfi_flash driver
2606 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002607
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002608- CONFIG_FLASH_CFI_MTD
2609 This option enables the building of the cfi_mtd driver
2610 in the drivers directory. The driver exports CFI flash
2611 to the MTD layer.
2612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002613- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002614 Use buffered writes to flash.
2615
2616- CONFIG_FLASH_SPANSION_S29WS_N
2617 s29ws-n MirrorBit flash has non-standard addresses for buffered
2618 write commands.
2619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002620- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002621 If this option is defined, the common CFI flash doesn't
2622 print it's warning upon not recognized FLASH banks. This
2623 is useful, if some of the configured banks are only
2624 optionally available.
2625
Jerry Van Barenaae73572008-03-08 13:48:01 -05002626- CONFIG_FLASH_SHOW_PROGRESS
2627 If defined (must be an integer), print out countdown
2628 digits and dots. Recommended value: 45 (9..1) for 80
2629 column displays, 15 (3..1) for 40 column displays.
2630
Stefan Roesed20cba52013-04-04 15:53:14 +02002631- CONFIG_FLASH_VERIFY
2632 If defined, the content of the flash (destination) is compared
2633 against the source after the write operation. An error message
2634 will be printed when the contents are not identical.
2635 Please note that this option is useless in nearly all cases,
2636 since such flash programming errors usually are detected earlier
2637 while unprotecting/erasing/programming. Please only enable
2638 this option if you really know what you are doing.
2639
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002640- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002641 Defines the number of Ethernet receive buffers. On some
2642 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002643 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2644 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002645 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002646 Defaults to 4 if not defined.
2647
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002648- CONFIG_ENV_MAX_ENTRIES
2649
Wolfgang Denk1136f692010-10-27 22:48:30 +02002650 Maximum number of entries in the hash table that is used
2651 internally to store the environment settings. The default
2652 setting is supposed to be generous and should work in most
2653 cases. This setting can be used to tune behaviour; see
2654 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002655
Joe Hershberger71497d02012-12-11 22:16:31 -06002656- CONFIG_ENV_FLAGS_LIST_DEFAULT
2657- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002658 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002659 calling env set. Variables can be restricted to only decimal,
2660 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2661 the variables can also be restricted to IP address or MAC address.
2662
2663 The format of the list is:
2664 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002665 access_attribute = [a|r|o|c]
2666 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002667 entry = variable_name[:attributes]
2668 list = entry[,list]
2669
2670 The type attributes are:
2671 s - String (default)
2672 d - Decimal
2673 x - Hexadecimal
2674 b - Boolean ([1yYtT|0nNfF])
2675 i - IP address
2676 m - MAC address
2677
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002678 The access attributes are:
2679 a - Any (default)
2680 r - Read-only
2681 o - Write-once
2682 c - Change-default
2683
Joe Hershberger71497d02012-12-11 22:16:31 -06002684 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2685 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002686 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002687
2688 - CONFIG_ENV_FLAGS_LIST_STATIC
2689 Define this to a list (string) to define validation that
2690 should be done if an entry is not found in the ".flags"
2691 environment variable. To override a setting in the static
2692 list, simply add an entry for the same variable name to the
2693 ".flags" variable.
2694
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002695 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2696 regular expression. This allows multiple variables to define the same
2697 flags without explicitly listing them for each variable.
2698
wdenkc6097192002-11-03 00:24:07 +00002699The following definitions that deal with the placement and management
2700of environment data (variable area); in general, we support the
2701following configurations:
2702
Mike Frysinger63b8f122011-07-08 10:44:25 +00002703- CONFIG_BUILD_ENVCRC:
2704
2705 Builds up envcrc with the target environment so that external utils
2706 may easily extract it and embed it in final U-Boot images.
2707
wdenkc6097192002-11-03 00:24:07 +00002708BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002709in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002710console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002711U-Boot will hang.
2712
2713Please note that even with NVRAM we still use a copy of the
2714environment in RAM: we could work on NVRAM directly, but we want to
2715keep settings there always unmodified except somebody uses "saveenv"
2716to save the current settings.
2717
Liu Gang85bcd732012-03-08 00:33:20 +00002718BE CAREFUL! For some special cases, the local device can not use
2719"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002720environment stored in a remote NOR flash by SRIO or PCIE link,
2721but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002722
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002723- CONFIG_NAND_ENV_DST
2724
2725 Defines address in RAM to which the nand_spl code should copy the
2726 environment. If redundant environment is used, it will be copied to
2727 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2728
Bruce Adleredecc942007-11-02 13:15:42 -07002729Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002730has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002731created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002732until then to read environment variables.
2733
wdenk8dba0502003-03-31 16:34:49 +00002734The environment is protected by a CRC32 checksum. Before the monitor
2735is relocated into RAM, as a result of a bad CRC you will be working
2736with the compiled-in default environment - *silently*!!! [This is
2737necessary, because the first environment variable we need is the
2738"baudrate" setting for the console - if we have a bad CRC, we don't
2739have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002740
2741Note: once the monitor has been relocated, then it will complain if
2742the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002743use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002745- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002746 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002748 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002749 also needs to be defined.
2750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002751- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002752 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002753
Ron Madriddfa028a2009-02-18 14:30:44 -08002754- CONFIG_NS16550_MIN_FUNCTIONS:
2755 Define this if you desire to only have use of the NS16550_init
2756 and NS16550_putc functions for the serial driver located at
2757 drivers/serial/ns16550.c. This option is useful for saving
2758 space for already greatly restricted images, including but not
2759 limited to NAND_SPL configurations.
2760
Simon Glass28a9e332012-11-30 13:01:18 +00002761- CONFIG_DISPLAY_BOARDINFO
2762 Display information about the board that U-Boot is running on
2763 when U-Boot starts up. The board function checkboard() is called
2764 to do this.
2765
Simon Glasse8822012012-11-30 13:01:19 +00002766- CONFIG_DISPLAY_BOARDINFO_LATE
2767 Similar to the previous option, but display this information
2768 later, once stdio is running and output goes to the LCD, if
2769 present.
2770
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002771- CONFIG_BOARD_SIZE_LIMIT:
2772 Maximum size of the U-Boot image. When defined, the
2773 build system checks that the actual size does not
2774 exceed it.
2775
wdenkc6097192002-11-03 00:24:07 +00002776Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002777---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002779- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002780 Cache Line Size of the CPU.
2781
Timur Tabid8f341c2011-08-04 18:03:41 -05002782- CONFIG_SYS_CCSRBAR_DEFAULT:
2783 Default (power-on reset) physical address of CCSR on Freescale
2784 PowerPC SOCs.
2785
2786- CONFIG_SYS_CCSRBAR:
2787 Virtual address of CCSR. On a 32-bit build, this is typically
2788 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2789
Timur Tabid8f341c2011-08-04 18:03:41 -05002790- CONFIG_SYS_CCSRBAR_PHYS:
2791 Physical address of CCSR. CCSR can be relocated to a new
2792 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002793 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002794 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2795 is typically relocated on 36-bit builds. It is recommended
2796 that this macro be defined via the _HIGH and _LOW macros:
2797
2798 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2799 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2800
2801- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002802 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2803 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002804 used in assembly code, so it must not contain typecasts or
2805 integer size suffixes (e.g. "ULL").
2806
2807- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2808 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2809 used in assembly code, so it must not contain typecasts or
2810 integer size suffixes (e.g. "ULL").
2811
2812- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2813 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2814 forced to a value that ensures that CCSR is not relocated.
2815
Macpaul Lind1e49942011-04-11 20:45:32 +00002816- CONFIG_IDE_AHB:
2817 Most IDE controllers were designed to be connected with PCI
2818 interface. Only few of them were designed for AHB interface.
2819 When software is doing ATA command and data transfer to
2820 IDE devices through IDE-AHB controller, some additional
2821 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002822 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00002823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002824- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002825 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002826 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002828- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002829
wdenkeb20ad32003-09-05 23:19:14 +00002830 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002831 initial data and stack; please note that this must be
2832 writable memory that is working WITHOUT special
2833 initialization, i. e. you CANNOT use normal RAM which
2834 will become available only after programming the
2835 memory controller and running certain initialization
2836 sequences.
2837
2838 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002839 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002840
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002841- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002842
2843 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002844 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2845 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002846 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002847 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002848 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002849 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2850 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002851
2852 Note:
2853 On the MPC824X (or other systems that use the data
2854 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002855 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002856 point to an otherwise UNUSED address space between
2857 the top of RAM and the start of the PCI space.
2858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002859- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002860
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002861- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002862 SDRAM timing
2863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002864- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002865 periodic timer for refresh
2866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002867- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2868 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2869 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2870 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002871 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2872
2873- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002874 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2875 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002876 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2877
Andrew Sharp61d47ca2012-08-29 14:16:32 +00002878- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002879 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00002880 Don't do any setup work, presumably because someone or
2881 something has already done it, and we don't need to do it
2882 a second time. Useful for platforms that are pre-booted
2883 by coreboot or similar.
2884
Gabor Juhosb4458732013-05-30 07:06:12 +00002885- CONFIG_PCI_INDIRECT_BRIDGE:
2886 Enable support for indirect PCI bridges.
2887
Kumar Gala8975d7a2010-12-30 12:09:53 -06002888- CONFIG_SYS_SRIO:
2889 Chip has SRIO or not
2890
2891- CONFIG_SRIO1:
2892 Board has SRIO 1 port available
2893
2894- CONFIG_SRIO2:
2895 Board has SRIO 2 port available
2896
Liu Gang27afb9c2013-05-07 16:30:46 +08002897- CONFIG_SRIO_PCIE_BOOT_MASTER
2898 Board can support master function for Boot from SRIO and PCIE
2899
Kumar Gala8975d7a2010-12-30 12:09:53 -06002900- CONFIG_SYS_SRIOn_MEM_VIRT:
2901 Virtual Address of SRIO port 'n' memory region
2902
Simon Glass970b61e2019-11-14 12:57:09 -07002903- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002904 Physical Address of SRIO port 'n' memory region
2905
2906- CONFIG_SYS_SRIOn_MEM_SIZE:
2907 Size of SRIO port 'n' memory region
2908
Fabio Estevamf17e8782013-04-11 09:35:34 +00002909- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2910 Defined to tell the NAND controller that the NAND chip is using
2911 a 16 bit bus.
2912 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002913 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002914 - drivers/mtd/nand/raw/ndfc.c
2915 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002916
2917- CONFIG_SYS_NDFC_EBC0_CFG
2918 Sets the EBC0_CFG register for the NDFC. If not defined
2919 a default value will be used.
2920
Ben Warren45657152006-09-07 16:50:54 -04002921- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002922 Get DDR timing information from an I2C EEPROM. Common
2923 with pluggable memory modules such as SODIMMs
2924
Ben Warren45657152006-09-07 16:50:54 -04002925 SPD_EEPROM_ADDRESS
2926 I2C address of the SPD EEPROM
2927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002928- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002929 If SPD EEPROM is on an I2C bus other than the first
2930 one, specify here. Note that the value must resolve
2931 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002932
York Sune73cc042011-06-07 09:42:16 +08002933- CONFIG_SYS_DDR_RAW_TIMING
2934 Get DDR timing information from other than SPD. Common with
2935 soldered DDR chips onboard without SPD. DDR raw timing
2936 parameters are extracted from datasheet and hard-coded into
2937 header files or board specific files.
2938
York Sunbd495cf2011-09-16 13:21:35 -07002939- CONFIG_FSL_DDR_INTERACTIVE
2940 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2941
York Sun8ced0502015-01-06 13:18:55 -08002942- CONFIG_FSL_DDR_SYNC_REFRESH
2943 Enable sync of refresh for multiple controllers.
2944
York Sunb6a35f82015-03-19 09:30:28 -07002945- CONFIG_FSL_DDR_BIST
2946 Enable built-in memory test for Freescale DDR controllers.
2947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002948- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002949 Only for 83xx systems. If specified, then DDR should
2950 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002951
wdenk6203e402004-04-18 10:13:26 +00002952- CONFIG_RMII
2953 Enable RMII mode for all FECs.
2954 Note that this is a global option, we can't
2955 have one FEC in standard MII mode and another in RMII mode.
2956
wdenk20c98a62004-04-23 20:32:05 +00002957- CONFIG_CRC32_VERIFY
2958 Add a verify option to the crc32 command.
2959 The syntax is:
2960
2961 => crc32 -v <address> <count> <crc32>
2962
2963 Where address/count indicate a memory area
2964 and crc32 is the correct crc32 which the
2965 area should have.
2966
wdenk64519362004-07-11 17:40:54 +00002967- CONFIG_LOOPW
2968 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06002969 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00002970
Joel Johnsondb5a97e2020-01-29 09:17:18 -07002971- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00002972 Add the "mdc" and "mwc" memory commands. These are cyclic
2973 "md/mw" commands.
2974 Examples:
2975
wdenk07d7e6b2004-12-16 21:44:03 +00002976 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002977 This command will print 4 bytes (10,11,12,13) each 500 ms.
2978
wdenk07d7e6b2004-12-16 21:44:03 +00002979 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002980 This command will write 12345678 to address 100 all 10 ms.
2981
wdenk07d7e6b2004-12-16 21:44:03 +00002982 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06002983 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00002984
wdenk3d3d99f2005-04-04 12:44:11 +00002985- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chend7e6f922017-12-26 13:55:59 +08002986 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01002987 low level initializations (like setting up the memory
2988 controller) are omitted and/or U-Boot does not
2989 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00002990
Wolfgang Denk302141d2010-11-27 23:30:56 +01002991 Normally this variable MUST NOT be defined. The only
2992 exception is when U-Boot is loaded (to RAM) by some
2993 other boot loader or by a debugger which performs
2994 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002995
Simon Glass90844072016-05-05 07:28:06 -06002996- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
2997 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09002998 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06002999 instruction cache) is still performed.
3000
Aneesh V552a3192011-07-13 05:11:07 +00003001- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08003002 Set when the currently-running compilation is for an artifact
3003 that will end up in the SPL (as opposed to the TPL or U-Boot
3004 proper). Code that needs stage-specific behavior should check
3005 this.
wdenk336b2bc2005-04-02 23:52:25 +00003006
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003007- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08003008 Set when the currently-running compilation is for an artifact
3009 that will end up in the TPL (as opposed to the SPL or U-Boot
3010 proper). Code that needs stage-specific behavior should check
3011 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003012
Ying Zhang0d4f5442013-05-20 14:07:23 +08003013- CONFIG_SYS_MPC85XX_NO_RESETVEC
3014 Only for 85xx systems. If this variable is specified, the section
3015 .resetvec is not kept and the section .bootpg is placed in the
3016 previous 4k of the .text section.
3017
Simon Glass17dabf02013-02-24 17:33:14 +00003018- CONFIG_ARCH_MAP_SYSMEM
3019 Generally U-Boot (and in particular the md command) uses
3020 effective address. It is therefore not necessary to regard
3021 U-Boot address as virtual addresses that need to be translated
3022 to physical addresses. However, sandbox requires this, since
3023 it maintains its own little RAM buffer which contains all
3024 addressable memory. This option causes some memory accesses
3025 to be mapped through map_sysmem() / unmap_sysmem().
3026
Simon Glassbfb59802013-02-14 04:18:54 +00003027- CONFIG_X86_RESET_VECTOR
3028 If defined, the x86 reset vector code is included. This is not
3029 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003030
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003031- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3032 Option to disable subpage write in NAND driver
3033 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02003034 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003035
Timur Tabi275f4bb2011-11-22 09:21:25 -06003036Freescale QE/FMAN Firmware Support:
3037-----------------------------------
3038
3039The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3040loading of "firmware", which is encoded in the QE firmware binary format.
3041This firmware often needs to be loaded during U-Boot booting, so macros
3042are used to identify the storage device (NOR flash, SPI, etc) and the address
3043within that device.
3044
Zhao Qiang83a90842014-03-21 16:21:44 +08003045- CONFIG_SYS_FMAN_FW_ADDR
3046 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04003047 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08003048 is also specified.
3049
3050- CONFIG_SYS_QE_FW_ADDR
3051 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04003052 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06003053 is also specified.
3054
3055- CONFIG_SYS_QE_FMAN_FW_LENGTH
3056 The maximum possible size of the firmware. The firmware binary format
3057 has a field that specifies the actual size of the firmware, but it
3058 might not be possible to read any part of the firmware unless some
3059 local storage is allocated to hold the entire firmware first.
3060
3061- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3062 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3063 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3064 virtual address in NOR flash.
3065
3066- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3067 Specifies that QE/FMAN firmware is located in NAND flash.
3068 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3069
3070- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3071 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3072 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3073
Liu Gang1e084582012-03-08 00:33:18 +00003074- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3075 Specifies that QE/FMAN firmware is located in the remote (master)
3076 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003077 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3078 window->master inbound window->master LAW->the ucode address in
3079 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003080
J. German Rivera8ff14b72014-06-23 15:15:55 -07003081Freescale Layerscape Management Complex Firmware Support:
3082---------------------------------------------------------
3083The Freescale Layerscape Management Complex (MC) supports the loading of
3084"firmware".
3085This firmware often needs to be loaded during U-Boot booting, so macros
3086are used to identify the storage device (NOR flash, SPI, etc) and the address
3087within that device.
3088
3089- CONFIG_FSL_MC_ENET
3090 Enable the MC driver for Layerscape SoCs.
3091
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303092Freescale Layerscape Debug Server Support:
3093-------------------------------------------
3094The Freescale Layerscape Debug Server Support supports the loading of
3095"Debug Server firmware" and triggering SP boot-rom.
3096This firmware often needs to be loaded during U-Boot booting.
3097
York Sun928b6812015-12-07 11:08:58 -08003098- CONFIG_SYS_MC_RSV_MEM_ALIGN
3099 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303100
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003101Reproducible builds
3102-------------------
3103
3104In order to achieve reproducible builds, timestamps used in the U-Boot build
3105process have to be set to a fixed value.
3106
3107This is done using the SOURCE_DATE_EPOCH environment variable.
3108SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3109option for U-Boot or an environment variable in U-Boot.
3110
3111SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3112
wdenkc6097192002-11-03 00:24:07 +00003113Building the Software:
3114======================
3115
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003116Building U-Boot has been tested in several native build environments
3117and in many different cross environments. Of course we cannot support
3118all possibly existing versions of cross development tools in all
3119(potentially obsolete) versions. In case of tool chain problems we
3120recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3121which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003122
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003123If you are not using a native environment, it is assumed that you
3124have GNU cross compiling tools available in your path. In this case,
3125you must set the environment variable CROSS_COMPILE in your shell.
3126Note that no changes to the Makefile or any other source files are
3127necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003128
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003129 $ CROSS_COMPILE=ppc_4xx-
3130 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003131
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003132U-Boot is intended to be simple to build. After installing the
3133sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003134is done by typing:
3135
Holger Freyther7ba4e572014-08-04 09:26:05 +02003136 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003137
Holger Freyther7ba4e572014-08-04 09:26:05 +02003138where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003139rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003140
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003141Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00003142 additional information is available from the board vendor; for
3143 instance, the TQM823L systems are available without (standard)
3144 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003145 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003146
Holger Freyther7ba4e572014-08-04 09:26:05 +02003147 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003148 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003149
Holger Freyther7ba4e572014-08-04 09:26:05 +02003150 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003151 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003152
wdenk6c59edc2004-05-03 20:45:30 +00003153 etc.
wdenkc6097192002-11-03 00:24:07 +00003154
wdenkc6097192002-11-03 00:24:07 +00003155
wdenk6c59edc2004-05-03 20:45:30 +00003156Finally, type "make all", and you should get some working U-Boot
3157images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003158
wdenk6c59edc2004-05-03 20:45:30 +00003159- "u-boot.bin" is a raw binary image
3160- "u-boot" is an image in ELF binary format
3161- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003162
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003163By default the build is performed locally and the objects are saved
3164in the source directory. One of the two methods can be used to change
3165this behavior and build U-Boot to some external directory:
3166
31671. Add O= to the make command line invocations:
3168
3169 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003170 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003171 make O=/tmp/build all
3172
Timo Ketolac8c67602014-11-06 14:39:05 +020031732. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003174
Timo Ketolac8c67602014-11-06 14:39:05 +02003175 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003176 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003177 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003178 make all
3179
Timo Ketolac8c67602014-11-06 14:39:05 +02003180Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003181variable.
3182
Daniel Schwierzeck88484422018-01-26 16:31:04 +01003183User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3184setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3185For example to treat all compiler warnings as errors:
3186
3187 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003188
wdenk6c59edc2004-05-03 20:45:30 +00003189Please be aware that the Makefiles assume you are using GNU make, so
3190for instance on NetBSD you might need to use "gmake" instead of
3191native "make".
wdenkc6097192002-11-03 00:24:07 +00003192
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk6c59edc2004-05-03 20:45:30 +00003194If the system board that you have is not listed, then you will need
3195to port U-Boot to your hardware platform. To do this, follow these
3196steps:
wdenkc6097192002-11-03 00:24:07 +00003197
Phil Sutterc77b4882015-12-25 14:41:18 +010031981. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003199 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003200 the "Makefile" and a "<board>.c".
32012. Create a new configuration file "include/configs/<board>.h" for
3202 your board.
wdenk6c59edc2004-05-03 20:45:30 +000032033. If you're porting U-Boot to a new CPU, then also create a new
3204 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020032054. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000032065. Type "make", and you should get a working "u-boot.srec" file
3207 to be installed on your target system.
32086. Debug and solve any problems that might arise.
3209 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003210
wdenkc6097192002-11-03 00:24:07 +00003211
wdenk6c59edc2004-05-03 20:45:30 +00003212Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3213==============================================================
wdenkc6097192002-11-03 00:24:07 +00003214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003215If you have modified U-Boot sources (for instance added a new board
3216or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003217provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08003218the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003219official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003220
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003221But before you submit such a patch, please verify that your modifi-
3222cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003223the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003224just run the buildman script (tools/buildman/buildman), which will
3225configure and build U-Boot for ALL supported system. Be warned, this
3226will take a while. Please see the buildman README, or run 'buildman -H'
3227for documentation.
wdenkc6097192002-11-03 00:24:07 +00003228
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003229
wdenk6c59edc2004-05-03 20:45:30 +00003230See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003231
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk6c59edc2004-05-03 20:45:30 +00003233Monitor Commands - Overview:
3234============================
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk6c59edc2004-05-03 20:45:30 +00003236go - start application at address 'addr'
3237run - run commands in an environment variable
3238bootm - boot application image from memory
3239bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003240bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003241tftpboot- boot image via network using TFTP protocol
3242 and env variables "ipaddr" and "serverip"
3243 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003244tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003245rarpboot- boot image via network using RARP/TFTP protocol
3246diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3247loads - load S-Record file over serial line
3248loadb - load binary file over serial line (kermit mode)
3249md - memory display
3250mm - memory modify (auto-incrementing)
3251nm - memory modify (constant address)
3252mw - memory write (fill)
3253cp - memory copy
3254cmp - memory compare
3255crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003256i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003257sspi - SPI utility commands
3258base - print or set address offset
3259printenv- print environment variables
3260setenv - set environment variables
3261saveenv - save environment variables to persistent storage
3262protect - enable or disable FLASH write protection
3263erase - erase FLASH memory
3264flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003265nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003266bdinfo - print Board Info structure
3267iminfo - print header information for application image
3268coninfo - print console devices and informations
3269ide - IDE sub-system
3270loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003271loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003272mtest - simple RAM test
3273icache - enable or disable instruction cache
3274dcache - enable or disable data cache
3275reset - Perform RESET of the CPU
3276echo - echo args to console
3277version - print monitor version
3278help - print online help
3279? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003280
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk6c59edc2004-05-03 20:45:30 +00003282Monitor Commands - Detailed Description:
3283========================================
wdenkc6097192002-11-03 00:24:07 +00003284
wdenk6c59edc2004-05-03 20:45:30 +00003285TODO.
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk6c59edc2004-05-03 20:45:30 +00003287For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003288
3289
wdenk6c59edc2004-05-03 20:45:30 +00003290Environment Variables:
3291======================
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk6c59edc2004-05-03 20:45:30 +00003293U-Boot supports user configuration using Environment Variables which
3294can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk6c59edc2004-05-03 20:45:30 +00003296Environment Variables are set using "setenv", printed using
3297"printenv", and saved to Flash using "saveenv". Using "setenv"
3298without a value can be used to delete a variable from the
3299environment. As long as you don't save the environment you are
3300working with an in-memory copy. In case the Flash area containing the
3301environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003302
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003303Some configuration options can be set using Environment Variables.
3304
3305List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk6c59edc2004-05-03 20:45:30 +00003307 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk6c59edc2004-05-03 20:45:30 +00003309 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003310
wdenk6c59edc2004-05-03 20:45:30 +00003311 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003312
wdenk6c59edc2004-05-03 20:45:30 +00003313 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003314
wdenk6c59edc2004-05-03 20:45:30 +00003315 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003316
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003317 bootm_low - Memory range available for image processing in the bootm
3318 command can be restricted. This variable is given as
3319 a hexadecimal number and defines lowest address allowed
3320 for use by the bootm command. See also "bootm_size"
3321 environment variable. Address defined by "bootm_low" is
3322 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003323 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3324 bootm_mapsize.
3325
Wolfgang Denk092ae952011-10-26 10:21:21 +00003326 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003327 This variable is given as a hexadecimal number and it
3328 defines the size of the memory region starting at base
3329 address bootm_low that is accessible by the Linux kernel
3330 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3331 as the default value if it is defined, and bootm_size is
3332 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003333
3334 bootm_size - Memory range available for image processing in the bootm
3335 command can be restricted. This variable is given as
3336 a hexadecimal number and defines the size of the region
3337 allowed for use by the bootm command. See also "bootm_low"
3338 environment variable.
3339
Simon Glassa8cab882019-07-20 20:51:17 -06003340 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3341
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003342 updatefile - Location of the software update file on a TFTP server, used
3343 by the automatic software update feature. Please refer to
3344 documentation in doc/README.update for more details.
3345
wdenk6c59edc2004-05-03 20:45:30 +00003346 autoload - if set to "no" (any string beginning with 'n'),
3347 "bootp" will just load perform a lookup of the
3348 configuration from the BOOTP server, but not try to
3349 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk6c59edc2004-05-03 20:45:30 +00003351 autostart - if set to "yes", an image loaded using the "bootp",
3352 "rarpboot", "tftpboot" or "diskboot" commands will
3353 be automatically started (by internally calling
3354 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003355
wdenk6c59edc2004-05-03 20:45:30 +00003356 If set to "no", a standalone image passed to the
3357 "bootm" command will be copied to the load address
3358 (and eventually uncompressed), but NOT be started.
3359 This can be used to load and uncompress arbitrary
3360 data.
wdenkc6097192002-11-03 00:24:07 +00003361
David A. Longd558a4e2011-07-09 16:40:19 -04003362 fdt_high - if set this restricts the maximum address that the
3363 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003364 For example, if you have a system with 1 GB memory
3365 at physical address 0x10000000, while Linux kernel
3366 only recognizes the first 704 MB as low memory, you
3367 may need to set fdt_high as 0x3C000000 to have the
3368 device tree blob be copied to the maximum address
3369 of the 704 MB low memory, so that Linux kernel can
3370 access it during the boot procedure.
3371
David A. Longd558a4e2011-07-09 16:40:19 -04003372 If this is set to the special value 0xFFFFFFFF then
3373 the fdt will not be copied at all on boot. For this
3374 to work it must reside in writable memory, have
3375 sufficient padding on the end of it for u-boot to
3376 add the information it needs into it, and the memory
3377 must be accessible by the kernel.
3378
Simon Glassdc6fa642011-10-24 19:15:34 +00003379 fdtcontroladdr- if set this is the address of the control flattened
3380 device tree used by U-Boot when CONFIG_OF_CONTROL is
3381 defined.
3382
wdenk0e2bd9c2004-06-06 21:51:03 +00003383 i2cfast - (PPC405GP|PPC405EP only)
3384 if set to 'y' configures Linux I2C driver for fast
3385 mode (400kHZ). This environment variable is used in
3386 initialization code. So, for changes to be effective
3387 it must be saved and board must be reset.
3388
wdenk6c59edc2004-05-03 20:45:30 +00003389 initrd_high - restrict positioning of initrd images:
3390 If this variable is not set, initrd images will be
3391 copied to the highest possible address in RAM; this
3392 is usually what you want since it allows for
3393 maximum initrd size. If for some reason you want to
3394 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003395 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003396 variable to a value of "no" or "off" or "0".
3397 Alternatively, you can set it to a maximum upper
3398 address to use (U-Boot will still check that it
3399 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003400
wdenk6c59edc2004-05-03 20:45:30 +00003401 For instance, when you have a system with 16 MB
3402 RAM, and want to reserve 4 MB from use by Linux,
3403 you can do this by adding "mem=12M" to the value of
3404 the "bootargs" variable. However, now you must make
3405 sure that the initrd image is placed in the first
3406 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk6c59edc2004-05-03 20:45:30 +00003408 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk6c59edc2004-05-03 20:45:30 +00003410 If you set initrd_high to 0xFFFFFFFF, this is an
3411 indication to U-Boot that all addresses are legal
3412 for the Linux kernel, including addresses in flash
3413 memory. In this case U-Boot will NOT COPY the
3414 ramdisk at all. This may be useful to reduce the
3415 boot time on your system, but requires that this
3416 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003417
wdenk6c59edc2004-05-03 20:45:30 +00003418 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk6c59edc2004-05-03 20:45:30 +00003420 loadaddr - Default load address for commands like "bootp",
3421 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003422
wdenk6c59edc2004-05-03 20:45:30 +00003423 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003424
wdenk6c59edc2004-05-03 20:45:30 +00003425 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003426
wdenk6c59edc2004-05-03 20:45:30 +00003427 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003428
wdenk6c59edc2004-05-03 20:45:30 +00003429 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003430
wdenk6c59edc2004-05-03 20:45:30 +00003431 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003432
Mike Frysingera23230c2011-10-02 10:01:27 +00003433 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003434
Mike Frysingera23230c2011-10-02 10:01:27 +00003435 ethact - controls which interface is currently active.
3436 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003437
Heiko Schocherc5e84052010-07-20 17:45:02 +02003438 => setenv ethact FEC
3439 => ping 192.168.0.1 # traffic sent on FEC
3440 => setenv ethact SCC
3441 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003442
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003443 ethrotate - When set to "no" U-Boot does not go through all
3444 available network interfaces.
3445 It just stays at the currently selected interface.
3446
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003447 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003448 either succeed or fail without retrying.
3449 When set to "once" the network operation will
3450 fail when all the available network interfaces
3451 are tried once without success.
3452 Useful on scripts which control the retry operation
3453 themselves.
wdenkc6097192002-11-03 00:24:07 +00003454
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003455 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003456
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003457 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003458 changing the console to be empty. If "yes" it will be
3459 made silent. If "no" it will not be made silent. If
3460 unset, then it will be made silent if the U-Boot console
3461 is silent.
3462
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003463 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003464 UDP source port.
3465
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003466 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003467 destination port instead of the Well Know Port 69.
3468
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003469 tftpblocksize - Block size to use for TFTP transfers; if not set,
3470 we use the TFTP server's default block size
3471
3472 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3473 seconds, minimum value is 1000 = 1 second). Defines
3474 when a packet is considered to be lost so it has to
3475 be retransmitted. The default is 5000 = 5 seconds.
3476 Lowering this value may make downloads succeed
3477 faster in networks with high packet loss rates or
3478 with unreliable TFTP servers.
3479
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003480 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3481 unit, minimum value = 0). Defines how many timeouts
3482 can happen during a single file transfer before that
3483 transfer is aborted. The default is 10, and 0 means
3484 'no timeouts allowed'. Increasing this value may help
3485 downloads succeed with high packet loss rates, or with
3486 unreliable TFTP servers or client hardware.
3487
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003488 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003489 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003490 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003491
Alexandre Messier15971322016-02-01 17:08:57 -05003492 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3493 Unsigned value, in milliseconds. If not set, the period will
3494 be either the default (28000), or a value based on
3495 CONFIG_NET_RETRY_COUNT, if defined. This value has
3496 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3497
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003498The following image location variables contain the location of images
3499used in booting. The "Image" column gives the role of the image and is
3500not an environment variable name. The other columns are environment
3501variable names. "File Name" gives the name of the file on a TFTP
3502server, "RAM Address" gives the location in RAM the image will be
3503loaded to, and "Flash Location" gives the image's address in NOR
3504flash or offset in NAND flash.
3505
3506*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03003507boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003508boards use these variables for other purposes.
3509
Wolfgang Denk092ae952011-10-26 10:21:21 +00003510Image File Name RAM Address Flash Location
3511----- --------- ----------- --------------
3512u-boot u-boot u-boot_addr_r u-boot_addr
3513Linux kernel bootfile kernel_addr_r kernel_addr
3514device tree blob fdtfile fdt_addr_r fdt_addr
3515ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003516
wdenk6c59edc2004-05-03 20:45:30 +00003517The following environment variables may be used and automatically
3518updated by the network boot commands ("bootp" and "rarpboot"),
3519depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003520
wdenk6c59edc2004-05-03 20:45:30 +00003521 bootfile - see above
3522 dnsip - IP address of your Domain Name Server
3523 dnsip2 - IP address of your secondary Domain Name Server
3524 gatewayip - IP address of the Gateway (Router) to use
3525 hostname - Target hostname
3526 ipaddr - see above
3527 netmask - Subnet Mask
3528 rootpath - Pathname of the root filesystem on the NFS server
3529 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003530
wdenk145d2c12004-04-15 21:48:45 +00003531
wdenk6c59edc2004-05-03 20:45:30 +00003532There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003533
wdenk6c59edc2004-05-03 20:45:30 +00003534 serial# - contains hardware identification information such
3535 as type string and/or serial number
3536 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk6c59edc2004-05-03 20:45:30 +00003538These variables can be set only once (usually during manufacturing of
3539the board). U-Boot refuses to delete or overwrite these variables
3540once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003541
3542
wdenk6c59edc2004-05-03 20:45:30 +00003543Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk6c59edc2004-05-03 20:45:30 +00003545 ver - Contains the U-Boot version string as printed
3546 with the "version" command. This variable is
3547 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003548
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk6c59edc2004-05-03 20:45:30 +00003550Please note that changes to some configuration parameters may take
3551only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003552
stroeseb9c17c52003-04-04 15:53:41 +00003553
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003554Callback functions for environment variables:
3555---------------------------------------------
3556
3557For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003558when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003559be associated with arbitrary variables. On creation, overwrite, or
3560deletion, the callback will provide the opportunity for some side
3561effect to happen or for the change to be rejected.
3562
3563The callbacks are named and associated with a function using the
3564U_BOOT_ENV_CALLBACK macro in your board or driver code.
3565
3566These callbacks are associated with variables in one of two ways. The
3567static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3568in the board configuration to a string that defines a list of
3569associations. The list must be in the following format:
3570
3571 entry = variable_name[:callback_name]
3572 list = entry[,list]
3573
3574If the callback name is not specified, then the callback is deleted.
3575Spaces are also allowed anywhere in the list.
3576
3577Callbacks can also be associated by defining the ".callbacks" variable
3578with the same list format above. Any association in ".callbacks" will
3579override any association in the static list. You can define
3580CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003581".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003582
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003583If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3584regular expression. This allows multiple variables to be connected to
3585the same callback without explicitly listing them all out.
3586
Heinrich Schuchardtc141fa52018-07-29 11:08:14 +02003587The signature of the callback functions is:
3588
3589 int callback(const char *name, const char *value, enum env_op op, int flags)
3590
3591* name - changed environment variable
3592* value - new value of the environment variable
3593* op - operation (create, overwrite, or delete)
3594* flags - attributes of the environment variable change, see flags H_* in
3595 include/search.h
3596
3597The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003598
wdenk6c59edc2004-05-03 20:45:30 +00003599Command Line Parsing:
3600=====================
stroeseb9c17c52003-04-04 15:53:41 +00003601
wdenk6c59edc2004-05-03 20:45:30 +00003602There are two different command line parsers available with U-Boot:
3603the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk6c59edc2004-05-03 20:45:30 +00003605Old, simple command line parser:
3606--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003607
wdenk6c59edc2004-05-03 20:45:30 +00003608- supports environment variables (through setenv / saveenv commands)
3609- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003610- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003611- special characters ('$', ';') can be escaped by prefixing with '\',
3612 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003613 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003614- You can also escape text by enclosing in single apostrophes, for example:
3615 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003616
wdenk6c59edc2004-05-03 20:45:30 +00003617Hush shell:
3618-----------
wdenkf4688a22003-05-28 08:06:31 +00003619
wdenk6c59edc2004-05-03 20:45:30 +00003620- similar to Bourne shell, with control structures like
3621 if...then...else...fi, for...do...done; while...do...done,
3622 until...do...done, ...
3623- supports environment ("global") variables (through setenv / saveenv
3624 commands) and local shell variables (through standard shell syntax
3625 "name=value"); only environment variables can be used with "run"
3626 command
wdenkf4688a22003-05-28 08:06:31 +00003627
wdenk6c59edc2004-05-03 20:45:30 +00003628General rules:
3629--------------
wdenkf4688a22003-05-28 08:06:31 +00003630
wdenk6c59edc2004-05-03 20:45:30 +00003631(1) If a command line (or an environment variable executed by a "run"
3632 command) contains several commands separated by semicolon, and
3633 one of these commands fails, then the remaining commands will be
3634 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003635
wdenk6c59edc2004-05-03 20:45:30 +00003636(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003637 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003638 command will cause "run" to terminate, i. e. the remaining
3639 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003640
wdenk6c59edc2004-05-03 20:45:30 +00003641Note for Redundant Ethernet Interfaces:
3642=======================================
wdenkf4688a22003-05-28 08:06:31 +00003643
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003644Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003645such configurations and is capable of automatic selection of a
3646"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003647
wdenk6c59edc2004-05-03 20:45:30 +00003648Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3649MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3650"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003651
wdenk6c59edc2004-05-03 20:45:30 +00003652If the network interface stores some valid MAC address (for instance
3653in SROM), this is used as default address if there is NO correspon-
3654ding setting in the environment; if the corresponding environment
3655variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003656
wdenk6c59edc2004-05-03 20:45:30 +00003657o If the SROM has a valid MAC address, and there is no address in the
3658 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk6c59edc2004-05-03 20:45:30 +00003660o If there is no valid address in the SROM, and a definition in the
3661 environment exists, then the value from the environment variable is
3662 used.
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk6c59edc2004-05-03 20:45:30 +00003664o If both the SROM and the environment contain a MAC address, and
3665 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk6c59edc2004-05-03 20:45:30 +00003667o If both the SROM and the environment contain a MAC address, and the
3668 addresses differ, the value from the environment is used and a
3669 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003670
wdenk6c59edc2004-05-03 20:45:30 +00003671o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05003672 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3673 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003674
Ben Warren6db991a2010-04-26 11:11:46 -07003675If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003676will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003677may be skipped by setting the appropriate 'ethmacskip' environment variable.
3678The naming convention is as follows:
3679"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk6c59edc2004-05-03 20:45:30 +00003681Image Formats:
3682==============
wdenkc6097192002-11-03 00:24:07 +00003683
Marian Balakowicz18710b82008-03-12 12:13:13 +01003684U-Boot is capable of booting (and performing other auxiliary operations on)
3685images in two formats:
3686
3687New uImage format (FIT)
3688-----------------------
3689
3690Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3691to Flattened Device Tree). It allows the use of images with multiple
3692components (several kernels, ramdisks, etc.), with contents protected by
3693SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3694
3695
3696Old uImage format
3697-----------------
3698
3699Old image format is based on binary files which can be basically anything,
3700preceded by a special header; see the definitions in include/image.h for
3701details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk6c59edc2004-05-03 20:45:30 +00003703* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3704 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003705 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3706 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3707 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003708* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003709 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003710 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003711* Compression Type (uncompressed, gzip, bzip2)
3712* Load Address
3713* Entry Point
3714* Image Name
3715* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk6c59edc2004-05-03 20:45:30 +00003717The header is marked by a special Magic Number, and both the header
3718and the data portions of the image are secured against corruption by
3719CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003720
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk6c59edc2004-05-03 20:45:30 +00003722Linux Support:
3723==============
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk6c59edc2004-05-03 20:45:30 +00003725Although U-Boot should support any OS or standalone application
3726easily, the main focus has always been on Linux during the design of
3727U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk6c59edc2004-05-03 20:45:30 +00003729U-Boot includes many features that so far have been part of some
3730special "boot loader" code within the Linux kernel. Also, any
3731"initrd" images to be used are no longer part of one big Linux image;
3732instead, kernel and "initrd" are separate images. This implementation
3733serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk6c59edc2004-05-03 20:45:30 +00003735- the same features can be used for other OS or standalone
3736 applications (for instance: using compressed images to reduce the
3737 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk6c59edc2004-05-03 20:45:30 +00003739- it becomes much easier to port new Linux kernel versions because
3740 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk6c59edc2004-05-03 20:45:30 +00003742- the same Linux kernel image can now be used with different "initrd"
3743 images; of course this also means that different kernel images can
3744 be run with the same "initrd". This makes testing easier (you don't
3745 have to build a new "zImage.initrd" Linux image when you just
3746 change a file in your "initrd"). Also, a field-upgrade of the
3747 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003748
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk6c59edc2004-05-03 20:45:30 +00003750Linux HOWTO:
3751============
wdenkc6097192002-11-03 00:24:07 +00003752
wdenk6c59edc2004-05-03 20:45:30 +00003753Porting Linux to U-Boot based systems:
3754---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk6c59edc2004-05-03 20:45:30 +00003756U-Boot cannot save you from doing all the necessary modifications to
3757configure the Linux device drivers for use with your target hardware
3758(no, we don't intend to provide a full virtual machine interface to
3759Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003760
Stefan Roese88fbf932010-04-15 16:07:28 +02003761But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk6c59edc2004-05-03 20:45:30 +00003763Just make sure your machine specific header file (for instance
3764include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003765Information structure as we define in include/asm-<arch>/u-boot.h,
3766and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003768
Simon Glassd097e592014-06-11 23:29:46 -06003769Note that U-Boot now has a driver model, a unified model for drivers.
3770If you are adding a new driver, plumb it into driver model. If there
3771is no uclass available, you are encouraged to create one. See
3772doc/driver-model.
3773
wdenkc6097192002-11-03 00:24:07 +00003774
wdenk6c59edc2004-05-03 20:45:30 +00003775Configuring the Linux kernel:
3776-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003777
wdenk6c59edc2004-05-03 20:45:30 +00003778No specific requirements for U-Boot. Make sure you have some root
3779device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003780
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk6c59edc2004-05-03 20:45:30 +00003782Building a Linux Image:
3783-----------------------
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk6c59edc2004-05-03 20:45:30 +00003785With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3786not used. If you use recent kernel source, a new build target
3787"uImage" will exist which automatically builds an image usable by
3788U-Boot. Most older kernels also have support for a "pImage" target,
3789which was introduced for our predecessor project PPCBoot and uses a
3790100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk6c59edc2004-05-03 20:45:30 +00003792Example:
wdenkc6097192002-11-03 00:24:07 +00003793
Holger Freyther7ba4e572014-08-04 09:26:05 +02003794 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003795 make oldconfig
3796 make dep
3797 make uImage
wdenkc6097192002-11-03 00:24:07 +00003798
wdenk6c59edc2004-05-03 20:45:30 +00003799The "uImage" build target uses a special tool (in 'tools/mkimage') to
3800encapsulate a compressed Linux kernel image with header information,
3801CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003802
wdenk6c59edc2004-05-03 20:45:30 +00003803* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003804
wdenk6c59edc2004-05-03 20:45:30 +00003805* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk6c59edc2004-05-03 20:45:30 +00003807 ${CROSS_COMPILE}-objcopy -O binary \
3808 -R .note -R .comment \
3809 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003810
wdenk6c59edc2004-05-03 20:45:30 +00003811* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003812
wdenk6c59edc2004-05-03 20:45:30 +00003813 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003814
wdenk6c59edc2004-05-03 20:45:30 +00003815* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003816
wdenk6c59edc2004-05-03 20:45:30 +00003817 mkimage -A ppc -O linux -T kernel -C gzip \
3818 -a 0 -e 0 -n "Linux Kernel Image" \
3819 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003820
wdenkc6097192002-11-03 00:24:07 +00003821
wdenk6c59edc2004-05-03 20:45:30 +00003822The "mkimage" tool can also be used to create ramdisk images for use
3823with U-Boot, either separated from the Linux kernel image, or
3824combined into one file. "mkimage" encapsulates the images with a 64
3825byte header containing information about target architecture,
3826operating system, image type, compression method, entry points, time
3827stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk6c59edc2004-05-03 20:45:30 +00003829"mkimage" can be called in two ways: to verify existing images and
3830print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003831
wdenk6c59edc2004-05-03 20:45:30 +00003832In the first form (with "-l" option) mkimage lists the information
3833contained in the header of an existing U-Boot image; this includes
3834checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003835
wdenk6c59edc2004-05-03 20:45:30 +00003836 tools/mkimage -l image
3837 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003838
wdenk6c59edc2004-05-03 20:45:30 +00003839The second form (with "-d" option) is used to build a U-Boot image
3840from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003841
wdenk6c59edc2004-05-03 20:45:30 +00003842 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3843 -n name -d data_file image
3844 -A ==> set architecture to 'arch'
3845 -O ==> set operating system to 'os'
3846 -T ==> set image type to 'type'
3847 -C ==> set compression type 'comp'
3848 -a ==> set load address to 'addr' (hex)
3849 -e ==> set entry point to 'ep' (hex)
3850 -n ==> set image name to 'name'
3851 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003852
wdenkcd914452004-05-29 16:53:29 +00003853Right now, all Linux kernels for PowerPC systems use the same load
3854address (0x00000000), but the entry point address depends on the
3855kernel version:
wdenkc6097192002-11-03 00:24:07 +00003856
wdenk6c59edc2004-05-03 20:45:30 +00003857- 2.2.x kernels have the entry point at 0x0000000C,
3858- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003859
wdenk6c59edc2004-05-03 20:45:30 +00003860So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003861
wdenk6c59edc2004-05-03 20:45:30 +00003862 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3863 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003864 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003865 > examples/uImage.TQM850L
3866 Image Name: 2.4.4 kernel for TQM850L
3867 Created: Wed Jul 19 02:34:59 2000
3868 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3869 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3870 Load Address: 0x00000000
3871 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk6c59edc2004-05-03 20:45:30 +00003873To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875 -> tools/mkimage -l examples/uImage.TQM850L
3876 Image Name: 2.4.4 kernel for TQM850L
3877 Created: Wed Jul 19 02:34:59 2000
3878 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3879 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3880 Load Address: 0x00000000
3881 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883NOTE: for embedded systems where boot time is critical you can trade
3884speed for memory and install an UNCOMPRESSED image instead: this
3885needs more space in Flash, but boots much faster since it does not
3886need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003887
Stefan Roese88fbf932010-04-15 16:07:28 +02003888 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003889 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3890 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003891 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003892 > examples/uImage.TQM850L-uncompressed
3893 Image Name: 2.4.4 kernel for TQM850L
3894 Created: Wed Jul 19 02:34:59 2000
3895 Image Type: PowerPC Linux Kernel Image (uncompressed)
3896 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3897 Load Address: 0x00000000
3898 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003899
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk6c59edc2004-05-03 20:45:30 +00003901Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3902when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk6c59edc2004-05-03 20:45:30 +00003904 -> tools/mkimage -n 'Simple Ramdisk Image' \
3905 > -A ppc -O linux -T ramdisk -C gzip \
3906 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3907 Image Name: Simple Ramdisk Image
3908 Created: Wed Jan 12 14:01:50 2000
3909 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3910 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3911 Load Address: 0x00000000
3912 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003913
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07003914The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3915option performs the converse operation of the mkimage's second form (the "-d"
3916option). Given an image built by mkimage, the dumpimage extracts a "data file"
3917from the image:
3918
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02003919 tools/dumpimage -i image -T type -p position data_file
3920 -i ==> extract from the 'image' a specific 'data_file'
3921 -T ==> set image type to 'type'
3922 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07003923
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925Installing a Linux Image:
3926-------------------------
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk6c59edc2004-05-03 20:45:30 +00003928To downloading a U-Boot image over the serial (console) interface,
3929you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk6c59edc2004-05-03 20:45:30 +00003931 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk6c59edc2004-05-03 20:45:30 +00003933The 'objcopy' does not understand the information in the U-Boot
3934image header, so the resulting S-Record file will be relative to
3935address 0x00000000. To load it to a given address, you need to
3936specify the target address as 'offset' parameter with the 'loads'
3937command.
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk6c59edc2004-05-03 20:45:30 +00003939Example: install the image to address 0x40100000 (which on the
3940TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944 .......... done
3945 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk6c59edc2004-05-03 20:45:30 +00003947 => loads 40100000
3948 ## Ready for S-Record download ...
3949 ~>examples/image.srec
3950 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3951 ...
3952 15989 15990 15991 15992
3953 [file transfer complete]
3954 [connected]
3955 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003956
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk6c59edc2004-05-03 20:45:30 +00003958You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003959this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003960corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003961
wdenk6c59edc2004-05-03 20:45:30 +00003962 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk6c59edc2004-05-03 20:45:30 +00003964 ## Checking Image at 40100000 ...
3965 Image Name: 2.2.13 for initrd on TQM850L
3966 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3967 Data Size: 335725 Bytes = 327 kB = 0 MB
3968 Load Address: 00000000
3969 Entry Point: 0000000c
3970 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003971
3972
wdenk6c59edc2004-05-03 20:45:30 +00003973Boot Linux:
3974-----------
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk6c59edc2004-05-03 20:45:30 +00003976The "bootm" command is used to boot an application that is stored in
3977memory (RAM or Flash). In case of a Linux kernel image, the contents
3978of the "bootargs" environment variable is passed to the kernel as
3979parameters. You can check and modify this variable using the
3980"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003981
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk6c59edc2004-05-03 20:45:30 +00003983 => printenv bootargs
3984 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003985
wdenk6c59edc2004-05-03 20:45:30 +00003986 => 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 +00003987
wdenk6c59edc2004-05-03 20:45:30 +00003988 => printenv bootargs
3989 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 +00003990
wdenk6c59edc2004-05-03 20:45:30 +00003991 => bootm 40020000
3992 ## Booting Linux kernel at 40020000 ...
3993 Image Name: 2.2.13 for NFS on TQM850L
3994 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3995 Data Size: 381681 Bytes = 372 kB = 0 MB
3996 Load Address: 00000000
3997 Entry Point: 0000000c
3998 Verifying Checksum ... OK
3999 Uncompressing Kernel Image ... OK
4000 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
4001 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4002 time_init: decrementer frequency = 187500000/60
4003 Calibrating delay loop... 49.77 BogoMIPS
4004 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4005 ...
wdenkc6097192002-11-03 00:24:07 +00004006
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004007If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004008the memory addresses of both the kernel and the initrd image (PPBCOOT
4009format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk6c59edc2004-05-03 20:45:30 +00004013 ## Checking Image at 40100000 ...
4014 Image Name: 2.2.13 for initrd on TQM850L
4015 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4016 Data Size: 335725 Bytes = 327 kB = 0 MB
4017 Load Address: 00000000
4018 Entry Point: 0000000c
4019 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk6c59edc2004-05-03 20:45:30 +00004021 ## Checking Image at 40200000 ...
4022 Image Name: Simple Ramdisk Image
4023 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4024 Data Size: 566530 Bytes = 553 kB = 0 MB
4025 Load Address: 00000000
4026 Entry Point: 00000000
4027 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004028
wdenk6c59edc2004-05-03 20:45:30 +00004029 => bootm 40100000 40200000
4030 ## Booting Linux kernel at 40100000 ...
4031 Image Name: 2.2.13 for initrd on TQM850L
4032 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4033 Data Size: 335725 Bytes = 327 kB = 0 MB
4034 Load Address: 00000000
4035 Entry Point: 0000000c
4036 Verifying Checksum ... OK
4037 Uncompressing Kernel Image ... OK
4038 ## Loading RAMDisk Image at 40200000 ...
4039 Image Name: Simple Ramdisk Image
4040 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4041 Data Size: 566530 Bytes = 553 kB = 0 MB
4042 Load Address: 00000000
4043 Entry Point: 00000000
4044 Verifying Checksum ... OK
4045 Loading Ramdisk ... OK
4046 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
4047 Boot arguments: root=/dev/ram
4048 time_init: decrementer frequency = 187500000/60
4049 Calibrating delay loop... 49.77 BogoMIPS
4050 ...
4051 RAMDISK: Compressed image found at block 0
4052 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004053
wdenk6c59edc2004-05-03 20:45:30 +00004054 bash#
wdenkc6097192002-11-03 00:24:07 +00004055
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004056Boot Linux and pass a flat device tree:
4057-----------
4058
4059First, U-Boot must be compiled with the appropriate defines. See the section
4060titled "Linux Kernel Interface" above for a more in depth explanation. The
4061following is an example of how to start a kernel and pass an updated
4062flat device tree:
4063
4064=> print oftaddr
4065oftaddr=0x300000
4066=> print oft
4067oft=oftrees/mpc8540ads.dtb
4068=> tftp $oftaddr $oft
4069Speed: 1000, full duplex
4070Using TSEC0 device
4071TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4072Filename 'oftrees/mpc8540ads.dtb'.
4073Load address: 0x300000
4074Loading: #
4075done
4076Bytes transferred = 4106 (100a hex)
4077=> tftp $loadaddr $bootfile
4078Speed: 1000, full duplex
4079Using TSEC0 device
4080TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4081Filename 'uImage'.
4082Load address: 0x200000
4083Loading:############
4084done
4085Bytes transferred = 1029407 (fb51f hex)
4086=> print loadaddr
4087loadaddr=200000
4088=> print oftaddr
4089oftaddr=0x300000
4090=> bootm $loadaddr - $oftaddr
4091## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004092 Image Name: Linux-2.6.17-dirty
4093 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4094 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004095 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004096 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004097 Verifying Checksum ... OK
4098 Uncompressing Kernel Image ... OK
4099Booting using flat device tree at 0x300000
4100Using MPC85xx ADS machine description
4101Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4102[snip]
4103
4104
wdenk6c59edc2004-05-03 20:45:30 +00004105More About U-Boot Image Types:
4106------------------------------
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk6c59edc2004-05-03 20:45:30 +00004108U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk6c59edc2004-05-03 20:45:30 +00004110 "Standalone Programs" are directly runnable in the environment
4111 provided by U-Boot; it is expected that (if they behave
4112 well) you can continue to work in U-Boot after return from
4113 the Standalone Program.
4114 "OS Kernel Images" are usually images of some Embedded OS which
4115 will take over control completely. Usually these programs
4116 will install their own set of exception handlers, device
4117 drivers, set up the MMU, etc. - this means, that you cannot
4118 expect to re-enter U-Boot except by resetting the CPU.
4119 "RAMDisk Images" are more or less just data blocks, and their
4120 parameters (address, size) are passed to an OS kernel that is
4121 being started.
4122 "Multi-File Images" contain several images, typically an OS
4123 (Linux) kernel image and one or more data images like
4124 RAMDisks. This construct is useful for instance when you want
4125 to boot over the network using BOOTP etc., where the boot
4126 server provides just a single image file, but you want to get
4127 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk6c59edc2004-05-03 20:45:30 +00004129 "Multi-File Images" start with a list of image sizes, each
4130 image size (in bytes) specified by an "uint32_t" in network
4131 byte order. This list is terminated by an "(uint32_t)0".
4132 Immediately after the terminating 0 follow the images, one by
4133 one, all aligned on "uint32_t" boundaries (size rounded up to
4134 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004135
wdenk6c59edc2004-05-03 20:45:30 +00004136 "Firmware Images" are binary images containing firmware (like
4137 U-Boot or FPGA images) which usually will be programmed to
4138 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004139
wdenk6c59edc2004-05-03 20:45:30 +00004140 "Script files" are command sequences that will be executed by
4141 U-Boot's command interpreter; this feature is especially
4142 useful when you configure U-Boot to use a real shell (hush)
4143 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004144
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004145Booting the Linux zImage:
4146-------------------------
4147
4148On some platforms, it's possible to boot Linux zImage. This is done
4149using the "bootz" command. The syntax of "bootz" command is the same
4150as the syntax of "bootm" command.
4151
Tom Rini45f46d12013-05-16 11:40:11 -04004152Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004153kernel with raw initrd images. The syntax is slightly different, the
4154address of the initrd must be augmented by it's size, in the following
4155format: "<initrd addres>:<initrd size>".
4156
stroeseb9c17c52003-04-04 15:53:41 +00004157
wdenk6c59edc2004-05-03 20:45:30 +00004158Standalone HOWTO:
4159=================
stroeseb9c17c52003-04-04 15:53:41 +00004160
wdenk6c59edc2004-05-03 20:45:30 +00004161One of the features of U-Boot is that you can dynamically load and
4162run "standalone" applications, which can use some resources of
4163U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004164
wdenk6c59edc2004-05-03 20:45:30 +00004165Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004166
wdenk6c59edc2004-05-03 20:45:30 +00004167"Hello World" Demo:
4168-------------------
wdenkc6097192002-11-03 00:24:07 +00004169
wdenk6c59edc2004-05-03 20:45:30 +00004170'examples/hello_world.c' contains a small "Hello World" Demo
4171application; it is automatically compiled when you build U-Boot.
4172It's configured to run at address 0x00040004, so you can play with it
4173like that:
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk6c59edc2004-05-03 20:45:30 +00004175 => loads
4176 ## Ready for S-Record download ...
4177 ~>examples/hello_world.srec
4178 1 2 3 4 5 6 7 8 9 10 11 ...
4179 [file transfer complete]
4180 [connected]
4181 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk6c59edc2004-05-03 20:45:30 +00004183 => go 40004 Hello World! This is a test.
4184 ## Starting application at 0x00040004 ...
4185 Hello World
4186 argc = 7
4187 argv[0] = "40004"
4188 argv[1] = "Hello"
4189 argv[2] = "World!"
4190 argv[3] = "This"
4191 argv[4] = "is"
4192 argv[5] = "a"
4193 argv[6] = "test."
4194 argv[7] = "<NULL>"
4195 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk6c59edc2004-05-03 20:45:30 +00004197 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004198
wdenk6c59edc2004-05-03 20:45:30 +00004199Another example, which demonstrates how to register a CPM interrupt
4200handler with the U-Boot code, can be found in 'examples/timer.c'.
4201Here, a CPM timer is set up to generate an interrupt every second.
4202The interrupt service routine is trivial, just printing a '.'
4203character, but this is just a demo program. The application can be
4204controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk6c59edc2004-05-03 20:45:30 +00004206 ? - print current values og the CPM Timer registers
4207 b - enable interrupts and start timer
4208 e - stop timer and disable interrupts
4209 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk6c59edc2004-05-03 20:45:30 +00004211 => loads
4212 ## Ready for S-Record download ...
4213 ~>examples/timer.srec
4214 1 2 3 4 5 6 7 8 9 10 11 ...
4215 [file transfer complete]
4216 [connected]
4217 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk6c59edc2004-05-03 20:45:30 +00004219 => go 40004
4220 ## Starting application at 0x00040004 ...
4221 TIMERS=0xfff00980
4222 Using timer 1
4223 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk6c59edc2004-05-03 20:45:30 +00004225Hit 'b':
4226 [q, b, e, ?] Set interval 1000000 us
4227 Enabling timer
4228Hit '?':
4229 [q, b, e, ?] ........
4230 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4231Hit '?':
4232 [q, b, e, ?] .
4233 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4234Hit '?':
4235 [q, b, e, ?] .
4236 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4237Hit '?':
4238 [q, b, e, ?] .
4239 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4240Hit 'e':
4241 [q, b, e, ?] ...Stopping timer
4242Hit 'q':
4243 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004244
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246Minicom warning:
4247================
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249Over time, many people have reported problems when trying to use the
4250"minicom" terminal emulation program for serial download. I (wd)
4251consider minicom to be broken, and recommend not to use it. Under
4252Unix, I recommend to use C-Kermit for general purpose use (and
4253especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004254use "cu" for S-Record download ("loads" command). See
4255http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4256for help with kermit.
4257
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk6c59edc2004-05-03 20:45:30 +00004259Nevertheless, if you absolutely want to use it try adding this
4260configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk6c59edc2004-05-03 20:45:30 +00004262 Name Program Name U/D FullScr IO-Red. Multi
4263 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4264 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004265
wdenk8dba0502003-03-31 16:34:49 +00004266
wdenk6c59edc2004-05-03 20:45:30 +00004267NetBSD Notes:
4268=============
wdenkc6097192002-11-03 00:24:07 +00004269
wdenk6c59edc2004-05-03 20:45:30 +00004270Starting at version 0.9.2, U-Boot supports NetBSD both as host
4271(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004272
wdenk6c59edc2004-05-03 20:45:30 +00004273Building requires a cross environment; it is known to work on
4274NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4275need gmake since the Makefiles are not compatible with BSD make).
4276Note that the cross-powerpc package does not install include files;
4277attempting to build U-Boot will fail because <machine/ansi.h> is
4278missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004279
wdenk6c59edc2004-05-03 20:45:30 +00004280 # cd /usr/pkg/cross/powerpc-netbsd/include
4281 # mkdir powerpc
4282 # ln -s powerpc machine
4283 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4284 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004285
wdenk6c59edc2004-05-03 20:45:30 +00004286Native builds *don't* work due to incompatibilities between native
4287and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk6c59edc2004-05-03 20:45:30 +00004289Booting assumes that (the first part of) the image booted is a
4290stage-2 loader which in turn loads and then invokes the kernel
4291proper. Loader sources will eventually appear in the NetBSD source
4292tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004293meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004294
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk6c59edc2004-05-03 20:45:30 +00004296Implementation Internals:
4297=========================
wdenkc6097192002-11-03 00:24:07 +00004298
wdenk6c59edc2004-05-03 20:45:30 +00004299The following is not intended to be a complete description of every
4300implementation detail. However, it should help to understand the
4301inner workings of U-Boot and make it easier to port it to custom
4302hardware.
wdenkc6097192002-11-03 00:24:07 +00004303
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk6c59edc2004-05-03 20:45:30 +00004305Initial Stack, Global Data:
4306---------------------------
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk6c59edc2004-05-03 20:45:30 +00004308The implementation of U-Boot is complicated by the fact that U-Boot
4309starts running out of ROM (flash memory), usually without access to
4310system RAM (because the memory controller is not initialized yet).
4311This means that we don't have writable Data or BSS segments, and BSS
4312is not initialized as zero. To be able to get a C environment working
4313at all, we have to allocate at least a minimal stack. Implementation
4314options for this are defined and restricted by the CPU used: Some CPU
4315models provide on-chip memory (like the IMMR area on MPC8xx and
4316MPC826x processors), on others (parts of) the data cache can be
4317locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004318
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004319 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004320 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004321
wdenk6c59edc2004-05-03 20:45:30 +00004322 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4323 From: "Chris Hallinan" <clh@net1plus.com>
4324 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4325 ...
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327 Correct me if I'm wrong, folks, but the way I understand it
4328 is this: Using DCACHE as initial RAM for Stack, etc, does not
4329 require any physical RAM backing up the cache. The cleverness
4330 is that the cache is being used as a temporary supply of
4331 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004332 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004333 can see how this works by studying the cache architecture and
4334 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4337 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004338 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004339 option should work for you. Using CS 4 should be fine if your
4340 board designers haven't used it for something that would
4341 cause you grief during the initial boot! It is frequently not
4342 used.
wdenkc6097192002-11-03 00:24:07 +00004343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004344 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004345 with your processor/board/system design. The default value
4346 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004347 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004348 than your SDRAM module. If you have a 64MB SDRAM module, set
4349 it above 400_0000. Just make sure your board has no resources
4350 that are supposed to respond to that address! That code in
4351 start.S has been around a while and should work as is when
4352 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004353
wdenk6c59edc2004-05-03 20:45:30 +00004354 -Chris Hallinan
4355 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004356
wdenk6c59edc2004-05-03 20:45:30 +00004357It is essential to remember this, since it has some impact on the C
4358code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004359
wdenk6c59edc2004-05-03 20:45:30 +00004360* Initialized global data (data segment) is read-only. Do not attempt
4361 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004362
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004363* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004364 as zero data - BSS segment) at all - this is undefined, initiali-
4365 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367* Stack space is very limited. Avoid big data buffers or things like
4368 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004369
wdenk6c59edc2004-05-03 20:45:30 +00004370Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004371normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004372turned out that the implementation of U-Boot can be greatly
4373simplified by making a global data structure (gd_t) available to all
4374functions. We could pass a pointer to this data as argument to _all_
4375functions, but this would bloat the code. Instead we use a feature of
4376the GCC compiler (Global Register Variables) to share the data: we
4377place a pointer (gd) to the global data into a register which we
4378reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk6c59edc2004-05-03 20:45:30 +00004380When choosing a register for such a purpose we are restricted by the
4381relevant (E)ABI specifications for the current architecture, and by
4382GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk6c59edc2004-05-03 20:45:30 +00004384For PowerPC, the following registers have specific use:
4385 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004386 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004387 R3-R4: parameter passing and return values
4388 R5-R10: parameter passing
4389 R13: small data area pointer
4390 R30: GOT pointer
4391 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004392
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004393 (U-Boot also uses R12 as internal GOT pointer. r12
4394 is a volatile register so r12 needs to be reset when
4395 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004396
Wolfgang Denk69c09642008-02-14 22:43:22 +01004397 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399 Note: on PPC, we could use a static initializer (since the
4400 address of the global data structure is known at compile time),
4401 but it turned out that reserving a register results in somewhat
4402 smaller code - although the code savings are not that big (on
4403 average for all boards 752 bytes for the whole U-Boot image,
4404 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk6c59edc2004-05-03 20:45:30 +00004406On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk6c59edc2004-05-03 20:45:30 +00004408 R0: function argument word/integer result
4409 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004410 R9: platform specific
4411 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004412 R11: argument (frame) pointer
4413 R12: temporary workspace
4414 R13: stack pointer
4415 R14: link register
4416 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004417
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004418 ==> U-Boot will use R9 to hold a pointer to the global data
4419
4420 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004421
Thomas Chou8fa38582010-05-21 11:08:03 +08004422On Nios II, the ABI is documented here:
4423 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4424
4425 ==> U-Boot will use gp to hold a pointer to the global data
4426
4427 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4428 to access small data sections, so gp is free.
4429
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004430On NDS32, the following registers are used:
4431
4432 R0-R1: argument/return
4433 R2-R5: argument
4434 R15: temporary register for assembler
4435 R16: trampoline register
4436 R28: frame pointer (FP)
4437 R29: global pointer (GP)
4438 R30: link register (LP)
4439 R31: stack pointer (SP)
4440 PC: program counter (PC)
4441
4442 ==> U-Boot will use R10 to hold a pointer to the global data
4443
Wolfgang Denk6405a152006-03-31 18:32:53 +02004444NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4445or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004446
Rick Chend7e6f922017-12-26 13:55:59 +08004447On RISC-V, the following registers are used:
4448
4449 x0: hard-wired zero (zero)
4450 x1: return address (ra)
4451 x2: stack pointer (sp)
4452 x3: global pointer (gp)
4453 x4: thread pointer (tp)
4454 x5: link register (t0)
4455 x8: frame pointer (fp)
4456 x10-x11: arguments/return values (a0-1)
4457 x12-x17: arguments (a2-7)
4458 x28-31: temporaries (t3-6)
4459 pc: program counter (pc)
4460
4461 ==> U-Boot will use gp to hold a pointer to the global data
4462
wdenk6c59edc2004-05-03 20:45:30 +00004463Memory Management:
4464------------------
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk6c59edc2004-05-03 20:45:30 +00004466U-Boot runs in system state and uses physical addresses, i.e. the
4467MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004468
wdenk6c59edc2004-05-03 20:45:30 +00004469The available memory is mapped to fixed addresses using the memory
4470controller. In this process, a contiguous block is formed for each
4471memory type (Flash, SDRAM, SRAM), even when it consists of several
4472physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk6c59edc2004-05-03 20:45:30 +00004474U-Boot is installed in the first 128 kB of the first Flash bank (on
4475TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4476booting and sizing and initializing DRAM, the code relocates itself
4477to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004478memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004479configuration setting]. Below that, a structure with global Board
4480Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004481
wdenk6c59edc2004-05-03 20:45:30 +00004482Additionally, some exception handler code is copied to the low 8 kB
4483of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485So a typical memory configuration with 16 MB of DRAM could look like
4486this:
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk6c59edc2004-05-03 20:45:30 +00004488 0x0000 0000 Exception Vector code
4489 :
4490 0x0000 1FFF
4491 0x0000 2000 Free for Application Use
4492 :
4493 :
wdenkc6097192002-11-03 00:24:07 +00004494
wdenk6c59edc2004-05-03 20:45:30 +00004495 :
4496 :
4497 0x00FB FF20 Monitor Stack (Growing downward)
4498 0x00FB FFAC Board Info Data and permanent copy of global data
4499 0x00FC 0000 Malloc Arena
4500 :
4501 0x00FD FFFF
4502 0x00FE 0000 RAM Copy of Monitor Code
4503 ... eventually: LCD or video framebuffer
4504 ... eventually: pRAM (Protected RAM - unchanged by reset)
4505 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004506
wdenkc6097192002-11-03 00:24:07 +00004507
wdenk6c59edc2004-05-03 20:45:30 +00004508System Initialization:
4509----------------------
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004512(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004513configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00004514To be able to re-map memory U-Boot then jumps to its link address.
4515To be able to implement the initialization code in C, a (small!)
4516initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02004517which provide such a feature like), or in a locked part of the data
4518cache. After that, U-Boot initializes the CPU core, the caches and
4519the SIU.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk6c59edc2004-05-03 20:45:30 +00004521Next, all (potentially) available memory banks are mapped using a
4522preliminary mapping. For example, we put them on 512 MB boundaries
4523(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4524on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4525programmed for SDRAM access. Using the temporary configuration, a
4526simple memory test is run that determines the size of the SDRAM
4527banks.
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529When there is more than one SDRAM bank, and the banks are of
4530different size, the largest is mapped first. For equal size, the first
4531bank (CS2#) is mapped first. The first mapping is always for address
45320x00000000, with any additional banks following immediately to create
4533contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535Then, the monitor installs itself at the upper end of the SDRAM area
4536and allocates memory for use by malloc() and for the global Board
4537Info data; also, the exception vector code is copied to the low RAM
4538pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540Only after this relocation will you have a "normal" C environment;
4541until that you are restricted in several ways, mostly because you are
4542running from ROM, and because the code will have to be relocated to a
4543new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004544
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk6c59edc2004-05-03 20:45:30 +00004546U-Boot Porting Guide:
4547----------------------
wdenkc6097192002-11-03 00:24:07 +00004548
wdenk6c59edc2004-05-03 20:45:30 +00004549[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4550list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004551
wdenkc6097192002-11-03 00:24:07 +00004552
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004553int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004554{
4555 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004556
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004557 signal(SIGALRM, no_more_time);
4558 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk6c59edc2004-05-03 20:45:30 +00004560 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004561 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004562 return 0;
4563 }
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004566
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004567 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004568
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004569 if (clueless)
4570 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572 while (learning) {
4573 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004574 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01004575 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00004576 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004577 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004578 }
wdenkc6097192002-11-03 00:24:07 +00004579
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004580 if (available_money > toLocalCurrency ($2500))
4581 Buy a BDI3000;
4582 else
wdenk6c59edc2004-05-03 20:45:30 +00004583 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004584
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004585 if (a similar board exists) { /* hopefully... */
4586 cp -a board/<similar> board/<myboard>
4587 cp include/configs/<similar>.h include/configs/<myboard>.h
4588 } else {
4589 Create your own board support subdirectory;
4590 Create your own board include/configs/<myboard>.h file;
4591 }
4592 Edit new board/<myboard> files
4593 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004594
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004595 while (!accepted) {
4596 while (!running) {
4597 do {
4598 Add / modify source code;
4599 } until (compiles);
4600 Debug;
4601 if (clueless)
4602 email("Hi, I am having problems...");
4603 }
4604 Send patch file to the U-Boot email list;
4605 if (reasonable critiques)
4606 Incorporate improvements from email list code review;
4607 else
4608 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004609 }
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611 return 0;
4612}
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614void no_more_time (int sig)
4615{
4616 hire_a_guru();
4617}
wdenkc6097192002-11-03 00:24:07 +00004618
wdenkc6097192002-11-03 00:24:07 +00004619
wdenk6c59edc2004-05-03 20:45:30 +00004620Coding Standards:
4621-----------------
wdenkc6097192002-11-03 00:24:07 +00004622
wdenk6c59edc2004-05-03 20:45:30 +00004623All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02004624coding style; see the kernel coding style guide at
4625https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4626script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004627
4628Source files originating from a different project (for example the
4629MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004630reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02004631sources.
wdenkc6097192002-11-03 00:24:07 +00004632
Detlev Zundelaa63d482006-09-01 15:39:02 +02004633Please note that U-Boot is implemented in C (and to some small parts in
4634Assembler); no C++ is used, so please do not use C++ style comments (//)
4635in your code.
wdenkad276f22004-01-04 16:28:35 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637Please also stick to the following formatting rules:
4638- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004639- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004640- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004641- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004642- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004643
wdenk6c59edc2004-05-03 20:45:30 +00004644Submissions which do not conform to the standards may be returned
4645with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004646
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk6c59edc2004-05-03 20:45:30 +00004648Submitting Patches:
4649-------------------
wdenkc6097192002-11-03 00:24:07 +00004650
wdenk6c59edc2004-05-03 20:45:30 +00004651Since the number of patches for U-Boot is growing, we need to
4652establish some rules. Submissions which do not conform to these rules
4653may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004654
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004655Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004656
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004657Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08004658see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004659
wdenk6c59edc2004-05-03 20:45:30 +00004660When you send a patch, please include the following information with
4661it:
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk6c59edc2004-05-03 20:45:30 +00004663* For bug fixes: a description of the bug and how your patch fixes
4664 this bug. Please try to include a way of demonstrating that the
4665 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004666
wdenk6c59edc2004-05-03 20:45:30 +00004667* For new features: a description of the feature and your
4668 implementation.
wdenkc6097192002-11-03 00:24:07 +00004669
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05004670* For major contributions, add a MAINTAINERS file with your
4671 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00004672
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02004673* When you add support for a new board, don't forget to add a
4674 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676* If your patch adds new configuration options, don't forget to
4677 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004678
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004679* The patch itself. If you are using git (which is *strongly*
4680 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004681 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004682 the U-Boot mailing list, you will avoid most of the common problems
4683 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004684
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004685 If you cannot use git, use "diff -purN OLD NEW". If your version of
4686 diff does not support these options, then get the latest version of
4687 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004688
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004689 The current directory when running this command shall be the parent
4690 directory of the U-Boot source tree (i. e. please make sure that
4691 your patch includes sufficient directory information for the
4692 affected files).
4693
4694 We prefer patches as plain text. MIME attachments are discouraged,
4695 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004696
wdenk6c59edc2004-05-03 20:45:30 +00004697* If one logical set of modifications affects or creates several
4698 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700* Changesets that contain different, unrelated modifications shall be
4701 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004702
wdenkc6097192002-11-03 00:24:07 +00004703
wdenk6c59edc2004-05-03 20:45:30 +00004704Notes:
wdenkc6097192002-11-03 00:24:07 +00004705
Simon Glassdc27def2016-07-27 20:33:08 -06004706* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00004707 source tree and make sure that no errors or warnings are reported
4708 for any of the boards.
4709
4710* Keep your modifications to the necessary minimum: A patch
4711 containing several unrelated changes or arbitrary reformats will be
4712 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714* If you modify existing code, make sure that your new code does not
4715 add to the memory footprint of the code ;-) Small is beautiful!
4716 When adding new features, these should compile conditionally only
4717 (using #ifdef), and the resulting code with the new feature
4718 disabled must not need more memory than the old code without your
4719 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004720
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004721* Remember that there is a size limit of 100 kB per message on the
4722 u-boot mailing list. Bigger patches will be moderated. If they are
4723 reasonable and not too big, they will be acknowledged. But patches
4724 bigger than the size limit should be avoided.