blob: a514f48caefc68b8453b8cc7ce0da3581f3504a8 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denkeca3aeb2013-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
wdenke86e5a02004-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. Day7207b362015-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. Day7207b362015-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. Dayadb9d852012-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. Day7207b362015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-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 Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
Robert P. J. Day7207b362015-12-19 07:16:10 -050061The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500136 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500137 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000140 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400142 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200143 /powerpc Files generic to PowerPC architecture
Rick Chen3fafced2017-12-26 13:55:59 +0800144 /riscv Files generic to RISC-V architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500145 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400147 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500148/api Machine/arch independent API for external apps
149/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800150/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500151/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500152/configs Board default configuration files
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400156/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-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. Day7207b362015-12-19 07:16:10 -0500160/lib Library routines generic to all architectures
161/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500162/net Networking code
163/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500164/scripts Various build scripts and Makefiles
165/test Various unit test files
Peter Tyser8d321b82010-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200183 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000184
Robert P. J. Day7207b362015-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 Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200201 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000202
Robert P. J. Day7207b362015-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 Glass75b3c3a2014-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 Teki6b1978f2014-08-31 21:19:43 +0530215See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600216
217
Simon Glassdb910352015-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. Day7207b362015-12-19 07:16:10 -0500222SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700223
Robert P. J. Day7207b362015-12-19 07:16:10 -0500224Note: "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.
231
232Execution 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 Glassdb910352015-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 Tan0680f1b2017-05-03 17:13:32 +0800293 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-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
wdenk7f6c2cb2002-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 Kumar63b23162017-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
wdenk7f6c2cb2002-11-10 22:06:23 +0000323
Ashish Kumarc055cee2017-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 Phillips26281142007-08-10 13:28:25 -0500330- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000331
Kim Phillips26281142007-08-10 13:28:25 -0500332- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200333
Kumar Gala66412c62011-02-18 05:40:54 -0600334- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Wood33eee332012-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 Kushwaha74fa22e2013-04-16 13:27:44 +0530372 CONFIG_A003399_NOR_WORKAROUND
373 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800374 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530375
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530376 CONFIG_A008044_WORKAROUND
377 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800378 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530379
Scott Wood33eee332012-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 Jain64501c62013-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 Jain765b0bd2013-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 Jain64501c62013-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 Jain765b0bd2013-04-04 09:31:54 +0530397 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
398 This value denotes start offset of DSP CCSR space.
399
Priyanka Jainb1359912013-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 Bansalfb4a2402014-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 Menga1875592016-02-05 19:30:11 -0800407 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530408
Tang Yuantianaade2002014-04-17 15:33:46 +0800409 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800410 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800411 supported, core will start to execute uboot when wakes up.
412
Daniel Schwierzeck6cb461b2012-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 Sun5614e712013-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 Sun34e026f2014-03-27 17:54:47 -0700440 CONFIG_SYS_FSL_DDRC_GEN4
441 Freescale DDR4 controller.
442
York Sun9ac4ffb2013-09-30 14:20:51 -0700443 CONFIG_SYS_FSL_DDRC_ARM_GEN3
444 Freescale DDR3 controller for ARM-based SoCs.
445
York Sun5614e712013-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. Day62a3b7d2016-07-15 13:44:45 -0400452 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-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 Sun34e026f2014-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 Sun5614e712013-09-30 09:22:09 -0700467
Prabhakar Kushwaha1b4175d2014-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 Kushwaha1c407072017-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 Kushwahaadd63f92017-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 Kushwaha690e4252014-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 Kushwaha89ad7be2014-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 Sun4e5b1bd2014-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 Sun6b9e3092014-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 Sun6b1e1252014-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 Sun1d71efb2014-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 Kushwaha44937212015-11-09 16:42:07 +0530515 CONFIG_SYS_FSL_HAS_DP_DDR
516 Defines the SoC has DP-DDR used for DPAA.
517
Ruchika Gupta028dbb82014-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 Schwierzeck92bbd642011-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 Schwierzeck92bbd642011-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 Rieschb67d8812012-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 Sun207774b2015-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 Warren73c38932015-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
wdenk5da627a2003-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 Denk218ca722008-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
wdenk5da627a2003-10-09 20:09:04 +0000572 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
573
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800574 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-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 Barenfec6d9e2008-06-03 20:34:45 -0400578 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200579
580 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-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 Phillips3bb342f2007-08-10 14:34:14 -0500587 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400588
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200589 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600590 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200591
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200592 boards with QUICC Engines require OF_QE to set UCC MAC
593 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500594
Kumar Gala4e253132006-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
wdenk6705d812004-08-02 23:22:59 +0000599
Simon Glassc654b512014-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 Schocher3887c3f2009-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 Grinberg7eb29392011-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 Giger0b2f4ec2008-11-03 22:13:47 +0100626- vxWorks boot parameters:
627
628 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700629 environments variables: bootdev, bootfile, ipaddr, netmask,
630 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100631 It loads the vxWorks image pointed bootfile.
632
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100633 Note: If a "bootargs" environment is defined, it will overwride
634 the defaults discussed just above.
635
Aneesh V2c451f72011-06-16 23:30:47 +0000636- Cache Configuration:
637 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
638 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
639 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
640
Aneesh V93bc2192011-06-16 23:30:51 +0000641- Cache Configuration for ARM:
642 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
643 controller
644 CONFIG_SYS_PL310_BASE - Physical base address of PL310
645 controller register space
646
wdenk6705d812004-08-02 23:22:59 +0000647- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200648 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000649
650 Define this if you want support for Amba PrimeCell PL010 UARTs.
651
Andreas Engel48d01922008-09-08 14:30:53 +0200652 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000653
654 Define this if you want support for Amba PrimeCell PL011 UARTs.
655
656 CONFIG_PL011_CLOCK
657
658 If you have Amba PrimeCell PL011 UARTs, set this variable to
659 the clock speed of the UARTs.
660
661 CONFIG_PL01x_PORTS
662
663 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
664 define this to a list of base addresses for each (supported)
665 port. See e.g. include/configs/versatile.h
666
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400667 CONFIG_SERIAL_HW_FLOW_CONTROL
668
669 Define this variable to enable hw flow control in serial driver.
670 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000671
wdenkc6097192002-11-03 00:24:07 +0000672- Console Baudrate:
673 CONFIG_BAUDRATE - in bps
674 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200675 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000676
wdenkc6097192002-11-03 00:24:07 +0000677- Autoboot Command:
678 CONFIG_BOOTCOMMAND
679 Only needed when CONFIG_BOOTDELAY is enabled;
680 define a command string that is automatically executed
681 when no character is read on the console interface
682 within "Boot Delay" after reset.
683
wdenkc6097192002-11-03 00:24:07 +0000684 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000685 The value of these goes into the environment as
686 "ramboot" and "nfsboot" respectively, and can be used
687 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200688 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000689
wdenkc6097192002-11-03 00:24:07 +0000690- Serial Download Echo Mode:
691 CONFIG_LOADS_ECHO
692 If defined to 1, all characters received during a
693 serial download (using the "loads" command) are
694 echoed back. This might be needed by some terminal
695 emulations (like "cu"), but may as well just take
696 time on others. This setting #define's the initial
697 value of the "loads_echo" environment variable.
698
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500699- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000700 CONFIG_KGDB_BAUDRATE
701 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200702 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000703
Simon Glass302a6482016-03-13 19:07:28 -0600704- Removal of commands
705 If no commands are needed to boot, you can disable
706 CONFIG_CMDLINE to remove them. In this case, the command line
707 will not be available, and when U-Boot wants to execute the
708 boot command (on start-up) it will call board_run_command()
709 instead. This can reduce image size significantly for very
710 simple boot procedures.
711
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000712- Regular expression support:
713 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200714 If this variable is defined, U-Boot is linked against
715 the SLRE (Super Light Regular Expression) library,
716 which adds regex support to some commands, as for
717 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000718
Simon Glass45ba8072011-10-15 05:48:20 +0000719- Device tree:
720 CONFIG_OF_CONTROL
721 If this variable is defined, U-Boot will use a device tree
722 to configure its devices, instead of relying on statically
723 compiled #defines in the board file. This option is
724 experimental and only available on a few boards. The device
725 tree is available in the global data as gd->fdt_blob.
726
Simon Glass2c0f79e2011-10-24 19:15:31 +0000727 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700728 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000729
730 CONFIG_OF_EMBED
731 If this variable is defined, U-Boot will embed a device tree
732 binary in its image. This device tree file should be in the
733 board directory and called <soc>-<board>.dts. The binary file
734 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900735 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000736
Simon Glass2c0f79e2011-10-24 19:15:31 +0000737 CONFIG_OF_SEPARATE
738 If this variable is defined, U-Boot will build a device tree
739 binary. It will be called u-boot.dtb. Architecture-specific
740 code will locate it at run-time. Generally this works by:
741
742 cat u-boot.bin u-boot.dtb >image.bin
743
744 and in fact, U-Boot does this for you, creating a file called
745 u-boot-dtb.bin which is useful in the common case. You can
746 still use the individual files if you need something more
747 exotic.
748
Alex Deymo82f766d2017-04-02 01:25:20 -0700749 CONFIG_OF_BOARD
750 If this variable is defined, U-Boot will use the device tree
751 provided by the board at runtime instead of embedding one with
752 the image. Only boards defining board_fdt_blob_setup() support
753 this option (see include/fdtdec.h file).
754
wdenkc6097192002-11-03 00:24:07 +0000755- Watchdog:
756 CONFIG_WATCHDOG
757 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000758 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200759 specific code for a watchdog. For the 8xx
760 CPUs, the SIU Watchdog feature is enabled in the SYPCR
761 register. When supported for a specific SoC is
762 available, then no further board specific code should
763 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000764
765 CONFIG_HW_WATCHDOG
766 When using a watchdog circuitry external to the used
767 SoC, then define this variable and provide board
768 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000769
770- Real-Time Clock:
771
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500772 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000773 has to be selected, too. Define exactly one of the
774 following options:
775
wdenkc6097192002-11-03 00:24:07 +0000776 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000777 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000778 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000779 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000780 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000781 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200782 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000783 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100784 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000785 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200786 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200787 CONFIG_SYS_RV3029_TCR - enable trickle charger on
788 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000789
wdenkb37c7e52003-06-30 16:24:52 +0000790 Note that if the RTC uses I2C, then the I2C interface
791 must also be configured. See I2C Support, below.
792
Peter Tysere92739d2008-12-17 16:36:21 -0600793- GPIO Support:
794 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600795
Chris Packham5dec49c2010-12-19 10:12:13 +0000796 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
797 chip-ngpio pairs that tell the PCA953X driver the number of
798 pins supported by a particular chip.
799
Peter Tysere92739d2008-12-17 16:36:21 -0600800 Note that if the GPIO device uses I2C, then the I2C interface
801 must also be configured. See I2C Support, below.
802
Simon Glassaa532332014-06-11 23:29:41 -0600803- I/O tracing:
804 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
805 accesses and can checksum them or write a list of them out
806 to memory. See the 'iotrace' command for details. This is
807 useful for testing device drivers since it can confirm that
808 the driver behaves the same way before and after a code
809 change. Currently this is supported on sandbox and arm. To
810 add support for your architecture, add '#include <iotrace.h>'
811 to the bottom of arch/<arch>/include/asm/io.h and test.
812
813 Example output from the 'iotrace stats' command is below.
814 Note that if the trace buffer is exhausted, the checksum will
815 still continue to operate.
816
817 iotrace is enabled
818 Start: 10000000 (buffer start address)
819 Size: 00010000 (buffer size)
820 Offset: 00000120 (current buffer offset)
821 Output: 10000120 (start + offset)
822 Count: 00000018 (number of trace records)
823 CRC32: 9526fb66 (CRC32 of all trace records)
824
wdenkc6097192002-11-03 00:24:07 +0000825- Timestamp Support:
826
wdenk43d96162003-03-06 00:02:04 +0000827 When CONFIG_TIMESTAMP is selected, the timestamp
828 (date and time) of an image is printed by image
829 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000831
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000832- Partition Labels (disklabels) Supported:
833 Zero or more of the following:
834 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000835 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
836 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
837 bootloader. Note 2TB partition limit; see
838 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600839 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000840 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000841
842- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000843 CONFIG_IDE_RESET_ROUTINE - this is defined in several
844 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000845
wdenk4d13cba2004-03-14 14:09:05 +0000846 CONFIG_IDE_RESET - is this is defined, IDE Reset will
847 be performed by calling the function
848 ide_set_reset(int reset)
849 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000850
851- ATAPI Support:
852 CONFIG_ATAPI
853
854 Set this to enable ATAPI support.
855
wdenkc40b2952004-03-13 23:29:43 +0000856- LBA48 Support
857 CONFIG_LBA48
858
859 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100860 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000861 Whithout these , LBA48 support uses 32bit variables and will 'only'
862 support disks up to 2.1TB.
863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200864 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000865 When enabled, makes the IDE subsystem use 64bit sector addresses.
866 Default is 32bit.
867
wdenkc6097192002-11-03 00:24:07 +0000868- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200869 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
870 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
871 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000872 maximum numbers of LUNs, SCSI ID's and target
873 devices.
wdenkc6097192002-11-03 00:24:07 +0000874
Wolfgang Denk93e14592013-10-04 17:43:24 +0200875 The environment variable 'scsidevs' is set to the number of
876 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000877
wdenkc6097192002-11-03 00:24:07 +0000878- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000879 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000880 Support for Intel 8254x/8257x gigabit chips.
881
882 CONFIG_E1000_SPI
883 Utility code for direct access to the SPI bus on Intel 8257x.
884 This does not do anything useful unless you set at least one
885 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
886
887 CONFIG_E1000_SPI_GENERIC
888 Allow generic access to the SPI bus on the Intel 8257x, for
889 example with the "sspi" command.
890
wdenkc6097192002-11-03 00:24:07 +0000891 CONFIG_EEPRO100
892 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200893 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000894 write routine for first time initialisation.
895
896 CONFIG_TULIP
897 Support for Digital 2114x chips.
898 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
899 modem chip initialisation (KS8761/QS6611).
900
901 CONFIG_NATSEMI
902 Support for National dp83815 chips.
903
904 CONFIG_NS8382X
905 Support for National dp8382[01] gigabit chips.
906
wdenk45219c42003-05-12 21:50:16 +0000907- NETWORK Support (other):
908
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100909 CONFIG_DRIVER_AT91EMAC
910 Support for AT91RM9200 EMAC.
911
912 CONFIG_RMII
913 Define this to use reduced MII inteface
914
915 CONFIG_DRIVER_AT91EMAC_QUIET
916 If this defined, the driver is quiet.
917 The driver doen't show link status messages.
918
Rob Herringefdd7312011-12-15 11:15:49 +0000919 CONFIG_CALXEDA_XGMAC
920 Support for the Calxeda XGMAC device
921
Ashok3bb46d22012-10-15 06:20:47 +0000922 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000923 Support for SMSC's LAN91C96 chips.
924
wdenk45219c42003-05-12 21:50:16 +0000925 CONFIG_LAN91C96_USE_32_BIT
926 Define this to enable 32 bit addressing
927
Ashok3bb46d22012-10-15 06:20:47 +0000928 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000929 Support for SMSC's LAN91C111 chip
930
931 CONFIG_SMC91111_BASE
932 Define this to hold the physical address
933 of the device (I/O space)
934
935 CONFIG_SMC_USE_32_BIT
936 Define this if data bus is 32 bits
937
938 CONFIG_SMC_USE_IOFUNCS
939 Define this to use i/o functions instead of macros
940 (some hardware wont work with macros)
941
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500942 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
943 Define this if you have more then 3 PHYs.
944
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800945 CONFIG_FTGMAC100
946 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
947
948 CONFIG_FTGMAC100_EGIGA
949 Define this to use GE link update with gigabit PHY.
950 Define this if FTGMAC100 is connected to gigabit PHY.
951 If your system has 10/100 PHY only, it might not occur
952 wrong behavior. Because PHY usually return timeout or
953 useless data when polling gigabit status and gigabit
954 control registers. This behavior won't affect the
955 correctnessof 10/100 link speed update.
956
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900957 CONFIG_SH_ETHER
958 Support for Renesas on-chip Ethernet controller
959
960 CONFIG_SH_ETHER_USE_PORT
961 Define the number of ports to be used
962
963 CONFIG_SH_ETHER_PHY_ADDR
964 Define the ETH PHY's address
965
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900966 CONFIG_SH_ETHER_CACHE_WRITEBACK
967 If this option is set, the driver enables cache flush.
968
Heiko Schocherb2f97cf2014-07-18 06:07:19 +0200969- PWM Support:
970 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -0400971 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +0200972
Vadim Bendebury5e124722011-10-17 08:36:14 +0000973- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000974 CONFIG_TPM
975 Support TPM devices.
976
Christophe Ricard0766ad22015-10-06 22:54:41 +0200977 CONFIG_TPM_TIS_INFINEON
978 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000979 per system is supported at this time.
980
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000981 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
982 Define the burst count bytes upper limit
983
Christophe Ricard3aa74082016-01-21 23:27:13 +0100984 CONFIG_TPM_ST33ZP24
985 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
986
987 CONFIG_TPM_ST33ZP24_I2C
988 Support for STMicroelectronics ST33ZP24 I2C devices.
989 Requires TPM_ST33ZP24 and I2C.
990
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100991 CONFIG_TPM_ST33ZP24_SPI
992 Support for STMicroelectronics ST33ZP24 SPI devices.
993 Requires TPM_ST33ZP24 and SPI.
994
Dirk Eibachc01939c2013-06-26 15:55:15 +0200995 CONFIG_TPM_ATMEL_TWI
996 Support for Atmel TWI TPM device. Requires I2C support.
997
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000998 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000999 Support for generic parallel port TPM devices. Only one device
1000 per system is supported at this time.
1001
1002 CONFIG_TPM_TIS_BASE_ADDRESS
1003 Base address where the generic TPM device is mapped
1004 to. Contemporary x86 systems usually map it at
1005 0xfed40000.
1006
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001007 CONFIG_TPM
1008 Define this to enable the TPM support library which provides
1009 functional interfaces to some TPM commands.
1010 Requires support for a TPM device.
1011
1012 CONFIG_TPM_AUTH_SESSIONS
1013 Define this to enable authorized functions in the TPM library.
1014 Requires CONFIG_TPM and CONFIG_SHA1.
1015
wdenkc6097192002-11-03 00:24:07 +00001016- USB Support:
1017 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001018 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001019 CONFIG_USB_UHCI to enable it.
1020 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001021 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001022 storage devices.
1023 Note:
1024 Supported are USB Keyboards and USB Floppy drives
1025 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001026
Simon Glass9ab4ce22012-02-27 10:52:47 +00001027 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1028 txfilltuning field in the EHCI controller on reset.
1029
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001030 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1031 HW module registers.
1032
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001033- USB Device:
1034 Define the below if you wish to use the USB console.
1035 Once firmware is rebuilt from a serial console issue the
1036 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001037 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001038 it has found a new device. The environment variable usbtty
1039 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001040 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001041 Common Device Class Abstract Control Model serial device.
1042 If you select usbtty = gserial you should be able to enumerate
1043 a Linux host by
1044 # modprobe usbserial vendor=0xVendorID product=0xProductID
1045 else if using cdc_acm, simply setting the environment
1046 variable usbtty to be cdc_acm should suffice. The following
1047 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001048
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001049 CONFIG_USB_DEVICE
1050 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001051
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001052 CONFIG_USB_TTY
1053 Define this to have a tty type of device available to
1054 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001055
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301056 CONFIG_USBD_HS
1057 Define this to enable the high speed support for usb
1058 device and usbtty. If this feature is enabled, a routine
1059 int is_usbd_high_speed(void)
1060 also needs to be defined by the driver to dynamically poll
1061 whether the enumeration has succeded at high speed or full
1062 speed.
1063
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001064 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001065 Define this if you want stdin, stdout &/or stderr to
1066 be set to usbtty.
1067
Wolfgang Denk386eda02006-06-14 18:14:56 +02001068 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001069 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001070 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001071 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1072 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1073 should pretend to be a Linux device to it's target host.
1074
1075 CONFIG_USBD_MANUFACTURER
1076 Define this string as the name of your company for
1077 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001078
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001079 CONFIG_USBD_PRODUCT_NAME
1080 Define this string as the name of your product
1081 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1082
1083 CONFIG_USBD_VENDORID
1084 Define this as your assigned Vendor ID from the USB
1085 Implementors Forum. This *must* be a genuine Vendor ID
1086 to avoid polluting the USB namespace.
1087 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001088
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001089 CONFIG_USBD_PRODUCTID
1090 Define this as the unique Product ID
1091 for your device
1092 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001093
Igor Grinbergd70a5602011-12-12 12:08:35 +02001094- ULPI Layer Support:
1095 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1096 the generic ULPI layer. The generic layer accesses the ULPI PHY
1097 via the platform viewport, so you need both the genric layer and
1098 the viewport enabled. Currently only Chipidea/ARC based
1099 viewport is supported.
1100 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1101 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001102 If your ULPI phy needs a different reference clock than the
1103 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1104 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001105
1106- MMC Support:
1107 The MMC controller on the Intel PXA is supported. To
1108 enable this define CONFIG_MMC. The MMC can be
1109 accessed from the boot prompt by mapping the device
1110 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001111 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1112 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001113
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001114 CONFIG_SH_MMCIF
1115 Support for Renesas on-chip MMCIF controller
1116
1117 CONFIG_SH_MMCIF_ADDR
1118 Define the base address of MMCIF registers
1119
1120 CONFIG_SH_MMCIF_CLK
1121 Define the clock frequency for MMCIF
1122
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001123 CONFIG_SUPPORT_EMMC_BOOT
1124 Enable some additional features of the eMMC boot partitions.
1125
Tom Rinib3ba6e92013-03-14 05:32:47 +00001126- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +01001127 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +00001128 This enables the USB portion of the DFU USB class
1129
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001130 CONFIG_DFU_NAND
1131 This enables support for exposing NAND devices via DFU.
1132
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301133 CONFIG_DFU_RAM
1134 This enables support for exposing RAM via DFU.
1135 Note: DFU spec refer to non-volatile memory usage, but
1136 allow usages beyond the scope of spec - here RAM usage,
1137 one that would help mostly the developer.
1138
Heiko Schochere7e75c72013-06-12 06:05:51 +02001139 CONFIG_SYS_DFU_DATA_BUF_SIZE
1140 Dfu transfer uses a buffer before writing data to the
1141 raw storage device. Make the size (in bytes) of this buffer
1142 configurable. The size of this buffer is also configurable
1143 through the "dfu_bufsiz" environment variable.
1144
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001145 CONFIG_SYS_DFU_MAX_FILE_SIZE
1146 When updating files rather than the raw storage device,
1147 we use a static buffer to copy the file into and then write
1148 the buffer once we've been given the whole file. Define
1149 this to the maximum filesize (in bytes) for the buffer.
1150 Default is 4 MiB if undefined.
1151
Heiko Schocher001a8312014-03-18 08:09:56 +01001152 DFU_DEFAULT_POLL_TIMEOUT
1153 Poll timeout [ms], is the timeout a device can send to the
1154 host. The host must wait for this timeout before sending
1155 a subsequent DFU_GET_STATUS request to the device.
1156
1157 DFU_MANIFEST_POLL_TIMEOUT
1158 Poll timeout [ms], which the device sends to the host when
1159 entering dfuMANIFEST state. Host waits this timeout, before
1160 sending again an USB request to the device.
1161
wdenk6705d812004-08-02 23:22:59 +00001162- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001163 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001164 Define these for a default partition on a NAND device
1165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001166 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1167 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001168 Define these for a default partition on a NOR device
1169
wdenkc6097192002-11-03 00:24:07 +00001170- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001171 See Kconfig help for available keyboard drivers.
1172
1173 CONFIG_KEYBOARD
1174
1175 Define this to enable a custom keyboard support.
1176 This simply calls drv_keyboard_init() which must be
1177 defined in your board-specific files. This option is deprecated
1178 and is only used by novena. For new boards, use driver model
1179 instead.
wdenkc6097192002-11-03 00:24:07 +00001180
1181- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001182 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001183 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001184 SOCs that have a DIU should define this macro to enable DIU
1185 support, and should also define these other macros:
1186
1187 CONFIG_SYS_DIU_ADDR
1188 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001189 CONFIG_CFB_CONSOLE
1190 CONFIG_VIDEO_SW_CURSOR
1191 CONFIG_VGA_AS_SINGLE_DEVICE
1192 CONFIG_VIDEO_LOGO
1193 CONFIG_VIDEO_BMP_LOGO
1194
Timur Tabiba8e76b2011-04-11 14:18:22 -05001195 The DIU driver will look for the 'video-mode' environment
1196 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001197 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001198 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001199
wdenkc6097192002-11-03 00:24:07 +00001200- LCD Support: CONFIG_LCD
1201
1202 Define this to enable LCD support (for output to LCD
1203 display); also select one of the supported displays
1204 by defining one of these:
1205
Stelian Pop39cf4802008-05-09 21:57:18 +02001206 CONFIG_ATMEL_LCD:
1207
1208 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1209
wdenkfd3103b2003-11-25 16:55:19 +00001210 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001211
wdenkfd3103b2003-11-25 16:55:19 +00001212 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001213
wdenkfd3103b2003-11-25 16:55:19 +00001214 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001215
wdenkfd3103b2003-11-25 16:55:19 +00001216 NEC NL6448BC20-08. 6.5", 640x480.
1217 Active, color, single scan.
1218
1219 CONFIG_NEC_NL6448BC33_54
1220
1221 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001222 Active, color, single scan.
1223
1224 CONFIG_SHARP_16x9
1225
1226 Sharp 320x240. Active, color, single scan.
1227 It isn't 16x9, and I am not sure what it is.
1228
1229 CONFIG_SHARP_LQ64D341
1230
1231 Sharp LQ64D341 display, 640x480.
1232 Active, color, single scan.
1233
1234 CONFIG_HLD1045
1235
1236 HLD1045 display, 640x480.
1237 Active, color, single scan.
1238
1239 CONFIG_OPTREX_BW
1240
1241 Optrex CBL50840-2 NF-FW 99 22 M5
1242 or
1243 Hitachi LMG6912RPFC-00T
1244 or
1245 Hitachi SP14Q002
1246
1247 320x240. Black & white.
1248
Simon Glass676d3192012-10-17 13:24:54 +00001249 CONFIG_LCD_ALIGNMENT
1250
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001251 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001252 defined then the LCD will be aligned to this value instead.
1253 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1254 here, since it is cheaper to change data cache settings on
1255 a per-section basis.
1256
1257
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001258 CONFIG_LCD_ROTATION
1259
1260 Sometimes, for example if the display is mounted in portrait
1261 mode or even if it's mounted landscape but rotated by 180degree,
1262 we need to rotate our content of the display relative to the
1263 framebuffer, so that user can read the messages which are
1264 printed out.
1265 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1266 initialized with a given rotation from "vl_rot" out of
1267 "vidinfo_t" which is provided by the board specific code.
1268 The value for vl_rot is coded as following (matching to
1269 fbcon=rotate:<n> linux-kernel commandline):
1270 0 = no rotation respectively 0 degree
1271 1 = 90 degree rotation
1272 2 = 180 degree rotation
1273 3 = 270 degree rotation
1274
1275 If CONFIG_LCD_ROTATION is not defined, the console will be
1276 initialized with 0degree rotation.
1277
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001278 CONFIG_LCD_BMP_RLE8
1279
1280 Support drawing of RLE8-compressed bitmaps on the LCD.
1281
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001282 CONFIG_I2C_EDID
1283
1284 Enables an 'i2c edid' command which can read EDID
1285 information over I2C from an attached LCD display.
1286
wdenk7152b1d2003-09-05 23:19:14 +00001287- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001288
wdenk8bde7f72003-06-27 21:31:46 +00001289 If this option is set, the environment is checked for
1290 a variable "splashimage". If found, the usual display
1291 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001292 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001293 specified in "splashimage" is loaded instead. The
1294 console is redirected to the "nulldev", too. This
1295 allows for a "silent" boot where a splash screen is
1296 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001297
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001298 CONFIG_SPLASHIMAGE_GUARD
1299
1300 If this option is set, then U-Boot will prevent the environment
1301 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001302 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001303 This option is useful for targets where, due to alignment
1304 restrictions, an improperly aligned BMP image will cause a data
1305 abort. If you think you will not have problems with unaligned
1306 accesses (for example because your toolchain prevents them)
1307 there is no need to set this option.
1308
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001309 CONFIG_SPLASH_SCREEN_ALIGN
1310
1311 If this option is set the splash image can be freely positioned
1312 on the screen. Environment variable "splashpos" specifies the
1313 position as "x,y". If a positive number is given it is used as
1314 number of pixel from left/top. If a negative number is given it
1315 is used as number of pixel from right/bottom. You can also
1316 specify 'm' for centering the image.
1317
1318 Example:
1319 setenv splashpos m,m
1320 => image at center of screen
1321
1322 setenv splashpos 30,20
1323 => image at x = 30 and y = 20
1324
1325 setenv splashpos -10,m
1326 => vertically centered image
1327 at x = dspWidth - bmpWidth - 9
1328
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001329- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1330
1331 If this option is set, additionally to standard BMP
1332 images, gzipped BMP images can be displayed via the
1333 splashscreen support or the bmp command.
1334
Anatolij Gustschind5011762010-03-15 14:50:25 +01001335- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1336
1337 If this option is set, 8-bit RLE compressed BMP images
1338 can be displayed via the splashscreen support or the
1339 bmp command.
1340
wdenkc29fdfc2003-08-29 20:57:53 +00001341- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001342 CONFIG_GZIP
1343
1344 Enabled by default to support gzip compressed images.
1345
wdenkc29fdfc2003-08-29 20:57:53 +00001346 CONFIG_BZIP2
1347
1348 If this option is set, support for bzip2 compressed
1349 images is included. If not, only uncompressed and gzip
1350 compressed images are supported.
1351
wdenk42d1f032003-10-15 23:53:47 +00001352 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001353 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001354 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001355
wdenk17ea1172004-06-06 21:51:03 +00001356- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +00001357 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1358
1359 The clock frequency of the MII bus
1360
wdenk17ea1172004-06-06 21:51:03 +00001361 CONFIG_PHY_RESET_DELAY
1362
1363 Some PHY like Intel LXT971A need extra delay after
1364 reset before any MII register access is possible.
1365 For such PHY, set this option to the usec delay
1366 required. (minimum 300usec for LXT971A)
1367
1368 CONFIG_PHY_CMD_DELAY (ppc4xx)
1369
1370 Some PHY like Intel LXT971A need extra delay after
1371 command issued before MII status register can be read
1372
wdenkc6097192002-11-03 00:24:07 +00001373- IP address:
1374 CONFIG_IPADDR
1375
1376 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001377 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001378 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001379 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001380
1381- Server IP address:
1382 CONFIG_SERVERIP
1383
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001384 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001385 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001386 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001387
Robin Getz97cfe862009-07-21 12:15:28 -04001388 CONFIG_KEEP_SERVERADDR
1389
1390 Keeps the server's MAC address, in the env 'serveraddr'
1391 for passing to bootargs (like Linux's netconsole option)
1392
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001393- Gateway IP address:
1394 CONFIG_GATEWAYIP
1395
1396 Defines a default value for the IP address of the
1397 default router where packets to other networks are
1398 sent to.
1399 (Environment variable "gatewayip")
1400
1401- Subnet mask:
1402 CONFIG_NETMASK
1403
1404 Defines a default value for the subnet mask (or
1405 routing prefix) which is used to determine if an IP
1406 address belongs to the local subnet or needs to be
1407 forwarded through a router.
1408 (Environment variable "netmask")
1409
wdenkc6097192002-11-03 00:24:07 +00001410- BOOTP Recovery Mode:
1411 CONFIG_BOOTP_RANDOM_DELAY
1412
1413 If you have many targets in a network that try to
1414 boot using BOOTP, you may want to avoid that all
1415 systems send out BOOTP requests at precisely the same
1416 moment (which would happen for instance at recovery
1417 from a power failure, when all systems will try to
1418 boot, thus flooding the BOOTP server. Defining
1419 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1420 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001421 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001422
1423 1st BOOTP request: delay 0 ... 1 sec
1424 2nd BOOTP request: delay 0 ... 2 sec
1425 3rd BOOTP request: delay 0 ... 4 sec
1426 4th and following
1427 BOOTP requests: delay 0 ... 8 sec
1428
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001429 CONFIG_BOOTP_ID_CACHE_SIZE
1430
1431 BOOTP packets are uniquely identified using a 32-bit ID. The
1432 server will copy the ID from client requests to responses and
1433 U-Boot will use this to determine if it is the destination of
1434 an incoming response. Some servers will check that addresses
1435 aren't in use before handing them out (usually using an ARP
1436 ping) and therefore take up to a few hundred milliseconds to
1437 respond. Network congestion may also influence the time it
1438 takes for a response to make it back to the client. If that
1439 time is too long, U-Boot will retransmit requests. In order
1440 to allow earlier responses to still be accepted after these
1441 retransmissions, U-Boot's BOOTP client keeps a small cache of
1442 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1443 cache. The default is to keep IDs for up to four outstanding
1444 requests. Increasing this will allow U-Boot to accept offers
1445 from a BOOTP client in networks with unusually high latency.
1446
stroesefe389a82003-08-28 14:17:32 +00001447- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001448 You can fine tune the DHCP functionality by defining
1449 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001450
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001451 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001452 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001453 CONFIG_BOOTP_SEND_HOSTNAME
1454 CONFIG_BOOTP_NTPSERVER
1455 CONFIG_BOOTP_TIMEOFFSET
1456 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001457 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001458
Wilson Callan5d110f02007-07-28 10:56:13 -04001459 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1460 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001461
Joe Hershberger2c00e092012-05-23 07:59:19 +00001462 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1463 after the configured retry count, the call will fail
1464 instead of starting over. This can be used to fail over
1465 to Link-local IP address configuration if the DHCP server
1466 is not available.
1467
stroesefe389a82003-08-28 14:17:32 +00001468 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1469 to do a dynamic update of a DNS server. To do this, they
1470 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001471 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001472 of the "hostname" environment variable is passed as
1473 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001474
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001475 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1476
1477 A 32bit value in microseconds for a delay between
1478 receiving a "DHCP Offer" and sending the "DHCP Request".
1479 This fixes a problem with certain DHCP servers that don't
1480 respond 100% of the time to a "DHCP request". E.g. On an
1481 AT91RM9200 processor running at 180MHz, this delay needed
1482 to be *at least* 15,000 usec before a Windows Server 2003
1483 DHCP server would reply 100% of the time. I recommend at
1484 least 50,000 usec to be safe. The alternative is to hope
1485 that one of the retries will be successful but note that
1486 the DHCP timeout and retry process takes a longer than
1487 this delay.
1488
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001489 - Link-local IP address negotiation:
1490 Negotiate with other link-local clients on the local network
1491 for an address that doesn't require explicit configuration.
1492 This is especially useful if a DHCP server cannot be guaranteed
1493 to exist in all environments that the device must operate.
1494
1495 See doc/README.link-local for more information.
1496
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301497 - MAC address from environment variables
1498
1499 FDT_SEQ_MACADDR_FROM_ENV
1500
1501 Fix-up device tree with MAC addresses fetched sequentially from
1502 environment variables. This config work on assumption that
1503 non-usable ethernet node of device-tree are either not present
1504 or their status has been marked as "disabled".
1505
wdenka3d991b2004-04-15 21:48:45 +00001506 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001507 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001508
1509 The device id used in CDP trigger frames.
1510
1511 CONFIG_CDP_DEVICE_ID_PREFIX
1512
1513 A two character string which is prefixed to the MAC address
1514 of the device.
1515
1516 CONFIG_CDP_PORT_ID
1517
1518 A printf format string which contains the ascii name of
1519 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001520 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001521
1522 CONFIG_CDP_CAPABILITIES
1523
1524 A 32bit integer which indicates the device capabilities;
1525 0x00000010 for a normal host which does not forwards.
1526
1527 CONFIG_CDP_VERSION
1528
1529 An ascii string containing the version of the software.
1530
1531 CONFIG_CDP_PLATFORM
1532
1533 An ascii string containing the name of the platform.
1534
1535 CONFIG_CDP_TRIGGER
1536
1537 A 32bit integer sent on the trigger.
1538
1539 CONFIG_CDP_POWER_CONSUMPTION
1540
1541 A 16bit integer containing the power consumption of the
1542 device in .1 of milliwatts.
1543
1544 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1545
1546 A byte containing the id of the VLAN.
1547
Uri Mashiach79267ed2017-01-19 10:51:05 +02001548- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001549
1550 Several configurations allow to display the current
1551 status using a LED. For instance, the LED will blink
1552 fast while running U-Boot code, stop blinking as
1553 soon as a reply to a BOOTP request was received, and
1554 start blinking slow once the Linux kernel is running
1555 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001556 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001557 feature in U-Boot.
1558
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001559 Additional options:
1560
Uri Mashiach79267ed2017-01-19 10:51:05 +02001561 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001562 The status LED can be connected to a GPIO pin.
1563 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001564 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001565 to include the gpio_led driver in the U-Boot binary.
1566
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001567 CONFIG_GPIO_LED_INVERTED_TABLE
1568 Some GPIO connected LEDs may have inverted polarity in which
1569 case the GPIO high value corresponds to LED off state and
1570 GPIO low value corresponds to LED on state.
1571 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1572 with a list of GPIO LEDs that have inverted polarity.
1573
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001574- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001575
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001576 This enable the NEW i2c subsystem, and will allow you to use
1577 i2c commands at the u-boot command line (as long as you set
1578 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1579 based realtime clock chips or other i2c devices. See
1580 common/cmd_i2c.c for a description of the command line
1581 interface.
1582
1583 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001584 - drivers/i2c/soft_i2c.c:
1585 - activate first bus with CONFIG_SYS_I2C_SOFT define
1586 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1587 for defining speed and slave address
1588 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1589 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1590 for defining speed and slave address
1591 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1592 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1593 for defining speed and slave address
1594 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1595 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1596 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001597
Heiko Schocher00f792e2012-10-24 13:48:22 +02001598 - drivers/i2c/fsl_i2c.c:
1599 - activate i2c driver with CONFIG_SYS_I2C_FSL
1600 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1601 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1602 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1603 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001604 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001605 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1606 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1607 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1608 second bus.
1609
Simon Glass1f2ba722012-10-30 07:28:53 +00001610 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001611 - activate this driver with CONFIG_SYS_I2C_TEGRA
1612 - This driver adds 4 i2c buses with a fix speed from
1613 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001614
Dirk Eibach880540d2013-04-25 02:40:01 +00001615 - drivers/i2c/ppc4xx_i2c.c
1616 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1617 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1618 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1619
tremfac96402013-09-21 18:13:35 +02001620 - drivers/i2c/i2c_mxc.c
1621 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001622 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1623 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1624 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1625 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001626 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1627 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1628 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1629 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1630 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1631 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001632 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1633 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001634 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001635 for speed, and 0 for slave.
1636
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001637 - drivers/i2c/rcar_i2c.c:
1638 - activate this driver with CONFIG_SYS_I2C_RCAR
1639 - This driver adds 4 i2c buses
1640
1641 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1642 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1643 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1644 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1645 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1646 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1647 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1648 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1649 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1650
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001651 - drivers/i2c/sh_i2c.c:
1652 - activate this driver with CONFIG_SYS_I2C_SH
1653 - This driver adds from 2 to 5 i2c buses
1654
1655 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1656 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1657 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1658 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1659 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1660 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1661 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1662 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1663 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1664 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001665 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001666
Heiko Schocher6789e842013-10-22 11:03:18 +02001667 - drivers/i2c/omap24xx_i2c.c
1668 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1669 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1670 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1671 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1672 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1673 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1674 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1675 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1676 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1677 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1678 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1679
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301680 - drivers/i2c/s3c24x0_i2c.c:
1681 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1682 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1683 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1684 with a fix speed from 100000 and the slave addr 0!
1685
Dirk Eibachb46226b2014-07-03 09:28:18 +02001686 - drivers/i2c/ihs_i2c.c
1687 - activate this driver with CONFIG_SYS_I2C_IHS
1688 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1689 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1690 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1691 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1692 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1693 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1694 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1695 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1696 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1697 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1698 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1699 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001700 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1701 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1702 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1703 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1704 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1705 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1706 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1707 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1708 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001709
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001710 additional defines:
1711
1712 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001713 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001714
1715 CONFIG_SYS_I2C_DIRECT_BUS
1716 define this, if you don't use i2c muxes on your hardware.
1717 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1718 omit this define.
1719
1720 CONFIG_SYS_I2C_MAX_HOPS
1721 define how many muxes are maximal consecutively connected
1722 on one i2c bus. If you not use i2c muxes, omit this
1723 define.
1724
1725 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001726 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001727 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1728 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1729 CONFIG_SYS_NUM_I2C_BUSES = 9:
1730
1731 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1732 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1733 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1734 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1735 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1736 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1737 {1, {I2C_NULL_HOP}}, \
1738 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1739 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1740 }
1741
1742 which defines
1743 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001744 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1745 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1746 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1747 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1748 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001749 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001750 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1751 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001752
1753 If you do not have i2c muxes on your board, omit this define.
1754
Simon Glassce3b5d62017-05-12 21:10:00 -06001755- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001756 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001757 then the following macros need to be defined (examples are
1758 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001759
1760 I2C_INIT
1761
wdenkb37c7e52003-06-30 16:24:52 +00001762 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001763 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001764
wdenkba56f622004-02-06 23:19:44 +00001765 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001766
wdenkc6097192002-11-03 00:24:07 +00001767 I2C_ACTIVE
1768
1769 The code necessary to make the I2C data line active
1770 (driven). If the data line is open collector, this
1771 define can be null.
1772
wdenkb37c7e52003-06-30 16:24:52 +00001773 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1774
wdenkc6097192002-11-03 00:24:07 +00001775 I2C_TRISTATE
1776
1777 The code necessary to make the I2C data line tri-stated
1778 (inactive). If the data line is open collector, this
1779 define can be null.
1780
wdenkb37c7e52003-06-30 16:24:52 +00001781 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1782
wdenkc6097192002-11-03 00:24:07 +00001783 I2C_READ
1784
York Sun472d5462013-04-01 11:29:11 -07001785 Code that returns true if the I2C data line is high,
1786 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001787
wdenkb37c7e52003-06-30 16:24:52 +00001788 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1789
wdenkc6097192002-11-03 00:24:07 +00001790 I2C_SDA(bit)
1791
York Sun472d5462013-04-01 11:29:11 -07001792 If <bit> is true, sets the I2C data line high. If it
1793 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001794
wdenkb37c7e52003-06-30 16:24:52 +00001795 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001796 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001797 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001798
wdenkc6097192002-11-03 00:24:07 +00001799 I2C_SCL(bit)
1800
York Sun472d5462013-04-01 11:29:11 -07001801 If <bit> is true, sets the I2C clock line high. If it
1802 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001803
wdenkb37c7e52003-06-30 16:24:52 +00001804 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001805 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001806 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001807
wdenkc6097192002-11-03 00:24:07 +00001808 I2C_DELAY
1809
1810 This delay is invoked four times per clock cycle so this
1811 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001812 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001813 like:
1814
wdenkb37c7e52003-06-30 16:24:52 +00001815 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001816
Mike Frysinger793b5722010-07-21 13:38:02 -04001817 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1818
1819 If your arch supports the generic GPIO framework (asm/gpio.h),
1820 then you may alternatively define the two GPIOs that are to be
1821 used as SCL / SDA. Any of the previous I2C_xxx macros will
1822 have GPIO-based defaults assigned to them as appropriate.
1823
1824 You should define these to the GPIO value as given directly to
1825 the generic GPIO functions.
1826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001827 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001828
wdenk8bde7f72003-06-27 21:31:46 +00001829 When a board is reset during an i2c bus transfer
1830 chips might think that the current transfer is still
1831 in progress. On some boards it is possible to access
1832 the i2c SCLK line directly, either by using the
1833 processor pin as a GPIO or by having a second pin
1834 connected to the bus. If this option is defined a
1835 custom i2c_init_board() routine in boards/xxx/board.c
1836 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001837
Ben Warrenbb99ad62006-09-07 16:50:54 -04001838 CONFIG_I2C_MULTI_BUS
1839
1840 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001841 must have a controller. At any point in time, only one bus is
1842 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001843 Note that bus numbering is zero-based.
1844
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001845 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001846
1847 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001848 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001849 is set, specify a list of bus-device pairs. Otherwise, specify
1850 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001851
1852 e.g.
1853 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001854 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001855
1856 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1857
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001858 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001859 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001860
1861 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1862
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001863 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001864
1865 If defined, then this indicates the I2C bus number for DDR SPD.
1866 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1867
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001868 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001869
1870 If defined, then this indicates the I2C bus number for the RTC.
1871 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1872
Andrew Dyer2ac69852008-12-29 17:36:01 -06001873 CONFIG_SOFT_I2C_READ_REPEATED_START
1874
1875 defining this will force the i2c_read() function in
1876 the soft_i2c driver to perform an I2C repeated start
1877 between writing the address pointer and reading the
1878 data. If this define is omitted the default behaviour
1879 of doing a stop-start sequence will be used. Most I2C
1880 devices can use either method, but some require one or
1881 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001882
wdenkc6097192002-11-03 00:24:07 +00001883- SPI Support: CONFIG_SPI
1884
1885 Enables SPI driver (so far only tested with
1886 SPI EEPROM, also an instance works with Crystal A/D and
1887 D/As on the SACSng board)
1888
wdenkc6097192002-11-03 00:24:07 +00001889 CONFIG_SOFT_SPI
1890
wdenk43d96162003-03-06 00:02:04 +00001891 Enables a software (bit-bang) SPI driver rather than
1892 using hardware support. This is a general purpose
1893 driver that only requires three general I/O port pins
1894 (two outputs, one input) to function. If this is
1895 defined, the board configuration must define several
1896 SPI configuration items (port pins to use, etc). For
1897 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001898
Heiko Schocherf659b572014-07-14 10:22:11 +02001899 CONFIG_SYS_SPI_MXC_WAIT
1900 Timeout for waiting until spi transfer completed.
1901 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1902
Matthias Fuchs01335022007-12-27 17:12:34 +01001903- FPGA Support: CONFIG_FPGA
1904
1905 Enables FPGA subsystem.
1906
1907 CONFIG_FPGA_<vendor>
1908
1909 Enables support for specific chip vendors.
1910 (ALTERA, XILINX)
1911
1912 CONFIG_FPGA_<family>
1913
1914 Enables support for FPGA family.
1915 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1916
1917 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001918
wdenk43d96162003-03-06 00:02:04 +00001919 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001921 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001922
wdenk8bde7f72003-06-27 21:31:46 +00001923 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001925 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001926
wdenk43d96162003-03-06 00:02:04 +00001927 Enable checks on FPGA configuration interface busy
1928 status by the configuration function. This option
1929 will require a board or device specific function to
1930 be written.
wdenkc6097192002-11-03 00:24:07 +00001931
1932 CONFIG_FPGA_DELAY
1933
1934 If defined, a function that provides delays in the FPGA
1935 configuration driver.
1936
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001937 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001938 Allow Control-C to interrupt FPGA configuration
1939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001940 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001941
wdenk43d96162003-03-06 00:02:04 +00001942 Check for configuration errors during FPGA bitfile
1943 loading. For example, abort during Virtex II
1944 configuration if the INIT_B line goes low (which
1945 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001947 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001948
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001949 Maximum time to wait for the INIT_B line to de-assert
1950 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00001951 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001952 ms.
wdenkc6097192002-11-03 00:24:07 +00001953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001954 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001955
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001956 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001957 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001959 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk43d96162003-03-06 00:02:04 +00001961 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001962 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001963
1964- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02001965
wdenkc6097192002-11-03 00:24:07 +00001966 CONFIG_IDENT_STRING
1967
wdenk43d96162003-03-06 00:02:04 +00001968 If defined, this string will be added to the U-Boot
1969 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001970
1971- Vendor Parameter Protection:
1972
wdenk43d96162003-03-06 00:02:04 +00001973 U-Boot considers the values of the environment
1974 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001975 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001976 are set once by the board vendor / manufacturer, and
1977 protects these variables from casual modification by
1978 the user. Once set, these variables are read-only,
1979 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001980 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001981
1982 If CONFIG_ENV_OVERWRITE is #defined in your config
1983 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001984 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001985 these parameters.
1986
Joe Hershberger92ac5202015-05-04 14:55:14 -05001987 Alternatively, if you define _both_ an ethaddr in the
1988 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001989 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001990 which can be changed exactly ONCE by the user. [The
1991 serial# is unaffected by this, i. e. it remains
1992 read-only.]
1993
Joe Hershberger25980902012-12-11 22:16:31 -06001994 The same can be accomplished in a more flexible way
1995 for any variable by configuring the type of access
1996 to allow for those variables in the ".flags" variable
1997 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1998
wdenkc6097192002-11-03 00:24:07 +00001999- Protected RAM:
2000 CONFIG_PRAM
2001
2002 Define this variable to enable the reservation of
2003 "protected RAM", i. e. RAM which is not overwritten
2004 by U-Boot. Define CONFIG_PRAM to hold the number of
2005 kB you want to reserve for pRAM. You can overwrite
2006 this default value by defining an environment
2007 variable "pram" to the number of kB you want to
2008 reserve. Note that the board info structure will
2009 still show the full amount of RAM. If pRAM is
2010 reserved, a new environment variable "mem" will
2011 automatically be defined to hold the amount of
2012 remaining RAM in a form that can be passed as boot
2013 argument to Linux, for instance like that:
2014
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002015 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002016 saveenv
2017
2018 This way you can tell Linux not to use this memory,
2019 either, which results in a memory region that will
2020 not be affected by reboots.
2021
2022 *WARNING* If your board configuration uses automatic
2023 detection of the RAM size, you must make sure that
2024 this memory test is non-destructive. So far, the
2025 following board configurations are known to be
2026 "pRAM-clean":
2027
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002028 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002029 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002030 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002031
Gabe Black40fef042012-12-02 04:55:18 +00002032- Access to physical memory region (> 4GB)
2033 Some basic support is provided for operations on memory not
2034 normally accessible to U-Boot - e.g. some architectures
2035 support access to more than 4GB of memory on 32-bit
2036 machines using physical address extension or similar.
2037 Define CONFIG_PHYSMEM to access this basic support, which
2038 currently only supports clearing the memory.
2039
wdenkc6097192002-11-03 00:24:07 +00002040- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002041 CONFIG_NET_RETRY_COUNT
2042
wdenk43d96162003-03-06 00:02:04 +00002043 This variable defines the number of retries for
2044 network operations like ARP, RARP, TFTP, or BOOTP
2045 before giving up the operation. If not defined, a
2046 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002047
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002048 CONFIG_ARP_TIMEOUT
2049
2050 Timeout waiting for an ARP reply in milliseconds.
2051
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002052 CONFIG_NFS_TIMEOUT
2053
2054 Timeout in milliseconds used in NFS protocol.
2055 If you encounter "ERROR: Cannot umount" in nfs command,
2056 try longer timeout such as
2057 #define CONFIG_NFS_TIMEOUT 10000UL
2058
wdenkc6097192002-11-03 00:24:07 +00002059- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002060 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002061
2062 This defines the secondary prompt string, which is
2063 printed when the command interpreter needs more input
2064 to complete a command. Usually "> ".
2065
2066 Note:
2067
wdenk8bde7f72003-06-27 21:31:46 +00002068 In the current implementation, the local variables
2069 space and global environment variables space are
2070 separated. Local variables are those you define by
2071 simply typing `name=value'. To access a local
2072 variable later on, you have write `$name' or
2073 `${name}'; to execute the contents of a variable
2074 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002075
wdenk43d96162003-03-06 00:02:04 +00002076 Global environment variables are those you use
2077 setenv/printenv to work with. To run a command stored
2078 in such a variable, you need to use the run command,
2079 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002080
2081 To store commands and special characters in a
2082 variable, please use double quotation marks
2083 surrounding the whole text of the variable, instead
2084 of the backslashes before semicolons and special
2085 symbols.
2086
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002087- Command Line Editing and History:
Marek Vasutf3b267b2016-01-27 04:47:55 +01002088 CONFIG_CMDLINE_PS_SUPPORT
2089
2090 Enable support for changing the command prompt string
2091 at run-time. Only static string is supported so far.
2092 The string is obtained from environment variables PS1
2093 and PS2.
2094
wdenka8c7c702003-12-06 19:49:23 +00002095- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002096 CONFIG_EXTRA_ENV_SETTINGS
2097
wdenk43d96162003-03-06 00:02:04 +00002098 Define this to contain any number of null terminated
2099 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002100 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002101
wdenk43d96162003-03-06 00:02:04 +00002102 For example, place something like this in your
2103 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002104
2105 #define CONFIG_EXTRA_ENV_SETTINGS \
2106 "myvar1=value1\0" \
2107 "myvar2=value2\0"
2108
wdenk43d96162003-03-06 00:02:04 +00002109 Warning: This method is based on knowledge about the
2110 internal format how the environment is stored by the
2111 U-Boot code. This is NOT an official, exported
2112 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002113 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002114 You better know what you are doing here.
2115
wdenk43d96162003-03-06 00:02:04 +00002116 Note: overly (ab)use of the default environment is
2117 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002118 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002119 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002120
Simon Glass06fd8532012-11-30 13:01:17 +00002121 CONFIG_DELAY_ENVIRONMENT
2122
2123 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002124 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002125 that so that the environment is not available until
2126 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2127 this is instead controlled by the value of
2128 /config/load-environment.
2129
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002130- TFTP Fixed UDP Port:
2131 CONFIG_TFTP_PORT
2132
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002133 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002134 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002135 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002136 number generator is used.
2137
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002138 Also, the environment variable tftpdstp is used to supply
2139 the TFTP UDP destination port value. If tftpdstp isn't
2140 defined, the normal port 69 is used.
2141
2142 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002143 blindly start the TFTP transfer using the pre-configured
2144 target IP address and UDP port. This has the effect of
2145 "punching through" the (Windows XP) firewall, allowing
2146 the remainder of the TFTP transfer to proceed normally.
2147 A better solution is to properly configure the firewall,
2148 but sometimes that is not allowed.
2149
wdenka8c7c702003-12-06 19:49:23 +00002150- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002151 CONFIG_SHOW_BOOT_PROGRESS
2152
wdenk43d96162003-03-06 00:02:04 +00002153 Defining this option allows to add some board-
2154 specific code (calling a user-provided function
2155 "show_boot_progress(int)") that enables you to show
2156 the system's boot progress on some display (for
2157 example, some LED's) on your board. At the moment,
2158 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002159
Simon Glass94fd1312012-09-28 08:56:37 +00002160
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002161Legacy uImage format:
2162
wdenkc6097192002-11-03 00:24:07 +00002163 Arg Where When
2164 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002165 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002166 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002167 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002168 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002169 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002170 4 common/cmd_bootm.c Image data has correct checksum
2171 -4 common/cmd_bootm.c Image is for unsupported architecture
2172 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002173 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002174 6 common/cmd_bootm.c Image Type check OK
2175 -6 common/cmd_bootm.c gunzip uncompression error
2176 -7 common/cmd_bootm.c Unimplemented compression type
2177 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002178 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002179 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002180
2181 9 common/image.c Start initial ramdisk verification
2182 -10 common/image.c Ramdisk header has bad magic number
2183 -11 common/image.c Ramdisk header has bad checksum
2184 10 common/image.c Ramdisk header is OK
2185 -12 common/image.c Ramdisk data has bad checksum
2186 11 common/image.c Ramdisk data has correct checksum
2187 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002188 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002189 13 common/image.c Start multifile image verification
2190 14 common/image.c No initial ramdisk, no multifile, continue.
2191
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002192 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002193
Stefan Roesea47a12b2010-04-15 16:07:28 +02002194 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002195 -31 post/post.c POST test failed, detected by post_output_backlog()
2196 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002197
Heiko Schocher566a4942007-06-22 19:11:54 +02002198 34 common/cmd_doc.c before loading a Image from a DOC device
2199 -35 common/cmd_doc.c Bad usage of "doc" command
2200 35 common/cmd_doc.c correct usage of "doc" command
2201 -36 common/cmd_doc.c No boot device
2202 36 common/cmd_doc.c correct boot device
2203 -37 common/cmd_doc.c Unknown Chip ID on boot device
2204 37 common/cmd_doc.c correct chip ID found, device available
2205 -38 common/cmd_doc.c Read Error on boot device
2206 38 common/cmd_doc.c reading Image header from DOC device OK
2207 -39 common/cmd_doc.c Image header has bad magic number
2208 39 common/cmd_doc.c Image header has correct magic number
2209 -40 common/cmd_doc.c Error reading Image from DOC device
2210 40 common/cmd_doc.c Image header has correct magic number
2211 41 common/cmd_ide.c before loading a Image from a IDE device
2212 -42 common/cmd_ide.c Bad usage of "ide" command
2213 42 common/cmd_ide.c correct usage of "ide" command
2214 -43 common/cmd_ide.c No boot device
2215 43 common/cmd_ide.c boot device found
2216 -44 common/cmd_ide.c Device not available
2217 44 common/cmd_ide.c Device available
2218 -45 common/cmd_ide.c wrong partition selected
2219 45 common/cmd_ide.c partition selected
2220 -46 common/cmd_ide.c Unknown partition table
2221 46 common/cmd_ide.c valid partition table found
2222 -47 common/cmd_ide.c Invalid partition type
2223 47 common/cmd_ide.c correct partition type
2224 -48 common/cmd_ide.c Error reading Image Header on boot device
2225 48 common/cmd_ide.c reading Image Header from IDE device OK
2226 -49 common/cmd_ide.c Image header has bad magic number
2227 49 common/cmd_ide.c Image header has correct magic number
2228 -50 common/cmd_ide.c Image header has bad checksum
2229 50 common/cmd_ide.c Image header has correct checksum
2230 -51 common/cmd_ide.c Error reading Image from IDE device
2231 51 common/cmd_ide.c reading Image from IDE device OK
2232 52 common/cmd_nand.c before loading a Image from a NAND device
2233 -53 common/cmd_nand.c Bad usage of "nand" command
2234 53 common/cmd_nand.c correct usage of "nand" command
2235 -54 common/cmd_nand.c No boot device
2236 54 common/cmd_nand.c boot device found
2237 -55 common/cmd_nand.c Unknown Chip ID on boot device
2238 55 common/cmd_nand.c correct chip ID found, device available
2239 -56 common/cmd_nand.c Error reading Image Header on boot device
2240 56 common/cmd_nand.c reading Image Header from NAND device OK
2241 -57 common/cmd_nand.c Image header has bad magic number
2242 57 common/cmd_nand.c Image header has correct magic number
2243 -58 common/cmd_nand.c Error reading Image from NAND device
2244 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002245
Heiko Schocher566a4942007-06-22 19:11:54 +02002246 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002247
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002248 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002249 -64 net/eth.c no Ethernet found.
2250 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002251
Heiko Schocher566a4942007-06-22 19:11:54 +02002252 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002253 80 common/cmd_net.c before calling net_loop()
2254 -81 common/cmd_net.c some error in net_loop() occurred
2255 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002256 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2257 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002258 83 common/cmd_net.c running "source" command
2259 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002260 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002261
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002262FIT uImage format:
2263
2264 Arg Where When
2265 100 common/cmd_bootm.c Kernel FIT Image has correct format
2266 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2267 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2268 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2269 102 common/cmd_bootm.c Kernel unit name specified
2270 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002271 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002272 104 common/cmd_bootm.c Got kernel subimage node offset
2273 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2274 105 common/cmd_bootm.c Kernel subimage hash verification OK
2275 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2276 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002277 -106 common/cmd_bootm.c Kernel subimage has wrong type
2278 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002279 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2280 108 common/cmd_bootm.c Got kernel subimage data/size
2281 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2282 -109 common/cmd_bootm.c Can't get kernel subimage type
2283 -110 common/cmd_bootm.c Can't get kernel subimage comp
2284 -111 common/cmd_bootm.c Can't get kernel subimage os
2285 -112 common/cmd_bootm.c Can't get kernel subimage load address
2286 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2287
2288 120 common/image.c Start initial ramdisk verification
2289 -120 common/image.c Ramdisk FIT image has incorrect format
2290 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002291 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002292 -122 common/image.c Can't get configuration for ramdisk subimage
2293 123 common/image.c Ramdisk unit name specified
2294 -124 common/image.c Can't get ramdisk subimage node offset
2295 125 common/image.c Got ramdisk subimage node offset
2296 -125 common/image.c Ramdisk subimage hash verification failed
2297 126 common/image.c Ramdisk subimage hash verification OK
2298 -126 common/image.c Ramdisk subimage for unsupported architecture
2299 127 common/image.c Architecture check OK
2300 -127 common/image.c Can't get ramdisk subimage data/size
2301 128 common/image.c Got ramdisk subimage data/size
2302 129 common/image.c Can't get ramdisk load address
2303 -129 common/image.c Got ramdisk load address
2304
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002305 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002306 131 common/cmd_doc.c FIT image format OK
2307
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002308 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002309 141 common/cmd_ide.c FIT image format OK
2310
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002311 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002312 151 common/cmd_nand.c FIT image format OK
2313
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002314- Standalone program support:
2315 CONFIG_STANDALONE_LOAD_ADDR
2316
Wolfgang Denk6feff892011-10-09 21:06:34 +02002317 This option defines a board specific value for the
2318 address where standalone program gets loaded, thus
2319 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002320 settings.
2321
2322- Frame Buffer Address:
2323 CONFIG_FB_ADDR
2324
2325 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002326 address for frame buffer. This is typically the case
2327 when using a graphics controller has separate video
2328 memory. U-Boot will then place the frame buffer at
2329 the given address instead of dynamically reserving it
2330 in system RAM by calling lcd_setmem(), which grabs
2331 the memory for the frame buffer depending on the
2332 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002333
2334 Please see board_init_f function.
2335
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002336- Automatic software updates via TFTP server
2337 CONFIG_UPDATE_TFTP
2338 CONFIG_UPDATE_TFTP_CNT_MAX
2339 CONFIG_UPDATE_TFTP_MSEC_MAX
2340
2341 These options enable and control the auto-update feature;
2342 for a more detailed description refer to doc/README.update.
2343
2344- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02002345 CONFIG_MTD_UBI_WL_THRESHOLD
2346 This parameter defines the maximum difference between the highest
2347 erase counter value and the lowest erase counter value of eraseblocks
2348 of UBI devices. When this threshold is exceeded, UBI starts performing
2349 wear leveling by means of moving data from eraseblock with low erase
2350 counter to eraseblocks with high erase counter.
2351
2352 The default value should be OK for SLC NAND flashes, NOR flashes and
2353 other flashes which have eraseblock life-cycle 100000 or more.
2354 However, in case of MLC NAND flashes which typically have eraseblock
2355 life-cycle less than 10000, the threshold should be lessened (e.g.,
2356 to 128 or 256, although it does not have to be power of 2).
2357
2358 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002359
Heiko Schocherff94bc42014-06-24 10:10:04 +02002360 CONFIG_MTD_UBI_BEB_LIMIT
2361 This option specifies the maximum bad physical eraseblocks UBI
2362 expects on the MTD device (per 1024 eraseblocks). If the
2363 underlying flash does not admit of bad eraseblocks (e.g. NOR
2364 flash), this value is ignored.
2365
2366 NAND datasheets often specify the minimum and maximum NVM
2367 (Number of Valid Blocks) for the flashes' endurance lifetime.
2368 The maximum expected bad eraseblocks per 1024 eraseblocks
2369 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2370 which gives 20 for most NANDs (MaxNVB is basically the total
2371 count of eraseblocks on the chip).
2372
2373 To put it differently, if this value is 20, UBI will try to
2374 reserve about 1.9% of physical eraseblocks for bad blocks
2375 handling. And that will be 1.9% of eraseblocks on the entire
2376 NAND chip, not just the MTD partition UBI attaches. This means
2377 that if you have, say, a NAND flash chip admits maximum 40 bad
2378 eraseblocks, and it is split on two MTD partitions of the same
2379 size, UBI will reserve 40 eraseblocks when attaching a
2380 partition.
2381
2382 default: 20
2383
2384 CONFIG_MTD_UBI_FASTMAP
2385 Fastmap is a mechanism which allows attaching an UBI device
2386 in nearly constant time. Instead of scanning the whole MTD device it
2387 only has to locate a checkpoint (called fastmap) on the device.
2388 The on-flash fastmap contains all information needed to attach
2389 the device. Using fastmap makes only sense on large devices where
2390 attaching by scanning takes long. UBI will not automatically install
2391 a fastmap on old images, but you can set the UBI parameter
2392 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2393 that fastmap-enabled images are still usable with UBI implementations
2394 without fastmap support. On typical flash devices the whole fastmap
2395 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2396
2397 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2398 Set this parameter to enable fastmap automatically on images
2399 without a fastmap.
2400 default: 0
2401
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002402 CONFIG_MTD_UBI_FM_DEBUG
2403 Enable UBI fastmap debug
2404 default: 0
2405
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002406- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002407 CONFIG_SPL
2408 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002409
Tom Rini95579792012-02-14 07:29:40 +00002410 CONFIG_SPL_LDSCRIPT
2411 LDSCRIPT for linking the SPL binary.
2412
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002413 CONFIG_SPL_MAX_FOOTPRINT
2414 Maximum size in memory allocated to the SPL, BSS included.
2415 When defined, the linker checks that the actual memory
2416 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002417 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002418 must not be both defined at the same time.
2419
Tom Rini95579792012-02-14 07:29:40 +00002420 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002421 Maximum size of the SPL image (text, data, rodata, and
2422 linker lists sections), BSS excluded.
2423 When defined, the linker checks that the actual size does
2424 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002425
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002426 CONFIG_SPL_TEXT_BASE
2427 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002428
Scott Wood94a45bb2012-09-20 19:05:12 -05002429 CONFIG_SPL_RELOC_TEXT_BASE
2430 Address to relocate to. If unspecified, this is equal to
2431 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2432
Tom Rini95579792012-02-14 07:29:40 +00002433 CONFIG_SPL_BSS_START_ADDR
2434 Link address for the BSS within the SPL binary.
2435
2436 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002437 Maximum size in memory allocated to the SPL BSS.
2438 When defined, the linker checks that the actual memory used
2439 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002440 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002441 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002442
2443 CONFIG_SPL_STACK
2444 Adress of the start of the stack SPL will use
2445
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002446 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2447 When defined, SPL will panic() if the image it has
2448 loaded does not have a signature.
2449 Defining this is useful when code which loads images
2450 in SPL cannot guarantee that absolutely all read errors
2451 will be caught.
2452 An example is the LPC32XX MLC NAND driver, which will
2453 consider that a completely unreadable NAND block is bad,
2454 and thus should be skipped silently.
2455
Scott Wood94a45bb2012-09-20 19:05:12 -05002456 CONFIG_SPL_RELOC_STACK
2457 Adress of the start of the stack SPL will use after
2458 relocation. If unspecified, this is equal to
2459 CONFIG_SPL_STACK.
2460
Tom Rini95579792012-02-14 07:29:40 +00002461 CONFIG_SYS_SPL_MALLOC_START
2462 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002463 When this option is set the full malloc is used in SPL and
2464 it is set up by spl_init() and before that, the simple malloc()
2465 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002466
2467 CONFIG_SYS_SPL_MALLOC_SIZE
2468 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002469
Tom Rini9607faf2014-03-28 12:03:39 -04002470 CONFIG_SPL_OS_BOOT
2471 Enable booting directly to an OS from SPL.
2472 See also: doc/README.falcon
2473
Tom Rini861a86f2012-08-13 11:37:56 -07002474 CONFIG_SPL_DISPLAY_PRINT
2475 For ARM, enable an optional function to print more information
2476 about the running system.
2477
Scott Wood4b919722012-09-20 16:35:21 -05002478 CONFIG_SPL_INIT_MINIMAL
2479 Arch init code should be built for a very small image
2480
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002481 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2482 Partition on the MMC to load U-Boot from when the MMC is being
2483 used in raw mode
2484
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002485 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2486 Sector to load kernel uImage from when MMC is being
2487 used in raw mode (for Falcon mode)
2488
2489 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2490 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2491 Sector and number of sectors to load kernel argument
2492 parameters from when MMC is being used in raw mode
2493 (for falcon mode)
2494
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002495 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2496 Partition on the MMC to load U-Boot from when the MMC is being
2497 used in fs mode
2498
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002499 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2500 Filename to read to load U-Boot when reading from filesystem
2501
2502 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002503 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002504 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002505
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002506 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002507 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002508 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002509
Scott Wood06f60ae2012-12-06 13:33:17 +00002510 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2511 Set this for NAND SPL on PPC mpc83xx targets, so that
2512 start.S waits for the rest of the SPL to load before
2513 continuing (the hardware starts execution after just
2514 loading the first page rather than the full 4K).
2515
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302516 CONFIG_SPL_SKIP_RELOCATE
2517 Avoid SPL relocation
2518
Scott Wood6f2f01b2012-09-20 19:09:07 -05002519 CONFIG_SPL_NAND_BASE
2520 Include nand_base.c in the SPL. Requires
2521 CONFIG_SPL_NAND_DRIVERS.
2522
2523 CONFIG_SPL_NAND_DRIVERS
2524 SPL uses normal NAND drivers, not minimal drivers.
2525
Jörg Krause15e207f2018-01-14 19:26:38 +01002526 CONFIG_SPL_NAND_IDENT
2527 SPL uses the chip ID list to identify the NAND flash.
2528 Requires CONFIG_SPL_NAND_BASE.
2529
Scott Wood6f2f01b2012-09-20 19:09:07 -05002530 CONFIG_SPL_NAND_ECC
2531 Include standard software ECC in the SPL
2532
Tom Rini95579792012-02-14 07:29:40 +00002533 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002534 Support for NAND boot using simple NAND drivers that
2535 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002536
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002537 CONFIG_SPL_UBI
2538 Support for a lightweight UBI (fastmap) scanner and
2539 loader
2540
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002541 CONFIG_SPL_NAND_RAW_ONLY
2542 Support to boot only raw u-boot.bin images. Use this only
2543 if you need to save space.
2544
Ying Zhang7c8eea52013-08-16 15:16:12 +08002545 CONFIG_SPL_COMMON_INIT_DDR
2546 Set for common ddr init with serial presence detect in
2547 SPL binary.
2548
Tom Rini95579792012-02-14 07:29:40 +00002549 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2550 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2551 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2552 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2553 CONFIG_SYS_NAND_ECCBYTES
2554 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002555 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002556
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05302557 CONFIG_SPL_NAND_BOOT
2558 Add support NAND boot
2559
Tom Rini95579792012-02-14 07:29:40 +00002560 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002561 Location in NAND to read U-Boot from
2562
2563 CONFIG_SYS_NAND_U_BOOT_DST
2564 Location in memory to load U-Boot to
2565
2566 CONFIG_SYS_NAND_U_BOOT_SIZE
2567 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002568
2569 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002570 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002571
2572 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2573 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002574 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002575
Pavel Machekc57b9532012-08-30 22:42:11 +02002576 CONFIG_SPL_RAM_DEVICE
2577 Support for running image already present in ram, in SPL binary
2578
Scott Wood74752ba2012-12-06 13:33:16 +00002579 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002580 Image offset to which the SPL should be padded before appending
2581 the SPL payload. By default, this is defined as
2582 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2583 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2584 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002585
Scott Woodca2fca22012-09-21 16:27:32 -05002586 CONFIG_SPL_TARGET
2587 Final target image containing SPL and payload. Some SPLs
2588 use an arch-specific makefile fragment instead, for
2589 example if more than one image needs to be produced.
2590
Marek Vasutb527b9c2018-05-13 00:22:52 +02002591 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00002592 Printing information about a FIT image adds quite a bit of
2593 code to SPL. So this is normally disabled in SPL. Use this
2594 option to re-enable it. This will affect the output of the
2595 bootm command when booting a FIT image.
2596
Ying Zhang3aa29de2013-08-16 15:16:15 +08002597- TPL framework
2598 CONFIG_TPL
2599 Enable building of TPL globally.
2600
2601 CONFIG_TPL_PAD_TO
2602 Image offset to which the TPL should be padded before appending
2603 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002604 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2605 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2606 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002607
wdenka8c7c702003-12-06 19:49:23 +00002608- Interrupt support (PPC):
2609
wdenkd4ca31c2004-01-02 14:00:00 +00002610 There are common interrupt_init() and timer_interrupt()
2611 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002612 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002613 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002614 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002615 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002616 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002617 specific handling. If board has watchdog / status_led
2618 / other_activity_monitor it works automatically from
2619 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002620
wdenkc6097192002-11-03 00:24:07 +00002621
Helmut Raiger9660e442011-10-20 04:19:47 +00002622Board initialization settings:
2623------------------------------
2624
2625During Initialization u-boot calls a number of board specific functions
2626to allow the preparation of board specific prerequisites, e.g. pin setup
2627before drivers are initialized. To enable these callbacks the
2628following configuration macros have to be defined. Currently this is
2629architecture specific, so please check arch/your_architecture/lib/board.c
2630typically in board_init_f() and board_init_r().
2631
2632- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2633- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2634- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2635- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002636
wdenkc6097192002-11-03 00:24:07 +00002637Configuration Settings:
2638-----------------------
2639
York Sun4d1fd7f2014-02-26 17:03:19 -08002640- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2641 Optionally it can be defined to support 64-bit memory commands.
2642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002644 undefine this when you're short of memory.
2645
Peter Tyser2fb26042009-01-27 18:03:12 -06002646- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2647 width of the commands listed in the 'help' command output.
2648
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002649- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002650 prompt for user input.
2651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002652- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002656- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002657
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002658- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002659 the application (usually a Linux kernel) when it is
2660 booted
2661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002662- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002663 List of legal baudrate settings for this board.
2664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002665- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002666 Begin and End addresses of the area used by the
2667 simple memory test.
2668
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002669- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002670 Scratch address used by the alternate memory test
2671 You only need to set this if address zero isn't writeable
2672
York Sune8149522015-12-04 11:57:07 -08002673- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002674 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002675 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2676 is substracted from total RAM and won't be reported to OS.
2677 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07002678 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08002679 the RAM base is not zero, or RAM is divided into banks,
2680 this variable needs to be recalcuated to get the address.
2681
York Sunaabd7dd2015-12-07 11:05:29 -08002682- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002684 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002685 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002686 fixing up gd->ram_size the Linux kernel should gets passed
2687 the now "corrected" memory size and won't touch it either.
2688 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002689 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002690 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002691 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002692
2693 This option can be used as a workaround for the 440EPx/GRx
2694 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2695 be touched.
2696
2697 WARNING: Please make sure that this value is a multiple of
2698 the Linux page size (normally 4k). If this is not the case,
2699 then the end address of the Linux memory will be located at a
2700 non page size aligned address and this could cause major
2701 problems.
2702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002704 Enable temporary baudrate change while serial download
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002707 Physical start address of SDRAM. _Must_ be 0 here.
2708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002710 Physical start address of Flash memory.
2711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002713 Physical start address of boot monitor code (set by
2714 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002715 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002716 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002719 Size of memory reserved for monitor code, used to
2720 determine _at_compile_time_ (!) if the environment is
2721 embedded within the U-Boot image, or in a separate
2722 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002724- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002725 Size of DRAM reserved for malloc() use.
2726
Simon Glassd59476b2014-07-10 22:23:28 -06002727- CONFIG_SYS_MALLOC_F_LEN
2728 Size of the malloc() pool for use before relocation. If
2729 this is defined, then a very simple malloc() implementation
2730 will become available before relocation. The address is just
2731 below the global data, and the stack is moved down to make
2732 space.
2733
2734 This feature allocates regions with increasing addresses
2735 within the region. calloc() is supported, but realloc()
2736 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002737 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06002738 U-Boot relocates itself.
2739
Simon Glass38687ae2014-11-10 17:16:54 -07002740- CONFIG_SYS_MALLOC_SIMPLE
2741 Provides a simple and small malloc() and calloc() for those
2742 boards which do not use the full malloc in SPL (which is
2743 enabled with CONFIG_SYS_SPL_MALLOC_START).
2744
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07002745- CONFIG_SYS_NONCACHED_MEMORY:
2746 Size of non-cached memory area. This area of memory will be
2747 typically located right below the malloc() area and mapped
2748 uncached in the MMU. This is useful for drivers that would
2749 otherwise require a lot of explicit cache maintenance. For
2750 some drivers it's also impossible to properly maintain the
2751 cache. For example if the regions that need to be flushed
2752 are not a multiple of the cache-line size, *and* padding
2753 cannot be allocated between the regions to align them (i.e.
2754 if the HW requires a contiguous array of regions, and the
2755 size of each region is not cache-aligned), then a flush of
2756 one region may result in overwriting data that hardware has
2757 written to another region in the same cache-line. This can
2758 happen for example in network drivers where descriptors for
2759 buffers are typically smaller than the CPU cache-line (e.g.
2760 16 bytes vs. 32 or 64 bytes).
2761
2762 Non-cached memory is only supported on 32-bit ARM at present.
2763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002764- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002765 Normally compressed uImages are limited to an
2766 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002767 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002768 to adjust this setting to your needs.
2769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002770- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002771 Maximum size of memory mapped by the startup code of
2772 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002773 the Linux kernel (bd_info, boot arguments, FDT blob if
2774 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002775 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002776 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002777 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002778 variable "bootm_mapsize" will override the value of
2779 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2780 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002781
John Rigbyfca43cc2010-10-13 13:57:35 -06002782- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2783 Enable initrd_high functionality. If defined then the
2784 initrd_high feature is enabled and the bootm ramdisk subcommand
2785 is enabled.
2786
2787- CONFIG_SYS_BOOT_GET_CMDLINE:
2788 Enables allocating and saving kernel cmdline in space between
2789 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2790
2791- CONFIG_SYS_BOOT_GET_KBD:
2792 Enables allocating and saving a kernel copy of the bd_info in
2793 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002796 Max number of Flash memory banks
2797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002798- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002799 Max number of sectors on a Flash chip
2800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002802 Timeout for Flash erase operations (in ms)
2803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002804- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002805 Timeout for Flash write operations (in ms)
2806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002808 Timeout for Flash set sector lock bit operation (in ms)
2809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002810- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002811 Timeout for Flash clear lock bits operation (in ms)
2812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002814 If defined, hardware flash sectors protection is used
2815 instead of U-Boot software protection.
2816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002817- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002818
2819 Enable TFTP transfers directly to flash memory;
2820 without this option such a download has to be
2821 performed in two steps: (1) download to RAM, and (2)
2822 copy from RAM to flash.
2823
2824 The two-step approach is usually more reliable, since
2825 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002826 the flash, but in some situations (when system RAM is
2827 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002828 downloaded image) this option may be very useful.
2829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002830- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002831 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002832 common flash structure for storing flash geometry.
2833
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002834- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002835 This option also enables the building of the cfi_flash driver
2836 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002837
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002838- CONFIG_FLASH_CFI_MTD
2839 This option enables the building of the cfi_mtd driver
2840 in the drivers directory. The driver exports CFI flash
2841 to the MTD layer.
2842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002843- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002844 Use buffered writes to flash.
2845
2846- CONFIG_FLASH_SPANSION_S29WS_N
2847 s29ws-n MirrorBit flash has non-standard addresses for buffered
2848 write commands.
2849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002851 If this option is defined, the common CFI flash doesn't
2852 print it's warning upon not recognized FLASH banks. This
2853 is useful, if some of the configured banks are only
2854 optionally available.
2855
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002856- CONFIG_FLASH_SHOW_PROGRESS
2857 If defined (must be an integer), print out countdown
2858 digits and dots. Recommended value: 45 (9..1) for 80
2859 column displays, 15 (3..1) for 40 column displays.
2860
Stefan Roese352ef3f2013-04-04 15:53:14 +02002861- CONFIG_FLASH_VERIFY
2862 If defined, the content of the flash (destination) is compared
2863 against the source after the write operation. An error message
2864 will be printed when the contents are not identical.
2865 Please note that this option is useless in nearly all cases,
2866 since such flash programming errors usually are detected earlier
2867 while unprotecting/erasing/programming. Please only enable
2868 this option if you really know what you are doing.
2869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002871 Defines the number of Ethernet receive buffers. On some
2872 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002873 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2874 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002875 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002876 Defaults to 4 if not defined.
2877
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002878- CONFIG_ENV_MAX_ENTRIES
2879
Wolfgang Denk071bc922010-10-27 22:48:30 +02002880 Maximum number of entries in the hash table that is used
2881 internally to store the environment settings. The default
2882 setting is supposed to be generous and should work in most
2883 cases. This setting can be used to tune behaviour; see
2884 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002885
Joe Hershberger25980902012-12-11 22:16:31 -06002886- CONFIG_ENV_FLAGS_LIST_DEFAULT
2887- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002888 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06002889 calling env set. Variables can be restricted to only decimal,
2890 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2891 the variables can also be restricted to IP address or MAC address.
2892
2893 The format of the list is:
2894 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002895 access_attribute = [a|r|o|c]
2896 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06002897 entry = variable_name[:attributes]
2898 list = entry[,list]
2899
2900 The type attributes are:
2901 s - String (default)
2902 d - Decimal
2903 x - Hexadecimal
2904 b - Boolean ([1yYtT|0nNfF])
2905 i - IP address
2906 m - MAC address
2907
Joe Hershberger267541f2012-12-11 22:16:34 -06002908 The access attributes are:
2909 a - Any (default)
2910 r - Read-only
2911 o - Write-once
2912 c - Change-default
2913
Joe Hershberger25980902012-12-11 22:16:31 -06002914 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2915 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002916 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06002917
2918 - CONFIG_ENV_FLAGS_LIST_STATIC
2919 Define this to a list (string) to define validation that
2920 should be done if an entry is not found in the ".flags"
2921 environment variable. To override a setting in the static
2922 list, simply add an entry for the same variable name to the
2923 ".flags" variable.
2924
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05002925 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2926 regular expression. This allows multiple variables to define the same
2927 flags without explicitly listing them for each variable.
2928
Joe Hershberger267541f2012-12-11 22:16:34 -06002929- CONFIG_ENV_ACCESS_IGNORE_FORCE
2930 If defined, don't allow the -f switch to env set override variable
2931 access flags.
2932
wdenkc6097192002-11-03 00:24:07 +00002933The following definitions that deal with the placement and management
2934of environment data (variable area); in general, we support the
2935following configurations:
2936
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002937- CONFIG_BUILD_ENVCRC:
2938
2939 Builds up envcrc with the target environment so that external utils
2940 may easily extract it and embed it in final U-Boot images.
2941
wdenkc6097192002-11-03 00:24:07 +00002942BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002943in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002944console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002945U-Boot will hang.
2946
2947Please note that even with NVRAM we still use a copy of the
2948environment in RAM: we could work on NVRAM directly, but we want to
2949keep settings there always unmodified except somebody uses "saveenv"
2950to save the current settings.
2951
Liu Gang0a85a9e2012-03-08 00:33:20 +00002952BE CAREFUL! For some special cases, the local device can not use
2953"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00002954environment stored in a remote NOR flash by SRIO or PCIE link,
2955but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00002956
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002957- CONFIG_NAND_ENV_DST
2958
2959 Defines address in RAM to which the nand_spl code should copy the
2960 environment. If redundant environment is used, it will be copied to
2961 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2962
Bruce Adlere881cb52007-11-02 13:15:42 -07002963Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002964has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06002965created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002966until then to read environment variables.
2967
wdenk85ec0bc2003-03-31 16:34:49 +00002968The environment is protected by a CRC32 checksum. Before the monitor
2969is relocated into RAM, as a result of a bad CRC you will be working
2970with the compiled-in default environment - *silently*!!! [This is
2971necessary, because the first environment variable we need is the
2972"baudrate" setting for the console - if we have a bad CRC, we don't
2973have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002974
2975Note: once the monitor has been relocated, then it will complain if
2976the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002977use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002979- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002980 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002982 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002983 also needs to be defined.
2984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002985- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002986 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002987
Ron Madridf5675aa2009-02-18 14:30:44 -08002988- CONFIG_NS16550_MIN_FUNCTIONS:
2989 Define this if you desire to only have use of the NS16550_init
2990 and NS16550_putc functions for the serial driver located at
2991 drivers/serial/ns16550.c. This option is useful for saving
2992 space for already greatly restricted images, including but not
2993 limited to NAND_SPL configurations.
2994
Simon Glassb2b92f52012-11-30 13:01:18 +00002995- CONFIG_DISPLAY_BOARDINFO
2996 Display information about the board that U-Boot is running on
2997 when U-Boot starts up. The board function checkboard() is called
2998 to do this.
2999
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003000- CONFIG_DISPLAY_BOARDINFO_LATE
3001 Similar to the previous option, but display this information
3002 later, once stdio is running and output goes to the LCD, if
3003 present.
3004
Sascha Silbefeb85802013-08-11 16:40:43 +02003005- CONFIG_BOARD_SIZE_LIMIT:
3006 Maximum size of the U-Boot image. When defined, the
3007 build system checks that the actual size does not
3008 exceed it.
3009
wdenkc6097192002-11-03 00:24:07 +00003010Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003011---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003013- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003014 Cache Line Size of the CPU.
3015
Timur Tabie46fedf2011-08-04 18:03:41 -05003016- CONFIG_SYS_CCSRBAR_DEFAULT:
3017 Default (power-on reset) physical address of CCSR on Freescale
3018 PowerPC SOCs.
3019
3020- CONFIG_SYS_CCSRBAR:
3021 Virtual address of CCSR. On a 32-bit build, this is typically
3022 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3023
Timur Tabie46fedf2011-08-04 18:03:41 -05003024- CONFIG_SYS_CCSRBAR_PHYS:
3025 Physical address of CCSR. CCSR can be relocated to a new
3026 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003027 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003028 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3029 is typically relocated on 36-bit builds. It is recommended
3030 that this macro be defined via the _HIGH and _LOW macros:
3031
3032 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3033 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3034
3035- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003036 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3037 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003038 used in assembly code, so it must not contain typecasts or
3039 integer size suffixes (e.g. "ULL").
3040
3041- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3042 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3043 used in assembly code, so it must not contain typecasts or
3044 integer size suffixes (e.g. "ULL").
3045
3046- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3047 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3048 forced to a value that ensures that CCSR is not relocated.
3049
wdenk7f6c2cb2002-11-10 22:06:23 +00003050- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003051 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003052
3053 the default drive number (default value 0)
3054
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003055 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003056
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003057 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003058 (default value 1)
3059
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003060 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003061
wdenk43d96162003-03-06 00:02:04 +00003062 defines the offset of register from address. It
3063 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003064 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003066 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3067 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003068 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003070 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003071 fdc_hw_init() is called at the beginning of the FDC
3072 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003073 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003074 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003075
Macpaul Lin0abddf82011-04-11 20:45:32 +00003076- CONFIG_IDE_AHB:
3077 Most IDE controllers were designed to be connected with PCI
3078 interface. Only few of them were designed for AHB interface.
3079 When software is doing ATA command and data transfer to
3080 IDE devices through IDE-AHB controller, some additional
3081 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003082 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003083
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003085 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003086 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003088- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003089
wdenk7152b1d2003-09-05 23:19:14 +00003090 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003091 initial data and stack; please note that this must be
3092 writable memory that is working WITHOUT special
3093 initialization, i. e. you CANNOT use normal RAM which
3094 will become available only after programming the
3095 memory controller and running certain initialization
3096 sequences.
3097
3098 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003099 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003101- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003102
3103 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003104 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3105 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003106 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003107 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003108 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003109 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3110 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003111
3112 Note:
3113 On the MPC824X (or other systems that use the data
3114 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003116 point to an otherwise UNUSED address space between
3117 the top of RAM and the start of the PCI space.
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003121- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003122 SDRAM timing
3123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003125 periodic timer for refresh
3126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003127- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3128 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3129 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3130 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003131 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3132
3133- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003134 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3135 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003136 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3137
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003138- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003139 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003140 Don't do any setup work, presumably because someone or
3141 something has already done it, and we don't need to do it
3142 a second time. Useful for platforms that are pre-booted
3143 by coreboot or similar.
3144
Gabor Juhos842033e2013-05-30 07:06:12 +00003145- CONFIG_PCI_INDIRECT_BRIDGE:
3146 Enable support for indirect PCI bridges.
3147
Kumar Galaa09b9b62010-12-30 12:09:53 -06003148- CONFIG_SYS_SRIO:
3149 Chip has SRIO or not
3150
3151- CONFIG_SRIO1:
3152 Board has SRIO 1 port available
3153
3154- CONFIG_SRIO2:
3155 Board has SRIO 2 port available
3156
Liu Gangc8b28152013-05-07 16:30:46 +08003157- CONFIG_SRIO_PCIE_BOOT_MASTER
3158 Board can support master function for Boot from SRIO and PCIE
3159
Kumar Galaa09b9b62010-12-30 12:09:53 -06003160- CONFIG_SYS_SRIOn_MEM_VIRT:
3161 Virtual Address of SRIO port 'n' memory region
3162
3163- CONFIG_SYS_SRIOn_MEM_PHYS:
3164 Physical Address of SRIO port 'n' memory region
3165
3166- CONFIG_SYS_SRIOn_MEM_SIZE:
3167 Size of SRIO port 'n' memory region
3168
Fabio Estevam66bd1842013-04-11 09:35:34 +00003169- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3170 Defined to tell the NAND controller that the NAND chip is using
3171 a 16 bit bus.
3172 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003173 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02003174 - drivers/mtd/nand/raw/ndfc.c
3175 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003176
3177- CONFIG_SYS_NDFC_EBC0_CFG
3178 Sets the EBC0_CFG register for the NDFC. If not defined
3179 a default value will be used.
3180
Ben Warrenbb99ad62006-09-07 16:50:54 -04003181- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003182 Get DDR timing information from an I2C EEPROM. Common
3183 with pluggable memory modules such as SODIMMs
3184
Ben Warrenbb99ad62006-09-07 16:50:54 -04003185 SPD_EEPROM_ADDRESS
3186 I2C address of the SPD EEPROM
3187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003188- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003189 If SPD EEPROM is on an I2C bus other than the first
3190 one, specify here. Note that the value must resolve
3191 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003192
York Sun1b3e3c42011-06-07 09:42:16 +08003193- CONFIG_SYS_DDR_RAW_TIMING
3194 Get DDR timing information from other than SPD. Common with
3195 soldered DDR chips onboard without SPD. DDR raw timing
3196 parameters are extracted from datasheet and hard-coded into
3197 header files or board specific files.
3198
York Sun6f5e1dc2011-09-16 13:21:35 -07003199- CONFIG_FSL_DDR_INTERACTIVE
3200 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3201
York Sune32d59a2015-01-06 13:18:55 -08003202- CONFIG_FSL_DDR_SYNC_REFRESH
3203 Enable sync of refresh for multiple controllers.
3204
York Sun4516ff82015-03-19 09:30:28 -07003205- CONFIG_FSL_DDR_BIST
3206 Enable built-in memory test for Freescale DDR controllers.
3207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003208- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003209 Only for 83xx systems. If specified, then DDR should
3210 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003211
wdenkc26e4542004-04-18 10:13:26 +00003212- CONFIG_RMII
3213 Enable RMII mode for all FECs.
3214 Note that this is a global option, we can't
3215 have one FEC in standard MII mode and another in RMII mode.
3216
wdenk5cf91d62004-04-23 20:32:05 +00003217- CONFIG_CRC32_VERIFY
3218 Add a verify option to the crc32 command.
3219 The syntax is:
3220
3221 => crc32 -v <address> <count> <crc32>
3222
3223 Where address/count indicate a memory area
3224 and crc32 is the correct crc32 which the
3225 area should have.
3226
wdenk56523f12004-07-11 17:40:54 +00003227- CONFIG_LOOPW
3228 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06003229 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00003230
stroese7b466642004-12-16 18:46:55 +00003231- CONFIG_MX_CYCLIC
3232 Add the "mdc" and "mwc" memory commands. These are cyclic
3233 "md/mw" commands.
3234 Examples:
3235
wdenkefe2a4d2004-12-16 21:44:03 +00003236 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003237 This command will print 4 bytes (10,11,12,13) each 500 ms.
3238
wdenkefe2a4d2004-12-16 21:44:03 +00003239 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003240 This command will write 12345678 to address 100 all 10 ms.
3241
wdenkefe2a4d2004-12-16 21:44:03 +00003242 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06003243 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00003244
wdenk8aa1a2d2005-04-04 12:44:11 +00003245- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chen3fafced2017-12-26 13:55:59 +08003246 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003247 low level initializations (like setting up the memory
3248 controller) are omitted and/or U-Boot does not
3249 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003250
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003251 Normally this variable MUST NOT be defined. The only
3252 exception is when U-Boot is loaded (to RAM) by some
3253 other boot loader or by a debugger which performs
3254 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003255
Simon Glassb5bd0982016-05-05 07:28:06 -06003256- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3257 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003258 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003259 instruction cache) is still performed.
3260
Aneesh V401bb302011-07-13 05:11:07 +00003261- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003262 Modifies the behaviour of start.S when compiling a loader
3263 that is executed before the actual U-Boot. E.g. when
3264 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003265
Ying Zhang3aa29de2013-08-16 15:16:15 +08003266- CONFIG_TPL_BUILD
3267 Modifies the behaviour of start.S when compiling a loader
3268 that is executed after the SPL and before the actual U-Boot.
3269 It is loaded by the SPL.
3270
Ying Zhang5df572f2013-05-20 14:07:23 +08003271- CONFIG_SYS_MPC85XX_NO_RESETVEC
3272 Only for 85xx systems. If this variable is specified, the section
3273 .resetvec is not kept and the section .bootpg is placed in the
3274 previous 4k of the .text section.
3275
Simon Glass4213fc22013-02-24 17:33:14 +00003276- CONFIG_ARCH_MAP_SYSMEM
3277 Generally U-Boot (and in particular the md command) uses
3278 effective address. It is therefore not necessary to regard
3279 U-Boot address as virtual addresses that need to be translated
3280 to physical addresses. However, sandbox requires this, since
3281 it maintains its own little RAM buffer which contains all
3282 addressable memory. This option causes some memory accesses
3283 to be mapped through map_sysmem() / unmap_sysmem().
3284
Simon Glass588a13f2013-02-14 04:18:54 +00003285- CONFIG_X86_RESET_VECTOR
3286 If defined, the x86 reset vector code is included. This is not
3287 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003288
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003289- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3290 Option to disable subpage write in NAND driver
3291 driver that uses this:
Miquel Raynala430fa02018-08-16 17:30:07 +02003292 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003293
Timur Tabif2717b42011-11-22 09:21:25 -06003294Freescale QE/FMAN Firmware Support:
3295-----------------------------------
3296
3297The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3298loading of "firmware", which is encoded in the QE firmware binary format.
3299This firmware often needs to be loaded during U-Boot booting, so macros
3300are used to identify the storage device (NOR flash, SPI, etc) and the address
3301within that device.
3302
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003303- CONFIG_SYS_FMAN_FW_ADDR
3304 The address in the storage device where the FMAN microcode is located. The
3305 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3306 is also specified.
3307
3308- CONFIG_SYS_QE_FW_ADDR
3309 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003310 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3311 is also specified.
3312
3313- CONFIG_SYS_QE_FMAN_FW_LENGTH
3314 The maximum possible size of the firmware. The firmware binary format
3315 has a field that specifies the actual size of the firmware, but it
3316 might not be possible to read any part of the firmware unless some
3317 local storage is allocated to hold the entire firmware first.
3318
3319- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3320 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3321 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3322 virtual address in NOR flash.
3323
3324- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3325 Specifies that QE/FMAN firmware is located in NAND flash.
3326 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3327
3328- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3329 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3330 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3331
Liu Gang292dc6c2012-03-08 00:33:18 +00003332- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3333 Specifies that QE/FMAN firmware is located in the remote (master)
3334 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003335 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3336 window->master inbound window->master LAW->the ucode address in
3337 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003338
J. German Riverab940ca62014-06-23 15:15:55 -07003339Freescale Layerscape Management Complex Firmware Support:
3340---------------------------------------------------------
3341The Freescale Layerscape Management Complex (MC) supports the loading of
3342"firmware".
3343This firmware often needs to be loaded during U-Boot booting, so macros
3344are used to identify the storage device (NOR flash, SPI, etc) and the address
3345within that device.
3346
3347- CONFIG_FSL_MC_ENET
3348 Enable the MC driver for Layerscape SoCs.
3349
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303350Freescale Layerscape Debug Server Support:
3351-------------------------------------------
3352The Freescale Layerscape Debug Server Support supports the loading of
3353"Debug Server firmware" and triggering SP boot-rom.
3354This firmware often needs to be loaded during U-Boot booting.
3355
York Sunc0492142015-12-07 11:08:58 -08003356- CONFIG_SYS_MC_RSV_MEM_ALIGN
3357 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303358
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003359Reproducible builds
3360-------------------
3361
3362In order to achieve reproducible builds, timestamps used in the U-Boot build
3363process have to be set to a fixed value.
3364
3365This is done using the SOURCE_DATE_EPOCH environment variable.
3366SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3367option for U-Boot or an environment variable in U-Boot.
3368
3369SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3370
wdenkc6097192002-11-03 00:24:07 +00003371Building the Software:
3372======================
3373
Wolfgang Denk218ca722008-03-26 10:40:12 +01003374Building U-Boot has been tested in several native build environments
3375and in many different cross environments. Of course we cannot support
3376all possibly existing versions of cross development tools in all
3377(potentially obsolete) versions. In case of tool chain problems we
3378recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3379which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003380
Wolfgang Denk218ca722008-03-26 10:40:12 +01003381If you are not using a native environment, it is assumed that you
3382have GNU cross compiling tools available in your path. In this case,
3383you must set the environment variable CROSS_COMPILE in your shell.
3384Note that no changes to the Makefile or any other source files are
3385necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003386
Wolfgang Denk218ca722008-03-26 10:40:12 +01003387 $ CROSS_COMPILE=ppc_4xx-
3388 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003389
Peter Tyser2f8d3962009-03-13 18:54:51 -05003390Note: If you wish to generate Windows versions of the utilities in
3391 the tools directory you can use the MinGW toolchain
3392 (http://www.mingw.org). Set your HOST tools to the MinGW
3393 toolchain and execute 'make tools'. For example:
3394
3395 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3396
3397 Binaries such as tools/mkimage.exe will be created which can
3398 be executed on computers running Windows.
3399
Wolfgang Denk218ca722008-03-26 10:40:12 +01003400U-Boot is intended to be simple to build. After installing the
3401sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003402is done by typing:
3403
Holger Freytherab584d62014-08-04 09:26:05 +02003404 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003405
Holger Freytherab584d62014-08-04 09:26:05 +02003406where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003407rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003408
wdenk2729af92004-05-03 20:45:30 +00003409Note: for some board special configuration names may exist; check if
3410 additional information is available from the board vendor; for
3411 instance, the TQM823L systems are available without (standard)
3412 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003413 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003414
Holger Freytherab584d62014-08-04 09:26:05 +02003415 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003416 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003417
Holger Freytherab584d62014-08-04 09:26:05 +02003418 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003419 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421 etc.
wdenkc6097192002-11-03 00:24:07 +00003422
wdenkc6097192002-11-03 00:24:07 +00003423
wdenk2729af92004-05-03 20:45:30 +00003424Finally, type "make all", and you should get some working U-Boot
3425images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003426
wdenk2729af92004-05-03 20:45:30 +00003427- "u-boot.bin" is a raw binary image
3428- "u-boot" is an image in ELF binary format
3429- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003430
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003431By default the build is performed locally and the objects are saved
3432in the source directory. One of the two methods can be used to change
3433this behavior and build U-Boot to some external directory:
3434
34351. Add O= to the make command line invocations:
3436
3437 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003438 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003439 make O=/tmp/build all
3440
Timo Ketolaadbba992014-11-06 14:39:05 +020034412. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003442
Timo Ketolaadbba992014-11-06 14:39:05 +02003443 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003444 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003445 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003446 make all
3447
Timo Ketolaadbba992014-11-06 14:39:05 +02003448Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003449variable.
3450
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01003451User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3452setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3453For example to treat all compiler warnings as errors:
3454
3455 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457Please be aware that the Makefiles assume you are using GNU make, so
3458for instance on NetBSD you might need to use "gmake" instead of
3459native "make".
wdenkc6097192002-11-03 00:24:07 +00003460
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk2729af92004-05-03 20:45:30 +00003462If the system board that you have is not listed, then you will need
3463to port U-Boot to your hardware platform. To do this, follow these
3464steps:
wdenkc6097192002-11-03 00:24:07 +00003465
Phil Sutter3c1496c2015-12-25 14:41:18 +010034661. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003467 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003468 the "Makefile" and a "<board>.c".
34692. Create a new configuration file "include/configs/<board>.h" for
3470 your board.
wdenk2729af92004-05-03 20:45:30 +000034713. If you're porting U-Boot to a new CPU, then also create a new
3472 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020034734. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000034745. Type "make", and you should get a working "u-boot.srec" file
3475 to be installed on your target system.
34766. Debug and solve any problems that might arise.
3477 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003478
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3481==============================================================
wdenkc6097192002-11-03 00:24:07 +00003482
Wolfgang Denk218ca722008-03-26 10:40:12 +01003483If you have modified U-Boot sources (for instance added a new board
3484or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003485provide feedback to the other developers. The feedback normally takes
3486the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003487official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003488
Wolfgang Denk218ca722008-03-26 10:40:12 +01003489But before you submit such a patch, please verify that your modifi-
3490cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003491the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003492just run the buildman script (tools/buildman/buildman), which will
3493configure and build U-Boot for ALL supported system. Be warned, this
3494will take a while. Please see the buildman README, or run 'buildman -H'
3495for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003496
3497
wdenk2729af92004-05-03 20:45:30 +00003498See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003499
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501Monitor Commands - Overview:
3502============================
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504go - start application at address 'addr'
3505run - run commands in an environment variable
3506bootm - boot application image from memory
3507bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003508bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003509tftpboot- boot image via network using TFTP protocol
3510 and env variables "ipaddr" and "serverip"
3511 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003512tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003513rarpboot- boot image via network using RARP/TFTP protocol
3514diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3515loads - load S-Record file over serial line
3516loadb - load binary file over serial line (kermit mode)
3517md - memory display
3518mm - memory modify (auto-incrementing)
3519nm - memory modify (constant address)
3520mw - memory write (fill)
3521cp - memory copy
3522cmp - memory compare
3523crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003524i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003525sspi - SPI utility commands
3526base - print or set address offset
3527printenv- print environment variables
3528setenv - set environment variables
3529saveenv - save environment variables to persistent storage
3530protect - enable or disable FLASH write protection
3531erase - erase FLASH memory
3532flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003533nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003534bdinfo - print Board Info structure
3535iminfo - print header information for application image
3536coninfo - print console devices and informations
3537ide - IDE sub-system
3538loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003539loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003540mtest - simple RAM test
3541icache - enable or disable instruction cache
3542dcache - enable or disable data cache
3543reset - Perform RESET of the CPU
3544echo - echo args to console
3545version - print monitor version
3546help - print online help
3547? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003548
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk2729af92004-05-03 20:45:30 +00003550Monitor Commands - Detailed Description:
3551========================================
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553TODO.
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003556
3557
wdenk2729af92004-05-03 20:45:30 +00003558Environment Variables:
3559======================
wdenkc6097192002-11-03 00:24:07 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561U-Boot supports user configuration using Environment Variables which
3562can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk2729af92004-05-03 20:45:30 +00003564Environment Variables are set using "setenv", printed using
3565"printenv", and saved to Flash using "saveenv". Using "setenv"
3566without a value can be used to delete a variable from the
3567environment. As long as you don't save the environment you are
3568working with an in-memory copy. In case the Flash area containing the
3569environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003570
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003571Some configuration options can be set using Environment Variables.
3572
3573List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003576
wdenk2729af92004-05-03 20:45:30 +00003577 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk2729af92004-05-03 20:45:30 +00003581 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003582
wdenk2729af92004-05-03 20:45:30 +00003583 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003584
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003585 bootm_low - Memory range available for image processing in the bootm
3586 command can be restricted. This variable is given as
3587 a hexadecimal number and defines lowest address allowed
3588 for use by the bootm command. See also "bootm_size"
3589 environment variable. Address defined by "bootm_low" is
3590 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003591 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3592 bootm_mapsize.
3593
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003594 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003595 This variable is given as a hexadecimal number and it
3596 defines the size of the memory region starting at base
3597 address bootm_low that is accessible by the Linux kernel
3598 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3599 as the default value if it is defined, and bootm_size is
3600 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003601
3602 bootm_size - Memory range available for image processing in the bootm
3603 command can be restricted. This variable is given as
3604 a hexadecimal number and defines the size of the region
3605 allowed for use by the bootm command. See also "bootm_low"
3606 environment variable.
3607
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003608 updatefile - Location of the software update file on a TFTP server, used
3609 by the automatic software update feature. Please refer to
3610 documentation in doc/README.update for more details.
3611
wdenk2729af92004-05-03 20:45:30 +00003612 autoload - if set to "no" (any string beginning with 'n'),
3613 "bootp" will just load perform a lookup of the
3614 configuration from the BOOTP server, but not try to
3615 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003616
wdenk2729af92004-05-03 20:45:30 +00003617 autostart - if set to "yes", an image loaded using the "bootp",
3618 "rarpboot", "tftpboot" or "diskboot" commands will
3619 be automatically started (by internally calling
3620 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003621
wdenk2729af92004-05-03 20:45:30 +00003622 If set to "no", a standalone image passed to the
3623 "bootm" command will be copied to the load address
3624 (and eventually uncompressed), but NOT be started.
3625 This can be used to load and uncompress arbitrary
3626 data.
wdenkc6097192002-11-03 00:24:07 +00003627
David A. Longa28afca2011-07-09 16:40:19 -04003628 fdt_high - if set this restricts the maximum address that the
3629 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003630 For example, if you have a system with 1 GB memory
3631 at physical address 0x10000000, while Linux kernel
3632 only recognizes the first 704 MB as low memory, you
3633 may need to set fdt_high as 0x3C000000 to have the
3634 device tree blob be copied to the maximum address
3635 of the 704 MB low memory, so that Linux kernel can
3636 access it during the boot procedure.
3637
David A. Longa28afca2011-07-09 16:40:19 -04003638 If this is set to the special value 0xFFFFFFFF then
3639 the fdt will not be copied at all on boot. For this
3640 to work it must reside in writable memory, have
3641 sufficient padding on the end of it for u-boot to
3642 add the information it needs into it, and the memory
3643 must be accessible by the kernel.
3644
Simon Glasseea63e02011-10-24 19:15:34 +00003645 fdtcontroladdr- if set this is the address of the control flattened
3646 device tree used by U-Boot when CONFIG_OF_CONTROL is
3647 defined.
3648
wdenk17ea1172004-06-06 21:51:03 +00003649 i2cfast - (PPC405GP|PPC405EP only)
3650 if set to 'y' configures Linux I2C driver for fast
3651 mode (400kHZ). This environment variable is used in
3652 initialization code. So, for changes to be effective
3653 it must be saved and board must be reset.
3654
wdenk2729af92004-05-03 20:45:30 +00003655 initrd_high - restrict positioning of initrd images:
3656 If this variable is not set, initrd images will be
3657 copied to the highest possible address in RAM; this
3658 is usually what you want since it allows for
3659 maximum initrd size. If for some reason you want to
3660 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003661 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003662 variable to a value of "no" or "off" or "0".
3663 Alternatively, you can set it to a maximum upper
3664 address to use (U-Boot will still check that it
3665 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667 For instance, when you have a system with 16 MB
3668 RAM, and want to reserve 4 MB from use by Linux,
3669 you can do this by adding "mem=12M" to the value of
3670 the "bootargs" variable. However, now you must make
3671 sure that the initrd image is placed in the first
3672 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003673
wdenk2729af92004-05-03 20:45:30 +00003674 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676 If you set initrd_high to 0xFFFFFFFF, this is an
3677 indication to U-Boot that all addresses are legal
3678 for the Linux kernel, including addresses in flash
3679 memory. In this case U-Boot will NOT COPY the
3680 ramdisk at all. This may be useful to reduce the
3681 boot time on your system, but requires that this
3682 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003683
wdenk2729af92004-05-03 20:45:30 +00003684 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003685
wdenk2729af92004-05-03 20:45:30 +00003686 loadaddr - Default load address for commands like "bootp",
3687 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003692
wdenk2729af92004-05-03 20:45:30 +00003693 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003694
wdenk2729af92004-05-03 20:45:30 +00003695 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003698
Mike Frysingere2a53452011-10-02 10:01:27 +00003699 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003700
Mike Frysingere2a53452011-10-02 10:01:27 +00003701 ethact - controls which interface is currently active.
3702 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003703
Heiko Schocher48690d82010-07-20 17:45:02 +02003704 => setenv ethact FEC
3705 => ping 192.168.0.1 # traffic sent on FEC
3706 => setenv ethact SCC
3707 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003708
Matthias Fuchse1692572008-01-17 07:45:05 +01003709 ethrotate - When set to "no" U-Boot does not go through all
3710 available network interfaces.
3711 It just stays at the currently selected interface.
3712
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003713 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003714 either succeed or fail without retrying.
3715 When set to "once" the network operation will
3716 fail when all the available network interfaces
3717 are tried once without success.
3718 Useful on scripts which control the retry operation
3719 themselves.
wdenkc6097192002-11-03 00:24:07 +00003720
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003721 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003722
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003723 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07003724 changing the console to be empty. If "yes" it will be
3725 made silent. If "no" it will not be made silent. If
3726 unset, then it will be made silent if the U-Boot console
3727 is silent.
3728
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003729 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003730 UDP source port.
3731
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003732 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003733 destination port instead of the Well Know Port 69.
3734
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003735 tftpblocksize - Block size to use for TFTP transfers; if not set,
3736 we use the TFTP server's default block size
3737
3738 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3739 seconds, minimum value is 1000 = 1 second). Defines
3740 when a packet is considered to be lost so it has to
3741 be retransmitted. The default is 5000 = 5 seconds.
3742 Lowering this value may make downloads succeed
3743 faster in networks with high packet loss rates or
3744 with unreliable TFTP servers.
3745
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003746 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3747 unit, minimum value = 0). Defines how many timeouts
3748 can happen during a single file transfer before that
3749 transfer is aborted. The default is 10, and 0 means
3750 'no timeouts allowed'. Increasing this value may help
3751 downloads succeed with high packet loss rates, or with
3752 unreliable TFTP servers or client hardware.
3753
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003754 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003755 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003756 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003757
Alexandre Messier50768f52016-02-01 17:08:57 -05003758 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3759 Unsigned value, in milliseconds. If not set, the period will
3760 be either the default (28000), or a value based on
3761 CONFIG_NET_RETRY_COUNT, if defined. This value has
3762 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3763
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003764The following image location variables contain the location of images
3765used in booting. The "Image" column gives the role of the image and is
3766not an environment variable name. The other columns are environment
3767variable names. "File Name" gives the name of the file on a TFTP
3768server, "RAM Address" gives the location in RAM the image will be
3769loaded to, and "Flash Location" gives the image's address in NOR
3770flash or offset in NAND flash.
3771
3772*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03003773boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003774boards use these variables for other purposes.
3775
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003776Image File Name RAM Address Flash Location
3777----- --------- ----------- --------------
3778u-boot u-boot u-boot_addr_r u-boot_addr
3779Linux kernel bootfile kernel_addr_r kernel_addr
3780device tree blob fdtfile fdt_addr_r fdt_addr
3781ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783The following environment variables may be used and automatically
3784updated by the network boot commands ("bootp" and "rarpboot"),
3785depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003786
wdenk2729af92004-05-03 20:45:30 +00003787 bootfile - see above
3788 dnsip - IP address of your Domain Name Server
3789 dnsip2 - IP address of your secondary Domain Name Server
3790 gatewayip - IP address of the Gateway (Router) to use
3791 hostname - Target hostname
3792 ipaddr - see above
3793 netmask - Subnet Mask
3794 rootpath - Pathname of the root filesystem on the NFS server
3795 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003796
wdenka3d991b2004-04-15 21:48:45 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003799
wdenk2729af92004-05-03 20:45:30 +00003800 serial# - contains hardware identification information such
3801 as type string and/or serial number
3802 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804These variables can be set only once (usually during manufacturing of
3805the board). U-Boot refuses to delete or overwrite these variables
3806once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003807
3808
wdenk2729af92004-05-03 20:45:30 +00003809Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811 ver - Contains the U-Boot version string as printed
3812 with the "version" command. This variable is
3813 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003814
wdenkc6097192002-11-03 00:24:07 +00003815
wdenk2729af92004-05-03 20:45:30 +00003816Please note that changes to some configuration parameters may take
3817only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003818
stroesec1551ea2003-04-04 15:53:41 +00003819
Joe Hershberger170ab112012-12-11 22:16:24 -06003820Callback functions for environment variables:
3821---------------------------------------------
3822
3823For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003824when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06003825be associated with arbitrary variables. On creation, overwrite, or
3826deletion, the callback will provide the opportunity for some side
3827effect to happen or for the change to be rejected.
3828
3829The callbacks are named and associated with a function using the
3830U_BOOT_ENV_CALLBACK macro in your board or driver code.
3831
3832These callbacks are associated with variables in one of two ways. The
3833static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3834in the board configuration to a string that defines a list of
3835associations. The list must be in the following format:
3836
3837 entry = variable_name[:callback_name]
3838 list = entry[,list]
3839
3840If the callback name is not specified, then the callback is deleted.
3841Spaces are also allowed anywhere in the list.
3842
3843Callbacks can also be associated by defining the ".callbacks" variable
3844with the same list format above. Any association in ".callbacks" will
3845override any association in the static list. You can define
3846CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003847".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06003848
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003849If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3850regular expression. This allows multiple variables to be connected to
3851the same callback without explicitly listing them all out.
3852
Heinrich Schuchardt1b040472018-07-29 11:08:14 +02003853The signature of the callback functions is:
3854
3855 int callback(const char *name, const char *value, enum env_op op, int flags)
3856
3857* name - changed environment variable
3858* value - new value of the environment variable
3859* op - operation (create, overwrite, or delete)
3860* flags - attributes of the environment variable change, see flags H_* in
3861 include/search.h
3862
3863The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger170ab112012-12-11 22:16:24 -06003864
wdenk2729af92004-05-03 20:45:30 +00003865Command Line Parsing:
3866=====================
stroesec1551ea2003-04-04 15:53:41 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868There are two different command line parsers available with U-Boot:
3869the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871Old, simple command line parser:
3872--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874- supports environment variables (through setenv / saveenv commands)
3875- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003876- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003877- special characters ('$', ';') can be escaped by prefixing with '\',
3878 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003879 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003880- You can also escape text by enclosing in single apostrophes, for example:
3881 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk2729af92004-05-03 20:45:30 +00003883Hush shell:
3884-----------
wdenkf07771c2003-05-28 08:06:31 +00003885
wdenk2729af92004-05-03 20:45:30 +00003886- similar to Bourne shell, with control structures like
3887 if...then...else...fi, for...do...done; while...do...done,
3888 until...do...done, ...
3889- supports environment ("global") variables (through setenv / saveenv
3890 commands) and local shell variables (through standard shell syntax
3891 "name=value"); only environment variables can be used with "run"
3892 command
wdenkf07771c2003-05-28 08:06:31 +00003893
wdenk2729af92004-05-03 20:45:30 +00003894General rules:
3895--------------
wdenkf07771c2003-05-28 08:06:31 +00003896
wdenk2729af92004-05-03 20:45:30 +00003897(1) If a command line (or an environment variable executed by a "run"
3898 command) contains several commands separated by semicolon, and
3899 one of these commands fails, then the remaining commands will be
3900 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003903 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003904 command will cause "run" to terminate, i. e. the remaining
3905 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907Note for Redundant Ethernet Interfaces:
3908=======================================
wdenkf07771c2003-05-28 08:06:31 +00003909
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003910Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003911such configurations and is capable of automatic selection of a
3912"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003913
wdenk2729af92004-05-03 20:45:30 +00003914Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3915MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3916"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918If the network interface stores some valid MAC address (for instance
3919in SROM), this is used as default address if there is NO correspon-
3920ding setting in the environment; if the corresponding environment
3921variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923o If the SROM has a valid MAC address, and there is no address in the
3924 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926o If there is no valid address in the SROM, and a definition in the
3927 environment exists, then the value from the environment variable is
3928 used.
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk2729af92004-05-03 20:45:30 +00003930o If both the SROM and the environment contain a MAC address, and
3931 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933o If both the SROM and the environment contain a MAC address, and the
3934 addresses differ, the value from the environment is used and a
3935 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05003938 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3939 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003940
Ben Warrenecee9322010-04-26 11:11:46 -07003941If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003942will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003943may be skipped by setting the appropriate 'ethmacskip' environment variable.
3944The naming convention is as follows:
3945"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947Image Formats:
3948==============
wdenkc6097192002-11-03 00:24:07 +00003949
Marian Balakowicz3310c542008-03-12 12:13:13 +01003950U-Boot is capable of booting (and performing other auxiliary operations on)
3951images in two formats:
3952
3953New uImage format (FIT)
3954-----------------------
3955
3956Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3957to Flattened Device Tree). It allows the use of images with multiple
3958components (several kernels, ramdisks, etc.), with contents protected by
3959SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3960
3961
3962Old uImage format
3963-----------------
3964
3965Old image format is based on binary files which can be basically anything,
3966preceded by a special header; see the definitions in include/image.h for
3967details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3970 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003971 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3972 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3973 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003974* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003975 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003976 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003977* Compression Type (uncompressed, gzip, bzip2)
3978* Load Address
3979* Entry Point
3980* Image Name
3981* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983The header is marked by a special Magic Number, and both the header
3984and the data portions of the image are secured against corruption by
3985CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003986
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk2729af92004-05-03 20:45:30 +00003988Linux Support:
3989==============
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991Although U-Boot should support any OS or standalone application
3992easily, the main focus has always been on Linux during the design of
3993U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995U-Boot includes many features that so far have been part of some
3996special "boot loader" code within the Linux kernel. Also, any
3997"initrd" images to be used are no longer part of one big Linux image;
3998instead, kernel and "initrd" are separate images. This implementation
3999serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001- the same features can be used for other OS or standalone
4002 applications (for instance: using compressed images to reduce the
4003 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005- it becomes much easier to port new Linux kernel versions because
4006 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008- the same Linux kernel image can now be used with different "initrd"
4009 images; of course this also means that different kernel images can
4010 be run with the same "initrd". This makes testing easier (you don't
4011 have to build a new "zImage.initrd" Linux image when you just
4012 change a file in your "initrd"). Also, a field-upgrade of the
4013 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004014
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk2729af92004-05-03 20:45:30 +00004016Linux HOWTO:
4017============
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019Porting Linux to U-Boot based systems:
4020---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022U-Boot cannot save you from doing all the necessary modifications to
4023configure the Linux device drivers for use with your target hardware
4024(no, we don't intend to provide a full virtual machine interface to
4025Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004026
Stefan Roesea47a12b2010-04-15 16:07:28 +02004027But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004028
wdenk2729af92004-05-03 20:45:30 +00004029Just make sure your machine specific header file (for instance
4030include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004031Information structure as we define in include/asm-<arch>/u-boot.h,
4032and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004033as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004034
Simon Glass2eb31b12014-06-11 23:29:46 -06004035Note that U-Boot now has a driver model, a unified model for drivers.
4036If you are adding a new driver, plumb it into driver model. If there
4037is no uclass available, you are encouraged to create one. See
4038doc/driver-model.
4039
wdenkc6097192002-11-03 00:24:07 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041Configuring the Linux kernel:
4042-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004043
wdenk2729af92004-05-03 20:45:30 +00004044No specific requirements for U-Boot. Make sure you have some root
4045device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004046
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048Building a Linux Image:
4049-----------------------
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4052not used. If you use recent kernel source, a new build target
4053"uImage" will exist which automatically builds an image usable by
4054U-Boot. Most older kernels also have support for a "pImage" target,
4055which was introduced for our predecessor project PPCBoot and uses a
4056100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058Example:
wdenkc6097192002-11-03 00:24:07 +00004059
Holger Freytherab584d62014-08-04 09:26:05 +02004060 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004061 make oldconfig
4062 make dep
4063 make uImage
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065The "uImage" build target uses a special tool (in 'tools/mkimage') to
4066encapsulate a compressed Linux kernel image with header information,
4067CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 ${CROSS_COMPILE}-objcopy -O binary \
4074 -R .note -R .comment \
4075 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004082
wdenk2729af92004-05-03 20:45:30 +00004083 mkimage -A ppc -O linux -T kernel -C gzip \
4084 -a 0 -e 0 -n "Linux Kernel Image" \
4085 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004086
wdenk24ee89b2002-11-03 17:56:27 +00004087
wdenk2729af92004-05-03 20:45:30 +00004088The "mkimage" tool can also be used to create ramdisk images for use
4089with U-Boot, either separated from the Linux kernel image, or
4090combined into one file. "mkimage" encapsulates the images with a 64
4091byte header containing information about target architecture,
4092operating system, image type, compression method, entry points, time
4093stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095"mkimage" can be called in two ways: to verify existing images and
4096print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004097
wdenk2729af92004-05-03 20:45:30 +00004098In the first form (with "-l" option) mkimage lists the information
4099contained in the header of an existing U-Boot image; this includes
4100checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004101
wdenk2729af92004-05-03 20:45:30 +00004102 tools/mkimage -l image
4103 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004104
wdenk2729af92004-05-03 20:45:30 +00004105The second form (with "-d" option) is used to build a U-Boot image
4106from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4109 -n name -d data_file image
4110 -A ==> set architecture to 'arch'
4111 -O ==> set operating system to 'os'
4112 -T ==> set image type to 'type'
4113 -C ==> set compression type 'comp'
4114 -a ==> set load address to 'addr' (hex)
4115 -e ==> set entry point to 'ep' (hex)
4116 -n ==> set image name to 'name'
4117 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004118
wdenk69459792004-05-29 16:53:29 +00004119Right now, all Linux kernels for PowerPC systems use the same load
4120address (0x00000000), but the entry point address depends on the
4121kernel version:
wdenkc6097192002-11-03 00:24:07 +00004122
wdenk2729af92004-05-03 20:45:30 +00004123- 2.2.x kernels have the entry point at 0x0000000C,
4124- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4129 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004130 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004131 > examples/uImage.TQM850L
4132 Image Name: 2.4.4 kernel for TQM850L
4133 Created: Wed Jul 19 02:34:59 2000
4134 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4135 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4136 Load Address: 0x00000000
4137 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk2729af92004-05-03 20:45:30 +00004141 -> tools/mkimage -l examples/uImage.TQM850L
4142 Image Name: 2.4.4 kernel for TQM850L
4143 Created: Wed Jul 19 02:34:59 2000
4144 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4145 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4146 Load Address: 0x00000000
4147 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004148
wdenk2729af92004-05-03 20:45:30 +00004149NOTE: for embedded systems where boot time is critical you can trade
4150speed for memory and install an UNCOMPRESSED image instead: this
4151needs more space in Flash, but boots much faster since it does not
4152need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004153
Stefan Roesea47a12b2010-04-15 16:07:28 +02004154 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004155 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4156 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004157 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004158 > examples/uImage.TQM850L-uncompressed
4159 Image Name: 2.4.4 kernel for TQM850L
4160 Created: Wed Jul 19 02:34:59 2000
4161 Image Type: PowerPC Linux Kernel Image (uncompressed)
4162 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4163 Load Address: 0x00000000
4164 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004165
wdenkc6097192002-11-03 00:24:07 +00004166
wdenk2729af92004-05-03 20:45:30 +00004167Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4168when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004169
wdenk2729af92004-05-03 20:45:30 +00004170 -> tools/mkimage -n 'Simple Ramdisk Image' \
4171 > -A ppc -O linux -T ramdisk -C gzip \
4172 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4173 Image Name: Simple Ramdisk Image
4174 Created: Wed Jan 12 14:01:50 2000
4175 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4176 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4177 Load Address: 0x00000000
4178 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004179
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004180The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4181option performs the converse operation of the mkimage's second form (the "-d"
4182option). Given an image built by mkimage, the dumpimage extracts a "data file"
4183from the image:
4184
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004185 tools/dumpimage -i image -T type -p position data_file
4186 -i ==> extract from the 'image' a specific 'data_file'
4187 -T ==> set image type to 'type'
4188 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004189
wdenkdb01a2e2004-04-15 23:14:49 +00004190
wdenk2729af92004-05-03 20:45:30 +00004191Installing a Linux Image:
4192-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194To downloading a U-Boot image over the serial (console) interface,
4195you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004198
wdenk2729af92004-05-03 20:45:30 +00004199The 'objcopy' does not understand the information in the U-Boot
4200image header, so the resulting S-Record file will be relative to
4201address 0x00000000. To load it to a given address, you need to
4202specify the target address as 'offset' parameter with the 'loads'
4203command.
wdenkc6097192002-11-03 00:24:07 +00004204
wdenk2729af92004-05-03 20:45:30 +00004205Example: install the image to address 0x40100000 (which on the
4206TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004207
wdenk2729af92004-05-03 20:45:30 +00004208 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210 .......... done
4211 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213 => loads 40100000
4214 ## Ready for S-Record download ...
4215 ~>examples/image.srec
4216 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4217 ...
4218 15989 15990 15991 15992
4219 [file transfer complete]
4220 [connected]
4221 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004222
4223
wdenk2729af92004-05-03 20:45:30 +00004224You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004225this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004226corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk2729af92004-05-03 20:45:30 +00004228 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004229
wdenk2729af92004-05-03 20:45:30 +00004230 ## Checking Image at 40100000 ...
4231 Image Name: 2.2.13 for initrd on TQM850L
4232 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4233 Data Size: 335725 Bytes = 327 kB = 0 MB
4234 Load Address: 00000000
4235 Entry Point: 0000000c
4236 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004237
4238
wdenk2729af92004-05-03 20:45:30 +00004239Boot Linux:
4240-----------
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242The "bootm" command is used to boot an application that is stored in
4243memory (RAM or Flash). In case of a Linux kernel image, the contents
4244of the "bootargs" environment variable is passed to the kernel as
4245parameters. You can check and modify this variable using the
4246"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004247
4248
wdenk2729af92004-05-03 20:45:30 +00004249 => printenv bootargs
4250 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk2729af92004-05-03 20:45:30 +00004252 => 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 +00004253
wdenk2729af92004-05-03 20:45:30 +00004254 => printenv bootargs
4255 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 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257 => bootm 40020000
4258 ## Booting Linux kernel at 40020000 ...
4259 Image Name: 2.2.13 for NFS on TQM850L
4260 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4261 Data Size: 381681 Bytes = 372 kB = 0 MB
4262 Load Address: 00000000
4263 Entry Point: 0000000c
4264 Verifying Checksum ... OK
4265 Uncompressing Kernel Image ... OK
4266 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
4267 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4268 time_init: decrementer frequency = 187500000/60
4269 Calibrating delay loop... 49.77 BogoMIPS
4270 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4271 ...
wdenkc6097192002-11-03 00:24:07 +00004272
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004273If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004274the memory addresses of both the kernel and the initrd image (PPBCOOT
4275format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 ## Checking Image at 40100000 ...
4280 Image Name: 2.2.13 for initrd on TQM850L
4281 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4282 Data Size: 335725 Bytes = 327 kB = 0 MB
4283 Load Address: 00000000
4284 Entry Point: 0000000c
4285 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287 ## Checking Image at 40200000 ...
4288 Image Name: Simple Ramdisk Image
4289 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4290 Data Size: 566530 Bytes = 553 kB = 0 MB
4291 Load Address: 00000000
4292 Entry Point: 00000000
4293 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk2729af92004-05-03 20:45:30 +00004295 => bootm 40100000 40200000
4296 ## Booting Linux kernel at 40100000 ...
4297 Image Name: 2.2.13 for initrd on TQM850L
4298 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4299 Data Size: 335725 Bytes = 327 kB = 0 MB
4300 Load Address: 00000000
4301 Entry Point: 0000000c
4302 Verifying Checksum ... OK
4303 Uncompressing Kernel Image ... OK
4304 ## Loading RAMDisk Image at 40200000 ...
4305 Image Name: Simple Ramdisk Image
4306 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4307 Data Size: 566530 Bytes = 553 kB = 0 MB
4308 Load Address: 00000000
4309 Entry Point: 00000000
4310 Verifying Checksum ... OK
4311 Loading Ramdisk ... OK
4312 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
4313 Boot arguments: root=/dev/ram
4314 time_init: decrementer frequency = 187500000/60
4315 Calibrating delay loop... 49.77 BogoMIPS
4316 ...
4317 RAMDISK: Compressed image found at block 0
4318 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004319
wdenk2729af92004-05-03 20:45:30 +00004320 bash#
wdenkc6097192002-11-03 00:24:07 +00004321
Matthew McClintock02677682006-06-28 10:41:37 -05004322Boot Linux and pass a flat device tree:
4323-----------
4324
4325First, U-Boot must be compiled with the appropriate defines. See the section
4326titled "Linux Kernel Interface" above for a more in depth explanation. The
4327following is an example of how to start a kernel and pass an updated
4328flat device tree:
4329
4330=> print oftaddr
4331oftaddr=0x300000
4332=> print oft
4333oft=oftrees/mpc8540ads.dtb
4334=> tftp $oftaddr $oft
4335Speed: 1000, full duplex
4336Using TSEC0 device
4337TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4338Filename 'oftrees/mpc8540ads.dtb'.
4339Load address: 0x300000
4340Loading: #
4341done
4342Bytes transferred = 4106 (100a hex)
4343=> tftp $loadaddr $bootfile
4344Speed: 1000, full duplex
4345Using TSEC0 device
4346TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4347Filename 'uImage'.
4348Load address: 0x200000
4349Loading:############
4350done
4351Bytes transferred = 1029407 (fb51f hex)
4352=> print loadaddr
4353loadaddr=200000
4354=> print oftaddr
4355oftaddr=0x300000
4356=> bootm $loadaddr - $oftaddr
4357## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004358 Image Name: Linux-2.6.17-dirty
4359 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4360 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004361 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004362 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004363 Verifying Checksum ... OK
4364 Uncompressing Kernel Image ... OK
4365Booting using flat device tree at 0x300000
4366Using MPC85xx ADS machine description
4367Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4368[snip]
4369
4370
wdenk2729af92004-05-03 20:45:30 +00004371More About U-Boot Image Types:
4372------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004375
wdenk2729af92004-05-03 20:45:30 +00004376 "Standalone Programs" are directly runnable in the environment
4377 provided by U-Boot; it is expected that (if they behave
4378 well) you can continue to work in U-Boot after return from
4379 the Standalone Program.
4380 "OS Kernel Images" are usually images of some Embedded OS which
4381 will take over control completely. Usually these programs
4382 will install their own set of exception handlers, device
4383 drivers, set up the MMU, etc. - this means, that you cannot
4384 expect to re-enter U-Boot except by resetting the CPU.
4385 "RAMDisk Images" are more or less just data blocks, and their
4386 parameters (address, size) are passed to an OS kernel that is
4387 being started.
4388 "Multi-File Images" contain several images, typically an OS
4389 (Linux) kernel image and one or more data images like
4390 RAMDisks. This construct is useful for instance when you want
4391 to boot over the network using BOOTP etc., where the boot
4392 server provides just a single image file, but you want to get
4393 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395 "Multi-File Images" start with a list of image sizes, each
4396 image size (in bytes) specified by an "uint32_t" in network
4397 byte order. This list is terminated by an "(uint32_t)0".
4398 Immediately after the terminating 0 follow the images, one by
4399 one, all aligned on "uint32_t" boundaries (size rounded up to
4400 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402 "Firmware Images" are binary images containing firmware (like
4403 U-Boot or FPGA images) which usually will be programmed to
4404 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 "Script files" are command sequences that will be executed by
4407 U-Boot's command interpreter; this feature is especially
4408 useful when you configure U-Boot to use a real shell (hush)
4409 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004410
Marek Vasut44f074c2012-03-14 21:52:45 +00004411Booting the Linux zImage:
4412-------------------------
4413
4414On some platforms, it's possible to boot Linux zImage. This is done
4415using the "bootz" command. The syntax of "bootz" command is the same
4416as the syntax of "bootm" command.
4417
Tom Rini8ac28562013-05-16 11:40:11 -04004418Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004419kernel with raw initrd images. The syntax is slightly different, the
4420address of the initrd must be augmented by it's size, in the following
4421format: "<initrd addres>:<initrd size>".
4422
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424Standalone HOWTO:
4425=================
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk2729af92004-05-03 20:45:30 +00004427One of the features of U-Boot is that you can dynamically load and
4428run "standalone" applications, which can use some resources of
4429U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk2729af92004-05-03 20:45:30 +00004431Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk2729af92004-05-03 20:45:30 +00004433"Hello World" Demo:
4434-------------------
wdenkc6097192002-11-03 00:24:07 +00004435
wdenk2729af92004-05-03 20:45:30 +00004436'examples/hello_world.c' contains a small "Hello World" Demo
4437application; it is automatically compiled when you build U-Boot.
4438It's configured to run at address 0x00040004, so you can play with it
4439like that:
wdenkc6097192002-11-03 00:24:07 +00004440
wdenk2729af92004-05-03 20:45:30 +00004441 => loads
4442 ## Ready for S-Record download ...
4443 ~>examples/hello_world.srec
4444 1 2 3 4 5 6 7 8 9 10 11 ...
4445 [file transfer complete]
4446 [connected]
4447 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449 => go 40004 Hello World! This is a test.
4450 ## Starting application at 0x00040004 ...
4451 Hello World
4452 argc = 7
4453 argv[0] = "40004"
4454 argv[1] = "Hello"
4455 argv[2] = "World!"
4456 argv[3] = "This"
4457 argv[4] = "is"
4458 argv[5] = "a"
4459 argv[6] = "test."
4460 argv[7] = "<NULL>"
4461 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004462
wdenk2729af92004-05-03 20:45:30 +00004463 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk2729af92004-05-03 20:45:30 +00004465Another example, which demonstrates how to register a CPM interrupt
4466handler with the U-Boot code, can be found in 'examples/timer.c'.
4467Here, a CPM timer is set up to generate an interrupt every second.
4468The interrupt service routine is trivial, just printing a '.'
4469character, but this is just a demo program. The application can be
4470controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472 ? - print current values og the CPM Timer registers
4473 b - enable interrupts and start timer
4474 e - stop timer and disable interrupts
4475 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk2729af92004-05-03 20:45:30 +00004477 => loads
4478 ## Ready for S-Record download ...
4479 ~>examples/timer.srec
4480 1 2 3 4 5 6 7 8 9 10 11 ...
4481 [file transfer complete]
4482 [connected]
4483 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk2729af92004-05-03 20:45:30 +00004485 => go 40004
4486 ## Starting application at 0x00040004 ...
4487 TIMERS=0xfff00980
4488 Using timer 1
4489 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491Hit 'b':
4492 [q, b, e, ?] Set interval 1000000 us
4493 Enabling timer
4494Hit '?':
4495 [q, b, e, ?] ........
4496 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4497Hit '?':
4498 [q, b, e, ?] .
4499 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4500Hit '?':
4501 [q, b, e, ?] .
4502 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4503Hit '?':
4504 [q, b, e, ?] .
4505 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4506Hit 'e':
4507 [q, b, e, ?] ...Stopping timer
4508Hit 'q':
4509 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004510
4511
wdenk2729af92004-05-03 20:45:30 +00004512Minicom warning:
4513================
wdenk85ec0bc2003-03-31 16:34:49 +00004514
wdenk2729af92004-05-03 20:45:30 +00004515Over time, many people have reported problems when trying to use the
4516"minicom" terminal emulation program for serial download. I (wd)
4517consider minicom to be broken, and recommend not to use it. Under
4518Unix, I recommend to use C-Kermit for general purpose use (and
4519especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004520use "cu" for S-Record download ("loads" command). See
4521http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4522for help with kermit.
4523
wdenk85ec0bc2003-03-31 16:34:49 +00004524
wdenk2729af92004-05-03 20:45:30 +00004525Nevertheless, if you absolutely want to use it try adding this
4526configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004527
wdenk2729af92004-05-03 20:45:30 +00004528 Name Program Name U/D FullScr IO-Red. Multi
4529 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4530 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004531
4532
wdenk2729af92004-05-03 20:45:30 +00004533NetBSD Notes:
4534=============
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536Starting at version 0.9.2, U-Boot supports NetBSD both as host
4537(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539Building requires a cross environment; it is known to work on
4540NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4541need gmake since the Makefiles are not compatible with BSD make).
4542Note that the cross-powerpc package does not install include files;
4543attempting to build U-Boot will fail because <machine/ansi.h> is
4544missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk2729af92004-05-03 20:45:30 +00004546 # cd /usr/pkg/cross/powerpc-netbsd/include
4547 # mkdir powerpc
4548 # ln -s powerpc machine
4549 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4550 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk2729af92004-05-03 20:45:30 +00004552Native builds *don't* work due to incompatibilities between native
4553and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555Booting assumes that (the first part of) the image booted is a
4556stage-2 loader which in turn loads and then invokes the kernel
4557proper. Loader sources will eventually appear in the NetBSD source
4558tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004559meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004560
4561
wdenk2729af92004-05-03 20:45:30 +00004562Implementation Internals:
4563=========================
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk2729af92004-05-03 20:45:30 +00004565The following is not intended to be a complete description of every
4566implementation detail. However, it should help to understand the
4567inner workings of U-Boot and make it easier to port it to custom
4568hardware.
wdenkc6097192002-11-03 00:24:07 +00004569
4570
wdenk2729af92004-05-03 20:45:30 +00004571Initial Stack, Global Data:
4572---------------------------
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574The implementation of U-Boot is complicated by the fact that U-Boot
4575starts running out of ROM (flash memory), usually without access to
4576system RAM (because the memory controller is not initialized yet).
4577This means that we don't have writable Data or BSS segments, and BSS
4578is not initialized as zero. To be able to get a C environment working
4579at all, we have to allocate at least a minimal stack. Implementation
4580options for this are defined and restricted by the CPU used: Some CPU
4581models provide on-chip memory (like the IMMR area on MPC8xx and
4582MPC826x processors), on others (parts of) the data cache can be
4583locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004584
Wolfgang Denk218ca722008-03-26 10:40:12 +01004585 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004586 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004587
wdenk2729af92004-05-03 20:45:30 +00004588 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4589 From: "Chris Hallinan" <clh@net1plus.com>
4590 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4591 ...
wdenk43d96162003-03-06 00:02:04 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593 Correct me if I'm wrong, folks, but the way I understand it
4594 is this: Using DCACHE as initial RAM for Stack, etc, does not
4595 require any physical RAM backing up the cache. The cleverness
4596 is that the cache is being used as a temporary supply of
4597 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004598 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004599 can see how this works by studying the cache architecture and
4600 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004601
wdenk2729af92004-05-03 20:45:30 +00004602 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4603 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004604 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004605 option should work for you. Using CS 4 should be fine if your
4606 board designers haven't used it for something that would
4607 cause you grief during the initial boot! It is frequently not
4608 used.
wdenk43d96162003-03-06 00:02:04 +00004609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004610 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004611 with your processor/board/system design. The default value
4612 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004613 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004614 than your SDRAM module. If you have a 64MB SDRAM module, set
4615 it above 400_0000. Just make sure your board has no resources
4616 that are supposed to respond to that address! That code in
4617 start.S has been around a while and should work as is when
4618 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004619
wdenk2729af92004-05-03 20:45:30 +00004620 -Chris Hallinan
4621 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004622
wdenk2729af92004-05-03 20:45:30 +00004623It is essential to remember this, since it has some impact on the C
4624code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004625
wdenk2729af92004-05-03 20:45:30 +00004626* Initialized global data (data segment) is read-only. Do not attempt
4627 to write it.
wdenkc6097192002-11-03 00:24:07 +00004628
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004629* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004630 as zero data - BSS segment) at all - this is undefined, initiali-
4631 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633* Stack space is very limited. Avoid big data buffers or things like
4634 that.
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004637normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004638turned out that the implementation of U-Boot can be greatly
4639simplified by making a global data structure (gd_t) available to all
4640functions. We could pass a pointer to this data as argument to _all_
4641functions, but this would bloat the code. Instead we use a feature of
4642the GCC compiler (Global Register Variables) to share the data: we
4643place a pointer (gd) to the global data into a register which we
4644reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk2729af92004-05-03 20:45:30 +00004646When choosing a register for such a purpose we are restricted by the
4647relevant (E)ABI specifications for the current architecture, and by
4648GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650For PowerPC, the following registers have specific use:
4651 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004652 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004653 R3-R4: parameter passing and return values
4654 R5-R10: parameter passing
4655 R13: small data area pointer
4656 R30: GOT pointer
4657 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004658
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004659 (U-Boot also uses R12 as internal GOT pointer. r12
4660 is a volatile register so r12 needs to be reset when
4661 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004662
Wolfgang Denke7670f62008-02-14 22:43:22 +01004663 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004664
wdenk2729af92004-05-03 20:45:30 +00004665 Note: on PPC, we could use a static initializer (since the
4666 address of the global data structure is known at compile time),
4667 but it turned out that reserving a register results in somewhat
4668 smaller code - although the code savings are not that big (on
4669 average for all boards 752 bytes for the whole U-Boot image,
4670 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk2729af92004-05-03 20:45:30 +00004674 R0: function argument word/integer result
4675 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004676 R9: platform specific
4677 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004678 R11: argument (frame) pointer
4679 R12: temporary workspace
4680 R13: stack pointer
4681 R14: link register
4682 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004683
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004684 ==> U-Boot will use R9 to hold a pointer to the global data
4685
4686 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004687
Thomas Chou0df01fd2010-05-21 11:08:03 +08004688On Nios II, the ABI is documented here:
4689 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4690
4691 ==> U-Boot will use gp to hold a pointer to the global data
4692
4693 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4694 to access small data sections, so gp is free.
4695
Macpaul Linafc1ce82011-10-19 20:41:11 +00004696On NDS32, the following registers are used:
4697
4698 R0-R1: argument/return
4699 R2-R5: argument
4700 R15: temporary register for assembler
4701 R16: trampoline register
4702 R28: frame pointer (FP)
4703 R29: global pointer (GP)
4704 R30: link register (LP)
4705 R31: stack pointer (SP)
4706 PC: program counter (PC)
4707
4708 ==> U-Boot will use R10 to hold a pointer to the global data
4709
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004710NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4711or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004712
Rick Chen3fafced2017-12-26 13:55:59 +08004713On RISC-V, the following registers are used:
4714
4715 x0: hard-wired zero (zero)
4716 x1: return address (ra)
4717 x2: stack pointer (sp)
4718 x3: global pointer (gp)
4719 x4: thread pointer (tp)
4720 x5: link register (t0)
4721 x8: frame pointer (fp)
4722 x10-x11: arguments/return values (a0-1)
4723 x12-x17: arguments (a2-7)
4724 x28-31: temporaries (t3-6)
4725 pc: program counter (pc)
4726
4727 ==> U-Boot will use gp to hold a pointer to the global data
4728
wdenk2729af92004-05-03 20:45:30 +00004729Memory Management:
4730------------------
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732U-Boot runs in system state and uses physical addresses, i.e. the
4733MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735The available memory is mapped to fixed addresses using the memory
4736controller. In this process, a contiguous block is formed for each
4737memory type (Flash, SDRAM, SRAM), even when it consists of several
4738physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740U-Boot is installed in the first 128 kB of the first Flash bank (on
4741TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4742booting and sizing and initializing DRAM, the code relocates itself
4743to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004744memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004745configuration setting]. Below that, a structure with global Board
4746Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748Additionally, some exception handler code is copied to the low 8 kB
4749of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751So a typical memory configuration with 16 MB of DRAM could look like
4752this:
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk2729af92004-05-03 20:45:30 +00004754 0x0000 0000 Exception Vector code
4755 :
4756 0x0000 1FFF
4757 0x0000 2000 Free for Application Use
4758 :
4759 :
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761 :
4762 :
4763 0x00FB FF20 Monitor Stack (Growing downward)
4764 0x00FB FFAC Board Info Data and permanent copy of global data
4765 0x00FC 0000 Malloc Arena
4766 :
4767 0x00FD FFFF
4768 0x00FE 0000 RAM Copy of Monitor Code
4769 ... eventually: LCD or video framebuffer
4770 ... eventually: pRAM (Protected RAM - unchanged by reset)
4771 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004772
4773
wdenk2729af92004-05-03 20:45:30 +00004774System Initialization:
4775----------------------
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk2729af92004-05-03 20:45:30 +00004777In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004778(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004779configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00004780To be able to re-map memory U-Boot then jumps to its link address.
4781To be able to implement the initialization code in C, a (small!)
4782initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02004783which provide such a feature like), or in a locked part of the data
4784cache. After that, U-Boot initializes the CPU core, the caches and
4785the SIU.
wdenkc6097192002-11-03 00:24:07 +00004786
wdenk2729af92004-05-03 20:45:30 +00004787Next, all (potentially) available memory banks are mapped using a
4788preliminary mapping. For example, we put them on 512 MB boundaries
4789(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4790on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4791programmed for SDRAM access. Using the temporary configuration, a
4792simple memory test is run that determines the size of the SDRAM
4793banks.
wdenkc6097192002-11-03 00:24:07 +00004794
wdenk2729af92004-05-03 20:45:30 +00004795When there is more than one SDRAM bank, and the banks are of
4796different size, the largest is mapped first. For equal size, the first
4797bank (CS2#) is mapped first. The first mapping is always for address
47980x00000000, with any additional banks following immediately to create
4799contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004800
wdenk2729af92004-05-03 20:45:30 +00004801Then, the monitor installs itself at the upper end of the SDRAM area
4802and allocates memory for use by malloc() and for the global Board
4803Info data; also, the exception vector code is copied to the low RAM
4804pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk2729af92004-05-03 20:45:30 +00004806Only after this relocation will you have a "normal" C environment;
4807until that you are restricted in several ways, mostly because you are
4808running from ROM, and because the code will have to be relocated to a
4809new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004810
4811
wdenk2729af92004-05-03 20:45:30 +00004812U-Boot Porting Guide:
4813----------------------
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk2729af92004-05-03 20:45:30 +00004815[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4816list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004817
4818
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004819int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004820{
4821 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004822
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004823 signal(SIGALRM, no_more_time);
4824 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004827 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004828 return 0;
4829 }
4830
wdenk2729af92004-05-03 20:45:30 +00004831 Download latest U-Boot source;
4832
Wolfgang Denk06682362008-12-30 22:56:11 +01004833 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004834
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004835 if (clueless)
4836 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004837
wdenk2729af92004-05-03 20:45:30 +00004838 while (learning) {
4839 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004840 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4841 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004842 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004843 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004844 }
wdenkc6097192002-11-03 00:24:07 +00004845
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004846 if (available_money > toLocalCurrency ($2500))
4847 Buy a BDI3000;
4848 else
wdenk2729af92004-05-03 20:45:30 +00004849 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004850
4851 if (a similar board exists) { /* hopefully... */
4852 cp -a board/<similar> board/<myboard>
4853 cp include/configs/<similar>.h include/configs/<myboard>.h
4854 } else {
4855 Create your own board support subdirectory;
4856 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004857 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004858 Edit new board/<myboard> files
4859 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004860
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004861 while (!accepted) {
4862 while (!running) {
4863 do {
4864 Add / modify source code;
4865 } until (compiles);
4866 Debug;
4867 if (clueless)
4868 email("Hi, I am having problems...");
4869 }
4870 Send patch file to the U-Boot email list;
4871 if (reasonable critiques)
4872 Incorporate improvements from email list code review;
4873 else
4874 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004875 }
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk2729af92004-05-03 20:45:30 +00004877 return 0;
4878}
4879
4880void no_more_time (int sig)
4881{
4882 hire_a_guru();
4883}
wdenkc6097192002-11-03 00:24:07 +00004884
4885
wdenk2729af92004-05-03 20:45:30 +00004886Coding Standards:
4887-----------------
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk2729af92004-05-03 20:45:30 +00004889All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02004890coding style; see the kernel coding style guide at
4891https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4892script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004893
Detlev Zundel2c051652006-09-01 15:39:02 +02004894Source files originating from a different project (for example the
4895MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004896reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02004897sources.
4898
4899Please note that U-Boot is implemented in C (and to some small parts in
4900Assembler); no C++ is used, so please do not use C++ style comments (//)
4901in your code.
wdenk2729af92004-05-03 20:45:30 +00004902
4903Please also stick to the following formatting rules:
4904- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004905- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004906- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004907- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004908- do not add trailing empty lines to source files
4909
4910Submissions which do not conform to the standards may be returned
4911with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004912
4913
wdenk2729af92004-05-03 20:45:30 +00004914Submitting Patches:
4915-------------------
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk2729af92004-05-03 20:45:30 +00004917Since the number of patches for U-Boot is growing, we need to
4918establish some rules. Submissions which do not conform to these rules
4919may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004920
Magnus Lilja0d28f342008-08-06 19:32:33 +02004921Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004922
Wolfgang Denk06682362008-12-30 22:56:11 +01004923Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08004924see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01004925
wdenk2729af92004-05-03 20:45:30 +00004926When you send a patch, please include the following information with
4927it:
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk2729af92004-05-03 20:45:30 +00004929* For bug fixes: a description of the bug and how your patch fixes
4930 this bug. Please try to include a way of demonstrating that the
4931 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004932
wdenk2729af92004-05-03 20:45:30 +00004933* For new features: a description of the feature and your
4934 implementation.
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936* A CHANGELOG entry as plaintext (separate from the patch)
4937
Robert P. J. Day7207b362015-12-19 07:16:10 -05004938* For major contributions, add a MAINTAINERS file with your
4939 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00004940
Albert ARIBAUD27af9302013-09-11 15:52:51 +02004941* When you add support for a new board, don't forget to add a
4942 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00004943
4944* If your patch adds new configuration options, don't forget to
4945 document these in the README file.
4946
Wolfgang Denk218ca722008-03-26 10:40:12 +01004947* The patch itself. If you are using git (which is *strongly*
4948 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004949 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004950 the U-Boot mailing list, you will avoid most of the common problems
4951 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004952
Wolfgang Denk218ca722008-03-26 10:40:12 +01004953 If you cannot use git, use "diff -purN OLD NEW". If your version of
4954 diff does not support these options, then get the latest version of
4955 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004956
Wolfgang Denk218ca722008-03-26 10:40:12 +01004957 The current directory when running this command shall be the parent
4958 directory of the U-Boot source tree (i. e. please make sure that
4959 your patch includes sufficient directory information for the
4960 affected files).
4961
4962 We prefer patches as plain text. MIME attachments are discouraged,
4963 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004964
4965* If one logical set of modifications affects or creates several
4966 files, all these changes shall be submitted in a SINGLE patch file.
4967
4968* Changesets that contain different, unrelated modifications shall be
4969 submitted as SEPARATE patches, one patch per changeset.
4970
4971
4972Notes:
4973
Simon Glass6de80f22016-07-27 20:33:08 -06004974* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00004975 source tree and make sure that no errors or warnings are reported
4976 for any of the boards.
4977
4978* Keep your modifications to the necessary minimum: A patch
4979 containing several unrelated changes or arbitrary reformats will be
4980 returned with a request to re-formatting / split it.
4981
4982* If you modify existing code, make sure that your new code does not
4983 add to the memory footprint of the code ;-) Small is beautiful!
4984 When adding new features, these should compile conditionally only
4985 (using #ifdef), and the resulting code with the new feature
4986 disabled must not need more memory than the old code without your
4987 modification.
wdenk90dc6702005-05-03 14:12:25 +00004988
Wolfgang Denk06682362008-12-30 22:56:11 +01004989* Remember that there is a size limit of 100 kB per message on the
4990 u-boot mailing list. Bigger patches will be moderated. If they are
4991 reasonable and not too big, they will be acknowledged. But patches
4992 bigger than the size limit should be avoided.