blob: fd1e17c51375ccaf58d9c8331b4095794cc1e0b8 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000043
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050061The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010062git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500137 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000140 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400142 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200143 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800144 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500145 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400147 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148/api Machine/arch independent API for external apps
149/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800150/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500152/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/disk Code for disk drive partition handling
154/doc Documentation (don't expect too much)
155/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400156/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157/examples Example code for standalone applications, etc.
158/fs Filesystem code (cramfs, ext2, jffs2, etc.)
159/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500160/lib Library routines generic to all architectures
161/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500162/net Networking code
163/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500164/scripts Various build scripts and Makefiles
165/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000167
wdenkc6097192002-11-03 00:24:07 +0000168Software Configuration:
169=======================
170
171Configuration is usually done using C preprocessor defines; the
172rationale behind that is to avoid dead code whenever possible.
173
174There are two classes of configuration variables:
175
176* Configuration _OPTIONS_:
177 These are selectable by the user and have names beginning with
178 "CONFIG_".
179
180* Configuration _SETTINGS_:
181 These depend on the hardware etc. and should not be meddled with if
182 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200183 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000184
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500185Previously, all configuration was done by hand, which involved creating
186symbolic links and editing configuration files manually. More recently,
187U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188allowing you to use the "make menuconfig" command to configure your
189build.
wdenkc6097192002-11-03 00:24:07 +0000190
191
192Selection of Processor Architecture and Board Type:
193---------------------------------------------------
194
195For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200196configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000197
198Example: For a TQM823L module type:
199
200 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200201 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000202
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500203Note: If you're looking for the default configuration file for a board
204you're sure used to be there but is now missing, check the file
205doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000206
Simon Glass53552c92014-03-22 17:12:59 -0600207Sandbox Environment:
208--------------------
209
210U-Boot can be built natively to run on a Linux host using the 'sandbox'
211board. This allows feature development which is not board- or architecture-
212specific to be undertaken on a native platform. The sandbox is also used to
213run some of U-Boot's tests.
214
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530215See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600216
217
Simon Glassd8711af2015-03-03 08:03:00 -0700218Board Initialisation Flow:
219--------------------------
220
221This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500222SPL and U-Boot proper (i.e. they both follow the same rules).
223
224Note: "SPL" stands for "Secondary Program Loader," which is explained in
225more detail later in this file.
226
227At present, SPL mostly uses a separate code path, but the function names
228and roles of each function are the same. Some boards or architectures
229may not conform to this. At least most ARM boards which use
230CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700231
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500232Execution typically starts with an architecture-specific (and possibly
233CPU-specific) start.S file, such as:
234
235 - arch/arm/cpu/armv7/start.S
236 - arch/powerpc/cpu/mpc83xx/start.S
237 - arch/mips/cpu/start.S
238
239and so on. From there, three functions are called; the purpose and
240limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700241
242lowlevel_init():
243 - purpose: essential init to permit execution to reach board_init_f()
244 - no global_data or BSS
245 - there is no stack (ARMv7 may have one but it will soon be removed)
246 - must not set up SDRAM or use console
247 - must only do the bare minimum to allow execution to continue to
248 board_init_f()
249 - this is almost never needed
250 - return normally from this function
251
252board_init_f():
253 - purpose: set up the machine ready for running board_init_r():
254 i.e. SDRAM and serial UART
255 - global_data is available
256 - stack is in SRAM
257 - BSS is not available, so you cannot use global/static variables,
258 only stack variables and global_data
259
260 Non-SPL-specific notes:
261 - dram_init() is called to set up DRAM. If already done in SPL this
262 can do nothing
263
264 SPL-specific notes:
265 - you can override the entire board_init_f() function with your own
266 version as needed.
267 - preloader_console_init() can be called here in extremis
268 - should set up SDRAM, and anything needed to make the UART work
269 - these is no need to clear BSS, it will be done by crt0.S
270 - must return normally from this function (don't call board_init_r()
271 directly)
272
273Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
274this point the stack and global_data are relocated to below
275CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
276memory.
277
278board_init_r():
279 - purpose: main execution, common code
280 - global_data is available
281 - SDRAM is available
282 - BSS is available, all static/global variables can be used
283 - execution eventually continues to main_loop()
284
285 Non-SPL-specific notes:
286 - U-Boot is relocated to the top of memory and is now running from
287 there.
288
289 SPL-specific notes:
290 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
291 CONFIG_SPL_STACK_R_ADDR points into SDRAM
292 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800293 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700294 spl_board_init() function containing this call
295 - loads U-Boot or (in falcon mode) Linux
296
297
298
wdenkc6097192002-11-03 00:24:07 +0000299Configuration Options:
300----------------------
301
302Configuration depends on the combination of board and CPU type; all
303such information is kept in a configuration file
304"include/configs/<board_name>.h".
305
306Example: For a TQM823L module, all configuration settings are in
307"include/configs/TQM823L.h".
308
309
wdenk1272e232002-11-10 22:06:23 +0000310Many of the options are named exactly as the corresponding Linux
311kernel configuration options. The intention is to make it easier to
312build a config tool - later.
313
Ashish Kumar11234062017-08-11 11:09:14 +0530314- ARM Platform Bus Type(CCI):
315 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
316 provides full cache coherency between two clusters of multi-core
317 CPUs and I/O coherency for devices and I/O masters
318
319 CONFIG_SYS_FSL_HAS_CCI400
320
321 Defined For SoC that has cache coherent interconnect
322 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000323
Ashish Kumar97393d62017-08-18 10:54:36 +0530324 CONFIG_SYS_FSL_HAS_CCN504
325
326 Defined for SoC that has cache coherent interconnect CCN-504
327
wdenkc6097192002-11-03 00:24:07 +0000328The following options need to be configured:
329
Kim Phillips203fee32007-08-10 13:28:25 -0500330- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000331
Kim Phillips203fee32007-08-10 13:28:25 -0500332- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200333
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600334- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000335 CONFIG_SYS_PPC64
336
337 Specifies that the core is a 64-bit PowerPC implementation (implements
338 the "64" category of the Power ISA). This is necessary for ePAPR
339 compliance, among other possible reasons.
340
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600341 CONFIG_SYS_FSL_TBCLK_DIV
342
343 Defines the core time base clock divider ratio compared to the
344 system clock. On most PQ3 devices this is 8, on newer QorIQ
345 devices it can be 16 or 32. The ratio varies from SoC to Soc.
346
Kumar Gala179b1b22011-05-20 00:39:21 -0500347 CONFIG_SYS_FSL_PCIE_COMPAT
348
349 Defines the string to utilize when trying to match PCIe device
350 tree nodes for the given platform.
351
Scott Wood80806962012-08-14 10:14:53 +0000352 CONFIG_SYS_FSL_ERRATUM_A004510
353
354 Enables a workaround for erratum A004510. If set,
355 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
356 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
357
358 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
359 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
360
361 Defines one or two SoC revisions (low 8 bits of SVR)
362 for which the A004510 workaround should be applied.
363
364 The rest of SVR is either not relevant to the decision
365 of whether the erratum is present (e.g. p2040 versus
366 p2041) or is implied by the build target, which controls
367 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
368
369 See Freescale App Note 4493 for more information about
370 this erratum.
371
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530372 CONFIG_A003399_NOR_WORKAROUND
373 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800374 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530375
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530376 CONFIG_A008044_WORKAROUND
377 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800378 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530379
Scott Wood80806962012-08-14 10:14:53 +0000380 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
381
382 This is the value to write into CCSR offset 0x18600
383 according to the A004510 workaround.
384
Priyanka Jainc73b9032013-07-02 09:21:04 +0530385 CONFIG_SYS_FSL_DSP_DDR_ADDR
386 This value denotes start offset of DDR memory which is
387 connected exclusively to the DSP cores.
388
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530389 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
390 This value denotes start offset of M2 memory
391 which is directly connected to the DSP core.
392
Priyanka Jainc73b9032013-07-02 09:21:04 +0530393 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
394 This value denotes start offset of M3 memory which is directly
395 connected to the DSP core.
396
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530397 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
398 This value denotes start offset of DSP CCSR space.
399
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530400 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
401 Single Source Clock is clocking mode present in some of FSL SoC's.
402 In this mode, a single differential clock is used to supply
403 clocks to the sysclock, ddrclock and usbclock.
404
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530405 CONFIG_SYS_CPC_REINIT_F
406 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800407 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530408
Tang Yuantiana7364af2014-04-17 15:33:46 +0800409 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800410 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800411 supported, core will start to execute uboot when wakes up.
412
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000413- Generic CPU options:
414 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
415
416 Defines the endianess of the CPU. Implementation of those
417 values is arch specific.
418
York Sunf0626592013-09-30 09:22:09 -0700419 CONFIG_SYS_FSL_DDR
420 Freescale DDR driver in use. This type of DDR controller is
421 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
422 SoCs.
423
424 CONFIG_SYS_FSL_DDR_ADDR
425 Freescale DDR memory-mapped register base.
426
427 CONFIG_SYS_FSL_DDR_EMU
428 Specify emulator support for DDR. Some DDR features such as
429 deskew training are not available.
430
431 CONFIG_SYS_FSL_DDRC_GEN1
432 Freescale DDR1 controller.
433
434 CONFIG_SYS_FSL_DDRC_GEN2
435 Freescale DDR2 controller.
436
437 CONFIG_SYS_FSL_DDRC_GEN3
438 Freescale DDR3 controller.
439
York Sun2896cb72014-03-27 17:54:47 -0700440 CONFIG_SYS_FSL_DDRC_GEN4
441 Freescale DDR4 controller.
442
York Sun461c9392013-09-30 14:20:51 -0700443 CONFIG_SYS_FSL_DDRC_ARM_GEN3
444 Freescale DDR3 controller for ARM-based SoCs.
445
York Sunf0626592013-09-30 09:22:09 -0700446 CONFIG_SYS_FSL_DDR1
447 Board config to use DDR1. It can be enabled for SoCs with
448 Freescale DDR1 or DDR2 controllers, depending on the board
449 implemetation.
450
451 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400452 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700453 Freescale DDR2 or DDR3 controllers, depending on the board
454 implementation.
455
456 CONFIG_SYS_FSL_DDR3
457 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700458 Freescale DDR3 or DDR3L controllers.
459
460 CONFIG_SYS_FSL_DDR3L
461 Board config to use DDR3L. It can be enabled for SoCs with
462 DDR3L controllers.
463
464 CONFIG_SYS_FSL_DDR4
465 Board config to use DDR4. It can be enabled for SoCs with
466 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700467
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530468 CONFIG_SYS_FSL_IFC_BE
469 Defines the IFC controller register space as Big Endian
470
471 CONFIG_SYS_FSL_IFC_LE
472 Defines the IFC controller register space as Little Endian
473
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530474 CONFIG_SYS_FSL_IFC_CLK_DIV
475 Defines divider of platform clock(clock input to IFC controller).
476
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530477 CONFIG_SYS_FSL_LBC_CLK_DIV
478 Defines divider of platform clock(clock input to eLBC controller).
479
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530480 CONFIG_SYS_FSL_PBL_PBI
481 It enables addition of RCW (Power on reset configuration) in built image.
482 Please refer doc/README.pblimage for more details
483
484 CONFIG_SYS_FSL_PBL_RCW
485 It adds PBI(pre-boot instructions) commands in u-boot build image.
486 PBI commands can be used to configure SoC before it starts the execution.
487 Please refer doc/README.pblimage for more details
488
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530489 CONFIG_SPL_FSL_PBL
490 It adds a target to create boot binary having SPL binary in PBI format
491 concatenated with u-boot binary.
492
York Sun29647ab2014-02-10 13:59:42 -0800493 CONFIG_SYS_FSL_DDR_BE
494 Defines the DDR controller register space as Big Endian
495
496 CONFIG_SYS_FSL_DDR_LE
497 Defines the DDR controller register space as Little Endian
498
York Sun3a0916d2014-02-10 13:59:43 -0800499 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
500 Physical address from the view of DDR controllers. It is the
501 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
502 it could be different for ARM SoCs.
503
York Sunc459ae62014-02-10 13:59:44 -0800504 CONFIG_SYS_FSL_DDR_INTLV_256B
505 DDR controller interleaving on 256-byte. This is a special
506 interleaving mode, handled by Dickens for Freescale layerscape
507 SoCs with ARM core.
508
York Sun79a779b2014-08-01 15:51:00 -0700509 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
510 Number of controllers used as main memory.
511
512 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
513 Number of controllers used for other than main memory.
514
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530515 CONFIG_SYS_FSL_HAS_DP_DDR
516 Defines the SoC has DP-DDR used for DPAA.
517
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530518 CONFIG_SYS_FSL_SEC_BE
519 Defines the SEC controller register space as Big Endian
520
521 CONFIG_SYS_FSL_SEC_LE
522 Defines the SEC controller register space as Little Endian
523
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200524- MIPS CPU options:
525 CONFIG_SYS_INIT_SP_OFFSET
526
527 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
528 pointer. This is needed for the temporary stack before
529 relocation.
530
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200531 CONFIG_XWAY_SWAP_BYTES
532
533 Enable compilation of tools/xway-swap-bytes needed for Lantiq
534 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
535 be swapped if a flash programmer is used.
536
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000537- ARM options:
538 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
539
540 Select high exception vectors of the ARM core, e.g., do not
541 clear the V bit of the c1 register of CP15.
542
York Sun77a10972015-03-20 19:28:08 -0700543 COUNTER_FREQUENCY
544 Generic timer clock source frequency.
545
546 COUNTER_FREQUENCY_REAL
547 Generic timer clock source frequency if the real clock is
548 different from COUNTER_FREQUENCY, and can only be determined
549 at run time.
550
Stephen Warren8d1fb312015-01-19 16:25:52 -0700551- Tegra SoC options:
552 CONFIG_TEGRA_SUPPORT_NON_SECURE
553
554 Support executing U-Boot in non-secure (NS) mode. Certain
555 impossible actions will be skipped if the CPU is in NS mode,
556 such as ARM architectural timer initialization.
557
wdenk9b7f3842003-10-09 20:09:04 +0000558- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000559 CONFIG_CLOCKS_IN_MHZ
560
561 U-Boot stores all clock information in Hz
562 internally. For binary compatibility with older Linux
563 kernels (which expect the clocks passed in the
564 bd_info data to be in MHz) the environment variable
565 "clocks_in_mhz" can be defined so that U-Boot
566 converts clock data to MHZ before passing it to the
567 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000568 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100569 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000570 default environment.
571
wdenk9b7f3842003-10-09 20:09:04 +0000572 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
573
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800574 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000575 expect it to be in bytes, others in MB.
576 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
577
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400578 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200579
580 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400581 passed using flattened device trees (based on open firmware
582 concepts).
583
584 CONFIG_OF_LIBFDT
585 * New libfdt-based support
586 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500587 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400588
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200589 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600590 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200591
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200592 boards with QUICC Engines require OF_QE to set UCC MAC
593 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500594
Kumar Gala1e26aa52006-01-11 13:54:17 -0600595 CONFIG_OF_BOARD_SETUP
596
597 Board code has addition modification that it wants to make
598 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000599
Simon Glass6c0be912014-10-23 18:58:54 -0600600 CONFIG_OF_SYSTEM_SETUP
601
602 Other code has addition modification that it wants to make
603 to the flat device tree before handing it off to the kernel.
604 This causes ft_system_setup() to be called before booting
605 the kernel.
606
Heiko Schocherffb293a2009-09-23 07:56:08 +0200607 CONFIG_OF_IDE_FIXUP
608
609 U-Boot can detect if an IDE device is present or not.
610 If not, and this new config option is activated, U-Boot
611 removes the ATA node from the DTS before booting Linux,
612 so the Linux IDE driver does not probe the device and
613 crash. This is needed for buggy hardware (uc101) where
614 no pull down resistor is connected to the signal IDE5V_DD7.
615
Igor Grinberg06890672011-07-14 05:45:07 +0000616 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
617
618 This setting is mandatory for all boards that have only one
619 machine type and must be used to specify the machine type
620 number as it appears in the ARM machine registry
621 (see http://www.arm.linux.org.uk/developer/machines/).
622 Only boards that have multiple machine types supported
623 in a single configuration file and the machine type is
624 runtime discoverable, do not have to use this setting.
625
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100626- vxWorks boot parameters:
627
628 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700629 environments variables: bootdev, bootfile, ipaddr, netmask,
630 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100631 It loads the vxWorks image pointed bootfile.
632
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100633 Note: If a "bootargs" environment is defined, it will overwride
634 the defaults discussed just above.
635
Aneesh V960f5c02011-06-16 23:30:47 +0000636- Cache Configuration:
Aneesh V960f5c02011-06-16 23:30:47 +0000637 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
638
Aneesh V686a0752011-06-16 23:30:51 +0000639- Cache Configuration for ARM:
640 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
641 controller
642 CONFIG_SYS_PL310_BASE - Physical base address of PL310
643 controller register space
644
wdenkda04a8b2004-08-02 23:22:59 +0000645- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200646 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000647
648 Define this if you want support for Amba PrimeCell PL010 UARTs.
649
Andreas Engel0813b122008-09-08 14:30:53 +0200650 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000651
652 Define this if you want support for Amba PrimeCell PL011 UARTs.
653
654 CONFIG_PL011_CLOCK
655
656 If you have Amba PrimeCell PL011 UARTs, set this variable to
657 the clock speed of the UARTs.
658
659 CONFIG_PL01x_PORTS
660
661 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
662 define this to a list of base addresses for each (supported)
663 port. See e.g. include/configs/versatile.h
664
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400665 CONFIG_SERIAL_HW_FLOW_CONTROL
666
667 Define this variable to enable hw flow control in serial driver.
668 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000669
wdenkc6097192002-11-03 00:24:07 +0000670- Console Baudrate:
671 CONFIG_BAUDRATE - in bps
672 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200673 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000674
wdenkc6097192002-11-03 00:24:07 +0000675- Autoboot Command:
676 CONFIG_BOOTCOMMAND
677 Only needed when CONFIG_BOOTDELAY is enabled;
678 define a command string that is automatically executed
679 when no character is read on the console interface
680 within "Boot Delay" after reset.
681
wdenkc6097192002-11-03 00:24:07 +0000682 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000683 The value of these goes into the environment as
684 "ramboot" and "nfsboot" respectively, and can be used
685 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200686 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000687
wdenkc6097192002-11-03 00:24:07 +0000688- Serial Download Echo Mode:
689 CONFIG_LOADS_ECHO
690 If defined to 1, all characters received during a
691 serial download (using the "loads" command) are
692 echoed back. This might be needed by some terminal
693 emulations (like "cu"), but may as well just take
694 time on others. This setting #define's the initial
695 value of the "loads_echo" environment variable.
696
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500697- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000698 CONFIG_KGDB_BAUDRATE
699 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200700 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000701
Simon Glassaa34ef22016-03-13 19:07:28 -0600702- Removal of commands
703 If no commands are needed to boot, you can disable
704 CONFIG_CMDLINE to remove them. In this case, the command line
705 will not be available, and when U-Boot wants to execute the
706 boot command (on start-up) it will call board_run_command()
707 instead. This can reduce image size significantly for very
708 simple boot procedures.
709
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000710- Regular expression support:
711 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200712 If this variable is defined, U-Boot is linked against
713 the SLRE (Super Light Regular Expression) library,
714 which adds regex support to some commands, as for
715 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000716
Simon Glass3d686442011-10-15 05:48:20 +0000717- Device tree:
718 CONFIG_OF_CONTROL
719 If this variable is defined, U-Boot will use a device tree
720 to configure its devices, instead of relying on statically
721 compiled #defines in the board file. This option is
722 experimental and only available on a few boards. The device
723 tree is available in the global data as gd->fdt_blob.
724
Simon Glass5cb34db2011-10-24 19:15:31 +0000725 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700726 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000727
728 CONFIG_OF_EMBED
729 If this variable is defined, U-Boot will embed a device tree
730 binary in its image. This device tree file should be in the
731 board directory and called <soc>-<board>.dts. The binary file
732 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900733 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000734
Simon Glass5cb34db2011-10-24 19:15:31 +0000735 CONFIG_OF_SEPARATE
736 If this variable is defined, U-Boot will build a device tree
737 binary. It will be called u-boot.dtb. Architecture-specific
738 code will locate it at run-time. Generally this works by:
739
740 cat u-boot.bin u-boot.dtb >image.bin
741
742 and in fact, U-Boot does this for you, creating a file called
743 u-boot-dtb.bin which is useful in the common case. You can
744 still use the individual files if you need something more
745 exotic.
746
Alex Deymo5b661ec2017-04-02 01:25:20 -0700747 CONFIG_OF_BOARD
748 If this variable is defined, U-Boot will use the device tree
749 provided by the board at runtime instead of embedding one with
750 the image. Only boards defining board_fdt_blob_setup() support
751 this option (see include/fdtdec.h file).
752
wdenkc6097192002-11-03 00:24:07 +0000753- Watchdog:
754 CONFIG_WATCHDOG
755 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000756 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200757 specific code for a watchdog. For the 8xx
758 CPUs, the SIU Watchdog feature is enabled in the SYPCR
759 register. When supported for a specific SoC is
760 available, then no further board specific code should
761 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000762
763 CONFIG_HW_WATCHDOG
764 When using a watchdog circuitry external to the used
765 SoC, then define this variable and provide board
766 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000767
768- Real-Time Clock:
769
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500770 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000771 has to be selected, too. Define exactly one of the
772 following options:
773
wdenkc6097192002-11-03 00:24:07 +0000774 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000775 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000776 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000777 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000778 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000779 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200780 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000781 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100782 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000783 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200784 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200785 CONFIG_SYS_RV3029_TCR - enable trickle charger on
786 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000787
wdenkb9bbd242003-06-30 16:24:52 +0000788 Note that if the RTC uses I2C, then the I2C interface
789 must also be configured. See I2C Support, below.
790
Peter Tyser9902e422008-12-17 16:36:21 -0600791- GPIO Support:
792 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600793
Chris Packham9b383202010-12-19 10:12:13 +0000794 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
795 chip-ngpio pairs that tell the PCA953X driver the number of
796 pins supported by a particular chip.
797
Peter Tyser9902e422008-12-17 16:36:21 -0600798 Note that if the GPIO device uses I2C, then the I2C interface
799 must also be configured. See I2C Support, below.
800
Simon Glass4dc47ca2014-06-11 23:29:41 -0600801- I/O tracing:
802 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
803 accesses and can checksum them or write a list of them out
804 to memory. See the 'iotrace' command for details. This is
805 useful for testing device drivers since it can confirm that
806 the driver behaves the same way before and after a code
807 change. Currently this is supported on sandbox and arm. To
808 add support for your architecture, add '#include <iotrace.h>'
809 to the bottom of arch/<arch>/include/asm/io.h and test.
810
811 Example output from the 'iotrace stats' command is below.
812 Note that if the trace buffer is exhausted, the checksum will
813 still continue to operate.
814
815 iotrace is enabled
816 Start: 10000000 (buffer start address)
817 Size: 00010000 (buffer size)
818 Offset: 00000120 (current buffer offset)
819 Output: 10000120 (start + offset)
820 Count: 00000018 (number of trace records)
821 CRC32: 9526fb66 (CRC32 of all trace records)
822
wdenkc6097192002-11-03 00:24:07 +0000823- Timestamp Support:
824
wdenk4a5c8a72003-03-06 00:02:04 +0000825 When CONFIG_TIMESTAMP is selected, the timestamp
826 (date and time) of an image is printed by image
827 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500828 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000829
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000830- Partition Labels (disklabels) Supported:
831 Zero or more of the following:
832 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000833 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
834 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
835 bootloader. Note 2TB partition limit; see
836 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600837 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000838 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000839
840- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000841 CONFIG_IDE_RESET_ROUTINE - this is defined in several
842 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000843
wdenk369d43d2004-03-14 14:09:05 +0000844 CONFIG_IDE_RESET - is this is defined, IDE Reset will
845 be performed by calling the function
846 ide_set_reset(int reset)
847 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000848
849- ATAPI Support:
850 CONFIG_ATAPI
851
852 Set this to enable ATAPI support.
853
wdenkf602aa02004-03-13 23:29:43 +0000854- LBA48 Support
855 CONFIG_LBA48
856
857 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100858 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000859 Whithout these , LBA48 support uses 32bit variables and will 'only'
860 support disks up to 2.1TB.
861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200862 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000863 When enabled, makes the IDE subsystem use 64bit sector addresses.
864 Default is 32bit.
865
wdenkc6097192002-11-03 00:24:07 +0000866- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200867 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
868 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
869 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000870 maximum numbers of LUNs, SCSI ID's and target
871 devices.
wdenkc6097192002-11-03 00:24:07 +0000872
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200873 The environment variable 'scsidevs' is set to the number of
874 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000875
wdenkc6097192002-11-03 00:24:07 +0000876- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000877 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000878 Support for Intel 8254x/8257x gigabit chips.
879
880 CONFIG_E1000_SPI
881 Utility code for direct access to the SPI bus on Intel 8257x.
882 This does not do anything useful unless you set at least one
883 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
884
885 CONFIG_E1000_SPI_GENERIC
886 Allow generic access to the SPI bus on the Intel 8257x, for
887 example with the "sspi" command.
888
wdenkc6097192002-11-03 00:24:07 +0000889 CONFIG_EEPRO100
890 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200891 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000892 write routine for first time initialisation.
893
894 CONFIG_TULIP
895 Support for Digital 2114x chips.
896 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
897 modem chip initialisation (KS8761/QS6611).
898
899 CONFIG_NATSEMI
900 Support for National dp83815 chips.
901
902 CONFIG_NS8382X
903 Support for National dp8382[01] gigabit chips.
904
wdenkaa603362003-05-12 21:50:16 +0000905- NETWORK Support (other):
906
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100907 CONFIG_DRIVER_AT91EMAC
908 Support for AT91RM9200 EMAC.
909
910 CONFIG_RMII
911 Define this to use reduced MII inteface
912
913 CONFIG_DRIVER_AT91EMAC_QUIET
914 If this defined, the driver is quiet.
915 The driver doen't show link status messages.
916
Rob Herringc9830dc2011-12-15 11:15:49 +0000917 CONFIG_CALXEDA_XGMAC
918 Support for the Calxeda XGMAC device
919
Ashok93fb8722012-10-15 06:20:47 +0000920 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000921 Support for SMSC's LAN91C96 chips.
922
wdenkaa603362003-05-12 21:50:16 +0000923 CONFIG_LAN91C96_USE_32_BIT
924 Define this to enable 32 bit addressing
925
Ashok93fb8722012-10-15 06:20:47 +0000926 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000927 Support for SMSC's LAN91C111 chip
928
929 CONFIG_SMC91111_BASE
930 Define this to hold the physical address
931 of the device (I/O space)
932
933 CONFIG_SMC_USE_32_BIT
934 Define this if data bus is 32 bits
935
936 CONFIG_SMC_USE_IOFUNCS
937 Define this to use i/o functions instead of macros
938 (some hardware wont work with macros)
939
Heiko Schocher7d037f72011-11-15 10:00:04 -0500940 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
941 Define this if you have more then 3 PHYs.
942
Macpaul Lin199c6252010-12-21 16:59:46 +0800943 CONFIG_FTGMAC100
944 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
945
946 CONFIG_FTGMAC100_EGIGA
947 Define this to use GE link update with gigabit PHY.
948 Define this if FTGMAC100 is connected to gigabit PHY.
949 If your system has 10/100 PHY only, it might not occur
950 wrong behavior. Because PHY usually return timeout or
951 useless data when polling gigabit status and gigabit
952 control registers. This behavior won't affect the
953 correctnessof 10/100 link speed update.
954
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900955 CONFIG_SH_ETHER
956 Support for Renesas on-chip Ethernet controller
957
958 CONFIG_SH_ETHER_USE_PORT
959 Define the number of ports to be used
960
961 CONFIG_SH_ETHER_PHY_ADDR
962 Define the ETH PHY's address
963
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900964 CONFIG_SH_ETHER_CACHE_WRITEBACK
965 If this option is set, the driver enables cache flush.
966
Heiko Schocher2b387762014-07-18 06:07:19 +0200967- PWM Support:
968 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -0400969 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +0200970
Vadim Bendeburydac69642011-10-17 08:36:14 +0000971- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000972 CONFIG_TPM
973 Support TPM devices.
974
Christophe Ricard8759ff82015-10-06 22:54:41 +0200975 CONFIG_TPM_TIS_INFINEON
976 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000977 per system is supported at this time.
978
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000979 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
980 Define the burst count bytes upper limit
981
Christophe Ricard88249232016-01-21 23:27:13 +0100982 CONFIG_TPM_ST33ZP24
983 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
984
985 CONFIG_TPM_ST33ZP24_I2C
986 Support for STMicroelectronics ST33ZP24 I2C devices.
987 Requires TPM_ST33ZP24 and I2C.
988
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100989 CONFIG_TPM_ST33ZP24_SPI
990 Support for STMicroelectronics ST33ZP24 SPI devices.
991 Requires TPM_ST33ZP24 and SPI.
992
Dirk Eibach20489092013-06-26 15:55:15 +0200993 CONFIG_TPM_ATMEL_TWI
994 Support for Atmel TWI TPM device. Requires I2C support.
995
Che-liang Chiouacea5702013-04-12 11:04:34 +0000996 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000997 Support for generic parallel port TPM devices. Only one device
998 per system is supported at this time.
999
1000 CONFIG_TPM_TIS_BASE_ADDRESS
1001 Base address where the generic TPM device is mapped
1002 to. Contemporary x86 systems usually map it at
1003 0xfed40000.
1004
Reinhard Pfau4fece432013-06-26 15:55:13 +02001005 CONFIG_TPM
1006 Define this to enable the TPM support library which provides
1007 functional interfaces to some TPM commands.
1008 Requires support for a TPM device.
1009
1010 CONFIG_TPM_AUTH_SESSIONS
1011 Define this to enable authorized functions in the TPM library.
1012 Requires CONFIG_TPM and CONFIG_SHA1.
1013
wdenkc6097192002-11-03 00:24:07 +00001014- USB Support:
1015 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001016 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001017 CONFIG_USB_UHCI to enable it.
1018 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001019 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001020 storage devices.
1021 Note:
1022 Supported are USB Keyboards and USB Floppy drives
1023 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001024
Simon Glass5978cdb2012-02-27 10:52:47 +00001025 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1026 txfilltuning field in the EHCI controller on reset.
1027
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001028 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1029 HW module registers.
1030
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001031- USB Device:
1032 Define the below if you wish to use the USB console.
1033 Once firmware is rebuilt from a serial console issue the
1034 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001035 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001036 it has found a new device. The environment variable usbtty
1037 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001038 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001039 Common Device Class Abstract Control Model serial device.
1040 If you select usbtty = gserial you should be able to enumerate
1041 a Linux host by
1042 # modprobe usbserial vendor=0xVendorID product=0xProductID
1043 else if using cdc_acm, simply setting the environment
1044 variable usbtty to be cdc_acm should suffice. The following
1045 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001046
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001047 CONFIG_USB_DEVICE
1048 Define this to build a UDC device
1049
1050 CONFIG_USB_TTY
1051 Define this to have a tty type of device available to
1052 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001053
Vipin KUMARbdb17702012-03-26 15:38:06 +05301054 CONFIG_USBD_HS
1055 Define this to enable the high speed support for usb
1056 device and usbtty. If this feature is enabled, a routine
1057 int is_usbd_high_speed(void)
1058 also needs to be defined by the driver to dynamically poll
1059 whether the enumeration has succeded at high speed or full
1060 speed.
1061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001062 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001063 Define this if you want stdin, stdout &/or stderr to
1064 be set to usbtty.
1065
Wolfgang Denke2601822006-06-14 18:14:56 +02001066 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001067 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001068 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001069 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1070 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1071 should pretend to be a Linux device to it's target host.
1072
1073 CONFIG_USBD_MANUFACTURER
1074 Define this string as the name of your company for
1075 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001076
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001077 CONFIG_USBD_PRODUCT_NAME
1078 Define this string as the name of your product
1079 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001080
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001081 CONFIG_USBD_VENDORID
1082 Define this as your assigned Vendor ID from the USB
1083 Implementors Forum. This *must* be a genuine Vendor ID
1084 to avoid polluting the USB namespace.
1085 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001086
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001087 CONFIG_USBD_PRODUCTID
1088 Define this as the unique Product ID
1089 for your device
1090 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001091
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001092- ULPI Layer Support:
1093 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1094 the generic ULPI layer. The generic layer accesses the ULPI PHY
1095 via the platform viewport, so you need both the genric layer and
1096 the viewport enabled. Currently only Chipidea/ARC based
1097 viewport is supported.
1098 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1099 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001100 If your ULPI phy needs a different reference clock than the
1101 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1102 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001103
wdenk7a428cc2003-06-15 22:40:42 +00001104- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001105 The MMC controller on the Intel PXA is supported. To
1106 enable this define CONFIG_MMC. The MMC can be
1107 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001108 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001109 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1110 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001111
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001112 CONFIG_SH_MMCIF
1113 Support for Renesas on-chip MMCIF controller
1114
1115 CONFIG_SH_MMCIF_ADDR
1116 Define the base address of MMCIF registers
1117
1118 CONFIG_SH_MMCIF_CLK
1119 Define the clock frequency for MMCIF
1120
Tom Rini58a8d322013-03-14 05:32:47 +00001121- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001122 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001123 This enables the USB portion of the DFU USB class
1124
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001125 CONFIG_DFU_NAND
1126 This enables support for exposing NAND devices via DFU.
1127
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301128 CONFIG_DFU_RAM
1129 This enables support for exposing RAM via DFU.
1130 Note: DFU spec refer to non-volatile memory usage, but
1131 allow usages beyond the scope of spec - here RAM usage,
1132 one that would help mostly the developer.
1133
Heiko Schochera2f831e2013-06-12 06:05:51 +02001134 CONFIG_SYS_DFU_DATA_BUF_SIZE
1135 Dfu transfer uses a buffer before writing data to the
1136 raw storage device. Make the size (in bytes) of this buffer
1137 configurable. The size of this buffer is also configurable
1138 through the "dfu_bufsiz" environment variable.
1139
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001140 CONFIG_SYS_DFU_MAX_FILE_SIZE
1141 When updating files rather than the raw storage device,
1142 we use a static buffer to copy the file into and then write
1143 the buffer once we've been given the whole file. Define
1144 this to the maximum filesize (in bytes) for the buffer.
1145 Default is 4 MiB if undefined.
1146
Heiko Schochere1ba1512014-03-18 08:09:56 +01001147 DFU_DEFAULT_POLL_TIMEOUT
1148 Poll timeout [ms], is the timeout a device can send to the
1149 host. The host must wait for this timeout before sending
1150 a subsequent DFU_GET_STATUS request to the device.
1151
1152 DFU_MANIFEST_POLL_TIMEOUT
1153 Poll timeout [ms], which the device sends to the host when
1154 entering dfuMANIFEST state. Host waits this timeout, before
1155 sending again an USB request to the device.
1156
wdenkda04a8b2004-08-02 23:22:59 +00001157- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001158 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001159 Define these for a default partition on a NAND device
1160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001161 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1162 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001163 Define these for a default partition on a NOR device
1164
wdenkc6097192002-11-03 00:24:07 +00001165- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001166 See Kconfig help for available keyboard drivers.
1167
1168 CONFIG_KEYBOARD
1169
1170 Define this to enable a custom keyboard support.
1171 This simply calls drv_keyboard_init() which must be
1172 defined in your board-specific files. This option is deprecated
1173 and is only used by novena. For new boards, use driver model
1174 instead.
wdenkc6097192002-11-03 00:24:07 +00001175
1176- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001177 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001178 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001179 SOCs that have a DIU should define this macro to enable DIU
1180 support, and should also define these other macros:
1181
1182 CONFIG_SYS_DIU_ADDR
1183 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001184 CONFIG_CFB_CONSOLE
1185 CONFIG_VIDEO_SW_CURSOR
1186 CONFIG_VGA_AS_SINGLE_DEVICE
1187 CONFIG_VIDEO_LOGO
1188 CONFIG_VIDEO_BMP_LOGO
1189
Timur Tabi32f709e2011-04-11 14:18:22 -05001190 The DIU driver will look for the 'video-mode' environment
1191 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001192 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001193 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001194
wdenkc6097192002-11-03 00:24:07 +00001195- LCD Support: CONFIG_LCD
1196
1197 Define this to enable LCD support (for output to LCD
1198 display); also select one of the supported displays
1199 by defining one of these:
1200
Stelian Popf6f86652008-05-09 21:57:18 +02001201 CONFIG_ATMEL_LCD:
1202
1203 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1204
wdenkc0d54ae2003-11-25 16:55:19 +00001205 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001206
wdenkc0d54ae2003-11-25 16:55:19 +00001207 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001208
wdenkc0d54ae2003-11-25 16:55:19 +00001209 CONFIG_NEC_NL6448BC20
1210
1211 NEC NL6448BC20-08. 6.5", 640x480.
1212 Active, color, single scan.
1213
1214 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001215
wdenkc0d54ae2003-11-25 16:55:19 +00001216 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001217 Active, color, single scan.
1218
1219 CONFIG_SHARP_16x9
1220
1221 Sharp 320x240. Active, color, single scan.
1222 It isn't 16x9, and I am not sure what it is.
1223
1224 CONFIG_SHARP_LQ64D341
1225
1226 Sharp LQ64D341 display, 640x480.
1227 Active, color, single scan.
1228
1229 CONFIG_HLD1045
1230
1231 HLD1045 display, 640x480.
1232 Active, color, single scan.
1233
1234 CONFIG_OPTREX_BW
1235
1236 Optrex CBL50840-2 NF-FW 99 22 M5
1237 or
1238 Hitachi LMG6912RPFC-00T
1239 or
1240 Hitachi SP14Q002
1241
1242 320x240. Black & white.
1243
Simon Glass599a4df2012-10-17 13:24:54 +00001244 CONFIG_LCD_ALIGNMENT
1245
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001246 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001247 defined then the LCD will be aligned to this value instead.
1248 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1249 here, since it is cheaper to change data cache settings on
1250 a per-section basis.
1251
1252
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001253 CONFIG_LCD_ROTATION
1254
1255 Sometimes, for example if the display is mounted in portrait
1256 mode or even if it's mounted landscape but rotated by 180degree,
1257 we need to rotate our content of the display relative to the
1258 framebuffer, so that user can read the messages which are
1259 printed out.
1260 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1261 initialized with a given rotation from "vl_rot" out of
1262 "vidinfo_t" which is provided by the board specific code.
1263 The value for vl_rot is coded as following (matching to
1264 fbcon=rotate:<n> linux-kernel commandline):
1265 0 = no rotation respectively 0 degree
1266 1 = 90 degree rotation
1267 2 = 180 degree rotation
1268 3 = 270 degree rotation
1269
1270 If CONFIG_LCD_ROTATION is not defined, the console will be
1271 initialized with 0degree rotation.
1272
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001273 CONFIG_LCD_BMP_RLE8
1274
1275 Support drawing of RLE8-compressed bitmaps on the LCD.
1276
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001277 CONFIG_I2C_EDID
1278
1279 Enables an 'i2c edid' command which can read EDID
1280 information over I2C from an attached LCD display.
1281
wdenkeb20ad32003-09-05 23:19:14 +00001282- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001283
wdenk57b2d802003-06-27 21:31:46 +00001284 If this option is set, the environment is checked for
1285 a variable "splashimage". If found, the usual display
1286 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001287 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001288 specified in "splashimage" is loaded instead. The
1289 console is redirected to the "nulldev", too. This
1290 allows for a "silent" boot where a splash screen is
1291 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001292
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001293 CONFIG_SPLASHIMAGE_GUARD
1294
1295 If this option is set, then U-Boot will prevent the environment
1296 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001297 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001298 This option is useful for targets where, due to alignment
1299 restrictions, an improperly aligned BMP image will cause a data
1300 abort. If you think you will not have problems with unaligned
1301 accesses (for example because your toolchain prevents them)
1302 there is no need to set this option.
1303
Matthias Weisser53884182009-07-09 16:07:30 +02001304 CONFIG_SPLASH_SCREEN_ALIGN
1305
1306 If this option is set the splash image can be freely positioned
1307 on the screen. Environment variable "splashpos" specifies the
1308 position as "x,y". If a positive number is given it is used as
1309 number of pixel from left/top. If a negative number is given it
1310 is used as number of pixel from right/bottom. You can also
1311 specify 'm' for centering the image.
1312
1313 Example:
1314 setenv splashpos m,m
1315 => image at center of screen
1316
1317 setenv splashpos 30,20
1318 => image at x = 30 and y = 20
1319
1320 setenv splashpos -10,m
1321 => vertically centered image
1322 at x = dspWidth - bmpWidth - 9
1323
Stefan Roesed9d97742005-09-22 09:04:17 +02001324- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1325
1326 If this option is set, additionally to standard BMP
1327 images, gzipped BMP images can be displayed via the
1328 splashscreen support or the bmp command.
1329
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001330- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1331
1332 If this option is set, 8-bit RLE compressed BMP images
1333 can be displayed via the splashscreen support or the
1334 bmp command.
1335
wdenk710e3502003-08-29 20:57:53 +00001336- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001337 CONFIG_GZIP
1338
1339 Enabled by default to support gzip compressed images.
1340
wdenk710e3502003-08-29 20:57:53 +00001341 CONFIG_BZIP2
1342
1343 If this option is set, support for bzip2 compressed
1344 images is included. If not, only uncompressed and gzip
1345 compressed images are supported.
1346
wdenk9c53f402003-10-15 23:53:47 +00001347 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001348 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001349 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001350
wdenk0e2bd9c2004-06-06 21:51:03 +00001351- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001352 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1353
1354 The clock frequency of the MII bus
1355
wdenk0e2bd9c2004-06-06 21:51:03 +00001356 CONFIG_PHY_RESET_DELAY
1357
1358 Some PHY like Intel LXT971A need extra delay after
1359 reset before any MII register access is possible.
1360 For such PHY, set this option to the usec delay
1361 required. (minimum 300usec for LXT971A)
1362
1363 CONFIG_PHY_CMD_DELAY (ppc4xx)
1364
1365 Some PHY like Intel LXT971A need extra delay after
1366 command issued before MII status register can be read
1367
wdenkc6097192002-11-03 00:24:07 +00001368- IP address:
1369 CONFIG_IPADDR
1370
1371 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001372 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001373 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001374 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001375
1376- Server IP address:
1377 CONFIG_SERVERIP
1378
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001379 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001380 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001381 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001382
Robin Getz470a6d42009-07-21 12:15:28 -04001383 CONFIG_KEEP_SERVERADDR
1384
1385 Keeps the server's MAC address, in the env 'serveraddr'
1386 for passing to bootargs (like Linux's netconsole option)
1387
Wolfgang Denk26da2992011-10-26 10:21:22 +00001388- Gateway IP address:
1389 CONFIG_GATEWAYIP
1390
1391 Defines a default value for the IP address of the
1392 default router where packets to other networks are
1393 sent to.
1394 (Environment variable "gatewayip")
1395
1396- Subnet mask:
1397 CONFIG_NETMASK
1398
1399 Defines a default value for the subnet mask (or
1400 routing prefix) which is used to determine if an IP
1401 address belongs to the local subnet or needs to be
1402 forwarded through a router.
1403 (Environment variable "netmask")
1404
wdenkc6097192002-11-03 00:24:07 +00001405- BOOTP Recovery Mode:
1406 CONFIG_BOOTP_RANDOM_DELAY
1407
1408 If you have many targets in a network that try to
1409 boot using BOOTP, you may want to avoid that all
1410 systems send out BOOTP requests at precisely the same
1411 moment (which would happen for instance at recovery
1412 from a power failure, when all systems will try to
1413 boot, thus flooding the BOOTP server. Defining
1414 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1415 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001416 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001417
1418 1st BOOTP request: delay 0 ... 1 sec
1419 2nd BOOTP request: delay 0 ... 2 sec
1420 3rd BOOTP request: delay 0 ... 4 sec
1421 4th and following
1422 BOOTP requests: delay 0 ... 8 sec
1423
Thierry Reding8977cda2014-08-19 10:21:24 +02001424 CONFIG_BOOTP_ID_CACHE_SIZE
1425
1426 BOOTP packets are uniquely identified using a 32-bit ID. The
1427 server will copy the ID from client requests to responses and
1428 U-Boot will use this to determine if it is the destination of
1429 an incoming response. Some servers will check that addresses
1430 aren't in use before handing them out (usually using an ARP
1431 ping) and therefore take up to a few hundred milliseconds to
1432 respond. Network congestion may also influence the time it
1433 takes for a response to make it back to the client. If that
1434 time is too long, U-Boot will retransmit requests. In order
1435 to allow earlier responses to still be accepted after these
1436 retransmissions, U-Boot's BOOTP client keeps a small cache of
1437 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1438 cache. The default is to keep IDs for up to four outstanding
1439 requests. Increasing this will allow U-Boot to accept offers
1440 from a BOOTP client in networks with unusually high latency.
1441
stroesee0aadfb2003-08-28 14:17:32 +00001442- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001443 You can fine tune the DHCP functionality by defining
1444 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001445
Jon Loeliger5336a762007-07-09 22:08:34 -05001446 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001447 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001448 CONFIG_BOOTP_SEND_HOSTNAME
1449 CONFIG_BOOTP_NTPSERVER
1450 CONFIG_BOOTP_TIMEOFFSET
1451 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001452 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001453
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001454 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1455 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001456
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001457 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1458 after the configured retry count, the call will fail
1459 instead of starting over. This can be used to fail over
1460 to Link-local IP address configuration if the DHCP server
1461 is not available.
1462
stroesee0aadfb2003-08-28 14:17:32 +00001463 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1464 to do a dynamic update of a DNS server. To do this, they
1465 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001466 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001467 of the "hostname" environment variable is passed as
1468 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001469
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001470 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1471
1472 A 32bit value in microseconds for a delay between
1473 receiving a "DHCP Offer" and sending the "DHCP Request".
1474 This fixes a problem with certain DHCP servers that don't
1475 respond 100% of the time to a "DHCP request". E.g. On an
1476 AT91RM9200 processor running at 180MHz, this delay needed
1477 to be *at least* 15,000 usec before a Windows Server 2003
1478 DHCP server would reply 100% of the time. I recommend at
1479 least 50,000 usec to be safe. The alternative is to hope
1480 that one of the retries will be successful but note that
1481 the DHCP timeout and retry process takes a longer than
1482 this delay.
1483
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001484 - Link-local IP address negotiation:
1485 Negotiate with other link-local clients on the local network
1486 for an address that doesn't require explicit configuration.
1487 This is especially useful if a DHCP server cannot be guaranteed
1488 to exist in all environments that the device must operate.
1489
1490 See doc/README.link-local for more information.
1491
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301492 - MAC address from environment variables
1493
1494 FDT_SEQ_MACADDR_FROM_ENV
1495
1496 Fix-up device tree with MAC addresses fetched sequentially from
1497 environment variables. This config work on assumption that
1498 non-usable ethernet node of device-tree are either not present
1499 or their status has been marked as "disabled".
1500
wdenk145d2c12004-04-15 21:48:45 +00001501 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001502 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001503
1504 The device id used in CDP trigger frames.
1505
1506 CONFIG_CDP_DEVICE_ID_PREFIX
1507
1508 A two character string which is prefixed to the MAC address
1509 of the device.
1510
1511 CONFIG_CDP_PORT_ID
1512
1513 A printf format string which contains the ascii name of
1514 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001515 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001516
1517 CONFIG_CDP_CAPABILITIES
1518
1519 A 32bit integer which indicates the device capabilities;
1520 0x00000010 for a normal host which does not forwards.
1521
1522 CONFIG_CDP_VERSION
1523
1524 An ascii string containing the version of the software.
1525
1526 CONFIG_CDP_PLATFORM
1527
1528 An ascii string containing the name of the platform.
1529
1530 CONFIG_CDP_TRIGGER
1531
1532 A 32bit integer sent on the trigger.
1533
1534 CONFIG_CDP_POWER_CONSUMPTION
1535
1536 A 16bit integer containing the power consumption of the
1537 device in .1 of milliwatts.
1538
1539 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1540
1541 A byte containing the id of the VLAN.
1542
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001543- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001544
1545 Several configurations allow to display the current
1546 status using a LED. For instance, the LED will blink
1547 fast while running U-Boot code, stop blinking as
1548 soon as a reply to a BOOTP request was received, and
1549 start blinking slow once the Linux kernel is running
1550 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001551 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001552 feature in U-Boot.
1553
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001554 Additional options:
1555
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001556 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001557 The status LED can be connected to a GPIO pin.
1558 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001559 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001560 to include the gpio_led driver in the U-Boot binary.
1561
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001562 CONFIG_GPIO_LED_INVERTED_TABLE
1563 Some GPIO connected LEDs may have inverted polarity in which
1564 case the GPIO high value corresponds to LED off state and
1565 GPIO low value corresponds to LED on state.
1566 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1567 with a list of GPIO LEDs that have inverted polarity.
1568
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001569- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001570
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001571 This enable the NEW i2c subsystem, and will allow you to use
1572 i2c commands at the u-boot command line (as long as you set
1573 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1574 based realtime clock chips or other i2c devices. See
1575 common/cmd_i2c.c for a description of the command line
1576 interface.
1577
1578 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001579 - drivers/i2c/soft_i2c.c:
1580 - activate first bus with CONFIG_SYS_I2C_SOFT define
1581 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1582 for defining speed and slave address
1583 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1584 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1585 for defining speed and slave address
1586 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1587 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1588 for defining speed and slave address
1589 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1590 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1591 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001592
Heiko Schocherf2850742012-10-24 13:48:22 +02001593 - drivers/i2c/fsl_i2c.c:
1594 - activate i2c driver with CONFIG_SYS_I2C_FSL
1595 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1596 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1597 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1598 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001599 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001600 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1601 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1602 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1603 second bus.
1604
Simon Glass026fefb2012-10-30 07:28:53 +00001605 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001606 - activate this driver with CONFIG_SYS_I2C_TEGRA
1607 - This driver adds 4 i2c buses with a fix speed from
1608 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001609
Dirk Eibach42b204f2013-04-25 02:40:01 +00001610 - drivers/i2c/ppc4xx_i2c.c
1611 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1612 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1613 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1614
trema49f40a2013-09-21 18:13:35 +02001615 - drivers/i2c/i2c_mxc.c
1616 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001617 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1618 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1619 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1620 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001621 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1622 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1623 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1624 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1625 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1626 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001627 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1628 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001629 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001630 for speed, and 0 for slave.
1631
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001632 - drivers/i2c/rcar_i2c.c:
1633 - activate this driver with CONFIG_SYS_I2C_RCAR
1634 - This driver adds 4 i2c buses
1635
1636 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1637 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1638 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1639 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1640 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1641 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1642 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1643 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1644 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1645
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001646 - drivers/i2c/sh_i2c.c:
1647 - activate this driver with CONFIG_SYS_I2C_SH
1648 - This driver adds from 2 to 5 i2c buses
1649
1650 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1651 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1652 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1653 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1654 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1655 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1656 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1657 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1658 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1659 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001660 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001661
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001662 - drivers/i2c/omap24xx_i2c.c
1663 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1664 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1665 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1666 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1667 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1668 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1669 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1670 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1671 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1672 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1673 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1674
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301675 - drivers/i2c/s3c24x0_i2c.c:
1676 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1677 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1678 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1679 with a fix speed from 100000 and the slave addr 0!
1680
Dirk Eibachb9577432014-07-03 09:28:18 +02001681 - drivers/i2c/ihs_i2c.c
1682 - activate this driver with CONFIG_SYS_I2C_IHS
1683 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1684 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1685 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1686 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1687 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1688 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1689 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1690 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1691 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1692 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1693 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1694 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001695 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1696 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1697 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1698 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1699 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1700 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1701 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1702 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1703 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001704
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001705 additional defines:
1706
1707 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001708 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001709
1710 CONFIG_SYS_I2C_DIRECT_BUS
1711 define this, if you don't use i2c muxes on your hardware.
1712 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1713 omit this define.
1714
1715 CONFIG_SYS_I2C_MAX_HOPS
1716 define how many muxes are maximal consecutively connected
1717 on one i2c bus. If you not use i2c muxes, omit this
1718 define.
1719
1720 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001721 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001722 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1723 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1724 CONFIG_SYS_NUM_I2C_BUSES = 9:
1725
1726 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1727 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1728 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1729 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1730 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1731 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1732 {1, {I2C_NULL_HOP}}, \
1733 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1734 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1735 }
1736
1737 which defines
1738 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001739 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1740 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1741 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1742 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1743 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001744 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001745 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1746 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001747
1748 If you do not have i2c muxes on your board, omit this define.
1749
Simon Glass3efce392017-05-12 21:10:00 -06001750- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001751 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001752 then the following macros need to be defined (examples are
1753 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001754
1755 I2C_INIT
1756
wdenkb9bbd242003-06-30 16:24:52 +00001757 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001758 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001759
wdenk544e9732004-02-06 23:19:44 +00001760 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001761
wdenkc6097192002-11-03 00:24:07 +00001762 I2C_ACTIVE
1763
1764 The code necessary to make the I2C data line active
1765 (driven). If the data line is open collector, this
1766 define can be null.
1767
wdenkb9bbd242003-06-30 16:24:52 +00001768 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1769
wdenkc6097192002-11-03 00:24:07 +00001770 I2C_TRISTATE
1771
1772 The code necessary to make the I2C data line tri-stated
1773 (inactive). If the data line is open collector, this
1774 define can be null.
1775
wdenkb9bbd242003-06-30 16:24:52 +00001776 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1777
wdenkc6097192002-11-03 00:24:07 +00001778 I2C_READ
1779
York Sun4a598092013-04-01 11:29:11 -07001780 Code that returns true if the I2C data line is high,
1781 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001782
wdenkb9bbd242003-06-30 16:24:52 +00001783 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1784
wdenkc6097192002-11-03 00:24:07 +00001785 I2C_SDA(bit)
1786
York Sun4a598092013-04-01 11:29:11 -07001787 If <bit> is true, sets the I2C data line high. If it
1788 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001789
wdenkb9bbd242003-06-30 16:24:52 +00001790 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001791 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001792 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001793
wdenkc6097192002-11-03 00:24:07 +00001794 I2C_SCL(bit)
1795
York Sun4a598092013-04-01 11:29:11 -07001796 If <bit> is true, sets the I2C clock line high. If it
1797 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001798
wdenkb9bbd242003-06-30 16:24:52 +00001799 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001800 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001801 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001802
wdenkc6097192002-11-03 00:24:07 +00001803 I2C_DELAY
1804
1805 This delay is invoked four times per clock cycle so this
1806 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001807 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001808 like:
1809
wdenkb9bbd242003-06-30 16:24:52 +00001810 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001811
Mike Frysingeree12d542010-07-21 13:38:02 -04001812 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1813
1814 If your arch supports the generic GPIO framework (asm/gpio.h),
1815 then you may alternatively define the two GPIOs that are to be
1816 used as SCL / SDA. Any of the previous I2C_xxx macros will
1817 have GPIO-based defaults assigned to them as appropriate.
1818
1819 You should define these to the GPIO value as given directly to
1820 the generic GPIO functions.
1821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001822 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001823
wdenk57b2d802003-06-27 21:31:46 +00001824 When a board is reset during an i2c bus transfer
1825 chips might think that the current transfer is still
1826 in progress. On some boards it is possible to access
1827 the i2c SCLK line directly, either by using the
1828 processor pin as a GPIO or by having a second pin
1829 connected to the bus. If this option is defined a
1830 custom i2c_init_board() routine in boards/xxx/board.c
1831 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001832
Ben Warren45657152006-09-07 16:50:54 -04001833 CONFIG_I2C_MULTI_BUS
1834
1835 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001836 must have a controller. At any point in time, only one bus is
1837 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001838 Note that bus numbering is zero-based.
1839
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001840 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001841
1842 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001843 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001844 is set, specify a list of bus-device pairs. Otherwise, specify
1845 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001846
1847 e.g.
1848 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001849 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001850
1851 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1852
Wolfgang Denk092ae952011-10-26 10:21:21 +00001853 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001854 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001855
1856 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1857
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001858 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001859
1860 If defined, then this indicates the I2C bus number for DDR SPD.
1861 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1862
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001863 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001864
1865 If defined, then this indicates the I2C bus number for the RTC.
1866 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1867
Andrew Dyer58c41f92008-12-29 17:36:01 -06001868 CONFIG_SOFT_I2C_READ_REPEATED_START
1869
1870 defining this will force the i2c_read() function in
1871 the soft_i2c driver to perform an I2C repeated start
1872 between writing the address pointer and reading the
1873 data. If this define is omitted the default behaviour
1874 of doing a stop-start sequence will be used. Most I2C
1875 devices can use either method, but some require one or
1876 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001877
wdenkc6097192002-11-03 00:24:07 +00001878- SPI Support: CONFIG_SPI
1879
1880 Enables SPI driver (so far only tested with
1881 SPI EEPROM, also an instance works with Crystal A/D and
1882 D/As on the SACSng board)
1883
wdenkc6097192002-11-03 00:24:07 +00001884 CONFIG_SOFT_SPI
1885
wdenk4a5c8a72003-03-06 00:02:04 +00001886 Enables a software (bit-bang) SPI driver rather than
1887 using hardware support. This is a general purpose
1888 driver that only requires three general I/O port pins
1889 (two outputs, one input) to function. If this is
1890 defined, the board configuration must define several
1891 SPI configuration items (port pins to use, etc). For
1892 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001893
Heiko Schocherb77c8882014-07-14 10:22:11 +02001894 CONFIG_SYS_SPI_MXC_WAIT
1895 Timeout for waiting until spi transfer completed.
1896 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1897
Matthias Fuchsa4400872007-12-27 17:12:34 +01001898- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001899
Matthias Fuchsa4400872007-12-27 17:12:34 +01001900 Enables FPGA subsystem.
1901
1902 CONFIG_FPGA_<vendor>
1903
1904 Enables support for specific chip vendors.
1905 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001906
Matthias Fuchsa4400872007-12-27 17:12:34 +01001907 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001908
Matthias Fuchsa4400872007-12-27 17:12:34 +01001909 Enables support for FPGA family.
1910 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1911
1912 CONFIG_FPGA_COUNT
1913
1914 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001916 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001917
wdenk57b2d802003-06-27 21:31:46 +00001918 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001920 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001921
wdenk4a5c8a72003-03-06 00:02:04 +00001922 Enable checks on FPGA configuration interface busy
1923 status by the configuration function. This option
1924 will require a board or device specific function to
1925 be written.
wdenkc6097192002-11-03 00:24:07 +00001926
1927 CONFIG_FPGA_DELAY
1928
1929 If defined, a function that provides delays in the FPGA
1930 configuration driver.
1931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001932 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001933 Allow Control-C to interrupt FPGA configuration
1934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001935 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001936
wdenk4a5c8a72003-03-06 00:02:04 +00001937 Check for configuration errors during FPGA bitfile
1938 loading. For example, abort during Virtex II
1939 configuration if the INIT_B line goes low (which
1940 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001941
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001942 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001943
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001944 Maximum time to wait for the INIT_B line to de-assert
1945 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001946 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001947 ms.
wdenkc6097192002-11-03 00:24:07 +00001948
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001949 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001950
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001951 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001952 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001954 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001955
wdenk4a5c8a72003-03-06 00:02:04 +00001956 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001957 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001958
1959- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02001960
wdenkc6097192002-11-03 00:24:07 +00001961 CONFIG_IDENT_STRING
1962
wdenk4a5c8a72003-03-06 00:02:04 +00001963 If defined, this string will be added to the U-Boot
1964 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001965
1966- Vendor Parameter Protection:
1967
wdenk4a5c8a72003-03-06 00:02:04 +00001968 U-Boot considers the values of the environment
1969 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001970 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001971 are set once by the board vendor / manufacturer, and
1972 protects these variables from casual modification by
1973 the user. Once set, these variables are read-only,
1974 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001975 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001976
1977 If CONFIG_ENV_OVERWRITE is #defined in your config
1978 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001979 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001980 these parameters.
1981
Joe Hershberger76f353e2015-05-04 14:55:14 -05001982 Alternatively, if you define _both_ an ethaddr in the
1983 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001984 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001985 which can be changed exactly ONCE by the user. [The
1986 serial# is unaffected by this, i. e. it remains
1987 read-only.]
1988
Joe Hershberger71497d02012-12-11 22:16:31 -06001989 The same can be accomplished in a more flexible way
1990 for any variable by configuring the type of access
1991 to allow for those variables in the ".flags" variable
1992 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1993
wdenkc6097192002-11-03 00:24:07 +00001994- Protected RAM:
1995 CONFIG_PRAM
1996
1997 Define this variable to enable the reservation of
1998 "protected RAM", i. e. RAM which is not overwritten
1999 by U-Boot. Define CONFIG_PRAM to hold the number of
2000 kB you want to reserve for pRAM. You can overwrite
2001 this default value by defining an environment
2002 variable "pram" to the number of kB you want to
2003 reserve. Note that the board info structure will
2004 still show the full amount of RAM. If pRAM is
2005 reserved, a new environment variable "mem" will
2006 automatically be defined to hold the amount of
2007 remaining RAM in a form that can be passed as boot
2008 argument to Linux, for instance like that:
2009
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002010 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002011 saveenv
2012
2013 This way you can tell Linux not to use this memory,
2014 either, which results in a memory region that will
2015 not be affected by reboots.
2016
2017 *WARNING* If your board configuration uses automatic
2018 detection of the RAM size, you must make sure that
2019 this memory test is non-destructive. So far, the
2020 following board configurations are known to be
2021 "pRAM-clean":
2022
Heiko Schocher65d94db2017-06-07 17:33:09 +02002023 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002024 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002025 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002026
Gabe Blacka2f3a932012-12-02 04:55:18 +00002027- Access to physical memory region (> 4GB)
2028 Some basic support is provided for operations on memory not
2029 normally accessible to U-Boot - e.g. some architectures
2030 support access to more than 4GB of memory on 32-bit
2031 machines using physical address extension or similar.
2032 Define CONFIG_PHYSMEM to access this basic support, which
2033 currently only supports clearing the memory.
2034
wdenkc6097192002-11-03 00:24:07 +00002035- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002036 CONFIG_NET_RETRY_COUNT
2037
wdenk4a5c8a72003-03-06 00:02:04 +00002038 This variable defines the number of retries for
2039 network operations like ARP, RARP, TFTP, or BOOTP
2040 before giving up the operation. If not defined, a
2041 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002042
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002043 CONFIG_ARP_TIMEOUT
2044
2045 Timeout waiting for an ARP reply in milliseconds.
2046
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002047 CONFIG_NFS_TIMEOUT
2048
2049 Timeout in milliseconds used in NFS protocol.
2050 If you encounter "ERROR: Cannot umount" in nfs command,
2051 try longer timeout such as
2052 #define CONFIG_NFS_TIMEOUT 10000UL
2053
wdenkc6097192002-11-03 00:24:07 +00002054- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002055 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002056
2057 This defines the secondary prompt string, which is
2058 printed when the command interpreter needs more input
2059 to complete a command. Usually "> ".
2060
2061 Note:
2062
wdenk57b2d802003-06-27 21:31:46 +00002063 In the current implementation, the local variables
2064 space and global environment variables space are
2065 separated. Local variables are those you define by
2066 simply typing `name=value'. To access a local
2067 variable later on, you have write `$name' or
2068 `${name}'; to execute the contents of a variable
2069 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002070
wdenk4a5c8a72003-03-06 00:02:04 +00002071 Global environment variables are those you use
2072 setenv/printenv to work with. To run a command stored
2073 in such a variable, you need to use the run command,
2074 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002075
2076 To store commands and special characters in a
2077 variable, please use double quotation marks
2078 surrounding the whole text of the variable, instead
2079 of the backslashes before semicolons and special
2080 symbols.
2081
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002082- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01002083 CONFIG_CMDLINE_PS_SUPPORT
2084
2085 Enable support for changing the command prompt string
2086 at run-time. Only static string is supported so far.
2087 The string is obtained from environment variables PS1
2088 and PS2.
2089
wdenkc0aa5c52003-12-06 19:49:23 +00002090- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002091 CONFIG_EXTRA_ENV_SETTINGS
2092
wdenk4a5c8a72003-03-06 00:02:04 +00002093 Define this to contain any number of null terminated
2094 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002095 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002096
wdenk4a5c8a72003-03-06 00:02:04 +00002097 For example, place something like this in your
2098 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002099
2100 #define CONFIG_EXTRA_ENV_SETTINGS \
2101 "myvar1=value1\0" \
2102 "myvar2=value2\0"
2103
wdenk4a5c8a72003-03-06 00:02:04 +00002104 Warning: This method is based on knowledge about the
2105 internal format how the environment is stored by the
2106 U-Boot code. This is NOT an official, exported
2107 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002108 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002109 You better know what you are doing here.
2110
wdenk4a5c8a72003-03-06 00:02:04 +00002111 Note: overly (ab)use of the default environment is
2112 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002113 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002114 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002115
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002116 CONFIG_DELAY_ENVIRONMENT
2117
2118 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002119 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002120 that so that the environment is not available until
2121 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2122 this is instead controlled by the value of
2123 /config/load-environment.
2124
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002125- TFTP Fixed UDP Port:
2126 CONFIG_TFTP_PORT
2127
Wolfgang Denk227b5192005-09-24 23:25:46 +02002128 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002129 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002130 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002131 number generator is used.
2132
Wolfgang Denk227b5192005-09-24 23:25:46 +02002133 Also, the environment variable tftpdstp is used to supply
2134 the TFTP UDP destination port value. If tftpdstp isn't
2135 defined, the normal port 69 is used.
2136
2137 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002138 blindly start the TFTP transfer using the pre-configured
2139 target IP address and UDP port. This has the effect of
2140 "punching through" the (Windows XP) firewall, allowing
2141 the remainder of the TFTP transfer to proceed normally.
2142 A better solution is to properly configure the firewall,
2143 but sometimes that is not allowed.
2144
wdenkc0aa5c52003-12-06 19:49:23 +00002145- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002146 CONFIG_SHOW_BOOT_PROGRESS
2147
wdenk4a5c8a72003-03-06 00:02:04 +00002148 Defining this option allows to add some board-
2149 specific code (calling a user-provided function
2150 "show_boot_progress(int)") that enables you to show
2151 the system's boot progress on some display (for
2152 example, some LED's) on your board. At the moment,
2153 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002154
Simon Glass0fa36a42012-09-28 08:56:37 +00002155
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002156Legacy uImage format:
2157
wdenkc6097192002-11-03 00:24:07 +00002158 Arg Where When
2159 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002160 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002161 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002162 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002163 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002164 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002165 4 common/cmd_bootm.c Image data has correct checksum
2166 -4 common/cmd_bootm.c Image is for unsupported architecture
2167 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002168 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002169 6 common/cmd_bootm.c Image Type check OK
2170 -6 common/cmd_bootm.c gunzip uncompression error
2171 -7 common/cmd_bootm.c Unimplemented compression type
2172 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002173 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002174 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002175
2176 9 common/image.c Start initial ramdisk verification
2177 -10 common/image.c Ramdisk header has bad magic number
2178 -11 common/image.c Ramdisk header has bad checksum
2179 10 common/image.c Ramdisk header is OK
2180 -12 common/image.c Ramdisk data has bad checksum
2181 11 common/image.c Ramdisk data has correct checksum
2182 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002183 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002184 13 common/image.c Start multifile image verification
2185 14 common/image.c No initial ramdisk, no multifile, continue.
2186
Wolfgang Denk092ae952011-10-26 10:21:21 +00002187 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002188
Stefan Roese88fbf932010-04-15 16:07:28 +02002189 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002190 -31 post/post.c POST test failed, detected by post_output_backlog()
2191 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002192
Heiko Schocher633e03a2007-06-22 19:11:54 +02002193 34 common/cmd_doc.c before loading a Image from a DOC device
2194 -35 common/cmd_doc.c Bad usage of "doc" command
2195 35 common/cmd_doc.c correct usage of "doc" command
2196 -36 common/cmd_doc.c No boot device
2197 36 common/cmd_doc.c correct boot device
2198 -37 common/cmd_doc.c Unknown Chip ID on boot device
2199 37 common/cmd_doc.c correct chip ID found, device available
2200 -38 common/cmd_doc.c Read Error on boot device
2201 38 common/cmd_doc.c reading Image header from DOC device OK
2202 -39 common/cmd_doc.c Image header has bad magic number
2203 39 common/cmd_doc.c Image header has correct magic number
2204 -40 common/cmd_doc.c Error reading Image from DOC device
2205 40 common/cmd_doc.c Image header has correct magic number
2206 41 common/cmd_ide.c before loading a Image from a IDE device
2207 -42 common/cmd_ide.c Bad usage of "ide" command
2208 42 common/cmd_ide.c correct usage of "ide" command
2209 -43 common/cmd_ide.c No boot device
2210 43 common/cmd_ide.c boot device found
2211 -44 common/cmd_ide.c Device not available
2212 44 common/cmd_ide.c Device available
2213 -45 common/cmd_ide.c wrong partition selected
2214 45 common/cmd_ide.c partition selected
2215 -46 common/cmd_ide.c Unknown partition table
2216 46 common/cmd_ide.c valid partition table found
2217 -47 common/cmd_ide.c Invalid partition type
2218 47 common/cmd_ide.c correct partition type
2219 -48 common/cmd_ide.c Error reading Image Header on boot device
2220 48 common/cmd_ide.c reading Image Header from IDE device OK
2221 -49 common/cmd_ide.c Image header has bad magic number
2222 49 common/cmd_ide.c Image header has correct magic number
2223 -50 common/cmd_ide.c Image header has bad checksum
2224 50 common/cmd_ide.c Image header has correct checksum
2225 -51 common/cmd_ide.c Error reading Image from IDE device
2226 51 common/cmd_ide.c reading Image from IDE device OK
2227 52 common/cmd_nand.c before loading a Image from a NAND device
2228 -53 common/cmd_nand.c Bad usage of "nand" command
2229 53 common/cmd_nand.c correct usage of "nand" command
2230 -54 common/cmd_nand.c No boot device
2231 54 common/cmd_nand.c boot device found
2232 -55 common/cmd_nand.c Unknown Chip ID on boot device
2233 55 common/cmd_nand.c correct chip ID found, device available
2234 -56 common/cmd_nand.c Error reading Image Header on boot device
2235 56 common/cmd_nand.c reading Image Header from NAND device OK
2236 -57 common/cmd_nand.c Image header has bad magic number
2237 57 common/cmd_nand.c Image header has correct magic number
2238 -58 common/cmd_nand.c Error reading Image from NAND device
2239 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002240
Heiko Schocher633e03a2007-06-22 19:11:54 +02002241 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002242
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002243 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002244 -64 net/eth.c no Ethernet found.
2245 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002246
Heiko Schocher633e03a2007-06-22 19:11:54 +02002247 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002248 80 common/cmd_net.c before calling net_loop()
2249 -81 common/cmd_net.c some error in net_loop() occurred
2250 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002251 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2252 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002253 83 common/cmd_net.c running "source" command
2254 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002255 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002256
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002257FIT uImage format:
2258
2259 Arg Where When
2260 100 common/cmd_bootm.c Kernel FIT Image has correct format
2261 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2262 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2263 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2264 102 common/cmd_bootm.c Kernel unit name specified
2265 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002266 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002267 104 common/cmd_bootm.c Got kernel subimage node offset
2268 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2269 105 common/cmd_bootm.c Kernel subimage hash verification OK
2270 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2271 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002272 -106 common/cmd_bootm.c Kernel subimage has wrong type
2273 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002274 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2275 108 common/cmd_bootm.c Got kernel subimage data/size
2276 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2277 -109 common/cmd_bootm.c Can't get kernel subimage type
2278 -110 common/cmd_bootm.c Can't get kernel subimage comp
2279 -111 common/cmd_bootm.c Can't get kernel subimage os
2280 -112 common/cmd_bootm.c Can't get kernel subimage load address
2281 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2282
2283 120 common/image.c Start initial ramdisk verification
2284 -120 common/image.c Ramdisk FIT image has incorrect format
2285 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002287 -122 common/image.c Can't get configuration for ramdisk subimage
2288 123 common/image.c Ramdisk unit name specified
2289 -124 common/image.c Can't get ramdisk subimage node offset
2290 125 common/image.c Got ramdisk subimage node offset
2291 -125 common/image.c Ramdisk subimage hash verification failed
2292 126 common/image.c Ramdisk subimage hash verification OK
2293 -126 common/image.c Ramdisk subimage for unsupported architecture
2294 127 common/image.c Architecture check OK
2295 -127 common/image.c Can't get ramdisk subimage data/size
2296 128 common/image.c Got ramdisk subimage data/size
2297 129 common/image.c Can't get ramdisk load address
2298 -129 common/image.c Got ramdisk load address
2299
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002300 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002301 131 common/cmd_doc.c FIT image format OK
2302
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002303 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002304 141 common/cmd_ide.c FIT image format OK
2305
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002306 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002307 151 common/cmd_nand.c FIT image format OK
2308
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002309- Standalone program support:
2310 CONFIG_STANDALONE_LOAD_ADDR
2311
Wolfgang Denk23f78482011-10-09 21:06:34 +02002312 This option defines a board specific value for the
2313 address where standalone program gets loaded, thus
2314 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002315 settings.
2316
2317- Frame Buffer Address:
2318 CONFIG_FB_ADDR
2319
2320 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002321 address for frame buffer. This is typically the case
2322 when using a graphics controller has separate video
2323 memory. U-Boot will then place the frame buffer at
2324 the given address instead of dynamically reserving it
2325 in system RAM by calling lcd_setmem(), which grabs
2326 the memory for the frame buffer depending on the
2327 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002328
2329 Please see board_init_f function.
2330
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002331- Automatic software updates via TFTP server
2332 CONFIG_UPDATE_TFTP
2333 CONFIG_UPDATE_TFTP_CNT_MAX
2334 CONFIG_UPDATE_TFTP_MSEC_MAX
2335
2336 These options enable and control the auto-update feature;
2337 for a more detailed description refer to doc/README.update.
2338
2339- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02002340 CONFIG_MTD_UBI_WL_THRESHOLD
2341 This parameter defines the maximum difference between the highest
2342 erase counter value and the lowest erase counter value of eraseblocks
2343 of UBI devices. When this threshold is exceeded, UBI starts performing
2344 wear leveling by means of moving data from eraseblock with low erase
2345 counter to eraseblocks with high erase counter.
2346
2347 The default value should be OK for SLC NAND flashes, NOR flashes and
2348 other flashes which have eraseblock life-cycle 100000 or more.
2349 However, in case of MLC NAND flashes which typically have eraseblock
2350 life-cycle less than 10000, the threshold should be lessened (e.g.,
2351 to 128 or 256, although it does not have to be power of 2).
2352
2353 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002354
Heiko Schocherf5895d12014-06-24 10:10:04 +02002355 CONFIG_MTD_UBI_BEB_LIMIT
2356 This option specifies the maximum bad physical eraseblocks UBI
2357 expects on the MTD device (per 1024 eraseblocks). If the
2358 underlying flash does not admit of bad eraseblocks (e.g. NOR
2359 flash), this value is ignored.
2360
2361 NAND datasheets often specify the minimum and maximum NVM
2362 (Number of Valid Blocks) for the flashes' endurance lifetime.
2363 The maximum expected bad eraseblocks per 1024 eraseblocks
2364 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2365 which gives 20 for most NANDs (MaxNVB is basically the total
2366 count of eraseblocks on the chip).
2367
2368 To put it differently, if this value is 20, UBI will try to
2369 reserve about 1.9% of physical eraseblocks for bad blocks
2370 handling. And that will be 1.9% of eraseblocks on the entire
2371 NAND chip, not just the MTD partition UBI attaches. This means
2372 that if you have, say, a NAND flash chip admits maximum 40 bad
2373 eraseblocks, and it is split on two MTD partitions of the same
2374 size, UBI will reserve 40 eraseblocks when attaching a
2375 partition.
2376
2377 default: 20
2378
2379 CONFIG_MTD_UBI_FASTMAP
2380 Fastmap is a mechanism which allows attaching an UBI device
2381 in nearly constant time. Instead of scanning the whole MTD device it
2382 only has to locate a checkpoint (called fastmap) on the device.
2383 The on-flash fastmap contains all information needed to attach
2384 the device. Using fastmap makes only sense on large devices where
2385 attaching by scanning takes long. UBI will not automatically install
2386 a fastmap on old images, but you can set the UBI parameter
2387 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2388 that fastmap-enabled images are still usable with UBI implementations
2389 without fastmap support. On typical flash devices the whole fastmap
2390 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2391
2392 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2393 Set this parameter to enable fastmap automatically on images
2394 without a fastmap.
2395 default: 0
2396
Heiko Schocher94b66de2015-10-22 06:19:21 +02002397 CONFIG_MTD_UBI_FM_DEBUG
2398 Enable UBI fastmap debug
2399 default: 0
2400
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002401- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002402 CONFIG_SPL
2403 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002404
Tom Rini36853852012-02-14 07:29:40 +00002405 CONFIG_SPL_LDSCRIPT
2406 LDSCRIPT for linking the SPL binary.
2407
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002408 CONFIG_SPL_MAX_FOOTPRINT
2409 Maximum size in memory allocated to the SPL, BSS included.
2410 When defined, the linker checks that the actual memory
2411 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002412 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002413 must not be both defined at the same time.
2414
Tom Rini36853852012-02-14 07:29:40 +00002415 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002416 Maximum size of the SPL image (text, data, rodata, and
2417 linker lists sections), BSS excluded.
2418 When defined, the linker checks that the actual size does
2419 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002420
Scott Woodc4f0d002012-09-20 19:05:12 -05002421 CONFIG_SPL_RELOC_TEXT_BASE
2422 Address to relocate to. If unspecified, this is equal to
2423 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2424
Tom Rini36853852012-02-14 07:29:40 +00002425 CONFIG_SPL_BSS_START_ADDR
2426 Link address for the BSS within the SPL binary.
2427
2428 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002429 Maximum size in memory allocated to the SPL BSS.
2430 When defined, the linker checks that the actual memory used
2431 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002432 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002433 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002434
2435 CONFIG_SPL_STACK
2436 Adress of the start of the stack SPL will use
2437
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002438 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2439 When defined, SPL will panic() if the image it has
2440 loaded does not have a signature.
2441 Defining this is useful when code which loads images
2442 in SPL cannot guarantee that absolutely all read errors
2443 will be caught.
2444 An example is the LPC32XX MLC NAND driver, which will
2445 consider that a completely unreadable NAND block is bad,
2446 and thus should be skipped silently.
2447
Scott Woodc4f0d002012-09-20 19:05:12 -05002448 CONFIG_SPL_RELOC_STACK
2449 Adress of the start of the stack SPL will use after
2450 relocation. If unspecified, this is equal to
2451 CONFIG_SPL_STACK.
2452
Tom Rini36853852012-02-14 07:29:40 +00002453 CONFIG_SYS_SPL_MALLOC_START
2454 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002455 When this option is set the full malloc is used in SPL and
2456 it is set up by spl_init() and before that, the simple malloc()
2457 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002458
2459 CONFIG_SYS_SPL_MALLOC_SIZE
2460 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002461
Tom Rinic2b76002014-03-28 12:03:39 -04002462 CONFIG_SPL_OS_BOOT
2463 Enable booting directly to an OS from SPL.
2464 See also: doc/README.falcon
2465
Tom Rinife3b0c72012-08-13 11:37:56 -07002466 CONFIG_SPL_DISPLAY_PRINT
2467 For ARM, enable an optional function to print more information
2468 about the running system.
2469
Scott Wood7c810902012-09-20 16:35:21 -05002470 CONFIG_SPL_INIT_MINIMAL
2471 Arch init code should be built for a very small image
2472
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002473 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2474 Partition on the MMC to load U-Boot from when the MMC is being
2475 used in raw mode
2476
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002477 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2478 Sector to load kernel uImage from when MMC is being
2479 used in raw mode (for Falcon mode)
2480
2481 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2482 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2483 Sector and number of sectors to load kernel argument
2484 parameters from when MMC is being used in raw mode
2485 (for falcon mode)
2486
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002487 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2488 Partition on the MMC to load U-Boot from when the MMC is being
2489 used in fs mode
2490
Guillaume GARDET5065b712014-10-15 17:53:13 +02002491 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2492 Filename to read to load U-Boot when reading from filesystem
2493
2494 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002495 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002496 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002497
Guillaume GARDET5065b712014-10-15 17:53:13 +02002498 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002499 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002500 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002501
Scott Wood2b36fbb2012-12-06 13:33:17 +00002502 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2503 Set this for NAND SPL on PPC mpc83xx targets, so that
2504 start.S waits for the rest of the SPL to load before
2505 continuing (the hardware starts execution after just
2506 loading the first page rather than the full 4K).
2507
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302508 CONFIG_SPL_SKIP_RELOCATE
2509 Avoid SPL relocation
2510
Scott Woodc352a0c2012-09-20 19:09:07 -05002511 CONFIG_SPL_NAND_BASE
2512 Include nand_base.c in the SPL. Requires
2513 CONFIG_SPL_NAND_DRIVERS.
2514
2515 CONFIG_SPL_NAND_DRIVERS
2516 SPL uses normal NAND drivers, not minimal drivers.
2517
Jörg Krause6f8190f2018-01-14 19:26:38 +01002518 CONFIG_SPL_NAND_IDENT
2519 SPL uses the chip ID list to identify the NAND flash.
2520 Requires CONFIG_SPL_NAND_BASE.
2521
Scott Woodc352a0c2012-09-20 19:09:07 -05002522 CONFIG_SPL_NAND_ECC
2523 Include standard software ECC in the SPL
2524
Tom Rini36853852012-02-14 07:29:40 +00002525 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002526 Support for NAND boot using simple NAND drivers that
2527 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002528
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002529 CONFIG_SPL_UBI
2530 Support for a lightweight UBI (fastmap) scanner and
2531 loader
2532
Heiko Schochercf000272014-10-31 08:31:00 +01002533 CONFIG_SPL_NAND_RAW_ONLY
2534 Support to boot only raw u-boot.bin images. Use this only
2535 if you need to save space.
2536
Ying Zhangdfb2b152013-08-16 15:16:12 +08002537 CONFIG_SPL_COMMON_INIT_DDR
2538 Set for common ddr init with serial presence detect in
2539 SPL binary.
2540
Tom Rini36853852012-02-14 07:29:40 +00002541 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2542 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2543 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2544 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2545 CONFIG_SYS_NAND_ECCBYTES
2546 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002547 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002548
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302549 CONFIG_SPL_NAND_BOOT
2550 Add support NAND boot
2551
Tom Rini36853852012-02-14 07:29:40 +00002552 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002553 Location in NAND to read U-Boot from
2554
2555 CONFIG_SYS_NAND_U_BOOT_DST
2556 Location in memory to load U-Boot to
2557
2558 CONFIG_SYS_NAND_U_BOOT_SIZE
2559 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002560
2561 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002562 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002563
2564 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2565 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002566 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002567
Pavel Machekde997252012-08-30 22:42:11 +02002568 CONFIG_SPL_RAM_DEVICE
2569 Support for running image already present in ram, in SPL binary
2570
Scott Woodeb7bd972012-12-06 13:33:16 +00002571 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002572 Image offset to which the SPL should be padded before appending
2573 the SPL payload. By default, this is defined as
2574 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2575 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2576 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002577
Scott Woodf147eb72012-09-21 16:27:32 -05002578 CONFIG_SPL_TARGET
2579 Final target image containing SPL and payload. Some SPLs
2580 use an arch-specific makefile fragment instead, for
2581 example if more than one image needs to be produced.
2582
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002583 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002584 Printing information about a FIT image adds quite a bit of
2585 code to SPL. So this is normally disabled in SPL. Use this
2586 option to re-enable it. This will affect the output of the
2587 bootm command when booting a FIT image.
2588
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002589- TPL framework
2590 CONFIG_TPL
2591 Enable building of TPL globally.
2592
2593 CONFIG_TPL_PAD_TO
2594 Image offset to which the TPL should be padded before appending
2595 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002596 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2597 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2598 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002599
wdenkc0aa5c52003-12-06 19:49:23 +00002600- Interrupt support (PPC):
2601
wdenk1ebf41e2004-01-02 14:00:00 +00002602 There are common interrupt_init() and timer_interrupt()
2603 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002604 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002605 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002606 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002607 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002608 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002609 specific handling. If board has watchdog / status_led
2610 / other_activity_monitor it works automatically from
2611 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002612
wdenkc6097192002-11-03 00:24:07 +00002613
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002614Board initialization settings:
2615------------------------------
2616
2617During Initialization u-boot calls a number of board specific functions
2618to allow the preparation of board specific prerequisites, e.g. pin setup
2619before drivers are initialized. To enable these callbacks the
2620following configuration macros have to be defined. Currently this is
2621architecture specific, so please check arch/your_architecture/lib/board.c
2622typically in board_init_f() and board_init_r().
2623
2624- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2625- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2626- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2627- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002628
wdenkc6097192002-11-03 00:24:07 +00002629Configuration Settings:
2630-----------------------
2631
York Sun6c480012014-02-26 17:03:19 -08002632- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2633 Optionally it can be defined to support 64-bit memory commands.
2634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002635- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002636 undefine this when you're short of memory.
2637
Peter Tyserdfb72b82009-01-27 18:03:12 -06002638- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2639 width of the commands listed in the 'help' command output.
2640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002641- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002642 prompt for user input.
2643
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002644- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002646- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002648- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002649
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002650- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002651 the application (usually a Linux kernel) when it is
2652 booted
2653
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002654- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002655 List of legal baudrate settings for this board.
2656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002657- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002658 Begin and End addresses of the area used by the
2659 simple memory test.
2660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002661- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002662 Scratch address used by the alternate memory test
2663 You only need to set this if address zero isn't writeable
2664
York Sun5d286cd2015-12-04 11:57:07 -08002665- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002666 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002667 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2668 is substracted from total RAM and won't be reported to OS.
2669 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002670 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002671 the RAM base is not zero, or RAM is divided into banks,
2672 this variable needs to be recalcuated to get the address.
2673
York Sun50739372015-12-07 11:05:29 -08002674- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002675 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002676 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002677 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002678 fixing up gd->ram_size the Linux kernel should gets passed
2679 the now "corrected" memory size and won't touch it either.
2680 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002681 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002682 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002683 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002684
2685 This option can be used as a workaround for the 440EPx/GRx
2686 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2687 be touched.
2688
2689 WARNING: Please make sure that this value is a multiple of
2690 the Linux page size (normally 4k). If this is not the case,
2691 then the end address of the Linux memory will be located at a
2692 non page size aligned address and this could cause major
2693 problems.
2694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002695- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002696 Enable temporary baudrate change while serial download
2697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002698- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002699 Physical start address of SDRAM. _Must_ be 0 here.
2700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002701- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002702 Physical start address of Flash memory.
2703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002704- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002705 Physical start address of boot monitor code (set by
2706 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002707 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002708 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002710- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002711 Size of memory reserved for monitor code, used to
2712 determine _at_compile_time_ (!) if the environment is
2713 embedded within the U-Boot image, or in a separate
2714 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002716- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002717 Size of DRAM reserved for malloc() use.
2718
Simon Glass863e4042014-07-10 22:23:28 -06002719- CONFIG_SYS_MALLOC_F_LEN
2720 Size of the malloc() pool for use before relocation. If
2721 this is defined, then a very simple malloc() implementation
2722 will become available before relocation. The address is just
2723 below the global data, and the stack is moved down to make
2724 space.
2725
2726 This feature allocates regions with increasing addresses
2727 within the region. calloc() is supported, but realloc()
2728 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002729 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002730 U-Boot relocates itself.
2731
Simon Glass9fa901b2014-11-10 17:16:54 -07002732- CONFIG_SYS_MALLOC_SIMPLE
2733 Provides a simple and small malloc() and calloc() for those
2734 boards which do not use the full malloc in SPL (which is
2735 enabled with CONFIG_SYS_SPL_MALLOC_START).
2736
Thierry Redingc97d9742014-12-09 22:25:22 -07002737- CONFIG_SYS_NONCACHED_MEMORY:
2738 Size of non-cached memory area. This area of memory will be
2739 typically located right below the malloc() area and mapped
2740 uncached in the MMU. This is useful for drivers that would
2741 otherwise require a lot of explicit cache maintenance. For
2742 some drivers it's also impossible to properly maintain the
2743 cache. For example if the regions that need to be flushed
2744 are not a multiple of the cache-line size, *and* padding
2745 cannot be allocated between the regions to align them (i.e.
2746 if the HW requires a contiguous array of regions, and the
2747 size of each region is not cache-aligned), then a flush of
2748 one region may result in overwriting data that hardware has
2749 written to another region in the same cache-line. This can
2750 happen for example in network drivers where descriptors for
2751 buffers are typically smaller than the CPU cache-line (e.g.
2752 16 bytes vs. 32 or 64 bytes).
2753
2754 Non-cached memory is only supported on 32-bit ARM at present.
2755
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002756- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002757 Normally compressed uImages are limited to an
2758 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002759 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002760 to adjust this setting to your needs.
2761
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002762- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002763 Maximum size of memory mapped by the startup code of
2764 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002765 the Linux kernel (bd_info, boot arguments, FDT blob if
2766 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002767 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002768 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002769 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002770 variable "bootm_mapsize" will override the value of
2771 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2772 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002773
John Rigbyeea8e692010-10-13 13:57:35 -06002774- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2775 Enable initrd_high functionality. If defined then the
2776 initrd_high feature is enabled and the bootm ramdisk subcommand
2777 is enabled.
2778
2779- CONFIG_SYS_BOOT_GET_CMDLINE:
2780 Enables allocating and saving kernel cmdline in space between
2781 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2782
2783- CONFIG_SYS_BOOT_GET_KBD:
2784 Enables allocating and saving a kernel copy of the bd_info in
2785 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002787- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002788 Max number of Flash memory banks
2789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002790- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002791 Max number of sectors on a Flash chip
2792
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002793- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002794 Timeout for Flash erase operations (in ms)
2795
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002796- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002797 Timeout for Flash write operations (in ms)
2798
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002799- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002800 Timeout for Flash set sector lock bit operation (in ms)
2801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002802- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002803 Timeout for Flash clear lock bits operation (in ms)
2804
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002805- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002806 If defined, hardware flash sectors protection is used
2807 instead of U-Boot software protection.
2808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002809- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002810
2811 Enable TFTP transfers directly to flash memory;
2812 without this option such a download has to be
2813 performed in two steps: (1) download to RAM, and (2)
2814 copy from RAM to flash.
2815
2816 The two-step approach is usually more reliable, since
2817 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002818 the flash, but in some situations (when system RAM is
2819 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002820 downloaded image) this option may be very useful.
2821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002822- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002823 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002824 common flash structure for storing flash geometry.
2825
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002826- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002827 This option also enables the building of the cfi_flash driver
2828 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002829
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002830- CONFIG_FLASH_CFI_MTD
2831 This option enables the building of the cfi_mtd driver
2832 in the drivers directory. The driver exports CFI flash
2833 to the MTD layer.
2834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002835- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002836 Use buffered writes to flash.
2837
2838- CONFIG_FLASH_SPANSION_S29WS_N
2839 s29ws-n MirrorBit flash has non-standard addresses for buffered
2840 write commands.
2841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002842- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002843 If this option is defined, the common CFI flash doesn't
2844 print it's warning upon not recognized FLASH banks. This
2845 is useful, if some of the configured banks are only
2846 optionally available.
2847
Jerry Van Barenaae73572008-03-08 13:48:01 -05002848- CONFIG_FLASH_SHOW_PROGRESS
2849 If defined (must be an integer), print out countdown
2850 digits and dots. Recommended value: 45 (9..1) for 80
2851 column displays, 15 (3..1) for 40 column displays.
2852
Stefan Roesed20cba52013-04-04 15:53:14 +02002853- CONFIG_FLASH_VERIFY
2854 If defined, the content of the flash (destination) is compared
2855 against the source after the write operation. An error message
2856 will be printed when the contents are not identical.
2857 Please note that this option is useless in nearly all cases,
2858 since such flash programming errors usually are detected earlier
2859 while unprotecting/erasing/programming. Please only enable
2860 this option if you really know what you are doing.
2861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002862- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002863 Defines the number of Ethernet receive buffers. On some
2864 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002865 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2866 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002867 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002868 Defaults to 4 if not defined.
2869
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002870- CONFIG_ENV_MAX_ENTRIES
2871
Wolfgang Denk1136f692010-10-27 22:48:30 +02002872 Maximum number of entries in the hash table that is used
2873 internally to store the environment settings. The default
2874 setting is supposed to be generous and should work in most
2875 cases. This setting can be used to tune behaviour; see
2876 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002877
Joe Hershberger71497d02012-12-11 22:16:31 -06002878- CONFIG_ENV_FLAGS_LIST_DEFAULT
2879- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002880 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002881 calling env set. Variables can be restricted to only decimal,
2882 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2883 the variables can also be restricted to IP address or MAC address.
2884
2885 The format of the list is:
2886 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002887 access_attribute = [a|r|o|c]
2888 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002889 entry = variable_name[:attributes]
2890 list = entry[,list]
2891
2892 The type attributes are:
2893 s - String (default)
2894 d - Decimal
2895 x - Hexadecimal
2896 b - Boolean ([1yYtT|0nNfF])
2897 i - IP address
2898 m - MAC address
2899
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002900 The access attributes are:
2901 a - Any (default)
2902 r - Read-only
2903 o - Write-once
2904 c - Change-default
2905
Joe Hershberger71497d02012-12-11 22:16:31 -06002906 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2907 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002908 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002909
2910 - CONFIG_ENV_FLAGS_LIST_STATIC
2911 Define this to a list (string) to define validation that
2912 should be done if an entry is not found in the ".flags"
2913 environment variable. To override a setting in the static
2914 list, simply add an entry for the same variable name to the
2915 ".flags" variable.
2916
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002917 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2918 regular expression. This allows multiple variables to define the same
2919 flags without explicitly listing them for each variable.
2920
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002921- CONFIG_ENV_ACCESS_IGNORE_FORCE
2922 If defined, don't allow the -f switch to env set override variable
2923 access flags.
2924
wdenkc6097192002-11-03 00:24:07 +00002925The following definitions that deal with the placement and management
2926of environment data (variable area); in general, we support the
2927following configurations:
2928
Mike Frysinger63b8f122011-07-08 10:44:25 +00002929- CONFIG_BUILD_ENVCRC:
2930
2931 Builds up envcrc with the target environment so that external utils
2932 may easily extract it and embed it in final U-Boot images.
2933
wdenkc6097192002-11-03 00:24:07 +00002934BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002935in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002936console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002937U-Boot will hang.
2938
2939Please note that even with NVRAM we still use a copy of the
2940environment in RAM: we could work on NVRAM directly, but we want to
2941keep settings there always unmodified except somebody uses "saveenv"
2942to save the current settings.
2943
Liu Gang85bcd732012-03-08 00:33:20 +00002944BE CAREFUL! For some special cases, the local device can not use
2945"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002946environment stored in a remote NOR flash by SRIO or PCIE link,
2947but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002948
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002949- CONFIG_NAND_ENV_DST
2950
2951 Defines address in RAM to which the nand_spl code should copy the
2952 environment. If redundant environment is used, it will be copied to
2953 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2954
Bruce Adleredecc942007-11-02 13:15:42 -07002955Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002956has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002957created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002958until then to read environment variables.
2959
wdenk8dba0502003-03-31 16:34:49 +00002960The environment is protected by a CRC32 checksum. Before the monitor
2961is relocated into RAM, as a result of a bad CRC you will be working
2962with the compiled-in default environment - *silently*!!! [This is
2963necessary, because the first environment variable we need is the
2964"baudrate" setting for the console - if we have a bad CRC, we don't
2965have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002966
2967Note: once the monitor has been relocated, then it will complain if
2968the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002969use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002970
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002971- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002972 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002974 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002975 also needs to be defined.
2976
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002977- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002978 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002979
Ron Madriddfa028a2009-02-18 14:30:44 -08002980- CONFIG_NS16550_MIN_FUNCTIONS:
2981 Define this if you desire to only have use of the NS16550_init
2982 and NS16550_putc functions for the serial driver located at
2983 drivers/serial/ns16550.c. This option is useful for saving
2984 space for already greatly restricted images, including but not
2985 limited to NAND_SPL configurations.
2986
Simon Glass28a9e332012-11-30 13:01:18 +00002987- CONFIG_DISPLAY_BOARDINFO
2988 Display information about the board that U-Boot is running on
2989 when U-Boot starts up. The board function checkboard() is called
2990 to do this.
2991
Simon Glasse8822012012-11-30 13:01:19 +00002992- CONFIG_DISPLAY_BOARDINFO_LATE
2993 Similar to the previous option, but display this information
2994 later, once stdio is running and output goes to the LCD, if
2995 present.
2996
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002997- CONFIG_BOARD_SIZE_LIMIT:
2998 Maximum size of the U-Boot image. When defined, the
2999 build system checks that the actual size does not
3000 exceed it.
3001
wdenkc6097192002-11-03 00:24:07 +00003002Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003003---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003004
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003005- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003006 Cache Line Size of the CPU.
3007
Timur Tabid8f341c2011-08-04 18:03:41 -05003008- CONFIG_SYS_CCSRBAR_DEFAULT:
3009 Default (power-on reset) physical address of CCSR on Freescale
3010 PowerPC SOCs.
3011
3012- CONFIG_SYS_CCSRBAR:
3013 Virtual address of CCSR. On a 32-bit build, this is typically
3014 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3015
Timur Tabid8f341c2011-08-04 18:03:41 -05003016- CONFIG_SYS_CCSRBAR_PHYS:
3017 Physical address of CCSR. CCSR can be relocated to a new
3018 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003019 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003020 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3021 is typically relocated on 36-bit builds. It is recommended
3022 that this macro be defined via the _HIGH and _LOW macros:
3023
3024 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3025 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3026
3027- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003028 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3029 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003030 used in assembly code, so it must not contain typecasts or
3031 integer size suffixes (e.g. "ULL").
3032
3033- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3034 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3035 used in assembly code, so it must not contain typecasts or
3036 integer size suffixes (e.g. "ULL").
3037
3038- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3039 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3040 forced to a value that ensures that CCSR is not relocated.
3041
wdenk1272e232002-11-10 22:06:23 +00003042- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003043 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003044
3045 the default drive number (default value 0)
3046
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003047 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003048
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003049 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003050 (default value 1)
3051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003052 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003053
wdenk4a5c8a72003-03-06 00:02:04 +00003054 defines the offset of register from address. It
3055 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003056 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003058 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3059 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003060 default value.
wdenk1272e232002-11-10 22:06:23 +00003061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003062 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003063 fdc_hw_init() is called at the beginning of the FDC
3064 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003065 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003066 initializations.
wdenk1272e232002-11-10 22:06:23 +00003067
Macpaul Lind1e49942011-04-11 20:45:32 +00003068- CONFIG_IDE_AHB:
3069 Most IDE controllers were designed to be connected with PCI
3070 interface. Only few of them were designed for AHB interface.
3071 When software is doing ATA command and data transfer to
3072 IDE devices through IDE-AHB controller, some additional
3073 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003074 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003076- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003077 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003078 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003081
wdenkeb20ad32003-09-05 23:19:14 +00003082 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003083 initial data and stack; please note that this must be
3084 writable memory that is working WITHOUT special
3085 initialization, i. e. you CANNOT use normal RAM which
3086 will become available only after programming the
3087 memory controller and running certain initialization
3088 sequences.
3089
3090 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003091 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003094
3095 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003096 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3097 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003098 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003099 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003100 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003101 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3102 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003103
3104 Note:
3105 On the MPC824X (or other systems that use the data
3106 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003107 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003108 point to an otherwise UNUSED address space between
3109 the top of RAM and the start of the PCI space.
3110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003111- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003112
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003113- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003114 SDRAM timing
3115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003117 periodic timer for refresh
3118
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003119- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3120 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3121 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3122 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003123 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3124
3125- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003126 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3127 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003128 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3129
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003130- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003131 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003132 Don't do any setup work, presumably because someone or
3133 something has already done it, and we don't need to do it
3134 a second time. Useful for platforms that are pre-booted
3135 by coreboot or similar.
3136
Gabor Juhosb4458732013-05-30 07:06:12 +00003137- CONFIG_PCI_INDIRECT_BRIDGE:
3138 Enable support for indirect PCI bridges.
3139
Kumar Gala8975d7a2010-12-30 12:09:53 -06003140- CONFIG_SYS_SRIO:
3141 Chip has SRIO or not
3142
3143- CONFIG_SRIO1:
3144 Board has SRIO 1 port available
3145
3146- CONFIG_SRIO2:
3147 Board has SRIO 2 port available
3148
Liu Gang27afb9c2013-05-07 16:30:46 +08003149- CONFIG_SRIO_PCIE_BOOT_MASTER
3150 Board can support master function for Boot from SRIO and PCIE
3151
Kumar Gala8975d7a2010-12-30 12:09:53 -06003152- CONFIG_SYS_SRIOn_MEM_VIRT:
3153 Virtual Address of SRIO port 'n' memory region
3154
3155- CONFIG_SYS_SRIOn_MEM_PHYS:
3156 Physical Address of SRIO port 'n' memory region
3157
3158- CONFIG_SYS_SRIOn_MEM_SIZE:
3159 Size of SRIO port 'n' memory region
3160
Fabio Estevamf17e8782013-04-11 09:35:34 +00003161- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3162 Defined to tell the NAND controller that the NAND chip is using
3163 a 16 bit bus.
3164 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003165 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02003166 - drivers/mtd/nand/raw/ndfc.c
3167 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003168
3169- CONFIG_SYS_NDFC_EBC0_CFG
3170 Sets the EBC0_CFG register for the NDFC. If not defined
3171 a default value will be used.
3172
Ben Warren45657152006-09-07 16:50:54 -04003173- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003174 Get DDR timing information from an I2C EEPROM. Common
3175 with pluggable memory modules such as SODIMMs
3176
Ben Warren45657152006-09-07 16:50:54 -04003177 SPD_EEPROM_ADDRESS
3178 I2C address of the SPD EEPROM
3179
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003180- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003181 If SPD EEPROM is on an I2C bus other than the first
3182 one, specify here. Note that the value must resolve
3183 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003184
York Sune73cc042011-06-07 09:42:16 +08003185- CONFIG_SYS_DDR_RAW_TIMING
3186 Get DDR timing information from other than SPD. Common with
3187 soldered DDR chips onboard without SPD. DDR raw timing
3188 parameters are extracted from datasheet and hard-coded into
3189 header files or board specific files.
3190
York Sunbd495cf2011-09-16 13:21:35 -07003191- CONFIG_FSL_DDR_INTERACTIVE
3192 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3193
York Sun8ced0502015-01-06 13:18:55 -08003194- CONFIG_FSL_DDR_SYNC_REFRESH
3195 Enable sync of refresh for multiple controllers.
3196
York Sunb6a35f82015-03-19 09:30:28 -07003197- CONFIG_FSL_DDR_BIST
3198 Enable built-in memory test for Freescale DDR controllers.
3199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003200- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003201 Only for 83xx systems. If specified, then DDR should
3202 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003203
wdenk6203e402004-04-18 10:13:26 +00003204- CONFIG_RMII
3205 Enable RMII mode for all FECs.
3206 Note that this is a global option, we can't
3207 have one FEC in standard MII mode and another in RMII mode.
3208
wdenk20c98a62004-04-23 20:32:05 +00003209- CONFIG_CRC32_VERIFY
3210 Add a verify option to the crc32 command.
3211 The syntax is:
3212
3213 => crc32 -v <address> <count> <crc32>
3214
3215 Where address/count indicate a memory area
3216 and crc32 is the correct crc32 which the
3217 area should have.
3218
wdenk64519362004-07-11 17:40:54 +00003219- CONFIG_LOOPW
3220 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003221 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003222
stroesecc3af832004-12-16 18:46:55 +00003223- CONFIG_MX_CYCLIC
3224 Add the "mdc" and "mwc" memory commands. These are cyclic
3225 "md/mw" commands.
3226 Examples:
3227
wdenk07d7e6b2004-12-16 21:44:03 +00003228 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003229 This command will print 4 bytes (10,11,12,13) each 500 ms.
3230
wdenk07d7e6b2004-12-16 21:44:03 +00003231 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003232 This command will write 12345678 to address 100 all 10 ms.
3233
wdenk07d7e6b2004-12-16 21:44:03 +00003234 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003235 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003236
wdenk3d3d99f2005-04-04 12:44:11 +00003237- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chend7e6f922017-12-26 13:55:59 +08003238 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003239 low level initializations (like setting up the memory
3240 controller) are omitted and/or U-Boot does not
3241 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003242
Wolfgang Denk302141d2010-11-27 23:30:56 +01003243 Normally this variable MUST NOT be defined. The only
3244 exception is when U-Boot is loaded (to RAM) by some
3245 other boot loader or by a debugger which performs
3246 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003247
Simon Glass90844072016-05-05 07:28:06 -06003248- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3249 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003250 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003251 instruction cache) is still performed.
3252
Aneesh V552a3192011-07-13 05:11:07 +00003253- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003254 Modifies the behaviour of start.S when compiling a loader
3255 that is executed before the actual U-Boot. E.g. when
3256 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003257
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003258- CONFIG_TPL_BUILD
3259 Modifies the behaviour of start.S when compiling a loader
3260 that is executed after the SPL and before the actual U-Boot.
3261 It is loaded by the SPL.
3262
Ying Zhang0d4f5442013-05-20 14:07:23 +08003263- CONFIG_SYS_MPC85XX_NO_RESETVEC
3264 Only for 85xx systems. If this variable is specified, the section
3265 .resetvec is not kept and the section .bootpg is placed in the
3266 previous 4k of the .text section.
3267
Simon Glass17dabf02013-02-24 17:33:14 +00003268- CONFIG_ARCH_MAP_SYSMEM
3269 Generally U-Boot (and in particular the md command) uses
3270 effective address. It is therefore not necessary to regard
3271 U-Boot address as virtual addresses that need to be translated
3272 to physical addresses. However, sandbox requires this, since
3273 it maintains its own little RAM buffer which contains all
3274 addressable memory. This option causes some memory accesses
3275 to be mapped through map_sysmem() / unmap_sysmem().
3276
Simon Glassbfb59802013-02-14 04:18:54 +00003277- CONFIG_X86_RESET_VECTOR
3278 If defined, the x86 reset vector code is included. This is not
3279 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003280
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003281- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3282 Option to disable subpage write in NAND driver
3283 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02003284 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003285
Timur Tabi275f4bb2011-11-22 09:21:25 -06003286Freescale QE/FMAN Firmware Support:
3287-----------------------------------
3288
3289The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3290loading of "firmware", which is encoded in the QE firmware binary format.
3291This firmware often needs to be loaded during U-Boot booting, so macros
3292are used to identify the storage device (NOR flash, SPI, etc) and the address
3293within that device.
3294
Zhao Qiang83a90842014-03-21 16:21:44 +08003295- CONFIG_SYS_FMAN_FW_ADDR
3296 The address in the storage device where the FMAN microcode is located. The
3297 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3298 is also specified.
3299
3300- CONFIG_SYS_QE_FW_ADDR
3301 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003302 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3303 is also specified.
3304
3305- CONFIG_SYS_QE_FMAN_FW_LENGTH
3306 The maximum possible size of the firmware. The firmware binary format
3307 has a field that specifies the actual size of the firmware, but it
3308 might not be possible to read any part of the firmware unless some
3309 local storage is allocated to hold the entire firmware first.
3310
3311- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3312 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3313 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3314 virtual address in NOR flash.
3315
3316- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3317 Specifies that QE/FMAN firmware is located in NAND flash.
3318 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3319
3320- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3321 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3322 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3323
Liu Gang1e084582012-03-08 00:33:18 +00003324- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3325 Specifies that QE/FMAN firmware is located in the remote (master)
3326 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003327 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3328 window->master inbound window->master LAW->the ucode address in
3329 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003330
J. German Rivera8ff14b72014-06-23 15:15:55 -07003331Freescale Layerscape Management Complex Firmware Support:
3332---------------------------------------------------------
3333The Freescale Layerscape Management Complex (MC) supports the loading of
3334"firmware".
3335This firmware often needs to be loaded during U-Boot booting, so macros
3336are used to identify the storage device (NOR flash, SPI, etc) and the address
3337within that device.
3338
3339- CONFIG_FSL_MC_ENET
3340 Enable the MC driver for Layerscape SoCs.
3341
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303342Freescale Layerscape Debug Server Support:
3343-------------------------------------------
3344The Freescale Layerscape Debug Server Support supports the loading of
3345"Debug Server firmware" and triggering SP boot-rom.
3346This firmware often needs to be loaded during U-Boot booting.
3347
York Sun928b6812015-12-07 11:08:58 -08003348- CONFIG_SYS_MC_RSV_MEM_ALIGN
3349 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303350
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003351Reproducible builds
3352-------------------
3353
3354In order to achieve reproducible builds, timestamps used in the U-Boot build
3355process have to be set to a fixed value.
3356
3357This is done using the SOURCE_DATE_EPOCH environment variable.
3358SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3359option for U-Boot or an environment variable in U-Boot.
3360
3361SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3362
wdenkc6097192002-11-03 00:24:07 +00003363Building the Software:
3364======================
3365
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003366Building U-Boot has been tested in several native build environments
3367and in many different cross environments. Of course we cannot support
3368all possibly existing versions of cross development tools in all
3369(potentially obsolete) versions. In case of tool chain problems we
3370recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3371which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003372
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003373If you are not using a native environment, it is assumed that you
3374have GNU cross compiling tools available in your path. In this case,
3375you must set the environment variable CROSS_COMPILE in your shell.
3376Note that no changes to the Makefile or any other source files are
3377necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003378
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003379 $ CROSS_COMPILE=ppc_4xx-
3380 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003381
Peter Tyserb06976d2009-03-13 18:54:51 -05003382Note: If you wish to generate Windows versions of the utilities in
3383 the tools directory you can use the MinGW toolchain
3384 (http://www.mingw.org). Set your HOST tools to the MinGW
3385 toolchain and execute 'make tools'. For example:
3386
3387 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3388
3389 Binaries such as tools/mkimage.exe will be created which can
3390 be executed on computers running Windows.
3391
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003392U-Boot is intended to be simple to build. After installing the
3393sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003394is done by typing:
3395
Holger Freyther7ba4e572014-08-04 09:26:05 +02003396 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003397
Holger Freyther7ba4e572014-08-04 09:26:05 +02003398where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003399rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003400
wdenk6c59edc2004-05-03 20:45:30 +00003401Note: for some board special configuration names may exist; check if
3402 additional information is available from the board vendor; for
3403 instance, the TQM823L systems are available without (standard)
3404 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003405 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003406
Holger Freyther7ba4e572014-08-04 09:26:05 +02003407 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003408 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003409
Holger Freyther7ba4e572014-08-04 09:26:05 +02003410 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003411 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003412
wdenk6c59edc2004-05-03 20:45:30 +00003413 etc.
wdenkc6097192002-11-03 00:24:07 +00003414
wdenkc6097192002-11-03 00:24:07 +00003415
wdenk6c59edc2004-05-03 20:45:30 +00003416Finally, type "make all", and you should get some working U-Boot
3417images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk6c59edc2004-05-03 20:45:30 +00003419- "u-boot.bin" is a raw binary image
3420- "u-boot" is an image in ELF binary format
3421- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003422
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003423By default the build is performed locally and the objects are saved
3424in the source directory. One of the two methods can be used to change
3425this behavior and build U-Boot to some external directory:
3426
34271. Add O= to the make command line invocations:
3428
3429 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003430 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003431 make O=/tmp/build all
3432
Timo Ketolac8c67602014-11-06 14:39:05 +020034332. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003434
Timo Ketolac8c67602014-11-06 14:39:05 +02003435 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003436 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003437 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003438 make all
3439
Timo Ketolac8c67602014-11-06 14:39:05 +02003440Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003441variable.
3442
Daniel Schwierzeck88484422018-01-26 16:31:04 +01003443User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3444setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3445For example to treat all compiler warnings as errors:
3446
3447 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk6c59edc2004-05-03 20:45:30 +00003449Please be aware that the Makefiles assume you are using GNU make, so
3450for instance on NetBSD you might need to use "gmake" instead of
3451native "make".
wdenkc6097192002-11-03 00:24:07 +00003452
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk6c59edc2004-05-03 20:45:30 +00003454If the system board that you have is not listed, then you will need
3455to port U-Boot to your hardware platform. To do this, follow these
3456steps:
wdenkc6097192002-11-03 00:24:07 +00003457
Phil Sutterc77b4882015-12-25 14:41:18 +010034581. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003459 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003460 the "Makefile" and a "<board>.c".
34612. Create a new configuration file "include/configs/<board>.h" for
3462 your board.
wdenk6c59edc2004-05-03 20:45:30 +000034633. If you're porting U-Boot to a new CPU, then also create a new
3464 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020034654. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000034665. Type "make", and you should get a working "u-boot.srec" file
3467 to be installed on your target system.
34686. Debug and solve any problems that might arise.
3469 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003470
wdenkc6097192002-11-03 00:24:07 +00003471
wdenk6c59edc2004-05-03 20:45:30 +00003472Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3473==============================================================
wdenkc6097192002-11-03 00:24:07 +00003474
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003475If you have modified U-Boot sources (for instance added a new board
3476or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003477provide feedback to the other developers. The feedback normally takes
3478the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003479official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003480
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003481But before you submit such a patch, please verify that your modifi-
3482cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003483the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003484just run the buildman script (tools/buildman/buildman), which will
3485configure and build U-Boot for ALL supported system. Be warned, this
3486will take a while. Please see the buildman README, or run 'buildman -H'
3487for documentation.
wdenkc6097192002-11-03 00:24:07 +00003488
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003489
wdenk6c59edc2004-05-03 20:45:30 +00003490See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003491
wdenkc6097192002-11-03 00:24:07 +00003492
wdenk6c59edc2004-05-03 20:45:30 +00003493Monitor Commands - Overview:
3494============================
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk6c59edc2004-05-03 20:45:30 +00003496go - start application at address 'addr'
3497run - run commands in an environment variable
3498bootm - boot application image from memory
3499bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003500bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003501tftpboot- boot image via network using TFTP protocol
3502 and env variables "ipaddr" and "serverip"
3503 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003504tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003505rarpboot- boot image via network using RARP/TFTP protocol
3506diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3507loads - load S-Record file over serial line
3508loadb - load binary file over serial line (kermit mode)
3509md - memory display
3510mm - memory modify (auto-incrementing)
3511nm - memory modify (constant address)
3512mw - memory write (fill)
3513cp - memory copy
3514cmp - memory compare
3515crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003516i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003517sspi - SPI utility commands
3518base - print or set address offset
3519printenv- print environment variables
3520setenv - set environment variables
3521saveenv - save environment variables to persistent storage
3522protect - enable or disable FLASH write protection
3523erase - erase FLASH memory
3524flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003525nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003526bdinfo - print Board Info structure
3527iminfo - print header information for application image
3528coninfo - print console devices and informations
3529ide - IDE sub-system
3530loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003531loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003532mtest - simple RAM test
3533icache - enable or disable instruction cache
3534dcache - enable or disable data cache
3535reset - Perform RESET of the CPU
3536echo - echo args to console
3537version - print monitor version
3538help - print online help
3539? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003540
wdenkc6097192002-11-03 00:24:07 +00003541
wdenk6c59edc2004-05-03 20:45:30 +00003542Monitor Commands - Detailed Description:
3543========================================
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk6c59edc2004-05-03 20:45:30 +00003545TODO.
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk6c59edc2004-05-03 20:45:30 +00003547For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003548
3549
wdenk6c59edc2004-05-03 20:45:30 +00003550Environment Variables:
3551======================
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk6c59edc2004-05-03 20:45:30 +00003553U-Boot supports user configuration using Environment Variables which
3554can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk6c59edc2004-05-03 20:45:30 +00003556Environment Variables are set using "setenv", printed using
3557"printenv", and saved to Flash using "saveenv". Using "setenv"
3558without a value can be used to delete a variable from the
3559environment. As long as you don't save the environment you are
3560working with an in-memory copy. In case the Flash area containing the
3561environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003562
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003563Some configuration options can be set using Environment Variables.
3564
3565List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk6c59edc2004-05-03 20:45:30 +00003567 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk6c59edc2004-05-03 20:45:30 +00003569 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk6c59edc2004-05-03 20:45:30 +00003571 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003572
wdenk6c59edc2004-05-03 20:45:30 +00003573 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk6c59edc2004-05-03 20:45:30 +00003575 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003576
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003577 bootm_low - Memory range available for image processing in the bootm
3578 command can be restricted. This variable is given as
3579 a hexadecimal number and defines lowest address allowed
3580 for use by the bootm command. See also "bootm_size"
3581 environment variable. Address defined by "bootm_low" is
3582 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003583 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3584 bootm_mapsize.
3585
Wolfgang Denk092ae952011-10-26 10:21:21 +00003586 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003587 This variable is given as a hexadecimal number and it
3588 defines the size of the memory region starting at base
3589 address bootm_low that is accessible by the Linux kernel
3590 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3591 as the default value if it is defined, and bootm_size is
3592 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003593
3594 bootm_size - Memory range available for image processing in the bootm
3595 command can be restricted. This variable is given as
3596 a hexadecimal number and defines the size of the region
3597 allowed for use by the bootm command. See also "bootm_low"
3598 environment variable.
3599
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003600 updatefile - Location of the software update file on a TFTP server, used
3601 by the automatic software update feature. Please refer to
3602 documentation in doc/README.update for more details.
3603
wdenk6c59edc2004-05-03 20:45:30 +00003604 autoload - if set to "no" (any string beginning with 'n'),
3605 "bootp" will just load perform a lookup of the
3606 configuration from the BOOTP server, but not try to
3607 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003608
wdenk6c59edc2004-05-03 20:45:30 +00003609 autostart - if set to "yes", an image loaded using the "bootp",
3610 "rarpboot", "tftpboot" or "diskboot" commands will
3611 be automatically started (by internally calling
3612 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk6c59edc2004-05-03 20:45:30 +00003614 If set to "no", a standalone image passed to the
3615 "bootm" command will be copied to the load address
3616 (and eventually uncompressed), but NOT be started.
3617 This can be used to load and uncompress arbitrary
3618 data.
wdenkc6097192002-11-03 00:24:07 +00003619
David A. Longd558a4e2011-07-09 16:40:19 -04003620 fdt_high - if set this restricts the maximum address that the
3621 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003622 For example, if you have a system with 1 GB memory
3623 at physical address 0x10000000, while Linux kernel
3624 only recognizes the first 704 MB as low memory, you
3625 may need to set fdt_high as 0x3C000000 to have the
3626 device tree blob be copied to the maximum address
3627 of the 704 MB low memory, so that Linux kernel can
3628 access it during the boot procedure.
3629
David A. Longd558a4e2011-07-09 16:40:19 -04003630 If this is set to the special value 0xFFFFFFFF then
3631 the fdt will not be copied at all on boot. For this
3632 to work it must reside in writable memory, have
3633 sufficient padding on the end of it for u-boot to
3634 add the information it needs into it, and the memory
3635 must be accessible by the kernel.
3636
Simon Glassdc6fa642011-10-24 19:15:34 +00003637 fdtcontroladdr- if set this is the address of the control flattened
3638 device tree used by U-Boot when CONFIG_OF_CONTROL is
3639 defined.
3640
wdenk0e2bd9c2004-06-06 21:51:03 +00003641 i2cfast - (PPC405GP|PPC405EP only)
3642 if set to 'y' configures Linux I2C driver for fast
3643 mode (400kHZ). This environment variable is used in
3644 initialization code. So, for changes to be effective
3645 it must be saved and board must be reset.
3646
wdenk6c59edc2004-05-03 20:45:30 +00003647 initrd_high - restrict positioning of initrd images:
3648 If this variable is not set, initrd images will be
3649 copied to the highest possible address in RAM; this
3650 is usually what you want since it allows for
3651 maximum initrd size. If for some reason you want to
3652 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003653 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003654 variable to a value of "no" or "off" or "0".
3655 Alternatively, you can set it to a maximum upper
3656 address to use (U-Boot will still check that it
3657 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk6c59edc2004-05-03 20:45:30 +00003659 For instance, when you have a system with 16 MB
3660 RAM, and want to reserve 4 MB from use by Linux,
3661 you can do this by adding "mem=12M" to the value of
3662 the "bootargs" variable. However, now you must make
3663 sure that the initrd image is placed in the first
3664 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk6c59edc2004-05-03 20:45:30 +00003666 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003667
wdenk6c59edc2004-05-03 20:45:30 +00003668 If you set initrd_high to 0xFFFFFFFF, this is an
3669 indication to U-Boot that all addresses are legal
3670 for the Linux kernel, including addresses in flash
3671 memory. In this case U-Boot will NOT COPY the
3672 ramdisk at all. This may be useful to reduce the
3673 boot time on your system, but requires that this
3674 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003675
wdenk6c59edc2004-05-03 20:45:30 +00003676 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk6c59edc2004-05-03 20:45:30 +00003678 loadaddr - Default load address for commands like "bootp",
3679 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk6c59edc2004-05-03 20:45:30 +00003681 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003682
wdenk6c59edc2004-05-03 20:45:30 +00003683 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003686
wdenk6c59edc2004-05-03 20:45:30 +00003687 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk6c59edc2004-05-03 20:45:30 +00003689 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003690
Mike Frysingera23230c2011-10-02 10:01:27 +00003691 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003692
Mike Frysingera23230c2011-10-02 10:01:27 +00003693 ethact - controls which interface is currently active.
3694 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003695
Heiko Schocherc5e84052010-07-20 17:45:02 +02003696 => setenv ethact FEC
3697 => ping 192.168.0.1 # traffic sent on FEC
3698 => setenv ethact SCC
3699 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003700
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003701 ethrotate - When set to "no" U-Boot does not go through all
3702 available network interfaces.
3703 It just stays at the currently selected interface.
3704
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003705 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003706 either succeed or fail without retrying.
3707 When set to "once" the network operation will
3708 fail when all the available network interfaces
3709 are tried once without success.
3710 Useful on scripts which control the retry operation
3711 themselves.
wdenkc6097192002-11-03 00:24:07 +00003712
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003713 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003714
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003715 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003716 changing the console to be empty. If "yes" it will be
3717 made silent. If "no" it will not be made silent. If
3718 unset, then it will be made silent if the U-Boot console
3719 is silent.
3720
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003721 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003722 UDP source port.
3723
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003724 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003725 destination port instead of the Well Know Port 69.
3726
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003727 tftpblocksize - Block size to use for TFTP transfers; if not set,
3728 we use the TFTP server's default block size
3729
3730 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3731 seconds, minimum value is 1000 = 1 second). Defines
3732 when a packet is considered to be lost so it has to
3733 be retransmitted. The default is 5000 = 5 seconds.
3734 Lowering this value may make downloads succeed
3735 faster in networks with high packet loss rates or
3736 with unreliable TFTP servers.
3737
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003738 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3739 unit, minimum value = 0). Defines how many timeouts
3740 can happen during a single file transfer before that
3741 transfer is aborted. The default is 10, and 0 means
3742 'no timeouts allowed'. Increasing this value may help
3743 downloads succeed with high packet loss rates, or with
3744 unreliable TFTP servers or client hardware.
3745
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003746 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003747 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003748 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003749
Alexandre Messier15971322016-02-01 17:08:57 -05003750 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3751 Unsigned value, in milliseconds. If not set, the period will
3752 be either the default (28000), or a value based on
3753 CONFIG_NET_RETRY_COUNT, if defined. This value has
3754 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3755
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003756The following image location variables contain the location of images
3757used in booting. The "Image" column gives the role of the image and is
3758not an environment variable name. The other columns are environment
3759variable names. "File Name" gives the name of the file on a TFTP
3760server, "RAM Address" gives the location in RAM the image will be
3761loaded to, and "Flash Location" gives the image's address in NOR
3762flash or offset in NAND flash.
3763
3764*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03003765boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003766boards use these variables for other purposes.
3767
Wolfgang Denk092ae952011-10-26 10:21:21 +00003768Image File Name RAM Address Flash Location
3769----- --------- ----------- --------------
3770u-boot u-boot u-boot_addr_r u-boot_addr
3771Linux kernel bootfile kernel_addr_r kernel_addr
3772device tree blob fdtfile fdt_addr_r fdt_addr
3773ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003774
wdenk6c59edc2004-05-03 20:45:30 +00003775The following environment variables may be used and automatically
3776updated by the network boot commands ("bootp" and "rarpboot"),
3777depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003778
wdenk6c59edc2004-05-03 20:45:30 +00003779 bootfile - see above
3780 dnsip - IP address of your Domain Name Server
3781 dnsip2 - IP address of your secondary Domain Name Server
3782 gatewayip - IP address of the Gateway (Router) to use
3783 hostname - Target hostname
3784 ipaddr - see above
3785 netmask - Subnet Mask
3786 rootpath - Pathname of the root filesystem on the NFS server
3787 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003788
wdenk145d2c12004-04-15 21:48:45 +00003789
wdenk6c59edc2004-05-03 20:45:30 +00003790There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk6c59edc2004-05-03 20:45:30 +00003792 serial# - contains hardware identification information such
3793 as type string and/or serial number
3794 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003795
wdenk6c59edc2004-05-03 20:45:30 +00003796These variables can be set only once (usually during manufacturing of
3797the board). U-Boot refuses to delete or overwrite these variables
3798once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003799
3800
wdenk6c59edc2004-05-03 20:45:30 +00003801Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003802
wdenk6c59edc2004-05-03 20:45:30 +00003803 ver - Contains the U-Boot version string as printed
3804 with the "version" command. This variable is
3805 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003806
wdenkc6097192002-11-03 00:24:07 +00003807
wdenk6c59edc2004-05-03 20:45:30 +00003808Please note that changes to some configuration parameters may take
3809only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003810
stroeseb9c17c52003-04-04 15:53:41 +00003811
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003812Callback functions for environment variables:
3813---------------------------------------------
3814
3815For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003816when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003817be associated with arbitrary variables. On creation, overwrite, or
3818deletion, the callback will provide the opportunity for some side
3819effect to happen or for the change to be rejected.
3820
3821The callbacks are named and associated with a function using the
3822U_BOOT_ENV_CALLBACK macro in your board or driver code.
3823
3824These callbacks are associated with variables in one of two ways. The
3825static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3826in the board configuration to a string that defines a list of
3827associations. The list must be in the following format:
3828
3829 entry = variable_name[:callback_name]
3830 list = entry[,list]
3831
3832If the callback name is not specified, then the callback is deleted.
3833Spaces are also allowed anywhere in the list.
3834
3835Callbacks can also be associated by defining the ".callbacks" variable
3836with the same list format above. Any association in ".callbacks" will
3837override any association in the static list. You can define
3838CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003839".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003840
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003841If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3842regular expression. This allows multiple variables to be connected to
3843the same callback without explicitly listing them all out.
3844
Heinrich Schuchardtc141fa52018-07-29 11:08:14 +02003845The signature of the callback functions is:
3846
3847 int callback(const char *name, const char *value, enum env_op op, int flags)
3848
3849* name - changed environment variable
3850* value - new value of the environment variable
3851* op - operation (create, overwrite, or delete)
3852* flags - attributes of the environment variable change, see flags H_* in
3853 include/search.h
3854
3855The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003856
wdenk6c59edc2004-05-03 20:45:30 +00003857Command Line Parsing:
3858=====================
stroeseb9c17c52003-04-04 15:53:41 +00003859
wdenk6c59edc2004-05-03 20:45:30 +00003860There are two different command line parsers available with U-Boot:
3861the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003862
wdenk6c59edc2004-05-03 20:45:30 +00003863Old, simple command line parser:
3864--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003865
wdenk6c59edc2004-05-03 20:45:30 +00003866- supports environment variables (through setenv / saveenv commands)
3867- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003868- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003869- special characters ('$', ';') can be escaped by prefixing with '\',
3870 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003871 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003872- You can also escape text by enclosing in single apostrophes, for example:
3873 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875Hush shell:
3876-----------
wdenkf4688a22003-05-28 08:06:31 +00003877
wdenk6c59edc2004-05-03 20:45:30 +00003878- similar to Bourne shell, with control structures like
3879 if...then...else...fi, for...do...done; while...do...done,
3880 until...do...done, ...
3881- supports environment ("global") variables (through setenv / saveenv
3882 commands) and local shell variables (through standard shell syntax
3883 "name=value"); only environment variables can be used with "run"
3884 command
wdenkf4688a22003-05-28 08:06:31 +00003885
wdenk6c59edc2004-05-03 20:45:30 +00003886General rules:
3887--------------
wdenkf4688a22003-05-28 08:06:31 +00003888
wdenk6c59edc2004-05-03 20:45:30 +00003889(1) If a command line (or an environment variable executed by a "run"
3890 command) contains several commands separated by semicolon, and
3891 one of these commands fails, then the remaining commands will be
3892 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003893
wdenk6c59edc2004-05-03 20:45:30 +00003894(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003895 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003896 command will cause "run" to terminate, i. e. the remaining
3897 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003898
wdenk6c59edc2004-05-03 20:45:30 +00003899Note for Redundant Ethernet Interfaces:
3900=======================================
wdenkf4688a22003-05-28 08:06:31 +00003901
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003902Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003903such configurations and is capable of automatic selection of a
3904"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003905
wdenk6c59edc2004-05-03 20:45:30 +00003906Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3907MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3908"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003909
wdenk6c59edc2004-05-03 20:45:30 +00003910If the network interface stores some valid MAC address (for instance
3911in SROM), this is used as default address if there is NO correspon-
3912ding setting in the environment; if the corresponding environment
3913variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003914
wdenk6c59edc2004-05-03 20:45:30 +00003915o If the SROM has a valid MAC address, and there is no address in the
3916 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk6c59edc2004-05-03 20:45:30 +00003918o If there is no valid address in the SROM, and a definition in the
3919 environment exists, then the value from the environment variable is
3920 used.
wdenkc6097192002-11-03 00:24:07 +00003921
wdenk6c59edc2004-05-03 20:45:30 +00003922o If both the SROM and the environment contain a MAC address, and
3923 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925o If both the SROM and the environment contain a MAC address, and the
3926 addresses differ, the value from the environment is used and a
3927 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk6c59edc2004-05-03 20:45:30 +00003929o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05003930 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3931 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003932
Ben Warren6db991a2010-04-26 11:11:46 -07003933If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003934will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003935may be skipped by setting the appropriate 'ethmacskip' environment variable.
3936The naming convention is as follows:
3937"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk6c59edc2004-05-03 20:45:30 +00003939Image Formats:
3940==============
wdenkc6097192002-11-03 00:24:07 +00003941
Marian Balakowicz18710b82008-03-12 12:13:13 +01003942U-Boot is capable of booting (and performing other auxiliary operations on)
3943images in two formats:
3944
3945New uImage format (FIT)
3946-----------------------
3947
3948Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3949to Flattened Device Tree). It allows the use of images with multiple
3950components (several kernels, ramdisks, etc.), with contents protected by
3951SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3952
3953
3954Old uImage format
3955-----------------
3956
3957Old image format is based on binary files which can be basically anything,
3958preceded by a special header; see the definitions in include/image.h for
3959details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk6c59edc2004-05-03 20:45:30 +00003961* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3962 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003963 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3964 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3965 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003966* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003967 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03003968 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003969* Compression Type (uncompressed, gzip, bzip2)
3970* Load Address
3971* Entry Point
3972* Image Name
3973* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk6c59edc2004-05-03 20:45:30 +00003975The header is marked by a special Magic Number, and both the header
3976and the data portions of the image are secured against corruption by
3977CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003978
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk6c59edc2004-05-03 20:45:30 +00003980Linux Support:
3981==============
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk6c59edc2004-05-03 20:45:30 +00003983Although U-Boot should support any OS or standalone application
3984easily, the main focus has always been on Linux during the design of
3985U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk6c59edc2004-05-03 20:45:30 +00003987U-Boot includes many features that so far have been part of some
3988special "boot loader" code within the Linux kernel. Also, any
3989"initrd" images to be used are no longer part of one big Linux image;
3990instead, kernel and "initrd" are separate images. This implementation
3991serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003992
wdenk6c59edc2004-05-03 20:45:30 +00003993- the same features can be used for other OS or standalone
3994 applications (for instance: using compressed images to reduce the
3995 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003996
wdenk6c59edc2004-05-03 20:45:30 +00003997- it becomes much easier to port new Linux kernel versions because
3998 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk6c59edc2004-05-03 20:45:30 +00004000- the same Linux kernel image can now be used with different "initrd"
4001 images; of course this also means that different kernel images can
4002 be run with the same "initrd". This makes testing easier (you don't
4003 have to build a new "zImage.initrd" Linux image when you just
4004 change a file in your "initrd"). Also, a field-upgrade of the
4005 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004006
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk6c59edc2004-05-03 20:45:30 +00004008Linux HOWTO:
4009============
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011Porting Linux to U-Boot based systems:
4012---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004013
wdenk6c59edc2004-05-03 20:45:30 +00004014U-Boot cannot save you from doing all the necessary modifications to
4015configure the Linux device drivers for use with your target hardware
4016(no, we don't intend to provide a full virtual machine interface to
4017Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004018
Stefan Roese88fbf932010-04-15 16:07:28 +02004019But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk6c59edc2004-05-03 20:45:30 +00004021Just make sure your machine specific header file (for instance
4022include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004023Information structure as we define in include/asm-<arch>/u-boot.h,
4024and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004025as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004026
Simon Glassd097e592014-06-11 23:29:46 -06004027Note that U-Boot now has a driver model, a unified model for drivers.
4028If you are adding a new driver, plumb it into driver model. If there
4029is no uclass available, you are encouraged to create one. See
4030doc/driver-model.
4031
wdenkc6097192002-11-03 00:24:07 +00004032
wdenk6c59edc2004-05-03 20:45:30 +00004033Configuring the Linux kernel:
4034-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk6c59edc2004-05-03 20:45:30 +00004036No specific requirements for U-Boot. Make sure you have some root
4037device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004038
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk6c59edc2004-05-03 20:45:30 +00004040Building a Linux Image:
4041-----------------------
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk6c59edc2004-05-03 20:45:30 +00004043With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4044not used. If you use recent kernel source, a new build target
4045"uImage" will exist which automatically builds an image usable by
4046U-Boot. Most older kernels also have support for a "pImage" target,
4047which was introduced for our predecessor project PPCBoot and uses a
4048100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk6c59edc2004-05-03 20:45:30 +00004050Example:
wdenkc6097192002-11-03 00:24:07 +00004051
Holger Freyther7ba4e572014-08-04 09:26:05 +02004052 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004053 make oldconfig
4054 make dep
4055 make uImage
wdenkc6097192002-11-03 00:24:07 +00004056
wdenk6c59edc2004-05-03 20:45:30 +00004057The "uImage" build target uses a special tool (in 'tools/mkimage') to
4058encapsulate a compressed Linux kernel image with header information,
4059CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004060
wdenk6c59edc2004-05-03 20:45:30 +00004061* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004062
wdenk6c59edc2004-05-03 20:45:30 +00004063* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk6c59edc2004-05-03 20:45:30 +00004065 ${CROSS_COMPILE}-objcopy -O binary \
4066 -R .note -R .comment \
4067 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004068
wdenk6c59edc2004-05-03 20:45:30 +00004069* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004070
wdenk6c59edc2004-05-03 20:45:30 +00004071 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004072
wdenk6c59edc2004-05-03 20:45:30 +00004073* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004074
wdenk6c59edc2004-05-03 20:45:30 +00004075 mkimage -A ppc -O linux -T kernel -C gzip \
4076 -a 0 -e 0 -n "Linux Kernel Image" \
4077 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004078
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk6c59edc2004-05-03 20:45:30 +00004080The "mkimage" tool can also be used to create ramdisk images for use
4081with U-Boot, either separated from the Linux kernel image, or
4082combined into one file. "mkimage" encapsulates the images with a 64
4083byte header containing information about target architecture,
4084operating system, image type, compression method, entry points, time
4085stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk6c59edc2004-05-03 20:45:30 +00004087"mkimage" can be called in two ways: to verify existing images and
4088print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004089
wdenk6c59edc2004-05-03 20:45:30 +00004090In the first form (with "-l" option) mkimage lists the information
4091contained in the header of an existing U-Boot image; this includes
4092checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004093
wdenk6c59edc2004-05-03 20:45:30 +00004094 tools/mkimage -l image
4095 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004096
wdenk6c59edc2004-05-03 20:45:30 +00004097The second form (with "-d" option) is used to build a U-Boot image
4098from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004099
wdenk6c59edc2004-05-03 20:45:30 +00004100 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4101 -n name -d data_file image
4102 -A ==> set architecture to 'arch'
4103 -O ==> set operating system to 'os'
4104 -T ==> set image type to 'type'
4105 -C ==> set compression type 'comp'
4106 -a ==> set load address to 'addr' (hex)
4107 -e ==> set entry point to 'ep' (hex)
4108 -n ==> set image name to 'name'
4109 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004110
wdenkcd914452004-05-29 16:53:29 +00004111Right now, all Linux kernels for PowerPC systems use the same load
4112address (0x00000000), but the entry point address depends on the
4113kernel version:
wdenkc6097192002-11-03 00:24:07 +00004114
wdenk6c59edc2004-05-03 20:45:30 +00004115- 2.2.x kernels have the entry point at 0x0000000C,
4116- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk6c59edc2004-05-03 20:45:30 +00004118So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk6c59edc2004-05-03 20:45:30 +00004120 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4121 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004122 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004123 > examples/uImage.TQM850L
4124 Image Name: 2.4.4 kernel for TQM850L
4125 Created: Wed Jul 19 02:34:59 2000
4126 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4127 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4128 Load Address: 0x00000000
4129 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk6c59edc2004-05-03 20:45:30 +00004133 -> tools/mkimage -l examples/uImage.TQM850L
4134 Image Name: 2.4.4 kernel for TQM850L
4135 Created: Wed Jul 19 02:34:59 2000
4136 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4137 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4138 Load Address: 0x00000000
4139 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk6c59edc2004-05-03 20:45:30 +00004141NOTE: for embedded systems where boot time is critical you can trade
4142speed for memory and install an UNCOMPRESSED image instead: this
4143needs more space in Flash, but boots much faster since it does not
4144need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004145
Stefan Roese88fbf932010-04-15 16:07:28 +02004146 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004147 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4148 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004149 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004150 > examples/uImage.TQM850L-uncompressed
4151 Image Name: 2.4.4 kernel for TQM850L
4152 Created: Wed Jul 19 02:34:59 2000
4153 Image Type: PowerPC Linux Kernel Image (uncompressed)
4154 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4155 Load Address: 0x00000000
4156 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004157
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk6c59edc2004-05-03 20:45:30 +00004159Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4160when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk6c59edc2004-05-03 20:45:30 +00004162 -> tools/mkimage -n 'Simple Ramdisk Image' \
4163 > -A ppc -O linux -T ramdisk -C gzip \
4164 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4165 Image Name: Simple Ramdisk Image
4166 Created: Wed Jan 12 14:01:50 2000
4167 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4168 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4169 Load Address: 0x00000000
4170 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004171
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004172The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4173option performs the converse operation of the mkimage's second form (the "-d"
4174option). Given an image built by mkimage, the dumpimage extracts a "data file"
4175from the image:
4176
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004177 tools/dumpimage -i image -T type -p position data_file
4178 -i ==> extract from the 'image' a specific 'data_file'
4179 -T ==> set image type to 'type'
4180 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004181
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk6c59edc2004-05-03 20:45:30 +00004183Installing a Linux Image:
4184-------------------------
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk6c59edc2004-05-03 20:45:30 +00004186To downloading a U-Boot image over the serial (console) interface,
4187you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk6c59edc2004-05-03 20:45:30 +00004189 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004190
wdenk6c59edc2004-05-03 20:45:30 +00004191The 'objcopy' does not understand the information in the U-Boot
4192image header, so the resulting S-Record file will be relative to
4193address 0x00000000. To load it to a given address, you need to
4194specify the target address as 'offset' parameter with the 'loads'
4195command.
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk6c59edc2004-05-03 20:45:30 +00004197Example: install the image to address 0x40100000 (which on the
4198TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004199
wdenk6c59edc2004-05-03 20:45:30 +00004200 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004201
wdenk6c59edc2004-05-03 20:45:30 +00004202 .......... done
4203 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004204
wdenk6c59edc2004-05-03 20:45:30 +00004205 => loads 40100000
4206 ## Ready for S-Record download ...
4207 ~>examples/image.srec
4208 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4209 ...
4210 15989 15990 15991 15992
4211 [file transfer complete]
4212 [connected]
4213 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004214
wdenkc6097192002-11-03 00:24:07 +00004215
wdenk6c59edc2004-05-03 20:45:30 +00004216You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004217this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004218corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004219
wdenk6c59edc2004-05-03 20:45:30 +00004220 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004221
wdenk6c59edc2004-05-03 20:45:30 +00004222 ## Checking Image at 40100000 ...
4223 Image Name: 2.2.13 for initrd on TQM850L
4224 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4225 Data Size: 335725 Bytes = 327 kB = 0 MB
4226 Load Address: 00000000
4227 Entry Point: 0000000c
4228 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004229
4230
wdenk6c59edc2004-05-03 20:45:30 +00004231Boot Linux:
4232-----------
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk6c59edc2004-05-03 20:45:30 +00004234The "bootm" command is used to boot an application that is stored in
4235memory (RAM or Flash). In case of a Linux kernel image, the contents
4236of the "bootargs" environment variable is passed to the kernel as
4237parameters. You can check and modify this variable using the
4238"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004239
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk6c59edc2004-05-03 20:45:30 +00004241 => printenv bootargs
4242 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004243
wdenk6c59edc2004-05-03 20:45:30 +00004244 => 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 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246 => printenv bootargs
4247 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 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249 => bootm 40020000
4250 ## Booting Linux kernel at 40020000 ...
4251 Image Name: 2.2.13 for NFS on TQM850L
4252 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4253 Data Size: 381681 Bytes = 372 kB = 0 MB
4254 Load Address: 00000000
4255 Entry Point: 0000000c
4256 Verifying Checksum ... OK
4257 Uncompressing Kernel Image ... OK
4258 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
4259 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4260 time_init: decrementer frequency = 187500000/60
4261 Calibrating delay loop... 49.77 BogoMIPS
4262 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4263 ...
wdenkc6097192002-11-03 00:24:07 +00004264
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004265If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004266the memory addresses of both the kernel and the initrd image (PPBCOOT
4267format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk6c59edc2004-05-03 20:45:30 +00004269 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271 ## Checking Image at 40100000 ...
4272 Image Name: 2.2.13 for initrd on TQM850L
4273 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4274 Data Size: 335725 Bytes = 327 kB = 0 MB
4275 Load Address: 00000000
4276 Entry Point: 0000000c
4277 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279 ## Checking Image at 40200000 ...
4280 Image Name: Simple Ramdisk Image
4281 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4282 Data Size: 566530 Bytes = 553 kB = 0 MB
4283 Load Address: 00000000
4284 Entry Point: 00000000
4285 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk6c59edc2004-05-03 20:45:30 +00004287 => bootm 40100000 40200000
4288 ## Booting Linux kernel at 40100000 ...
4289 Image Name: 2.2.13 for initrd on TQM850L
4290 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4291 Data Size: 335725 Bytes = 327 kB = 0 MB
4292 Load Address: 00000000
4293 Entry Point: 0000000c
4294 Verifying Checksum ... OK
4295 Uncompressing Kernel Image ... OK
4296 ## Loading RAMDisk Image at 40200000 ...
4297 Image Name: Simple Ramdisk Image
4298 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4299 Data Size: 566530 Bytes = 553 kB = 0 MB
4300 Load Address: 00000000
4301 Entry Point: 00000000
4302 Verifying Checksum ... OK
4303 Loading Ramdisk ... OK
4304 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
4305 Boot arguments: root=/dev/ram
4306 time_init: decrementer frequency = 187500000/60
4307 Calibrating delay loop... 49.77 BogoMIPS
4308 ...
4309 RAMDISK: Compressed image found at block 0
4310 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004311
wdenk6c59edc2004-05-03 20:45:30 +00004312 bash#
wdenkc6097192002-11-03 00:24:07 +00004313
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004314Boot Linux and pass a flat device tree:
4315-----------
4316
4317First, U-Boot must be compiled with the appropriate defines. See the section
4318titled "Linux Kernel Interface" above for a more in depth explanation. The
4319following is an example of how to start a kernel and pass an updated
4320flat device tree:
4321
4322=> print oftaddr
4323oftaddr=0x300000
4324=> print oft
4325oft=oftrees/mpc8540ads.dtb
4326=> tftp $oftaddr $oft
4327Speed: 1000, full duplex
4328Using TSEC0 device
4329TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4330Filename 'oftrees/mpc8540ads.dtb'.
4331Load address: 0x300000
4332Loading: #
4333done
4334Bytes transferred = 4106 (100a hex)
4335=> tftp $loadaddr $bootfile
4336Speed: 1000, full duplex
4337Using TSEC0 device
4338TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4339Filename 'uImage'.
4340Load address: 0x200000
4341Loading:############
4342done
4343Bytes transferred = 1029407 (fb51f hex)
4344=> print loadaddr
4345loadaddr=200000
4346=> print oftaddr
4347oftaddr=0x300000
4348=> bootm $loadaddr - $oftaddr
4349## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004350 Image Name: Linux-2.6.17-dirty
4351 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4352 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004353 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004354 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004355 Verifying Checksum ... OK
4356 Uncompressing Kernel Image ... OK
4357Booting using flat device tree at 0x300000
4358Using MPC85xx ADS machine description
4359Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4360[snip]
4361
4362
wdenk6c59edc2004-05-03 20:45:30 +00004363More About U-Boot Image Types:
4364------------------------------
wdenkc6097192002-11-03 00:24:07 +00004365
wdenk6c59edc2004-05-03 20:45:30 +00004366U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004367
wdenk6c59edc2004-05-03 20:45:30 +00004368 "Standalone Programs" are directly runnable in the environment
4369 provided by U-Boot; it is expected that (if they behave
4370 well) you can continue to work in U-Boot after return from
4371 the Standalone Program.
4372 "OS Kernel Images" are usually images of some Embedded OS which
4373 will take over control completely. Usually these programs
4374 will install their own set of exception handlers, device
4375 drivers, set up the MMU, etc. - this means, that you cannot
4376 expect to re-enter U-Boot except by resetting the CPU.
4377 "RAMDisk Images" are more or less just data blocks, and their
4378 parameters (address, size) are passed to an OS kernel that is
4379 being started.
4380 "Multi-File Images" contain several images, typically an OS
4381 (Linux) kernel image and one or more data images like
4382 RAMDisks. This construct is useful for instance when you want
4383 to boot over the network using BOOTP etc., where the boot
4384 server provides just a single image file, but you want to get
4385 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk6c59edc2004-05-03 20:45:30 +00004387 "Multi-File Images" start with a list of image sizes, each
4388 image size (in bytes) specified by an "uint32_t" in network
4389 byte order. This list is terminated by an "(uint32_t)0".
4390 Immediately after the terminating 0 follow the images, one by
4391 one, all aligned on "uint32_t" boundaries (size rounded up to
4392 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk6c59edc2004-05-03 20:45:30 +00004394 "Firmware Images" are binary images containing firmware (like
4395 U-Boot or FPGA images) which usually will be programmed to
4396 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004397
wdenk6c59edc2004-05-03 20:45:30 +00004398 "Script files" are command sequences that will be executed by
4399 U-Boot's command interpreter; this feature is especially
4400 useful when you configure U-Boot to use a real shell (hush)
4401 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004402
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004403Booting the Linux zImage:
4404-------------------------
4405
4406On some platforms, it's possible to boot Linux zImage. This is done
4407using the "bootz" command. The syntax of "bootz" command is the same
4408as the syntax of "bootm" command.
4409
Tom Rini45f46d12013-05-16 11:40:11 -04004410Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004411kernel with raw initrd images. The syntax is slightly different, the
4412address of the initrd must be augmented by it's size, in the following
4413format: "<initrd addres>:<initrd size>".
4414
stroeseb9c17c52003-04-04 15:53:41 +00004415
wdenk6c59edc2004-05-03 20:45:30 +00004416Standalone HOWTO:
4417=================
stroeseb9c17c52003-04-04 15:53:41 +00004418
wdenk6c59edc2004-05-03 20:45:30 +00004419One of the features of U-Boot is that you can dynamically load and
4420run "standalone" applications, which can use some resources of
4421U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004422
wdenk6c59edc2004-05-03 20:45:30 +00004423Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425"Hello World" Demo:
4426-------------------
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk6c59edc2004-05-03 20:45:30 +00004428'examples/hello_world.c' contains a small "Hello World" Demo
4429application; it is automatically compiled when you build U-Boot.
4430It's configured to run at address 0x00040004, so you can play with it
4431like that:
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk6c59edc2004-05-03 20:45:30 +00004433 => loads
4434 ## Ready for S-Record download ...
4435 ~>examples/hello_world.srec
4436 1 2 3 4 5 6 7 8 9 10 11 ...
4437 [file transfer complete]
4438 [connected]
4439 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004440
wdenk6c59edc2004-05-03 20:45:30 +00004441 => go 40004 Hello World! This is a test.
4442 ## Starting application at 0x00040004 ...
4443 Hello World
4444 argc = 7
4445 argv[0] = "40004"
4446 argv[1] = "Hello"
4447 argv[2] = "World!"
4448 argv[3] = "This"
4449 argv[4] = "is"
4450 argv[5] = "a"
4451 argv[6] = "test."
4452 argv[7] = "<NULL>"
4453 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk6c59edc2004-05-03 20:45:30 +00004455 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk6c59edc2004-05-03 20:45:30 +00004457Another example, which demonstrates how to register a CPM interrupt
4458handler with the U-Boot code, can be found in 'examples/timer.c'.
4459Here, a CPM timer is set up to generate an interrupt every second.
4460The interrupt service routine is trivial, just printing a '.'
4461character, but this is just a demo program. The application can be
4462controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk6c59edc2004-05-03 20:45:30 +00004464 ? - print current values og the CPM Timer registers
4465 b - enable interrupts and start timer
4466 e - stop timer and disable interrupts
4467 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004468
wdenk6c59edc2004-05-03 20:45:30 +00004469 => loads
4470 ## Ready for S-Record download ...
4471 ~>examples/timer.srec
4472 1 2 3 4 5 6 7 8 9 10 11 ...
4473 [file transfer complete]
4474 [connected]
4475 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk6c59edc2004-05-03 20:45:30 +00004477 => go 40004
4478 ## Starting application at 0x00040004 ...
4479 TIMERS=0xfff00980
4480 Using timer 1
4481 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk6c59edc2004-05-03 20:45:30 +00004483Hit 'b':
4484 [q, b, e, ?] Set interval 1000000 us
4485 Enabling timer
4486Hit '?':
4487 [q, b, e, ?] ........
4488 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4489Hit '?':
4490 [q, b, e, ?] .
4491 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4492Hit '?':
4493 [q, b, e, ?] .
4494 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4495Hit '?':
4496 [q, b, e, ?] .
4497 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4498Hit 'e':
4499 [q, b, e, ?] ...Stopping timer
4500Hit 'q':
4501 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004502
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk6c59edc2004-05-03 20:45:30 +00004504Minicom warning:
4505================
wdenkc6097192002-11-03 00:24:07 +00004506
wdenk6c59edc2004-05-03 20:45:30 +00004507Over time, many people have reported problems when trying to use the
4508"minicom" terminal emulation program for serial download. I (wd)
4509consider minicom to be broken, and recommend not to use it. Under
4510Unix, I recommend to use C-Kermit for general purpose use (and
4511especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004512use "cu" for S-Record download ("loads" command). See
4513http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4514for help with kermit.
4515
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517Nevertheless, if you absolutely want to use it try adding this
4518configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520 Name Program Name U/D FullScr IO-Red. Multi
4521 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4522 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004523
wdenk8dba0502003-03-31 16:34:49 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525NetBSD Notes:
4526=============
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk6c59edc2004-05-03 20:45:30 +00004528Starting at version 0.9.2, U-Boot supports NetBSD both as host
4529(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004530
wdenk6c59edc2004-05-03 20:45:30 +00004531Building requires a cross environment; it is known to work on
4532NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4533need gmake since the Makefiles are not compatible with BSD make).
4534Note that the cross-powerpc package does not install include files;
4535attempting to build U-Boot will fail because <machine/ansi.h> is
4536missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004537
wdenk6c59edc2004-05-03 20:45:30 +00004538 # cd /usr/pkg/cross/powerpc-netbsd/include
4539 # mkdir powerpc
4540 # ln -s powerpc machine
4541 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4542 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544Native builds *don't* work due to incompatibilities between native
4545and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547Booting assumes that (the first part of) the image booted is a
4548stage-2 loader which in turn loads and then invokes the kernel
4549proper. Loader sources will eventually appear in the NetBSD source
4550tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004551meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004552
wdenkc6097192002-11-03 00:24:07 +00004553
wdenk6c59edc2004-05-03 20:45:30 +00004554Implementation Internals:
4555=========================
wdenkc6097192002-11-03 00:24:07 +00004556
wdenk6c59edc2004-05-03 20:45:30 +00004557The following is not intended to be a complete description of every
4558implementation detail. However, it should help to understand the
4559inner workings of U-Boot and make it easier to port it to custom
4560hardware.
wdenkc6097192002-11-03 00:24:07 +00004561
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk6c59edc2004-05-03 20:45:30 +00004563Initial Stack, Global Data:
4564---------------------------
wdenkc6097192002-11-03 00:24:07 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566The implementation of U-Boot is complicated by the fact that U-Boot
4567starts running out of ROM (flash memory), usually without access to
4568system RAM (because the memory controller is not initialized yet).
4569This means that we don't have writable Data or BSS segments, and BSS
4570is not initialized as zero. To be able to get a C environment working
4571at all, we have to allocate at least a minimal stack. Implementation
4572options for this are defined and restricted by the CPU used: Some CPU
4573models provide on-chip memory (like the IMMR area on MPC8xx and
4574MPC826x processors), on others (parts of) the data cache can be
4575locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004576
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004577 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004578 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk6c59edc2004-05-03 20:45:30 +00004580 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4581 From: "Chris Hallinan" <clh@net1plus.com>
4582 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4583 ...
wdenkc6097192002-11-03 00:24:07 +00004584
wdenk6c59edc2004-05-03 20:45:30 +00004585 Correct me if I'm wrong, folks, but the way I understand it
4586 is this: Using DCACHE as initial RAM for Stack, etc, does not
4587 require any physical RAM backing up the cache. The cleverness
4588 is that the cache is being used as a temporary supply of
4589 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004590 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004591 can see how this works by studying the cache architecture and
4592 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk6c59edc2004-05-03 20:45:30 +00004594 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4595 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004596 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004597 option should work for you. Using CS 4 should be fine if your
4598 board designers haven't used it for something that would
4599 cause you grief during the initial boot! It is frequently not
4600 used.
wdenkc6097192002-11-03 00:24:07 +00004601
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004602 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004603 with your processor/board/system design. The default value
4604 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004605 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004606 than your SDRAM module. If you have a 64MB SDRAM module, set
4607 it above 400_0000. Just make sure your board has no resources
4608 that are supposed to respond to that address! That code in
4609 start.S has been around a while and should work as is when
4610 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004611
wdenk6c59edc2004-05-03 20:45:30 +00004612 -Chris Hallinan
4613 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004614
wdenk6c59edc2004-05-03 20:45:30 +00004615It is essential to remember this, since it has some impact on the C
4616code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004617
wdenk6c59edc2004-05-03 20:45:30 +00004618* Initialized global data (data segment) is read-only. Do not attempt
4619 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004620
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004621* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004622 as zero data - BSS segment) at all - this is undefined, initiali-
4623 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004624
wdenk6c59edc2004-05-03 20:45:30 +00004625* Stack space is very limited. Avoid big data buffers or things like
4626 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004627
wdenk6c59edc2004-05-03 20:45:30 +00004628Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004629normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004630turned out that the implementation of U-Boot can be greatly
4631simplified by making a global data structure (gd_t) available to all
4632functions. We could pass a pointer to this data as argument to _all_
4633functions, but this would bloat the code. Instead we use a feature of
4634the GCC compiler (Global Register Variables) to share the data: we
4635place a pointer (gd) to the global data into a register which we
4636reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk6c59edc2004-05-03 20:45:30 +00004638When choosing a register for such a purpose we are restricted by the
4639relevant (E)ABI specifications for the current architecture, and by
4640GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004641
wdenk6c59edc2004-05-03 20:45:30 +00004642For PowerPC, the following registers have specific use:
4643 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004644 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004645 R3-R4: parameter passing and return values
4646 R5-R10: parameter passing
4647 R13: small data area pointer
4648 R30: GOT pointer
4649 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004650
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004651 (U-Boot also uses R12 as internal GOT pointer. r12
4652 is a volatile register so r12 needs to be reset when
4653 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004654
Wolfgang Denk69c09642008-02-14 22:43:22 +01004655 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657 Note: on PPC, we could use a static initializer (since the
4658 address of the global data structure is known at compile time),
4659 but it turned out that reserving a register results in somewhat
4660 smaller code - although the code savings are not that big (on
4661 average for all boards 752 bytes for the whole U-Boot image,
4662 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666 R0: function argument word/integer result
4667 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004668 R9: platform specific
4669 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004670 R11: argument (frame) pointer
4671 R12: temporary workspace
4672 R13: stack pointer
4673 R14: link register
4674 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004675
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004676 ==> U-Boot will use R9 to hold a pointer to the global data
4677
4678 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004679
Thomas Chou8fa38582010-05-21 11:08:03 +08004680On Nios II, the ABI is documented here:
4681 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4682
4683 ==> U-Boot will use gp to hold a pointer to the global data
4684
4685 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4686 to access small data sections, so gp is free.
4687
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004688On NDS32, the following registers are used:
4689
4690 R0-R1: argument/return
4691 R2-R5: argument
4692 R15: temporary register for assembler
4693 R16: trampoline register
4694 R28: frame pointer (FP)
4695 R29: global pointer (GP)
4696 R30: link register (LP)
4697 R31: stack pointer (SP)
4698 PC: program counter (PC)
4699
4700 ==> U-Boot will use R10 to hold a pointer to the global data
4701
Wolfgang Denk6405a152006-03-31 18:32:53 +02004702NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4703or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004704
Rick Chend7e6f922017-12-26 13:55:59 +08004705On RISC-V, the following registers are used:
4706
4707 x0: hard-wired zero (zero)
4708 x1: return address (ra)
4709 x2: stack pointer (sp)
4710 x3: global pointer (gp)
4711 x4: thread pointer (tp)
4712 x5: link register (t0)
4713 x8: frame pointer (fp)
4714 x10-x11: arguments/return values (a0-1)
4715 x12-x17: arguments (a2-7)
4716 x28-31: temporaries (t3-6)
4717 pc: program counter (pc)
4718
4719 ==> U-Boot will use gp to hold a pointer to the global data
4720
wdenk6c59edc2004-05-03 20:45:30 +00004721Memory Management:
4722------------------
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk6c59edc2004-05-03 20:45:30 +00004724U-Boot runs in system state and uses physical addresses, i.e. the
4725MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk6c59edc2004-05-03 20:45:30 +00004727The available memory is mapped to fixed addresses using the memory
4728controller. In this process, a contiguous block is formed for each
4729memory type (Flash, SDRAM, SRAM), even when it consists of several
4730physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk6c59edc2004-05-03 20:45:30 +00004732U-Boot is installed in the first 128 kB of the first Flash bank (on
4733TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4734booting and sizing and initializing DRAM, the code relocates itself
4735to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004736memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004737configuration setting]. Below that, a structure with global Board
4738Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740Additionally, some exception handler code is copied to the low 8 kB
4741of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004742
wdenk6c59edc2004-05-03 20:45:30 +00004743So a typical memory configuration with 16 MB of DRAM could look like
4744this:
wdenkc6097192002-11-03 00:24:07 +00004745
wdenk6c59edc2004-05-03 20:45:30 +00004746 0x0000 0000 Exception Vector code
4747 :
4748 0x0000 1FFF
4749 0x0000 2000 Free for Application Use
4750 :
4751 :
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk6c59edc2004-05-03 20:45:30 +00004753 :
4754 :
4755 0x00FB FF20 Monitor Stack (Growing downward)
4756 0x00FB FFAC Board Info Data and permanent copy of global data
4757 0x00FC 0000 Malloc Arena
4758 :
4759 0x00FD FFFF
4760 0x00FE 0000 RAM Copy of Monitor Code
4761 ... eventually: LCD or video framebuffer
4762 ... eventually: pRAM (Protected RAM - unchanged by reset)
4763 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004764
wdenkc6097192002-11-03 00:24:07 +00004765
wdenk6c59edc2004-05-03 20:45:30 +00004766System Initialization:
4767----------------------
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004770(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004771configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00004772To be able to re-map memory U-Boot then jumps to its link address.
4773To be able to implement the initialization code in C, a (small!)
4774initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02004775which provide such a feature like), or in a locked part of the data
4776cache. After that, U-Boot initializes the CPU core, the caches and
4777the SIU.
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779Next, all (potentially) available memory banks are mapped using a
4780preliminary mapping. For example, we put them on 512 MB boundaries
4781(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4782on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4783programmed for SDRAM access. Using the temporary configuration, a
4784simple memory test is run that determines the size of the SDRAM
4785banks.
wdenkc6097192002-11-03 00:24:07 +00004786
wdenk6c59edc2004-05-03 20:45:30 +00004787When there is more than one SDRAM bank, and the banks are of
4788different size, the largest is mapped first. For equal size, the first
4789bank (CS2#) is mapped first. The first mapping is always for address
47900x00000000, with any additional banks following immediately to create
4791contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk6c59edc2004-05-03 20:45:30 +00004793Then, the monitor installs itself at the upper end of the SDRAM area
4794and allocates memory for use by malloc() and for the global Board
4795Info data; also, the exception vector code is copied to the low RAM
4796pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004797
wdenk6c59edc2004-05-03 20:45:30 +00004798Only after this relocation will you have a "normal" C environment;
4799until that you are restricted in several ways, mostly because you are
4800running from ROM, and because the code will have to be relocated to a
4801new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004802
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk6c59edc2004-05-03 20:45:30 +00004804U-Boot Porting Guide:
4805----------------------
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk6c59edc2004-05-03 20:45:30 +00004807[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4808list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004809
wdenkc6097192002-11-03 00:24:07 +00004810
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004811int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004812{
4813 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004814
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004815 signal(SIGALRM, no_more_time);
4816 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004819 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004820 return 0;
4821 }
wdenkc6097192002-11-03 00:24:07 +00004822
wdenk6c59edc2004-05-03 20:45:30 +00004823 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004824
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004825 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004826
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004827 if (clueless)
4828 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk6c59edc2004-05-03 20:45:30 +00004830 while (learning) {
4831 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004832 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4833 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004834 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004835 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004836 }
wdenkc6097192002-11-03 00:24:07 +00004837
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004838 if (available_money > toLocalCurrency ($2500))
4839 Buy a BDI3000;
4840 else
wdenk6c59edc2004-05-03 20:45:30 +00004841 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004842
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004843 if (a similar board exists) { /* hopefully... */
4844 cp -a board/<similar> board/<myboard>
4845 cp include/configs/<similar>.h include/configs/<myboard>.h
4846 } else {
4847 Create your own board support subdirectory;
4848 Create your own board include/configs/<myboard>.h file;
4849 }
4850 Edit new board/<myboard> files
4851 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004852
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004853 while (!accepted) {
4854 while (!running) {
4855 do {
4856 Add / modify source code;
4857 } until (compiles);
4858 Debug;
4859 if (clueless)
4860 email("Hi, I am having problems...");
4861 }
4862 Send patch file to the U-Boot email list;
4863 if (reasonable critiques)
4864 Incorporate improvements from email list code review;
4865 else
4866 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004867 }
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk6c59edc2004-05-03 20:45:30 +00004869 return 0;
4870}
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk6c59edc2004-05-03 20:45:30 +00004872void no_more_time (int sig)
4873{
4874 hire_a_guru();
4875}
wdenkc6097192002-11-03 00:24:07 +00004876
wdenkc6097192002-11-03 00:24:07 +00004877
wdenk6c59edc2004-05-03 20:45:30 +00004878Coding Standards:
4879-----------------
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02004882coding style; see the kernel coding style guide at
4883https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4884script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004885
4886Source files originating from a different project (for example the
4887MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004888reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02004889sources.
wdenkc6097192002-11-03 00:24:07 +00004890
Detlev Zundelaa63d482006-09-01 15:39:02 +02004891Please note that U-Boot is implemented in C (and to some small parts in
4892Assembler); no C++ is used, so please do not use C++ style comments (//)
4893in your code.
wdenkad276f22004-01-04 16:28:35 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895Please also stick to the following formatting rules:
4896- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004897- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004898- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004899- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004900- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004901
wdenk6c59edc2004-05-03 20:45:30 +00004902Submissions which do not conform to the standards may be returned
4903with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004904
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906Submitting Patches:
4907-------------------
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909Since the number of patches for U-Boot is growing, we need to
4910establish some rules. Submissions which do not conform to these rules
4911may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004912
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004913Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004914
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004915Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08004916see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004917
wdenk6c59edc2004-05-03 20:45:30 +00004918When you send a patch, please include the following information with
4919it:
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921* For bug fixes: a description of the bug and how your patch fixes
4922 this bug. Please try to include a way of demonstrating that the
4923 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk6c59edc2004-05-03 20:45:30 +00004925* For new features: a description of the feature and your
4926 implementation.
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk6c59edc2004-05-03 20:45:30 +00004928* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004929
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05004930* For major contributions, add a MAINTAINERS file with your
4931 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00004932
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02004933* When you add support for a new board, don't forget to add a
4934 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk6c59edc2004-05-03 20:45:30 +00004936* If your patch adds new configuration options, don't forget to
4937 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004938
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004939* The patch itself. If you are using git (which is *strongly*
4940 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004941 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004942 the U-Boot mailing list, you will avoid most of the common problems
4943 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004944
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004945 If you cannot use git, use "diff -purN OLD NEW". If your version of
4946 diff does not support these options, then get the latest version of
4947 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004948
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004949 The current directory when running this command shall be the parent
4950 directory of the U-Boot source tree (i. e. please make sure that
4951 your patch includes sufficient directory information for the
4952 affected files).
4953
4954 We prefer patches as plain text. MIME attachments are discouraged,
4955 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957* If one logical set of modifications affects or creates several
4958 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960* Changesets that contain different, unrelated modifications shall be
4961 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004962
wdenkc6097192002-11-03 00:24:07 +00004963
wdenk6c59edc2004-05-03 20:45:30 +00004964Notes:
wdenkc6097192002-11-03 00:24:07 +00004965
Simon Glassdc27def2016-07-27 20:33:08 -06004966* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00004967 source tree and make sure that no errors or warnings are reported
4968 for any of the boards.
4969
4970* Keep your modifications to the necessary minimum: A patch
4971 containing several unrelated changes or arbitrary reformats will be
4972 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974* If you modify existing code, make sure that your new code does not
4975 add to the memory footprint of the code ;-) Small is beautiful!
4976 When adding new features, these should compile conditionally only
4977 (using #ifdef), and the resulting code with the new feature
4978 disabled must not need more memory than the old code without your
4979 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004980
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004981* Remember that there is a size limit of 100 kB per message on the
4982 u-boot mailing list. Bigger patches will be moderated. If they are
4983 reasonable and not too big, they will be acknowledged. But patches
4984 bigger than the size limit should be avoided.