blob: 0e37358af1cec6222b5c6a2b0799f0bd5a3debc6 [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.
Naoki Hayama2bc50c22020-10-08 13:16:18 +090054Please see https://lists.denx.de/pipermail/u-boot and
55https://marc.info/?l=u-boot
wdenkc6097192002-11-03 00:24:07 +000056
Wolfgang Denkb240aef2008-03-26 10:40:12 +010057Where to get source code:
58=========================
59
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050060The U-Boot source code is maintained in the Git repository at
Heinrich Schuchardt28b2b852021-02-24 13:19:04 +010061https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://source.denx.de/u-boot/u-boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +010063
Naoki Hayama65ae68a2020-10-08 13:16:25 +090064The "Tags" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020065any version you might be interested in. Official releases are also
Naoki Hayama65ae68a2020-10-08 13:16:25 +090066available from the DENX file server through HTTPS or FTP.
67https://ftp.denx.de/pub/u-boot/
68ftp://ftp.denx.de/pub/u-boot/
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069
70
wdenkc6097192002-11-03 00:24:07 +000071Where we come from:
72===================
73
74- start from 8xxrom sources
Naoki Hayamae0cc1852020-10-08 13:17:16 +090075- create PPCBoot project (https://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000076- clean up code
77- make it easier to add custom boards
78- make it possible to add other [PowerPC] CPUs
79- extend functions, especially:
80 * Provide extended interface to Linux boot loader
81 * S-Record download
82 * network boot
Simon Glassaaef3bf2019-08-01 09:47:14 -060083 * ATA disk / SCSI ... boot
Naoki Hayamae0cc1852020-10-08 13:17:16 +090084- create ARMBoot project (https://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000085- add other CPU families (starting with ARM)
Naoki Hayamae0cc1852020-10-08 13:17:16 +090086- create U-Boot project (https://sourceforge.net/projects/u-boot)
87- current project page: see https://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000088
89
90Names and Spelling:
91===================
92
93The "official" name of this project is "Das U-Boot". The spelling
94"U-Boot" shall be used in all written text (documentation, comments
95in source files etc.). Example:
96
97 This is the README file for the U-Boot project.
98
99File names etc. shall be based on the string "u-boot". Examples:
100
101 include/asm-ppc/u-boot.h
102
103 #include <asm/u-boot.h>
104
105Variable names, preprocessor constants etc. shall be either based on
106the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000107
wdenk24ee89b2002-11-03 17:56:27 +0000108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
110
wdenkc6097192002-11-03 00:24:07 +0000111
wdenk7474aca2002-12-17 17:55:09 +0000112Versioning:
113===========
114
Thomas Webere89e6282010-09-28 08:06:25 +0200115Starting with the release in October 2008, the names of the releases
116were changed from numerical release numbers without deeper meaning
117into a time stamp based numbering. Regular releases are identified by
118names consisting of the calendar year and month of the release date.
119Additional fields (if present) indicate release candidates or bug fix
120releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000121
Thomas Webere89e6282010-09-28 08:06:25 +0200122Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000123 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000126
127
wdenkc6097192002-11-03 00:24:07 +0000128Directory Hierarchy:
129====================
130
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600131/arch Architecture-specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900132 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500133 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500135 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000137 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /nios2 Files generic to Altera NIOS2 architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200139 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800140 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500141 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400143 /x86 Files generic to x86 architecture
Naoki Hayama411f5c62020-10-08 13:16:38 +0900144 /xtensa Files generic to Xtensa architecture
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600145/api Machine/arch-independent API for external apps
146/board Board-dependent files
Simon Glass91944df2021-10-14 12:47:54 -0600147/boot Support for images and booting
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800148/cmd U-Boot commands functions
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600149/common Misc architecture-independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500150/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/disk Code for disk drive partition handling
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600152/doc Documentation (a mix of ReST and READMEs)
153/drivers Device drivers
154/dts Makefile for building internal U-Boot fdt.
155/env Environment support
Peter Tysere4d1abc2010-04-12 22:28:21 -0500156/examples Example code for standalone applications, etc.
157/fs Filesystem code (cramfs, ext2, jffs2, etc.)
158/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500159/lib Library routines generic to all architectures
160/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500161/net Networking code
162/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500163/scripts Various build scripts and Makefiles
164/test Various unit test files
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600165/tools Tools to build and sign FIT images, etc.
wdenkc6097192002-11-03 00:24:07 +0000166
wdenkc6097192002-11-03 00:24:07 +0000167Software Configuration:
168=======================
169
170Configuration is usually done using C preprocessor defines; the
171rationale behind that is to avoid dead code whenever possible.
172
173There are two classes of configuration variables:
174
175* Configuration _OPTIONS_:
176 These are selectable by the user and have names beginning with
177 "CONFIG_".
178
179* Configuration _SETTINGS_:
180 These depend on the hardware etc. and should not be meddled with if
181 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200182 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000183
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500184Previously, all configuration was done by hand, which involved creating
185symbolic links and editing configuration files manually. More recently,
186U-Boot has added the Kbuild infrastructure used by the Linux kernel,
187allowing you to use the "make menuconfig" command to configure your
188build.
wdenkc6097192002-11-03 00:24:07 +0000189
190
191Selection of Processor Architecture and Board Type:
192---------------------------------------------------
193
194For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200195configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000196
197Example: For a TQM823L module type:
198
199 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200200 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000201
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500202Note: If you're looking for the default configuration file for a board
203you're sure used to be there but is now missing, check the file
204doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000205
Simon Glass53552c92014-03-22 17:12:59 -0600206Sandbox Environment:
207--------------------
208
209U-Boot can be built natively to run on a Linux host using the 'sandbox'
210board. This allows feature development which is not board- or architecture-
211specific to be undertaken on a native platform. The sandbox is also used to
212run some of U-Boot's tests.
213
Naoki Hayamadd860ca2020-10-08 13:16:58 +0900214See doc/arch/sandbox.rst for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600215
216
Simon Glassd8711af2015-03-03 08:03:00 -0700217Board Initialisation Flow:
218--------------------------
219
220This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500221SPL and U-Boot proper (i.e. they both follow the same rules).
222
223Note: "SPL" stands for "Secondary Program Loader," which is explained in
224more detail later in this file.
225
226At present, SPL mostly uses a separate code path, but the function names
227and roles of each function are the same. Some boards or architectures
228may not conform to this. At least most ARM boards which use
229CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700230
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500231Execution typically starts with an architecture-specific (and possibly
232CPU-specific) start.S file, such as:
233
234 - arch/arm/cpu/armv7/start.S
235 - arch/powerpc/cpu/mpc83xx/start.S
236 - arch/mips/cpu/start.S
237
238and so on. From there, three functions are called; the purpose and
239limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700240
241lowlevel_init():
242 - purpose: essential init to permit execution to reach board_init_f()
243 - no global_data or BSS
244 - there is no stack (ARMv7 may have one but it will soon be removed)
245 - must not set up SDRAM or use console
246 - must only do the bare minimum to allow execution to continue to
247 board_init_f()
248 - this is almost never needed
249 - return normally from this function
250
251board_init_f():
252 - purpose: set up the machine ready for running board_init_r():
253 i.e. SDRAM and serial UART
254 - global_data is available
255 - stack is in SRAM
256 - BSS is not available, so you cannot use global/static variables,
257 only stack variables and global_data
258
259 Non-SPL-specific notes:
260 - dram_init() is called to set up DRAM. If already done in SPL this
261 can do nothing
262
263 SPL-specific notes:
264 - you can override the entire board_init_f() function with your own
265 version as needed.
266 - preloader_console_init() can be called here in extremis
267 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayamaebfd8192020-09-24 15:57:19 +0900268 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg7673bed2019-08-08 12:54:49 -0500269 - for specific scenarios on certain architectures an early BSS *can*
270 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
271 of BSS prior to entering board_init_f()) but doing so is discouraged.
272 Instead it is strongly recommended to architect any code changes
273 or additions such to not depend on the availability of BSS during
274 board_init_f() as indicated in other sections of this README to
275 maintain compatibility and consistency across the entire code base.
Simon Glassd8711af2015-03-03 08:03:00 -0700276 - must return normally from this function (don't call board_init_r()
277 directly)
278
279Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
280this point the stack and global_data are relocated to below
281CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
282memory.
283
284board_init_r():
285 - purpose: main execution, common code
286 - global_data is available
287 - SDRAM is available
288 - BSS is available, all static/global variables can be used
289 - execution eventually continues to main_loop()
290
291 Non-SPL-specific notes:
292 - U-Boot is relocated to the top of memory and is now running from
293 there.
294
295 SPL-specific notes:
296 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
297 CONFIG_SPL_STACK_R_ADDR points into SDRAM
298 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800299 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700300 spl_board_init() function containing this call
301 - loads U-Boot or (in falcon mode) Linux
302
303
wdenkc6097192002-11-03 00:24:07 +0000304Configuration Options:
305----------------------
306
307Configuration depends on the combination of board and CPU type; all
308such information is kept in a configuration file
309"include/configs/<board_name>.h".
310
311Example: For a TQM823L module, all configuration settings are in
312"include/configs/TQM823L.h".
313
314
wdenk1272e232002-11-10 22:06:23 +0000315Many of the options are named exactly as the corresponding Linux
316kernel configuration options. The intention is to make it easier to
317build a config tool - later.
318
Ashish Kumar11234062017-08-11 11:09:14 +0530319- ARM Platform Bus Type(CCI):
320 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321 provides full cache coherency between two clusters of multi-core
322 CPUs and I/O coherency for devices and I/O masters
323
324 CONFIG_SYS_FSL_HAS_CCI400
325
326 Defined For SoC that has cache coherent interconnect
327 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000328
Ashish Kumar97393d62017-08-18 10:54:36 +0530329 CONFIG_SYS_FSL_HAS_CCN504
330
331 Defined for SoC that has cache coherent interconnect CCN-504
332
wdenkc6097192002-11-03 00:24:07 +0000333The following options need to be configured:
334
Kim Phillips203fee32007-08-10 13:28:25 -0500335- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000336
Kim Phillips203fee32007-08-10 13:28:25 -0500337- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200338
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600339- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000340 CONFIG_SYS_PPC64
341
342 Specifies that the core is a 64-bit PowerPC implementation (implements
343 the "64" category of the Power ISA). This is necessary for ePAPR
344 compliance, among other possible reasons.
345
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600346 CONFIG_SYS_FSL_TBCLK_DIV
347
348 Defines the core time base clock divider ratio compared to the
349 system clock. On most PQ3 devices this is 8, on newer QorIQ
350 devices it can be 16 or 32. The ratio varies from SoC to Soc.
351
Kumar Gala179b1b22011-05-20 00:39:21 -0500352 CONFIG_SYS_FSL_PCIE_COMPAT
353
354 Defines the string to utilize when trying to match PCIe device
355 tree nodes for the given platform.
356
Scott Wood80806962012-08-14 10:14:53 +0000357 CONFIG_SYS_FSL_ERRATUM_A004510
358
359 Enables a workaround for erratum A004510. If set,
360 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
362
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
365
366 Defines one or two SoC revisions (low 8 bits of SVR)
367 for which the A004510 workaround should be applied.
368
369 The rest of SVR is either not relevant to the decision
370 of whether the erratum is present (e.g. p2040 versus
371 p2041) or is implied by the build target, which controls
372 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
373
374 See Freescale App Note 4493 for more information about
375 this erratum.
376
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530377 CONFIG_A003399_NOR_WORKAROUND
378 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800379 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530380
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530381 CONFIG_A008044_WORKAROUND
382 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800383 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530384
Scott Wood80806962012-08-14 10:14:53 +0000385 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
386
387 This is the value to write into CCSR offset 0x18600
388 according to the A004510 workaround.
389
Priyanka Jainc73b9032013-07-02 09:21:04 +0530390 CONFIG_SYS_FSL_DSP_DDR_ADDR
391 This value denotes start offset of DDR memory which is
392 connected exclusively to the DSP cores.
393
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
395 This value denotes start offset of M2 memory
396 which is directly connected to the DSP core.
397
Priyanka Jainc73b9032013-07-02 09:21:04 +0530398 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
399 This value denotes start offset of M3 memory which is directly
400 connected to the DSP core.
401
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530402 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
403 This value denotes start offset of DSP CCSR space.
404
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530405 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
406 Single Source Clock is clocking mode present in some of FSL SoC's.
407 In this mode, a single differential clock is used to supply
408 clocks to the sysclock, ddrclock and usbclock.
409
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530410 CONFIG_SYS_CPC_REINIT_F
411 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800412 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530413
Tang Yuantiana7364af2014-04-17 15:33:46 +0800414 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800415 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800416 supported, core will start to execute uboot when wakes up.
417
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000418- Generic CPU options:
419 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
420
421 Defines the endianess of the CPU. Implementation of those
422 values is arch specific.
423
York Sunf0626592013-09-30 09:22:09 -0700424 CONFIG_SYS_FSL_DDR
425 Freescale DDR driver in use. This type of DDR controller is
Tom Rinie5404982021-05-14 21:34:26 -0400426 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
York Sunf0626592013-09-30 09:22:09 -0700427
428 CONFIG_SYS_FSL_DDR_ADDR
429 Freescale DDR memory-mapped register base.
430
431 CONFIG_SYS_FSL_DDR_EMU
432 Specify emulator support for DDR. Some DDR features such as
433 deskew training are not available.
434
435 CONFIG_SYS_FSL_DDRC_GEN1
436 Freescale DDR1 controller.
437
438 CONFIG_SYS_FSL_DDRC_GEN2
439 Freescale DDR2 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN3
442 Freescale DDR3 controller.
443
York Sun2896cb72014-03-27 17:54:47 -0700444 CONFIG_SYS_FSL_DDRC_GEN4
445 Freescale DDR4 controller.
446
York Sun461c9392013-09-30 14:20:51 -0700447 CONFIG_SYS_FSL_DDRC_ARM_GEN3
448 Freescale DDR3 controller for ARM-based SoCs.
449
York Sunf0626592013-09-30 09:22:09 -0700450 CONFIG_SYS_FSL_DDR1
451 Board config to use DDR1. It can be enabled for SoCs with
452 Freescale DDR1 or DDR2 controllers, depending on the board
453 implemetation.
454
455 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400456 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700457 Freescale DDR2 or DDR3 controllers, depending on the board
458 implementation.
459
460 CONFIG_SYS_FSL_DDR3
461 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700462 Freescale DDR3 or DDR3L controllers.
463
464 CONFIG_SYS_FSL_DDR3L
465 Board config to use DDR3L. It can be enabled for SoCs with
466 DDR3L controllers.
467
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530468 CONFIG_SYS_FSL_IFC_BE
469 Defines the IFC controller register space as Big Endian
470
471 CONFIG_SYS_FSL_IFC_LE
472 Defines the IFC controller register space as Little Endian
473
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530474 CONFIG_SYS_FSL_IFC_CLK_DIV
475 Defines divider of platform clock(clock input to IFC controller).
476
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530477 CONFIG_SYS_FSL_LBC_CLK_DIV
478 Defines divider of platform clock(clock input to eLBC controller).
479
York Sun29647ab2014-02-10 13:59:42 -0800480 CONFIG_SYS_FSL_DDR_BE
481 Defines the DDR controller register space as Big Endian
482
483 CONFIG_SYS_FSL_DDR_LE
484 Defines the DDR controller register space as Little Endian
485
York Sun3a0916d2014-02-10 13:59:43 -0800486 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
487 Physical address from the view of DDR controllers. It is the
488 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
489 it could be different for ARM SoCs.
490
York Sunc459ae62014-02-10 13:59:44 -0800491 CONFIG_SYS_FSL_DDR_INTLV_256B
492 DDR controller interleaving on 256-byte. This is a special
493 interleaving mode, handled by Dickens for Freescale layerscape
494 SoCs with ARM core.
495
York Sun79a779b2014-08-01 15:51:00 -0700496 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
497 Number of controllers used as main memory.
498
499 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
500 Number of controllers used for other than main memory.
501
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530502 CONFIG_SYS_FSL_HAS_DP_DDR
503 Defines the SoC has DP-DDR used for DPAA.
504
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530505 CONFIG_SYS_FSL_SEC_BE
506 Defines the SEC controller register space as Big Endian
507
508 CONFIG_SYS_FSL_SEC_LE
509 Defines the SEC controller register space as Little Endian
510
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200511- MIPS CPU options:
512 CONFIG_SYS_INIT_SP_OFFSET
513
514 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
515 pointer. This is needed for the temporary stack before
516 relocation.
517
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200518 CONFIG_XWAY_SWAP_BYTES
519
520 Enable compilation of tools/xway-swap-bytes needed for Lantiq
521 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
522 be swapped if a flash programmer is used.
523
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000524- ARM options:
525 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
526
527 Select high exception vectors of the ARM core, e.g., do not
528 clear the V bit of the c1 register of CP15.
529
York Sun77a10972015-03-20 19:28:08 -0700530 COUNTER_FREQUENCY
531 Generic timer clock source frequency.
532
533 COUNTER_FREQUENCY_REAL
534 Generic timer clock source frequency if the real clock is
535 different from COUNTER_FREQUENCY, and can only be determined
536 at run time.
537
Stephen Warren8d1fb312015-01-19 16:25:52 -0700538- Tegra SoC options:
539 CONFIG_TEGRA_SUPPORT_NON_SECURE
540
541 Support executing U-Boot in non-secure (NS) mode. Certain
542 impossible actions will be skipped if the CPU is in NS mode,
543 such as ARM architectural timer initialization.
544
wdenk9b7f3842003-10-09 20:09:04 +0000545- Linux Kernel Interface:
wdenk9b7f3842003-10-09 20:09:04 +0000546 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
547
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800548 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000549 expect it to be in bytes, others in MB.
550 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
551
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400552 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200553
554 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400555 passed using flattened device trees (based on open firmware
556 concepts).
557
558 CONFIG_OF_LIBFDT
559 * New libfdt-based support
560 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500561 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400562
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200563 OF_TBCLK - The timebase frequency.
564
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200565 boards with QUICC Engines require OF_QE to set UCC MAC
566 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500567
Kumar Gala1e26aa52006-01-11 13:54:17 -0600568 CONFIG_OF_BOARD_SETUP
569
570 Board code has addition modification that it wants to make
571 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000572
Simon Glass6c0be912014-10-23 18:58:54 -0600573 CONFIG_OF_SYSTEM_SETUP
574
575 Other code has addition modification that it wants to make
576 to the flat device tree before handing it off to the kernel.
577 This causes ft_system_setup() to be called before booting
578 the kernel.
579
Heiko Schocherffb293a2009-09-23 07:56:08 +0200580 CONFIG_OF_IDE_FIXUP
581
582 U-Boot can detect if an IDE device is present or not.
583 If not, and this new config option is activated, U-Boot
584 removes the ATA node from the DTS before booting Linux,
585 so the Linux IDE driver does not probe the device and
586 crash. This is needed for buggy hardware (uc101) where
587 no pull down resistor is connected to the signal IDE5V_DD7.
588
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100589- vxWorks boot parameters:
590
591 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700592 environments variables: bootdev, bootfile, ipaddr, netmask,
593 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100594 It loads the vxWorks image pointed bootfile.
595
Naoki Hayama158c2262020-10-08 13:17:08 +0900596 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100597 the defaults discussed just above.
598
Aneesh V960f5c02011-06-16 23:30:47 +0000599- Cache Configuration:
Aneesh V960f5c02011-06-16 23:30:47 +0000600 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
601
Aneesh V686a0752011-06-16 23:30:51 +0000602- Cache Configuration for ARM:
603 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
604 controller
605 CONFIG_SYS_PL310_BASE - Physical base address of PL310
606 controller register space
607
wdenkda04a8b2004-08-02 23:22:59 +0000608- Serial Ports:
wdenkda04a8b2004-08-02 23:22:59 +0000609 CONFIG_PL011_CLOCK
610
611 If you have Amba PrimeCell PL011 UARTs, set this variable to
612 the clock speed of the UARTs.
613
614 CONFIG_PL01x_PORTS
615
616 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
617 define this to a list of base addresses for each (supported)
618 port. See e.g. include/configs/versatile.h
619
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400620 CONFIG_SERIAL_HW_FLOW_CONTROL
621
622 Define this variable to enable hw flow control in serial driver.
623 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000624
wdenkc6097192002-11-03 00:24:07 +0000625- Autoboot Command:
626 CONFIG_BOOTCOMMAND
627 Only needed when CONFIG_BOOTDELAY is enabled;
628 define a command string that is automatically executed
629 when no character is read on the console interface
630 within "Boot Delay" after reset.
631
wdenkc6097192002-11-03 00:24:07 +0000632 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000633 The value of these goes into the environment as
634 "ramboot" and "nfsboot" respectively, and can be used
635 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200636 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000637
wdenkc6097192002-11-03 00:24:07 +0000638- Serial Download Echo Mode:
639 CONFIG_LOADS_ECHO
640 If defined to 1, all characters received during a
641 serial download (using the "loads" command) are
642 echoed back. This might be needed by some terminal
643 emulations (like "cu"), but may as well just take
644 time on others. This setting #define's the initial
645 value of the "loads_echo" environment variable.
646
Simon Glassaa34ef22016-03-13 19:07:28 -0600647- Removal of commands
648 If no commands are needed to boot, you can disable
649 CONFIG_CMDLINE to remove them. In this case, the command line
650 will not be available, and when U-Boot wants to execute the
651 boot command (on start-up) it will call board_run_command()
652 instead. This can reduce image size significantly for very
653 simple boot procedures.
654
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000655- Regular expression support:
656 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200657 If this variable is defined, U-Boot is linked against
658 the SLRE (Super Light Regular Expression) library,
659 which adds regex support to some commands, as for
660 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000661
Simon Glass3d686442011-10-15 05:48:20 +0000662- Device tree:
663 CONFIG_OF_CONTROL
664 If this variable is defined, U-Boot will use a device tree
665 to configure its devices, instead of relying on statically
666 compiled #defines in the board file. This option is
667 experimental and only available on a few boards. The device
668 tree is available in the global data as gd->fdt_blob.
669
Simon Glass5cb34db2011-10-24 19:15:31 +0000670 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700671 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000672
Simon Glass5cb34db2011-10-24 19:15:31 +0000673 CONFIG_OF_SEPARATE
674 If this variable is defined, U-Boot will build a device tree
675 binary. It will be called u-boot.dtb. Architecture-specific
676 code will locate it at run-time. Generally this works by:
677
678 cat u-boot.bin u-boot.dtb >image.bin
679
680 and in fact, U-Boot does this for you, creating a file called
681 u-boot-dtb.bin which is useful in the common case. You can
682 still use the individual files if you need something more
683 exotic.
684
Alex Deymo5b661ec2017-04-02 01:25:20 -0700685 CONFIG_OF_BOARD
686 If this variable is defined, U-Boot will use the device tree
687 provided by the board at runtime instead of embedding one with
688 the image. Only boards defining board_fdt_blob_setup() support
689 this option (see include/fdtdec.h file).
690
wdenkc6097192002-11-03 00:24:07 +0000691- Watchdog:
692 CONFIG_WATCHDOG
693 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000694 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200695 specific code for a watchdog. For the 8xx
696 CPUs, the SIU Watchdog feature is enabled in the SYPCR
697 register. When supported for a specific SoC is
698 available, then no further board specific code should
699 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000700
701 CONFIG_HW_WATCHDOG
702 When using a watchdog circuitry external to the used
703 SoC, then define this variable and provide board
704 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000705
Rasmus Villemoes134cc2b2021-04-14 09:18:22 +0200706 CONFIG_SYS_WATCHDOG_FREQ
707 Some platforms automatically call WATCHDOG_RESET()
708 from the timer interrupt handler every
709 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
710 board configuration file, a default of CONFIG_SYS_HZ/2
711 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
712 to 0 disables calling WATCHDOG_RESET() from the timer
713 interrupt.
714
wdenkc6097192002-11-03 00:24:07 +0000715- Real-Time Clock:
716
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500717 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000718 has to be selected, too. Define exactly one of the
719 following options:
720
wdenkc6097192002-11-03 00:24:07 +0000721 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000722 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000723 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000724 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000725 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000726 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200727 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000728 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100729 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000730 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200731 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200732 CONFIG_SYS_RV3029_TCR - enable trickle charger on
733 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000734
wdenkb9bbd242003-06-30 16:24:52 +0000735 Note that if the RTC uses I2C, then the I2C interface
736 must also be configured. See I2C Support, below.
737
Peter Tyser9902e422008-12-17 16:36:21 -0600738- GPIO Support:
739 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600740
Chris Packham9b383202010-12-19 10:12:13 +0000741 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
742 chip-ngpio pairs that tell the PCA953X driver the number of
743 pins supported by a particular chip.
744
Peter Tyser9902e422008-12-17 16:36:21 -0600745 Note that if the GPIO device uses I2C, then the I2C interface
746 must also be configured. See I2C Support, below.
747
Simon Glass4dc47ca2014-06-11 23:29:41 -0600748- I/O tracing:
749 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
750 accesses and can checksum them or write a list of them out
751 to memory. See the 'iotrace' command for details. This is
752 useful for testing device drivers since it can confirm that
753 the driver behaves the same way before and after a code
754 change. Currently this is supported on sandbox and arm. To
755 add support for your architecture, add '#include <iotrace.h>'
756 to the bottom of arch/<arch>/include/asm/io.h and test.
757
758 Example output from the 'iotrace stats' command is below.
759 Note that if the trace buffer is exhausted, the checksum will
760 still continue to operate.
761
762 iotrace is enabled
763 Start: 10000000 (buffer start address)
764 Size: 00010000 (buffer size)
765 Offset: 00000120 (current buffer offset)
766 Output: 10000120 (start + offset)
767 Count: 00000018 (number of trace records)
768 CRC32: 9526fb66 (CRC32 of all trace records)
769
wdenkc6097192002-11-03 00:24:07 +0000770- Timestamp Support:
771
wdenk4a5c8a72003-03-06 00:02:04 +0000772 When CONFIG_TIMESTAMP is selected, the timestamp
773 (date and time) of an image is printed by image
774 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500775 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000776
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000777- Partition Labels (disklabels) Supported:
778 Zero or more of the following:
779 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000780 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
781 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
782 bootloader. Note 2TB partition limit; see
783 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600784 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000785 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000786
787- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000788 CONFIG_IDE_RESET_ROUTINE - this is defined in several
789 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000790
wdenk369d43d2004-03-14 14:09:05 +0000791 CONFIG_IDE_RESET - is this is defined, IDE Reset will
792 be performed by calling the function
793 ide_set_reset(int reset)
794 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000795
796- ATAPI Support:
797 CONFIG_ATAPI
798
799 Set this to enable ATAPI support.
800
wdenkf602aa02004-03-13 23:29:43 +0000801- LBA48 Support
802 CONFIG_LBA48
803
804 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100805 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000806 Whithout these , LBA48 support uses 32bit variables and will 'only'
807 support disks up to 2.1TB.
808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200809 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000810 When enabled, makes the IDE subsystem use 64bit sector addresses.
811 Default is 32bit.
812
wdenkc6097192002-11-03 00:24:07 +0000813- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200814 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
815 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
816 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000817 maximum numbers of LUNs, SCSI ID's and target
818 devices.
wdenkc6097192002-11-03 00:24:07 +0000819
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200820 The environment variable 'scsidevs' is set to the number of
821 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000822
wdenkc6097192002-11-03 00:24:07 +0000823- NETWORK Support (PCI):
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000824 CONFIG_E1000_SPI
825 Utility code for direct access to the SPI bus on Intel 8257x.
826 This does not do anything useful unless you set at least one
827 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
828
wdenkc6097192002-11-03 00:24:07 +0000829 CONFIG_NATSEMI
830 Support for National dp83815 chips.
831
832 CONFIG_NS8382X
833 Support for National dp8382[01] gigabit chips.
834
wdenkaa603362003-05-12 21:50:16 +0000835- NETWORK Support (other):
Rob Herringc9830dc2011-12-15 11:15:49 +0000836 CONFIG_CALXEDA_XGMAC
837 Support for the Calxeda XGMAC device
838
Ashok93fb8722012-10-15 06:20:47 +0000839 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000840 Support for SMSC's LAN91C96 chips.
841
wdenkaa603362003-05-12 21:50:16 +0000842 CONFIG_LAN91C96_USE_32_BIT
843 Define this to enable 32 bit addressing
844
Ashok93fb8722012-10-15 06:20:47 +0000845 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000846 Support for SMSC's LAN91C111 chip
847
848 CONFIG_SMC91111_BASE
849 Define this to hold the physical address
850 of the device (I/O space)
851
852 CONFIG_SMC_USE_32_BIT
853 Define this if data bus is 32 bits
854
855 CONFIG_SMC_USE_IOFUNCS
856 Define this to use i/o functions instead of macros
857 (some hardware wont work with macros)
858
Heiko Schocher7d037f72011-11-15 10:00:04 -0500859 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
860 Define this if you have more then 3 PHYs.
861
Macpaul Lin199c6252010-12-21 16:59:46 +0800862 CONFIG_FTGMAC100
863 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
864
865 CONFIG_FTGMAC100_EGIGA
866 Define this to use GE link update with gigabit PHY.
867 Define this if FTGMAC100 is connected to gigabit PHY.
868 If your system has 10/100 PHY only, it might not occur
869 wrong behavior. Because PHY usually return timeout or
870 useless data when polling gigabit status and gigabit
871 control registers. This behavior won't affect the
872 correctnessof 10/100 link speed update.
873
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900874 CONFIG_SH_ETHER
875 Support for Renesas on-chip Ethernet controller
876
877 CONFIG_SH_ETHER_USE_PORT
878 Define the number of ports to be used
879
880 CONFIG_SH_ETHER_PHY_ADDR
881 Define the ETH PHY's address
882
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900883 CONFIG_SH_ETHER_CACHE_WRITEBACK
884 If this option is set, the driver enables cache flush.
885
Vadim Bendeburydac69642011-10-17 08:36:14 +0000886- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000887 CONFIG_TPM
888 Support TPM devices.
889
Christophe Ricard8759ff82015-10-06 22:54:41 +0200890 CONFIG_TPM_TIS_INFINEON
891 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000892 per system is supported at this time.
893
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000894 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
895 Define the burst count bytes upper limit
896
Christophe Ricard88249232016-01-21 23:27:13 +0100897 CONFIG_TPM_ST33ZP24
898 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
899
900 CONFIG_TPM_ST33ZP24_I2C
901 Support for STMicroelectronics ST33ZP24 I2C devices.
902 Requires TPM_ST33ZP24 and I2C.
903
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100904 CONFIG_TPM_ST33ZP24_SPI
905 Support for STMicroelectronics ST33ZP24 SPI devices.
906 Requires TPM_ST33ZP24 and SPI.
907
Dirk Eibach20489092013-06-26 15:55:15 +0200908 CONFIG_TPM_ATMEL_TWI
909 Support for Atmel TWI TPM device. Requires I2C support.
910
Che-liang Chiouacea5702013-04-12 11:04:34 +0000911 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000912 Support for generic parallel port TPM devices. Only one device
913 per system is supported at this time.
914
915 CONFIG_TPM_TIS_BASE_ADDRESS
916 Base address where the generic TPM device is mapped
917 to. Contemporary x86 systems usually map it at
918 0xfed40000.
919
Reinhard Pfau4fece432013-06-26 15:55:13 +0200920 CONFIG_TPM
921 Define this to enable the TPM support library which provides
922 functional interfaces to some TPM commands.
923 Requires support for a TPM device.
924
925 CONFIG_TPM_AUTH_SESSIONS
926 Define this to enable authorized functions in the TPM library.
927 Requires CONFIG_TPM and CONFIG_SHA1.
928
wdenkc6097192002-11-03 00:24:07 +0000929- USB Support:
930 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +0200931 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000932 CONFIG_USB_UHCI to enable it.
933 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000934 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000935 storage devices.
936 Note:
937 Supported are USB Keyboards and USB Floppy drives
938 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000939
Simon Glass5978cdb2012-02-27 10:52:47 +0000940 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
941 txfilltuning field in the EHCI controller on reset.
942
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -0700943 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
944 HW module registers.
945
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200946- USB Device:
947 Define the below if you wish to use the USB console.
948 Once firmware is rebuilt from a serial console issue the
949 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200950 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200951 it has found a new device. The environment variable usbtty
952 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200953 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200954 Common Device Class Abstract Control Model serial device.
955 If you select usbtty = gserial you should be able to enumerate
956 a Linux host by
957 # modprobe usbserial vendor=0xVendorID product=0xProductID
958 else if using cdc_acm, simply setting the environment
959 variable usbtty to be cdc_acm should suffice. The following
960 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200961
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200962 CONFIG_USB_DEVICE
963 Define this to build a UDC device
964
965 CONFIG_USB_TTY
966 Define this to have a tty type of device available to
967 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200968
Vipin KUMARbdb17702012-03-26 15:38:06 +0530969 CONFIG_USBD_HS
970 Define this to enable the high speed support for usb
971 device and usbtty. If this feature is enabled, a routine
972 int is_usbd_high_speed(void)
973 also needs to be defined by the driver to dynamically poll
974 whether the enumeration has succeded at high speed or full
975 speed.
976
Wolfgang Denke2601822006-06-14 18:14:56 +0200977 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200978 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200979 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200980 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
981 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
982 should pretend to be a Linux device to it's target host.
983
984 CONFIG_USBD_MANUFACTURER
985 Define this string as the name of your company for
986 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200987
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200988 CONFIG_USBD_PRODUCT_NAME
989 Define this string as the name of your product
990 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000991
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200992 CONFIG_USBD_VENDORID
993 Define this as your assigned Vendor ID from the USB
994 Implementors Forum. This *must* be a genuine Vendor ID
995 to avoid polluting the USB namespace.
996 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200997
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200998 CONFIG_USBD_PRODUCTID
999 Define this as the unique Product ID
1000 for your device
1001 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001002
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001003- ULPI Layer Support:
1004 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1005 the generic ULPI layer. The generic layer accesses the ULPI PHY
1006 via the platform viewport, so you need both the genric layer and
1007 the viewport enabled. Currently only Chipidea/ARC based
1008 viewport is supported.
1009 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1010 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001011 If your ULPI phy needs a different reference clock than the
1012 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1013 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001014
wdenk7a428cc2003-06-15 22:40:42 +00001015- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001016 The MMC controller on the Intel PXA is supported. To
1017 enable this define CONFIG_MMC. The MMC can be
1018 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001019 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001020 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1021 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001022
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001023 CONFIG_SH_MMCIF
1024 Support for Renesas on-chip MMCIF controller
1025
1026 CONFIG_SH_MMCIF_ADDR
1027 Define the base address of MMCIF registers
1028
1029 CONFIG_SH_MMCIF_CLK
1030 Define the clock frequency for MMCIF
1031
Tom Rini58a8d322013-03-14 05:32:47 +00001032- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001033 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001034 This enables the USB portion of the DFU USB class
1035
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001036 CONFIG_DFU_NAND
1037 This enables support for exposing NAND devices via DFU.
1038
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301039 CONFIG_DFU_RAM
1040 This enables support for exposing RAM via DFU.
1041 Note: DFU spec refer to non-volatile memory usage, but
1042 allow usages beyond the scope of spec - here RAM usage,
1043 one that would help mostly the developer.
1044
Heiko Schochera2f831e2013-06-12 06:05:51 +02001045 CONFIG_SYS_DFU_DATA_BUF_SIZE
1046 Dfu transfer uses a buffer before writing data to the
1047 raw storage device. Make the size (in bytes) of this buffer
1048 configurable. The size of this buffer is also configurable
1049 through the "dfu_bufsiz" environment variable.
1050
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001051 CONFIG_SYS_DFU_MAX_FILE_SIZE
1052 When updating files rather than the raw storage device,
1053 we use a static buffer to copy the file into and then write
1054 the buffer once we've been given the whole file. Define
1055 this to the maximum filesize (in bytes) for the buffer.
1056 Default is 4 MiB if undefined.
1057
Heiko Schochere1ba1512014-03-18 08:09:56 +01001058 DFU_DEFAULT_POLL_TIMEOUT
1059 Poll timeout [ms], is the timeout a device can send to the
1060 host. The host must wait for this timeout before sending
1061 a subsequent DFU_GET_STATUS request to the device.
1062
1063 DFU_MANIFEST_POLL_TIMEOUT
1064 Poll timeout [ms], which the device sends to the host when
1065 entering dfuMANIFEST state. Host waits this timeout, before
1066 sending again an USB request to the device.
1067
wdenkda04a8b2004-08-02 23:22:59 +00001068- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001069 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001070 Define these for a default partition on a NAND device
1071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001072 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1073 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001074 Define these for a default partition on a NOR device
1075
wdenkc6097192002-11-03 00:24:07 +00001076- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001077 See Kconfig help for available keyboard drivers.
1078
1079 CONFIG_KEYBOARD
1080
1081 Define this to enable a custom keyboard support.
1082 This simply calls drv_keyboard_init() which must be
1083 defined in your board-specific files. This option is deprecated
1084 and is only used by novena. For new boards, use driver model
1085 instead.
wdenkc6097192002-11-03 00:24:07 +00001086
1087- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001088 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001089 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001090 SOCs that have a DIU should define this macro to enable DIU
1091 support, and should also define these other macros:
1092
1093 CONFIG_SYS_DIU_ADDR
1094 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001095 CONFIG_CFB_CONSOLE
1096 CONFIG_VIDEO_SW_CURSOR
1097 CONFIG_VGA_AS_SINGLE_DEVICE
1098 CONFIG_VIDEO_LOGO
1099 CONFIG_VIDEO_BMP_LOGO
1100
Timur Tabi32f709e2011-04-11 14:18:22 -05001101 The DIU driver will look for the 'video-mode' environment
1102 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001103 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001104 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001105
wdenkc6097192002-11-03 00:24:07 +00001106- LCD Support: CONFIG_LCD
1107
1108 Define this to enable LCD support (for output to LCD
1109 display); also select one of the supported displays
1110 by defining one of these:
1111
Stelian Popf6f86652008-05-09 21:57:18 +02001112 CONFIG_ATMEL_LCD:
1113
1114 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1115
wdenkc0d54ae2003-11-25 16:55:19 +00001116 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001117
wdenkc0d54ae2003-11-25 16:55:19 +00001118 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001119
wdenkc0d54ae2003-11-25 16:55:19 +00001120 CONFIG_NEC_NL6448BC20
1121
1122 NEC NL6448BC20-08. 6.5", 640x480.
1123 Active, color, single scan.
1124
1125 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001126
wdenkc0d54ae2003-11-25 16:55:19 +00001127 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001128 Active, color, single scan.
1129
1130 CONFIG_SHARP_16x9
1131
1132 Sharp 320x240. Active, color, single scan.
1133 It isn't 16x9, and I am not sure what it is.
1134
1135 CONFIG_SHARP_LQ64D341
1136
1137 Sharp LQ64D341 display, 640x480.
1138 Active, color, single scan.
1139
1140 CONFIG_HLD1045
1141
1142 HLD1045 display, 640x480.
1143 Active, color, single scan.
1144
1145 CONFIG_OPTREX_BW
1146
1147 Optrex CBL50840-2 NF-FW 99 22 M5
1148 or
1149 Hitachi LMG6912RPFC-00T
1150 or
1151 Hitachi SP14Q002
1152
1153 320x240. Black & white.
1154
Simon Glass599a4df2012-10-17 13:24:54 +00001155 CONFIG_LCD_ALIGNMENT
1156
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001157 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001158 defined then the LCD will be aligned to this value instead.
1159 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1160 here, since it is cheaper to change data cache settings on
1161 a per-section basis.
1162
1163
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001164 CONFIG_LCD_ROTATION
1165
1166 Sometimes, for example if the display is mounted in portrait
1167 mode or even if it's mounted landscape but rotated by 180degree,
1168 we need to rotate our content of the display relative to the
1169 framebuffer, so that user can read the messages which are
1170 printed out.
1171 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1172 initialized with a given rotation from "vl_rot" out of
1173 "vidinfo_t" which is provided by the board specific code.
1174 The value for vl_rot is coded as following (matching to
1175 fbcon=rotate:<n> linux-kernel commandline):
1176 0 = no rotation respectively 0 degree
1177 1 = 90 degree rotation
1178 2 = 180 degree rotation
1179 3 = 270 degree rotation
1180
1181 If CONFIG_LCD_ROTATION is not defined, the console will be
1182 initialized with 0degree rotation.
1183
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001184 CONFIG_LCD_BMP_RLE8
1185
1186 Support drawing of RLE8-compressed bitmaps on the LCD.
1187
wdenk0e2bd9c2004-06-06 21:51:03 +00001188- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001189 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1190
1191 The clock frequency of the MII bus
1192
wdenk0e2bd9c2004-06-06 21:51:03 +00001193 CONFIG_PHY_RESET_DELAY
1194
1195 Some PHY like Intel LXT971A need extra delay after
1196 reset before any MII register access is possible.
1197 For such PHY, set this option to the usec delay
1198 required. (minimum 300usec for LXT971A)
1199
1200 CONFIG_PHY_CMD_DELAY (ppc4xx)
1201
1202 Some PHY like Intel LXT971A need extra delay after
1203 command issued before MII status register can be read
1204
wdenkc6097192002-11-03 00:24:07 +00001205- IP address:
1206 CONFIG_IPADDR
1207
1208 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001209 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001210 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001211 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001212
1213- Server IP address:
1214 CONFIG_SERVERIP
1215
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001216 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001217 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001218 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001219
Robin Getz470a6d42009-07-21 12:15:28 -04001220 CONFIG_KEEP_SERVERADDR
1221
1222 Keeps the server's MAC address, in the env 'serveraddr'
1223 for passing to bootargs (like Linux's netconsole option)
1224
Wolfgang Denk26da2992011-10-26 10:21:22 +00001225- Gateway IP address:
1226 CONFIG_GATEWAYIP
1227
1228 Defines a default value for the IP address of the
1229 default router where packets to other networks are
1230 sent to.
1231 (Environment variable "gatewayip")
1232
1233- Subnet mask:
1234 CONFIG_NETMASK
1235
1236 Defines a default value for the subnet mask (or
1237 routing prefix) which is used to determine if an IP
1238 address belongs to the local subnet or needs to be
1239 forwarded through a router.
1240 (Environment variable "netmask")
1241
wdenkc6097192002-11-03 00:24:07 +00001242- BOOTP Recovery Mode:
1243 CONFIG_BOOTP_RANDOM_DELAY
1244
1245 If you have many targets in a network that try to
1246 boot using BOOTP, you may want to avoid that all
1247 systems send out BOOTP requests at precisely the same
1248 moment (which would happen for instance at recovery
1249 from a power failure, when all systems will try to
1250 boot, thus flooding the BOOTP server. Defining
1251 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1252 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001253 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001254
1255 1st BOOTP request: delay 0 ... 1 sec
1256 2nd BOOTP request: delay 0 ... 2 sec
1257 3rd BOOTP request: delay 0 ... 4 sec
1258 4th and following
1259 BOOTP requests: delay 0 ... 8 sec
1260
Thierry Reding8977cda2014-08-19 10:21:24 +02001261 CONFIG_BOOTP_ID_CACHE_SIZE
1262
1263 BOOTP packets are uniquely identified using a 32-bit ID. The
1264 server will copy the ID from client requests to responses and
1265 U-Boot will use this to determine if it is the destination of
1266 an incoming response. Some servers will check that addresses
1267 aren't in use before handing them out (usually using an ARP
1268 ping) and therefore take up to a few hundred milliseconds to
1269 respond. Network congestion may also influence the time it
1270 takes for a response to make it back to the client. If that
1271 time is too long, U-Boot will retransmit requests. In order
1272 to allow earlier responses to still be accepted after these
1273 retransmissions, U-Boot's BOOTP client keeps a small cache of
1274 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1275 cache. The default is to keep IDs for up to four outstanding
1276 requests. Increasing this will allow U-Boot to accept offers
1277 from a BOOTP client in networks with unusually high latency.
1278
stroesee0aadfb2003-08-28 14:17:32 +00001279- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001280 You can fine tune the DHCP functionality by defining
1281 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001282
Jon Loeliger5336a762007-07-09 22:08:34 -05001283 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001284 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001285 CONFIG_BOOTP_NTPSERVER
1286 CONFIG_BOOTP_TIMEOFFSET
1287 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001288 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001289
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001290 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1291 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001292
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001293 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1294 after the configured retry count, the call will fail
1295 instead of starting over. This can be used to fail over
1296 to Link-local IP address configuration if the DHCP server
1297 is not available.
1298
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001299 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1300
1301 A 32bit value in microseconds for a delay between
1302 receiving a "DHCP Offer" and sending the "DHCP Request".
1303 This fixes a problem with certain DHCP servers that don't
1304 respond 100% of the time to a "DHCP request". E.g. On an
1305 AT91RM9200 processor running at 180MHz, this delay needed
1306 to be *at least* 15,000 usec before a Windows Server 2003
1307 DHCP server would reply 100% of the time. I recommend at
1308 least 50,000 usec to be safe. The alternative is to hope
1309 that one of the retries will be successful but note that
1310 the DHCP timeout and retry process takes a longer than
1311 this delay.
1312
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001313 - Link-local IP address negotiation:
1314 Negotiate with other link-local clients on the local network
1315 for an address that doesn't require explicit configuration.
1316 This is especially useful if a DHCP server cannot be guaranteed
1317 to exist in all environments that the device must operate.
1318
1319 See doc/README.link-local for more information.
1320
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301321 - MAC address from environment variables
1322
1323 FDT_SEQ_MACADDR_FROM_ENV
1324
1325 Fix-up device tree with MAC addresses fetched sequentially from
1326 environment variables. This config work on assumption that
1327 non-usable ethernet node of device-tree are either not present
1328 or their status has been marked as "disabled".
1329
wdenk145d2c12004-04-15 21:48:45 +00001330 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001331 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001332
1333 The device id used in CDP trigger frames.
1334
1335 CONFIG_CDP_DEVICE_ID_PREFIX
1336
1337 A two character string which is prefixed to the MAC address
1338 of the device.
1339
1340 CONFIG_CDP_PORT_ID
1341
1342 A printf format string which contains the ascii name of
1343 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001344 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001345
1346 CONFIG_CDP_CAPABILITIES
1347
1348 A 32bit integer which indicates the device capabilities;
1349 0x00000010 for a normal host which does not forwards.
1350
1351 CONFIG_CDP_VERSION
1352
1353 An ascii string containing the version of the software.
1354
1355 CONFIG_CDP_PLATFORM
1356
1357 An ascii string containing the name of the platform.
1358
1359 CONFIG_CDP_TRIGGER
1360
1361 A 32bit integer sent on the trigger.
1362
1363 CONFIG_CDP_POWER_CONSUMPTION
1364
1365 A 16bit integer containing the power consumption of the
1366 device in .1 of milliwatts.
1367
1368 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1369
1370 A byte containing the id of the VLAN.
1371
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001372- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001373
1374 Several configurations allow to display the current
1375 status using a LED. For instance, the LED will blink
1376 fast while running U-Boot code, stop blinking as
1377 soon as a reply to a BOOTP request was received, and
1378 start blinking slow once the Linux kernel is running
1379 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001380 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001381 feature in U-Boot.
1382
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001383 Additional options:
1384
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001385 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001386 The status LED can be connected to a GPIO pin.
1387 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001388 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001389 to include the gpio_led driver in the U-Boot binary.
1390
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001391 CONFIG_GPIO_LED_INVERTED_TABLE
1392 Some GPIO connected LEDs may have inverted polarity in which
1393 case the GPIO high value corresponds to LED off state and
1394 GPIO low value corresponds to LED on state.
1395 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1396 with a list of GPIO LEDs that have inverted polarity.
1397
Tom Rini52b2e262021-08-18 23:12:24 -04001398- I2C Support:
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001399 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001400 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001401
1402 CONFIG_SYS_I2C_DIRECT_BUS
1403 define this, if you don't use i2c muxes on your hardware.
1404 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1405 omit this define.
1406
1407 CONFIG_SYS_I2C_MAX_HOPS
1408 define how many muxes are maximal consecutively connected
1409 on one i2c bus. If you not use i2c muxes, omit this
1410 define.
1411
1412 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001413 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001414 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1415 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1416 CONFIG_SYS_NUM_I2C_BUSES = 9:
1417
1418 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1419 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1420 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1421 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1422 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1423 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1424 {1, {I2C_NULL_HOP}}, \
1425 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1426 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1427 }
1428
1429 which defines
1430 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001431 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1432 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1433 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1434 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1435 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001436 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001437 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1438 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001439
1440 If you do not have i2c muxes on your board, omit this define.
1441
Simon Glass3efce392017-05-12 21:10:00 -06001442- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001443 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001444 then the following macros need to be defined (examples are
1445 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001446
1447 I2C_INIT
1448
wdenkb9bbd242003-06-30 16:24:52 +00001449 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001450 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001451
wdenk544e9732004-02-06 23:19:44 +00001452 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001453
wdenkc6097192002-11-03 00:24:07 +00001454 I2C_ACTIVE
1455
1456 The code necessary to make the I2C data line active
1457 (driven). If the data line is open collector, this
1458 define can be null.
1459
wdenkb9bbd242003-06-30 16:24:52 +00001460 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1461
wdenkc6097192002-11-03 00:24:07 +00001462 I2C_TRISTATE
1463
1464 The code necessary to make the I2C data line tri-stated
1465 (inactive). If the data line is open collector, this
1466 define can be null.
1467
wdenkb9bbd242003-06-30 16:24:52 +00001468 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1469
wdenkc6097192002-11-03 00:24:07 +00001470 I2C_READ
1471
York Sun4a598092013-04-01 11:29:11 -07001472 Code that returns true if the I2C data line is high,
1473 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001474
wdenkb9bbd242003-06-30 16:24:52 +00001475 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1476
wdenkc6097192002-11-03 00:24:07 +00001477 I2C_SDA(bit)
1478
York Sun4a598092013-04-01 11:29:11 -07001479 If <bit> is true, sets the I2C data line high. If it
1480 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001481
wdenkb9bbd242003-06-30 16:24:52 +00001482 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001483 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001484 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001485
wdenkc6097192002-11-03 00:24:07 +00001486 I2C_SCL(bit)
1487
York Sun4a598092013-04-01 11:29:11 -07001488 If <bit> is true, sets the I2C clock line high. If it
1489 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001490
wdenkb9bbd242003-06-30 16:24:52 +00001491 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001492 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001493 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001494
wdenkc6097192002-11-03 00:24:07 +00001495 I2C_DELAY
1496
1497 This delay is invoked four times per clock cycle so this
1498 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001499 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001500 like:
1501
wdenkb9bbd242003-06-30 16:24:52 +00001502 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001503
Mike Frysingeree12d542010-07-21 13:38:02 -04001504 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1505
1506 If your arch supports the generic GPIO framework (asm/gpio.h),
1507 then you may alternatively define the two GPIOs that are to be
1508 used as SCL / SDA. Any of the previous I2C_xxx macros will
1509 have GPIO-based defaults assigned to them as appropriate.
1510
1511 You should define these to the GPIO value as given directly to
1512 the generic GPIO functions.
1513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001514 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001515
wdenk57b2d802003-06-27 21:31:46 +00001516 When a board is reset during an i2c bus transfer
1517 chips might think that the current transfer is still
1518 in progress. On some boards it is possible to access
1519 the i2c SCLK line directly, either by using the
1520 processor pin as a GPIO or by having a second pin
1521 connected to the bus. If this option is defined a
1522 custom i2c_init_board() routine in boards/xxx/board.c
1523 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001524
Ben Warren45657152006-09-07 16:50:54 -04001525 CONFIG_I2C_MULTI_BUS
1526
1527 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001528 must have a controller. At any point in time, only one bus is
1529 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001530 Note that bus numbering is zero-based.
1531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001532 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001533
1534 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001535 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001536 is set, specify a list of bus-device pairs. Otherwise, specify
1537 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001538
1539 e.g.
1540 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001541 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001542
1543 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1544
Wolfgang Denk092ae952011-10-26 10:21:21 +00001545 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001546 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001547
1548 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1549
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001550 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001551
1552 If defined, then this indicates the I2C bus number for DDR SPD.
1553 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1554
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001555 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001556
1557 If defined, then this indicates the I2C bus number for the RTC.
1558 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1559
Andrew Dyer58c41f92008-12-29 17:36:01 -06001560 CONFIG_SOFT_I2C_READ_REPEATED_START
1561
1562 defining this will force the i2c_read() function in
1563 the soft_i2c driver to perform an I2C repeated start
1564 between writing the address pointer and reading the
1565 data. If this define is omitted the default behaviour
1566 of doing a stop-start sequence will be used. Most I2C
1567 devices can use either method, but some require one or
1568 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001569
wdenkc6097192002-11-03 00:24:07 +00001570- SPI Support: CONFIG_SPI
1571
1572 Enables SPI driver (so far only tested with
1573 SPI EEPROM, also an instance works with Crystal A/D and
1574 D/As on the SACSng board)
1575
wdenkc6097192002-11-03 00:24:07 +00001576 CONFIG_SOFT_SPI
1577
wdenk4a5c8a72003-03-06 00:02:04 +00001578 Enables a software (bit-bang) SPI driver rather than
1579 using hardware support. This is a general purpose
1580 driver that only requires three general I/O port pins
1581 (two outputs, one input) to function. If this is
1582 defined, the board configuration must define several
1583 SPI configuration items (port pins to use, etc). For
1584 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001585
Heiko Schocherb77c8882014-07-14 10:22:11 +02001586 CONFIG_SYS_SPI_MXC_WAIT
1587 Timeout for waiting until spi transfer completed.
1588 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1589
Matthias Fuchsa4400872007-12-27 17:12:34 +01001590- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001591
Matthias Fuchsa4400872007-12-27 17:12:34 +01001592 Enables FPGA subsystem.
1593
1594 CONFIG_FPGA_<vendor>
1595
1596 Enables support for specific chip vendors.
1597 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001598
Matthias Fuchsa4400872007-12-27 17:12:34 +01001599 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001600
Matthias Fuchsa4400872007-12-27 17:12:34 +01001601 Enables support for FPGA family.
1602 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1603
1604 CONFIG_FPGA_COUNT
1605
1606 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001607
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001608 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001609
wdenk57b2d802003-06-27 21:31:46 +00001610 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001611
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001612 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001613
wdenk4a5c8a72003-03-06 00:02:04 +00001614 Enable checks on FPGA configuration interface busy
1615 status by the configuration function. This option
1616 will require a board or device specific function to
1617 be written.
wdenkc6097192002-11-03 00:24:07 +00001618
1619 CONFIG_FPGA_DELAY
1620
1621 If defined, a function that provides delays in the FPGA
1622 configuration driver.
1623
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001624 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001625 Allow Control-C to interrupt FPGA configuration
1626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001627 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001628
wdenk4a5c8a72003-03-06 00:02:04 +00001629 Check for configuration errors during FPGA bitfile
1630 loading. For example, abort during Virtex II
1631 configuration if the INIT_B line goes low (which
1632 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001633
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001634 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001635
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001636 Maximum time to wait for the INIT_B line to de-assert
1637 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001638 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001639 ms.
wdenkc6097192002-11-03 00:24:07 +00001640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001641 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001642
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001643 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001644 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001646 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001647
wdenk4a5c8a72003-03-06 00:02:04 +00001648 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001649 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001650
1651- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02001652
wdenkc6097192002-11-03 00:24:07 +00001653 CONFIG_IDENT_STRING
1654
wdenk4a5c8a72003-03-06 00:02:04 +00001655 If defined, this string will be added to the U-Boot
1656 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001657
1658- Vendor Parameter Protection:
1659
wdenk4a5c8a72003-03-06 00:02:04 +00001660 U-Boot considers the values of the environment
1661 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001662 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001663 are set once by the board vendor / manufacturer, and
1664 protects these variables from casual modification by
1665 the user. Once set, these variables are read-only,
1666 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001667 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001668
1669 If CONFIG_ENV_OVERWRITE is #defined in your config
1670 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001671 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001672 these parameters.
1673
Joe Hershberger76f353e2015-05-04 14:55:14 -05001674 Alternatively, if you define _both_ an ethaddr in the
1675 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001676 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001677 which can be changed exactly ONCE by the user. [The
1678 serial# is unaffected by this, i. e. it remains
1679 read-only.]
1680
Joe Hershberger71497d02012-12-11 22:16:31 -06001681 The same can be accomplished in a more flexible way
1682 for any variable by configuring the type of access
1683 to allow for those variables in the ".flags" variable
1684 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1685
wdenkc6097192002-11-03 00:24:07 +00001686- Protected RAM:
1687 CONFIG_PRAM
1688
1689 Define this variable to enable the reservation of
1690 "protected RAM", i. e. RAM which is not overwritten
1691 by U-Boot. Define CONFIG_PRAM to hold the number of
1692 kB you want to reserve for pRAM. You can overwrite
1693 this default value by defining an environment
1694 variable "pram" to the number of kB you want to
1695 reserve. Note that the board info structure will
1696 still show the full amount of RAM. If pRAM is
1697 reserved, a new environment variable "mem" will
1698 automatically be defined to hold the amount of
1699 remaining RAM in a form that can be passed as boot
1700 argument to Linux, for instance like that:
1701
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001702 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001703 saveenv
1704
1705 This way you can tell Linux not to use this memory,
1706 either, which results in a memory region that will
1707 not be affected by reboots.
1708
1709 *WARNING* If your board configuration uses automatic
1710 detection of the RAM size, you must make sure that
1711 this memory test is non-destructive. So far, the
1712 following board configurations are known to be
1713 "pRAM-clean":
1714
Heiko Schocher65d94db2017-06-07 17:33:09 +02001715 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00001716 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02001717 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001718
Gabe Blacka2f3a932012-12-02 04:55:18 +00001719- Access to physical memory region (> 4GB)
1720 Some basic support is provided for operations on memory not
1721 normally accessible to U-Boot - e.g. some architectures
1722 support access to more than 4GB of memory on 32-bit
1723 machines using physical address extension or similar.
1724 Define CONFIG_PHYSMEM to access this basic support, which
1725 currently only supports clearing the memory.
1726
wdenkc6097192002-11-03 00:24:07 +00001727- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001728 CONFIG_NET_RETRY_COUNT
1729
wdenk4a5c8a72003-03-06 00:02:04 +00001730 This variable defines the number of retries for
1731 network operations like ARP, RARP, TFTP, or BOOTP
1732 before giving up the operation. If not defined, a
1733 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001734
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001735 CONFIG_ARP_TIMEOUT
1736
1737 Timeout waiting for an ARP reply in milliseconds.
1738
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00001739 CONFIG_NFS_TIMEOUT
1740
1741 Timeout in milliseconds used in NFS protocol.
1742 If you encounter "ERROR: Cannot umount" in nfs command,
1743 try longer timeout such as
1744 #define CONFIG_NFS_TIMEOUT 10000UL
1745
wdenkc6097192002-11-03 00:24:07 +00001746 Note:
1747
wdenk57b2d802003-06-27 21:31:46 +00001748 In the current implementation, the local variables
1749 space and global environment variables space are
1750 separated. Local variables are those you define by
1751 simply typing `name=value'. To access a local
1752 variable later on, you have write `$name' or
1753 `${name}'; to execute the contents of a variable
1754 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001755
wdenk4a5c8a72003-03-06 00:02:04 +00001756 Global environment variables are those you use
1757 setenv/printenv to work with. To run a command stored
1758 in such a variable, you need to use the run command,
1759 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001760
1761 To store commands and special characters in a
1762 variable, please use double quotation marks
1763 surrounding the whole text of the variable, instead
1764 of the backslashes before semicolons and special
1765 symbols.
1766
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001767- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01001768 CONFIG_CMDLINE_PS_SUPPORT
1769
1770 Enable support for changing the command prompt string
1771 at run-time. Only static string is supported so far.
1772 The string is obtained from environment variables PS1
1773 and PS2.
1774
wdenkc0aa5c52003-12-06 19:49:23 +00001775- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001776 CONFIG_EXTRA_ENV_SETTINGS
1777
wdenk4a5c8a72003-03-06 00:02:04 +00001778 Define this to contain any number of null terminated
1779 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001780 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001781
wdenk4a5c8a72003-03-06 00:02:04 +00001782 For example, place something like this in your
1783 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001784
1785 #define CONFIG_EXTRA_ENV_SETTINGS \
1786 "myvar1=value1\0" \
1787 "myvar2=value2\0"
1788
wdenk4a5c8a72003-03-06 00:02:04 +00001789 Warning: This method is based on knowledge about the
1790 internal format how the environment is stored by the
1791 U-Boot code. This is NOT an official, exported
1792 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001793 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001794 You better know what you are doing here.
1795
wdenk4a5c8a72003-03-06 00:02:04 +00001796 Note: overly (ab)use of the default environment is
1797 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001798 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00001799 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001800
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001801 CONFIG_DELAY_ENVIRONMENT
1802
1803 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001804 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001805 that so that the environment is not available until
1806 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1807 this is instead controlled by the value of
1808 /config/load-environment.
1809
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001810- TFTP Fixed UDP Port:
1811 CONFIG_TFTP_PORT
1812
Wolfgang Denk227b5192005-09-24 23:25:46 +02001813 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001814 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001815 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001816 number generator is used.
1817
Wolfgang Denk227b5192005-09-24 23:25:46 +02001818 Also, the environment variable tftpdstp is used to supply
1819 the TFTP UDP destination port value. If tftpdstp isn't
1820 defined, the normal port 69 is used.
1821
1822 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001823 blindly start the TFTP transfer using the pre-configured
1824 target IP address and UDP port. This has the effect of
1825 "punching through" the (Windows XP) firewall, allowing
1826 the remainder of the TFTP transfer to proceed normally.
1827 A better solution is to properly configure the firewall,
1828 but sometimes that is not allowed.
1829
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001830 CONFIG_STANDALONE_LOAD_ADDR
1831
Wolfgang Denk23f78482011-10-09 21:06:34 +02001832 This option defines a board specific value for the
1833 address where standalone program gets loaded, thus
1834 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001835 settings.
1836
1837- Frame Buffer Address:
1838 CONFIG_FB_ADDR
1839
1840 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00001841 address for frame buffer. This is typically the case
1842 when using a graphics controller has separate video
1843 memory. U-Boot will then place the frame buffer at
1844 the given address instead of dynamically reserving it
1845 in system RAM by calling lcd_setmem(), which grabs
1846 the memory for the frame buffer depending on the
1847 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001848
1849 Please see board_init_f function.
1850
Detlev Zundel0ecb6112009-12-01 17:16:19 +01001851- Automatic software updates via TFTP server
1852 CONFIG_UPDATE_TFTP
1853 CONFIG_UPDATE_TFTP_CNT_MAX
1854 CONFIG_UPDATE_TFTP_MSEC_MAX
1855
1856 These options enable and control the auto-update feature;
1857 for a more detailed description refer to doc/README.update.
1858
1859- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02001860 CONFIG_MTD_UBI_WL_THRESHOLD
1861 This parameter defines the maximum difference between the highest
1862 erase counter value and the lowest erase counter value of eraseblocks
1863 of UBI devices. When this threshold is exceeded, UBI starts performing
1864 wear leveling by means of moving data from eraseblock with low erase
1865 counter to eraseblocks with high erase counter.
1866
1867 The default value should be OK for SLC NAND flashes, NOR flashes and
1868 other flashes which have eraseblock life-cycle 100000 or more.
1869 However, in case of MLC NAND flashes which typically have eraseblock
1870 life-cycle less than 10000, the threshold should be lessened (e.g.,
1871 to 128 or 256, although it does not have to be power of 2).
1872
1873 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06001874
Heiko Schocherf5895d12014-06-24 10:10:04 +02001875 CONFIG_MTD_UBI_BEB_LIMIT
1876 This option specifies the maximum bad physical eraseblocks UBI
1877 expects on the MTD device (per 1024 eraseblocks). If the
1878 underlying flash does not admit of bad eraseblocks (e.g. NOR
1879 flash), this value is ignored.
1880
1881 NAND datasheets often specify the minimum and maximum NVM
1882 (Number of Valid Blocks) for the flashes' endurance lifetime.
1883 The maximum expected bad eraseblocks per 1024 eraseblocks
1884 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1885 which gives 20 for most NANDs (MaxNVB is basically the total
1886 count of eraseblocks on the chip).
1887
1888 To put it differently, if this value is 20, UBI will try to
1889 reserve about 1.9% of physical eraseblocks for bad blocks
1890 handling. And that will be 1.9% of eraseblocks on the entire
1891 NAND chip, not just the MTD partition UBI attaches. This means
1892 that if you have, say, a NAND flash chip admits maximum 40 bad
1893 eraseblocks, and it is split on two MTD partitions of the same
1894 size, UBI will reserve 40 eraseblocks when attaching a
1895 partition.
1896
1897 default: 20
1898
1899 CONFIG_MTD_UBI_FASTMAP
1900 Fastmap is a mechanism which allows attaching an UBI device
1901 in nearly constant time. Instead of scanning the whole MTD device it
1902 only has to locate a checkpoint (called fastmap) on the device.
1903 The on-flash fastmap contains all information needed to attach
1904 the device. Using fastmap makes only sense on large devices where
1905 attaching by scanning takes long. UBI will not automatically install
1906 a fastmap on old images, but you can set the UBI parameter
1907 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1908 that fastmap-enabled images are still usable with UBI implementations
1909 without fastmap support. On typical flash devices the whole fastmap
1910 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1911
1912 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1913 Set this parameter to enable fastmap automatically on images
1914 without a fastmap.
1915 default: 0
1916
Heiko Schocher94b66de2015-10-22 06:19:21 +02001917 CONFIG_MTD_UBI_FM_DEBUG
1918 Enable UBI fastmap debug
1919 default: 0
1920
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001921- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02001922 CONFIG_SPL
1923 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001924
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001925 CONFIG_SPL_MAX_FOOTPRINT
1926 Maximum size in memory allocated to the SPL, BSS included.
1927 When defined, the linker checks that the actual memory
1928 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001929 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001930 must not be both defined at the same time.
1931
Tom Rini36853852012-02-14 07:29:40 +00001932 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001933 Maximum size of the SPL image (text, data, rodata, and
1934 linker lists sections), BSS excluded.
1935 When defined, the linker checks that the actual size does
1936 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00001937
Scott Woodc4f0d002012-09-20 19:05:12 -05001938 CONFIG_SPL_RELOC_TEXT_BASE
1939 Address to relocate to. If unspecified, this is equal to
1940 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
1941
Tom Rini36853852012-02-14 07:29:40 +00001942 CONFIG_SPL_BSS_START_ADDR
1943 Link address for the BSS within the SPL binary.
1944
1945 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001946 Maximum size in memory allocated to the SPL BSS.
1947 When defined, the linker checks that the actual memory used
1948 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001949 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001950 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00001951
1952 CONFIG_SPL_STACK
1953 Adress of the start of the stack SPL will use
1954
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02001955 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1956 When defined, SPL will panic() if the image it has
1957 loaded does not have a signature.
1958 Defining this is useful when code which loads images
1959 in SPL cannot guarantee that absolutely all read errors
1960 will be caught.
1961 An example is the LPC32XX MLC NAND driver, which will
1962 consider that a completely unreadable NAND block is bad,
1963 and thus should be skipped silently.
1964
Scott Woodc4f0d002012-09-20 19:05:12 -05001965 CONFIG_SPL_RELOC_STACK
1966 Adress of the start of the stack SPL will use after
1967 relocation. If unspecified, this is equal to
1968 CONFIG_SPL_STACK.
1969
Tom Rini36853852012-02-14 07:29:40 +00001970 CONFIG_SYS_SPL_MALLOC_START
1971 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02001972 When this option is set the full malloc is used in SPL and
1973 it is set up by spl_init() and before that, the simple malloc()
1974 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00001975
1976 CONFIG_SYS_SPL_MALLOC_SIZE
1977 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001978
Tom Rinife3b0c72012-08-13 11:37:56 -07001979 CONFIG_SPL_DISPLAY_PRINT
1980 For ARM, enable an optional function to print more information
1981 about the running system.
1982
Scott Wood7c810902012-09-20 16:35:21 -05001983 CONFIG_SPL_INIT_MINIMAL
1984 Arch init code should be built for a very small image
1985
Paul Kocialkowski17675c82014-11-08 23:14:56 +01001986 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
1987 Partition on the MMC to load U-Boot from when the MMC is being
1988 used in raw mode
1989
Peter Korsgaard01b542f2013-05-13 08:36:29 +00001990 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
1991 Sector to load kernel uImage from when MMC is being
1992 used in raw mode (for Falcon mode)
1993
1994 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
1995 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
1996 Sector and number of sectors to load kernel argument
1997 parameters from when MMC is being used in raw mode
1998 (for falcon mode)
1999
Guillaume GARDET5065b712014-10-15 17:53:13 +02002000 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2001 Filename to read to load U-Boot when reading from filesystem
2002
2003 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002004 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002005 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002006
Guillaume GARDET5065b712014-10-15 17:53:13 +02002007 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002008 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002009 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002010
Scott Wood2b36fbb2012-12-06 13:33:17 +00002011 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2012 Set this for NAND SPL on PPC mpc83xx targets, so that
2013 start.S waits for the rest of the SPL to load before
2014 continuing (the hardware starts execution after just
2015 loading the first page rather than the full 4K).
2016
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302017 CONFIG_SPL_SKIP_RELOCATE
2018 Avoid SPL relocation
2019
Jörg Krause6f8190f2018-01-14 19:26:38 +01002020 CONFIG_SPL_NAND_IDENT
2021 SPL uses the chip ID list to identify the NAND flash.
2022 Requires CONFIG_SPL_NAND_BASE.
2023
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002024 CONFIG_SPL_UBI
2025 Support for a lightweight UBI (fastmap) scanner and
2026 loader
2027
Heiko Schochercf000272014-10-31 08:31:00 +01002028 CONFIG_SPL_NAND_RAW_ONLY
2029 Support to boot only raw u-boot.bin images. Use this only
2030 if you need to save space.
2031
Ying Zhangdfb2b152013-08-16 15:16:12 +08002032 CONFIG_SPL_COMMON_INIT_DDR
2033 Set for common ddr init with serial presence detect in
2034 SPL binary.
2035
Tom Rini36853852012-02-14 07:29:40 +00002036 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2037 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2038 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2039 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2040 CONFIG_SYS_NAND_ECCBYTES
2041 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002042 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002043
Scott Wood36c440e2012-09-21 18:35:27 -05002044 CONFIG_SYS_NAND_U_BOOT_DST
2045 Location in memory to load U-Boot to
2046
2047 CONFIG_SYS_NAND_U_BOOT_SIZE
2048 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002049
2050 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002051 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002052
2053 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2054 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002055 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002056
Pavel Machekde997252012-08-30 22:42:11 +02002057 CONFIG_SPL_RAM_DEVICE
2058 Support for running image already present in ram, in SPL binary
2059
Scott Woodeb7bd972012-12-06 13:33:16 +00002060 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002061 Image offset to which the SPL should be padded before appending
2062 the SPL payload. By default, this is defined as
2063 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2064 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2065 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002066
Scott Woodf147eb72012-09-21 16:27:32 -05002067 CONFIG_SPL_TARGET
2068 Final target image containing SPL and payload. Some SPLs
2069 use an arch-specific makefile fragment instead, for
2070 example if more than one image needs to be produced.
2071
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002072 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002073 Printing information about a FIT image adds quite a bit of
2074 code to SPL. So this is normally disabled in SPL. Use this
2075 option to re-enable it. This will affect the output of the
2076 bootm command when booting a FIT image.
2077
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002078- TPL framework
2079 CONFIG_TPL
2080 Enable building of TPL globally.
2081
2082 CONFIG_TPL_PAD_TO
2083 Image offset to which the TPL should be padded before appending
2084 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002085 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2086 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2087 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002088
wdenkc0aa5c52003-12-06 19:49:23 +00002089- Interrupt support (PPC):
2090
wdenk1ebf41e2004-01-02 14:00:00 +00002091 There are common interrupt_init() and timer_interrupt()
2092 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002093 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002094 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002095 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002096 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002097 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002098 specific handling. If board has watchdog / status_led
2099 / other_activity_monitor it works automatically from
2100 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002101
wdenkc6097192002-11-03 00:24:07 +00002102
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002103Board initialization settings:
2104------------------------------
2105
2106During Initialization u-boot calls a number of board specific functions
2107to allow the preparation of board specific prerequisites, e.g. pin setup
2108before drivers are initialized. To enable these callbacks the
2109following configuration macros have to be defined. Currently this is
2110architecture specific, so please check arch/your_architecture/lib/board.c
2111typically in board_init_f() and board_init_r().
2112
2113- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2114- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2115- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2116- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002117
wdenkc6097192002-11-03 00:24:07 +00002118Configuration Settings:
2119-----------------------
2120
Simon Glass8927bf22019-12-28 10:45:10 -07002121- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08002122 Optionally it can be defined to support 64-bit memory commands.
2123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002124- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002125 undefine this when you're short of memory.
2126
Peter Tyserdfb72b82009-01-27 18:03:12 -06002127- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2128 width of the commands listed in the 'help' command output.
2129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002130- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002131 prompt for user input.
2132
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002133- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002135- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002136
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002137- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002139- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002140 the application (usually a Linux kernel) when it is
2141 booted
2142
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002143- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002144 List of legal baudrate settings for this board.
2145
York Sun5d286cd2015-12-04 11:57:07 -08002146- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002147 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002148 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2149 is substracted from total RAM and won't be reported to OS.
2150 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002151 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002152 the RAM base is not zero, or RAM is divided into banks,
2153 this variable needs to be recalcuated to get the address.
2154
York Sun50739372015-12-07 11:05:29 -08002155- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002156 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002157 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002158 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002159 fixing up gd->ram_size the Linux kernel should gets passed
2160 the now "corrected" memory size and won't touch it either.
2161 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002162 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002163 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002164 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002165
2166 This option can be used as a workaround for the 440EPx/GRx
2167 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2168 be touched.
2169
2170 WARNING: Please make sure that this value is a multiple of
2171 the Linux page size (normally 4k). If this is not the case,
2172 then the end address of the Linux memory will be located at a
2173 non page size aligned address and this could cause major
2174 problems.
2175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002176- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002177 Enable temporary baudrate change while serial download
2178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002179- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002180 Physical start address of SDRAM. _Must_ be 0 here.
2181
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002182- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002183 Physical start address of Flash memory.
2184
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002185- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002186 Physical start address of boot monitor code (set by
2187 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002188 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002189 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002191- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002192 Size of memory reserved for monitor code, used to
2193 determine _at_compile_time_ (!) if the environment is
2194 embedded within the U-Boot image, or in a separate
2195 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002196
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002197- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002198 Size of DRAM reserved for malloc() use.
2199
Simon Glass863e4042014-07-10 22:23:28 -06002200- CONFIG_SYS_MALLOC_F_LEN
2201 Size of the malloc() pool for use before relocation. If
2202 this is defined, then a very simple malloc() implementation
2203 will become available before relocation. The address is just
2204 below the global data, and the stack is moved down to make
2205 space.
2206
2207 This feature allocates regions with increasing addresses
2208 within the region. calloc() is supported, but realloc()
2209 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002210 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002211 U-Boot relocates itself.
2212
Simon Glass9fa901b2014-11-10 17:16:54 -07002213- CONFIG_SYS_MALLOC_SIMPLE
2214 Provides a simple and small malloc() and calloc() for those
2215 boards which do not use the full malloc in SPL (which is
2216 enabled with CONFIG_SYS_SPL_MALLOC_START).
2217
Thierry Redingc97d9742014-12-09 22:25:22 -07002218- CONFIG_SYS_NONCACHED_MEMORY:
2219 Size of non-cached memory area. This area of memory will be
2220 typically located right below the malloc() area and mapped
2221 uncached in the MMU. This is useful for drivers that would
2222 otherwise require a lot of explicit cache maintenance. For
2223 some drivers it's also impossible to properly maintain the
2224 cache. For example if the regions that need to be flushed
2225 are not a multiple of the cache-line size, *and* padding
2226 cannot be allocated between the regions to align them (i.e.
2227 if the HW requires a contiguous array of regions, and the
2228 size of each region is not cache-aligned), then a flush of
2229 one region may result in overwriting data that hardware has
2230 written to another region in the same cache-line. This can
2231 happen for example in network drivers where descriptors for
2232 buffers are typically smaller than the CPU cache-line (e.g.
2233 16 bytes vs. 32 or 64 bytes).
2234
2235 Non-cached memory is only supported on 32-bit ARM at present.
2236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002237- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002238 Normally compressed uImages are limited to an
2239 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002240 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002241 to adjust this setting to your needs.
2242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002243- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002244 Maximum size of memory mapped by the startup code of
2245 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002246 the Linux kernel (bd_info, boot arguments, FDT blob if
2247 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002248 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002249 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002250 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002251 variable "bootm_mapsize" will override the value of
2252 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2253 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002254
John Rigbyeea8e692010-10-13 13:57:35 -06002255- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2256 Enable initrd_high functionality. If defined then the
2257 initrd_high feature is enabled and the bootm ramdisk subcommand
2258 is enabled.
2259
2260- CONFIG_SYS_BOOT_GET_CMDLINE:
2261 Enables allocating and saving kernel cmdline in space between
2262 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2263
2264- CONFIG_SYS_BOOT_GET_KBD:
2265 Enables allocating and saving a kernel copy of the bd_info in
2266 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002268- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002269 Max number of Flash memory banks
2270
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002271- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002272 Max number of sectors on a Flash chip
2273
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002274- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002275 Timeout for Flash erase operations (in ms)
2276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002277- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002278 Timeout for Flash write operations (in ms)
2279
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002280- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002281 Timeout for Flash set sector lock bit operation (in ms)
2282
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002283- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002284 Timeout for Flash clear lock bits operation (in ms)
2285
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002286- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002287 If defined, hardware flash sectors protection is used
2288 instead of U-Boot software protection.
2289
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002290- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002291
2292 Enable TFTP transfers directly to flash memory;
2293 without this option such a download has to be
2294 performed in two steps: (1) download to RAM, and (2)
2295 copy from RAM to flash.
2296
2297 The two-step approach is usually more reliable, since
2298 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002299 the flash, but in some situations (when system RAM is
2300 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002301 downloaded image) this option may be very useful.
2302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002303- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002304 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002305 common flash structure for storing flash geometry.
2306
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002307- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002308 This option also enables the building of the cfi_flash driver
2309 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002310
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002311- CONFIG_FLASH_CFI_MTD
2312 This option enables the building of the cfi_mtd driver
2313 in the drivers directory. The driver exports CFI flash
2314 to the MTD layer.
2315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002316- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002317 Use buffered writes to flash.
2318
2319- CONFIG_FLASH_SPANSION_S29WS_N
2320 s29ws-n MirrorBit flash has non-standard addresses for buffered
2321 write commands.
2322
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002323- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002324 If this option is defined, the common CFI flash doesn't
2325 print it's warning upon not recognized FLASH banks. This
2326 is useful, if some of the configured banks are only
2327 optionally available.
2328
Jerry Van Barenaae73572008-03-08 13:48:01 -05002329- CONFIG_FLASH_SHOW_PROGRESS
2330 If defined (must be an integer), print out countdown
2331 digits and dots. Recommended value: 45 (9..1) for 80
2332 column displays, 15 (3..1) for 40 column displays.
2333
Stefan Roesed20cba52013-04-04 15:53:14 +02002334- CONFIG_FLASH_VERIFY
2335 If defined, the content of the flash (destination) is compared
2336 against the source after the write operation. An error message
2337 will be printed when the contents are not identical.
2338 Please note that this option is useless in nearly all cases,
2339 since such flash programming errors usually are detected earlier
2340 while unprotecting/erasing/programming. Please only enable
2341 this option if you really know what you are doing.
2342
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002343- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002344 Defines the number of Ethernet receive buffers. On some
2345 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002346 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2347 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002348 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002349 Defaults to 4 if not defined.
2350
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002351- CONFIG_ENV_MAX_ENTRIES
2352
Wolfgang Denk1136f692010-10-27 22:48:30 +02002353 Maximum number of entries in the hash table that is used
2354 internally to store the environment settings. The default
2355 setting is supposed to be generous and should work in most
2356 cases. This setting can be used to tune behaviour; see
2357 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002358
Joe Hershberger71497d02012-12-11 22:16:31 -06002359- CONFIG_ENV_FLAGS_LIST_DEFAULT
2360- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002361 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002362 calling env set. Variables can be restricted to only decimal,
2363 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2364 the variables can also be restricted to IP address or MAC address.
2365
2366 The format of the list is:
2367 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002368 access_attribute = [a|r|o|c]
2369 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002370 entry = variable_name[:attributes]
2371 list = entry[,list]
2372
2373 The type attributes are:
2374 s - String (default)
2375 d - Decimal
2376 x - Hexadecimal
2377 b - Boolean ([1yYtT|0nNfF])
2378 i - IP address
2379 m - MAC address
2380
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002381 The access attributes are:
2382 a - Any (default)
2383 r - Read-only
2384 o - Write-once
2385 c - Change-default
2386
Joe Hershberger71497d02012-12-11 22:16:31 -06002387 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2388 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002389 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002390
2391 - CONFIG_ENV_FLAGS_LIST_STATIC
2392 Define this to a list (string) to define validation that
2393 should be done if an entry is not found in the ".flags"
2394 environment variable. To override a setting in the static
2395 list, simply add an entry for the same variable name to the
2396 ".flags" variable.
2397
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002398 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2399 regular expression. This allows multiple variables to define the same
2400 flags without explicitly listing them for each variable.
2401
wdenkc6097192002-11-03 00:24:07 +00002402The following definitions that deal with the placement and management
2403of environment data (variable area); in general, we support the
2404following configurations:
2405
Mike Frysinger63b8f122011-07-08 10:44:25 +00002406- CONFIG_BUILD_ENVCRC:
2407
2408 Builds up envcrc with the target environment so that external utils
2409 may easily extract it and embed it in final U-Boot images.
2410
wdenkc6097192002-11-03 00:24:07 +00002411BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002412in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002413console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002414U-Boot will hang.
2415
2416Please note that even with NVRAM we still use a copy of the
2417environment in RAM: we could work on NVRAM directly, but we want to
2418keep settings there always unmodified except somebody uses "saveenv"
2419to save the current settings.
2420
Liu Gang85bcd732012-03-08 00:33:20 +00002421BE CAREFUL! For some special cases, the local device can not use
2422"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002423environment stored in a remote NOR flash by SRIO or PCIE link,
2424but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002425
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002426- CONFIG_NAND_ENV_DST
2427
2428 Defines address in RAM to which the nand_spl code should copy the
2429 environment. If redundant environment is used, it will be copied to
2430 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2431
Bruce Adleredecc942007-11-02 13:15:42 -07002432Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002433has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002434created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002435until then to read environment variables.
2436
wdenk8dba0502003-03-31 16:34:49 +00002437The environment is protected by a CRC32 checksum. Before the monitor
2438is relocated into RAM, as a result of a bad CRC you will be working
2439with the compiled-in default environment - *silently*!!! [This is
2440necessary, because the first environment variable we need is the
2441"baudrate" setting for the console - if we have a bad CRC, we don't
2442have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002443
2444Note: once the monitor has been relocated, then it will complain if
2445the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002446use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002448- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002449 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002451 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002452 also needs to be defined.
2453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002454- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002455 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002456
Ron Madriddfa028a2009-02-18 14:30:44 -08002457- CONFIG_NS16550_MIN_FUNCTIONS:
2458 Define this if you desire to only have use of the NS16550_init
2459 and NS16550_putc functions for the serial driver located at
2460 drivers/serial/ns16550.c. This option is useful for saving
2461 space for already greatly restricted images, including but not
2462 limited to NAND_SPL configurations.
2463
Simon Glass28a9e332012-11-30 13:01:18 +00002464- CONFIG_DISPLAY_BOARDINFO
2465 Display information about the board that U-Boot is running on
2466 when U-Boot starts up. The board function checkboard() is called
2467 to do this.
2468
Simon Glasse8822012012-11-30 13:01:19 +00002469- CONFIG_DISPLAY_BOARDINFO_LATE
2470 Similar to the previous option, but display this information
2471 later, once stdio is running and output goes to the LCD, if
2472 present.
2473
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002474- CONFIG_BOARD_SIZE_LIMIT:
2475 Maximum size of the U-Boot image. When defined, the
2476 build system checks that the actual size does not
2477 exceed it.
2478
wdenkc6097192002-11-03 00:24:07 +00002479Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002480---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002482- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002483 Cache Line Size of the CPU.
2484
Timur Tabid8f341c2011-08-04 18:03:41 -05002485- CONFIG_SYS_CCSRBAR_DEFAULT:
2486 Default (power-on reset) physical address of CCSR on Freescale
2487 PowerPC SOCs.
2488
2489- CONFIG_SYS_CCSRBAR:
2490 Virtual address of CCSR. On a 32-bit build, this is typically
2491 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2492
Timur Tabid8f341c2011-08-04 18:03:41 -05002493- CONFIG_SYS_CCSRBAR_PHYS:
2494 Physical address of CCSR. CCSR can be relocated to a new
2495 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002496 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002497 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2498 is typically relocated on 36-bit builds. It is recommended
2499 that this macro be defined via the _HIGH and _LOW macros:
2500
2501 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2502 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2503
2504- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002505 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2506 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002507 used in assembly code, so it must not contain typecasts or
2508 integer size suffixes (e.g. "ULL").
2509
2510- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2511 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2512 used in assembly code, so it must not contain typecasts or
2513 integer size suffixes (e.g. "ULL").
2514
2515- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2516 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2517 forced to a value that ensures that CCSR is not relocated.
2518
Macpaul Lind1e49942011-04-11 20:45:32 +00002519- CONFIG_IDE_AHB:
2520 Most IDE controllers were designed to be connected with PCI
2521 interface. Only few of them were designed for AHB interface.
2522 When software is doing ATA command and data transfer to
2523 IDE devices through IDE-AHB controller, some additional
2524 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002525 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00002526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002527- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002528 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002529 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002532
wdenkeb20ad32003-09-05 23:19:14 +00002533 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002534 initial data and stack; please note that this must be
2535 writable memory that is working WITHOUT special
2536 initialization, i. e. you CANNOT use normal RAM which
2537 will become available only after programming the
2538 memory controller and running certain initialization
2539 sequences.
2540
2541 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002542 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002545
2546 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002547 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2548 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002549 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002550 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002551 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002552 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2553 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002554
2555 Note:
2556 On the MPC824X (or other systems that use the data
2557 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002558 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002559 point to an otherwise UNUSED address space between
2560 the top of RAM and the start of the PCI space.
2561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002562- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002565 SDRAM timing
2566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002567- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002568 periodic timer for refresh
2569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002570- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2571 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2572 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2573 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002574 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2575
2576- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2578 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002579 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2580
Kumar Gala8975d7a2010-12-30 12:09:53 -06002581- CONFIG_SYS_SRIO:
2582 Chip has SRIO or not
2583
2584- CONFIG_SRIO1:
2585 Board has SRIO 1 port available
2586
2587- CONFIG_SRIO2:
2588 Board has SRIO 2 port available
2589
Liu Gang27afb9c2013-05-07 16:30:46 +08002590- CONFIG_SRIO_PCIE_BOOT_MASTER
2591 Board can support master function for Boot from SRIO and PCIE
2592
Kumar Gala8975d7a2010-12-30 12:09:53 -06002593- CONFIG_SYS_SRIOn_MEM_VIRT:
2594 Virtual Address of SRIO port 'n' memory region
2595
Simon Glass970b61e2019-11-14 12:57:09 -07002596- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002597 Physical Address of SRIO port 'n' memory region
2598
2599- CONFIG_SYS_SRIOn_MEM_SIZE:
2600 Size of SRIO port 'n' memory region
2601
Fabio Estevamf17e8782013-04-11 09:35:34 +00002602- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2603 Defined to tell the NAND controller that the NAND chip is using
2604 a 16 bit bus.
2605 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002606 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002607 - drivers/mtd/nand/raw/ndfc.c
2608 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002609
2610- CONFIG_SYS_NDFC_EBC0_CFG
2611 Sets the EBC0_CFG register for the NDFC. If not defined
2612 a default value will be used.
2613
Ben Warren45657152006-09-07 16:50:54 -04002614- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002615 Get DDR timing information from an I2C EEPROM. Common
2616 with pluggable memory modules such as SODIMMs
2617
Ben Warren45657152006-09-07 16:50:54 -04002618 SPD_EEPROM_ADDRESS
2619 I2C address of the SPD EEPROM
2620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002621- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002622 If SPD EEPROM is on an I2C bus other than the first
2623 one, specify here. Note that the value must resolve
2624 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002625
York Sune73cc042011-06-07 09:42:16 +08002626- CONFIG_SYS_DDR_RAW_TIMING
2627 Get DDR timing information from other than SPD. Common with
2628 soldered DDR chips onboard without SPD. DDR raw timing
2629 parameters are extracted from datasheet and hard-coded into
2630 header files or board specific files.
2631
York Sunbd495cf2011-09-16 13:21:35 -07002632- CONFIG_FSL_DDR_INTERACTIVE
2633 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2634
York Sun8ced0502015-01-06 13:18:55 -08002635- CONFIG_FSL_DDR_SYNC_REFRESH
2636 Enable sync of refresh for multiple controllers.
2637
York Sunb6a35f82015-03-19 09:30:28 -07002638- CONFIG_FSL_DDR_BIST
2639 Enable built-in memory test for Freescale DDR controllers.
2640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002641- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002642 Only for 83xx systems. If specified, then DDR should
2643 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002644
wdenk6203e402004-04-18 10:13:26 +00002645- CONFIG_RMII
2646 Enable RMII mode for all FECs.
2647 Note that this is a global option, we can't
2648 have one FEC in standard MII mode and another in RMII mode.
2649
wdenk20c98a62004-04-23 20:32:05 +00002650- CONFIG_CRC32_VERIFY
2651 Add a verify option to the crc32 command.
2652 The syntax is:
2653
2654 => crc32 -v <address> <count> <crc32>
2655
2656 Where address/count indicate a memory area
2657 and crc32 is the correct crc32 which the
2658 area should have.
2659
wdenk64519362004-07-11 17:40:54 +00002660- CONFIG_LOOPW
2661 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06002662 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00002663
Joel Johnsondb5a97e2020-01-29 09:17:18 -07002664- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00002665 Add the "mdc" and "mwc" memory commands. These are cyclic
2666 "md/mw" commands.
2667 Examples:
2668
wdenk07d7e6b2004-12-16 21:44:03 +00002669 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002670 This command will print 4 bytes (10,11,12,13) each 500 ms.
2671
wdenk07d7e6b2004-12-16 21:44:03 +00002672 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002673 This command will write 12345678 to address 100 all 10 ms.
2674
wdenk07d7e6b2004-12-16 21:44:03 +00002675 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06002676 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00002677
Aneesh V552a3192011-07-13 05:11:07 +00002678- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002679 Set when the currently-running compilation is for an artifact
2680 that will end up in the SPL (as opposed to the TPL or U-Boot
2681 proper). Code that needs stage-specific behavior should check
2682 this.
wdenk336b2bc2005-04-02 23:52:25 +00002683
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002684- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002685 Set when the currently-running compilation is for an artifact
2686 that will end up in the TPL (as opposed to the SPL or U-Boot
2687 proper). Code that needs stage-specific behavior should check
2688 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002689
Ying Zhang0d4f5442013-05-20 14:07:23 +08002690- CONFIG_SYS_MPC85XX_NO_RESETVEC
2691 Only for 85xx systems. If this variable is specified, the section
2692 .resetvec is not kept and the section .bootpg is placed in the
2693 previous 4k of the .text section.
2694
Simon Glass17dabf02013-02-24 17:33:14 +00002695- CONFIG_ARCH_MAP_SYSMEM
2696 Generally U-Boot (and in particular the md command) uses
2697 effective address. It is therefore not necessary to regard
2698 U-Boot address as virtual addresses that need to be translated
2699 to physical addresses. However, sandbox requires this, since
2700 it maintains its own little RAM buffer which contains all
2701 addressable memory. This option causes some memory accesses
2702 to be mapped through map_sysmem() / unmap_sysmem().
2703
Simon Glassbfb59802013-02-14 04:18:54 +00002704- CONFIG_X86_RESET_VECTOR
2705 If defined, the x86 reset vector code is included. This is not
2706 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00002707
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002708- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2709 Option to disable subpage write in NAND driver
2710 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002711 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002712
Timur Tabi275f4bb2011-11-22 09:21:25 -06002713Freescale QE/FMAN Firmware Support:
2714-----------------------------------
2715
2716The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2717loading of "firmware", which is encoded in the QE firmware binary format.
2718This firmware often needs to be loaded during U-Boot booting, so macros
2719are used to identify the storage device (NOR flash, SPI, etc) and the address
2720within that device.
2721
Zhao Qiang83a90842014-03-21 16:21:44 +08002722- CONFIG_SYS_FMAN_FW_ADDR
2723 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002724 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08002725 is also specified.
2726
2727- CONFIG_SYS_QE_FW_ADDR
2728 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002729 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06002730 is also specified.
2731
2732- CONFIG_SYS_QE_FMAN_FW_LENGTH
2733 The maximum possible size of the firmware. The firmware binary format
2734 has a field that specifies the actual size of the firmware, but it
2735 might not be possible to read any part of the firmware unless some
2736 local storage is allocated to hold the entire firmware first.
2737
2738- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2739 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2740 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2741 virtual address in NOR flash.
2742
2743- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2744 Specifies that QE/FMAN firmware is located in NAND flash.
2745 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2746
2747- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2748 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2749 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2750
Liu Gang1e084582012-03-08 00:33:18 +00002751- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2752 Specifies that QE/FMAN firmware is located in the remote (master)
2753 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00002754 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2755 window->master inbound window->master LAW->the ucode address in
2756 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06002757
J. German Rivera8ff14b72014-06-23 15:15:55 -07002758Freescale Layerscape Management Complex Firmware Support:
2759---------------------------------------------------------
2760The Freescale Layerscape Management Complex (MC) supports the loading of
2761"firmware".
2762This firmware often needs to be loaded during U-Boot booting, so macros
2763are used to identify the storage device (NOR flash, SPI, etc) and the address
2764within that device.
2765
2766- CONFIG_FSL_MC_ENET
2767 Enable the MC driver for Layerscape SoCs.
2768
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302769Freescale Layerscape Debug Server Support:
2770-------------------------------------------
2771The Freescale Layerscape Debug Server Support supports the loading of
2772"Debug Server firmware" and triggering SP boot-rom.
2773This firmware often needs to be loaded during U-Boot booting.
2774
York Sun928b6812015-12-07 11:08:58 -08002775- CONFIG_SYS_MC_RSV_MEM_ALIGN
2776 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302777
Paul Kocialkowski7b917022015-07-26 18:48:15 +02002778Reproducible builds
2779-------------------
2780
2781In order to achieve reproducible builds, timestamps used in the U-Boot build
2782process have to be set to a fixed value.
2783
2784This is done using the SOURCE_DATE_EPOCH environment variable.
2785SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2786option for U-Boot or an environment variable in U-Boot.
2787
2788SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2789
wdenkc6097192002-11-03 00:24:07 +00002790Building the Software:
2791======================
2792
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002793Building U-Boot has been tested in several native build environments
2794and in many different cross environments. Of course we cannot support
2795all possibly existing versions of cross development tools in all
2796(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayamae0cc1852020-10-08 13:17:16 +09002797recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002798which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002799
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002800If you are not using a native environment, it is assumed that you
2801have GNU cross compiling tools available in your path. In this case,
2802you must set the environment variable CROSS_COMPILE in your shell.
2803Note that no changes to the Makefile or any other source files are
2804necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002805
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002806 $ CROSS_COMPILE=ppc_4xx-
2807 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002808
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002809U-Boot is intended to be simple to build. After installing the
2810sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002811is done by typing:
2812
Holger Freyther7ba4e572014-08-04 09:26:05 +02002813 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00002814
Holger Freyther7ba4e572014-08-04 09:26:05 +02002815where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002816rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002817
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002818Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00002819 additional information is available from the board vendor; for
2820 instance, the TQM823L systems are available without (standard)
2821 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002822 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002823
Holger Freyther7ba4e572014-08-04 09:26:05 +02002824 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002825 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002826
Holger Freyther7ba4e572014-08-04 09:26:05 +02002827 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002828 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk6c59edc2004-05-03 20:45:30 +00002830 etc.
wdenkc6097192002-11-03 00:24:07 +00002831
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk6c59edc2004-05-03 20:45:30 +00002833Finally, type "make all", and you should get some working U-Boot
2834images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002835
wdenk6c59edc2004-05-03 20:45:30 +00002836- "u-boot.bin" is a raw binary image
2837- "u-boot" is an image in ELF binary format
2838- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002839
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002840By default the build is performed locally and the objects are saved
2841in the source directory. One of the two methods can be used to change
2842this behavior and build U-Boot to some external directory:
2843
28441. Add O= to the make command line invocations:
2845
2846 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002847 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002848 make O=/tmp/build all
2849
Timo Ketolac8c67602014-11-06 14:39:05 +020028502. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002851
Timo Ketolac8c67602014-11-06 14:39:05 +02002852 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002853 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002854 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002855 make all
2856
Timo Ketolac8c67602014-11-06 14:39:05 +02002857Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002858variable.
2859
Daniel Schwierzeck88484422018-01-26 16:31:04 +01002860User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2861setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2862For example to treat all compiler warnings as errors:
2863
2864 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00002865
wdenk6c59edc2004-05-03 20:45:30 +00002866Please be aware that the Makefiles assume you are using GNU make, so
2867for instance on NetBSD you might need to use "gmake" instead of
2868native "make".
wdenkc6097192002-11-03 00:24:07 +00002869
wdenkc6097192002-11-03 00:24:07 +00002870
wdenk6c59edc2004-05-03 20:45:30 +00002871If the system board that you have is not listed, then you will need
2872to port U-Boot to your hardware platform. To do this, follow these
2873steps:
wdenkc6097192002-11-03 00:24:07 +00002874
Phil Sutterc77b4882015-12-25 14:41:18 +010028751. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00002876 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01002877 the "Makefile" and a "<board>.c".
28782. Create a new configuration file "include/configs/<board>.h" for
2879 your board.
wdenk6c59edc2004-05-03 20:45:30 +000028803. If you're porting U-Boot to a new CPU, then also create a new
2881 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020028824. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000028835. Type "make", and you should get a working "u-boot.srec" file
2884 to be installed on your target system.
28856. Debug and solve any problems that might arise.
2886 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002887
wdenkc6097192002-11-03 00:24:07 +00002888
wdenk6c59edc2004-05-03 20:45:30 +00002889Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2890==============================================================
wdenkc6097192002-11-03 00:24:07 +00002891
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002892If you have modified U-Boot sources (for instance added a new board
2893or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002894provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08002895the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002896official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002897
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002898But before you submit such a patch, please verify that your modifi-
2899cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002900the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06002901just run the buildman script (tools/buildman/buildman), which will
2902configure and build U-Boot for ALL supported system. Be warned, this
2903will take a while. Please see the buildman README, or run 'buildman -H'
2904for documentation.
wdenkc6097192002-11-03 00:24:07 +00002905
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002906
wdenk6c59edc2004-05-03 20:45:30 +00002907See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002908
wdenkc6097192002-11-03 00:24:07 +00002909
wdenk6c59edc2004-05-03 20:45:30 +00002910Monitor Commands - Overview:
2911============================
wdenkc6097192002-11-03 00:24:07 +00002912
wdenk6c59edc2004-05-03 20:45:30 +00002913go - start application at address 'addr'
2914run - run commands in an environment variable
2915bootm - boot application image from memory
2916bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00002917bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00002918tftpboot- boot image via network using TFTP protocol
2919 and env variables "ipaddr" and "serverip"
2920 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00002921tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00002922rarpboot- boot image via network using RARP/TFTP protocol
2923diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2924loads - load S-Record file over serial line
2925loadb - load binary file over serial line (kermit mode)
2926md - memory display
2927mm - memory modify (auto-incrementing)
2928nm - memory modify (constant address)
2929mw - memory write (fill)
Simon Glass19038de2020-06-02 19:26:49 -06002930ms - memory search
wdenk6c59edc2004-05-03 20:45:30 +00002931cp - memory copy
2932cmp - memory compare
2933crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05002934i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00002935sspi - SPI utility commands
2936base - print or set address offset
2937printenv- print environment variables
Pragnesh Patel1d5955f2020-12-22 11:30:05 +05302938pwm - control pwm channels
wdenk6c59edc2004-05-03 20:45:30 +00002939setenv - set environment variables
2940saveenv - save environment variables to persistent storage
2941protect - enable or disable FLASH write protection
2942erase - erase FLASH memory
2943flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00002944nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00002945bdinfo - print Board Info structure
2946iminfo - print header information for application image
2947coninfo - print console devices and informations
2948ide - IDE sub-system
2949loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002950loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002951mtest - simple RAM test
2952icache - enable or disable instruction cache
2953dcache - enable or disable data cache
2954reset - Perform RESET of the CPU
2955echo - echo args to console
2956version - print monitor version
2957help - print online help
2958? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002959
wdenkc6097192002-11-03 00:24:07 +00002960
wdenk6c59edc2004-05-03 20:45:30 +00002961Monitor Commands - Detailed Description:
2962========================================
wdenkc6097192002-11-03 00:24:07 +00002963
wdenk6c59edc2004-05-03 20:45:30 +00002964TODO.
wdenkc6097192002-11-03 00:24:07 +00002965
wdenk6c59edc2004-05-03 20:45:30 +00002966For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002967
2968
wdenk6c59edc2004-05-03 20:45:30 +00002969Note for Redundant Ethernet Interfaces:
2970=======================================
wdenkf4688a22003-05-28 08:06:31 +00002971
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002972Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00002973such configurations and is capable of automatic selection of a
2974"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00002975
wdenk6c59edc2004-05-03 20:45:30 +00002976Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2977MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2978"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00002979
wdenk6c59edc2004-05-03 20:45:30 +00002980If the network interface stores some valid MAC address (for instance
2981in SROM), this is used as default address if there is NO correspon-
2982ding setting in the environment; if the corresponding environment
2983variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00002984
wdenk6c59edc2004-05-03 20:45:30 +00002985o If the SROM has a valid MAC address, and there is no address in the
2986 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002987
wdenk6c59edc2004-05-03 20:45:30 +00002988o If there is no valid address in the SROM, and a definition in the
2989 environment exists, then the value from the environment variable is
2990 used.
wdenkc6097192002-11-03 00:24:07 +00002991
wdenk6c59edc2004-05-03 20:45:30 +00002992o If both the SROM and the environment contain a MAC address, and
2993 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002994
wdenk6c59edc2004-05-03 20:45:30 +00002995o If both the SROM and the environment contain a MAC address, and the
2996 addresses differ, the value from the environment is used and a
2997 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002998
wdenk6c59edc2004-05-03 20:45:30 +00002999o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05003000 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3001 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003002
Ben Warren6db991a2010-04-26 11:11:46 -07003003If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003004will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003005may be skipped by setting the appropriate 'ethmacskip' environment variable.
3006The naming convention is as follows:
3007"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003008
wdenk6c59edc2004-05-03 20:45:30 +00003009Image Formats:
3010==============
wdenkc6097192002-11-03 00:24:07 +00003011
Marian Balakowicz18710b82008-03-12 12:13:13 +01003012U-Boot is capable of booting (and performing other auxiliary operations on)
3013images in two formats:
3014
3015New uImage format (FIT)
3016-----------------------
3017
3018Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3019to Flattened Device Tree). It allows the use of images with multiple
3020components (several kernels, ramdisks, etc.), with contents protected by
3021SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3022
3023
3024Old uImage format
3025-----------------
3026
3027Old image format is based on binary files which can be basically anything,
3028preceded by a special header; see the definitions in include/image.h for
3029details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003030
wdenk6c59edc2004-05-03 20:45:30 +00003031* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3032 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003033 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3034 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3035 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003036* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003037 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003038 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003039* Compression Type (uncompressed, gzip, bzip2)
3040* Load Address
3041* Entry Point
3042* Image Name
3043* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003044
wdenk6c59edc2004-05-03 20:45:30 +00003045The header is marked by a special Magic Number, and both the header
3046and the data portions of the image are secured against corruption by
3047CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003048
wdenkc6097192002-11-03 00:24:07 +00003049
wdenk6c59edc2004-05-03 20:45:30 +00003050Linux Support:
3051==============
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk6c59edc2004-05-03 20:45:30 +00003053Although U-Boot should support any OS or standalone application
3054easily, the main focus has always been on Linux during the design of
3055U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk6c59edc2004-05-03 20:45:30 +00003057U-Boot includes many features that so far have been part of some
3058special "boot loader" code within the Linux kernel. Also, any
3059"initrd" images to be used are no longer part of one big Linux image;
3060instead, kernel and "initrd" are separate images. This implementation
3061serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003062
wdenk6c59edc2004-05-03 20:45:30 +00003063- the same features can be used for other OS or standalone
3064 applications (for instance: using compressed images to reduce the
3065 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk6c59edc2004-05-03 20:45:30 +00003067- it becomes much easier to port new Linux kernel versions because
3068 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003069
wdenk6c59edc2004-05-03 20:45:30 +00003070- the same Linux kernel image can now be used with different "initrd"
3071 images; of course this also means that different kernel images can
3072 be run with the same "initrd". This makes testing easier (you don't
3073 have to build a new "zImage.initrd" Linux image when you just
3074 change a file in your "initrd"). Also, a field-upgrade of the
3075 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003076
wdenkc6097192002-11-03 00:24:07 +00003077
wdenk6c59edc2004-05-03 20:45:30 +00003078Linux HOWTO:
3079============
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk6c59edc2004-05-03 20:45:30 +00003081Porting Linux to U-Boot based systems:
3082---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003083
wdenk6c59edc2004-05-03 20:45:30 +00003084U-Boot cannot save you from doing all the necessary modifications to
3085configure the Linux device drivers for use with your target hardware
3086(no, we don't intend to provide a full virtual machine interface to
3087Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003088
Stefan Roese88fbf932010-04-15 16:07:28 +02003089But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk6c59edc2004-05-03 20:45:30 +00003091Just make sure your machine specific header file (for instance
3092include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003093Information structure as we define in include/asm-<arch>/u-boot.h,
3094and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003095as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003096
Simon Glassd097e592014-06-11 23:29:46 -06003097Note that U-Boot now has a driver model, a unified model for drivers.
3098If you are adding a new driver, plumb it into driver model. If there
3099is no uclass available, you are encouraged to create one. See
3100doc/driver-model.
3101
wdenkc6097192002-11-03 00:24:07 +00003102
wdenk6c59edc2004-05-03 20:45:30 +00003103Configuring the Linux kernel:
3104-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003105
wdenk6c59edc2004-05-03 20:45:30 +00003106No specific requirements for U-Boot. Make sure you have some root
3107device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003108
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk6c59edc2004-05-03 20:45:30 +00003110Building a Linux Image:
3111-----------------------
wdenkc6097192002-11-03 00:24:07 +00003112
wdenk6c59edc2004-05-03 20:45:30 +00003113With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3114not used. If you use recent kernel source, a new build target
3115"uImage" will exist which automatically builds an image usable by
3116U-Boot. Most older kernels also have support for a "pImage" target,
3117which was introduced for our predecessor project PPCBoot and uses a
3118100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003119
wdenk6c59edc2004-05-03 20:45:30 +00003120Example:
wdenkc6097192002-11-03 00:24:07 +00003121
Holger Freyther7ba4e572014-08-04 09:26:05 +02003122 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003123 make oldconfig
3124 make dep
3125 make uImage
wdenkc6097192002-11-03 00:24:07 +00003126
wdenk6c59edc2004-05-03 20:45:30 +00003127The "uImage" build target uses a special tool (in 'tools/mkimage') to
3128encapsulate a compressed Linux kernel image with header information,
3129CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003130
wdenk6c59edc2004-05-03 20:45:30 +00003131* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003132
wdenk6c59edc2004-05-03 20:45:30 +00003133* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003134
wdenk6c59edc2004-05-03 20:45:30 +00003135 ${CROSS_COMPILE}-objcopy -O binary \
3136 -R .note -R .comment \
3137 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003138
wdenk6c59edc2004-05-03 20:45:30 +00003139* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003140
wdenk6c59edc2004-05-03 20:45:30 +00003141 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003142
wdenk6c59edc2004-05-03 20:45:30 +00003143* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003144
wdenk6c59edc2004-05-03 20:45:30 +00003145 mkimage -A ppc -O linux -T kernel -C gzip \
3146 -a 0 -e 0 -n "Linux Kernel Image" \
3147 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003148
wdenkc6097192002-11-03 00:24:07 +00003149
wdenk6c59edc2004-05-03 20:45:30 +00003150The "mkimage" tool can also be used to create ramdisk images for use
3151with U-Boot, either separated from the Linux kernel image, or
3152combined into one file. "mkimage" encapsulates the images with a 64
3153byte header containing information about target architecture,
3154operating system, image type, compression method, entry points, time
3155stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk6c59edc2004-05-03 20:45:30 +00003157"mkimage" can be called in two ways: to verify existing images and
3158print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003159
wdenk6c59edc2004-05-03 20:45:30 +00003160In the first form (with "-l" option) mkimage lists the information
3161contained in the header of an existing U-Boot image; this includes
3162checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003163
wdenk6c59edc2004-05-03 20:45:30 +00003164 tools/mkimage -l image
3165 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003166
wdenk6c59edc2004-05-03 20:45:30 +00003167The second form (with "-d" option) is used to build a U-Boot image
3168from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003169
wdenk6c59edc2004-05-03 20:45:30 +00003170 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3171 -n name -d data_file image
3172 -A ==> set architecture to 'arch'
3173 -O ==> set operating system to 'os'
3174 -T ==> set image type to 'type'
3175 -C ==> set compression type 'comp'
3176 -a ==> set load address to 'addr' (hex)
3177 -e ==> set entry point to 'ep' (hex)
3178 -n ==> set image name to 'name'
3179 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003180
wdenkcd914452004-05-29 16:53:29 +00003181Right now, all Linux kernels for PowerPC systems use the same load
3182address (0x00000000), but the entry point address depends on the
3183kernel version:
wdenkc6097192002-11-03 00:24:07 +00003184
wdenk6c59edc2004-05-03 20:45:30 +00003185- 2.2.x kernels have the entry point at 0x0000000C,
3186- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003187
wdenk6c59edc2004-05-03 20:45:30 +00003188So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003189
wdenk6c59edc2004-05-03 20:45:30 +00003190 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3191 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003192 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003193 > examples/uImage.TQM850L
3194 Image Name: 2.4.4 kernel for TQM850L
3195 Created: Wed Jul 19 02:34:59 2000
3196 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3197 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3198 Load Address: 0x00000000
3199 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003200
wdenk6c59edc2004-05-03 20:45:30 +00003201To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk6c59edc2004-05-03 20:45:30 +00003203 -> tools/mkimage -l examples/uImage.TQM850L
3204 Image Name: 2.4.4 kernel for TQM850L
3205 Created: Wed Jul 19 02:34:59 2000
3206 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3207 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3208 Load Address: 0x00000000
3209 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk6c59edc2004-05-03 20:45:30 +00003211NOTE: for embedded systems where boot time is critical you can trade
3212speed for memory and install an UNCOMPRESSED image instead: this
3213needs more space in Flash, but boots much faster since it does not
3214need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003215
Stefan Roese88fbf932010-04-15 16:07:28 +02003216 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003217 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3218 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003219 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003220 > examples/uImage.TQM850L-uncompressed
3221 Image Name: 2.4.4 kernel for TQM850L
3222 Created: Wed Jul 19 02:34:59 2000
3223 Image Type: PowerPC Linux Kernel Image (uncompressed)
3224 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3225 Load Address: 0x00000000
3226 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003227
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk6c59edc2004-05-03 20:45:30 +00003229Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3230when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk6c59edc2004-05-03 20:45:30 +00003232 -> tools/mkimage -n 'Simple Ramdisk Image' \
3233 > -A ppc -O linux -T ramdisk -C gzip \
3234 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3235 Image Name: Simple Ramdisk Image
3236 Created: Wed Jan 12 14:01:50 2000
3237 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3238 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3239 Load Address: 0x00000000
3240 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003241
Tyler Hicks791c7472020-10-26 10:40:24 -05003242The "dumpimage" tool can be used to disassemble or list the contents of images
3243built by mkimage. See dumpimage's help output (-h) for details.
wdenkc6097192002-11-03 00:24:07 +00003244
wdenk6c59edc2004-05-03 20:45:30 +00003245Installing a Linux Image:
3246-------------------------
wdenkc6097192002-11-03 00:24:07 +00003247
wdenk6c59edc2004-05-03 20:45:30 +00003248To downloading a U-Boot image over the serial (console) interface,
3249you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk6c59edc2004-05-03 20:45:30 +00003251 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk6c59edc2004-05-03 20:45:30 +00003253The 'objcopy' does not understand the information in the U-Boot
3254image header, so the resulting S-Record file will be relative to
3255address 0x00000000. To load it to a given address, you need to
3256specify the target address as 'offset' parameter with the 'loads'
3257command.
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk6c59edc2004-05-03 20:45:30 +00003259Example: install the image to address 0x40100000 (which on the
3260TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk6c59edc2004-05-03 20:45:30 +00003262 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk6c59edc2004-05-03 20:45:30 +00003264 .......... done
3265 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003266
wdenk6c59edc2004-05-03 20:45:30 +00003267 => loads 40100000
3268 ## Ready for S-Record download ...
3269 ~>examples/image.srec
3270 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3271 ...
3272 15989 15990 15991 15992
3273 [file transfer complete]
3274 [connected]
3275 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003276
wdenkc6097192002-11-03 00:24:07 +00003277
wdenk6c59edc2004-05-03 20:45:30 +00003278You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003279this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003280corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk6c59edc2004-05-03 20:45:30 +00003282 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003283
wdenk6c59edc2004-05-03 20:45:30 +00003284 ## Checking Image at 40100000 ...
3285 Image Name: 2.2.13 for initrd on TQM850L
3286 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3287 Data Size: 335725 Bytes = 327 kB = 0 MB
3288 Load Address: 00000000
3289 Entry Point: 0000000c
3290 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003291
3292
wdenk6c59edc2004-05-03 20:45:30 +00003293Boot Linux:
3294-----------
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk6c59edc2004-05-03 20:45:30 +00003296The "bootm" command is used to boot an application that is stored in
3297memory (RAM or Flash). In case of a Linux kernel image, the contents
3298of the "bootargs" environment variable is passed to the kernel as
3299parameters. You can check and modify this variable using the
3300"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003301
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk6c59edc2004-05-03 20:45:30 +00003303 => printenv bootargs
3304 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003305
wdenk6c59edc2004-05-03 20:45:30 +00003306 => 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 +00003307
wdenk6c59edc2004-05-03 20:45:30 +00003308 => printenv bootargs
3309 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 +00003310
wdenk6c59edc2004-05-03 20:45:30 +00003311 => bootm 40020000
3312 ## Booting Linux kernel at 40020000 ...
3313 Image Name: 2.2.13 for NFS on TQM850L
3314 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3315 Data Size: 381681 Bytes = 372 kB = 0 MB
3316 Load Address: 00000000
3317 Entry Point: 0000000c
3318 Verifying Checksum ... OK
3319 Uncompressing Kernel Image ... OK
3320 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
3321 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3322 time_init: decrementer frequency = 187500000/60
3323 Calibrating delay loop... 49.77 BogoMIPS
3324 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3325 ...
wdenkc6097192002-11-03 00:24:07 +00003326
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003327If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003328the memory addresses of both the kernel and the initrd image (PPBCOOT
3329format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk6c59edc2004-05-03 20:45:30 +00003331 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333 ## Checking Image at 40100000 ...
3334 Image Name: 2.2.13 for initrd on TQM850L
3335 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3336 Data Size: 335725 Bytes = 327 kB = 0 MB
3337 Load Address: 00000000
3338 Entry Point: 0000000c
3339 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003340
wdenk6c59edc2004-05-03 20:45:30 +00003341 ## Checking Image at 40200000 ...
3342 Image Name: Simple Ramdisk Image
3343 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3344 Data Size: 566530 Bytes = 553 kB = 0 MB
3345 Load Address: 00000000
3346 Entry Point: 00000000
3347 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003348
wdenk6c59edc2004-05-03 20:45:30 +00003349 => bootm 40100000 40200000
3350 ## Booting Linux kernel at 40100000 ...
3351 Image Name: 2.2.13 for initrd on TQM850L
3352 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3353 Data Size: 335725 Bytes = 327 kB = 0 MB
3354 Load Address: 00000000
3355 Entry Point: 0000000c
3356 Verifying Checksum ... OK
3357 Uncompressing Kernel Image ... OK
3358 ## Loading RAMDisk Image at 40200000 ...
3359 Image Name: Simple Ramdisk Image
3360 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3361 Data Size: 566530 Bytes = 553 kB = 0 MB
3362 Load Address: 00000000
3363 Entry Point: 00000000
3364 Verifying Checksum ... OK
3365 Loading Ramdisk ... OK
3366 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
3367 Boot arguments: root=/dev/ram
3368 time_init: decrementer frequency = 187500000/60
3369 Calibrating delay loop... 49.77 BogoMIPS
3370 ...
3371 RAMDISK: Compressed image found at block 0
3372 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003373
wdenk6c59edc2004-05-03 20:45:30 +00003374 bash#
wdenkc6097192002-11-03 00:24:07 +00003375
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003376Boot Linux and pass a flat device tree:
3377-----------
3378
3379First, U-Boot must be compiled with the appropriate defines. See the section
3380titled "Linux Kernel Interface" above for a more in depth explanation. The
3381following is an example of how to start a kernel and pass an updated
3382flat device tree:
3383
3384=> print oftaddr
3385oftaddr=0x300000
3386=> print oft
3387oft=oftrees/mpc8540ads.dtb
3388=> tftp $oftaddr $oft
3389Speed: 1000, full duplex
3390Using TSEC0 device
3391TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3392Filename 'oftrees/mpc8540ads.dtb'.
3393Load address: 0x300000
3394Loading: #
3395done
3396Bytes transferred = 4106 (100a hex)
3397=> tftp $loadaddr $bootfile
3398Speed: 1000, full duplex
3399Using TSEC0 device
3400TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3401Filename 'uImage'.
3402Load address: 0x200000
3403Loading:############
3404done
3405Bytes transferred = 1029407 (fb51f hex)
3406=> print loadaddr
3407loadaddr=200000
3408=> print oftaddr
3409oftaddr=0x300000
3410=> bootm $loadaddr - $oftaddr
3411## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003412 Image Name: Linux-2.6.17-dirty
3413 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3414 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003415 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003416 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003417 Verifying Checksum ... OK
3418 Uncompressing Kernel Image ... OK
3419Booting using flat device tree at 0x300000
3420Using MPC85xx ADS machine description
3421Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3422[snip]
3423
3424
wdenk6c59edc2004-05-03 20:45:30 +00003425More About U-Boot Image Types:
3426------------------------------
wdenkc6097192002-11-03 00:24:07 +00003427
wdenk6c59edc2004-05-03 20:45:30 +00003428U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk6c59edc2004-05-03 20:45:30 +00003430 "Standalone Programs" are directly runnable in the environment
3431 provided by U-Boot; it is expected that (if they behave
3432 well) you can continue to work in U-Boot after return from
3433 the Standalone Program.
3434 "OS Kernel Images" are usually images of some Embedded OS which
3435 will take over control completely. Usually these programs
3436 will install their own set of exception handlers, device
3437 drivers, set up the MMU, etc. - this means, that you cannot
3438 expect to re-enter U-Boot except by resetting the CPU.
3439 "RAMDisk Images" are more or less just data blocks, and their
3440 parameters (address, size) are passed to an OS kernel that is
3441 being started.
3442 "Multi-File Images" contain several images, typically an OS
3443 (Linux) kernel image and one or more data images like
3444 RAMDisks. This construct is useful for instance when you want
3445 to boot over the network using BOOTP etc., where the boot
3446 server provides just a single image file, but you want to get
3447 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk6c59edc2004-05-03 20:45:30 +00003449 "Multi-File Images" start with a list of image sizes, each
3450 image size (in bytes) specified by an "uint32_t" in network
3451 byte order. This list is terminated by an "(uint32_t)0".
3452 Immediately after the terminating 0 follow the images, one by
3453 one, all aligned on "uint32_t" boundaries (size rounded up to
3454 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk6c59edc2004-05-03 20:45:30 +00003456 "Firmware Images" are binary images containing firmware (like
3457 U-Boot or FPGA images) which usually will be programmed to
3458 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003459
wdenk6c59edc2004-05-03 20:45:30 +00003460 "Script files" are command sequences that will be executed by
3461 U-Boot's command interpreter; this feature is especially
3462 useful when you configure U-Boot to use a real shell (hush)
3463 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003464
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003465Booting the Linux zImage:
3466-------------------------
3467
3468On some platforms, it's possible to boot Linux zImage. This is done
3469using the "bootz" command. The syntax of "bootz" command is the same
3470as the syntax of "bootm" command.
3471
Tom Rini45f46d12013-05-16 11:40:11 -04003472Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00003473kernel with raw initrd images. The syntax is slightly different, the
3474address of the initrd must be augmented by it's size, in the following
3475format: "<initrd addres>:<initrd size>".
3476
stroeseb9c17c52003-04-04 15:53:41 +00003477
wdenk6c59edc2004-05-03 20:45:30 +00003478Standalone HOWTO:
3479=================
stroeseb9c17c52003-04-04 15:53:41 +00003480
wdenk6c59edc2004-05-03 20:45:30 +00003481One of the features of U-Boot is that you can dynamically load and
3482run "standalone" applications, which can use some resources of
3483U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003484
wdenk6c59edc2004-05-03 20:45:30 +00003485Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003486
wdenk6c59edc2004-05-03 20:45:30 +00003487"Hello World" Demo:
3488-------------------
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk6c59edc2004-05-03 20:45:30 +00003490'examples/hello_world.c' contains a small "Hello World" Demo
3491application; it is automatically compiled when you build U-Boot.
3492It's configured to run at address 0x00040004, so you can play with it
3493like that:
wdenkc6097192002-11-03 00:24:07 +00003494
wdenk6c59edc2004-05-03 20:45:30 +00003495 => loads
3496 ## Ready for S-Record download ...
3497 ~>examples/hello_world.srec
3498 1 2 3 4 5 6 7 8 9 10 11 ...
3499 [file transfer complete]
3500 [connected]
3501 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk6c59edc2004-05-03 20:45:30 +00003503 => go 40004 Hello World! This is a test.
3504 ## Starting application at 0x00040004 ...
3505 Hello World
3506 argc = 7
3507 argv[0] = "40004"
3508 argv[1] = "Hello"
3509 argv[2] = "World!"
3510 argv[3] = "This"
3511 argv[4] = "is"
3512 argv[5] = "a"
3513 argv[6] = "test."
3514 argv[7] = "<NULL>"
3515 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003516
wdenk6c59edc2004-05-03 20:45:30 +00003517 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003518
wdenk6c59edc2004-05-03 20:45:30 +00003519Another example, which demonstrates how to register a CPM interrupt
3520handler with the U-Boot code, can be found in 'examples/timer.c'.
3521Here, a CPM timer is set up to generate an interrupt every second.
3522The interrupt service routine is trivial, just printing a '.'
3523character, but this is just a demo program. The application can be
3524controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003525
wdenk6c59edc2004-05-03 20:45:30 +00003526 ? - print current values og the CPM Timer registers
3527 b - enable interrupts and start timer
3528 e - stop timer and disable interrupts
3529 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk6c59edc2004-05-03 20:45:30 +00003531 => loads
3532 ## Ready for S-Record download ...
3533 ~>examples/timer.srec
3534 1 2 3 4 5 6 7 8 9 10 11 ...
3535 [file transfer complete]
3536 [connected]
3537 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk6c59edc2004-05-03 20:45:30 +00003539 => go 40004
3540 ## Starting application at 0x00040004 ...
3541 TIMERS=0xfff00980
3542 Using timer 1
3543 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk6c59edc2004-05-03 20:45:30 +00003545Hit 'b':
3546 [q, b, e, ?] Set interval 1000000 us
3547 Enabling timer
3548Hit '?':
3549 [q, b, e, ?] ........
3550 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3551Hit '?':
3552 [q, b, e, ?] .
3553 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3554Hit '?':
3555 [q, b, e, ?] .
3556 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3557Hit '?':
3558 [q, b, e, ?] .
3559 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3560Hit 'e':
3561 [q, b, e, ?] ...Stopping timer
3562Hit 'q':
3563 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003564
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk6c59edc2004-05-03 20:45:30 +00003566Minicom warning:
3567================
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk6c59edc2004-05-03 20:45:30 +00003569Over time, many people have reported problems when trying to use the
3570"minicom" terminal emulation program for serial download. I (wd)
3571consider minicom to be broken, and recommend not to use it. Under
3572Unix, I recommend to use C-Kermit for general purpose use (and
3573especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003574use "cu" for S-Record download ("loads" command). See
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003575https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003576for help with kermit.
3577
wdenkc6097192002-11-03 00:24:07 +00003578
wdenk6c59edc2004-05-03 20:45:30 +00003579Nevertheless, if you absolutely want to use it try adding this
3580configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003581
wdenk6c59edc2004-05-03 20:45:30 +00003582 Name Program Name U/D FullScr IO-Red. Multi
3583 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3584 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003585
wdenk8dba0502003-03-31 16:34:49 +00003586
wdenk6c59edc2004-05-03 20:45:30 +00003587NetBSD Notes:
3588=============
wdenkc6097192002-11-03 00:24:07 +00003589
wdenk6c59edc2004-05-03 20:45:30 +00003590Starting at version 0.9.2, U-Boot supports NetBSD both as host
3591(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003592
wdenk6c59edc2004-05-03 20:45:30 +00003593Building requires a cross environment; it is known to work on
3594NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3595need gmake since the Makefiles are not compatible with BSD make).
3596Note that the cross-powerpc package does not install include files;
3597attempting to build U-Boot will fail because <machine/ansi.h> is
3598missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003599
wdenk6c59edc2004-05-03 20:45:30 +00003600 # cd /usr/pkg/cross/powerpc-netbsd/include
3601 # mkdir powerpc
3602 # ln -s powerpc machine
3603 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3604 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003605
wdenk6c59edc2004-05-03 20:45:30 +00003606Native builds *don't* work due to incompatibilities between native
3607and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003608
wdenk6c59edc2004-05-03 20:45:30 +00003609Booting assumes that (the first part of) the image booted is a
3610stage-2 loader which in turn loads and then invokes the kernel
3611proper. Loader sources will eventually appear in the NetBSD source
3612tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003613meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003614
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk6c59edc2004-05-03 20:45:30 +00003616Implementation Internals:
3617=========================
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk6c59edc2004-05-03 20:45:30 +00003619The following is not intended to be a complete description of every
3620implementation detail. However, it should help to understand the
3621inner workings of U-Boot and make it easier to port it to custom
3622hardware.
wdenkc6097192002-11-03 00:24:07 +00003623
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk6c59edc2004-05-03 20:45:30 +00003625Initial Stack, Global Data:
3626---------------------------
wdenkc6097192002-11-03 00:24:07 +00003627
wdenk6c59edc2004-05-03 20:45:30 +00003628The implementation of U-Boot is complicated by the fact that U-Boot
3629starts running out of ROM (flash memory), usually without access to
3630system RAM (because the memory controller is not initialized yet).
3631This means that we don't have writable Data or BSS segments, and BSS
3632is not initialized as zero. To be able to get a C environment working
3633at all, we have to allocate at least a minimal stack. Implementation
3634options for this are defined and restricted by the CPU used: Some CPU
3635models provide on-chip memory (like the IMMR area on MPC8xx and
3636MPC826x processors), on others (parts of) the data cache can be
3637locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003638
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003639 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003640 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk6c59edc2004-05-03 20:45:30 +00003642 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3643 From: "Chris Hallinan" <clh@net1plus.com>
3644 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3645 ...
wdenkc6097192002-11-03 00:24:07 +00003646
wdenk6c59edc2004-05-03 20:45:30 +00003647 Correct me if I'm wrong, folks, but the way I understand it
3648 is this: Using DCACHE as initial RAM for Stack, etc, does not
3649 require any physical RAM backing up the cache. The cleverness
3650 is that the cache is being used as a temporary supply of
3651 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003652 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003653 can see how this works by studying the cache architecture and
3654 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003655
wdenk6c59edc2004-05-03 20:45:30 +00003656 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3657 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003658 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003659 option should work for you. Using CS 4 should be fine if your
3660 board designers haven't used it for something that would
3661 cause you grief during the initial boot! It is frequently not
3662 used.
wdenkc6097192002-11-03 00:24:07 +00003663
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003664 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003665 with your processor/board/system design. The default value
3666 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003667 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003668 than your SDRAM module. If you have a 64MB SDRAM module, set
3669 it above 400_0000. Just make sure your board has no resources
3670 that are supposed to respond to that address! That code in
3671 start.S has been around a while and should work as is when
3672 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003673
wdenk6c59edc2004-05-03 20:45:30 +00003674 -Chris Hallinan
3675 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003676
wdenk6c59edc2004-05-03 20:45:30 +00003677It is essential to remember this, since it has some impact on the C
3678code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003679
wdenk6c59edc2004-05-03 20:45:30 +00003680* Initialized global data (data segment) is read-only. Do not attempt
3681 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003682
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003683* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00003684 as zero data - BSS segment) at all - this is undefined, initiali-
3685 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003686
wdenk6c59edc2004-05-03 20:45:30 +00003687* Stack space is very limited. Avoid big data buffers or things like
3688 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003689
wdenk6c59edc2004-05-03 20:45:30 +00003690Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003691normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00003692turned out that the implementation of U-Boot can be greatly
3693simplified by making a global data structure (gd_t) available to all
3694functions. We could pass a pointer to this data as argument to _all_
3695functions, but this would bloat the code. Instead we use a feature of
3696the GCC compiler (Global Register Variables) to share the data: we
3697place a pointer (gd) to the global data into a register which we
3698reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk6c59edc2004-05-03 20:45:30 +00003700When choosing a register for such a purpose we are restricted by the
3701relevant (E)ABI specifications for the current architecture, and by
3702GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk6c59edc2004-05-03 20:45:30 +00003704For PowerPC, the following registers have specific use:
3705 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003706 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003707 R3-R4: parameter passing and return values
3708 R5-R10: parameter passing
3709 R13: small data area pointer
3710 R30: GOT pointer
3711 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003712
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01003713 (U-Boot also uses R12 as internal GOT pointer. r12
3714 is a volatile register so r12 needs to be reset when
3715 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003716
Wolfgang Denk69c09642008-02-14 22:43:22 +01003717 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003718
wdenk6c59edc2004-05-03 20:45:30 +00003719 Note: on PPC, we could use a static initializer (since the
3720 address of the global data structure is known at compile time),
3721 but it turned out that reserving a register results in somewhat
3722 smaller code - although the code savings are not that big (on
3723 average for all boards 752 bytes for the whole U-Boot image,
3724 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk6c59edc2004-05-03 20:45:30 +00003726On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk6c59edc2004-05-03 20:45:30 +00003728 R0: function argument word/integer result
3729 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003730 R9: platform specific
3731 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00003732 R11: argument (frame) pointer
3733 R12: temporary workspace
3734 R13: stack pointer
3735 R14: link register
3736 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003737
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003738 ==> U-Boot will use R9 to hold a pointer to the global data
3739
3740 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00003741
Thomas Chou8fa38582010-05-21 11:08:03 +08003742On Nios II, the ABI is documented here:
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003743 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou8fa38582010-05-21 11:08:03 +08003744
3745 ==> U-Boot will use gp to hold a pointer to the global data
3746
3747 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3748 to access small data sections, so gp is free.
3749
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003750On NDS32, the following registers are used:
3751
3752 R0-R1: argument/return
3753 R2-R5: argument
3754 R15: temporary register for assembler
3755 R16: trampoline register
3756 R28: frame pointer (FP)
3757 R29: global pointer (GP)
3758 R30: link register (LP)
3759 R31: stack pointer (SP)
3760 PC: program counter (PC)
3761
3762 ==> U-Boot will use R10 to hold a pointer to the global data
3763
Wolfgang Denk6405a152006-03-31 18:32:53 +02003764NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3765or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003766
Rick Chend7e6f922017-12-26 13:55:59 +08003767On RISC-V, the following registers are used:
3768
3769 x0: hard-wired zero (zero)
3770 x1: return address (ra)
3771 x2: stack pointer (sp)
3772 x3: global pointer (gp)
3773 x4: thread pointer (tp)
3774 x5: link register (t0)
3775 x8: frame pointer (fp)
3776 x10-x11: arguments/return values (a0-1)
3777 x12-x17: arguments (a2-7)
3778 x28-31: temporaries (t3-6)
3779 pc: program counter (pc)
3780
3781 ==> U-Boot will use gp to hold a pointer to the global data
3782
wdenk6c59edc2004-05-03 20:45:30 +00003783Memory Management:
3784------------------
wdenkc6097192002-11-03 00:24:07 +00003785
wdenk6c59edc2004-05-03 20:45:30 +00003786U-Boot runs in system state and uses physical addresses, i.e. the
3787MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk6c59edc2004-05-03 20:45:30 +00003789The available memory is mapped to fixed addresses using the memory
3790controller. In this process, a contiguous block is formed for each
3791memory type (Flash, SDRAM, SRAM), even when it consists of several
3792physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk6c59edc2004-05-03 20:45:30 +00003794U-Boot is installed in the first 128 kB of the first Flash bank (on
3795TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3796booting and sizing and initializing DRAM, the code relocates itself
3797to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003798memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003799configuration setting]. Below that, a structure with global Board
3800Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk6c59edc2004-05-03 20:45:30 +00003802Additionally, some exception handler code is copied to the low 8 kB
3803of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003804
wdenk6c59edc2004-05-03 20:45:30 +00003805So a typical memory configuration with 16 MB of DRAM could look like
3806this:
wdenkc6097192002-11-03 00:24:07 +00003807
wdenk6c59edc2004-05-03 20:45:30 +00003808 0x0000 0000 Exception Vector code
3809 :
3810 0x0000 1FFF
3811 0x0000 2000 Free for Application Use
3812 :
3813 :
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk6c59edc2004-05-03 20:45:30 +00003815 :
3816 :
3817 0x00FB FF20 Monitor Stack (Growing downward)
3818 0x00FB FFAC Board Info Data and permanent copy of global data
3819 0x00FC 0000 Malloc Arena
3820 :
3821 0x00FD FFFF
3822 0x00FE 0000 RAM Copy of Monitor Code
3823 ... eventually: LCD or video framebuffer
3824 ... eventually: pRAM (Protected RAM - unchanged by reset)
3825 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003826
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk6c59edc2004-05-03 20:45:30 +00003828System Initialization:
3829----------------------
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk6c59edc2004-05-03 20:45:30 +00003831In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003832(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003833configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00003834To be able to re-map memory U-Boot then jumps to its link address.
3835To be able to implement the initialization code in C, a (small!)
3836initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02003837which provide such a feature like), or in a locked part of the data
3838cache. After that, U-Boot initializes the CPU core, the caches and
3839the SIU.
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk6c59edc2004-05-03 20:45:30 +00003841Next, all (potentially) available memory banks are mapped using a
3842preliminary mapping. For example, we put them on 512 MB boundaries
3843(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3844on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3845programmed for SDRAM access. Using the temporary configuration, a
3846simple memory test is run that determines the size of the SDRAM
3847banks.
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk6c59edc2004-05-03 20:45:30 +00003849When there is more than one SDRAM bank, and the banks are of
3850different size, the largest is mapped first. For equal size, the first
3851bank (CS2#) is mapped first. The first mapping is always for address
38520x00000000, with any additional banks following immediately to create
3853contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003854
wdenk6c59edc2004-05-03 20:45:30 +00003855Then, the monitor installs itself at the upper end of the SDRAM area
3856and allocates memory for use by malloc() and for the global Board
3857Info data; also, the exception vector code is copied to the low RAM
3858pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003859
wdenk6c59edc2004-05-03 20:45:30 +00003860Only after this relocation will you have a "normal" C environment;
3861until that you are restricted in several ways, mostly because you are
3862running from ROM, and because the code will have to be relocated to a
3863new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003864
wdenkc6097192002-11-03 00:24:07 +00003865
wdenk6c59edc2004-05-03 20:45:30 +00003866U-Boot Porting Guide:
3867----------------------
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3870list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003871
wdenkc6097192002-11-03 00:24:07 +00003872
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003873int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00003874{
3875 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003876
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003877 signal(SIGALRM, no_more_time);
3878 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003879
wdenk6c59edc2004-05-03 20:45:30 +00003880 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003881 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00003882 return 0;
3883 }
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003886
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003887 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00003888
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003889 if (clueless)
3890 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk6c59edc2004-05-03 20:45:30 +00003892 while (learning) {
3893 Read the README file in the top level directory;
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003894 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01003895 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00003896 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003897 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00003898 }
wdenkc6097192002-11-03 00:24:07 +00003899
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003900 if (available_money > toLocalCurrency ($2500))
3901 Buy a BDI3000;
3902 else
wdenk6c59edc2004-05-03 20:45:30 +00003903 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00003904
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003905 if (a similar board exists) { /* hopefully... */
3906 cp -a board/<similar> board/<myboard>
3907 cp include/configs/<similar>.h include/configs/<myboard>.h
3908 } else {
3909 Create your own board support subdirectory;
3910 Create your own board include/configs/<myboard>.h file;
3911 }
3912 Edit new board/<myboard> files
3913 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00003914
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003915 while (!accepted) {
3916 while (!running) {
3917 do {
3918 Add / modify source code;
3919 } until (compiles);
3920 Debug;
3921 if (clueless)
3922 email("Hi, I am having problems...");
3923 }
3924 Send patch file to the U-Boot email list;
3925 if (reasonable critiques)
3926 Incorporate improvements from email list code review;
3927 else
3928 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00003929 }
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk6c59edc2004-05-03 20:45:30 +00003931 return 0;
3932}
wdenkc6097192002-11-03 00:24:07 +00003933
wdenk6c59edc2004-05-03 20:45:30 +00003934void no_more_time (int sig)
3935{
3936 hire_a_guru();
3937}
wdenkc6097192002-11-03 00:24:07 +00003938
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk6c59edc2004-05-03 20:45:30 +00003940Coding Standards:
3941-----------------
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk6c59edc2004-05-03 20:45:30 +00003943All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02003944coding style; see the kernel coding style guide at
3945https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3946script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02003947
3948Source files originating from a different project (for example the
3949MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003950reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02003951sources.
wdenkc6097192002-11-03 00:24:07 +00003952
Detlev Zundelaa63d482006-09-01 15:39:02 +02003953Please note that U-Boot is implemented in C (and to some small parts in
3954Assembler); no C++ is used, so please do not use C++ style comments (//)
3955in your code.
wdenkad276f22004-01-04 16:28:35 +00003956
wdenk6c59edc2004-05-03 20:45:30 +00003957Please also stick to the following formatting rules:
3958- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003959- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00003960- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003961- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00003962- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk6c59edc2004-05-03 20:45:30 +00003964Submissions which do not conform to the standards may be returned
3965with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003966
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk6c59edc2004-05-03 20:45:30 +00003968Submitting Patches:
3969-------------------
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk6c59edc2004-05-03 20:45:30 +00003971Since the number of patches for U-Boot is growing, we need to
3972establish some rules. Submissions which do not conform to these rules
3973may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003974
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003975Please see https://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003976
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003977Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08003978see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003979
wdenk6c59edc2004-05-03 20:45:30 +00003980When you send a patch, please include the following information with
3981it:
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk6c59edc2004-05-03 20:45:30 +00003983* For bug fixes: a description of the bug and how your patch fixes
3984 this bug. Please try to include a way of demonstrating that the
3985 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk6c59edc2004-05-03 20:45:30 +00003987* For new features: a description of the feature and your
3988 implementation.
wdenkc6097192002-11-03 00:24:07 +00003989
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05003990* For major contributions, add a MAINTAINERS file with your
3991 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00003992
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02003993* When you add support for a new board, don't forget to add a
3994 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk6c59edc2004-05-03 20:45:30 +00003996* If your patch adds new configuration options, don't forget to
3997 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00003998
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003999* The patch itself. If you are using git (which is *strongly*
4000 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004001 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004002 the U-Boot mailing list, you will avoid most of the common problems
4003 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004004
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004005 If you cannot use git, use "diff -purN OLD NEW". If your version of
4006 diff does not support these options, then get the latest version of
4007 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004008
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004009 The current directory when running this command shall be the parent
4010 directory of the U-Boot source tree (i. e. please make sure that
4011 your patch includes sufficient directory information for the
4012 affected files).
4013
4014 We prefer patches as plain text. MIME attachments are discouraged,
4015 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004016
wdenk6c59edc2004-05-03 20:45:30 +00004017* If one logical set of modifications affects or creates several
4018 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004019
wdenk6c59edc2004-05-03 20:45:30 +00004020* Changesets that contain different, unrelated modifications shall be
4021 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004022
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk6c59edc2004-05-03 20:45:30 +00004024Notes:
wdenkc6097192002-11-03 00:24:07 +00004025
Simon Glassdc27def2016-07-27 20:33:08 -06004026* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00004027 source tree and make sure that no errors or warnings are reported
4028 for any of the boards.
4029
4030* Keep your modifications to the necessary minimum: A patch
4031 containing several unrelated changes or arbitrary reformats will be
4032 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk6c59edc2004-05-03 20:45:30 +00004034* If you modify existing code, make sure that your new code does not
4035 add to the memory footprint of the code ;-) Small is beautiful!
4036 When adding new features, these should compile conditionally only
4037 (using #ifdef), and the resulting code with the new feature
4038 disabled must not need more memory than the old code without your
4039 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004040
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004041* Remember that there is a size limit of 100 kB per message on the
4042 u-boot mailing list. Bigger patches will be moderated. If they are
4043 reasonable and not too big, they will be acknowledged. But patches
4044 bigger than the size limit should be avoided.