blob: b962ba7c2f7f1609ef3dc87b991c419950c4515b [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
Naoki Hayama65ae68a2020-10-08 13:16:25 +090061https://gitlab.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://gitlab.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
Peter Tysere4d1abc2010-04-12 22:28:21 -0500131/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
Peter Tysere4d1abc2010-04-12 22:28:21 -0500145/api Machine/arch independent API for external apps
146/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800147/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500149/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/disk Code for disk drive partition handling
151/doc Documentation (don't expect too much)
152/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400153/dts Contains Makefile for building internal U-Boot fdt.
Naoki Hayama411f5c62020-10-08 13:16:38 +0900154/env Environment files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/examples Example code for standalone applications, etc.
156/fs Filesystem code (cramfs, ext2, jffs2, etc.)
157/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500158/lib Library routines generic to all architectures
159/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500160/net Networking code
161/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500162/scripts Various build scripts and Makefiles
163/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500164/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000165
wdenkc6097192002-11-03 00:24:07 +0000166Software Configuration:
167=======================
168
169Configuration is usually done using C preprocessor defines; the
170rationale behind that is to avoid dead code whenever possible.
171
172There are two classes of configuration variables:
173
174* Configuration _OPTIONS_:
175 These are selectable by the user and have names beginning with
176 "CONFIG_".
177
178* Configuration _SETTINGS_:
179 These depend on the hardware etc. and should not be meddled with if
180 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200181 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000182
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500183Previously, all configuration was done by hand, which involved creating
184symbolic links and editing configuration files manually. More recently,
185U-Boot has added the Kbuild infrastructure used by the Linux kernel,
186allowing you to use the "make menuconfig" command to configure your
187build.
wdenkc6097192002-11-03 00:24:07 +0000188
189
190Selection of Processor Architecture and Board Type:
191---------------------------------------------------
192
193For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200194configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000195
196Example: For a TQM823L module type:
197
198 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200199 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000200
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500201Note: If you're looking for the default configuration file for a board
202you're sure used to be there but is now missing, check the file
203doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000204
Simon Glass53552c92014-03-22 17:12:59 -0600205Sandbox Environment:
206--------------------
207
208U-Boot can be built natively to run on a Linux host using the 'sandbox'
209board. This allows feature development which is not board- or architecture-
210specific to be undertaken on a native platform. The sandbox is also used to
211run some of U-Boot's tests.
212
Naoki Hayamadd860ca2020-10-08 13:16:58 +0900213See doc/arch/sandbox.rst for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600214
215
Simon Glassd8711af2015-03-03 08:03:00 -0700216Board Initialisation Flow:
217--------------------------
218
219This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500220SPL and U-Boot proper (i.e. they both follow the same rules).
221
222Note: "SPL" stands for "Secondary Program Loader," which is explained in
223more detail later in this file.
224
225At present, SPL mostly uses a separate code path, but the function names
226and roles of each function are the same. Some boards or architectures
227may not conform to this. At least most ARM boards which use
228CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700229
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500230Execution typically starts with an architecture-specific (and possibly
231CPU-specific) start.S file, such as:
232
233 - arch/arm/cpu/armv7/start.S
234 - arch/powerpc/cpu/mpc83xx/start.S
235 - arch/mips/cpu/start.S
236
237and so on. From there, three functions are called; the purpose and
238limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700239
240lowlevel_init():
241 - purpose: essential init to permit execution to reach board_init_f()
242 - no global_data or BSS
243 - there is no stack (ARMv7 may have one but it will soon be removed)
244 - must not set up SDRAM or use console
245 - must only do the bare minimum to allow execution to continue to
246 board_init_f()
247 - this is almost never needed
248 - return normally from this function
249
250board_init_f():
251 - purpose: set up the machine ready for running board_init_r():
252 i.e. SDRAM and serial UART
253 - global_data is available
254 - stack is in SRAM
255 - BSS is not available, so you cannot use global/static variables,
256 only stack variables and global_data
257
258 Non-SPL-specific notes:
259 - dram_init() is called to set up DRAM. If already done in SPL this
260 can do nothing
261
262 SPL-specific notes:
263 - you can override the entire board_init_f() function with your own
264 version as needed.
265 - preloader_console_init() can be called here in extremis
266 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayamaebfd8192020-09-24 15:57:19 +0900267 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg7673bed2019-08-08 12:54:49 -0500268 - for specific scenarios on certain architectures an early BSS *can*
269 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
270 of BSS prior to entering board_init_f()) but doing so is discouraged.
271 Instead it is strongly recommended to architect any code changes
272 or additions such to not depend on the availability of BSS during
273 board_init_f() as indicated in other sections of this README to
274 maintain compatibility and consistency across the entire code base.
Simon Glassd8711af2015-03-03 08:03:00 -0700275 - must return normally from this function (don't call board_init_r()
276 directly)
277
278Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
279this point the stack and global_data are relocated to below
280CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
281memory.
282
283board_init_r():
284 - purpose: main execution, common code
285 - global_data is available
286 - SDRAM is available
287 - BSS is available, all static/global variables can be used
288 - execution eventually continues to main_loop()
289
290 Non-SPL-specific notes:
291 - U-Boot is relocated to the top of memory and is now running from
292 there.
293
294 SPL-specific notes:
295 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
296 CONFIG_SPL_STACK_R_ADDR points into SDRAM
297 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800298 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700299 spl_board_init() function containing this call
300 - loads U-Boot or (in falcon mode) Linux
301
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
426 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
427 SoCs.
428
429 CONFIG_SYS_FSL_DDR_ADDR
430 Freescale DDR memory-mapped register base.
431
432 CONFIG_SYS_FSL_DDR_EMU
433 Specify emulator support for DDR. Some DDR features such as
434 deskew training are not available.
435
436 CONFIG_SYS_FSL_DDRC_GEN1
437 Freescale DDR1 controller.
438
439 CONFIG_SYS_FSL_DDRC_GEN2
440 Freescale DDR2 controller.
441
442 CONFIG_SYS_FSL_DDRC_GEN3
443 Freescale DDR3 controller.
444
York Sun2896cb72014-03-27 17:54:47 -0700445 CONFIG_SYS_FSL_DDRC_GEN4
446 Freescale DDR4 controller.
447
York Sun461c9392013-09-30 14:20:51 -0700448 CONFIG_SYS_FSL_DDRC_ARM_GEN3
449 Freescale DDR3 controller for ARM-based SoCs.
450
York Sunf0626592013-09-30 09:22:09 -0700451 CONFIG_SYS_FSL_DDR1
452 Board config to use DDR1. It can be enabled for SoCs with
453 Freescale DDR1 or DDR2 controllers, depending on the board
454 implemetation.
455
456 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400457 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700458 Freescale DDR2 or DDR3 controllers, depending on the board
459 implementation.
460
461 CONFIG_SYS_FSL_DDR3
462 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700463 Freescale DDR3 or DDR3L controllers.
464
465 CONFIG_SYS_FSL_DDR3L
466 Board config to use DDR3L. It can be enabled for SoCs with
467 DDR3L controllers.
468
469 CONFIG_SYS_FSL_DDR4
470 Board config to use DDR4. It can be enabled for SoCs with
471 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700472
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530473 CONFIG_SYS_FSL_IFC_BE
474 Defines the IFC controller register space as Big Endian
475
476 CONFIG_SYS_FSL_IFC_LE
477 Defines the IFC controller register space as Little Endian
478
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530479 CONFIG_SYS_FSL_IFC_CLK_DIV
480 Defines divider of platform clock(clock input to IFC controller).
481
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530482 CONFIG_SYS_FSL_LBC_CLK_DIV
483 Defines divider of platform clock(clock input to eLBC controller).
484
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530485 CONFIG_SYS_FSL_PBL_PBI
486 It enables addition of RCW (Power on reset configuration) in built image.
487 Please refer doc/README.pblimage for more details
488
489 CONFIG_SYS_FSL_PBL_RCW
490 It adds PBI(pre-boot instructions) commands in u-boot build image.
491 PBI commands can be used to configure SoC before it starts the execution.
492 Please refer doc/README.pblimage for more details
493
York Sun29647ab2014-02-10 13:59:42 -0800494 CONFIG_SYS_FSL_DDR_BE
495 Defines the DDR controller register space as Big Endian
496
497 CONFIG_SYS_FSL_DDR_LE
498 Defines the DDR controller register space as Little Endian
499
York Sun3a0916d2014-02-10 13:59:43 -0800500 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
501 Physical address from the view of DDR controllers. It is the
502 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
503 it could be different for ARM SoCs.
504
York Sunc459ae62014-02-10 13:59:44 -0800505 CONFIG_SYS_FSL_DDR_INTLV_256B
506 DDR controller interleaving on 256-byte. This is a special
507 interleaving mode, handled by Dickens for Freescale layerscape
508 SoCs with ARM core.
509
York Sun79a779b2014-08-01 15:51:00 -0700510 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
511 Number of controllers used as main memory.
512
513 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
514 Number of controllers used for other than main memory.
515
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530516 CONFIG_SYS_FSL_HAS_DP_DDR
517 Defines the SoC has DP-DDR used for DPAA.
518
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530519 CONFIG_SYS_FSL_SEC_BE
520 Defines the SEC controller register space as Big Endian
521
522 CONFIG_SYS_FSL_SEC_LE
523 Defines the SEC controller register space as Little Endian
524
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200525- MIPS CPU options:
526 CONFIG_SYS_INIT_SP_OFFSET
527
528 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
529 pointer. This is needed for the temporary stack before
530 relocation.
531
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200532 CONFIG_XWAY_SWAP_BYTES
533
534 Enable compilation of tools/xway-swap-bytes needed for Lantiq
535 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
536 be swapped if a flash programmer is used.
537
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000538- ARM options:
539 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
540
541 Select high exception vectors of the ARM core, e.g., do not
542 clear the V bit of the c1 register of CP15.
543
York Sun77a10972015-03-20 19:28:08 -0700544 COUNTER_FREQUENCY
545 Generic timer clock source frequency.
546
547 COUNTER_FREQUENCY_REAL
548 Generic timer clock source frequency if the real clock is
549 different from COUNTER_FREQUENCY, and can only be determined
550 at run time.
551
Stephen Warren8d1fb312015-01-19 16:25:52 -0700552- Tegra SoC options:
553 CONFIG_TEGRA_SUPPORT_NON_SECURE
554
555 Support executing U-Boot in non-secure (NS) mode. Certain
556 impossible actions will be skipped if the CPU is in NS mode,
557 such as ARM architectural timer initialization.
558
wdenk9b7f3842003-10-09 20:09:04 +0000559- Linux Kernel Interface:
wdenk9b7f3842003-10-09 20:09:04 +0000560 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
561
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800562 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000563 expect it to be in bytes, others in MB.
564 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
565
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400566 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200567
568 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400569 passed using flattened device trees (based on open firmware
570 concepts).
571
572 CONFIG_OF_LIBFDT
573 * New libfdt-based support
574 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500575 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400576
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200577 OF_TBCLK - The timebase frequency.
578
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200579 boards with QUICC Engines require OF_QE to set UCC MAC
580 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500581
Kumar Gala1e26aa52006-01-11 13:54:17 -0600582 CONFIG_OF_BOARD_SETUP
583
584 Board code has addition modification that it wants to make
585 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000586
Simon Glass6c0be912014-10-23 18:58:54 -0600587 CONFIG_OF_SYSTEM_SETUP
588
589 Other code has addition modification that it wants to make
590 to the flat device tree before handing it off to the kernel.
591 This causes ft_system_setup() to be called before booting
592 the kernel.
593
Heiko Schocherffb293a2009-09-23 07:56:08 +0200594 CONFIG_OF_IDE_FIXUP
595
596 U-Boot can detect if an IDE device is present or not.
597 If not, and this new config option is activated, U-Boot
598 removes the ATA node from the DTS before booting Linux,
599 so the Linux IDE driver does not probe the device and
600 crash. This is needed for buggy hardware (uc101) where
601 no pull down resistor is connected to the signal IDE5V_DD7.
602
Igor Grinberg06890672011-07-14 05:45:07 +0000603 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
604
605 This setting is mandatory for all boards that have only one
606 machine type and must be used to specify the machine type
607 number as it appears in the ARM machine registry
Naoki Hayamae0cc1852020-10-08 13:17:16 +0900608 (see https://www.arm.linux.org.uk/developer/machines/).
Igor Grinberg06890672011-07-14 05:45:07 +0000609 Only boards that have multiple machine types supported
610 in a single configuration file and the machine type is
611 runtime discoverable, do not have to use this setting.
612
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100613- vxWorks boot parameters:
614
615 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700616 environments variables: bootdev, bootfile, ipaddr, netmask,
617 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100618 It loads the vxWorks image pointed bootfile.
619
Naoki Hayama158c2262020-10-08 13:17:08 +0900620 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100621 the defaults discussed just above.
622
Aneesh V960f5c02011-06-16 23:30:47 +0000623- Cache Configuration:
Aneesh V960f5c02011-06-16 23:30:47 +0000624 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
625
Aneesh V686a0752011-06-16 23:30:51 +0000626- Cache Configuration for ARM:
627 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
628 controller
629 CONFIG_SYS_PL310_BASE - Physical base address of PL310
630 controller register space
631
wdenkda04a8b2004-08-02 23:22:59 +0000632- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200633 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000634
635 Define this if you want support for Amba PrimeCell PL010 UARTs.
636
Andreas Engel0813b122008-09-08 14:30:53 +0200637 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000638
639 Define this if you want support for Amba PrimeCell PL011 UARTs.
640
641 CONFIG_PL011_CLOCK
642
643 If you have Amba PrimeCell PL011 UARTs, set this variable to
644 the clock speed of the UARTs.
645
646 CONFIG_PL01x_PORTS
647
648 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
649 define this to a list of base addresses for each (supported)
650 port. See e.g. include/configs/versatile.h
651
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400652 CONFIG_SERIAL_HW_FLOW_CONTROL
653
654 Define this variable to enable hw flow control in serial driver.
655 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000656
wdenkc6097192002-11-03 00:24:07 +0000657- Autoboot Command:
658 CONFIG_BOOTCOMMAND
659 Only needed when CONFIG_BOOTDELAY is enabled;
660 define a command string that is automatically executed
661 when no character is read on the console interface
662 within "Boot Delay" after reset.
663
wdenkc6097192002-11-03 00:24:07 +0000664 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000665 The value of these goes into the environment as
666 "ramboot" and "nfsboot" respectively, and can be used
667 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200668 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000669
wdenkc6097192002-11-03 00:24:07 +0000670- Serial Download Echo Mode:
671 CONFIG_LOADS_ECHO
672 If defined to 1, all characters received during a
673 serial download (using the "loads" command) are
674 echoed back. This might be needed by some terminal
675 emulations (like "cu"), but may as well just take
676 time on others. This setting #define's the initial
677 value of the "loads_echo" environment variable.
678
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500679- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_KGDB_BAUDRATE
681 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200682 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000683
Simon Glassaa34ef22016-03-13 19:07:28 -0600684- Removal of commands
685 If no commands are needed to boot, you can disable
686 CONFIG_CMDLINE to remove them. In this case, the command line
687 will not be available, and when U-Boot wants to execute the
688 boot command (on start-up) it will call board_run_command()
689 instead. This can reduce image size significantly for very
690 simple boot procedures.
691
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000692- Regular expression support:
693 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200694 If this variable is defined, U-Boot is linked against
695 the SLRE (Super Light Regular Expression) library,
696 which adds regex support to some commands, as for
697 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000698
Simon Glass3d686442011-10-15 05:48:20 +0000699- Device tree:
700 CONFIG_OF_CONTROL
701 If this variable is defined, U-Boot will use a device tree
702 to configure its devices, instead of relying on statically
703 compiled #defines in the board file. This option is
704 experimental and only available on a few boards. The device
705 tree is available in the global data as gd->fdt_blob.
706
Simon Glass5cb34db2011-10-24 19:15:31 +0000707 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700708 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000709
710 CONFIG_OF_EMBED
711 If this variable is defined, U-Boot will embed a device tree
712 binary in its image. This device tree file should be in the
713 board directory and called <soc>-<board>.dts. The binary file
714 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900715 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000716
Simon Glass5cb34db2011-10-24 19:15:31 +0000717 CONFIG_OF_SEPARATE
718 If this variable is defined, U-Boot will build a device tree
719 binary. It will be called u-boot.dtb. Architecture-specific
720 code will locate it at run-time. Generally this works by:
721
722 cat u-boot.bin u-boot.dtb >image.bin
723
724 and in fact, U-Boot does this for you, creating a file called
725 u-boot-dtb.bin which is useful in the common case. You can
726 still use the individual files if you need something more
727 exotic.
728
Alex Deymo5b661ec2017-04-02 01:25:20 -0700729 CONFIG_OF_BOARD
730 If this variable is defined, U-Boot will use the device tree
731 provided by the board at runtime instead of embedding one with
732 the image. Only boards defining board_fdt_blob_setup() support
733 this option (see include/fdtdec.h file).
734
wdenkc6097192002-11-03 00:24:07 +0000735- Watchdog:
736 CONFIG_WATCHDOG
737 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000738 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200739 specific code for a watchdog. For the 8xx
740 CPUs, the SIU Watchdog feature is enabled in the SYPCR
741 register. When supported for a specific SoC is
742 available, then no further board specific code should
743 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000744
745 CONFIG_HW_WATCHDOG
746 When using a watchdog circuitry external to the used
747 SoC, then define this variable and provide board
748 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000749
750- Real-Time Clock:
751
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500752 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000753 has to be selected, too. Define exactly one of the
754 following options:
755
wdenkc6097192002-11-03 00:24:07 +0000756 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000757 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000758 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000759 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000760 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000761 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200762 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000763 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100764 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000765 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200766 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200767 CONFIG_SYS_RV3029_TCR - enable trickle charger on
768 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000769
wdenkb9bbd242003-06-30 16:24:52 +0000770 Note that if the RTC uses I2C, then the I2C interface
771 must also be configured. See I2C Support, below.
772
Peter Tyser9902e422008-12-17 16:36:21 -0600773- GPIO Support:
774 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600775
Chris Packham9b383202010-12-19 10:12:13 +0000776 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
777 chip-ngpio pairs that tell the PCA953X driver the number of
778 pins supported by a particular chip.
779
Peter Tyser9902e422008-12-17 16:36:21 -0600780 Note that if the GPIO device uses I2C, then the I2C interface
781 must also be configured. See I2C Support, below.
782
Simon Glass4dc47ca2014-06-11 23:29:41 -0600783- I/O tracing:
784 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
785 accesses and can checksum them or write a list of them out
786 to memory. See the 'iotrace' command for details. This is
787 useful for testing device drivers since it can confirm that
788 the driver behaves the same way before and after a code
789 change. Currently this is supported on sandbox and arm. To
790 add support for your architecture, add '#include <iotrace.h>'
791 to the bottom of arch/<arch>/include/asm/io.h and test.
792
793 Example output from the 'iotrace stats' command is below.
794 Note that if the trace buffer is exhausted, the checksum will
795 still continue to operate.
796
797 iotrace is enabled
798 Start: 10000000 (buffer start address)
799 Size: 00010000 (buffer size)
800 Offset: 00000120 (current buffer offset)
801 Output: 10000120 (start + offset)
802 Count: 00000018 (number of trace records)
803 CRC32: 9526fb66 (CRC32 of all trace records)
804
wdenkc6097192002-11-03 00:24:07 +0000805- Timestamp Support:
806
wdenk4a5c8a72003-03-06 00:02:04 +0000807 When CONFIG_TIMESTAMP is selected, the timestamp
808 (date and time) of an image is printed by image
809 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500810 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000811
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000812- Partition Labels (disklabels) Supported:
813 Zero or more of the following:
814 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000815 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
816 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
817 bootloader. Note 2TB partition limit; see
818 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600819 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000820 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000821
822- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000823 CONFIG_IDE_RESET_ROUTINE - this is defined in several
824 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000825
wdenk369d43d2004-03-14 14:09:05 +0000826 CONFIG_IDE_RESET - is this is defined, IDE Reset will
827 be performed by calling the function
828 ide_set_reset(int reset)
829 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000830
831- ATAPI Support:
832 CONFIG_ATAPI
833
834 Set this to enable ATAPI support.
835
wdenkf602aa02004-03-13 23:29:43 +0000836- LBA48 Support
837 CONFIG_LBA48
838
839 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100840 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000841 Whithout these , LBA48 support uses 32bit variables and will 'only'
842 support disks up to 2.1TB.
843
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200844 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000845 When enabled, makes the IDE subsystem use 64bit sector addresses.
846 Default is 32bit.
847
wdenkc6097192002-11-03 00:24:07 +0000848- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200849 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
850 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
851 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000852 maximum numbers of LUNs, SCSI ID's and target
853 devices.
wdenkc6097192002-11-03 00:24:07 +0000854
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200855 The environment variable 'scsidevs' is set to the number of
856 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000857
wdenkc6097192002-11-03 00:24:07 +0000858- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000859 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000860 Support for Intel 8254x/8257x gigabit chips.
861
862 CONFIG_E1000_SPI
863 Utility code for direct access to the SPI bus on Intel 8257x.
864 This does not do anything useful unless you set at least one
865 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
866
867 CONFIG_E1000_SPI_GENERIC
868 Allow generic access to the SPI bus on the Intel 8257x, for
869 example with the "sspi" command.
870
wdenkc6097192002-11-03 00:24:07 +0000871 CONFIG_NATSEMI
872 Support for National dp83815 chips.
873
874 CONFIG_NS8382X
875 Support for National dp8382[01] gigabit chips.
876
wdenkaa603362003-05-12 21:50:16 +0000877- NETWORK Support (other):
878
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100879 CONFIG_DRIVER_AT91EMAC
880 Support for AT91RM9200 EMAC.
881
882 CONFIG_RMII
883 Define this to use reduced MII inteface
884
885 CONFIG_DRIVER_AT91EMAC_QUIET
886 If this defined, the driver is quiet.
887 The driver doen't show link status messages.
888
Rob Herringc9830dc2011-12-15 11:15:49 +0000889 CONFIG_CALXEDA_XGMAC
890 Support for the Calxeda XGMAC device
891
Ashok93fb8722012-10-15 06:20:47 +0000892 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000893 Support for SMSC's LAN91C96 chips.
894
wdenkaa603362003-05-12 21:50:16 +0000895 CONFIG_LAN91C96_USE_32_BIT
896 Define this to enable 32 bit addressing
897
Ashok93fb8722012-10-15 06:20:47 +0000898 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000899 Support for SMSC's LAN91C111 chip
900
901 CONFIG_SMC91111_BASE
902 Define this to hold the physical address
903 of the device (I/O space)
904
905 CONFIG_SMC_USE_32_BIT
906 Define this if data bus is 32 bits
907
908 CONFIG_SMC_USE_IOFUNCS
909 Define this to use i/o functions instead of macros
910 (some hardware wont work with macros)
911
Heiko Schocher7d037f72011-11-15 10:00:04 -0500912 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
913 Define this if you have more then 3 PHYs.
914
Macpaul Lin199c6252010-12-21 16:59:46 +0800915 CONFIG_FTGMAC100
916 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
917
918 CONFIG_FTGMAC100_EGIGA
919 Define this to use GE link update with gigabit PHY.
920 Define this if FTGMAC100 is connected to gigabit PHY.
921 If your system has 10/100 PHY only, it might not occur
922 wrong behavior. Because PHY usually return timeout or
923 useless data when polling gigabit status and gigabit
924 control registers. This behavior won't affect the
925 correctnessof 10/100 link speed update.
926
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900927 CONFIG_SH_ETHER
928 Support for Renesas on-chip Ethernet controller
929
930 CONFIG_SH_ETHER_USE_PORT
931 Define the number of ports to be used
932
933 CONFIG_SH_ETHER_PHY_ADDR
934 Define the ETH PHY's address
935
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900936 CONFIG_SH_ETHER_CACHE_WRITEBACK
937 If this option is set, the driver enables cache flush.
938
Vadim Bendeburydac69642011-10-17 08:36:14 +0000939- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000940 CONFIG_TPM
941 Support TPM devices.
942
Christophe Ricard8759ff82015-10-06 22:54:41 +0200943 CONFIG_TPM_TIS_INFINEON
944 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000945 per system is supported at this time.
946
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000947 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
948 Define the burst count bytes upper limit
949
Christophe Ricard88249232016-01-21 23:27:13 +0100950 CONFIG_TPM_ST33ZP24
951 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
952
953 CONFIG_TPM_ST33ZP24_I2C
954 Support for STMicroelectronics ST33ZP24 I2C devices.
955 Requires TPM_ST33ZP24 and I2C.
956
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100957 CONFIG_TPM_ST33ZP24_SPI
958 Support for STMicroelectronics ST33ZP24 SPI devices.
959 Requires TPM_ST33ZP24 and SPI.
960
Dirk Eibach20489092013-06-26 15:55:15 +0200961 CONFIG_TPM_ATMEL_TWI
962 Support for Atmel TWI TPM device. Requires I2C support.
963
Che-liang Chiouacea5702013-04-12 11:04:34 +0000964 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000965 Support for generic parallel port TPM devices. Only one device
966 per system is supported at this time.
967
968 CONFIG_TPM_TIS_BASE_ADDRESS
969 Base address where the generic TPM device is mapped
970 to. Contemporary x86 systems usually map it at
971 0xfed40000.
972
Reinhard Pfau4fece432013-06-26 15:55:13 +0200973 CONFIG_TPM
974 Define this to enable the TPM support library which provides
975 functional interfaces to some TPM commands.
976 Requires support for a TPM device.
977
978 CONFIG_TPM_AUTH_SESSIONS
979 Define this to enable authorized functions in the TPM library.
980 Requires CONFIG_TPM and CONFIG_SHA1.
981
wdenkc6097192002-11-03 00:24:07 +0000982- USB Support:
983 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +0200984 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000985 CONFIG_USB_UHCI to enable it.
986 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000987 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000988 storage devices.
989 Note:
990 Supported are USB Keyboards and USB Floppy drives
991 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000992
Simon Glass5978cdb2012-02-27 10:52:47 +0000993 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
994 txfilltuning field in the EHCI controller on reset.
995
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -0700996 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
997 HW module registers.
998
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200999- USB Device:
1000 Define the below if you wish to use the USB console.
1001 Once firmware is rebuilt from a serial console issue the
1002 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001003 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001004 it has found a new device. The environment variable usbtty
1005 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001006 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001007 Common Device Class Abstract Control Model serial device.
1008 If you select usbtty = gserial you should be able to enumerate
1009 a Linux host by
1010 # modprobe usbserial vendor=0xVendorID product=0xProductID
1011 else if using cdc_acm, simply setting the environment
1012 variable usbtty to be cdc_acm should suffice. The following
1013 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001014
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001015 CONFIG_USB_DEVICE
1016 Define this to build a UDC device
1017
1018 CONFIG_USB_TTY
1019 Define this to have a tty type of device available to
1020 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001021
Vipin KUMARbdb17702012-03-26 15:38:06 +05301022 CONFIG_USBD_HS
1023 Define this to enable the high speed support for usb
1024 device and usbtty. If this feature is enabled, a routine
1025 int is_usbd_high_speed(void)
1026 also needs to be defined by the driver to dynamically poll
1027 whether the enumeration has succeded at high speed or full
1028 speed.
1029
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001030 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001031 Define this if you want stdin, stdout &/or stderr to
1032 be set to usbtty.
1033
Wolfgang Denke2601822006-06-14 18:14:56 +02001034 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001035 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001036 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001037 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1038 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1039 should pretend to be a Linux device to it's target host.
1040
1041 CONFIG_USBD_MANUFACTURER
1042 Define this string as the name of your company for
1043 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001044
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001045 CONFIG_USBD_PRODUCT_NAME
1046 Define this string as the name of your product
1047 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001048
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001049 CONFIG_USBD_VENDORID
1050 Define this as your assigned Vendor ID from the USB
1051 Implementors Forum. This *must* be a genuine Vendor ID
1052 to avoid polluting the USB namespace.
1053 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001054
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001055 CONFIG_USBD_PRODUCTID
1056 Define this as the unique Product ID
1057 for your device
1058 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001059
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001060- ULPI Layer Support:
1061 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1062 the generic ULPI layer. The generic layer accesses the ULPI PHY
1063 via the platform viewport, so you need both the genric layer and
1064 the viewport enabled. Currently only Chipidea/ARC based
1065 viewport is supported.
1066 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1067 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001068 If your ULPI phy needs a different reference clock than the
1069 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1070 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001071
wdenk7a428cc2003-06-15 22:40:42 +00001072- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001073 The MMC controller on the Intel PXA is supported. To
1074 enable this define CONFIG_MMC. The MMC can be
1075 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001076 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001077 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1078 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001079
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001080 CONFIG_SH_MMCIF
1081 Support for Renesas on-chip MMCIF controller
1082
1083 CONFIG_SH_MMCIF_ADDR
1084 Define the base address of MMCIF registers
1085
1086 CONFIG_SH_MMCIF_CLK
1087 Define the clock frequency for MMCIF
1088
Tom Rini58a8d322013-03-14 05:32:47 +00001089- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001090 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001091 This enables the USB portion of the DFU USB class
1092
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001093 CONFIG_DFU_NAND
1094 This enables support for exposing NAND devices via DFU.
1095
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301096 CONFIG_DFU_RAM
1097 This enables support for exposing RAM via DFU.
1098 Note: DFU spec refer to non-volatile memory usage, but
1099 allow usages beyond the scope of spec - here RAM usage,
1100 one that would help mostly the developer.
1101
Heiko Schochera2f831e2013-06-12 06:05:51 +02001102 CONFIG_SYS_DFU_DATA_BUF_SIZE
1103 Dfu transfer uses a buffer before writing data to the
1104 raw storage device. Make the size (in bytes) of this buffer
1105 configurable. The size of this buffer is also configurable
1106 through the "dfu_bufsiz" environment variable.
1107
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001108 CONFIG_SYS_DFU_MAX_FILE_SIZE
1109 When updating files rather than the raw storage device,
1110 we use a static buffer to copy the file into and then write
1111 the buffer once we've been given the whole file. Define
1112 this to the maximum filesize (in bytes) for the buffer.
1113 Default is 4 MiB if undefined.
1114
Heiko Schochere1ba1512014-03-18 08:09:56 +01001115 DFU_DEFAULT_POLL_TIMEOUT
1116 Poll timeout [ms], is the timeout a device can send to the
1117 host. The host must wait for this timeout before sending
1118 a subsequent DFU_GET_STATUS request to the device.
1119
1120 DFU_MANIFEST_POLL_TIMEOUT
1121 Poll timeout [ms], which the device sends to the host when
1122 entering dfuMANIFEST state. Host waits this timeout, before
1123 sending again an USB request to the device.
1124
wdenkda04a8b2004-08-02 23:22:59 +00001125- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001126 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001127 Define these for a default partition on a NAND device
1128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001129 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1130 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001131 Define these for a default partition on a NOR device
1132
wdenkc6097192002-11-03 00:24:07 +00001133- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001134 See Kconfig help for available keyboard drivers.
1135
1136 CONFIG_KEYBOARD
1137
1138 Define this to enable a custom keyboard support.
1139 This simply calls drv_keyboard_init() which must be
1140 defined in your board-specific files. This option is deprecated
1141 and is only used by novena. For new boards, use driver model
1142 instead.
wdenkc6097192002-11-03 00:24:07 +00001143
1144- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001145 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001146 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001147 SOCs that have a DIU should define this macro to enable DIU
1148 support, and should also define these other macros:
1149
1150 CONFIG_SYS_DIU_ADDR
1151 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001152 CONFIG_CFB_CONSOLE
1153 CONFIG_VIDEO_SW_CURSOR
1154 CONFIG_VGA_AS_SINGLE_DEVICE
1155 CONFIG_VIDEO_LOGO
1156 CONFIG_VIDEO_BMP_LOGO
1157
Timur Tabi32f709e2011-04-11 14:18:22 -05001158 The DIU driver will look for the 'video-mode' environment
1159 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001160 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001161 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001162
wdenkc6097192002-11-03 00:24:07 +00001163- LCD Support: CONFIG_LCD
1164
1165 Define this to enable LCD support (for output to LCD
1166 display); also select one of the supported displays
1167 by defining one of these:
1168
Stelian Popf6f86652008-05-09 21:57:18 +02001169 CONFIG_ATMEL_LCD:
1170
1171 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1172
wdenkc0d54ae2003-11-25 16:55:19 +00001173 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001174
wdenkc0d54ae2003-11-25 16:55:19 +00001175 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001176
wdenkc0d54ae2003-11-25 16:55:19 +00001177 CONFIG_NEC_NL6448BC20
1178
1179 NEC NL6448BC20-08. 6.5", 640x480.
1180 Active, color, single scan.
1181
1182 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001183
wdenkc0d54ae2003-11-25 16:55:19 +00001184 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001185 Active, color, single scan.
1186
1187 CONFIG_SHARP_16x9
1188
1189 Sharp 320x240. Active, color, single scan.
1190 It isn't 16x9, and I am not sure what it is.
1191
1192 CONFIG_SHARP_LQ64D341
1193
1194 Sharp LQ64D341 display, 640x480.
1195 Active, color, single scan.
1196
1197 CONFIG_HLD1045
1198
1199 HLD1045 display, 640x480.
1200 Active, color, single scan.
1201
1202 CONFIG_OPTREX_BW
1203
1204 Optrex CBL50840-2 NF-FW 99 22 M5
1205 or
1206 Hitachi LMG6912RPFC-00T
1207 or
1208 Hitachi SP14Q002
1209
1210 320x240. Black & white.
1211
Simon Glass599a4df2012-10-17 13:24:54 +00001212 CONFIG_LCD_ALIGNMENT
1213
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001214 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001215 defined then the LCD will be aligned to this value instead.
1216 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1217 here, since it is cheaper to change data cache settings on
1218 a per-section basis.
1219
1220
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001221 CONFIG_LCD_ROTATION
1222
1223 Sometimes, for example if the display is mounted in portrait
1224 mode or even if it's mounted landscape but rotated by 180degree,
1225 we need to rotate our content of the display relative to the
1226 framebuffer, so that user can read the messages which are
1227 printed out.
1228 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1229 initialized with a given rotation from "vl_rot" out of
1230 "vidinfo_t" which is provided by the board specific code.
1231 The value for vl_rot is coded as following (matching to
1232 fbcon=rotate:<n> linux-kernel commandline):
1233 0 = no rotation respectively 0 degree
1234 1 = 90 degree rotation
1235 2 = 180 degree rotation
1236 3 = 270 degree rotation
1237
1238 If CONFIG_LCD_ROTATION is not defined, the console will be
1239 initialized with 0degree rotation.
1240
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001241 CONFIG_LCD_BMP_RLE8
1242
1243 Support drawing of RLE8-compressed bitmaps on the LCD.
1244
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001245 CONFIG_I2C_EDID
1246
1247 Enables an 'i2c edid' command which can read EDID
1248 information over I2C from an attached LCD display.
1249
wdenk0e2bd9c2004-06-06 21:51:03 +00001250- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001251 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1252
1253 The clock frequency of the MII bus
1254
wdenk0e2bd9c2004-06-06 21:51:03 +00001255 CONFIG_PHY_RESET_DELAY
1256
1257 Some PHY like Intel LXT971A need extra delay after
1258 reset before any MII register access is possible.
1259 For such PHY, set this option to the usec delay
1260 required. (minimum 300usec for LXT971A)
1261
1262 CONFIG_PHY_CMD_DELAY (ppc4xx)
1263
1264 Some PHY like Intel LXT971A need extra delay after
1265 command issued before MII status register can be read
1266
wdenkc6097192002-11-03 00:24:07 +00001267- IP address:
1268 CONFIG_IPADDR
1269
1270 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001271 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001272 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001273 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001274
1275- Server IP address:
1276 CONFIG_SERVERIP
1277
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001278 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001279 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001280 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001281
Robin Getz470a6d42009-07-21 12:15:28 -04001282 CONFIG_KEEP_SERVERADDR
1283
1284 Keeps the server's MAC address, in the env 'serveraddr'
1285 for passing to bootargs (like Linux's netconsole option)
1286
Wolfgang Denk26da2992011-10-26 10:21:22 +00001287- Gateway IP address:
1288 CONFIG_GATEWAYIP
1289
1290 Defines a default value for the IP address of the
1291 default router where packets to other networks are
1292 sent to.
1293 (Environment variable "gatewayip")
1294
1295- Subnet mask:
1296 CONFIG_NETMASK
1297
1298 Defines a default value for the subnet mask (or
1299 routing prefix) which is used to determine if an IP
1300 address belongs to the local subnet or needs to be
1301 forwarded through a router.
1302 (Environment variable "netmask")
1303
wdenkc6097192002-11-03 00:24:07 +00001304- BOOTP Recovery Mode:
1305 CONFIG_BOOTP_RANDOM_DELAY
1306
1307 If you have many targets in a network that try to
1308 boot using BOOTP, you may want to avoid that all
1309 systems send out BOOTP requests at precisely the same
1310 moment (which would happen for instance at recovery
1311 from a power failure, when all systems will try to
1312 boot, thus flooding the BOOTP server. Defining
1313 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1314 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001315 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001316
1317 1st BOOTP request: delay 0 ... 1 sec
1318 2nd BOOTP request: delay 0 ... 2 sec
1319 3rd BOOTP request: delay 0 ... 4 sec
1320 4th and following
1321 BOOTP requests: delay 0 ... 8 sec
1322
Thierry Reding8977cda2014-08-19 10:21:24 +02001323 CONFIG_BOOTP_ID_CACHE_SIZE
1324
1325 BOOTP packets are uniquely identified using a 32-bit ID. The
1326 server will copy the ID from client requests to responses and
1327 U-Boot will use this to determine if it is the destination of
1328 an incoming response. Some servers will check that addresses
1329 aren't in use before handing them out (usually using an ARP
1330 ping) and therefore take up to a few hundred milliseconds to
1331 respond. Network congestion may also influence the time it
1332 takes for a response to make it back to the client. If that
1333 time is too long, U-Boot will retransmit requests. In order
1334 to allow earlier responses to still be accepted after these
1335 retransmissions, U-Boot's BOOTP client keeps a small cache of
1336 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1337 cache. The default is to keep IDs for up to four outstanding
1338 requests. Increasing this will allow U-Boot to accept offers
1339 from a BOOTP client in networks with unusually high latency.
1340
stroesee0aadfb2003-08-28 14:17:32 +00001341- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001342 You can fine tune the DHCP functionality by defining
1343 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001344
Jon Loeliger5336a762007-07-09 22:08:34 -05001345 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001346 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001347 CONFIG_BOOTP_NTPSERVER
1348 CONFIG_BOOTP_TIMEOFFSET
1349 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001350 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001351
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001352 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1353 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001354
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001355 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1356 after the configured retry count, the call will fail
1357 instead of starting over. This can be used to fail over
1358 to Link-local IP address configuration if the DHCP server
1359 is not available.
1360
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001361 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1362
1363 A 32bit value in microseconds for a delay between
1364 receiving a "DHCP Offer" and sending the "DHCP Request".
1365 This fixes a problem with certain DHCP servers that don't
1366 respond 100% of the time to a "DHCP request". E.g. On an
1367 AT91RM9200 processor running at 180MHz, this delay needed
1368 to be *at least* 15,000 usec before a Windows Server 2003
1369 DHCP server would reply 100% of the time. I recommend at
1370 least 50,000 usec to be safe. The alternative is to hope
1371 that one of the retries will be successful but note that
1372 the DHCP timeout and retry process takes a longer than
1373 this delay.
1374
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001375 - Link-local IP address negotiation:
1376 Negotiate with other link-local clients on the local network
1377 for an address that doesn't require explicit configuration.
1378 This is especially useful if a DHCP server cannot be guaranteed
1379 to exist in all environments that the device must operate.
1380
1381 See doc/README.link-local for more information.
1382
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301383 - MAC address from environment variables
1384
1385 FDT_SEQ_MACADDR_FROM_ENV
1386
1387 Fix-up device tree with MAC addresses fetched sequentially from
1388 environment variables. This config work on assumption that
1389 non-usable ethernet node of device-tree are either not present
1390 or their status has been marked as "disabled".
1391
wdenk145d2c12004-04-15 21:48:45 +00001392 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001393 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001394
1395 The device id used in CDP trigger frames.
1396
1397 CONFIG_CDP_DEVICE_ID_PREFIX
1398
1399 A two character string which is prefixed to the MAC address
1400 of the device.
1401
1402 CONFIG_CDP_PORT_ID
1403
1404 A printf format string which contains the ascii name of
1405 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001406 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001407
1408 CONFIG_CDP_CAPABILITIES
1409
1410 A 32bit integer which indicates the device capabilities;
1411 0x00000010 for a normal host which does not forwards.
1412
1413 CONFIG_CDP_VERSION
1414
1415 An ascii string containing the version of the software.
1416
1417 CONFIG_CDP_PLATFORM
1418
1419 An ascii string containing the name of the platform.
1420
1421 CONFIG_CDP_TRIGGER
1422
1423 A 32bit integer sent on the trigger.
1424
1425 CONFIG_CDP_POWER_CONSUMPTION
1426
1427 A 16bit integer containing the power consumption of the
1428 device in .1 of milliwatts.
1429
1430 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1431
1432 A byte containing the id of the VLAN.
1433
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001434- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001435
1436 Several configurations allow to display the current
1437 status using a LED. For instance, the LED will blink
1438 fast while running U-Boot code, stop blinking as
1439 soon as a reply to a BOOTP request was received, and
1440 start blinking slow once the Linux kernel is running
1441 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001442 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001443 feature in U-Boot.
1444
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001445 Additional options:
1446
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001447 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001448 The status LED can be connected to a GPIO pin.
1449 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001450 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001451 to include the gpio_led driver in the U-Boot binary.
1452
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001453 CONFIG_GPIO_LED_INVERTED_TABLE
1454 Some GPIO connected LEDs may have inverted polarity in which
1455 case the GPIO high value corresponds to LED off state and
1456 GPIO low value corresponds to LED on state.
1457 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1458 with a list of GPIO LEDs that have inverted polarity.
1459
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001460- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001461
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001462 This enable the NEW i2c subsystem, and will allow you to use
1463 i2c commands at the u-boot command line (as long as you set
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001464 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1465 for defining speed and slave address
1466 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1467 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1468 for defining speed and slave address
1469 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1470 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1471 for defining speed and slave address
1472 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1473 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1474 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001475
Heiko Schocherf2850742012-10-24 13:48:22 +02001476 - drivers/i2c/fsl_i2c.c:
1477 - activate i2c driver with CONFIG_SYS_I2C_FSL
1478 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1479 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1480 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1481 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001482 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001483 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1484 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1485 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1486 second bus.
1487
Simon Glass026fefb2012-10-30 07:28:53 +00001488 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001489 - activate this driver with CONFIG_SYS_I2C_TEGRA
1490 - This driver adds 4 i2c buses with a fix speed from
1491 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001492
Dirk Eibach42b204f2013-04-25 02:40:01 +00001493 - drivers/i2c/ppc4xx_i2c.c
1494 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1495 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1496 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1497
trema49f40a2013-09-21 18:13:35 +02001498 - drivers/i2c/i2c_mxc.c
1499 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001500 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1501 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1502 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1503 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001504 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1505 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1506 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1507 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1508 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1509 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001510 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1511 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001512 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001513 for speed, and 0 for slave.
1514
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001515 - drivers/i2c/rcar_i2c.c:
1516 - activate this driver with CONFIG_SYS_I2C_RCAR
1517 - This driver adds 4 i2c buses
1518
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001519 - drivers/i2c/sh_i2c.c:
1520 - activate this driver with CONFIG_SYS_I2C_SH
1521 - This driver adds from 2 to 5 i2c buses
1522
1523 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1524 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1525 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1526 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1527 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1528 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1529 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1530 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1531 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1532 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001533 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001534
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001535 - drivers/i2c/omap24xx_i2c.c
1536 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1537 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1538 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1539 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1540 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1541 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1542 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1543 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1544 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1545 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1546 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1547
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301548 - drivers/i2c/s3c24x0_i2c.c:
1549 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1550 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1551 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1552 with a fix speed from 100000 and the slave addr 0!
1553
Dirk Eibachb9577432014-07-03 09:28:18 +02001554 - drivers/i2c/ihs_i2c.c
1555 - activate this driver with CONFIG_SYS_I2C_IHS
1556 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1557 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1558 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1559 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1560 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1561 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1562 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1563 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1564 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1565 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1566 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1567 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001568 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1569 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1570 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1571 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1572 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1573 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1574 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1575 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1576 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001577
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001578 additional defines:
1579
1580 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001581 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001582
1583 CONFIG_SYS_I2C_DIRECT_BUS
1584 define this, if you don't use i2c muxes on your hardware.
1585 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1586 omit this define.
1587
1588 CONFIG_SYS_I2C_MAX_HOPS
1589 define how many muxes are maximal consecutively connected
1590 on one i2c bus. If you not use i2c muxes, omit this
1591 define.
1592
1593 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001594 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001595 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1596 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1597 CONFIG_SYS_NUM_I2C_BUSES = 9:
1598
1599 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1600 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1601 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1602 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1603 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1604 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1605 {1, {I2C_NULL_HOP}}, \
1606 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1607 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1608 }
1609
1610 which defines
1611 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001612 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1613 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1614 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1615 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1616 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001617 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001618 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1619 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001620
1621 If you do not have i2c muxes on your board, omit this define.
1622
Simon Glass3efce392017-05-12 21:10:00 -06001623- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001624 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001625 then the following macros need to be defined (examples are
1626 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001627
1628 I2C_INIT
1629
wdenkb9bbd242003-06-30 16:24:52 +00001630 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001631 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001632
wdenk544e9732004-02-06 23:19:44 +00001633 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001634
wdenkc6097192002-11-03 00:24:07 +00001635 I2C_ACTIVE
1636
1637 The code necessary to make the I2C data line active
1638 (driven). If the data line is open collector, this
1639 define can be null.
1640
wdenkb9bbd242003-06-30 16:24:52 +00001641 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1642
wdenkc6097192002-11-03 00:24:07 +00001643 I2C_TRISTATE
1644
1645 The code necessary to make the I2C data line tri-stated
1646 (inactive). If the data line is open collector, this
1647 define can be null.
1648
wdenkb9bbd242003-06-30 16:24:52 +00001649 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1650
wdenkc6097192002-11-03 00:24:07 +00001651 I2C_READ
1652
York Sun4a598092013-04-01 11:29:11 -07001653 Code that returns true if the I2C data line is high,
1654 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001655
wdenkb9bbd242003-06-30 16:24:52 +00001656 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1657
wdenkc6097192002-11-03 00:24:07 +00001658 I2C_SDA(bit)
1659
York Sun4a598092013-04-01 11:29:11 -07001660 If <bit> is true, sets the I2C data line high. If it
1661 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001662
wdenkb9bbd242003-06-30 16:24:52 +00001663 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001664 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001665 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001666
wdenkc6097192002-11-03 00:24:07 +00001667 I2C_SCL(bit)
1668
York Sun4a598092013-04-01 11:29:11 -07001669 If <bit> is true, sets the I2C clock line high. If it
1670 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001671
wdenkb9bbd242003-06-30 16:24:52 +00001672 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001673 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001674 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001675
wdenkc6097192002-11-03 00:24:07 +00001676 I2C_DELAY
1677
1678 This delay is invoked four times per clock cycle so this
1679 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001680 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001681 like:
1682
wdenkb9bbd242003-06-30 16:24:52 +00001683 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001684
Mike Frysingeree12d542010-07-21 13:38:02 -04001685 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1686
1687 If your arch supports the generic GPIO framework (asm/gpio.h),
1688 then you may alternatively define the two GPIOs that are to be
1689 used as SCL / SDA. Any of the previous I2C_xxx macros will
1690 have GPIO-based defaults assigned to them as appropriate.
1691
1692 You should define these to the GPIO value as given directly to
1693 the generic GPIO functions.
1694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001695 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001696
wdenk57b2d802003-06-27 21:31:46 +00001697 When a board is reset during an i2c bus transfer
1698 chips might think that the current transfer is still
1699 in progress. On some boards it is possible to access
1700 the i2c SCLK line directly, either by using the
1701 processor pin as a GPIO or by having a second pin
1702 connected to the bus. If this option is defined a
1703 custom i2c_init_board() routine in boards/xxx/board.c
1704 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001705
Ben Warren45657152006-09-07 16:50:54 -04001706 CONFIG_I2C_MULTI_BUS
1707
1708 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001709 must have a controller. At any point in time, only one bus is
1710 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001711 Note that bus numbering is zero-based.
1712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001713 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001714
1715 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001716 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001717 is set, specify a list of bus-device pairs. Otherwise, specify
1718 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001719
1720 e.g.
1721 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001722 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001723
1724 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1725
Wolfgang Denk092ae952011-10-26 10:21:21 +00001726 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001727 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001728
1729 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1730
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001731 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001732
1733 If defined, then this indicates the I2C bus number for DDR SPD.
1734 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001736 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001737
1738 If defined, then this indicates the I2C bus number for the RTC.
1739 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1740
Andrew Dyer58c41f92008-12-29 17:36:01 -06001741 CONFIG_SOFT_I2C_READ_REPEATED_START
1742
1743 defining this will force the i2c_read() function in
1744 the soft_i2c driver to perform an I2C repeated start
1745 between writing the address pointer and reading the
1746 data. If this define is omitted the default behaviour
1747 of doing a stop-start sequence will be used. Most I2C
1748 devices can use either method, but some require one or
1749 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001750
wdenkc6097192002-11-03 00:24:07 +00001751- SPI Support: CONFIG_SPI
1752
1753 Enables SPI driver (so far only tested with
1754 SPI EEPROM, also an instance works with Crystal A/D and
1755 D/As on the SACSng board)
1756
wdenkc6097192002-11-03 00:24:07 +00001757 CONFIG_SOFT_SPI
1758
wdenk4a5c8a72003-03-06 00:02:04 +00001759 Enables a software (bit-bang) SPI driver rather than
1760 using hardware support. This is a general purpose
1761 driver that only requires three general I/O port pins
1762 (two outputs, one input) to function. If this is
1763 defined, the board configuration must define several
1764 SPI configuration items (port pins to use, etc). For
1765 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001766
Heiko Schocherb77c8882014-07-14 10:22:11 +02001767 CONFIG_SYS_SPI_MXC_WAIT
1768 Timeout for waiting until spi transfer completed.
1769 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1770
Matthias Fuchsa4400872007-12-27 17:12:34 +01001771- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001772
Matthias Fuchsa4400872007-12-27 17:12:34 +01001773 Enables FPGA subsystem.
1774
1775 CONFIG_FPGA_<vendor>
1776
1777 Enables support for specific chip vendors.
1778 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001779
Matthias Fuchsa4400872007-12-27 17:12:34 +01001780 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001781
Matthias Fuchsa4400872007-12-27 17:12:34 +01001782 Enables support for FPGA family.
1783 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1784
1785 CONFIG_FPGA_COUNT
1786
1787 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001789 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001790
wdenk57b2d802003-06-27 21:31:46 +00001791 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001792
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001793 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001794
wdenk4a5c8a72003-03-06 00:02:04 +00001795 Enable checks on FPGA configuration interface busy
1796 status by the configuration function. This option
1797 will require a board or device specific function to
1798 be written.
wdenkc6097192002-11-03 00:24:07 +00001799
1800 CONFIG_FPGA_DELAY
1801
1802 If defined, a function that provides delays in the FPGA
1803 configuration driver.
1804
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001805 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001806 Allow Control-C to interrupt FPGA configuration
1807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001808 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001809
wdenk4a5c8a72003-03-06 00:02:04 +00001810 Check for configuration errors during FPGA bitfile
1811 loading. For example, abort during Virtex II
1812 configuration if the INIT_B line goes low (which
1813 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001815 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001816
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001817 Maximum time to wait for the INIT_B line to de-assert
1818 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001819 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001820 ms.
wdenkc6097192002-11-03 00:24:07 +00001821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001822 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001823
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001824 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001825 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001826
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001827 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001828
wdenk4a5c8a72003-03-06 00:02:04 +00001829 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001830 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001831
1832- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02001833
wdenkc6097192002-11-03 00:24:07 +00001834 CONFIG_IDENT_STRING
1835
wdenk4a5c8a72003-03-06 00:02:04 +00001836 If defined, this string will be added to the U-Boot
1837 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001838
1839- Vendor Parameter Protection:
1840
wdenk4a5c8a72003-03-06 00:02:04 +00001841 U-Boot considers the values of the environment
1842 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001843 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001844 are set once by the board vendor / manufacturer, and
1845 protects these variables from casual modification by
1846 the user. Once set, these variables are read-only,
1847 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001848 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001849
1850 If CONFIG_ENV_OVERWRITE is #defined in your config
1851 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001852 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001853 these parameters.
1854
Joe Hershberger76f353e2015-05-04 14:55:14 -05001855 Alternatively, if you define _both_ an ethaddr in the
1856 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001857 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001858 which can be changed exactly ONCE by the user. [The
1859 serial# is unaffected by this, i. e. it remains
1860 read-only.]
1861
Joe Hershberger71497d02012-12-11 22:16:31 -06001862 The same can be accomplished in a more flexible way
1863 for any variable by configuring the type of access
1864 to allow for those variables in the ".flags" variable
1865 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1866
wdenkc6097192002-11-03 00:24:07 +00001867- Protected RAM:
1868 CONFIG_PRAM
1869
1870 Define this variable to enable the reservation of
1871 "protected RAM", i. e. RAM which is not overwritten
1872 by U-Boot. Define CONFIG_PRAM to hold the number of
1873 kB you want to reserve for pRAM. You can overwrite
1874 this default value by defining an environment
1875 variable "pram" to the number of kB you want to
1876 reserve. Note that the board info structure will
1877 still show the full amount of RAM. If pRAM is
1878 reserved, a new environment variable "mem" will
1879 automatically be defined to hold the amount of
1880 remaining RAM in a form that can be passed as boot
1881 argument to Linux, for instance like that:
1882
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001883 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001884 saveenv
1885
1886 This way you can tell Linux not to use this memory,
1887 either, which results in a memory region that will
1888 not be affected by reboots.
1889
1890 *WARNING* If your board configuration uses automatic
1891 detection of the RAM size, you must make sure that
1892 this memory test is non-destructive. So far, the
1893 following board configurations are known to be
1894 "pRAM-clean":
1895
Heiko Schocher65d94db2017-06-07 17:33:09 +02001896 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00001897 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02001898 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001899
Gabe Blacka2f3a932012-12-02 04:55:18 +00001900- Access to physical memory region (> 4GB)
1901 Some basic support is provided for operations on memory not
1902 normally accessible to U-Boot - e.g. some architectures
1903 support access to more than 4GB of memory on 32-bit
1904 machines using physical address extension or similar.
1905 Define CONFIG_PHYSMEM to access this basic support, which
1906 currently only supports clearing the memory.
1907
wdenkc6097192002-11-03 00:24:07 +00001908- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001909 CONFIG_NET_RETRY_COUNT
1910
wdenk4a5c8a72003-03-06 00:02:04 +00001911 This variable defines the number of retries for
1912 network operations like ARP, RARP, TFTP, or BOOTP
1913 before giving up the operation. If not defined, a
1914 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001915
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001916 CONFIG_ARP_TIMEOUT
1917
1918 Timeout waiting for an ARP reply in milliseconds.
1919
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00001920 CONFIG_NFS_TIMEOUT
1921
1922 Timeout in milliseconds used in NFS protocol.
1923 If you encounter "ERROR: Cannot umount" in nfs command,
1924 try longer timeout such as
1925 #define CONFIG_NFS_TIMEOUT 10000UL
1926
wdenkc6097192002-11-03 00:24:07 +00001927 Note:
1928
wdenk57b2d802003-06-27 21:31:46 +00001929 In the current implementation, the local variables
1930 space and global environment variables space are
1931 separated. Local variables are those you define by
1932 simply typing `name=value'. To access a local
1933 variable later on, you have write `$name' or
1934 `${name}'; to execute the contents of a variable
1935 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001936
wdenk4a5c8a72003-03-06 00:02:04 +00001937 Global environment variables are those you use
1938 setenv/printenv to work with. To run a command stored
1939 in such a variable, you need to use the run command,
1940 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001941
1942 To store commands and special characters in a
1943 variable, please use double quotation marks
1944 surrounding the whole text of the variable, instead
1945 of the backslashes before semicolons and special
1946 symbols.
1947
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001948- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01001949 CONFIG_CMDLINE_PS_SUPPORT
1950
1951 Enable support for changing the command prompt string
1952 at run-time. Only static string is supported so far.
1953 The string is obtained from environment variables PS1
1954 and PS2.
1955
wdenkc0aa5c52003-12-06 19:49:23 +00001956- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001957 CONFIG_EXTRA_ENV_SETTINGS
1958
wdenk4a5c8a72003-03-06 00:02:04 +00001959 Define this to contain any number of null terminated
1960 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001961 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001962
wdenk4a5c8a72003-03-06 00:02:04 +00001963 For example, place something like this in your
1964 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001965
1966 #define CONFIG_EXTRA_ENV_SETTINGS \
1967 "myvar1=value1\0" \
1968 "myvar2=value2\0"
1969
wdenk4a5c8a72003-03-06 00:02:04 +00001970 Warning: This method is based on knowledge about the
1971 internal format how the environment is stored by the
1972 U-Boot code. This is NOT an official, exported
1973 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001974 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001975 You better know what you are doing here.
1976
wdenk4a5c8a72003-03-06 00:02:04 +00001977 Note: overly (ab)use of the default environment is
1978 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001979 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00001980 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001981
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001982 CONFIG_DELAY_ENVIRONMENT
1983
1984 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001985 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001986 that so that the environment is not available until
1987 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1988 this is instead controlled by the value of
1989 /config/load-environment.
1990
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001991- TFTP Fixed UDP Port:
1992 CONFIG_TFTP_PORT
1993
Wolfgang Denk227b5192005-09-24 23:25:46 +02001994 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001995 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001996 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001997 number generator is used.
1998
Wolfgang Denk227b5192005-09-24 23:25:46 +02001999 Also, the environment variable tftpdstp is used to supply
2000 the TFTP UDP destination port value. If tftpdstp isn't
2001 defined, the normal port 69 is used.
2002
2003 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002004 blindly start the TFTP transfer using the pre-configured
2005 target IP address and UDP port. This has the effect of
2006 "punching through" the (Windows XP) firewall, allowing
2007 the remainder of the TFTP transfer to proceed normally.
2008 A better solution is to properly configure the firewall,
2009 but sometimes that is not allowed.
2010
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002011 CONFIG_STANDALONE_LOAD_ADDR
2012
Wolfgang Denk23f78482011-10-09 21:06:34 +02002013 This option defines a board specific value for the
2014 address where standalone program gets loaded, thus
2015 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002016 settings.
2017
2018- Frame Buffer Address:
2019 CONFIG_FB_ADDR
2020
2021 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002022 address for frame buffer. This is typically the case
2023 when using a graphics controller has separate video
2024 memory. U-Boot will then place the frame buffer at
2025 the given address instead of dynamically reserving it
2026 in system RAM by calling lcd_setmem(), which grabs
2027 the memory for the frame buffer depending on the
2028 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002029
2030 Please see board_init_f function.
2031
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002032- Automatic software updates via TFTP server
2033 CONFIG_UPDATE_TFTP
2034 CONFIG_UPDATE_TFTP_CNT_MAX
2035 CONFIG_UPDATE_TFTP_MSEC_MAX
2036
2037 These options enable and control the auto-update feature;
2038 for a more detailed description refer to doc/README.update.
2039
2040- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02002041 CONFIG_MTD_UBI_WL_THRESHOLD
2042 This parameter defines the maximum difference between the highest
2043 erase counter value and the lowest erase counter value of eraseblocks
2044 of UBI devices. When this threshold is exceeded, UBI starts performing
2045 wear leveling by means of moving data from eraseblock with low erase
2046 counter to eraseblocks with high erase counter.
2047
2048 The default value should be OK for SLC NAND flashes, NOR flashes and
2049 other flashes which have eraseblock life-cycle 100000 or more.
2050 However, in case of MLC NAND flashes which typically have eraseblock
2051 life-cycle less than 10000, the threshold should be lessened (e.g.,
2052 to 128 or 256, although it does not have to be power of 2).
2053
2054 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002055
Heiko Schocherf5895d12014-06-24 10:10:04 +02002056 CONFIG_MTD_UBI_BEB_LIMIT
2057 This option specifies the maximum bad physical eraseblocks UBI
2058 expects on the MTD device (per 1024 eraseblocks). If the
2059 underlying flash does not admit of bad eraseblocks (e.g. NOR
2060 flash), this value is ignored.
2061
2062 NAND datasheets often specify the minimum and maximum NVM
2063 (Number of Valid Blocks) for the flashes' endurance lifetime.
2064 The maximum expected bad eraseblocks per 1024 eraseblocks
2065 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2066 which gives 20 for most NANDs (MaxNVB is basically the total
2067 count of eraseblocks on the chip).
2068
2069 To put it differently, if this value is 20, UBI will try to
2070 reserve about 1.9% of physical eraseblocks for bad blocks
2071 handling. And that will be 1.9% of eraseblocks on the entire
2072 NAND chip, not just the MTD partition UBI attaches. This means
2073 that if you have, say, a NAND flash chip admits maximum 40 bad
2074 eraseblocks, and it is split on two MTD partitions of the same
2075 size, UBI will reserve 40 eraseblocks when attaching a
2076 partition.
2077
2078 default: 20
2079
2080 CONFIG_MTD_UBI_FASTMAP
2081 Fastmap is a mechanism which allows attaching an UBI device
2082 in nearly constant time. Instead of scanning the whole MTD device it
2083 only has to locate a checkpoint (called fastmap) on the device.
2084 The on-flash fastmap contains all information needed to attach
2085 the device. Using fastmap makes only sense on large devices where
2086 attaching by scanning takes long. UBI will not automatically install
2087 a fastmap on old images, but you can set the UBI parameter
2088 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2089 that fastmap-enabled images are still usable with UBI implementations
2090 without fastmap support. On typical flash devices the whole fastmap
2091 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2092
2093 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2094 Set this parameter to enable fastmap automatically on images
2095 without a fastmap.
2096 default: 0
2097
Heiko Schocher94b66de2015-10-22 06:19:21 +02002098 CONFIG_MTD_UBI_FM_DEBUG
2099 Enable UBI fastmap debug
2100 default: 0
2101
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002102- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002103 CONFIG_SPL
2104 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002105
Tom Rini36853852012-02-14 07:29:40 +00002106 CONFIG_SPL_LDSCRIPT
2107 LDSCRIPT for linking the SPL binary.
2108
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002109 CONFIG_SPL_MAX_FOOTPRINT
2110 Maximum size in memory allocated to the SPL, BSS included.
2111 When defined, the linker checks that the actual memory
2112 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002113 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002114 must not be both defined at the same time.
2115
Tom Rini36853852012-02-14 07:29:40 +00002116 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002117 Maximum size of the SPL image (text, data, rodata, and
2118 linker lists sections), BSS excluded.
2119 When defined, the linker checks that the actual size does
2120 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002121
Scott Woodc4f0d002012-09-20 19:05:12 -05002122 CONFIG_SPL_RELOC_TEXT_BASE
2123 Address to relocate to. If unspecified, this is equal to
2124 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2125
Tom Rini36853852012-02-14 07:29:40 +00002126 CONFIG_SPL_BSS_START_ADDR
2127 Link address for the BSS within the SPL binary.
2128
2129 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002130 Maximum size in memory allocated to the SPL BSS.
2131 When defined, the linker checks that the actual memory used
2132 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002133 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002134 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002135
2136 CONFIG_SPL_STACK
2137 Adress of the start of the stack SPL will use
2138
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002139 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2140 When defined, SPL will panic() if the image it has
2141 loaded does not have a signature.
2142 Defining this is useful when code which loads images
2143 in SPL cannot guarantee that absolutely all read errors
2144 will be caught.
2145 An example is the LPC32XX MLC NAND driver, which will
2146 consider that a completely unreadable NAND block is bad,
2147 and thus should be skipped silently.
2148
Scott Woodc4f0d002012-09-20 19:05:12 -05002149 CONFIG_SPL_RELOC_STACK
2150 Adress of the start of the stack SPL will use after
2151 relocation. If unspecified, this is equal to
2152 CONFIG_SPL_STACK.
2153
Tom Rini36853852012-02-14 07:29:40 +00002154 CONFIG_SYS_SPL_MALLOC_START
2155 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002156 When this option is set the full malloc is used in SPL and
2157 it is set up by spl_init() and before that, the simple malloc()
2158 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002159
2160 CONFIG_SYS_SPL_MALLOC_SIZE
2161 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002162
Tom Rinic2b76002014-03-28 12:03:39 -04002163 CONFIG_SPL_OS_BOOT
2164 Enable booting directly to an OS from SPL.
2165 See also: doc/README.falcon
2166
Tom Rinife3b0c72012-08-13 11:37:56 -07002167 CONFIG_SPL_DISPLAY_PRINT
2168 For ARM, enable an optional function to print more information
2169 about the running system.
2170
Scott Wood7c810902012-09-20 16:35:21 -05002171 CONFIG_SPL_INIT_MINIMAL
2172 Arch init code should be built for a very small image
2173
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002174 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2175 Partition on the MMC to load U-Boot from when the MMC is being
2176 used in raw mode
2177
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002178 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2179 Sector to load kernel uImage from when MMC is being
2180 used in raw mode (for Falcon mode)
2181
2182 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2183 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2184 Sector and number of sectors to load kernel argument
2185 parameters from when MMC is being used in raw mode
2186 (for falcon mode)
2187
Guillaume GARDET5065b712014-10-15 17:53:13 +02002188 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2189 Filename to read to load U-Boot when reading from filesystem
2190
2191 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002192 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002193 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002194
Guillaume GARDET5065b712014-10-15 17:53:13 +02002195 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002196 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002197 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002198
Scott Wood2b36fbb2012-12-06 13:33:17 +00002199 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2200 Set this for NAND SPL on PPC mpc83xx targets, so that
2201 start.S waits for the rest of the SPL to load before
2202 continuing (the hardware starts execution after just
2203 loading the first page rather than the full 4K).
2204
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302205 CONFIG_SPL_SKIP_RELOCATE
2206 Avoid SPL relocation
2207
Jörg Krause6f8190f2018-01-14 19:26:38 +01002208 CONFIG_SPL_NAND_IDENT
2209 SPL uses the chip ID list to identify the NAND flash.
2210 Requires CONFIG_SPL_NAND_BASE.
2211
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002212 CONFIG_SPL_UBI
2213 Support for a lightweight UBI (fastmap) scanner and
2214 loader
2215
Heiko Schochercf000272014-10-31 08:31:00 +01002216 CONFIG_SPL_NAND_RAW_ONLY
2217 Support to boot only raw u-boot.bin images. Use this only
2218 if you need to save space.
2219
Ying Zhangdfb2b152013-08-16 15:16:12 +08002220 CONFIG_SPL_COMMON_INIT_DDR
2221 Set for common ddr init with serial presence detect in
2222 SPL binary.
2223
Tom Rini36853852012-02-14 07:29:40 +00002224 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2225 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2226 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2227 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2228 CONFIG_SYS_NAND_ECCBYTES
2229 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002230 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002231
2232 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002233 Location in NAND to read U-Boot from
2234
2235 CONFIG_SYS_NAND_U_BOOT_DST
2236 Location in memory to load U-Boot to
2237
2238 CONFIG_SYS_NAND_U_BOOT_SIZE
2239 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002240
2241 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002242 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002243
2244 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2245 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002246 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002247
Pavel Machekde997252012-08-30 22:42:11 +02002248 CONFIG_SPL_RAM_DEVICE
2249 Support for running image already present in ram, in SPL binary
2250
Scott Woodeb7bd972012-12-06 13:33:16 +00002251 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002252 Image offset to which the SPL should be padded before appending
2253 the SPL payload. By default, this is defined as
2254 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2255 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2256 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002257
Scott Woodf147eb72012-09-21 16:27:32 -05002258 CONFIG_SPL_TARGET
2259 Final target image containing SPL and payload. Some SPLs
2260 use an arch-specific makefile fragment instead, for
2261 example if more than one image needs to be produced.
2262
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002263 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002264 Printing information about a FIT image adds quite a bit of
2265 code to SPL. So this is normally disabled in SPL. Use this
2266 option to re-enable it. This will affect the output of the
2267 bootm command when booting a FIT image.
2268
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002269- TPL framework
2270 CONFIG_TPL
2271 Enable building of TPL globally.
2272
2273 CONFIG_TPL_PAD_TO
2274 Image offset to which the TPL should be padded before appending
2275 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002276 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2277 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2278 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002279
wdenkc0aa5c52003-12-06 19:49:23 +00002280- Interrupt support (PPC):
2281
wdenk1ebf41e2004-01-02 14:00:00 +00002282 There are common interrupt_init() and timer_interrupt()
2283 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002284 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002285 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002287 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002288 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002289 specific handling. If board has watchdog / status_led
2290 / other_activity_monitor it works automatically from
2291 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002292
wdenkc6097192002-11-03 00:24:07 +00002293
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002294Board initialization settings:
2295------------------------------
2296
2297During Initialization u-boot calls a number of board specific functions
2298to allow the preparation of board specific prerequisites, e.g. pin setup
2299before drivers are initialized. To enable these callbacks the
2300following configuration macros have to be defined. Currently this is
2301architecture specific, so please check arch/your_architecture/lib/board.c
2302typically in board_init_f() and board_init_r().
2303
2304- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2305- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2306- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2307- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002308
wdenkc6097192002-11-03 00:24:07 +00002309Configuration Settings:
2310-----------------------
2311
Simon Glass8927bf22019-12-28 10:45:10 -07002312- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08002313 Optionally it can be defined to support 64-bit memory commands.
2314
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002315- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002316 undefine this when you're short of memory.
2317
Peter Tyserdfb72b82009-01-27 18:03:12 -06002318- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2319 width of the commands listed in the 'help' command output.
2320
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002321- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002322 prompt for user input.
2323
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002324- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002326- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002328- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002330- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002331 the application (usually a Linux kernel) when it is
2332 booted
2333
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002334- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002335 List of legal baudrate settings for this board.
2336
York Sun5d286cd2015-12-04 11:57:07 -08002337- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002338 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002339 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2340 is substracted from total RAM and won't be reported to OS.
2341 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002342 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002343 the RAM base is not zero, or RAM is divided into banks,
2344 this variable needs to be recalcuated to get the address.
2345
York Sun50739372015-12-07 11:05:29 -08002346- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002347 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002348 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002349 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002350 fixing up gd->ram_size the Linux kernel should gets passed
2351 the now "corrected" memory size and won't touch it either.
2352 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002353 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002354 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002355 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002356
2357 This option can be used as a workaround for the 440EPx/GRx
2358 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2359 be touched.
2360
2361 WARNING: Please make sure that this value is a multiple of
2362 the Linux page size (normally 4k). If this is not the case,
2363 then the end address of the Linux memory will be located at a
2364 non page size aligned address and this could cause major
2365 problems.
2366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002367- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002368 Enable temporary baudrate change while serial download
2369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002370- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002371 Physical start address of SDRAM. _Must_ be 0 here.
2372
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002373- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002374 Physical start address of Flash memory.
2375
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002376- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002377 Physical start address of boot monitor code (set by
2378 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002379 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002380 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002381
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002382- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002383 Size of memory reserved for monitor code, used to
2384 determine _at_compile_time_ (!) if the environment is
2385 embedded within the U-Boot image, or in a separate
2386 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002387
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002388- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002389 Size of DRAM reserved for malloc() use.
2390
Simon Glass863e4042014-07-10 22:23:28 -06002391- CONFIG_SYS_MALLOC_F_LEN
2392 Size of the malloc() pool for use before relocation. If
2393 this is defined, then a very simple malloc() implementation
2394 will become available before relocation. The address is just
2395 below the global data, and the stack is moved down to make
2396 space.
2397
2398 This feature allocates regions with increasing addresses
2399 within the region. calloc() is supported, but realloc()
2400 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002401 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002402 U-Boot relocates itself.
2403
Simon Glass9fa901b2014-11-10 17:16:54 -07002404- CONFIG_SYS_MALLOC_SIMPLE
2405 Provides a simple and small malloc() and calloc() for those
2406 boards which do not use the full malloc in SPL (which is
2407 enabled with CONFIG_SYS_SPL_MALLOC_START).
2408
Thierry Redingc97d9742014-12-09 22:25:22 -07002409- CONFIG_SYS_NONCACHED_MEMORY:
2410 Size of non-cached memory area. This area of memory will be
2411 typically located right below the malloc() area and mapped
2412 uncached in the MMU. This is useful for drivers that would
2413 otherwise require a lot of explicit cache maintenance. For
2414 some drivers it's also impossible to properly maintain the
2415 cache. For example if the regions that need to be flushed
2416 are not a multiple of the cache-line size, *and* padding
2417 cannot be allocated between the regions to align them (i.e.
2418 if the HW requires a contiguous array of regions, and the
2419 size of each region is not cache-aligned), then a flush of
2420 one region may result in overwriting data that hardware has
2421 written to another region in the same cache-line. This can
2422 happen for example in network drivers where descriptors for
2423 buffers are typically smaller than the CPU cache-line (e.g.
2424 16 bytes vs. 32 or 64 bytes).
2425
2426 Non-cached memory is only supported on 32-bit ARM at present.
2427
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002428- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002429 Normally compressed uImages are limited to an
2430 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002431 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002432 to adjust this setting to your needs.
2433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002434- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002435 Maximum size of memory mapped by the startup code of
2436 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002437 the Linux kernel (bd_info, boot arguments, FDT blob if
2438 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002439 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002440 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002441 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002442 variable "bootm_mapsize" will override the value of
2443 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2444 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002445
John Rigbyeea8e692010-10-13 13:57:35 -06002446- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2447 Enable initrd_high functionality. If defined then the
2448 initrd_high feature is enabled and the bootm ramdisk subcommand
2449 is enabled.
2450
2451- CONFIG_SYS_BOOT_GET_CMDLINE:
2452 Enables allocating and saving kernel cmdline in space between
2453 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2454
2455- CONFIG_SYS_BOOT_GET_KBD:
2456 Enables allocating and saving a kernel copy of the bd_info in
2457 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2458
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002459- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002460 Max number of Flash memory banks
2461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002462- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002463 Max number of sectors on a Flash chip
2464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002465- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002466 Timeout for Flash erase operations (in ms)
2467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002468- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002469 Timeout for Flash write operations (in ms)
2470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002471- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002472 Timeout for Flash set sector lock bit operation (in ms)
2473
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002474- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002475 Timeout for Flash clear lock bits operation (in ms)
2476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002477- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002478 If defined, hardware flash sectors protection is used
2479 instead of U-Boot software protection.
2480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002481- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002482
2483 Enable TFTP transfers directly to flash memory;
2484 without this option such a download has to be
2485 performed in two steps: (1) download to RAM, and (2)
2486 copy from RAM to flash.
2487
2488 The two-step approach is usually more reliable, since
2489 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002490 the flash, but in some situations (when system RAM is
2491 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002492 downloaded image) this option may be very useful.
2493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002495 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002496 common flash structure for storing flash geometry.
2497
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002498- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002499 This option also enables the building of the cfi_flash driver
2500 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002501
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002502- CONFIG_FLASH_CFI_MTD
2503 This option enables the building of the cfi_mtd driver
2504 in the drivers directory. The driver exports CFI flash
2505 to the MTD layer.
2506
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002507- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002508 Use buffered writes to flash.
2509
2510- CONFIG_FLASH_SPANSION_S29WS_N
2511 s29ws-n MirrorBit flash has non-standard addresses for buffered
2512 write commands.
2513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002514- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002515 If this option is defined, the common CFI flash doesn't
2516 print it's warning upon not recognized FLASH banks. This
2517 is useful, if some of the configured banks are only
2518 optionally available.
2519
Jerry Van Barenaae73572008-03-08 13:48:01 -05002520- CONFIG_FLASH_SHOW_PROGRESS
2521 If defined (must be an integer), print out countdown
2522 digits and dots. Recommended value: 45 (9..1) for 80
2523 column displays, 15 (3..1) for 40 column displays.
2524
Stefan Roesed20cba52013-04-04 15:53:14 +02002525- CONFIG_FLASH_VERIFY
2526 If defined, the content of the flash (destination) is compared
2527 against the source after the write operation. An error message
2528 will be printed when the contents are not identical.
2529 Please note that this option is useless in nearly all cases,
2530 since such flash programming errors usually are detected earlier
2531 while unprotecting/erasing/programming. Please only enable
2532 this option if you really know what you are doing.
2533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002534- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002535 Defines the number of Ethernet receive buffers. On some
2536 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002537 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2538 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002539 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002540 Defaults to 4 if not defined.
2541
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002542- CONFIG_ENV_MAX_ENTRIES
2543
Wolfgang Denk1136f692010-10-27 22:48:30 +02002544 Maximum number of entries in the hash table that is used
2545 internally to store the environment settings. The default
2546 setting is supposed to be generous and should work in most
2547 cases. This setting can be used to tune behaviour; see
2548 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002549
Joe Hershberger71497d02012-12-11 22:16:31 -06002550- CONFIG_ENV_FLAGS_LIST_DEFAULT
2551- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002552 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002553 calling env set. Variables can be restricted to only decimal,
2554 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2555 the variables can also be restricted to IP address or MAC address.
2556
2557 The format of the list is:
2558 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002559 access_attribute = [a|r|o|c]
2560 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002561 entry = variable_name[:attributes]
2562 list = entry[,list]
2563
2564 The type attributes are:
2565 s - String (default)
2566 d - Decimal
2567 x - Hexadecimal
2568 b - Boolean ([1yYtT|0nNfF])
2569 i - IP address
2570 m - MAC address
2571
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002572 The access attributes are:
2573 a - Any (default)
2574 r - Read-only
2575 o - Write-once
2576 c - Change-default
2577
Joe Hershberger71497d02012-12-11 22:16:31 -06002578 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2579 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002580 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002581
2582 - CONFIG_ENV_FLAGS_LIST_STATIC
2583 Define this to a list (string) to define validation that
2584 should be done if an entry is not found in the ".flags"
2585 environment variable. To override a setting in the static
2586 list, simply add an entry for the same variable name to the
2587 ".flags" variable.
2588
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002589 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2590 regular expression. This allows multiple variables to define the same
2591 flags without explicitly listing them for each variable.
2592
wdenkc6097192002-11-03 00:24:07 +00002593The following definitions that deal with the placement and management
2594of environment data (variable area); in general, we support the
2595following configurations:
2596
Mike Frysinger63b8f122011-07-08 10:44:25 +00002597- CONFIG_BUILD_ENVCRC:
2598
2599 Builds up envcrc with the target environment so that external utils
2600 may easily extract it and embed it in final U-Boot images.
2601
wdenkc6097192002-11-03 00:24:07 +00002602BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002603in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002604console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002605U-Boot will hang.
2606
2607Please note that even with NVRAM we still use a copy of the
2608environment in RAM: we could work on NVRAM directly, but we want to
2609keep settings there always unmodified except somebody uses "saveenv"
2610to save the current settings.
2611
Liu Gang85bcd732012-03-08 00:33:20 +00002612BE CAREFUL! For some special cases, the local device can not use
2613"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002614environment stored in a remote NOR flash by SRIO or PCIE link,
2615but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002616
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002617- CONFIG_NAND_ENV_DST
2618
2619 Defines address in RAM to which the nand_spl code should copy the
2620 environment. If redundant environment is used, it will be copied to
2621 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2622
Bruce Adleredecc942007-11-02 13:15:42 -07002623Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002624has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002625created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002626until then to read environment variables.
2627
wdenk8dba0502003-03-31 16:34:49 +00002628The environment is protected by a CRC32 checksum. Before the monitor
2629is relocated into RAM, as a result of a bad CRC you will be working
2630with the compiled-in default environment - *silently*!!! [This is
2631necessary, because the first environment variable we need is the
2632"baudrate" setting for the console - if we have a bad CRC, we don't
2633have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002634
2635Note: once the monitor has been relocated, then it will complain if
2636the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002637use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002638
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002639- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002640 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002641
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002642 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002643 also needs to be defined.
2644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002645- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002646 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002647
Ron Madriddfa028a2009-02-18 14:30:44 -08002648- CONFIG_NS16550_MIN_FUNCTIONS:
2649 Define this if you desire to only have use of the NS16550_init
2650 and NS16550_putc functions for the serial driver located at
2651 drivers/serial/ns16550.c. This option is useful for saving
2652 space for already greatly restricted images, including but not
2653 limited to NAND_SPL configurations.
2654
Simon Glass28a9e332012-11-30 13:01:18 +00002655- CONFIG_DISPLAY_BOARDINFO
2656 Display information about the board that U-Boot is running on
2657 when U-Boot starts up. The board function checkboard() is called
2658 to do this.
2659
Simon Glasse8822012012-11-30 13:01:19 +00002660- CONFIG_DISPLAY_BOARDINFO_LATE
2661 Similar to the previous option, but display this information
2662 later, once stdio is running and output goes to the LCD, if
2663 present.
2664
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002665- CONFIG_BOARD_SIZE_LIMIT:
2666 Maximum size of the U-Boot image. When defined, the
2667 build system checks that the actual size does not
2668 exceed it.
2669
wdenkc6097192002-11-03 00:24:07 +00002670Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002671---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002672
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002673- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002674 Cache Line Size of the CPU.
2675
Timur Tabid8f341c2011-08-04 18:03:41 -05002676- CONFIG_SYS_CCSRBAR_DEFAULT:
2677 Default (power-on reset) physical address of CCSR on Freescale
2678 PowerPC SOCs.
2679
2680- CONFIG_SYS_CCSRBAR:
2681 Virtual address of CCSR. On a 32-bit build, this is typically
2682 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2683
Timur Tabid8f341c2011-08-04 18:03:41 -05002684- CONFIG_SYS_CCSRBAR_PHYS:
2685 Physical address of CCSR. CCSR can be relocated to a new
2686 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002687 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002688 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2689 is typically relocated on 36-bit builds. It is recommended
2690 that this macro be defined via the _HIGH and _LOW macros:
2691
2692 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2693 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2694
2695- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002696 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2697 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002698 used in assembly code, so it must not contain typecasts or
2699 integer size suffixes (e.g. "ULL").
2700
2701- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2702 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2703 used in assembly code, so it must not contain typecasts or
2704 integer size suffixes (e.g. "ULL").
2705
2706- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2707 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2708 forced to a value that ensures that CCSR is not relocated.
2709
Macpaul Lind1e49942011-04-11 20:45:32 +00002710- CONFIG_IDE_AHB:
2711 Most IDE controllers were designed to be connected with PCI
2712 interface. Only few of them were designed for AHB interface.
2713 When software is doing ATA command and data transfer to
2714 IDE devices through IDE-AHB controller, some additional
2715 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002716 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00002717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002718- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002719 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002720 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002722- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002723
wdenkeb20ad32003-09-05 23:19:14 +00002724 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002725 initial data and stack; please note that this must be
2726 writable memory that is working WITHOUT special
2727 initialization, i. e. you CANNOT use normal RAM which
2728 will become available only after programming the
2729 memory controller and running certain initialization
2730 sequences.
2731
2732 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002733 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002734
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002735- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002736
2737 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002738 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2739 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002740 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002741 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002742 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002743 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2744 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002745
2746 Note:
2747 On the MPC824X (or other systems that use the data
2748 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002749 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002750 point to an otherwise UNUSED address space between
2751 the top of RAM and the start of the PCI space.
2752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002753- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002755- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002756 SDRAM timing
2757
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002758- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002759 periodic timer for refresh
2760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002761- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2762 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2763 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2764 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002765 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2766
2767- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002768 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2769 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002770 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2771
Gabor Juhosb4458732013-05-30 07:06:12 +00002772- CONFIG_PCI_INDIRECT_BRIDGE:
2773 Enable support for indirect PCI bridges.
2774
Kumar Gala8975d7a2010-12-30 12:09:53 -06002775- CONFIG_SYS_SRIO:
2776 Chip has SRIO or not
2777
2778- CONFIG_SRIO1:
2779 Board has SRIO 1 port available
2780
2781- CONFIG_SRIO2:
2782 Board has SRIO 2 port available
2783
Liu Gang27afb9c2013-05-07 16:30:46 +08002784- CONFIG_SRIO_PCIE_BOOT_MASTER
2785 Board can support master function for Boot from SRIO and PCIE
2786
Kumar Gala8975d7a2010-12-30 12:09:53 -06002787- CONFIG_SYS_SRIOn_MEM_VIRT:
2788 Virtual Address of SRIO port 'n' memory region
2789
Simon Glass970b61e2019-11-14 12:57:09 -07002790- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002791 Physical Address of SRIO port 'n' memory region
2792
2793- CONFIG_SYS_SRIOn_MEM_SIZE:
2794 Size of SRIO port 'n' memory region
2795
Fabio Estevamf17e8782013-04-11 09:35:34 +00002796- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2797 Defined to tell the NAND controller that the NAND chip is using
2798 a 16 bit bus.
2799 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002800 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002801 - drivers/mtd/nand/raw/ndfc.c
2802 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002803
2804- CONFIG_SYS_NDFC_EBC0_CFG
2805 Sets the EBC0_CFG register for the NDFC. If not defined
2806 a default value will be used.
2807
Ben Warren45657152006-09-07 16:50:54 -04002808- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002809 Get DDR timing information from an I2C EEPROM. Common
2810 with pluggable memory modules such as SODIMMs
2811
Ben Warren45657152006-09-07 16:50:54 -04002812 SPD_EEPROM_ADDRESS
2813 I2C address of the SPD EEPROM
2814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002815- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002816 If SPD EEPROM is on an I2C bus other than the first
2817 one, specify here. Note that the value must resolve
2818 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002819
York Sune73cc042011-06-07 09:42:16 +08002820- CONFIG_SYS_DDR_RAW_TIMING
2821 Get DDR timing information from other than SPD. Common with
2822 soldered DDR chips onboard without SPD. DDR raw timing
2823 parameters are extracted from datasheet and hard-coded into
2824 header files or board specific files.
2825
York Sunbd495cf2011-09-16 13:21:35 -07002826- CONFIG_FSL_DDR_INTERACTIVE
2827 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2828
York Sun8ced0502015-01-06 13:18:55 -08002829- CONFIG_FSL_DDR_SYNC_REFRESH
2830 Enable sync of refresh for multiple controllers.
2831
York Sunb6a35f82015-03-19 09:30:28 -07002832- CONFIG_FSL_DDR_BIST
2833 Enable built-in memory test for Freescale DDR controllers.
2834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002835- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002836 Only for 83xx systems. If specified, then DDR should
2837 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002838
wdenk6203e402004-04-18 10:13:26 +00002839- CONFIG_RMII
2840 Enable RMII mode for all FECs.
2841 Note that this is a global option, we can't
2842 have one FEC in standard MII mode and another in RMII mode.
2843
wdenk20c98a62004-04-23 20:32:05 +00002844- CONFIG_CRC32_VERIFY
2845 Add a verify option to the crc32 command.
2846 The syntax is:
2847
2848 => crc32 -v <address> <count> <crc32>
2849
2850 Where address/count indicate a memory area
2851 and crc32 is the correct crc32 which the
2852 area should have.
2853
wdenk64519362004-07-11 17:40:54 +00002854- CONFIG_LOOPW
2855 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06002856 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00002857
Joel Johnsondb5a97e2020-01-29 09:17:18 -07002858- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00002859 Add the "mdc" and "mwc" memory commands. These are cyclic
2860 "md/mw" commands.
2861 Examples:
2862
wdenk07d7e6b2004-12-16 21:44:03 +00002863 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002864 This command will print 4 bytes (10,11,12,13) each 500 ms.
2865
wdenk07d7e6b2004-12-16 21:44:03 +00002866 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002867 This command will write 12345678 to address 100 all 10 ms.
2868
wdenk07d7e6b2004-12-16 21:44:03 +00002869 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06002870 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00002871
wdenk3d3d99f2005-04-04 12:44:11 +00002872- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chend7e6f922017-12-26 13:55:59 +08002873 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01002874 low level initializations (like setting up the memory
2875 controller) are omitted and/or U-Boot does not
2876 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00002877
Wolfgang Denk302141d2010-11-27 23:30:56 +01002878 Normally this variable MUST NOT be defined. The only
2879 exception is when U-Boot is loaded (to RAM) by some
2880 other boot loader or by a debugger which performs
2881 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002882
Simon Glass90844072016-05-05 07:28:06 -06002883- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
2884 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09002885 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06002886 instruction cache) is still performed.
2887
Aneesh V552a3192011-07-13 05:11:07 +00002888- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002889 Set when the currently-running compilation is for an artifact
2890 that will end up in the SPL (as opposed to the TPL or U-Boot
2891 proper). Code that needs stage-specific behavior should check
2892 this.
wdenk336b2bc2005-04-02 23:52:25 +00002893
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002894- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002895 Set when the currently-running compilation is for an artifact
2896 that will end up in the TPL (as opposed to the SPL or U-Boot
2897 proper). Code that needs stage-specific behavior should check
2898 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002899
Ying Zhang0d4f5442013-05-20 14:07:23 +08002900- CONFIG_SYS_MPC85XX_NO_RESETVEC
2901 Only for 85xx systems. If this variable is specified, the section
2902 .resetvec is not kept and the section .bootpg is placed in the
2903 previous 4k of the .text section.
2904
Simon Glass17dabf02013-02-24 17:33:14 +00002905- CONFIG_ARCH_MAP_SYSMEM
2906 Generally U-Boot (and in particular the md command) uses
2907 effective address. It is therefore not necessary to regard
2908 U-Boot address as virtual addresses that need to be translated
2909 to physical addresses. However, sandbox requires this, since
2910 it maintains its own little RAM buffer which contains all
2911 addressable memory. This option causes some memory accesses
2912 to be mapped through map_sysmem() / unmap_sysmem().
2913
Simon Glassbfb59802013-02-14 04:18:54 +00002914- CONFIG_X86_RESET_VECTOR
2915 If defined, the x86 reset vector code is included. This is not
2916 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00002917
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002918- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2919 Option to disable subpage write in NAND driver
2920 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002921 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002922
Timur Tabi275f4bb2011-11-22 09:21:25 -06002923Freescale QE/FMAN Firmware Support:
2924-----------------------------------
2925
2926The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2927loading of "firmware", which is encoded in the QE firmware binary format.
2928This firmware often needs to be loaded during U-Boot booting, so macros
2929are used to identify the storage device (NOR flash, SPI, etc) and the address
2930within that device.
2931
Zhao Qiang83a90842014-03-21 16:21:44 +08002932- CONFIG_SYS_FMAN_FW_ADDR
2933 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002934 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08002935 is also specified.
2936
2937- CONFIG_SYS_QE_FW_ADDR
2938 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002939 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06002940 is also specified.
2941
2942- CONFIG_SYS_QE_FMAN_FW_LENGTH
2943 The maximum possible size of the firmware. The firmware binary format
2944 has a field that specifies the actual size of the firmware, but it
2945 might not be possible to read any part of the firmware unless some
2946 local storage is allocated to hold the entire firmware first.
2947
2948- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2949 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2950 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2951 virtual address in NOR flash.
2952
2953- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2954 Specifies that QE/FMAN firmware is located in NAND flash.
2955 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2956
2957- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2958 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2959 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2960
Liu Gang1e084582012-03-08 00:33:18 +00002961- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2962 Specifies that QE/FMAN firmware is located in the remote (master)
2963 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00002964 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2965 window->master inbound window->master LAW->the ucode address in
2966 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06002967
J. German Rivera8ff14b72014-06-23 15:15:55 -07002968Freescale Layerscape Management Complex Firmware Support:
2969---------------------------------------------------------
2970The Freescale Layerscape Management Complex (MC) supports the loading of
2971"firmware".
2972This firmware often needs to be loaded during U-Boot booting, so macros
2973are used to identify the storage device (NOR flash, SPI, etc) and the address
2974within that device.
2975
2976- CONFIG_FSL_MC_ENET
2977 Enable the MC driver for Layerscape SoCs.
2978
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302979Freescale Layerscape Debug Server Support:
2980-------------------------------------------
2981The Freescale Layerscape Debug Server Support supports the loading of
2982"Debug Server firmware" and triggering SP boot-rom.
2983This firmware often needs to be loaded during U-Boot booting.
2984
York Sun928b6812015-12-07 11:08:58 -08002985- CONFIG_SYS_MC_RSV_MEM_ALIGN
2986 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302987
Paul Kocialkowski7b917022015-07-26 18:48:15 +02002988Reproducible builds
2989-------------------
2990
2991In order to achieve reproducible builds, timestamps used in the U-Boot build
2992process have to be set to a fixed value.
2993
2994This is done using the SOURCE_DATE_EPOCH environment variable.
2995SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2996option for U-Boot or an environment variable in U-Boot.
2997
2998SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2999
wdenkc6097192002-11-03 00:24:07 +00003000Building the Software:
3001======================
3002
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003003Building U-Boot has been tested in several native build environments
3004and in many different cross environments. Of course we cannot support
3005all possibly existing versions of cross development tools in all
3006(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003007recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003008which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003009
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003010If you are not using a native environment, it is assumed that you
3011have GNU cross compiling tools available in your path. In this case,
3012you must set the environment variable CROSS_COMPILE in your shell.
3013Note that no changes to the Makefile or any other source files are
3014necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003015
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003016 $ CROSS_COMPILE=ppc_4xx-
3017 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003018
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003019U-Boot is intended to be simple to build. After installing the
3020sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003021is done by typing:
3022
Holger Freyther7ba4e572014-08-04 09:26:05 +02003023 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003024
Holger Freyther7ba4e572014-08-04 09:26:05 +02003025where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003026rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003027
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01003028Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00003029 additional information is available from the board vendor; for
3030 instance, the TQM823L systems are available without (standard)
3031 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003032 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003033
Holger Freyther7ba4e572014-08-04 09:26:05 +02003034 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003035 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003036
Holger Freyther7ba4e572014-08-04 09:26:05 +02003037 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003038 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003039
wdenk6c59edc2004-05-03 20:45:30 +00003040 etc.
wdenkc6097192002-11-03 00:24:07 +00003041
wdenkc6097192002-11-03 00:24:07 +00003042
wdenk6c59edc2004-05-03 20:45:30 +00003043Finally, type "make all", and you should get some working U-Boot
3044images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk6c59edc2004-05-03 20:45:30 +00003046- "u-boot.bin" is a raw binary image
3047- "u-boot" is an image in ELF binary format
3048- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003049
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003050By default the build is performed locally and the objects are saved
3051in the source directory. One of the two methods can be used to change
3052this behavior and build U-Boot to some external directory:
3053
30541. Add O= to the make command line invocations:
3055
3056 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003057 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003058 make O=/tmp/build all
3059
Timo Ketolac8c67602014-11-06 14:39:05 +020030602. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003061
Timo Ketolac8c67602014-11-06 14:39:05 +02003062 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003063 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003064 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003065 make all
3066
Timo Ketolac8c67602014-11-06 14:39:05 +02003067Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003068variable.
3069
Daniel Schwierzeck88484422018-01-26 16:31:04 +01003070User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3071setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3072For example to treat all compiler warnings as errors:
3073
3074 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk6c59edc2004-05-03 20:45:30 +00003076Please be aware that the Makefiles assume you are using GNU make, so
3077for instance on NetBSD you might need to use "gmake" instead of
3078native "make".
wdenkc6097192002-11-03 00:24:07 +00003079
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk6c59edc2004-05-03 20:45:30 +00003081If the system board that you have is not listed, then you will need
3082to port U-Boot to your hardware platform. To do this, follow these
3083steps:
wdenkc6097192002-11-03 00:24:07 +00003084
Phil Sutterc77b4882015-12-25 14:41:18 +010030851. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003086 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003087 the "Makefile" and a "<board>.c".
30882. Create a new configuration file "include/configs/<board>.h" for
3089 your board.
wdenk6c59edc2004-05-03 20:45:30 +000030903. If you're porting U-Boot to a new CPU, then also create a new
3091 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020030924. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000030935. Type "make", and you should get a working "u-boot.srec" file
3094 to be installed on your target system.
30956. Debug and solve any problems that might arise.
3096 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003097
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk6c59edc2004-05-03 20:45:30 +00003099Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3100==============================================================
wdenkc6097192002-11-03 00:24:07 +00003101
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003102If you have modified U-Boot sources (for instance added a new board
3103or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003104provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08003105the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003106official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003107
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003108But before you submit such a patch, please verify that your modifi-
3109cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003110the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003111just run the buildman script (tools/buildman/buildman), which will
3112configure and build U-Boot for ALL supported system. Be warned, this
3113will take a while. Please see the buildman README, or run 'buildman -H'
3114for documentation.
wdenkc6097192002-11-03 00:24:07 +00003115
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003116
wdenk6c59edc2004-05-03 20:45:30 +00003117See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003118
wdenkc6097192002-11-03 00:24:07 +00003119
wdenk6c59edc2004-05-03 20:45:30 +00003120Monitor Commands - Overview:
3121============================
wdenkc6097192002-11-03 00:24:07 +00003122
wdenk6c59edc2004-05-03 20:45:30 +00003123go - start application at address 'addr'
3124run - run commands in an environment variable
3125bootm - boot application image from memory
3126bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003127bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003128tftpboot- boot image via network using TFTP protocol
3129 and env variables "ipaddr" and "serverip"
3130 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003131tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003132rarpboot- boot image via network using RARP/TFTP protocol
3133diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3134loads - load S-Record file over serial line
3135loadb - load binary file over serial line (kermit mode)
3136md - memory display
3137mm - memory modify (auto-incrementing)
3138nm - memory modify (constant address)
3139mw - memory write (fill)
Simon Glass19038de2020-06-02 19:26:49 -06003140ms - memory search
wdenk6c59edc2004-05-03 20:45:30 +00003141cp - memory copy
3142cmp - memory compare
3143crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003144i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003145sspi - SPI utility commands
3146base - print or set address offset
3147printenv- print environment variables
Pragnesh Patel1d5955f2020-12-22 11:30:05 +05303148pwm - control pwm channels
wdenk6c59edc2004-05-03 20:45:30 +00003149setenv - set environment variables
3150saveenv - save environment variables to persistent storage
3151protect - enable or disable FLASH write protection
3152erase - erase FLASH memory
3153flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003154nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003155bdinfo - print Board Info structure
3156iminfo - print header information for application image
3157coninfo - print console devices and informations
3158ide - IDE sub-system
3159loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003160loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003161mtest - simple RAM test
3162icache - enable or disable instruction cache
3163dcache - enable or disable data cache
3164reset - Perform RESET of the CPU
3165echo - echo args to console
3166version - print monitor version
3167help - print online help
3168? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003169
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk6c59edc2004-05-03 20:45:30 +00003171Monitor Commands - Detailed Description:
3172========================================
wdenkc6097192002-11-03 00:24:07 +00003173
wdenk6c59edc2004-05-03 20:45:30 +00003174TODO.
wdenkc6097192002-11-03 00:24:07 +00003175
wdenk6c59edc2004-05-03 20:45:30 +00003176For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003177
3178
wdenk6c59edc2004-05-03 20:45:30 +00003179Environment Variables:
3180======================
wdenkc6097192002-11-03 00:24:07 +00003181
wdenk6c59edc2004-05-03 20:45:30 +00003182U-Boot supports user configuration using Environment Variables which
3183can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003184
wdenk6c59edc2004-05-03 20:45:30 +00003185Environment Variables are set using "setenv", printed using
3186"printenv", and saved to Flash using "saveenv". Using "setenv"
3187without a value can be used to delete a variable from the
3188environment. As long as you don't save the environment you are
3189working with an in-memory copy. In case the Flash area containing the
3190environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003191
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003192Some configuration options can be set using Environment Variables.
3193
3194List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk6c59edc2004-05-03 20:45:30 +00003196 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk6c59edc2004-05-03 20:45:30 +00003198 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk6c59edc2004-05-03 20:45:30 +00003200 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk6c59edc2004-05-03 20:45:30 +00003202 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003203
wdenk6c59edc2004-05-03 20:45:30 +00003204 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003205
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003206 bootm_low - Memory range available for image processing in the bootm
3207 command can be restricted. This variable is given as
3208 a hexadecimal number and defines lowest address allowed
3209 for use by the bootm command. See also "bootm_size"
3210 environment variable. Address defined by "bootm_low" is
3211 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003212 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3213 bootm_mapsize.
3214
Wolfgang Denk092ae952011-10-26 10:21:21 +00003215 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003216 This variable is given as a hexadecimal number and it
3217 defines the size of the memory region starting at base
3218 address bootm_low that is accessible by the Linux kernel
3219 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3220 as the default value if it is defined, and bootm_size is
3221 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003222
3223 bootm_size - Memory range available for image processing in the bootm
3224 command can be restricted. This variable is given as
3225 a hexadecimal number and defines the size of the region
3226 allowed for use by the bootm command. See also "bootm_low"
3227 environment variable.
3228
Simon Glassa8cab882019-07-20 20:51:17 -06003229 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3230
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003231 updatefile - Location of the software update file on a TFTP server, used
3232 by the automatic software update feature. Please refer to
3233 documentation in doc/README.update for more details.
3234
wdenk6c59edc2004-05-03 20:45:30 +00003235 autoload - if set to "no" (any string beginning with 'n'),
3236 "bootp" will just load perform a lookup of the
3237 configuration from the BOOTP server, but not try to
3238 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk6c59edc2004-05-03 20:45:30 +00003240 autostart - if set to "yes", an image loaded using the "bootp",
3241 "rarpboot", "tftpboot" or "diskboot" commands will
3242 be automatically started (by internally calling
3243 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003244
wdenk6c59edc2004-05-03 20:45:30 +00003245 If set to "no", a standalone image passed to the
3246 "bootm" command will be copied to the load address
3247 (and eventually uncompressed), but NOT be started.
3248 This can be used to load and uncompress arbitrary
3249 data.
wdenkc6097192002-11-03 00:24:07 +00003250
David A. Longd558a4e2011-07-09 16:40:19 -04003251 fdt_high - if set this restricts the maximum address that the
3252 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003253 For example, if you have a system with 1 GB memory
3254 at physical address 0x10000000, while Linux kernel
3255 only recognizes the first 704 MB as low memory, you
3256 may need to set fdt_high as 0x3C000000 to have the
3257 device tree blob be copied to the maximum address
3258 of the 704 MB low memory, so that Linux kernel can
3259 access it during the boot procedure.
3260
David A. Longd558a4e2011-07-09 16:40:19 -04003261 If this is set to the special value 0xFFFFFFFF then
3262 the fdt will not be copied at all on boot. For this
3263 to work it must reside in writable memory, have
3264 sufficient padding on the end of it for u-boot to
3265 add the information it needs into it, and the memory
3266 must be accessible by the kernel.
3267
Simon Glassdc6fa642011-10-24 19:15:34 +00003268 fdtcontroladdr- if set this is the address of the control flattened
3269 device tree used by U-Boot when CONFIG_OF_CONTROL is
3270 defined.
3271
wdenk0e2bd9c2004-06-06 21:51:03 +00003272 i2cfast - (PPC405GP|PPC405EP only)
3273 if set to 'y' configures Linux I2C driver for fast
3274 mode (400kHZ). This environment variable is used in
3275 initialization code. So, for changes to be effective
3276 it must be saved and board must be reset.
3277
wdenk6c59edc2004-05-03 20:45:30 +00003278 initrd_high - restrict positioning of initrd images:
3279 If this variable is not set, initrd images will be
3280 copied to the highest possible address in RAM; this
3281 is usually what you want since it allows for
3282 maximum initrd size. If for some reason you want to
3283 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003284 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003285 variable to a value of "no" or "off" or "0".
3286 Alternatively, you can set it to a maximum upper
3287 address to use (U-Boot will still check that it
3288 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003289
wdenk6c59edc2004-05-03 20:45:30 +00003290 For instance, when you have a system with 16 MB
3291 RAM, and want to reserve 4 MB from use by Linux,
3292 you can do this by adding "mem=12M" to the value of
3293 the "bootargs" variable. However, now you must make
3294 sure that the initrd image is placed in the first
3295 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk6c59edc2004-05-03 20:45:30 +00003297 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003298
wdenk6c59edc2004-05-03 20:45:30 +00003299 If you set initrd_high to 0xFFFFFFFF, this is an
3300 indication to U-Boot that all addresses are legal
3301 for the Linux kernel, including addresses in flash
3302 memory. In this case U-Boot will NOT COPY the
3303 ramdisk at all. This may be useful to reduce the
3304 boot time on your system, but requires that this
3305 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003306
wdenk6c59edc2004-05-03 20:45:30 +00003307 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk6c59edc2004-05-03 20:45:30 +00003309 loadaddr - Default load address for commands like "bootp",
3310 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk6c59edc2004-05-03 20:45:30 +00003312 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk6c59edc2004-05-03 20:45:30 +00003314 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003315
wdenk6c59edc2004-05-03 20:45:30 +00003316 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk6c59edc2004-05-03 20:45:30 +00003318 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk6c59edc2004-05-03 20:45:30 +00003320 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003321
Mike Frysingera23230c2011-10-02 10:01:27 +00003322 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003323
Mike Frysingera23230c2011-10-02 10:01:27 +00003324 ethact - controls which interface is currently active.
3325 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003326
Heiko Schocherc5e84052010-07-20 17:45:02 +02003327 => setenv ethact FEC
3328 => ping 192.168.0.1 # traffic sent on FEC
3329 => setenv ethact SCC
3330 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003331
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003332 ethrotate - When set to "no" U-Boot does not go through all
3333 available network interfaces.
3334 It just stays at the currently selected interface.
3335
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003336 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003337 either succeed or fail without retrying.
3338 When set to "once" the network operation will
3339 fail when all the available network interfaces
3340 are tried once without success.
3341 Useful on scripts which control the retry operation
3342 themselves.
wdenkc6097192002-11-03 00:24:07 +00003343
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003344 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003345
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003346 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003347 changing the console to be empty. If "yes" it will be
3348 made silent. If "no" it will not be made silent. If
3349 unset, then it will be made silent if the U-Boot console
3350 is silent.
3351
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003352 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003353 UDP source port.
3354
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003355 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003356 destination port instead of the Well Know Port 69.
3357
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003358 tftpblocksize - Block size to use for TFTP transfers; if not set,
3359 we use the TFTP server's default block size
3360
3361 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3362 seconds, minimum value is 1000 = 1 second). Defines
3363 when a packet is considered to be lost so it has to
3364 be retransmitted. The default is 5000 = 5 seconds.
3365 Lowering this value may make downloads succeed
3366 faster in networks with high packet loss rates or
3367 with unreliable TFTP servers.
3368
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003369 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3370 unit, minimum value = 0). Defines how many timeouts
3371 can happen during a single file transfer before that
3372 transfer is aborted. The default is 10, and 0 means
3373 'no timeouts allowed'. Increasing this value may help
3374 downloads succeed with high packet loss rates, or with
3375 unreliable TFTP servers or client hardware.
3376
Ramon Fried6e9aa542020-07-18 23:31:46 +03003377 tftpwindowsize - if this is set, the value is used for TFTP's
3378 window size as described by RFC 7440.
3379 This means the count of blocks we can receive before
3380 sending ack to server.
3381
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003382 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003383 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003384 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003385
Alexandre Messier15971322016-02-01 17:08:57 -05003386 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3387 Unsigned value, in milliseconds. If not set, the period will
3388 be either the default (28000), or a value based on
3389 CONFIG_NET_RETRY_COUNT, if defined. This value has
3390 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3391
Simon Glass19038de2020-06-02 19:26:49 -06003392 memmatches - Number of matches found by the last 'ms' command, in hex
3393
3394 memaddr - Address of the last match found by the 'ms' command, in hex,
3395 or 0 if none
3396
3397 mempos - Index position of the last match found by the 'ms' command,
3398 in units of the size (.b, .w, .l) of the search
3399
Simon Glass58a90462020-09-05 14:50:48 -06003400 zbootbase - (x86 only) Base address of the bzImage 'setup' block
3401
3402 zbootaddr - (x86 only) Address of the loaded bzImage, typically
3403 BZIMAGE_LOAD_ADDR which is 0x100000
Simon Glass19038de2020-06-02 19:26:49 -06003404
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003405The following image location variables contain the location of images
3406used in booting. The "Image" column gives the role of the image and is
3407not an environment variable name. The other columns are environment
3408variable names. "File Name" gives the name of the file on a TFTP
3409server, "RAM Address" gives the location in RAM the image will be
3410loaded to, and "Flash Location" gives the image's address in NOR
3411flash or offset in NAND flash.
3412
3413*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03003414boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003415boards use these variables for other purposes.
3416
Wolfgang Denk092ae952011-10-26 10:21:21 +00003417Image File Name RAM Address Flash Location
3418----- --------- ----------- --------------
3419u-boot u-boot u-boot_addr_r u-boot_addr
3420Linux kernel bootfile kernel_addr_r kernel_addr
3421device tree blob fdtfile fdt_addr_r fdt_addr
3422ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003423
wdenk6c59edc2004-05-03 20:45:30 +00003424The following environment variables may be used and automatically
3425updated by the network boot commands ("bootp" and "rarpboot"),
3426depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003427
wdenk6c59edc2004-05-03 20:45:30 +00003428 bootfile - see above
3429 dnsip - IP address of your Domain Name Server
3430 dnsip2 - IP address of your secondary Domain Name Server
3431 gatewayip - IP address of the Gateway (Router) to use
3432 hostname - Target hostname
3433 ipaddr - see above
3434 netmask - Subnet Mask
3435 rootpath - Pathname of the root filesystem on the NFS server
3436 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003437
wdenk145d2c12004-04-15 21:48:45 +00003438
wdenk6c59edc2004-05-03 20:45:30 +00003439There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003440
wdenk6c59edc2004-05-03 20:45:30 +00003441 serial# - contains hardware identification information such
3442 as type string and/or serial number
3443 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003444
wdenk6c59edc2004-05-03 20:45:30 +00003445These variables can be set only once (usually during manufacturing of
3446the board). U-Boot refuses to delete or overwrite these variables
3447once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003448
3449
wdenk6c59edc2004-05-03 20:45:30 +00003450Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003451
wdenk6c59edc2004-05-03 20:45:30 +00003452 ver - Contains the U-Boot version string as printed
3453 with the "version" command. This variable is
3454 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003455
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk6c59edc2004-05-03 20:45:30 +00003457Please note that changes to some configuration parameters may take
3458only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003459
stroeseb9c17c52003-04-04 15:53:41 +00003460
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003461Callback functions for environment variables:
3462---------------------------------------------
3463
3464For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003465when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003466be associated with arbitrary variables. On creation, overwrite, or
3467deletion, the callback will provide the opportunity for some side
3468effect to happen or for the change to be rejected.
3469
3470The callbacks are named and associated with a function using the
3471U_BOOT_ENV_CALLBACK macro in your board or driver code.
3472
3473These callbacks are associated with variables in one of two ways. The
3474static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3475in the board configuration to a string that defines a list of
3476associations. The list must be in the following format:
3477
3478 entry = variable_name[:callback_name]
3479 list = entry[,list]
3480
3481If the callback name is not specified, then the callback is deleted.
3482Spaces are also allowed anywhere in the list.
3483
3484Callbacks can also be associated by defining the ".callbacks" variable
3485with the same list format above. Any association in ".callbacks" will
3486override any association in the static list. You can define
3487CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003488".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003489
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003490If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3491regular expression. This allows multiple variables to be connected to
3492the same callback without explicitly listing them all out.
3493
Heinrich Schuchardtc141fa52018-07-29 11:08:14 +02003494The signature of the callback functions is:
3495
3496 int callback(const char *name, const char *value, enum env_op op, int flags)
3497
3498* name - changed environment variable
3499* value - new value of the environment variable
3500* op - operation (create, overwrite, or delete)
3501* flags - attributes of the environment variable change, see flags H_* in
3502 include/search.h
3503
3504The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003505
wdenk6c59edc2004-05-03 20:45:30 +00003506Command Line Parsing:
3507=====================
stroeseb9c17c52003-04-04 15:53:41 +00003508
wdenk6c59edc2004-05-03 20:45:30 +00003509There are two different command line parsers available with U-Boot:
3510the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk6c59edc2004-05-03 20:45:30 +00003512Old, simple command line parser:
3513--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003514
wdenk6c59edc2004-05-03 20:45:30 +00003515- supports environment variables (through setenv / saveenv commands)
3516- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003517- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003518- special characters ('$', ';') can be escaped by prefixing with '\',
3519 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003520 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003521- You can also escape text by enclosing in single apostrophes, for example:
3522 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003523
wdenk6c59edc2004-05-03 20:45:30 +00003524Hush shell:
3525-----------
wdenkf4688a22003-05-28 08:06:31 +00003526
wdenk6c59edc2004-05-03 20:45:30 +00003527- similar to Bourne shell, with control structures like
3528 if...then...else...fi, for...do...done; while...do...done,
3529 until...do...done, ...
3530- supports environment ("global") variables (through setenv / saveenv
3531 commands) and local shell variables (through standard shell syntax
3532 "name=value"); only environment variables can be used with "run"
3533 command
wdenkf4688a22003-05-28 08:06:31 +00003534
wdenk6c59edc2004-05-03 20:45:30 +00003535General rules:
3536--------------
wdenkf4688a22003-05-28 08:06:31 +00003537
wdenk6c59edc2004-05-03 20:45:30 +00003538(1) If a command line (or an environment variable executed by a "run"
3539 command) contains several commands separated by semicolon, and
3540 one of these commands fails, then the remaining commands will be
3541 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003542
wdenk6c59edc2004-05-03 20:45:30 +00003543(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003544 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003545 command will cause "run" to terminate, i. e. the remaining
3546 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003547
wdenk6c59edc2004-05-03 20:45:30 +00003548Note for Redundant Ethernet Interfaces:
3549=======================================
wdenkf4688a22003-05-28 08:06:31 +00003550
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003551Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003552such configurations and is capable of automatic selection of a
3553"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003554
wdenk6c59edc2004-05-03 20:45:30 +00003555Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3556MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3557"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003558
wdenk6c59edc2004-05-03 20:45:30 +00003559If the network interface stores some valid MAC address (for instance
3560in SROM), this is used as default address if there is NO correspon-
3561ding setting in the environment; if the corresponding environment
3562variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003563
wdenk6c59edc2004-05-03 20:45:30 +00003564o If the SROM has a valid MAC address, and there is no address in the
3565 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk6c59edc2004-05-03 20:45:30 +00003567o If there is no valid address in the SROM, and a definition in the
3568 environment exists, then the value from the environment variable is
3569 used.
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk6c59edc2004-05-03 20:45:30 +00003571o If both the SROM and the environment contain a MAC address, and
3572 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk6c59edc2004-05-03 20:45:30 +00003574o If both the SROM and the environment contain a MAC address, and the
3575 addresses differ, the value from the environment is used and a
3576 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk6c59edc2004-05-03 20:45:30 +00003578o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05003579 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3580 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003581
Ben Warren6db991a2010-04-26 11:11:46 -07003582If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003583will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003584may be skipped by setting the appropriate 'ethmacskip' environment variable.
3585The naming convention is as follows:
3586"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003587
wdenk6c59edc2004-05-03 20:45:30 +00003588Image Formats:
3589==============
wdenkc6097192002-11-03 00:24:07 +00003590
Marian Balakowicz18710b82008-03-12 12:13:13 +01003591U-Boot is capable of booting (and performing other auxiliary operations on)
3592images in two formats:
3593
3594New uImage format (FIT)
3595-----------------------
3596
3597Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3598to Flattened Device Tree). It allows the use of images with multiple
3599components (several kernels, ramdisks, etc.), with contents protected by
3600SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3601
3602
3603Old uImage format
3604-----------------
3605
3606Old image format is based on binary files which can be basically anything,
3607preceded by a special header; see the definitions in include/image.h for
3608details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk6c59edc2004-05-03 20:45:30 +00003610* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3611 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003612 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3613 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3614 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003615* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003616 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003617 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003618* Compression Type (uncompressed, gzip, bzip2)
3619* Load Address
3620* Entry Point
3621* Image Name
3622* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003623
wdenk6c59edc2004-05-03 20:45:30 +00003624The header is marked by a special Magic Number, and both the header
3625and the data portions of the image are secured against corruption by
3626CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003627
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk6c59edc2004-05-03 20:45:30 +00003629Linux Support:
3630==============
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk6c59edc2004-05-03 20:45:30 +00003632Although U-Boot should support any OS or standalone application
3633easily, the main focus has always been on Linux during the design of
3634U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003635
wdenk6c59edc2004-05-03 20:45:30 +00003636U-Boot includes many features that so far have been part of some
3637special "boot loader" code within the Linux kernel. Also, any
3638"initrd" images to be used are no longer part of one big Linux image;
3639instead, kernel and "initrd" are separate images. This implementation
3640serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk6c59edc2004-05-03 20:45:30 +00003642- the same features can be used for other OS or standalone
3643 applications (for instance: using compressed images to reduce the
3644 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk6c59edc2004-05-03 20:45:30 +00003646- it becomes much easier to port new Linux kernel versions because
3647 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk6c59edc2004-05-03 20:45:30 +00003649- the same Linux kernel image can now be used with different "initrd"
3650 images; of course this also means that different kernel images can
3651 be run with the same "initrd". This makes testing easier (you don't
3652 have to build a new "zImage.initrd" Linux image when you just
3653 change a file in your "initrd"). Also, a field-upgrade of the
3654 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003655
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk6c59edc2004-05-03 20:45:30 +00003657Linux HOWTO:
3658============
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk6c59edc2004-05-03 20:45:30 +00003660Porting Linux to U-Boot based systems:
3661---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003662
wdenk6c59edc2004-05-03 20:45:30 +00003663U-Boot cannot save you from doing all the necessary modifications to
3664configure the Linux device drivers for use with your target hardware
3665(no, we don't intend to provide a full virtual machine interface to
3666Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003667
Stefan Roese88fbf932010-04-15 16:07:28 +02003668But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003669
wdenk6c59edc2004-05-03 20:45:30 +00003670Just make sure your machine specific header file (for instance
3671include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003672Information structure as we define in include/asm-<arch>/u-boot.h,
3673and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003674as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003675
Simon Glassd097e592014-06-11 23:29:46 -06003676Note that U-Boot now has a driver model, a unified model for drivers.
3677If you are adding a new driver, plumb it into driver model. If there
3678is no uclass available, you are encouraged to create one. See
3679doc/driver-model.
3680
wdenkc6097192002-11-03 00:24:07 +00003681
wdenk6c59edc2004-05-03 20:45:30 +00003682Configuring the Linux kernel:
3683-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685No specific requirements for U-Boot. Make sure you have some root
3686device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003687
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk6c59edc2004-05-03 20:45:30 +00003689Building a Linux Image:
3690-----------------------
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk6c59edc2004-05-03 20:45:30 +00003692With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3693not used. If you use recent kernel source, a new build target
3694"uImage" will exist which automatically builds an image usable by
3695U-Boot. Most older kernels also have support for a "pImage" target,
3696which was introduced for our predecessor project PPCBoot and uses a
3697100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003698
wdenk6c59edc2004-05-03 20:45:30 +00003699Example:
wdenkc6097192002-11-03 00:24:07 +00003700
Holger Freyther7ba4e572014-08-04 09:26:05 +02003701 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003702 make oldconfig
3703 make dep
3704 make uImage
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk6c59edc2004-05-03 20:45:30 +00003706The "uImage" build target uses a special tool (in 'tools/mkimage') to
3707encapsulate a compressed Linux kernel image with header information,
3708CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk6c59edc2004-05-03 20:45:30 +00003710* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003711
wdenk6c59edc2004-05-03 20:45:30 +00003712* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk6c59edc2004-05-03 20:45:30 +00003714 ${CROSS_COMPILE}-objcopy -O binary \
3715 -R .note -R .comment \
3716 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003717
wdenk6c59edc2004-05-03 20:45:30 +00003718* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003719
wdenk6c59edc2004-05-03 20:45:30 +00003720 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003721
wdenk6c59edc2004-05-03 20:45:30 +00003722* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003723
wdenk6c59edc2004-05-03 20:45:30 +00003724 mkimage -A ppc -O linux -T kernel -C gzip \
3725 -a 0 -e 0 -n "Linux Kernel Image" \
3726 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003727
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk6c59edc2004-05-03 20:45:30 +00003729The "mkimage" tool can also be used to create ramdisk images for use
3730with U-Boot, either separated from the Linux kernel image, or
3731combined into one file. "mkimage" encapsulates the images with a 64
3732byte header containing information about target architecture,
3733operating system, image type, compression method, entry points, time
3734stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk6c59edc2004-05-03 20:45:30 +00003736"mkimage" can be called in two ways: to verify existing images and
3737print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003738
wdenk6c59edc2004-05-03 20:45:30 +00003739In the first form (with "-l" option) mkimage lists the information
3740contained in the header of an existing U-Boot image; this includes
3741checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003742
wdenk6c59edc2004-05-03 20:45:30 +00003743 tools/mkimage -l image
3744 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003745
wdenk6c59edc2004-05-03 20:45:30 +00003746The second form (with "-d" option) is used to build a U-Boot image
3747from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003748
wdenk6c59edc2004-05-03 20:45:30 +00003749 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3750 -n name -d data_file image
3751 -A ==> set architecture to 'arch'
3752 -O ==> set operating system to 'os'
3753 -T ==> set image type to 'type'
3754 -C ==> set compression type 'comp'
3755 -a ==> set load address to 'addr' (hex)
3756 -e ==> set entry point to 'ep' (hex)
3757 -n ==> set image name to 'name'
3758 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003759
wdenkcd914452004-05-29 16:53:29 +00003760Right now, all Linux kernels for PowerPC systems use the same load
3761address (0x00000000), but the entry point address depends on the
3762kernel version:
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk6c59edc2004-05-03 20:45:30 +00003764- 2.2.x kernels have the entry point at 0x0000000C,
3765- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk6c59edc2004-05-03 20:45:30 +00003767So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3770 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003771 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003772 > examples/uImage.TQM850L
3773 Image Name: 2.4.4 kernel for TQM850L
3774 Created: Wed Jul 19 02:34:59 2000
3775 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3776 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3777 Load Address: 0x00000000
3778 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk6c59edc2004-05-03 20:45:30 +00003780To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk6c59edc2004-05-03 20:45:30 +00003782 -> tools/mkimage -l examples/uImage.TQM850L
3783 Image Name: 2.4.4 kernel for TQM850L
3784 Created: Wed Jul 19 02:34:59 2000
3785 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3786 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3787 Load Address: 0x00000000
3788 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk6c59edc2004-05-03 20:45:30 +00003790NOTE: for embedded systems where boot time is critical you can trade
3791speed for memory and install an UNCOMPRESSED image instead: this
3792needs more space in Flash, but boots much faster since it does not
3793need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003794
Stefan Roese88fbf932010-04-15 16:07:28 +02003795 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003796 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3797 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003798 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003799 > examples/uImage.TQM850L-uncompressed
3800 Image Name: 2.4.4 kernel for TQM850L
3801 Created: Wed Jul 19 02:34:59 2000
3802 Image Type: PowerPC Linux Kernel Image (uncompressed)
3803 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3804 Load Address: 0x00000000
3805 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003806
wdenkc6097192002-11-03 00:24:07 +00003807
wdenk6c59edc2004-05-03 20:45:30 +00003808Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3809when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk6c59edc2004-05-03 20:45:30 +00003811 -> tools/mkimage -n 'Simple Ramdisk Image' \
3812 > -A ppc -O linux -T ramdisk -C gzip \
3813 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3814 Image Name: Simple Ramdisk Image
3815 Created: Wed Jan 12 14:01:50 2000
3816 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3817 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3818 Load Address: 0x00000000
3819 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003820
Tyler Hicks791c7472020-10-26 10:40:24 -05003821The "dumpimage" tool can be used to disassemble or list the contents of images
3822built by mkimage. See dumpimage's help output (-h) for details.
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk6c59edc2004-05-03 20:45:30 +00003824Installing a Linux Image:
3825-------------------------
wdenkc6097192002-11-03 00:24:07 +00003826
wdenk6c59edc2004-05-03 20:45:30 +00003827To downloading a U-Boot image over the serial (console) interface,
3828you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk6c59edc2004-05-03 20:45:30 +00003830 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk6c59edc2004-05-03 20:45:30 +00003832The 'objcopy' does not understand the information in the U-Boot
3833image header, so the resulting S-Record file will be relative to
3834address 0x00000000. To load it to a given address, you need to
3835specify the target address as 'offset' parameter with the 'loads'
3836command.
wdenkc6097192002-11-03 00:24:07 +00003837
wdenk6c59edc2004-05-03 20:45:30 +00003838Example: install the image to address 0x40100000 (which on the
3839TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk6c59edc2004-05-03 20:45:30 +00003841 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843 .......... done
3844 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk6c59edc2004-05-03 20:45:30 +00003846 => loads 40100000
3847 ## Ready for S-Record download ...
3848 ~>examples/image.srec
3849 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3850 ...
3851 15989 15990 15991 15992
3852 [file transfer complete]
3853 [connected]
3854 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003855
wdenkc6097192002-11-03 00:24:07 +00003856
wdenk6c59edc2004-05-03 20:45:30 +00003857You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003858this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003859corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003860
wdenk6c59edc2004-05-03 20:45:30 +00003861 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003862
wdenk6c59edc2004-05-03 20:45:30 +00003863 ## Checking Image at 40100000 ...
3864 Image Name: 2.2.13 for initrd on TQM850L
3865 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3866 Data Size: 335725 Bytes = 327 kB = 0 MB
3867 Load Address: 00000000
3868 Entry Point: 0000000c
3869 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003870
3871
wdenk6c59edc2004-05-03 20:45:30 +00003872Boot Linux:
3873-----------
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875The "bootm" command is used to boot an application that is stored in
3876memory (RAM or Flash). In case of a Linux kernel image, the contents
3877of the "bootargs" environment variable is passed to the kernel as
3878parameters. You can check and modify this variable using the
3879"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003880
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk6c59edc2004-05-03 20:45:30 +00003882 => printenv bootargs
3883 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885 => 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 +00003886
wdenk6c59edc2004-05-03 20:45:30 +00003887 => printenv bootargs
3888 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 +00003889
wdenk6c59edc2004-05-03 20:45:30 +00003890 => bootm 40020000
3891 ## Booting Linux kernel at 40020000 ...
3892 Image Name: 2.2.13 for NFS on TQM850L
3893 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3894 Data Size: 381681 Bytes = 372 kB = 0 MB
3895 Load Address: 00000000
3896 Entry Point: 0000000c
3897 Verifying Checksum ... OK
3898 Uncompressing Kernel Image ... OK
3899 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
3900 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3901 time_init: decrementer frequency = 187500000/60
3902 Calibrating delay loop... 49.77 BogoMIPS
3903 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3904 ...
wdenkc6097192002-11-03 00:24:07 +00003905
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003906If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003907the memory addresses of both the kernel and the initrd image (PPBCOOT
3908format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk6c59edc2004-05-03 20:45:30 +00003910 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk6c59edc2004-05-03 20:45:30 +00003912 ## Checking Image at 40100000 ...
3913 Image Name: 2.2.13 for initrd on TQM850L
3914 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3915 Data Size: 335725 Bytes = 327 kB = 0 MB
3916 Load Address: 00000000
3917 Entry Point: 0000000c
3918 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk6c59edc2004-05-03 20:45:30 +00003920 ## Checking Image at 40200000 ...
3921 Image Name: Simple Ramdisk Image
3922 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3923 Data Size: 566530 Bytes = 553 kB = 0 MB
3924 Load Address: 00000000
3925 Entry Point: 00000000
3926 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk6c59edc2004-05-03 20:45:30 +00003928 => bootm 40100000 40200000
3929 ## Booting Linux kernel at 40100000 ...
3930 Image Name: 2.2.13 for initrd on TQM850L
3931 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3932 Data Size: 335725 Bytes = 327 kB = 0 MB
3933 Load Address: 00000000
3934 Entry Point: 0000000c
3935 Verifying Checksum ... OK
3936 Uncompressing Kernel Image ... OK
3937 ## Loading RAMDisk Image at 40200000 ...
3938 Image Name: Simple Ramdisk Image
3939 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3940 Data Size: 566530 Bytes = 553 kB = 0 MB
3941 Load Address: 00000000
3942 Entry Point: 00000000
3943 Verifying Checksum ... OK
3944 Loading Ramdisk ... OK
3945 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
3946 Boot arguments: root=/dev/ram
3947 time_init: decrementer frequency = 187500000/60
3948 Calibrating delay loop... 49.77 BogoMIPS
3949 ...
3950 RAMDISK: Compressed image found at block 0
3951 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk6c59edc2004-05-03 20:45:30 +00003953 bash#
wdenkc6097192002-11-03 00:24:07 +00003954
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003955Boot Linux and pass a flat device tree:
3956-----------
3957
3958First, U-Boot must be compiled with the appropriate defines. See the section
3959titled "Linux Kernel Interface" above for a more in depth explanation. The
3960following is an example of how to start a kernel and pass an updated
3961flat device tree:
3962
3963=> print oftaddr
3964oftaddr=0x300000
3965=> print oft
3966oft=oftrees/mpc8540ads.dtb
3967=> tftp $oftaddr $oft
3968Speed: 1000, full duplex
3969Using TSEC0 device
3970TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3971Filename 'oftrees/mpc8540ads.dtb'.
3972Load address: 0x300000
3973Loading: #
3974done
3975Bytes transferred = 4106 (100a hex)
3976=> tftp $loadaddr $bootfile
3977Speed: 1000, full duplex
3978Using TSEC0 device
3979TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3980Filename 'uImage'.
3981Load address: 0x200000
3982Loading:############
3983done
3984Bytes transferred = 1029407 (fb51f hex)
3985=> print loadaddr
3986loadaddr=200000
3987=> print oftaddr
3988oftaddr=0x300000
3989=> bootm $loadaddr - $oftaddr
3990## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003991 Image Name: Linux-2.6.17-dirty
3992 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3993 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003994 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003995 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003996 Verifying Checksum ... OK
3997 Uncompressing Kernel Image ... OK
3998Booting using flat device tree at 0x300000
3999Using MPC85xx ADS machine description
4000Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4001[snip]
4002
4003
wdenk6c59edc2004-05-03 20:45:30 +00004004More About U-Boot Image Types:
4005------------------------------
wdenkc6097192002-11-03 00:24:07 +00004006
wdenk6c59edc2004-05-03 20:45:30 +00004007U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004008
wdenk6c59edc2004-05-03 20:45:30 +00004009 "Standalone Programs" are directly runnable in the environment
4010 provided by U-Boot; it is expected that (if they behave
4011 well) you can continue to work in U-Boot after return from
4012 the Standalone Program.
4013 "OS Kernel Images" are usually images of some Embedded OS which
4014 will take over control completely. Usually these programs
4015 will install their own set of exception handlers, device
4016 drivers, set up the MMU, etc. - this means, that you cannot
4017 expect to re-enter U-Boot except by resetting the CPU.
4018 "RAMDisk Images" are more or less just data blocks, and their
4019 parameters (address, size) are passed to an OS kernel that is
4020 being started.
4021 "Multi-File Images" contain several images, typically an OS
4022 (Linux) kernel image and one or more data images like
4023 RAMDisks. This construct is useful for instance when you want
4024 to boot over the network using BOOTP etc., where the boot
4025 server provides just a single image file, but you want to get
4026 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004027
wdenk6c59edc2004-05-03 20:45:30 +00004028 "Multi-File Images" start with a list of image sizes, each
4029 image size (in bytes) specified by an "uint32_t" in network
4030 byte order. This list is terminated by an "(uint32_t)0".
4031 Immediately after the terminating 0 follow the images, one by
4032 one, all aligned on "uint32_t" boundaries (size rounded up to
4033 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035 "Firmware Images" are binary images containing firmware (like
4036 U-Boot or FPGA images) which usually will be programmed to
4037 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004038
wdenk6c59edc2004-05-03 20:45:30 +00004039 "Script files" are command sequences that will be executed by
4040 U-Boot's command interpreter; this feature is especially
4041 useful when you configure U-Boot to use a real shell (hush)
4042 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004043
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004044Booting the Linux zImage:
4045-------------------------
4046
4047On some platforms, it's possible to boot Linux zImage. This is done
4048using the "bootz" command. The syntax of "bootz" command is the same
4049as the syntax of "bootm" command.
4050
Tom Rini45f46d12013-05-16 11:40:11 -04004051Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004052kernel with raw initrd images. The syntax is slightly different, the
4053address of the initrd must be augmented by it's size, in the following
4054format: "<initrd addres>:<initrd size>".
4055
stroeseb9c17c52003-04-04 15:53:41 +00004056
wdenk6c59edc2004-05-03 20:45:30 +00004057Standalone HOWTO:
4058=================
stroeseb9c17c52003-04-04 15:53:41 +00004059
wdenk6c59edc2004-05-03 20:45:30 +00004060One of the features of U-Boot is that you can dynamically load and
4061run "standalone" applications, which can use some resources of
4062U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004063
wdenk6c59edc2004-05-03 20:45:30 +00004064Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066"Hello World" Demo:
4067-------------------
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk6c59edc2004-05-03 20:45:30 +00004069'examples/hello_world.c' contains a small "Hello World" Demo
4070application; it is automatically compiled when you build U-Boot.
4071It's configured to run at address 0x00040004, so you can play with it
4072like that:
wdenkc6097192002-11-03 00:24:07 +00004073
wdenk6c59edc2004-05-03 20:45:30 +00004074 => loads
4075 ## Ready for S-Record download ...
4076 ~>examples/hello_world.srec
4077 1 2 3 4 5 6 7 8 9 10 11 ...
4078 [file transfer complete]
4079 [connected]
4080 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk6c59edc2004-05-03 20:45:30 +00004082 => go 40004 Hello World! This is a test.
4083 ## Starting application at 0x00040004 ...
4084 Hello World
4085 argc = 7
4086 argv[0] = "40004"
4087 argv[1] = "Hello"
4088 argv[2] = "World!"
4089 argv[3] = "This"
4090 argv[4] = "is"
4091 argv[5] = "a"
4092 argv[6] = "test."
4093 argv[7] = "<NULL>"
4094 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk6c59edc2004-05-03 20:45:30 +00004096 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004097
wdenk6c59edc2004-05-03 20:45:30 +00004098Another example, which demonstrates how to register a CPM interrupt
4099handler with the U-Boot code, can be found in 'examples/timer.c'.
4100Here, a CPM timer is set up to generate an interrupt every second.
4101The interrupt service routine is trivial, just printing a '.'
4102character, but this is just a demo program. The application can be
4103controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004104
wdenk6c59edc2004-05-03 20:45:30 +00004105 ? - print current values og the CPM Timer registers
4106 b - enable interrupts and start timer
4107 e - stop timer and disable interrupts
4108 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk6c59edc2004-05-03 20:45:30 +00004110 => loads
4111 ## Ready for S-Record download ...
4112 ~>examples/timer.srec
4113 1 2 3 4 5 6 7 8 9 10 11 ...
4114 [file transfer complete]
4115 [connected]
4116 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk6c59edc2004-05-03 20:45:30 +00004118 => go 40004
4119 ## Starting application at 0x00040004 ...
4120 TIMERS=0xfff00980
4121 Using timer 1
4122 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk6c59edc2004-05-03 20:45:30 +00004124Hit 'b':
4125 [q, b, e, ?] Set interval 1000000 us
4126 Enabling timer
4127Hit '?':
4128 [q, b, e, ?] ........
4129 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4130Hit '?':
4131 [q, b, e, ?] .
4132 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4133Hit '?':
4134 [q, b, e, ?] .
4135 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4136Hit '?':
4137 [q, b, e, ?] .
4138 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4139Hit 'e':
4140 [q, b, e, ?] ...Stopping timer
4141Hit 'q':
4142 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004143
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk6c59edc2004-05-03 20:45:30 +00004145Minicom warning:
4146================
wdenkc6097192002-11-03 00:24:07 +00004147
wdenk6c59edc2004-05-03 20:45:30 +00004148Over time, many people have reported problems when trying to use the
4149"minicom" terminal emulation program for serial download. I (wd)
4150consider minicom to be broken, and recommend not to use it. Under
4151Unix, I recommend to use C-Kermit for general purpose use (and
4152especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004153use "cu" for S-Record download ("loads" command). See
Naoki Hayamae0cc1852020-10-08 13:17:16 +09004154https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004155for help with kermit.
4156
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk6c59edc2004-05-03 20:45:30 +00004158Nevertheless, if you absolutely want to use it try adding this
4159configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004160
wdenk6c59edc2004-05-03 20:45:30 +00004161 Name Program Name U/D FullScr IO-Red. Multi
4162 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4163 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004164
wdenk8dba0502003-03-31 16:34:49 +00004165
wdenk6c59edc2004-05-03 20:45:30 +00004166NetBSD Notes:
4167=============
wdenkc6097192002-11-03 00:24:07 +00004168
wdenk6c59edc2004-05-03 20:45:30 +00004169Starting at version 0.9.2, U-Boot supports NetBSD both as host
4170(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004171
wdenk6c59edc2004-05-03 20:45:30 +00004172Building requires a cross environment; it is known to work on
4173NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4174need gmake since the Makefiles are not compatible with BSD make).
4175Note that the cross-powerpc package does not install include files;
4176attempting to build U-Boot will fail because <machine/ansi.h> is
4177missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004178
wdenk6c59edc2004-05-03 20:45:30 +00004179 # cd /usr/pkg/cross/powerpc-netbsd/include
4180 # mkdir powerpc
4181 # ln -s powerpc machine
4182 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4183 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004184
wdenk6c59edc2004-05-03 20:45:30 +00004185Native builds *don't* work due to incompatibilities between native
4186and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk6c59edc2004-05-03 20:45:30 +00004188Booting assumes that (the first part of) the image booted is a
4189stage-2 loader which in turn loads and then invokes the kernel
4190proper. Loader sources will eventually appear in the NetBSD source
4191tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004192meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004193
wdenkc6097192002-11-03 00:24:07 +00004194
wdenk6c59edc2004-05-03 20:45:30 +00004195Implementation Internals:
4196=========================
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk6c59edc2004-05-03 20:45:30 +00004198The following is not intended to be a complete description of every
4199implementation detail. However, it should help to understand the
4200inner workings of U-Boot and make it easier to port it to custom
4201hardware.
wdenkc6097192002-11-03 00:24:07 +00004202
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk6c59edc2004-05-03 20:45:30 +00004204Initial Stack, Global Data:
4205---------------------------
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk6c59edc2004-05-03 20:45:30 +00004207The implementation of U-Boot is complicated by the fact that U-Boot
4208starts running out of ROM (flash memory), usually without access to
4209system RAM (because the memory controller is not initialized yet).
4210This means that we don't have writable Data or BSS segments, and BSS
4211is not initialized as zero. To be able to get a C environment working
4212at all, we have to allocate at least a minimal stack. Implementation
4213options for this are defined and restricted by the CPU used: Some CPU
4214models provide on-chip memory (like the IMMR area on MPC8xx and
4215MPC826x processors), on others (parts of) the data cache can be
4216locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004217
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004218 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004219 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk6c59edc2004-05-03 20:45:30 +00004221 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4222 From: "Chris Hallinan" <clh@net1plus.com>
4223 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4224 ...
wdenkc6097192002-11-03 00:24:07 +00004225
wdenk6c59edc2004-05-03 20:45:30 +00004226 Correct me if I'm wrong, folks, but the way I understand it
4227 is this: Using DCACHE as initial RAM for Stack, etc, does not
4228 require any physical RAM backing up the cache. The cleverness
4229 is that the cache is being used as a temporary supply of
4230 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004231 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004232 can see how this works by studying the cache architecture and
4233 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004234
wdenk6c59edc2004-05-03 20:45:30 +00004235 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4236 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004237 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004238 option should work for you. Using CS 4 should be fine if your
4239 board designers haven't used it for something that would
4240 cause you grief during the initial boot! It is frequently not
4241 used.
wdenkc6097192002-11-03 00:24:07 +00004242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004243 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004244 with your processor/board/system design. The default value
4245 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004246 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004247 than your SDRAM module. If you have a 64MB SDRAM module, set
4248 it above 400_0000. Just make sure your board has no resources
4249 that are supposed to respond to that address! That code in
4250 start.S has been around a while and should work as is when
4251 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004252
wdenk6c59edc2004-05-03 20:45:30 +00004253 -Chris Hallinan
4254 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004255
wdenk6c59edc2004-05-03 20:45:30 +00004256It is essential to remember this, since it has some impact on the C
4257code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004258
wdenk6c59edc2004-05-03 20:45:30 +00004259* Initialized global data (data segment) is read-only. Do not attempt
4260 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004261
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004262* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004263 as zero data - BSS segment) at all - this is undefined, initiali-
4264 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004265
wdenk6c59edc2004-05-03 20:45:30 +00004266* Stack space is very limited. Avoid big data buffers or things like
4267 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004268
wdenk6c59edc2004-05-03 20:45:30 +00004269Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004270normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004271turned out that the implementation of U-Boot can be greatly
4272simplified by making a global data structure (gd_t) available to all
4273functions. We could pass a pointer to this data as argument to _all_
4274functions, but this would bloat the code. Instead we use a feature of
4275the GCC compiler (Global Register Variables) to share the data: we
4276place a pointer (gd) to the global data into a register which we
4277reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279When choosing a register for such a purpose we are restricted by the
4280relevant (E)ABI specifications for the current architecture, and by
4281GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk6c59edc2004-05-03 20:45:30 +00004283For PowerPC, the following registers have specific use:
4284 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004285 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004286 R3-R4: parameter passing and return values
4287 R5-R10: parameter passing
4288 R13: small data area pointer
4289 R30: GOT pointer
4290 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004291
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004292 (U-Boot also uses R12 as internal GOT pointer. r12
4293 is a volatile register so r12 needs to be reset when
4294 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004295
Wolfgang Denk69c09642008-02-14 22:43:22 +01004296 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk6c59edc2004-05-03 20:45:30 +00004298 Note: on PPC, we could use a static initializer (since the
4299 address of the global data structure is known at compile time),
4300 but it turned out that reserving a register results in somewhat
4301 smaller code - although the code savings are not that big (on
4302 average for all boards 752 bytes for the whole U-Boot image,
4303 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk6c59edc2004-05-03 20:45:30 +00004305On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk6c59edc2004-05-03 20:45:30 +00004307 R0: function argument word/integer result
4308 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004309 R9: platform specific
4310 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004311 R11: argument (frame) pointer
4312 R12: temporary workspace
4313 R13: stack pointer
4314 R14: link register
4315 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004316
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004317 ==> U-Boot will use R9 to hold a pointer to the global data
4318
4319 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004320
Thomas Chou8fa38582010-05-21 11:08:03 +08004321On Nios II, the ABI is documented here:
Naoki Hayamae0cc1852020-10-08 13:17:16 +09004322 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou8fa38582010-05-21 11:08:03 +08004323
4324 ==> U-Boot will use gp to hold a pointer to the global data
4325
4326 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4327 to access small data sections, so gp is free.
4328
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004329On NDS32, the following registers are used:
4330
4331 R0-R1: argument/return
4332 R2-R5: argument
4333 R15: temporary register for assembler
4334 R16: trampoline register
4335 R28: frame pointer (FP)
4336 R29: global pointer (GP)
4337 R30: link register (LP)
4338 R31: stack pointer (SP)
4339 PC: program counter (PC)
4340
4341 ==> U-Boot will use R10 to hold a pointer to the global data
4342
Wolfgang Denk6405a152006-03-31 18:32:53 +02004343NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4344or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004345
Rick Chend7e6f922017-12-26 13:55:59 +08004346On RISC-V, the following registers are used:
4347
4348 x0: hard-wired zero (zero)
4349 x1: return address (ra)
4350 x2: stack pointer (sp)
4351 x3: global pointer (gp)
4352 x4: thread pointer (tp)
4353 x5: link register (t0)
4354 x8: frame pointer (fp)
4355 x10-x11: arguments/return values (a0-1)
4356 x12-x17: arguments (a2-7)
4357 x28-31: temporaries (t3-6)
4358 pc: program counter (pc)
4359
4360 ==> U-Boot will use gp to hold a pointer to the global data
4361
wdenk6c59edc2004-05-03 20:45:30 +00004362Memory Management:
4363------------------
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365U-Boot runs in system state and uses physical addresses, i.e. the
4366MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004367
wdenk6c59edc2004-05-03 20:45:30 +00004368The available memory is mapped to fixed addresses using the memory
4369controller. In this process, a contiguous block is formed for each
4370memory type (Flash, SDRAM, SRAM), even when it consists of several
4371physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk6c59edc2004-05-03 20:45:30 +00004373U-Boot is installed in the first 128 kB of the first Flash bank (on
4374TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4375booting and sizing and initializing DRAM, the code relocates itself
4376to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004377memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004378configuration setting]. Below that, a structure with global Board
4379Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk6c59edc2004-05-03 20:45:30 +00004381Additionally, some exception handler code is copied to the low 8 kB
4382of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk6c59edc2004-05-03 20:45:30 +00004384So a typical memory configuration with 16 MB of DRAM could look like
4385this:
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk6c59edc2004-05-03 20:45:30 +00004387 0x0000 0000 Exception Vector code
4388 :
4389 0x0000 1FFF
4390 0x0000 2000 Free for Application Use
4391 :
4392 :
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk6c59edc2004-05-03 20:45:30 +00004394 :
4395 :
4396 0x00FB FF20 Monitor Stack (Growing downward)
4397 0x00FB FFAC Board Info Data and permanent copy of global data
4398 0x00FC 0000 Malloc Arena
4399 :
4400 0x00FD FFFF
4401 0x00FE 0000 RAM Copy of Monitor Code
4402 ... eventually: LCD or video framebuffer
4403 ... eventually: pRAM (Protected RAM - unchanged by reset)
4404 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004405
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk6c59edc2004-05-03 20:45:30 +00004407System Initialization:
4408----------------------
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk6c59edc2004-05-03 20:45:30 +00004410In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004411(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004412configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00004413To be able to re-map memory U-Boot then jumps to its link address.
4414To be able to implement the initialization code in C, a (small!)
4415initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02004416which provide such a feature like), or in a locked part of the data
4417cache. After that, U-Boot initializes the CPU core, the caches and
4418the SIU.
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk6c59edc2004-05-03 20:45:30 +00004420Next, all (potentially) available memory banks are mapped using a
4421preliminary mapping. For example, we put them on 512 MB boundaries
4422(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4423on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4424programmed for SDRAM access. Using the temporary configuration, a
4425simple memory test is run that determines the size of the SDRAM
4426banks.
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk6c59edc2004-05-03 20:45:30 +00004428When there is more than one SDRAM bank, and the banks are of
4429different size, the largest is mapped first. For equal size, the first
4430bank (CS2#) is mapped first. The first mapping is always for address
44310x00000000, with any additional banks following immediately to create
4432contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk6c59edc2004-05-03 20:45:30 +00004434Then, the monitor installs itself at the upper end of the SDRAM area
4435and allocates memory for use by malloc() and for the global Board
4436Info data; also, the exception vector code is copied to the low RAM
4437pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk6c59edc2004-05-03 20:45:30 +00004439Only after this relocation will you have a "normal" C environment;
4440until that you are restricted in several ways, mostly because you are
4441running from ROM, and because the code will have to be relocated to a
4442new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004443
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk6c59edc2004-05-03 20:45:30 +00004445U-Boot Porting Guide:
4446----------------------
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4449list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004450
wdenkc6097192002-11-03 00:24:07 +00004451
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004452int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004453{
4454 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004455
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004456 signal(SIGALRM, no_more_time);
4457 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004460 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004461 return 0;
4462 }
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk6c59edc2004-05-03 20:45:30 +00004464 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004465
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004466 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004467
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004468 if (clueless)
4469 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk6c59edc2004-05-03 20:45:30 +00004471 while (learning) {
4472 Read the README file in the top level directory;
Naoki Hayamae0cc1852020-10-08 13:17:16 +09004473 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01004474 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00004475 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004476 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004477 }
wdenkc6097192002-11-03 00:24:07 +00004478
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004479 if (available_money > toLocalCurrency ($2500))
4480 Buy a BDI3000;
4481 else
wdenk6c59edc2004-05-03 20:45:30 +00004482 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004483
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004484 if (a similar board exists) { /* hopefully... */
4485 cp -a board/<similar> board/<myboard>
4486 cp include/configs/<similar>.h include/configs/<myboard>.h
4487 } else {
4488 Create your own board support subdirectory;
4489 Create your own board include/configs/<myboard>.h file;
4490 }
4491 Edit new board/<myboard> files
4492 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004493
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004494 while (!accepted) {
4495 while (!running) {
4496 do {
4497 Add / modify source code;
4498 } until (compiles);
4499 Debug;
4500 if (clueless)
4501 email("Hi, I am having problems...");
4502 }
4503 Send patch file to the U-Boot email list;
4504 if (reasonable critiques)
4505 Incorporate improvements from email list code review;
4506 else
4507 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004508 }
wdenkc6097192002-11-03 00:24:07 +00004509
wdenk6c59edc2004-05-03 20:45:30 +00004510 return 0;
4511}
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk6c59edc2004-05-03 20:45:30 +00004513void no_more_time (int sig)
4514{
4515 hire_a_guru();
4516}
wdenkc6097192002-11-03 00:24:07 +00004517
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk6c59edc2004-05-03 20:45:30 +00004519Coding Standards:
4520-----------------
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk6c59edc2004-05-03 20:45:30 +00004522All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02004523coding style; see the kernel coding style guide at
4524https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4525script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004526
4527Source files originating from a different project (for example the
4528MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004529reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02004530sources.
wdenkc6097192002-11-03 00:24:07 +00004531
Detlev Zundelaa63d482006-09-01 15:39:02 +02004532Please note that U-Boot is implemented in C (and to some small parts in
4533Assembler); no C++ is used, so please do not use C++ style comments (//)
4534in your code.
wdenkad276f22004-01-04 16:28:35 +00004535
wdenk6c59edc2004-05-03 20:45:30 +00004536Please also stick to the following formatting rules:
4537- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004538- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004539- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004540- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004541- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543Submissions which do not conform to the standards may be returned
4544with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004545
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547Submitting Patches:
4548-------------------
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550Since the number of patches for U-Boot is growing, we need to
4551establish some rules. Submissions which do not conform to these rules
4552may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004553
Naoki Hayamae0cc1852020-10-08 13:17:16 +09004554Please see https://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004555
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004556Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08004557see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004558
wdenk6c59edc2004-05-03 20:45:30 +00004559When you send a patch, please include the following information with
4560it:
wdenkc6097192002-11-03 00:24:07 +00004561
wdenk6c59edc2004-05-03 20:45:30 +00004562* For bug fixes: a description of the bug and how your patch fixes
4563 this bug. Please try to include a way of demonstrating that the
4564 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566* For new features: a description of the feature and your
4567 implementation.
wdenkc6097192002-11-03 00:24:07 +00004568
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05004569* For major contributions, add a MAINTAINERS file with your
4570 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00004571
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02004572* When you add support for a new board, don't forget to add a
4573 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00004574
wdenk6c59edc2004-05-03 20:45:30 +00004575* If your patch adds new configuration options, don't forget to
4576 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004577
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004578* The patch itself. If you are using git (which is *strongly*
4579 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004580 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004581 the U-Boot mailing list, you will avoid most of the common problems
4582 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004583
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004584 If you cannot use git, use "diff -purN OLD NEW". If your version of
4585 diff does not support these options, then get the latest version of
4586 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004587
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004588 The current directory when running this command shall be the parent
4589 directory of the U-Boot source tree (i. e. please make sure that
4590 your patch includes sufficient directory information for the
4591 affected files).
4592
4593 We prefer patches as plain text. MIME attachments are discouraged,
4594 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004595
wdenk6c59edc2004-05-03 20:45:30 +00004596* If one logical set of modifications affects or creates several
4597 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004598
wdenk6c59edc2004-05-03 20:45:30 +00004599* Changesets that contain different, unrelated modifications shall be
4600 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004601
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk6c59edc2004-05-03 20:45:30 +00004603Notes:
wdenkc6097192002-11-03 00:24:07 +00004604
Simon Glassdc27def2016-07-27 20:33:08 -06004605* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00004606 source tree and make sure that no errors or warnings are reported
4607 for any of the boards.
4608
4609* Keep your modifications to the necessary minimum: A patch
4610 containing several unrelated changes or arbitrary reformats will be
4611 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004612
wdenk6c59edc2004-05-03 20:45:30 +00004613* If you modify existing code, make sure that your new code does not
4614 add to the memory footprint of the code ;-) Small is beautiful!
4615 When adding new features, these should compile conditionally only
4616 (using #ifdef), and the resulting code with the new feature
4617 disabled must not need more memory than the old code without your
4618 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004619
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004620* Remember that there is a size limit of 100 kB per message on the
4621 u-boot mailing list. Bigger patches will be moderated. If they are
4622 reasonable and not too big, they will be acknowledged. But patches
4623 bigger than the size limit should be avoided.