blob: 6cb0567ba66b46aa2a6050fd71a43a9082827f69 [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
Simon Glass9e5616d2019-08-01 09:47:14 -060086 * ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus 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
Keerthy5917d0b2019-07-29 13:52:04 +0530215See doc/arch/index.rst 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
Andreas Dannenberg14254652019-08-08 12:54:49 -0500270 - for specific scenarios on certain architectures an early BSS *can*
271 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
272 of BSS prior to entering board_init_f()) but doing so is discouraged.
273 Instead it is strongly recommended to architect any code changes
274 or additions such to not depend on the availability of BSS during
275 board_init_f() as indicated in other sections of this README to
276 maintain compatibility and consistency across the entire code base.
Simon Glassdb910352015-03-03 08:03:00 -0700277 - must return normally from this function (don't call board_init_r()
278 directly)
279
280Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
281this point the stack and global_data are relocated to below
282CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
283memory.
284
285board_init_r():
286 - purpose: main execution, common code
287 - global_data is available
288 - SDRAM is available
289 - BSS is available, all static/global variables can be used
290 - execution eventually continues to main_loop()
291
292 Non-SPL-specific notes:
293 - U-Boot is relocated to the top of memory and is now running from
294 there.
295
296 SPL-specific notes:
297 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
298 CONFIG_SPL_STACK_R_ADDR points into SDRAM
299 - preloader_console_init() can be called here - typically this is
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800300 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700301 spl_board_init() function containing this call
302 - loads U-Boot or (in falcon mode) Linux
303
304
305
wdenkc6097192002-11-03 00:24:07 +0000306Configuration Options:
307----------------------
308
309Configuration depends on the combination of board and CPU type; all
310such information is kept in a configuration file
311"include/configs/<board_name>.h".
312
313Example: For a TQM823L module, all configuration settings are in
314"include/configs/TQM823L.h".
315
316
wdenk7f6c2cb2002-11-10 22:06:23 +0000317Many of the options are named exactly as the corresponding Linux
318kernel configuration options. The intention is to make it easier to
319build a config tool - later.
320
Ashish Kumar63b23162017-08-11 11:09:14 +0530321- ARM Platform Bus Type(CCI):
322 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
323 provides full cache coherency between two clusters of multi-core
324 CPUs and I/O coherency for devices and I/O masters
325
326 CONFIG_SYS_FSL_HAS_CCI400
327
328 Defined For SoC that has cache coherent interconnect
329 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000330
Ashish Kumarc055cee2017-08-18 10:54:36 +0530331 CONFIG_SYS_FSL_HAS_CCN504
332
333 Defined for SoC that has cache coherent interconnect CCN-504
334
wdenkc6097192002-11-03 00:24:07 +0000335The following options need to be configured:
336
Kim Phillips26281142007-08-10 13:28:25 -0500337- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000338
Kim Phillips26281142007-08-10 13:28:25 -0500339- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200340
Kumar Gala66412c62011-02-18 05:40:54 -0600341- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000342 CONFIG_SYS_PPC64
343
344 Specifies that the core is a 64-bit PowerPC implementation (implements
345 the "64" category of the Power ISA). This is necessary for ePAPR
346 compliance, among other possible reasons.
347
Kumar Gala66412c62011-02-18 05:40:54 -0600348 CONFIG_SYS_FSL_TBCLK_DIV
349
350 Defines the core time base clock divider ratio compared to the
351 system clock. On most PQ3 devices this is 8, on newer QorIQ
352 devices it can be 16 or 32. The ratio varies from SoC to Soc.
353
Kumar Gala8f290842011-05-20 00:39:21 -0500354 CONFIG_SYS_FSL_PCIE_COMPAT
355
356 Defines the string to utilize when trying to match PCIe device
357 tree nodes for the given platform.
358
Scott Wood33eee332012-08-14 10:14:53 +0000359 CONFIG_SYS_FSL_ERRATUM_A004510
360
361 Enables a workaround for erratum A004510. If set,
362 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
364
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
367
368 Defines one or two SoC revisions (low 8 bits of SVR)
369 for which the A004510 workaround should be applied.
370
371 The rest of SVR is either not relevant to the decision
372 of whether the erratum is present (e.g. p2040 versus
373 p2041) or is implied by the build target, which controls
374 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
375
376 See Freescale App Note 4493 for more information about
377 this erratum.
378
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530379 CONFIG_A003399_NOR_WORKAROUND
380 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800381 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530382
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530383 CONFIG_A008044_WORKAROUND
384 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800385 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530386
Scott Wood33eee332012-08-14 10:14:53 +0000387 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
388
389 This is the value to write into CCSR offset 0x18600
390 according to the A004510 workaround.
391
Priyanka Jain64501c62013-07-02 09:21:04 +0530392 CONFIG_SYS_FSL_DSP_DDR_ADDR
393 This value denotes start offset of DDR memory which is
394 connected exclusively to the DSP cores.
395
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530396 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397 This value denotes start offset of M2 memory
398 which is directly connected to the DSP core.
399
Priyanka Jain64501c62013-07-02 09:21:04 +0530400 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401 This value denotes start offset of M3 memory which is directly
402 connected to the DSP core.
403
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530404 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405 This value denotes start offset of DSP CCSR space.
406
Priyanka Jainb1359912013-12-17 14:25:52 +0530407 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408 Single Source Clock is clocking mode present in some of FSL SoC's.
409 In this mode, a single differential clock is used to supply
410 clocks to the sysclock, ddrclock and usbclock.
411
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530412 CONFIG_SYS_CPC_REINIT_F
413 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800414 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530415
Tang Yuantianaade2002014-04-17 15:33:46 +0800416 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800417 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800418 supported, core will start to execute uboot when wakes up.
419
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000420- Generic CPU options:
421 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
422
423 Defines the endianess of the CPU. Implementation of those
424 values is arch specific.
425
York Sun5614e712013-09-30 09:22:09 -0700426 CONFIG_SYS_FSL_DDR
427 Freescale DDR driver in use. This type of DDR controller is
428 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
429 SoCs.
430
431 CONFIG_SYS_FSL_DDR_ADDR
432 Freescale DDR memory-mapped register base.
433
434 CONFIG_SYS_FSL_DDR_EMU
435 Specify emulator support for DDR. Some DDR features such as
436 deskew training are not available.
437
438 CONFIG_SYS_FSL_DDRC_GEN1
439 Freescale DDR1 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN2
442 Freescale DDR2 controller.
443
444 CONFIG_SYS_FSL_DDRC_GEN3
445 Freescale DDR3 controller.
446
York Sun34e026f2014-03-27 17:54:47 -0700447 CONFIG_SYS_FSL_DDRC_GEN4
448 Freescale DDR4 controller.
449
York Sun9ac4ffb2013-09-30 14:20:51 -0700450 CONFIG_SYS_FSL_DDRC_ARM_GEN3
451 Freescale DDR3 controller for ARM-based SoCs.
452
York Sun5614e712013-09-30 09:22:09 -0700453 CONFIG_SYS_FSL_DDR1
454 Board config to use DDR1. It can be enabled for SoCs with
455 Freescale DDR1 or DDR2 controllers, depending on the board
456 implemetation.
457
458 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400459 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700460 Freescale DDR2 or DDR3 controllers, depending on the board
461 implementation.
462
463 CONFIG_SYS_FSL_DDR3
464 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700465 Freescale DDR3 or DDR3L controllers.
466
467 CONFIG_SYS_FSL_DDR3L
468 Board config to use DDR3L. It can be enabled for SoCs with
469 DDR3L controllers.
470
471 CONFIG_SYS_FSL_DDR4
472 Board config to use DDR4. It can be enabled for SoCs with
473 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700474
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
477
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
480
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530481 CONFIG_SYS_FSL_IFC_CLK_DIV
482 Defines divider of platform clock(clock input to IFC controller).
483
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530484 CONFIG_SYS_FSL_LBC_CLK_DIV
485 Defines divider of platform clock(clock input to eLBC controller).
486
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530487 CONFIG_SYS_FSL_PBL_PBI
488 It enables addition of RCW (Power on reset configuration) in built image.
489 Please refer doc/README.pblimage for more details
490
491 CONFIG_SYS_FSL_PBL_RCW
492 It adds PBI(pre-boot instructions) commands in u-boot build image.
493 PBI commands can be used to configure SoC before it starts the execution.
494 Please refer doc/README.pblimage for more details
495
York Sun4e5b1bd2014-02-10 13:59:42 -0800496 CONFIG_SYS_FSL_DDR_BE
497 Defines the DDR controller register space as Big Endian
498
499 CONFIG_SYS_FSL_DDR_LE
500 Defines the DDR controller register space as Little Endian
501
York Sun6b9e3092014-02-10 13:59:43 -0800502 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
503 Physical address from the view of DDR controllers. It is the
504 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
505 it could be different for ARM SoCs.
506
York Sun6b1e1252014-02-10 13:59:44 -0800507 CONFIG_SYS_FSL_DDR_INTLV_256B
508 DDR controller interleaving on 256-byte. This is a special
509 interleaving mode, handled by Dickens for Freescale layerscape
510 SoCs with ARM core.
511
York Sun1d71efb2014-08-01 15:51:00 -0700512 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
513 Number of controllers used as main memory.
514
515 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
516 Number of controllers used for other than main memory.
517
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530518 CONFIG_SYS_FSL_HAS_DP_DDR
519 Defines the SoC has DP-DDR used for DPAA.
520
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530521 CONFIG_SYS_FSL_SEC_BE
522 Defines the SEC controller register space as Big Endian
523
524 CONFIG_SYS_FSL_SEC_LE
525 Defines the SEC controller register space as Little Endian
526
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200527- MIPS CPU options:
528 CONFIG_SYS_INIT_SP_OFFSET
529
530 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
531 pointer. This is needed for the temporary stack before
532 relocation.
533
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200534 CONFIG_XWAY_SWAP_BYTES
535
536 Enable compilation of tools/xway-swap-bytes needed for Lantiq
537 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
538 be swapped if a flash programmer is used.
539
Christian Rieschb67d8812012-02-02 00:44:39 +0000540- ARM options:
541 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
542
543 Select high exception vectors of the ARM core, e.g., do not
544 clear the V bit of the c1 register of CP15.
545
York Sun207774b2015-03-20 19:28:08 -0700546 COUNTER_FREQUENCY
547 Generic timer clock source frequency.
548
549 COUNTER_FREQUENCY_REAL
550 Generic timer clock source frequency if the real clock is
551 different from COUNTER_FREQUENCY, and can only be determined
552 at run time.
553
Stephen Warren73c38932015-01-19 16:25:52 -0700554- Tegra SoC options:
555 CONFIG_TEGRA_SUPPORT_NON_SECURE
556
557 Support executing U-Boot in non-secure (NS) mode. Certain
558 impossible actions will be skipped if the CPU is in NS mode,
559 such as ARM architectural timer initialization.
560
wdenk5da627a2003-10-09 20:09:04 +0000561- Linux Kernel Interface:
wdenk5da627a2003-10-09 20:09:04 +0000562 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
563
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800564 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000565 expect it to be in bytes, others in MB.
566 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
567
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400568 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200569
570 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400571 passed using flattened device trees (based on open firmware
572 concepts).
573
574 CONFIG_OF_LIBFDT
575 * New libfdt-based support
576 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500577 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400578
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200579 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600580 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200581
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200582 boards with QUICC Engines require OF_QE to set UCC MAC
583 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500584
Kumar Gala4e253132006-01-11 13:54:17 -0600585 CONFIG_OF_BOARD_SETUP
586
587 Board code has addition modification that it wants to make
588 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000589
Simon Glassc654b512014-10-23 18:58:54 -0600590 CONFIG_OF_SYSTEM_SETUP
591
592 Other code has addition modification that it wants to make
593 to the flat device tree before handing it off to the kernel.
594 This causes ft_system_setup() to be called before booting
595 the kernel.
596
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200597 CONFIG_OF_IDE_FIXUP
598
599 U-Boot can detect if an IDE device is present or not.
600 If not, and this new config option is activated, U-Boot
601 removes the ATA node from the DTS before booting Linux,
602 so the Linux IDE driver does not probe the device and
603 crash. This is needed for buggy hardware (uc101) where
604 no pull down resistor is connected to the signal IDE5V_DD7.
605
Igor Grinberg7eb29392011-07-14 05:45:07 +0000606 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
607
608 This setting is mandatory for all boards that have only one
609 machine type and must be used to specify the machine type
610 number as it appears in the ARM machine registry
611 (see http://www.arm.linux.org.uk/developer/machines/).
612 Only boards that have multiple machine types supported
613 in a single configuration file and the machine type is
614 runtime discoverable, do not have to use this setting.
615
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100616- vxWorks boot parameters:
617
618 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700619 environments variables: bootdev, bootfile, ipaddr, netmask,
620 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100621 It loads the vxWorks image pointed bootfile.
622
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100623 Note: If a "bootargs" environment is defined, it will overwride
624 the defaults discussed just above.
625
Aneesh V2c451f72011-06-16 23:30:47 +0000626- Cache Configuration:
Aneesh V2c451f72011-06-16 23:30:47 +0000627 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
628
Aneesh V93bc2192011-06-16 23:30:51 +0000629- Cache Configuration for ARM:
630 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
631 controller
632 CONFIG_SYS_PL310_BASE - Physical base address of PL310
633 controller register space
634
wdenk6705d812004-08-02 23:22:59 +0000635- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200636 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000637
638 Define this if you want support for Amba PrimeCell PL010 UARTs.
639
Andreas Engel48d01922008-09-08 14:30:53 +0200640 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000641
642 Define this if you want support for Amba PrimeCell PL011 UARTs.
643
644 CONFIG_PL011_CLOCK
645
646 If you have Amba PrimeCell PL011 UARTs, set this variable to
647 the clock speed of the UARTs.
648
649 CONFIG_PL01x_PORTS
650
651 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
652 define this to a list of base addresses for each (supported)
653 port. See e.g. include/configs/versatile.h
654
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400655 CONFIG_SERIAL_HW_FLOW_CONTROL
656
657 Define this variable to enable hw flow control in serial driver.
658 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000659
wdenkc6097192002-11-03 00:24:07 +0000660- Autoboot Command:
661 CONFIG_BOOTCOMMAND
662 Only needed when CONFIG_BOOTDELAY is enabled;
663 define a command string that is automatically executed
664 when no character is read on the console interface
665 within "Boot Delay" after reset.
666
wdenkc6097192002-11-03 00:24:07 +0000667 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000668 The value of these goes into the environment as
669 "ramboot" and "nfsboot" respectively, and can be used
670 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200671 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000672
wdenkc6097192002-11-03 00:24:07 +0000673- Serial Download Echo Mode:
674 CONFIG_LOADS_ECHO
675 If defined to 1, all characters received during a
676 serial download (using the "loads" command) are
677 echoed back. This might be needed by some terminal
678 emulations (like "cu"), but may as well just take
679 time on others. This setting #define's the initial
680 value of the "loads_echo" environment variable.
681
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500682- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000683 CONFIG_KGDB_BAUDRATE
684 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200685 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000686
Simon Glass302a6482016-03-13 19:07:28 -0600687- Removal of commands
688 If no commands are needed to boot, you can disable
689 CONFIG_CMDLINE to remove them. In this case, the command line
690 will not be available, and when U-Boot wants to execute the
691 boot command (on start-up) it will call board_run_command()
692 instead. This can reduce image size significantly for very
693 simple boot procedures.
694
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000695- Regular expression support:
696 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200697 If this variable is defined, U-Boot is linked against
698 the SLRE (Super Light Regular Expression) library,
699 which adds regex support to some commands, as for
700 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000701
Simon Glass45ba8072011-10-15 05:48:20 +0000702- Device tree:
703 CONFIG_OF_CONTROL
704 If this variable is defined, U-Boot will use a device tree
705 to configure its devices, instead of relying on statically
706 compiled #defines in the board file. This option is
707 experimental and only available on a few boards. The device
708 tree is available in the global data as gd->fdt_blob.
709
Simon Glass2c0f79e2011-10-24 19:15:31 +0000710 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700711 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000712
713 CONFIG_OF_EMBED
714 If this variable is defined, U-Boot will embed a device tree
715 binary in its image. This device tree file should be in the
716 board directory and called <soc>-<board>.dts. The binary file
717 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900718 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000719
Simon Glass2c0f79e2011-10-24 19:15:31 +0000720 CONFIG_OF_SEPARATE
721 If this variable is defined, U-Boot will build a device tree
722 binary. It will be called u-boot.dtb. Architecture-specific
723 code will locate it at run-time. Generally this works by:
724
725 cat u-boot.bin u-boot.dtb >image.bin
726
727 and in fact, U-Boot does this for you, creating a file called
728 u-boot-dtb.bin which is useful in the common case. You can
729 still use the individual files if you need something more
730 exotic.
731
Alex Deymo82f766d2017-04-02 01:25:20 -0700732 CONFIG_OF_BOARD
733 If this variable is defined, U-Boot will use the device tree
734 provided by the board at runtime instead of embedding one with
735 the image. Only boards defining board_fdt_blob_setup() support
736 this option (see include/fdtdec.h file).
737
wdenkc6097192002-11-03 00:24:07 +0000738- Watchdog:
739 CONFIG_WATCHDOG
740 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000741 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200742 specific code for a watchdog. For the 8xx
743 CPUs, the SIU Watchdog feature is enabled in the SYPCR
744 register. When supported for a specific SoC is
745 available, then no further board specific code should
746 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000747
748 CONFIG_HW_WATCHDOG
749 When using a watchdog circuitry external to the used
750 SoC, then define this variable and provide board
751 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000752
753- Real-Time Clock:
754
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500755 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000756 has to be selected, too. Define exactly one of the
757 following options:
758
wdenkc6097192002-11-03 00:24:07 +0000759 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000760 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000761 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000762 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000763 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000764 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200765 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000766 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100767 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000768 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200769 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200770 CONFIG_SYS_RV3029_TCR - enable trickle charger on
771 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000772
wdenkb37c7e52003-06-30 16:24:52 +0000773 Note that if the RTC uses I2C, then the I2C interface
774 must also be configured. See I2C Support, below.
775
Peter Tysere92739d2008-12-17 16:36:21 -0600776- GPIO Support:
777 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600778
Chris Packham5dec49c2010-12-19 10:12:13 +0000779 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
780 chip-ngpio pairs that tell the PCA953X driver the number of
781 pins supported by a particular chip.
782
Peter Tysere92739d2008-12-17 16:36:21 -0600783 Note that if the GPIO device uses I2C, then the I2C interface
784 must also be configured. See I2C Support, below.
785
Simon Glassaa532332014-06-11 23:29:41 -0600786- I/O tracing:
787 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
788 accesses and can checksum them or write a list of them out
789 to memory. See the 'iotrace' command for details. This is
790 useful for testing device drivers since it can confirm that
791 the driver behaves the same way before and after a code
792 change. Currently this is supported on sandbox and arm. To
793 add support for your architecture, add '#include <iotrace.h>'
794 to the bottom of arch/<arch>/include/asm/io.h and test.
795
796 Example output from the 'iotrace stats' command is below.
797 Note that if the trace buffer is exhausted, the checksum will
798 still continue to operate.
799
800 iotrace is enabled
801 Start: 10000000 (buffer start address)
802 Size: 00010000 (buffer size)
803 Offset: 00000120 (current buffer offset)
804 Output: 10000120 (start + offset)
805 Count: 00000018 (number of trace records)
806 CRC32: 9526fb66 (CRC32 of all trace records)
807
wdenkc6097192002-11-03 00:24:07 +0000808- Timestamp Support:
809
wdenk43d96162003-03-06 00:02:04 +0000810 When CONFIG_TIMESTAMP is selected, the timestamp
811 (date and time) of an image is printed by image
812 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000814
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000815- Partition Labels (disklabels) Supported:
816 Zero or more of the following:
817 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000818 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
819 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
820 bootloader. Note 2TB partition limit; see
821 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600822 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000823 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000824
825- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000826 CONFIG_IDE_RESET_ROUTINE - this is defined in several
827 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000828
wdenk4d13cba2004-03-14 14:09:05 +0000829 CONFIG_IDE_RESET - is this is defined, IDE Reset will
830 be performed by calling the function
831 ide_set_reset(int reset)
832 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000833
834- ATAPI Support:
835 CONFIG_ATAPI
836
837 Set this to enable ATAPI support.
838
wdenkc40b2952004-03-13 23:29:43 +0000839- LBA48 Support
840 CONFIG_LBA48
841
842 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100843 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000844 Whithout these , LBA48 support uses 32bit variables and will 'only'
845 support disks up to 2.1TB.
846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200847 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000848 When enabled, makes the IDE subsystem use 64bit sector addresses.
849 Default is 32bit.
850
wdenkc6097192002-11-03 00:24:07 +0000851- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200852 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
853 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
854 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000855 maximum numbers of LUNs, SCSI ID's and target
856 devices.
wdenkc6097192002-11-03 00:24:07 +0000857
Wolfgang Denk93e14592013-10-04 17:43:24 +0200858 The environment variable 'scsidevs' is set to the number of
859 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000860
wdenkc6097192002-11-03 00:24:07 +0000861- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000862 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000863 Support for Intel 8254x/8257x gigabit chips.
864
865 CONFIG_E1000_SPI
866 Utility code for direct access to the SPI bus on Intel 8257x.
867 This does not do anything useful unless you set at least one
868 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
869
870 CONFIG_E1000_SPI_GENERIC
871 Allow generic access to the SPI bus on the Intel 8257x, for
872 example with the "sspi" command.
873
wdenkc6097192002-11-03 00:24:07 +0000874 CONFIG_NATSEMI
875 Support for National dp83815 chips.
876
877 CONFIG_NS8382X
878 Support for National dp8382[01] gigabit chips.
879
wdenk45219c42003-05-12 21:50:16 +0000880- NETWORK Support (other):
881
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100882 CONFIG_DRIVER_AT91EMAC
883 Support for AT91RM9200 EMAC.
884
885 CONFIG_RMII
886 Define this to use reduced MII inteface
887
888 CONFIG_DRIVER_AT91EMAC_QUIET
889 If this defined, the driver is quiet.
890 The driver doen't show link status messages.
891
Rob Herringefdd7312011-12-15 11:15:49 +0000892 CONFIG_CALXEDA_XGMAC
893 Support for the Calxeda XGMAC device
894
Ashok3bb46d22012-10-15 06:20:47 +0000895 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000896 Support for SMSC's LAN91C96 chips.
897
wdenk45219c42003-05-12 21:50:16 +0000898 CONFIG_LAN91C96_USE_32_BIT
899 Define this to enable 32 bit addressing
900
Ashok3bb46d22012-10-15 06:20:47 +0000901 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000902 Support for SMSC's LAN91C111 chip
903
904 CONFIG_SMC91111_BASE
905 Define this to hold the physical address
906 of the device (I/O space)
907
908 CONFIG_SMC_USE_32_BIT
909 Define this if data bus is 32 bits
910
911 CONFIG_SMC_USE_IOFUNCS
912 Define this to use i/o functions instead of macros
913 (some hardware wont work with macros)
914
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500915 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
916 Define this if you have more then 3 PHYs.
917
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800918 CONFIG_FTGMAC100
919 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
920
921 CONFIG_FTGMAC100_EGIGA
922 Define this to use GE link update with gigabit PHY.
923 Define this if FTGMAC100 is connected to gigabit PHY.
924 If your system has 10/100 PHY only, it might not occur
925 wrong behavior. Because PHY usually return timeout or
926 useless data when polling gigabit status and gigabit
927 control registers. This behavior won't affect the
928 correctnessof 10/100 link speed update.
929
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900930 CONFIG_SH_ETHER
931 Support for Renesas on-chip Ethernet controller
932
933 CONFIG_SH_ETHER_USE_PORT
934 Define the number of ports to be used
935
936 CONFIG_SH_ETHER_PHY_ADDR
937 Define the ETH PHY's address
938
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900939 CONFIG_SH_ETHER_CACHE_WRITEBACK
940 If this option is set, the driver enables cache flush.
941
Vadim Bendebury5e124722011-10-17 08:36:14 +0000942- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000943 CONFIG_TPM
944 Support TPM devices.
945
Christophe Ricard0766ad22015-10-06 22:54:41 +0200946 CONFIG_TPM_TIS_INFINEON
947 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000948 per system is supported at this time.
949
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000950 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
951 Define the burst count bytes upper limit
952
Christophe Ricard3aa74082016-01-21 23:27:13 +0100953 CONFIG_TPM_ST33ZP24
954 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
955
956 CONFIG_TPM_ST33ZP24_I2C
957 Support for STMicroelectronics ST33ZP24 I2C devices.
958 Requires TPM_ST33ZP24 and I2C.
959
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100960 CONFIG_TPM_ST33ZP24_SPI
961 Support for STMicroelectronics ST33ZP24 SPI devices.
962 Requires TPM_ST33ZP24 and SPI.
963
Dirk Eibachc01939c2013-06-26 15:55:15 +0200964 CONFIG_TPM_ATMEL_TWI
965 Support for Atmel TWI TPM device. Requires I2C support.
966
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000967 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000968 Support for generic parallel port TPM devices. Only one device
969 per system is supported at this time.
970
971 CONFIG_TPM_TIS_BASE_ADDRESS
972 Base address where the generic TPM device is mapped
973 to. Contemporary x86 systems usually map it at
974 0xfed40000.
975
Reinhard Pfaube6c1522013-06-26 15:55:13 +0200976 CONFIG_TPM
977 Define this to enable the TPM support library which provides
978 functional interfaces to some TPM commands.
979 Requires support for a TPM device.
980
981 CONFIG_TPM_AUTH_SESSIONS
982 Define this to enable authorized functions in the TPM library.
983 Requires CONFIG_TPM and CONFIG_SHA1.
984
wdenkc6097192002-11-03 00:24:07 +0000985- USB Support:
986 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +0200987 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000988 CONFIG_USB_UHCI to enable it.
989 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000990 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000991 storage devices.
992 Note:
993 Supported are USB Keyboards and USB Floppy drives
994 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000995
Simon Glass9ab4ce22012-02-27 10:52:47 +0000996 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
997 txfilltuning field in the EHCI controller on reset.
998
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -0700999 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1000 HW module registers.
1001
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001002- USB Device:
1003 Define the below if you wish to use the USB console.
1004 Once firmware is rebuilt from a serial console issue the
1005 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001006 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001007 it has found a new device. The environment variable usbtty
1008 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001009 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001010 Common Device Class Abstract Control Model serial device.
1011 If you select usbtty = gserial you should be able to enumerate
1012 a Linux host by
1013 # modprobe usbserial vendor=0xVendorID product=0xProductID
1014 else if using cdc_acm, simply setting the environment
1015 variable usbtty to be cdc_acm should suffice. The following
1016 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001017
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001018 CONFIG_USB_DEVICE
1019 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001020
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001021 CONFIG_USB_TTY
1022 Define this to have a tty type of device available to
1023 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001024
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301025 CONFIG_USBD_HS
1026 Define this to enable the high speed support for usb
1027 device and usbtty. If this feature is enabled, a routine
1028 int is_usbd_high_speed(void)
1029 also needs to be defined by the driver to dynamically poll
1030 whether the enumeration has succeded at high speed or full
1031 speed.
1032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001033 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001034 Define this if you want stdin, stdout &/or stderr to
1035 be set to usbtty.
1036
Wolfgang Denk386eda02006-06-14 18:14:56 +02001037 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001038 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001039 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001040 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1041 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1042 should pretend to be a Linux device to it's target host.
1043
1044 CONFIG_USBD_MANUFACTURER
1045 Define this string as the name of your company for
1046 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001047
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001048 CONFIG_USBD_PRODUCT_NAME
1049 Define this string as the name of your product
1050 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1051
1052 CONFIG_USBD_VENDORID
1053 Define this as your assigned Vendor ID from the USB
1054 Implementors Forum. This *must* be a genuine Vendor ID
1055 to avoid polluting the USB namespace.
1056 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001057
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001058 CONFIG_USBD_PRODUCTID
1059 Define this as the unique Product ID
1060 for your device
1061 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001062
Igor Grinbergd70a5602011-12-12 12:08:35 +02001063- ULPI Layer Support:
1064 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1065 the generic ULPI layer. The generic layer accesses the ULPI PHY
1066 via the platform viewport, so you need both the genric layer and
1067 the viewport enabled. Currently only Chipidea/ARC based
1068 viewport is supported.
1069 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1070 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001071 If your ULPI phy needs a different reference clock than the
1072 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1073 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001074
1075- MMC Support:
1076 The MMC controller on the Intel PXA is supported. To
1077 enable this define CONFIG_MMC. The MMC can be
1078 accessed from the boot prompt by mapping the device
1079 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1081 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001082
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001083 CONFIG_SH_MMCIF
1084 Support for Renesas on-chip MMCIF controller
1085
1086 CONFIG_SH_MMCIF_ADDR
1087 Define the base address of MMCIF registers
1088
1089 CONFIG_SH_MMCIF_CLK
1090 Define the clock frequency for MMCIF
1091
Tom Rinib3ba6e92013-03-14 05:32:47 +00001092- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +01001093 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +00001094 This enables the USB portion of the DFU USB class
1095
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001096 CONFIG_DFU_NAND
1097 This enables support for exposing NAND devices via DFU.
1098
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301099 CONFIG_DFU_RAM
1100 This enables support for exposing RAM via DFU.
1101 Note: DFU spec refer to non-volatile memory usage, but
1102 allow usages beyond the scope of spec - here RAM usage,
1103 one that would help mostly the developer.
1104
Heiko Schochere7e75c72013-06-12 06:05:51 +02001105 CONFIG_SYS_DFU_DATA_BUF_SIZE
1106 Dfu transfer uses a buffer before writing data to the
1107 raw storage device. Make the size (in bytes) of this buffer
1108 configurable. The size of this buffer is also configurable
1109 through the "dfu_bufsiz" environment variable.
1110
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001111 CONFIG_SYS_DFU_MAX_FILE_SIZE
1112 When updating files rather than the raw storage device,
1113 we use a static buffer to copy the file into and then write
1114 the buffer once we've been given the whole file. Define
1115 this to the maximum filesize (in bytes) for the buffer.
1116 Default is 4 MiB if undefined.
1117
Heiko Schocher001a8312014-03-18 08:09:56 +01001118 DFU_DEFAULT_POLL_TIMEOUT
1119 Poll timeout [ms], is the timeout a device can send to the
1120 host. The host must wait for this timeout before sending
1121 a subsequent DFU_GET_STATUS request to the device.
1122
1123 DFU_MANIFEST_POLL_TIMEOUT
1124 Poll timeout [ms], which the device sends to the host when
1125 entering dfuMANIFEST state. Host waits this timeout, before
1126 sending again an USB request to the device.
1127
wdenk6705d812004-08-02 23:22:59 +00001128- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001129 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001130 Define these for a default partition on a NAND device
1131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001132 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1133 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001134 Define these for a default partition on a NOR device
1135
wdenkc6097192002-11-03 00:24:07 +00001136- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001137 See Kconfig help for available keyboard drivers.
1138
1139 CONFIG_KEYBOARD
1140
1141 Define this to enable a custom keyboard support.
1142 This simply calls drv_keyboard_init() which must be
1143 defined in your board-specific files. This option is deprecated
1144 and is only used by novena. For new boards, use driver model
1145 instead.
wdenkc6097192002-11-03 00:24:07 +00001146
1147- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001148 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001149 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001150 SOCs that have a DIU should define this macro to enable DIU
1151 support, and should also define these other macros:
1152
1153 CONFIG_SYS_DIU_ADDR
1154 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001155 CONFIG_CFB_CONSOLE
1156 CONFIG_VIDEO_SW_CURSOR
1157 CONFIG_VGA_AS_SINGLE_DEVICE
1158 CONFIG_VIDEO_LOGO
1159 CONFIG_VIDEO_BMP_LOGO
1160
Timur Tabiba8e76b2011-04-11 14:18:22 -05001161 The DIU driver will look for the 'video-mode' environment
1162 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001163 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001164 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001165
wdenkc6097192002-11-03 00:24:07 +00001166- LCD Support: CONFIG_LCD
1167
1168 Define this to enable LCD support (for output to LCD
1169 display); also select one of the supported displays
1170 by defining one of these:
1171
Stelian Pop39cf4802008-05-09 21:57:18 +02001172 CONFIG_ATMEL_LCD:
1173
1174 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1175
wdenkfd3103b2003-11-25 16:55:19 +00001176 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001177
wdenkfd3103b2003-11-25 16:55:19 +00001178 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001179
wdenkfd3103b2003-11-25 16:55:19 +00001180 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001181
wdenkfd3103b2003-11-25 16:55:19 +00001182 NEC NL6448BC20-08. 6.5", 640x480.
1183 Active, color, single scan.
1184
1185 CONFIG_NEC_NL6448BC33_54
1186
1187 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001188 Active, color, single scan.
1189
1190 CONFIG_SHARP_16x9
1191
1192 Sharp 320x240. Active, color, single scan.
1193 It isn't 16x9, and I am not sure what it is.
1194
1195 CONFIG_SHARP_LQ64D341
1196
1197 Sharp LQ64D341 display, 640x480.
1198 Active, color, single scan.
1199
1200 CONFIG_HLD1045
1201
1202 HLD1045 display, 640x480.
1203 Active, color, single scan.
1204
1205 CONFIG_OPTREX_BW
1206
1207 Optrex CBL50840-2 NF-FW 99 22 M5
1208 or
1209 Hitachi LMG6912RPFC-00T
1210 or
1211 Hitachi SP14Q002
1212
1213 320x240. Black & white.
1214
Simon Glass676d3192012-10-17 13:24:54 +00001215 CONFIG_LCD_ALIGNMENT
1216
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001217 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001218 defined then the LCD will be aligned to this value instead.
1219 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1220 here, since it is cheaper to change data cache settings on
1221 a per-section basis.
1222
1223
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001224 CONFIG_LCD_ROTATION
1225
1226 Sometimes, for example if the display is mounted in portrait
1227 mode or even if it's mounted landscape but rotated by 180degree,
1228 we need to rotate our content of the display relative to the
1229 framebuffer, so that user can read the messages which are
1230 printed out.
1231 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1232 initialized with a given rotation from "vl_rot" out of
1233 "vidinfo_t" which is provided by the board specific code.
1234 The value for vl_rot is coded as following (matching to
1235 fbcon=rotate:<n> linux-kernel commandline):
1236 0 = no rotation respectively 0 degree
1237 1 = 90 degree rotation
1238 2 = 180 degree rotation
1239 3 = 270 degree rotation
1240
1241 If CONFIG_LCD_ROTATION is not defined, the console will be
1242 initialized with 0degree rotation.
1243
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001244 CONFIG_LCD_BMP_RLE8
1245
1246 Support drawing of RLE8-compressed bitmaps on the LCD.
1247
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001248 CONFIG_I2C_EDID
1249
1250 Enables an 'i2c edid' command which can read EDID
1251 information over I2C from an attached LCD display.
1252
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001253- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1254
1255 If this option is set, additionally to standard BMP
1256 images, gzipped BMP images can be displayed via the
1257 splashscreen support or the bmp command.
1258
Anatolij Gustschind5011762010-03-15 14:50:25 +01001259- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1260
1261 If this option is set, 8-bit RLE compressed BMP images
1262 can be displayed via the splashscreen support or the
1263 bmp command.
1264
wdenk17ea1172004-06-06 21:51:03 +00001265- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +00001266 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1267
1268 The clock frequency of the MII bus
1269
wdenk17ea1172004-06-06 21:51:03 +00001270 CONFIG_PHY_RESET_DELAY
1271
1272 Some PHY like Intel LXT971A need extra delay after
1273 reset before any MII register access is possible.
1274 For such PHY, set this option to the usec delay
1275 required. (minimum 300usec for LXT971A)
1276
1277 CONFIG_PHY_CMD_DELAY (ppc4xx)
1278
1279 Some PHY like Intel LXT971A need extra delay after
1280 command issued before MII status register can be read
1281
wdenkc6097192002-11-03 00:24:07 +00001282- IP address:
1283 CONFIG_IPADDR
1284
1285 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001286 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001287 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001288 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001289
1290- Server IP address:
1291 CONFIG_SERVERIP
1292
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001293 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001294 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001295 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001296
Robin Getz97cfe862009-07-21 12:15:28 -04001297 CONFIG_KEEP_SERVERADDR
1298
1299 Keeps the server's MAC address, in the env 'serveraddr'
1300 for passing to bootargs (like Linux's netconsole option)
1301
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001302- Gateway IP address:
1303 CONFIG_GATEWAYIP
1304
1305 Defines a default value for the IP address of the
1306 default router where packets to other networks are
1307 sent to.
1308 (Environment variable "gatewayip")
1309
1310- Subnet mask:
1311 CONFIG_NETMASK
1312
1313 Defines a default value for the subnet mask (or
1314 routing prefix) which is used to determine if an IP
1315 address belongs to the local subnet or needs to be
1316 forwarded through a router.
1317 (Environment variable "netmask")
1318
wdenkc6097192002-11-03 00:24:07 +00001319- BOOTP Recovery Mode:
1320 CONFIG_BOOTP_RANDOM_DELAY
1321
1322 If you have many targets in a network that try to
1323 boot using BOOTP, you may want to avoid that all
1324 systems send out BOOTP requests at precisely the same
1325 moment (which would happen for instance at recovery
1326 from a power failure, when all systems will try to
1327 boot, thus flooding the BOOTP server. Defining
1328 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1329 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001330 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001331
1332 1st BOOTP request: delay 0 ... 1 sec
1333 2nd BOOTP request: delay 0 ... 2 sec
1334 3rd BOOTP request: delay 0 ... 4 sec
1335 4th and following
1336 BOOTP requests: delay 0 ... 8 sec
1337
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001338 CONFIG_BOOTP_ID_CACHE_SIZE
1339
1340 BOOTP packets are uniquely identified using a 32-bit ID. The
1341 server will copy the ID from client requests to responses and
1342 U-Boot will use this to determine if it is the destination of
1343 an incoming response. Some servers will check that addresses
1344 aren't in use before handing them out (usually using an ARP
1345 ping) and therefore take up to a few hundred milliseconds to
1346 respond. Network congestion may also influence the time it
1347 takes for a response to make it back to the client. If that
1348 time is too long, U-Boot will retransmit requests. In order
1349 to allow earlier responses to still be accepted after these
1350 retransmissions, U-Boot's BOOTP client keeps a small cache of
1351 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1352 cache. The default is to keep IDs for up to four outstanding
1353 requests. Increasing this will allow U-Boot to accept offers
1354 from a BOOTP client in networks with unusually high latency.
1355
stroesefe389a82003-08-28 14:17:32 +00001356- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001357 You can fine tune the DHCP functionality by defining
1358 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001359
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001360 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001361 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001362 CONFIG_BOOTP_NTPSERVER
1363 CONFIG_BOOTP_TIMEOFFSET
1364 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001365 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001366
Wilson Callan5d110f02007-07-28 10:56:13 -04001367 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1368 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001369
Joe Hershberger2c00e092012-05-23 07:59:19 +00001370 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1371 after the configured retry count, the call will fail
1372 instead of starting over. This can be used to fail over
1373 to Link-local IP address configuration if the DHCP server
1374 is not available.
1375
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001376 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1377
1378 A 32bit value in microseconds for a delay between
1379 receiving a "DHCP Offer" and sending the "DHCP Request".
1380 This fixes a problem with certain DHCP servers that don't
1381 respond 100% of the time to a "DHCP request". E.g. On an
1382 AT91RM9200 processor running at 180MHz, this delay needed
1383 to be *at least* 15,000 usec before a Windows Server 2003
1384 DHCP server would reply 100% of the time. I recommend at
1385 least 50,000 usec to be safe. The alternative is to hope
1386 that one of the retries will be successful but note that
1387 the DHCP timeout and retry process takes a longer than
1388 this delay.
1389
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001390 - Link-local IP address negotiation:
1391 Negotiate with other link-local clients on the local network
1392 for an address that doesn't require explicit configuration.
1393 This is especially useful if a DHCP server cannot be guaranteed
1394 to exist in all environments that the device must operate.
1395
1396 See doc/README.link-local for more information.
1397
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301398 - MAC address from environment variables
1399
1400 FDT_SEQ_MACADDR_FROM_ENV
1401
1402 Fix-up device tree with MAC addresses fetched sequentially from
1403 environment variables. This config work on assumption that
1404 non-usable ethernet node of device-tree are either not present
1405 or their status has been marked as "disabled".
1406
wdenka3d991b2004-04-15 21:48:45 +00001407 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001408 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001409
1410 The device id used in CDP trigger frames.
1411
1412 CONFIG_CDP_DEVICE_ID_PREFIX
1413
1414 A two character string which is prefixed to the MAC address
1415 of the device.
1416
1417 CONFIG_CDP_PORT_ID
1418
1419 A printf format string which contains the ascii name of
1420 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001421 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001422
1423 CONFIG_CDP_CAPABILITIES
1424
1425 A 32bit integer which indicates the device capabilities;
1426 0x00000010 for a normal host which does not forwards.
1427
1428 CONFIG_CDP_VERSION
1429
1430 An ascii string containing the version of the software.
1431
1432 CONFIG_CDP_PLATFORM
1433
1434 An ascii string containing the name of the platform.
1435
1436 CONFIG_CDP_TRIGGER
1437
1438 A 32bit integer sent on the trigger.
1439
1440 CONFIG_CDP_POWER_CONSUMPTION
1441
1442 A 16bit integer containing the power consumption of the
1443 device in .1 of milliwatts.
1444
1445 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1446
1447 A byte containing the id of the VLAN.
1448
Uri Mashiach79267ed2017-01-19 10:51:05 +02001449- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001450
1451 Several configurations allow to display the current
1452 status using a LED. For instance, the LED will blink
1453 fast while running U-Boot code, stop blinking as
1454 soon as a reply to a BOOTP request was received, and
1455 start blinking slow once the Linux kernel is running
1456 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001457 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001458 feature in U-Boot.
1459
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001460 Additional options:
1461
Uri Mashiach79267ed2017-01-19 10:51:05 +02001462 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001463 The status LED can be connected to a GPIO pin.
1464 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001465 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001466 to include the gpio_led driver in the U-Boot binary.
1467
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001468 CONFIG_GPIO_LED_INVERTED_TABLE
1469 Some GPIO connected LEDs may have inverted polarity in which
1470 case the GPIO high value corresponds to LED off state and
1471 GPIO low value corresponds to LED on state.
1472 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1473 with a list of GPIO LEDs that have inverted polarity.
1474
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001475- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001476
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001477 This enable the NEW i2c subsystem, and will allow you to use
1478 i2c commands at the u-boot command line (as long as you set
Heiko Schocherea818db2013-01-29 08:53:15 +01001479 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1480 for defining speed and slave address
1481 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1482 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1483 for defining speed and slave address
1484 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1485 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1486 for defining speed and slave address
1487 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1488 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1489 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001490
Heiko Schocher00f792e2012-10-24 13:48:22 +02001491 - drivers/i2c/fsl_i2c.c:
1492 - activate i2c driver with CONFIG_SYS_I2C_FSL
1493 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1494 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1495 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1496 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001497 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001498 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1499 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1500 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1501 second bus.
1502
Simon Glass1f2ba722012-10-30 07:28:53 +00001503 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001504 - activate this driver with CONFIG_SYS_I2C_TEGRA
1505 - This driver adds 4 i2c buses with a fix speed from
1506 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001507
Dirk Eibach880540d2013-04-25 02:40:01 +00001508 - drivers/i2c/ppc4xx_i2c.c
1509 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1510 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1511 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1512
tremfac96402013-09-21 18:13:35 +02001513 - drivers/i2c/i2c_mxc.c
1514 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001515 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1516 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1517 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1518 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001519 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1520 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1521 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1522 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1523 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1524 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001525 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1526 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001527 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001528 for speed, and 0 for slave.
1529
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001530 - drivers/i2c/rcar_i2c.c:
1531 - activate this driver with CONFIG_SYS_I2C_RCAR
1532 - This driver adds 4 i2c buses
1533
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001534 - drivers/i2c/sh_i2c.c:
1535 - activate this driver with CONFIG_SYS_I2C_SH
1536 - This driver adds from 2 to 5 i2c buses
1537
1538 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1539 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1540 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1541 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1542 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1543 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1544 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1545 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1546 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1547 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001548 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001549
Heiko Schocher6789e842013-10-22 11:03:18 +02001550 - drivers/i2c/omap24xx_i2c.c
1551 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1552 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1553 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1554 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1555 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1556 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1557 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1558 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1559 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1560 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1561 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1562
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301563 - drivers/i2c/s3c24x0_i2c.c:
1564 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1565 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1566 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1567 with a fix speed from 100000 and the slave addr 0!
1568
Dirk Eibachb46226b2014-07-03 09:28:18 +02001569 - drivers/i2c/ihs_i2c.c
1570 - activate this driver with CONFIG_SYS_I2C_IHS
1571 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1572 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1573 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1574 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1575 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1576 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1577 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1578 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1579 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1580 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1581 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1582 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001583 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1584 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1585 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1586 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1587 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1588 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1589 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1590 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1591 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001592
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001593 additional defines:
1594
1595 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001596 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001597
1598 CONFIG_SYS_I2C_DIRECT_BUS
1599 define this, if you don't use i2c muxes on your hardware.
1600 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1601 omit this define.
1602
1603 CONFIG_SYS_I2C_MAX_HOPS
1604 define how many muxes are maximal consecutively connected
1605 on one i2c bus. If you not use i2c muxes, omit this
1606 define.
1607
1608 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001609 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001610 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1611 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1612 CONFIG_SYS_NUM_I2C_BUSES = 9:
1613
1614 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1615 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1616 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1617 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1618 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1619 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1620 {1, {I2C_NULL_HOP}}, \
1621 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1622 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1623 }
1624
1625 which defines
1626 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001627 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1628 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1629 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1630 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1631 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001632 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001633 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1634 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001635
1636 If you do not have i2c muxes on your board, omit this define.
1637
Simon Glassce3b5d62017-05-12 21:10:00 -06001638- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001639 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001640 then the following macros need to be defined (examples are
1641 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001642
1643 I2C_INIT
1644
wdenkb37c7e52003-06-30 16:24:52 +00001645 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001646 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001647
wdenkba56f622004-02-06 23:19:44 +00001648 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001649
wdenkc6097192002-11-03 00:24:07 +00001650 I2C_ACTIVE
1651
1652 The code necessary to make the I2C data line active
1653 (driven). If the data line is open collector, this
1654 define can be null.
1655
wdenkb37c7e52003-06-30 16:24:52 +00001656 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1657
wdenkc6097192002-11-03 00:24:07 +00001658 I2C_TRISTATE
1659
1660 The code necessary to make the I2C data line tri-stated
1661 (inactive). If the data line is open collector, this
1662 define can be null.
1663
wdenkb37c7e52003-06-30 16:24:52 +00001664 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1665
wdenkc6097192002-11-03 00:24:07 +00001666 I2C_READ
1667
York Sun472d5462013-04-01 11:29:11 -07001668 Code that returns true if the I2C data line is high,
1669 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001670
wdenkb37c7e52003-06-30 16:24:52 +00001671 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1672
wdenkc6097192002-11-03 00:24:07 +00001673 I2C_SDA(bit)
1674
York Sun472d5462013-04-01 11:29:11 -07001675 If <bit> is true, sets the I2C data line high. If it
1676 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001677
wdenkb37c7e52003-06-30 16:24:52 +00001678 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001679 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001680 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001681
wdenkc6097192002-11-03 00:24:07 +00001682 I2C_SCL(bit)
1683
York Sun472d5462013-04-01 11:29:11 -07001684 If <bit> is true, sets the I2C clock line high. If it
1685 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001686
wdenkb37c7e52003-06-30 16:24:52 +00001687 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001688 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001689 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001690
wdenkc6097192002-11-03 00:24:07 +00001691 I2C_DELAY
1692
1693 This delay is invoked four times per clock cycle so this
1694 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001695 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001696 like:
1697
wdenkb37c7e52003-06-30 16:24:52 +00001698 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001699
Mike Frysinger793b5722010-07-21 13:38:02 -04001700 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1701
1702 If your arch supports the generic GPIO framework (asm/gpio.h),
1703 then you may alternatively define the two GPIOs that are to be
1704 used as SCL / SDA. Any of the previous I2C_xxx macros will
1705 have GPIO-based defaults assigned to them as appropriate.
1706
1707 You should define these to the GPIO value as given directly to
1708 the generic GPIO functions.
1709
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001710 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001711
wdenk8bde7f72003-06-27 21:31:46 +00001712 When a board is reset during an i2c bus transfer
1713 chips might think that the current transfer is still
1714 in progress. On some boards it is possible to access
1715 the i2c SCLK line directly, either by using the
1716 processor pin as a GPIO or by having a second pin
1717 connected to the bus. If this option is defined a
1718 custom i2c_init_board() routine in boards/xxx/board.c
1719 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001720
Ben Warrenbb99ad62006-09-07 16:50:54 -04001721 CONFIG_I2C_MULTI_BUS
1722
1723 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001724 must have a controller. At any point in time, only one bus is
1725 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001726 Note that bus numbering is zero-based.
1727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001728 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001729
1730 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001731 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001732 is set, specify a list of bus-device pairs. Otherwise, specify
1733 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001734
1735 e.g.
1736 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001737 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001738
1739 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1740
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001741 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001742 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001743
1744 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001746 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001747
1748 If defined, then this indicates the I2C bus number for DDR SPD.
1749 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001751 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001752
1753 If defined, then this indicates the I2C bus number for the RTC.
1754 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1755
Andrew Dyer2ac69852008-12-29 17:36:01 -06001756 CONFIG_SOFT_I2C_READ_REPEATED_START
1757
1758 defining this will force the i2c_read() function in
1759 the soft_i2c driver to perform an I2C repeated start
1760 between writing the address pointer and reading the
1761 data. If this define is omitted the default behaviour
1762 of doing a stop-start sequence will be used. Most I2C
1763 devices can use either method, but some require one or
1764 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001765
wdenkc6097192002-11-03 00:24:07 +00001766- SPI Support: CONFIG_SPI
1767
1768 Enables SPI driver (so far only tested with
1769 SPI EEPROM, also an instance works with Crystal A/D and
1770 D/As on the SACSng board)
1771
wdenkc6097192002-11-03 00:24:07 +00001772 CONFIG_SOFT_SPI
1773
wdenk43d96162003-03-06 00:02:04 +00001774 Enables a software (bit-bang) SPI driver rather than
1775 using hardware support. This is a general purpose
1776 driver that only requires three general I/O port pins
1777 (two outputs, one input) to function. If this is
1778 defined, the board configuration must define several
1779 SPI configuration items (port pins to use, etc). For
1780 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001781
Heiko Schocherf659b572014-07-14 10:22:11 +02001782 CONFIG_SYS_SPI_MXC_WAIT
1783 Timeout for waiting until spi transfer completed.
1784 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1785
Matthias Fuchs01335022007-12-27 17:12:34 +01001786- FPGA Support: CONFIG_FPGA
1787
1788 Enables FPGA subsystem.
1789
1790 CONFIG_FPGA_<vendor>
1791
1792 Enables support for specific chip vendors.
1793 (ALTERA, XILINX)
1794
1795 CONFIG_FPGA_<family>
1796
1797 Enables support for FPGA family.
1798 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1799
1800 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001801
wdenk43d96162003-03-06 00:02:04 +00001802 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001804 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001805
wdenk8bde7f72003-06-27 21:31:46 +00001806 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001808 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001809
wdenk43d96162003-03-06 00:02:04 +00001810 Enable checks on FPGA configuration interface busy
1811 status by the configuration function. This option
1812 will require a board or device specific function to
1813 be written.
wdenkc6097192002-11-03 00:24:07 +00001814
1815 CONFIG_FPGA_DELAY
1816
1817 If defined, a function that provides delays in the FPGA
1818 configuration driver.
1819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001820 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001821 Allow Control-C to interrupt FPGA configuration
1822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001823 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001824
wdenk43d96162003-03-06 00:02:04 +00001825 Check for configuration errors during FPGA bitfile
1826 loading. For example, abort during Virtex II
1827 configuration if the INIT_B line goes low (which
1828 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001830 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001831
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001832 Maximum time to wait for the INIT_B line to de-assert
1833 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00001834 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001835 ms.
wdenkc6097192002-11-03 00:24:07 +00001836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001837 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001838
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001839 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001840 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001842 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001843
wdenk43d96162003-03-06 00:02:04 +00001844 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001845 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001846
1847- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02001848
wdenkc6097192002-11-03 00:24:07 +00001849 CONFIG_IDENT_STRING
1850
wdenk43d96162003-03-06 00:02:04 +00001851 If defined, this string will be added to the U-Boot
1852 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001853
1854- Vendor Parameter Protection:
1855
wdenk43d96162003-03-06 00:02:04 +00001856 U-Boot considers the values of the environment
1857 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001858 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001859 are set once by the board vendor / manufacturer, and
1860 protects these variables from casual modification by
1861 the user. Once set, these variables are read-only,
1862 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001863 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001864
1865 If CONFIG_ENV_OVERWRITE is #defined in your config
1866 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001867 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001868 these parameters.
1869
Joe Hershberger92ac5202015-05-04 14:55:14 -05001870 Alternatively, if you define _both_ an ethaddr in the
1871 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001872 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001873 which can be changed exactly ONCE by the user. [The
1874 serial# is unaffected by this, i. e. it remains
1875 read-only.]
1876
Joe Hershberger25980902012-12-11 22:16:31 -06001877 The same can be accomplished in a more flexible way
1878 for any variable by configuring the type of access
1879 to allow for those variables in the ".flags" variable
1880 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1881
wdenkc6097192002-11-03 00:24:07 +00001882- Protected RAM:
1883 CONFIG_PRAM
1884
1885 Define this variable to enable the reservation of
1886 "protected RAM", i. e. RAM which is not overwritten
1887 by U-Boot. Define CONFIG_PRAM to hold the number of
1888 kB you want to reserve for pRAM. You can overwrite
1889 this default value by defining an environment
1890 variable "pram" to the number of kB you want to
1891 reserve. Note that the board info structure will
1892 still show the full amount of RAM. If pRAM is
1893 reserved, a new environment variable "mem" will
1894 automatically be defined to hold the amount of
1895 remaining RAM in a form that can be passed as boot
1896 argument to Linux, for instance like that:
1897
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001898 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001899 saveenv
1900
1901 This way you can tell Linux not to use this memory,
1902 either, which results in a memory region that will
1903 not be affected by reboots.
1904
1905 *WARNING* If your board configuration uses automatic
1906 detection of the RAM size, you must make sure that
1907 this memory test is non-destructive. So far, the
1908 following board configurations are known to be
1909 "pRAM-clean":
1910
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001911 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00001912 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02001913 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001914
Gabe Black40fef042012-12-02 04:55:18 +00001915- Access to physical memory region (> 4GB)
1916 Some basic support is provided for operations on memory not
1917 normally accessible to U-Boot - e.g. some architectures
1918 support access to more than 4GB of memory on 32-bit
1919 machines using physical address extension or similar.
1920 Define CONFIG_PHYSMEM to access this basic support, which
1921 currently only supports clearing the memory.
1922
wdenkc6097192002-11-03 00:24:07 +00001923- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001924 CONFIG_NET_RETRY_COUNT
1925
wdenk43d96162003-03-06 00:02:04 +00001926 This variable defines the number of retries for
1927 network operations like ARP, RARP, TFTP, or BOOTP
1928 before giving up the operation. If not defined, a
1929 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001930
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001931 CONFIG_ARP_TIMEOUT
1932
1933 Timeout waiting for an ARP reply in milliseconds.
1934
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00001935 CONFIG_NFS_TIMEOUT
1936
1937 Timeout in milliseconds used in NFS protocol.
1938 If you encounter "ERROR: Cannot umount" in nfs command,
1939 try longer timeout such as
1940 #define CONFIG_NFS_TIMEOUT 10000UL
1941
wdenkc6097192002-11-03 00:24:07 +00001942- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001943 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001944
1945 This defines the secondary prompt string, which is
1946 printed when the command interpreter needs more input
1947 to complete a command. Usually "> ".
1948
1949 Note:
1950
wdenk8bde7f72003-06-27 21:31:46 +00001951 In the current implementation, the local variables
1952 space and global environment variables space are
1953 separated. Local variables are those you define by
1954 simply typing `name=value'. To access a local
1955 variable later on, you have write `$name' or
1956 `${name}'; to execute the contents of a variable
1957 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001958
wdenk43d96162003-03-06 00:02:04 +00001959 Global environment variables are those you use
1960 setenv/printenv to work with. To run a command stored
1961 in such a variable, you need to use the run command,
1962 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001963
1964 To store commands and special characters in a
1965 variable, please use double quotation marks
1966 surrounding the whole text of the variable, instead
1967 of the backslashes before semicolons and special
1968 symbols.
1969
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001970- Command Line Editing and History:
Marek Vasutf3b267b2016-01-27 04:47:55 +01001971 CONFIG_CMDLINE_PS_SUPPORT
1972
1973 Enable support for changing the command prompt string
1974 at run-time. Only static string is supported so far.
1975 The string is obtained from environment variables PS1
1976 and PS2.
1977
wdenka8c7c702003-12-06 19:49:23 +00001978- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001979 CONFIG_EXTRA_ENV_SETTINGS
1980
wdenk43d96162003-03-06 00:02:04 +00001981 Define this to contain any number of null terminated
1982 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001983 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001984
wdenk43d96162003-03-06 00:02:04 +00001985 For example, place something like this in your
1986 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001987
1988 #define CONFIG_EXTRA_ENV_SETTINGS \
1989 "myvar1=value1\0" \
1990 "myvar2=value2\0"
1991
wdenk43d96162003-03-06 00:02:04 +00001992 Warning: This method is based on knowledge about the
1993 internal format how the environment is stored by the
1994 U-Boot code. This is NOT an official, exported
1995 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001996 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001997 You better know what you are doing here.
1998
wdenk43d96162003-03-06 00:02:04 +00001999 Note: overly (ab)use of the default environment is
2000 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002001 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002002 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002003
Simon Glass06fd8532012-11-30 13:01:17 +00002004 CONFIG_DELAY_ENVIRONMENT
2005
2006 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002007 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002008 that so that the environment is not available until
2009 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2010 this is instead controlled by the value of
2011 /config/load-environment.
2012
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002013- TFTP Fixed UDP Port:
2014 CONFIG_TFTP_PORT
2015
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002016 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002017 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002018 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002019 number generator is used.
2020
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002021 Also, the environment variable tftpdstp is used to supply
2022 the TFTP UDP destination port value. If tftpdstp isn't
2023 defined, the normal port 69 is used.
2024
2025 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002026 blindly start the TFTP transfer using the pre-configured
2027 target IP address and UDP port. This has the effect of
2028 "punching through" the (Windows XP) firewall, allowing
2029 the remainder of the TFTP transfer to proceed normally.
2030 A better solution is to properly configure the firewall,
2031 but sometimes that is not allowed.
2032
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002033 CONFIG_STANDALONE_LOAD_ADDR
2034
Wolfgang Denk6feff892011-10-09 21:06:34 +02002035 This option defines a board specific value for the
2036 address where standalone program gets loaded, thus
2037 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002038 settings.
2039
2040- Frame Buffer Address:
2041 CONFIG_FB_ADDR
2042
2043 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002044 address for frame buffer. This is typically the case
2045 when using a graphics controller has separate video
2046 memory. U-Boot will then place the frame buffer at
2047 the given address instead of dynamically reserving it
2048 in system RAM by calling lcd_setmem(), which grabs
2049 the memory for the frame buffer depending on the
2050 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002051
2052 Please see board_init_f function.
2053
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002054- Automatic software updates via TFTP server
2055 CONFIG_UPDATE_TFTP
2056 CONFIG_UPDATE_TFTP_CNT_MAX
2057 CONFIG_UPDATE_TFTP_MSEC_MAX
2058
2059 These options enable and control the auto-update feature;
2060 for a more detailed description refer to doc/README.update.
2061
2062- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02002063 CONFIG_MTD_UBI_WL_THRESHOLD
2064 This parameter defines the maximum difference between the highest
2065 erase counter value and the lowest erase counter value of eraseblocks
2066 of UBI devices. When this threshold is exceeded, UBI starts performing
2067 wear leveling by means of moving data from eraseblock with low erase
2068 counter to eraseblocks with high erase counter.
2069
2070 The default value should be OK for SLC NAND flashes, NOR flashes and
2071 other flashes which have eraseblock life-cycle 100000 or more.
2072 However, in case of MLC NAND flashes which typically have eraseblock
2073 life-cycle less than 10000, the threshold should be lessened (e.g.,
2074 to 128 or 256, although it does not have to be power of 2).
2075
2076 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002077
Heiko Schocherff94bc42014-06-24 10:10:04 +02002078 CONFIG_MTD_UBI_BEB_LIMIT
2079 This option specifies the maximum bad physical eraseblocks UBI
2080 expects on the MTD device (per 1024 eraseblocks). If the
2081 underlying flash does not admit of bad eraseblocks (e.g. NOR
2082 flash), this value is ignored.
2083
2084 NAND datasheets often specify the minimum and maximum NVM
2085 (Number of Valid Blocks) for the flashes' endurance lifetime.
2086 The maximum expected bad eraseblocks per 1024 eraseblocks
2087 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2088 which gives 20 for most NANDs (MaxNVB is basically the total
2089 count of eraseblocks on the chip).
2090
2091 To put it differently, if this value is 20, UBI will try to
2092 reserve about 1.9% of physical eraseblocks for bad blocks
2093 handling. And that will be 1.9% of eraseblocks on the entire
2094 NAND chip, not just the MTD partition UBI attaches. This means
2095 that if you have, say, a NAND flash chip admits maximum 40 bad
2096 eraseblocks, and it is split on two MTD partitions of the same
2097 size, UBI will reserve 40 eraseblocks when attaching a
2098 partition.
2099
2100 default: 20
2101
2102 CONFIG_MTD_UBI_FASTMAP
2103 Fastmap is a mechanism which allows attaching an UBI device
2104 in nearly constant time. Instead of scanning the whole MTD device it
2105 only has to locate a checkpoint (called fastmap) on the device.
2106 The on-flash fastmap contains all information needed to attach
2107 the device. Using fastmap makes only sense on large devices where
2108 attaching by scanning takes long. UBI will not automatically install
2109 a fastmap on old images, but you can set the UBI parameter
2110 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2111 that fastmap-enabled images are still usable with UBI implementations
2112 without fastmap support. On typical flash devices the whole fastmap
2113 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2114
2115 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2116 Set this parameter to enable fastmap automatically on images
2117 without a fastmap.
2118 default: 0
2119
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002120 CONFIG_MTD_UBI_FM_DEBUG
2121 Enable UBI fastmap debug
2122 default: 0
2123
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002124- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002125 CONFIG_SPL
2126 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002127
Tom Rini95579792012-02-14 07:29:40 +00002128 CONFIG_SPL_LDSCRIPT
2129 LDSCRIPT for linking the SPL binary.
2130
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002131 CONFIG_SPL_MAX_FOOTPRINT
2132 Maximum size in memory allocated to the SPL, BSS included.
2133 When defined, the linker checks that the actual memory
2134 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002135 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002136 must not be both defined at the same time.
2137
Tom Rini95579792012-02-14 07:29:40 +00002138 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002139 Maximum size of the SPL image (text, data, rodata, and
2140 linker lists sections), BSS excluded.
2141 When defined, the linker checks that the actual size does
2142 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002143
Scott Wood94a45bb2012-09-20 19:05:12 -05002144 CONFIG_SPL_RELOC_TEXT_BASE
2145 Address to relocate to. If unspecified, this is equal to
2146 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2147
Tom Rini95579792012-02-14 07:29:40 +00002148 CONFIG_SPL_BSS_START_ADDR
2149 Link address for the BSS within the SPL binary.
2150
2151 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002152 Maximum size in memory allocated to the SPL BSS.
2153 When defined, the linker checks that the actual memory used
2154 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002155 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002156 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002157
2158 CONFIG_SPL_STACK
2159 Adress of the start of the stack SPL will use
2160
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002161 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2162 When defined, SPL will panic() if the image it has
2163 loaded does not have a signature.
2164 Defining this is useful when code which loads images
2165 in SPL cannot guarantee that absolutely all read errors
2166 will be caught.
2167 An example is the LPC32XX MLC NAND driver, which will
2168 consider that a completely unreadable NAND block is bad,
2169 and thus should be skipped silently.
2170
Scott Wood94a45bb2012-09-20 19:05:12 -05002171 CONFIG_SPL_RELOC_STACK
2172 Adress of the start of the stack SPL will use after
2173 relocation. If unspecified, this is equal to
2174 CONFIG_SPL_STACK.
2175
Tom Rini95579792012-02-14 07:29:40 +00002176 CONFIG_SYS_SPL_MALLOC_START
2177 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002178 When this option is set the full malloc is used in SPL and
2179 it is set up by spl_init() and before that, the simple malloc()
2180 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002181
2182 CONFIG_SYS_SPL_MALLOC_SIZE
2183 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002184
Tom Rini9607faf2014-03-28 12:03:39 -04002185 CONFIG_SPL_OS_BOOT
2186 Enable booting directly to an OS from SPL.
2187 See also: doc/README.falcon
2188
Tom Rini861a86f2012-08-13 11:37:56 -07002189 CONFIG_SPL_DISPLAY_PRINT
2190 For ARM, enable an optional function to print more information
2191 about the running system.
2192
Scott Wood4b919722012-09-20 16:35:21 -05002193 CONFIG_SPL_INIT_MINIMAL
2194 Arch init code should be built for a very small image
2195
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002196 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2197 Partition on the MMC to load U-Boot from when the MMC is being
2198 used in raw mode
2199
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002200 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2201 Sector to load kernel uImage from when MMC is being
2202 used in raw mode (for Falcon mode)
2203
2204 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2205 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2206 Sector and number of sectors to load kernel argument
2207 parameters from when MMC is being used in raw mode
2208 (for falcon mode)
2209
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002210 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2211 Filename to read to load U-Boot when reading from filesystem
2212
2213 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002214 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002215 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002216
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002217 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002218 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002219 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002220
Scott Wood06f60ae2012-12-06 13:33:17 +00002221 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2222 Set this for NAND SPL on PPC mpc83xx targets, so that
2223 start.S waits for the rest of the SPL to load before
2224 continuing (the hardware starts execution after just
2225 loading the first page rather than the full 4K).
2226
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302227 CONFIG_SPL_SKIP_RELOCATE
2228 Avoid SPL relocation
2229
Jörg Krause15e207f2018-01-14 19:26:38 +01002230 CONFIG_SPL_NAND_IDENT
2231 SPL uses the chip ID list to identify the NAND flash.
2232 Requires CONFIG_SPL_NAND_BASE.
2233
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002234 CONFIG_SPL_UBI
2235 Support for a lightweight UBI (fastmap) scanner and
2236 loader
2237
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002238 CONFIG_SPL_NAND_RAW_ONLY
2239 Support to boot only raw u-boot.bin images. Use this only
2240 if you need to save space.
2241
Ying Zhang7c8eea52013-08-16 15:16:12 +08002242 CONFIG_SPL_COMMON_INIT_DDR
2243 Set for common ddr init with serial presence detect in
2244 SPL binary.
2245
Tom Rini95579792012-02-14 07:29:40 +00002246 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2247 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2248 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2249 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2250 CONFIG_SYS_NAND_ECCBYTES
2251 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002252 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002253
2254 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002255 Location in NAND to read U-Boot from
2256
2257 CONFIG_SYS_NAND_U_BOOT_DST
2258 Location in memory to load U-Boot to
2259
2260 CONFIG_SYS_NAND_U_BOOT_SIZE
2261 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002262
2263 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002264 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002265
2266 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2267 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002268 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002269
Pavel Machekc57b9532012-08-30 22:42:11 +02002270 CONFIG_SPL_RAM_DEVICE
2271 Support for running image already present in ram, in SPL binary
2272
Scott Wood74752ba2012-12-06 13:33:16 +00002273 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002274 Image offset to which the SPL should be padded before appending
2275 the SPL payload. By default, this is defined as
2276 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2277 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2278 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002279
Scott Woodca2fca22012-09-21 16:27:32 -05002280 CONFIG_SPL_TARGET
2281 Final target image containing SPL and payload. Some SPLs
2282 use an arch-specific makefile fragment instead, for
2283 example if more than one image needs to be produced.
2284
Marek Vasutb527b9c2018-05-13 00:22:52 +02002285 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00002286 Printing information about a FIT image adds quite a bit of
2287 code to SPL. So this is normally disabled in SPL. Use this
2288 option to re-enable it. This will affect the output of the
2289 bootm command when booting a FIT image.
2290
Ying Zhang3aa29de2013-08-16 15:16:15 +08002291- TPL framework
2292 CONFIG_TPL
2293 Enable building of TPL globally.
2294
2295 CONFIG_TPL_PAD_TO
2296 Image offset to which the TPL should be padded before appending
2297 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002298 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2299 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2300 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002301
wdenka8c7c702003-12-06 19:49:23 +00002302- Interrupt support (PPC):
2303
wdenkd4ca31c2004-01-02 14:00:00 +00002304 There are common interrupt_init() and timer_interrupt()
2305 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002306 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002307 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002308 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002309 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002310 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002311 specific handling. If board has watchdog / status_led
2312 / other_activity_monitor it works automatically from
2313 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002314
wdenkc6097192002-11-03 00:24:07 +00002315
Helmut Raiger9660e442011-10-20 04:19:47 +00002316Board initialization settings:
2317------------------------------
2318
2319During Initialization u-boot calls a number of board specific functions
2320to allow the preparation of board specific prerequisites, e.g. pin setup
2321before drivers are initialized. To enable these callbacks the
2322following configuration macros have to be defined. Currently this is
2323architecture specific, so please check arch/your_architecture/lib/board.c
2324typically in board_init_f() and board_init_r().
2325
2326- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2327- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2328- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2329- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002330
wdenkc6097192002-11-03 00:24:07 +00002331Configuration Settings:
2332-----------------------
2333
Simon Glass4d979bf2019-12-28 10:45:10 -07002334- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun4d1fd7f2014-02-26 17:03:19 -08002335 Optionally it can be defined to support 64-bit memory commands.
2336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002338 undefine this when you're short of memory.
2339
Peter Tyser2fb26042009-01-27 18:03:12 -06002340- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2341 width of the commands listed in the 'help' command output.
2342
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002343- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002344 prompt for user input.
2345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002346- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002347
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002348- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002350- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002352- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002353 the application (usually a Linux kernel) when it is
2354 booted
2355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002356- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002357 List of legal baudrate settings for this board.
2358
York Sune8149522015-12-04 11:57:07 -08002359- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002360 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002361 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2362 is substracted from total RAM and won't be reported to OS.
2363 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07002364 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08002365 the RAM base is not zero, or RAM is divided into banks,
2366 this variable needs to be recalcuated to get the address.
2367
York Sunaabd7dd2015-12-07 11:05:29 -08002368- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002369 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002370 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002371 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002372 fixing up gd->ram_size the Linux kernel should gets passed
2373 the now "corrected" memory size and won't touch it either.
2374 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002375 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002376 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002377 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002378
2379 This option can be used as a workaround for the 440EPx/GRx
2380 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2381 be touched.
2382
2383 WARNING: Please make sure that this value is a multiple of
2384 the Linux page size (normally 4k). If this is not the case,
2385 then the end address of the Linux memory will be located at a
2386 non page size aligned address and this could cause major
2387 problems.
2388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002389- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002390 Enable temporary baudrate change while serial download
2391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002393 Physical start address of SDRAM. _Must_ be 0 here.
2394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002395- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002396 Physical start address of Flash memory.
2397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002398- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002399 Physical start address of boot monitor code (set by
2400 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002401 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002402 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002405 Size of memory reserved for monitor code, used to
2406 determine _at_compile_time_ (!) if the environment is
2407 embedded within the U-Boot image, or in a separate
2408 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002410- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002411 Size of DRAM reserved for malloc() use.
2412
Simon Glassd59476b2014-07-10 22:23:28 -06002413- CONFIG_SYS_MALLOC_F_LEN
2414 Size of the malloc() pool for use before relocation. If
2415 this is defined, then a very simple malloc() implementation
2416 will become available before relocation. The address is just
2417 below the global data, and the stack is moved down to make
2418 space.
2419
2420 This feature allocates regions with increasing addresses
2421 within the region. calloc() is supported, but realloc()
2422 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002423 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06002424 U-Boot relocates itself.
2425
Simon Glass38687ae2014-11-10 17:16:54 -07002426- CONFIG_SYS_MALLOC_SIMPLE
2427 Provides a simple and small malloc() and calloc() for those
2428 boards which do not use the full malloc in SPL (which is
2429 enabled with CONFIG_SYS_SPL_MALLOC_START).
2430
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07002431- CONFIG_SYS_NONCACHED_MEMORY:
2432 Size of non-cached memory area. This area of memory will be
2433 typically located right below the malloc() area and mapped
2434 uncached in the MMU. This is useful for drivers that would
2435 otherwise require a lot of explicit cache maintenance. For
2436 some drivers it's also impossible to properly maintain the
2437 cache. For example if the regions that need to be flushed
2438 are not a multiple of the cache-line size, *and* padding
2439 cannot be allocated between the regions to align them (i.e.
2440 if the HW requires a contiguous array of regions, and the
2441 size of each region is not cache-aligned), then a flush of
2442 one region may result in overwriting data that hardware has
2443 written to another region in the same cache-line. This can
2444 happen for example in network drivers where descriptors for
2445 buffers are typically smaller than the CPU cache-line (e.g.
2446 16 bytes vs. 32 or 64 bytes).
2447
2448 Non-cached memory is only supported on 32-bit ARM at present.
2449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002450- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002451 Normally compressed uImages are limited to an
2452 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002453 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002454 to adjust this setting to your needs.
2455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002456- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002457 Maximum size of memory mapped by the startup code of
2458 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002459 the Linux kernel (bd_info, boot arguments, FDT blob if
2460 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002461 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002462 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002463 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002464 variable "bootm_mapsize" will override the value of
2465 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2466 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002467
John Rigbyfca43cc2010-10-13 13:57:35 -06002468- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2469 Enable initrd_high functionality. If defined then the
2470 initrd_high feature is enabled and the bootm ramdisk subcommand
2471 is enabled.
2472
2473- CONFIG_SYS_BOOT_GET_CMDLINE:
2474 Enables allocating and saving kernel cmdline in space between
2475 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2476
2477- CONFIG_SYS_BOOT_GET_KBD:
2478 Enables allocating and saving a kernel copy of the bd_info in
2479 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002482 Max number of Flash memory banks
2483
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002484- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002485 Max number of sectors on a Flash chip
2486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002488 Timeout for Flash erase operations (in ms)
2489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002491 Timeout for Flash write operations (in ms)
2492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002493- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002494 Timeout for Flash set sector lock bit operation (in ms)
2495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002496- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002497 Timeout for Flash clear lock bits operation (in ms)
2498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002500 If defined, hardware flash sectors protection is used
2501 instead of U-Boot software protection.
2502
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002503- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002504
2505 Enable TFTP transfers directly to flash memory;
2506 without this option such a download has to be
2507 performed in two steps: (1) download to RAM, and (2)
2508 copy from RAM to flash.
2509
2510 The two-step approach is usually more reliable, since
2511 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002512 the flash, but in some situations (when system RAM is
2513 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002514 downloaded image) this option may be very useful.
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002517 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002518 common flash structure for storing flash geometry.
2519
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002520- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002521 This option also enables the building of the cfi_flash driver
2522 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002523
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002524- CONFIG_FLASH_CFI_MTD
2525 This option enables the building of the cfi_mtd driver
2526 in the drivers directory. The driver exports CFI flash
2527 to the MTD layer.
2528
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002529- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002530 Use buffered writes to flash.
2531
2532- CONFIG_FLASH_SPANSION_S29WS_N
2533 s29ws-n MirrorBit flash has non-standard addresses for buffered
2534 write commands.
2535
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002536- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002537 If this option is defined, the common CFI flash doesn't
2538 print it's warning upon not recognized FLASH banks. This
2539 is useful, if some of the configured banks are only
2540 optionally available.
2541
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002542- CONFIG_FLASH_SHOW_PROGRESS
2543 If defined (must be an integer), print out countdown
2544 digits and dots. Recommended value: 45 (9..1) for 80
2545 column displays, 15 (3..1) for 40 column displays.
2546
Stefan Roese352ef3f2013-04-04 15:53:14 +02002547- CONFIG_FLASH_VERIFY
2548 If defined, the content of the flash (destination) is compared
2549 against the source after the write operation. An error message
2550 will be printed when the contents are not identical.
2551 Please note that this option is useless in nearly all cases,
2552 since such flash programming errors usually are detected earlier
2553 while unprotecting/erasing/programming. Please only enable
2554 this option if you really know what you are doing.
2555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002557 Defines the number of Ethernet receive buffers. On some
2558 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002559 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2560 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002561 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002562 Defaults to 4 if not defined.
2563
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002564- CONFIG_ENV_MAX_ENTRIES
2565
Wolfgang Denk071bc922010-10-27 22:48:30 +02002566 Maximum number of entries in the hash table that is used
2567 internally to store the environment settings. The default
2568 setting is supposed to be generous and should work in most
2569 cases. This setting can be used to tune behaviour; see
2570 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002571
Joe Hershberger25980902012-12-11 22:16:31 -06002572- CONFIG_ENV_FLAGS_LIST_DEFAULT
2573- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002574 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06002575 calling env set. Variables can be restricted to only decimal,
2576 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2577 the variables can also be restricted to IP address or MAC address.
2578
2579 The format of the list is:
2580 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002581 access_attribute = [a|r|o|c]
2582 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06002583 entry = variable_name[:attributes]
2584 list = entry[,list]
2585
2586 The type attributes are:
2587 s - String (default)
2588 d - Decimal
2589 x - Hexadecimal
2590 b - Boolean ([1yYtT|0nNfF])
2591 i - IP address
2592 m - MAC address
2593
Joe Hershberger267541f2012-12-11 22:16:34 -06002594 The access attributes are:
2595 a - Any (default)
2596 r - Read-only
2597 o - Write-once
2598 c - Change-default
2599
Joe Hershberger25980902012-12-11 22:16:31 -06002600 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2601 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002602 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06002603
2604 - CONFIG_ENV_FLAGS_LIST_STATIC
2605 Define this to a list (string) to define validation that
2606 should be done if an entry is not found in the ".flags"
2607 environment variable. To override a setting in the static
2608 list, simply add an entry for the same variable name to the
2609 ".flags" variable.
2610
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05002611 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2612 regular expression. This allows multiple variables to define the same
2613 flags without explicitly listing them for each variable.
2614
wdenkc6097192002-11-03 00:24:07 +00002615The following definitions that deal with the placement and management
2616of environment data (variable area); in general, we support the
2617following configurations:
2618
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002619- CONFIG_BUILD_ENVCRC:
2620
2621 Builds up envcrc with the target environment so that external utils
2622 may easily extract it and embed it in final U-Boot images.
2623
wdenkc6097192002-11-03 00:24:07 +00002624BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002625in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002626console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002627U-Boot will hang.
2628
2629Please note that even with NVRAM we still use a copy of the
2630environment in RAM: we could work on NVRAM directly, but we want to
2631keep settings there always unmodified except somebody uses "saveenv"
2632to save the current settings.
2633
Liu Gang0a85a9e2012-03-08 00:33:20 +00002634BE CAREFUL! For some special cases, the local device can not use
2635"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00002636environment stored in a remote NOR flash by SRIO or PCIE link,
2637but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00002638
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002639- CONFIG_NAND_ENV_DST
2640
2641 Defines address in RAM to which the nand_spl code should copy the
2642 environment. If redundant environment is used, it will be copied to
2643 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2644
Bruce Adlere881cb52007-11-02 13:15:42 -07002645Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002646has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06002647created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002648until then to read environment variables.
2649
wdenk85ec0bc2003-03-31 16:34:49 +00002650The environment is protected by a CRC32 checksum. Before the monitor
2651is relocated into RAM, as a result of a bad CRC you will be working
2652with the compiled-in default environment - *silently*!!! [This is
2653necessary, because the first environment variable we need is the
2654"baudrate" setting for the console - if we have a bad CRC, we don't
2655have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002656
2657Note: once the monitor has been relocated, then it will complain if
2658the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002659use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002661- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002662 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002663
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002664 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002665 also needs to be defined.
2666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002667- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002668 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002669
Ron Madridf5675aa2009-02-18 14:30:44 -08002670- CONFIG_NS16550_MIN_FUNCTIONS:
2671 Define this if you desire to only have use of the NS16550_init
2672 and NS16550_putc functions for the serial driver located at
2673 drivers/serial/ns16550.c. This option is useful for saving
2674 space for already greatly restricted images, including but not
2675 limited to NAND_SPL configurations.
2676
Simon Glassb2b92f52012-11-30 13:01:18 +00002677- CONFIG_DISPLAY_BOARDINFO
2678 Display information about the board that U-Boot is running on
2679 when U-Boot starts up. The board function checkboard() is called
2680 to do this.
2681
Simon Glasse2e3e2b2012-11-30 13:01:19 +00002682- CONFIG_DISPLAY_BOARDINFO_LATE
2683 Similar to the previous option, but display this information
2684 later, once stdio is running and output goes to the LCD, if
2685 present.
2686
Sascha Silbefeb85802013-08-11 16:40:43 +02002687- CONFIG_BOARD_SIZE_LIMIT:
2688 Maximum size of the U-Boot image. When defined, the
2689 build system checks that the actual size does not
2690 exceed it.
2691
wdenkc6097192002-11-03 00:24:07 +00002692Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002693---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002695- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002696 Cache Line Size of the CPU.
2697
Timur Tabie46fedf2011-08-04 18:03:41 -05002698- CONFIG_SYS_CCSRBAR_DEFAULT:
2699 Default (power-on reset) physical address of CCSR on Freescale
2700 PowerPC SOCs.
2701
2702- CONFIG_SYS_CCSRBAR:
2703 Virtual address of CCSR. On a 32-bit build, this is typically
2704 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2705
Timur Tabie46fedf2011-08-04 18:03:41 -05002706- CONFIG_SYS_CCSRBAR_PHYS:
2707 Physical address of CCSR. CCSR can be relocated to a new
2708 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002709 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05002710 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2711 is typically relocated on 36-bit builds. It is recommended
2712 that this macro be defined via the _HIGH and _LOW macros:
2713
2714 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2715 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2716
2717- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002718 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2719 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002720 used in assembly code, so it must not contain typecasts or
2721 integer size suffixes (e.g. "ULL").
2722
2723- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2724 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2725 used in assembly code, so it must not contain typecasts or
2726 integer size suffixes (e.g. "ULL").
2727
2728- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2729 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2730 forced to a value that ensures that CCSR is not relocated.
2731
Macpaul Lin0abddf82011-04-11 20:45:32 +00002732- CONFIG_IDE_AHB:
2733 Most IDE controllers were designed to be connected with PCI
2734 interface. Only few of them were designed for AHB interface.
2735 When software is doing ATA command and data transfer to
2736 IDE devices through IDE-AHB controller, some additional
2737 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002738 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00002739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002741 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02002742 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002745
wdenk7152b1d2003-09-05 23:19:14 +00002746 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002747 initial data and stack; please note that this must be
2748 writable memory that is working WITHOUT special
2749 initialization, i. e. you CANNOT use normal RAM which
2750 will become available only after programming the
2751 memory controller and running certain initialization
2752 sequences.
2753
2754 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02002755 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002756
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002757- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002758
2759 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002760 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2761 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002762 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002763 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06002764 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2766 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002767
2768 Note:
2769 On the MPC824X (or other systems that use the data
2770 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002771 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002772 point to an otherwise UNUSED address space between
2773 the top of RAM and the start of the PCI space.
2774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002775- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002777- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002778 SDRAM timing
2779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002781 periodic timer for refresh
2782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002783- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2784 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2785 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2786 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002787 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2788
2789- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002790 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2791 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002792 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2793
Andrew Sharp69fd2d32012-08-29 14:16:32 +00002794- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002795 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00002796 Don't do any setup work, presumably because someone or
2797 something has already done it, and we don't need to do it
2798 a second time. Useful for platforms that are pre-booted
2799 by coreboot or similar.
2800
Gabor Juhos842033e2013-05-30 07:06:12 +00002801- CONFIG_PCI_INDIRECT_BRIDGE:
2802 Enable support for indirect PCI bridges.
2803
Kumar Galaa09b9b62010-12-30 12:09:53 -06002804- CONFIG_SYS_SRIO:
2805 Chip has SRIO or not
2806
2807- CONFIG_SRIO1:
2808 Board has SRIO 1 port available
2809
2810- CONFIG_SRIO2:
2811 Board has SRIO 2 port available
2812
Liu Gangc8b28152013-05-07 16:30:46 +08002813- CONFIG_SRIO_PCIE_BOOT_MASTER
2814 Board can support master function for Boot from SRIO and PCIE
2815
Kumar Galaa09b9b62010-12-30 12:09:53 -06002816- CONFIG_SYS_SRIOn_MEM_VIRT:
2817 Virtual Address of SRIO port 'n' memory region
2818
Simon Glass62f9b652019-11-14 12:57:09 -07002819- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Galaa09b9b62010-12-30 12:09:53 -06002820 Physical Address of SRIO port 'n' memory region
2821
2822- CONFIG_SYS_SRIOn_MEM_SIZE:
2823 Size of SRIO port 'n' memory region
2824
Fabio Estevam66bd1842013-04-11 09:35:34 +00002825- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2826 Defined to tell the NAND controller that the NAND chip is using
2827 a 16 bit bus.
2828 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00002829 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02002830 - drivers/mtd/nand/raw/ndfc.c
2831 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04002832
2833- CONFIG_SYS_NDFC_EBC0_CFG
2834 Sets the EBC0_CFG register for the NDFC. If not defined
2835 a default value will be used.
2836
Ben Warrenbb99ad62006-09-07 16:50:54 -04002837- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002838 Get DDR timing information from an I2C EEPROM. Common
2839 with pluggable memory modules such as SODIMMs
2840
Ben Warrenbb99ad62006-09-07 16:50:54 -04002841 SPD_EEPROM_ADDRESS
2842 I2C address of the SPD EEPROM
2843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002845 If SPD EEPROM is on an I2C bus other than the first
2846 one, specify here. Note that the value must resolve
2847 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002848
York Sun1b3e3c42011-06-07 09:42:16 +08002849- CONFIG_SYS_DDR_RAW_TIMING
2850 Get DDR timing information from other than SPD. Common with
2851 soldered DDR chips onboard without SPD. DDR raw timing
2852 parameters are extracted from datasheet and hard-coded into
2853 header files or board specific files.
2854
York Sun6f5e1dc2011-09-16 13:21:35 -07002855- CONFIG_FSL_DDR_INTERACTIVE
2856 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2857
York Sune32d59a2015-01-06 13:18:55 -08002858- CONFIG_FSL_DDR_SYNC_REFRESH
2859 Enable sync of refresh for multiple controllers.
2860
York Sun4516ff82015-03-19 09:30:28 -07002861- CONFIG_FSL_DDR_BIST
2862 Enable built-in memory test for Freescale DDR controllers.
2863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002864- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002865 Only for 83xx systems. If specified, then DDR should
2866 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002867
wdenkc26e4542004-04-18 10:13:26 +00002868- CONFIG_RMII
2869 Enable RMII mode for all FECs.
2870 Note that this is a global option, we can't
2871 have one FEC in standard MII mode and another in RMII mode.
2872
wdenk5cf91d62004-04-23 20:32:05 +00002873- CONFIG_CRC32_VERIFY
2874 Add a verify option to the crc32 command.
2875 The syntax is:
2876
2877 => crc32 -v <address> <count> <crc32>
2878
2879 Where address/count indicate a memory area
2880 and crc32 is the correct crc32 which the
2881 area should have.
2882
wdenk56523f12004-07-11 17:40:54 +00002883- CONFIG_LOOPW
2884 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06002885 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00002886
Joel Johnson72732312020-01-29 09:17:18 -07002887- CONFIG_CMD_MX_CYCLIC
stroese7b466642004-12-16 18:46:55 +00002888 Add the "mdc" and "mwc" memory commands. These are cyclic
2889 "md/mw" commands.
2890 Examples:
2891
wdenkefe2a4d2004-12-16 21:44:03 +00002892 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002893 This command will print 4 bytes (10,11,12,13) each 500 ms.
2894
wdenkefe2a4d2004-12-16 21:44:03 +00002895 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002896 This command will write 12345678 to address 100 all 10 ms.
2897
wdenkefe2a4d2004-12-16 21:44:03 +00002898 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06002899 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00002900
wdenk8aa1a2d2005-04-04 12:44:11 +00002901- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chen3fafced2017-12-26 13:55:59 +08002902 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002903 low level initializations (like setting up the memory
2904 controller) are omitted and/or U-Boot does not
2905 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002906
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002907 Normally this variable MUST NOT be defined. The only
2908 exception is when U-Boot is loaded (to RAM) by some
2909 other boot loader or by a debugger which performs
2910 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002911
Simon Glassb5bd0982016-05-05 07:28:06 -06002912- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
2913 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09002914 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06002915 instruction cache) is still performed.
2916
Aneesh V401bb302011-07-13 05:11:07 +00002917- CONFIG_SPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002918 Set when the currently-running compilation is for an artifact
2919 that will end up in the SPL (as opposed to the TPL or U-Boot
2920 proper). Code that needs stage-specific behavior should check
2921 this.
wdenk400558b2005-04-02 23:52:25 +00002922
Ying Zhang3aa29de2013-08-16 15:16:15 +08002923- CONFIG_TPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002924 Set when the currently-running compilation is for an artifact
2925 that will end up in the TPL (as opposed to the SPL or U-Boot
2926 proper). Code that needs stage-specific behavior should check
2927 this.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002928
Ying Zhang5df572f2013-05-20 14:07:23 +08002929- CONFIG_SYS_MPC85XX_NO_RESETVEC
2930 Only for 85xx systems. If this variable is specified, the section
2931 .resetvec is not kept and the section .bootpg is placed in the
2932 previous 4k of the .text section.
2933
Simon Glass4213fc22013-02-24 17:33:14 +00002934- CONFIG_ARCH_MAP_SYSMEM
2935 Generally U-Boot (and in particular the md command) uses
2936 effective address. It is therefore not necessary to regard
2937 U-Boot address as virtual addresses that need to be translated
2938 to physical addresses. However, sandbox requires this, since
2939 it maintains its own little RAM buffer which contains all
2940 addressable memory. This option causes some memory accesses
2941 to be mapped through map_sysmem() / unmap_sysmem().
2942
Simon Glass588a13f2013-02-14 04:18:54 +00002943- CONFIG_X86_RESET_VECTOR
2944 If defined, the x86 reset vector code is included. This is not
2945 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00002946
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002947- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2948 Option to disable subpage write in NAND driver
2949 driver that uses this:
Miquel Raynala430fa02018-08-16 17:30:07 +02002950 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002951
Timur Tabif2717b42011-11-22 09:21:25 -06002952Freescale QE/FMAN Firmware Support:
2953-----------------------------------
2954
2955The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2956loading of "firmware", which is encoded in the QE firmware binary format.
2957This firmware often needs to be loaded during U-Boot booting, so macros
2958are used to identify the storage device (NOR flash, SPI, etc) and the address
2959within that device.
2960
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002961- CONFIG_SYS_FMAN_FW_ADDR
2962 The address in the storage device where the FMAN microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002963 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002964 is also specified.
2965
2966- CONFIG_SYS_QE_FW_ADDR
2967 The address in the storage device where the QE microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002968 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabif2717b42011-11-22 09:21:25 -06002969 is also specified.
2970
2971- CONFIG_SYS_QE_FMAN_FW_LENGTH
2972 The maximum possible size of the firmware. The firmware binary format
2973 has a field that specifies the actual size of the firmware, but it
2974 might not be possible to read any part of the firmware unless some
2975 local storage is allocated to hold the entire firmware first.
2976
2977- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2978 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2979 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2980 virtual address in NOR flash.
2981
2982- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2983 Specifies that QE/FMAN firmware is located in NAND flash.
2984 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2985
2986- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2987 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2988 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2989
Liu Gang292dc6c2012-03-08 00:33:18 +00002990- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2991 Specifies that QE/FMAN firmware is located in the remote (master)
2992 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00002993 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2994 window->master inbound window->master LAW->the ucode address in
2995 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06002996
J. German Riverab940ca62014-06-23 15:15:55 -07002997Freescale Layerscape Management Complex Firmware Support:
2998---------------------------------------------------------
2999The Freescale Layerscape Management Complex (MC) supports the loading of
3000"firmware".
3001This firmware often needs to be loaded during U-Boot booting, so macros
3002are used to identify the storage device (NOR flash, SPI, etc) and the address
3003within that device.
3004
3005- CONFIG_FSL_MC_ENET
3006 Enable the MC driver for Layerscape SoCs.
3007
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303008Freescale Layerscape Debug Server Support:
3009-------------------------------------------
3010The Freescale Layerscape Debug Server Support supports the loading of
3011"Debug Server firmware" and triggering SP boot-rom.
3012This firmware often needs to be loaded during U-Boot booting.
3013
York Sunc0492142015-12-07 11:08:58 -08003014- CONFIG_SYS_MC_RSV_MEM_ALIGN
3015 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303016
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003017Reproducible builds
3018-------------------
3019
3020In order to achieve reproducible builds, timestamps used in the U-Boot build
3021process have to be set to a fixed value.
3022
3023This is done using the SOURCE_DATE_EPOCH environment variable.
3024SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3025option for U-Boot or an environment variable in U-Boot.
3026
3027SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3028
wdenkc6097192002-11-03 00:24:07 +00003029Building the Software:
3030======================
3031
Wolfgang Denk218ca722008-03-26 10:40:12 +01003032Building U-Boot has been tested in several native build environments
3033and in many different cross environments. Of course we cannot support
3034all possibly existing versions of cross development tools in all
3035(potentially obsolete) versions. In case of tool chain problems we
3036recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3037which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003038
Wolfgang Denk218ca722008-03-26 10:40:12 +01003039If you are not using a native environment, it is assumed that you
3040have GNU cross compiling tools available in your path. In this case,
3041you must set the environment variable CROSS_COMPILE in your shell.
3042Note that no changes to the Makefile or any other source files are
3043necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003044
Wolfgang Denk218ca722008-03-26 10:40:12 +01003045 $ CROSS_COMPILE=ppc_4xx-
3046 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003047
Wolfgang Denk218ca722008-03-26 10:40:12 +01003048U-Boot is intended to be simple to build. After installing the
3049sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003050is done by typing:
3051
Holger Freytherab584d62014-08-04 09:26:05 +02003052 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003053
Holger Freytherab584d62014-08-04 09:26:05 +02003054where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01003055rations; see configs/*_defconfig for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003056
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01003057Note: for some boards special configuration names may exist; check if
wdenk2729af92004-05-03 20:45:30 +00003058 additional information is available from the board vendor; for
3059 instance, the TQM823L systems are available without (standard)
3060 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003061 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003062
Holger Freytherab584d62014-08-04 09:26:05 +02003063 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003064 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003065
Holger Freytherab584d62014-08-04 09:26:05 +02003066 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003067 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003068
wdenk2729af92004-05-03 20:45:30 +00003069 etc.
wdenkc6097192002-11-03 00:24:07 +00003070
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072Finally, type "make all", and you should get some working U-Boot
3073images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003074
wdenk2729af92004-05-03 20:45:30 +00003075- "u-boot.bin" is a raw binary image
3076- "u-boot" is an image in ELF binary format
3077- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003078
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003079By default the build is performed locally and the objects are saved
3080in the source directory. One of the two methods can be used to change
3081this behavior and build U-Boot to some external directory:
3082
30831. Add O= to the make command line invocations:
3084
3085 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003086 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003087 make O=/tmp/build all
3088
Timo Ketolaadbba992014-11-06 14:39:05 +020030892. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003090
Timo Ketolaadbba992014-11-06 14:39:05 +02003091 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003092 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003093 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003094 make all
3095
Timo Ketolaadbba992014-11-06 14:39:05 +02003096Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003097variable.
3098
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01003099User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3100setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3101For example to treat all compiler warnings as errors:
3102
3103 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105Please be aware that the Makefiles assume you are using GNU make, so
3106for instance on NetBSD you might need to use "gmake" instead of
3107native "make".
wdenkc6097192002-11-03 00:24:07 +00003108
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk2729af92004-05-03 20:45:30 +00003110If the system board that you have is not listed, then you will need
3111to port U-Boot to your hardware platform. To do this, follow these
3112steps:
wdenkc6097192002-11-03 00:24:07 +00003113
Phil Sutter3c1496c2015-12-25 14:41:18 +010031141. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003115 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003116 the "Makefile" and a "<board>.c".
31172. Create a new configuration file "include/configs/<board>.h" for
3118 your board.
wdenk2729af92004-05-03 20:45:30 +000031193. If you're porting U-Boot to a new CPU, then also create a new
3120 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020031214. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000031225. Type "make", and you should get a working "u-boot.srec" file
3123 to be installed on your target system.
31246. Debug and solve any problems that might arise.
3125 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003126
wdenkc6097192002-11-03 00:24:07 +00003127
wdenk2729af92004-05-03 20:45:30 +00003128Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3129==============================================================
wdenkc6097192002-11-03 00:24:07 +00003130
Wolfgang Denk218ca722008-03-26 10:40:12 +01003131If you have modified U-Boot sources (for instance added a new board
3132or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003133provide feedback to the other developers. The feedback normally takes
Thomas Hebb32f2ca22019-11-13 18:18:03 -08003134the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003135official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003136
Wolfgang Denk218ca722008-03-26 10:40:12 +01003137But before you submit such a patch, please verify that your modifi-
3138cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003139the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003140just run the buildman script (tools/buildman/buildman), which will
3141configure and build U-Boot for ALL supported system. Be warned, this
3142will take a while. Please see the buildman README, or run 'buildman -H'
3143for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003144
3145
wdenk2729af92004-05-03 20:45:30 +00003146See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003147
wdenkc6097192002-11-03 00:24:07 +00003148
wdenk2729af92004-05-03 20:45:30 +00003149Monitor Commands - Overview:
3150============================
wdenkc6097192002-11-03 00:24:07 +00003151
wdenk2729af92004-05-03 20:45:30 +00003152go - start application at address 'addr'
3153run - run commands in an environment variable
3154bootm - boot application image from memory
3155bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003156bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003157tftpboot- boot image via network using TFTP protocol
3158 and env variables "ipaddr" and "serverip"
3159 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003160tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003161rarpboot- boot image via network using RARP/TFTP protocol
3162diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3163loads - load S-Record file over serial line
3164loadb - load binary file over serial line (kermit mode)
3165md - memory display
3166mm - memory modify (auto-incrementing)
3167nm - memory modify (constant address)
3168mw - memory write (fill)
Simon Glassbdded202020-06-02 19:26:49 -06003169ms - memory search
wdenk2729af92004-05-03 20:45:30 +00003170cp - memory copy
3171cmp - memory compare
3172crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003173i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003174sspi - SPI utility commands
3175base - print or set address offset
3176printenv- print environment variables
3177setenv - set environment variables
3178saveenv - save environment variables to persistent storage
3179protect - enable or disable FLASH write protection
3180erase - erase FLASH memory
3181flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003182nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003183bdinfo - print Board Info structure
3184iminfo - print header information for application image
3185coninfo - print console devices and informations
3186ide - IDE sub-system
3187loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003188loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003189mtest - simple RAM test
3190icache - enable or disable instruction cache
3191dcache - enable or disable data cache
3192reset - Perform RESET of the CPU
3193echo - echo args to console
3194version - print monitor version
3195help - print online help
3196? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003197
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk2729af92004-05-03 20:45:30 +00003199Monitor Commands - Detailed Description:
3200========================================
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk2729af92004-05-03 20:45:30 +00003202TODO.
wdenkc6097192002-11-03 00:24:07 +00003203
wdenk2729af92004-05-03 20:45:30 +00003204For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003205
3206
wdenk2729af92004-05-03 20:45:30 +00003207Environment Variables:
3208======================
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210U-Boot supports user configuration using Environment Variables which
3211can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003212
wdenk2729af92004-05-03 20:45:30 +00003213Environment Variables are set using "setenv", printed using
3214"printenv", and saved to Flash using "saveenv". Using "setenv"
3215without a value can be used to delete a variable from the
3216environment. As long as you don't save the environment you are
3217working with an in-memory copy. In case the Flash area containing the
3218environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003219
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003220Some configuration options can be set using Environment Variables.
3221
3222List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003223
wdenk2729af92004-05-03 20:45:30 +00003224 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003225
wdenk2729af92004-05-03 20:45:30 +00003226 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003227
wdenk2729af92004-05-03 20:45:30 +00003228 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003229
wdenk2729af92004-05-03 20:45:30 +00003230 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk2729af92004-05-03 20:45:30 +00003232 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003233
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003234 bootm_low - Memory range available for image processing in the bootm
3235 command can be restricted. This variable is given as
3236 a hexadecimal number and defines lowest address allowed
3237 for use by the bootm command. See also "bootm_size"
3238 environment variable. Address defined by "bootm_low" is
3239 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003240 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3241 bootm_mapsize.
3242
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003243 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003244 This variable is given as a hexadecimal number and it
3245 defines the size of the memory region starting at base
3246 address bootm_low that is accessible by the Linux kernel
3247 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3248 as the default value if it is defined, and bootm_size is
3249 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003250
3251 bootm_size - Memory range available for image processing in the bootm
3252 command can be restricted. This variable is given as
3253 a hexadecimal number and defines the size of the region
3254 allowed for use by the bootm command. See also "bootm_low"
3255 environment variable.
3256
Simon Glass88fa4be2019-07-20 20:51:17 -06003257 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3258
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003259 updatefile - Location of the software update file on a TFTP server, used
3260 by the automatic software update feature. Please refer to
3261 documentation in doc/README.update for more details.
3262
wdenk2729af92004-05-03 20:45:30 +00003263 autoload - if set to "no" (any string beginning with 'n'),
3264 "bootp" will just load perform a lookup of the
3265 configuration from the BOOTP server, but not try to
3266 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268 autostart - if set to "yes", an image loaded using the "bootp",
3269 "rarpboot", "tftpboot" or "diskboot" commands will
3270 be automatically started (by internally calling
3271 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003272
wdenk2729af92004-05-03 20:45:30 +00003273 If set to "no", a standalone image passed to the
3274 "bootm" command will be copied to the load address
3275 (and eventually uncompressed), but NOT be started.
3276 This can be used to load and uncompress arbitrary
3277 data.
wdenkc6097192002-11-03 00:24:07 +00003278
David A. Longa28afca2011-07-09 16:40:19 -04003279 fdt_high - if set this restricts the maximum address that the
3280 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003281 For example, if you have a system with 1 GB memory
3282 at physical address 0x10000000, while Linux kernel
3283 only recognizes the first 704 MB as low memory, you
3284 may need to set fdt_high as 0x3C000000 to have the
3285 device tree blob be copied to the maximum address
3286 of the 704 MB low memory, so that Linux kernel can
3287 access it during the boot procedure.
3288
David A. Longa28afca2011-07-09 16:40:19 -04003289 If this is set to the special value 0xFFFFFFFF then
3290 the fdt will not be copied at all on boot. For this
3291 to work it must reside in writable memory, have
3292 sufficient padding on the end of it for u-boot to
3293 add the information it needs into it, and the memory
3294 must be accessible by the kernel.
3295
Simon Glasseea63e02011-10-24 19:15:34 +00003296 fdtcontroladdr- if set this is the address of the control flattened
3297 device tree used by U-Boot when CONFIG_OF_CONTROL is
3298 defined.
3299
wdenk17ea1172004-06-06 21:51:03 +00003300 i2cfast - (PPC405GP|PPC405EP only)
3301 if set to 'y' configures Linux I2C driver for fast
3302 mode (400kHZ). This environment variable is used in
3303 initialization code. So, for changes to be effective
3304 it must be saved and board must be reset.
3305
wdenk2729af92004-05-03 20:45:30 +00003306 initrd_high - restrict positioning of initrd images:
3307 If this variable is not set, initrd images will be
3308 copied to the highest possible address in RAM; this
3309 is usually what you want since it allows for
3310 maximum initrd size. If for some reason you want to
3311 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003312 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003313 variable to a value of "no" or "off" or "0".
3314 Alternatively, you can set it to a maximum upper
3315 address to use (U-Boot will still check that it
3316 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk2729af92004-05-03 20:45:30 +00003318 For instance, when you have a system with 16 MB
3319 RAM, and want to reserve 4 MB from use by Linux,
3320 you can do this by adding "mem=12M" to the value of
3321 the "bootargs" variable. However, now you must make
3322 sure that the initrd image is placed in the first
3323 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk2729af92004-05-03 20:45:30 +00003325 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk2729af92004-05-03 20:45:30 +00003327 If you set initrd_high to 0xFFFFFFFF, this is an
3328 indication to U-Boot that all addresses are legal
3329 for the Linux kernel, including addresses in flash
3330 memory. In this case U-Boot will NOT COPY the
3331 ramdisk at all. This may be useful to reduce the
3332 boot time on your system, but requires that this
3333 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003336
wdenk2729af92004-05-03 20:45:30 +00003337 loadaddr - Default load address for commands like "bootp",
3338 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk2729af92004-05-03 20:45:30 +00003340 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003341
wdenk2729af92004-05-03 20:45:30 +00003342 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003345
wdenk2729af92004-05-03 20:45:30 +00003346 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003349
Mike Frysingere2a53452011-10-02 10:01:27 +00003350 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003351
Mike Frysingere2a53452011-10-02 10:01:27 +00003352 ethact - controls which interface is currently active.
3353 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003354
Heiko Schocher48690d82010-07-20 17:45:02 +02003355 => setenv ethact FEC
3356 => ping 192.168.0.1 # traffic sent on FEC
3357 => setenv ethact SCC
3358 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003359
Matthias Fuchse1692572008-01-17 07:45:05 +01003360 ethrotate - When set to "no" U-Boot does not go through all
3361 available network interfaces.
3362 It just stays at the currently selected interface.
3363
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003364 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003365 either succeed or fail without retrying.
3366 When set to "once" the network operation will
3367 fail when all the available network interfaces
3368 are tried once without success.
3369 Useful on scripts which control the retry operation
3370 themselves.
wdenkc6097192002-11-03 00:24:07 +00003371
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003372 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003373
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003374 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07003375 changing the console to be empty. If "yes" it will be
3376 made silent. If "no" it will not be made silent. If
3377 unset, then it will be made silent if the U-Boot console
3378 is silent.
3379
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003380 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003381 UDP source port.
3382
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003383 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003384 destination port instead of the Well Know Port 69.
3385
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003386 tftpblocksize - Block size to use for TFTP transfers; if not set,
3387 we use the TFTP server's default block size
3388
3389 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3390 seconds, minimum value is 1000 = 1 second). Defines
3391 when a packet is considered to be lost so it has to
3392 be retransmitted. The default is 5000 = 5 seconds.
3393 Lowering this value may make downloads succeed
3394 faster in networks with high packet loss rates or
3395 with unreliable TFTP servers.
3396
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003397 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3398 unit, minimum value = 0). Defines how many timeouts
3399 can happen during a single file transfer before that
3400 transfer is aborted. The default is 10, and 0 means
3401 'no timeouts allowed'. Increasing this value may help
3402 downloads succeed with high packet loss rates, or with
3403 unreliable TFTP servers or client hardware.
3404
Ramon Friedcc6b87e2020-07-18 23:31:46 +03003405 tftpwindowsize - if this is set, the value is used for TFTP's
3406 window size as described by RFC 7440.
3407 This means the count of blocks we can receive before
3408 sending ack to server.
3409
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003410 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003411 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003412 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003413
Alexandre Messier50768f52016-02-01 17:08:57 -05003414 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3415 Unsigned value, in milliseconds. If not set, the period will
3416 be either the default (28000), or a value based on
3417 CONFIG_NET_RETRY_COUNT, if defined. This value has
3418 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3419
Simon Glassbdded202020-06-02 19:26:49 -06003420 memmatches - Number of matches found by the last 'ms' command, in hex
3421
3422 memaddr - Address of the last match found by the 'ms' command, in hex,
3423 or 0 if none
3424
3425 mempos - Index position of the last match found by the 'ms' command,
3426 in units of the size (.b, .w, .l) of the search
3427
3428
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003429The following image location variables contain the location of images
3430used in booting. The "Image" column gives the role of the image and is
3431not an environment variable name. The other columns are environment
3432variable names. "File Name" gives the name of the file on a TFTP
3433server, "RAM Address" gives the location in RAM the image will be
3434loaded to, and "Flash Location" gives the image's address in NOR
3435flash or offset in NAND flash.
3436
3437*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03003438boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003439boards use these variables for other purposes.
3440
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003441Image File Name RAM Address Flash Location
3442----- --------- ----------- --------------
3443u-boot u-boot u-boot_addr_r u-boot_addr
3444Linux kernel bootfile kernel_addr_r kernel_addr
3445device tree blob fdtfile fdt_addr_r fdt_addr
3446ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003447
wdenk2729af92004-05-03 20:45:30 +00003448The following environment variables may be used and automatically
3449updated by the network boot commands ("bootp" and "rarpboot"),
3450depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452 bootfile - see above
3453 dnsip - IP address of your Domain Name Server
3454 dnsip2 - IP address of your secondary Domain Name Server
3455 gatewayip - IP address of the Gateway (Router) to use
3456 hostname - Target hostname
3457 ipaddr - see above
3458 netmask - Subnet Mask
3459 rootpath - Pathname of the root filesystem on the NFS server
3460 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003461
wdenka3d991b2004-04-15 21:48:45 +00003462
wdenk2729af92004-05-03 20:45:30 +00003463There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465 serial# - contains hardware identification information such
3466 as type string and/or serial number
3467 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003468
wdenk2729af92004-05-03 20:45:30 +00003469These variables can be set only once (usually during manufacturing of
3470the board). U-Boot refuses to delete or overwrite these variables
3471once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003472
3473
wdenk2729af92004-05-03 20:45:30 +00003474Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003475
wdenk2729af92004-05-03 20:45:30 +00003476 ver - Contains the U-Boot version string as printed
3477 with the "version" command. This variable is
3478 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003479
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481Please note that changes to some configuration parameters may take
3482only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003483
stroesec1551ea2003-04-04 15:53:41 +00003484
Joe Hershberger170ab112012-12-11 22:16:24 -06003485Callback functions for environment variables:
3486---------------------------------------------
3487
3488For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003489when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06003490be associated with arbitrary variables. On creation, overwrite, or
3491deletion, the callback will provide the opportunity for some side
3492effect to happen or for the change to be rejected.
3493
3494The callbacks are named and associated with a function using the
3495U_BOOT_ENV_CALLBACK macro in your board or driver code.
3496
3497These callbacks are associated with variables in one of two ways. The
3498static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3499in the board configuration to a string that defines a list of
3500associations. The list must be in the following format:
3501
3502 entry = variable_name[:callback_name]
3503 list = entry[,list]
3504
3505If the callback name is not specified, then the callback is deleted.
3506Spaces are also allowed anywhere in the list.
3507
3508Callbacks can also be associated by defining the ".callbacks" variable
3509with the same list format above. Any association in ".callbacks" will
3510override any association in the static list. You can define
3511CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003512".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06003513
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003514If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3515regular expression. This allows multiple variables to be connected to
3516the same callback without explicitly listing them all out.
3517
Heinrich Schuchardt1b040472018-07-29 11:08:14 +02003518The signature of the callback functions is:
3519
3520 int callback(const char *name, const char *value, enum env_op op, int flags)
3521
3522* name - changed environment variable
3523* value - new value of the environment variable
3524* op - operation (create, overwrite, or delete)
3525* flags - attributes of the environment variable change, see flags H_* in
3526 include/search.h
3527
3528The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger170ab112012-12-11 22:16:24 -06003529
wdenk2729af92004-05-03 20:45:30 +00003530Command Line Parsing:
3531=====================
stroesec1551ea2003-04-04 15:53:41 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533There are two different command line parsers available with U-Boot:
3534the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536Old, simple command line parser:
3537--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539- supports environment variables (through setenv / saveenv commands)
3540- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003541- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003542- special characters ('$', ';') can be escaped by prefixing with '\',
3543 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003544 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003545- You can also escape text by enclosing in single apostrophes, for example:
3546 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003547
wdenk2729af92004-05-03 20:45:30 +00003548Hush shell:
3549-----------
wdenkf07771c2003-05-28 08:06:31 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551- similar to Bourne shell, with control structures like
3552 if...then...else...fi, for...do...done; while...do...done,
3553 until...do...done, ...
3554- supports environment ("global") variables (through setenv / saveenv
3555 commands) and local shell variables (through standard shell syntax
3556 "name=value"); only environment variables can be used with "run"
3557 command
wdenkf07771c2003-05-28 08:06:31 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559General rules:
3560--------------
wdenkf07771c2003-05-28 08:06:31 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562(1) If a command line (or an environment variable executed by a "run"
3563 command) contains several commands separated by semicolon, and
3564 one of these commands fails, then the remaining commands will be
3565 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003566
wdenk2729af92004-05-03 20:45:30 +00003567(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003568 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003569 command will cause "run" to terminate, i. e. the remaining
3570 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572Note for Redundant Ethernet Interfaces:
3573=======================================
wdenkf07771c2003-05-28 08:06:31 +00003574
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003575Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003576such configurations and is capable of automatic selection of a
3577"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3580MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3581"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003582
wdenk2729af92004-05-03 20:45:30 +00003583If the network interface stores some valid MAC address (for instance
3584in SROM), this is used as default address if there is NO correspon-
3585ding setting in the environment; if the corresponding environment
3586variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003587
wdenk2729af92004-05-03 20:45:30 +00003588o If the SROM has a valid MAC address, and there is no address in the
3589 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591o If there is no valid address in the SROM, and a definition in the
3592 environment exists, then the value from the environment variable is
3593 used.
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk2729af92004-05-03 20:45:30 +00003595o If both the SROM and the environment contain a MAC address, and
3596 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003597
wdenk2729af92004-05-03 20:45:30 +00003598o If both the SROM and the environment contain a MAC address, and the
3599 addresses differ, the value from the environment is used and a
3600 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05003603 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3604 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003605
Ben Warrenecee9322010-04-26 11:11:46 -07003606If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003607will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003608may be skipped by setting the appropriate 'ethmacskip' environment variable.
3609The naming convention is as follows:
3610"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612Image Formats:
3613==============
wdenkc6097192002-11-03 00:24:07 +00003614
Marian Balakowicz3310c542008-03-12 12:13:13 +01003615U-Boot is capable of booting (and performing other auxiliary operations on)
3616images in two formats:
3617
3618New uImage format (FIT)
3619-----------------------
3620
3621Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3622to Flattened Device Tree). It allows the use of images with multiple
3623components (several kernels, ramdisks, etc.), with contents protected by
3624SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3625
3626
3627Old uImage format
3628-----------------
3629
3630Old image format is based on binary files which can be basically anything,
3631preceded by a special header; see the definitions in include/image.h for
3632details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3635 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003636 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3637 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3638 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003639* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003640 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003641 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003642* Compression Type (uncompressed, gzip, bzip2)
3643* Load Address
3644* Entry Point
3645* Image Name
3646* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648The header is marked by a special Magic Number, and both the header
3649and the data portions of the image are secured against corruption by
3650CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003651
wdenkc6097192002-11-03 00:24:07 +00003652
wdenk2729af92004-05-03 20:45:30 +00003653Linux Support:
3654==============
wdenkc6097192002-11-03 00:24:07 +00003655
wdenk2729af92004-05-03 20:45:30 +00003656Although U-Boot should support any OS or standalone application
3657easily, the main focus has always been on Linux during the design of
3658U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk2729af92004-05-03 20:45:30 +00003660U-Boot includes many features that so far have been part of some
3661special "boot loader" code within the Linux kernel. Also, any
3662"initrd" images to be used are no longer part of one big Linux image;
3663instead, kernel and "initrd" are separate images. This implementation
3664serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk2729af92004-05-03 20:45:30 +00003666- the same features can be used for other OS or standalone
3667 applications (for instance: using compressed images to reduce the
3668 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003669
wdenk2729af92004-05-03 20:45:30 +00003670- it becomes much easier to port new Linux kernel versions because
3671 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673- the same Linux kernel image can now be used with different "initrd"
3674 images; of course this also means that different kernel images can
3675 be run with the same "initrd". This makes testing easier (you don't
3676 have to build a new "zImage.initrd" Linux image when you just
3677 change a file in your "initrd"). Also, a field-upgrade of the
3678 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003679
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk2729af92004-05-03 20:45:30 +00003681Linux HOWTO:
3682============
wdenkc6097192002-11-03 00:24:07 +00003683
wdenk2729af92004-05-03 20:45:30 +00003684Porting Linux to U-Boot based systems:
3685---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003686
wdenk2729af92004-05-03 20:45:30 +00003687U-Boot cannot save you from doing all the necessary modifications to
3688configure the Linux device drivers for use with your target hardware
3689(no, we don't intend to provide a full virtual machine interface to
3690Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003691
Stefan Roesea47a12b2010-04-15 16:07:28 +02003692But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694Just make sure your machine specific header file (for instance
3695include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003696Information structure as we define in include/asm-<arch>/u-boot.h,
3697and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003698as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003699
Simon Glass2eb31b12014-06-11 23:29:46 -06003700Note that U-Boot now has a driver model, a unified model for drivers.
3701If you are adding a new driver, plumb it into driver model. If there
3702is no uclass available, you are encouraged to create one. See
3703doc/driver-model.
3704
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706Configuring the Linux kernel:
3707-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003708
wdenk2729af92004-05-03 20:45:30 +00003709No specific requirements for U-Boot. Make sure you have some root
3710device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003711
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713Building a Linux Image:
3714-----------------------
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3717not used. If you use recent kernel source, a new build target
3718"uImage" will exist which automatically builds an image usable by
3719U-Boot. Most older kernels also have support for a "pImage" target,
3720which was introduced for our predecessor project PPCBoot and uses a
3721100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003722
wdenk2729af92004-05-03 20:45:30 +00003723Example:
wdenkc6097192002-11-03 00:24:07 +00003724
Holger Freytherab584d62014-08-04 09:26:05 +02003725 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003726 make oldconfig
3727 make dep
3728 make uImage
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730The "uImage" build target uses a special tool (in 'tools/mkimage') to
3731encapsulate a compressed Linux kernel image with header information,
3732CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003733
wdenk2729af92004-05-03 20:45:30 +00003734* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003737
wdenk2729af92004-05-03 20:45:30 +00003738 ${CROSS_COMPILE}-objcopy -O binary \
3739 -R .note -R .comment \
3740 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk2729af92004-05-03 20:45:30 +00003742* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003745
wdenk2729af92004-05-03 20:45:30 +00003746* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003747
wdenk2729af92004-05-03 20:45:30 +00003748 mkimage -A ppc -O linux -T kernel -C gzip \
3749 -a 0 -e 0 -n "Linux Kernel Image" \
3750 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003751
wdenk24ee89b2002-11-03 17:56:27 +00003752
wdenk2729af92004-05-03 20:45:30 +00003753The "mkimage" tool can also be used to create ramdisk images for use
3754with U-Boot, either separated from the Linux kernel image, or
3755combined into one file. "mkimage" encapsulates the images with a 64
3756byte header containing information about target architecture,
3757operating system, image type, compression method, entry points, time
3758stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760"mkimage" can be called in two ways: to verify existing images and
3761print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763In the first form (with "-l" option) mkimage lists the information
3764contained in the header of an existing U-Boot image; this includes
3765checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003766
wdenk2729af92004-05-03 20:45:30 +00003767 tools/mkimage -l image
3768 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770The second form (with "-d" option) is used to build a U-Boot image
3771from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3774 -n name -d data_file image
3775 -A ==> set architecture to 'arch'
3776 -O ==> set operating system to 'os'
3777 -T ==> set image type to 'type'
3778 -C ==> set compression type 'comp'
3779 -a ==> set load address to 'addr' (hex)
3780 -e ==> set entry point to 'ep' (hex)
3781 -n ==> set image name to 'name'
3782 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003783
wdenk69459792004-05-29 16:53:29 +00003784Right now, all Linux kernels for PowerPC systems use the same load
3785address (0x00000000), but the entry point address depends on the
3786kernel version:
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788- 2.2.x kernels have the entry point at 0x0000000C,
3789- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003790
wdenk2729af92004-05-03 20:45:30 +00003791So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003792
wdenk2729af92004-05-03 20:45:30 +00003793 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3794 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003795 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003796 > examples/uImage.TQM850L
3797 Image Name: 2.4.4 kernel for TQM850L
3798 Created: Wed Jul 19 02:34:59 2000
3799 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3800 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3801 Load Address: 0x00000000
3802 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003805
wdenk2729af92004-05-03 20:45:30 +00003806 -> tools/mkimage -l examples/uImage.TQM850L
3807 Image Name: 2.4.4 kernel for TQM850L
3808 Created: Wed Jul 19 02:34:59 2000
3809 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3810 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3811 Load Address: 0x00000000
3812 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk2729af92004-05-03 20:45:30 +00003814NOTE: for embedded systems where boot time is critical you can trade
3815speed for memory and install an UNCOMPRESSED image instead: this
3816needs more space in Flash, but boots much faster since it does not
3817need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003818
Stefan Roesea47a12b2010-04-15 16:07:28 +02003819 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003820 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3821 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003822 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003823 > examples/uImage.TQM850L-uncompressed
3824 Image Name: 2.4.4 kernel for TQM850L
3825 Created: Wed Jul 19 02:34:59 2000
3826 Image Type: PowerPC Linux Kernel Image (uncompressed)
3827 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3828 Load Address: 0x00000000
3829 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003830
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk2729af92004-05-03 20:45:30 +00003832Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3833when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003834
wdenk2729af92004-05-03 20:45:30 +00003835 -> tools/mkimage -n 'Simple Ramdisk Image' \
3836 > -A ppc -O linux -T ramdisk -C gzip \
3837 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3838 Image Name: Simple Ramdisk Image
3839 Created: Wed Jan 12 14:01:50 2000
3840 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3841 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3842 Load Address: 0x00000000
3843 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003844
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07003845The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3846option performs the converse operation of the mkimage's second form (the "-d"
3847option). Given an image built by mkimage, the dumpimage extracts a "data file"
3848from the image:
3849
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02003850 tools/dumpimage -i image -T type -p position data_file
3851 -i ==> extract from the 'image' a specific 'data_file'
3852 -T ==> set image type to 'type'
3853 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07003854
wdenkdb01a2e2004-04-15 23:14:49 +00003855
wdenk2729af92004-05-03 20:45:30 +00003856Installing a Linux Image:
3857-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859To downloading a U-Boot image over the serial (console) interface,
3860you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003861
wdenk2729af92004-05-03 20:45:30 +00003862 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864The 'objcopy' does not understand the information in the U-Boot
3865image header, so the resulting S-Record file will be relative to
3866address 0x00000000. To load it to a given address, you need to
3867specify the target address as 'offset' parameter with the 'loads'
3868command.
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870Example: install the image to address 0x40100000 (which on the
3871TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk2729af92004-05-03 20:45:30 +00003873 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk2729af92004-05-03 20:45:30 +00003875 .......... done
3876 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003877
wdenk2729af92004-05-03 20:45:30 +00003878 => loads 40100000
3879 ## Ready for S-Record download ...
3880 ~>examples/image.srec
3881 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3882 ...
3883 15989 15990 15991 15992
3884 [file transfer complete]
3885 [connected]
3886 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003887
3888
wdenk2729af92004-05-03 20:45:30 +00003889You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003890this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003891corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895 ## Checking Image at 40100000 ...
3896 Image Name: 2.2.13 for initrd on TQM850L
3897 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3898 Data Size: 335725 Bytes = 327 kB = 0 MB
3899 Load Address: 00000000
3900 Entry Point: 0000000c
3901 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003902
3903
wdenk2729af92004-05-03 20:45:30 +00003904Boot Linux:
3905-----------
wdenkc6097192002-11-03 00:24:07 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907The "bootm" command is used to boot an application that is stored in
3908memory (RAM or Flash). In case of a Linux kernel image, the contents
3909of the "bootargs" environment variable is passed to the kernel as
3910parameters. You can check and modify this variable using the
3911"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003912
3913
wdenk2729af92004-05-03 20:45:30 +00003914 => printenv bootargs
3915 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk2729af92004-05-03 20:45:30 +00003917 => 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 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919 => printenv bootargs
3920 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 +00003921
wdenk2729af92004-05-03 20:45:30 +00003922 => bootm 40020000
3923 ## Booting Linux kernel at 40020000 ...
3924 Image Name: 2.2.13 for NFS on TQM850L
3925 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3926 Data Size: 381681 Bytes = 372 kB = 0 MB
3927 Load Address: 00000000
3928 Entry Point: 0000000c
3929 Verifying Checksum ... OK
3930 Uncompressing Kernel Image ... OK
3931 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
3932 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3933 time_init: decrementer frequency = 187500000/60
3934 Calibrating delay loop... 49.77 BogoMIPS
3935 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3936 ...
wdenkc6097192002-11-03 00:24:07 +00003937
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003938If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003939the memory addresses of both the kernel and the initrd image (PPBCOOT
3940format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk2729af92004-05-03 20:45:30 +00003942 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk2729af92004-05-03 20:45:30 +00003944 ## Checking Image at 40100000 ...
3945 Image Name: 2.2.13 for initrd on TQM850L
3946 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3947 Data Size: 335725 Bytes = 327 kB = 0 MB
3948 Load Address: 00000000
3949 Entry Point: 0000000c
3950 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952 ## Checking Image at 40200000 ...
3953 Image Name: Simple Ramdisk Image
3954 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3955 Data Size: 566530 Bytes = 553 kB = 0 MB
3956 Load Address: 00000000
3957 Entry Point: 00000000
3958 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960 => bootm 40100000 40200000
3961 ## Booting Linux kernel at 40100000 ...
3962 Image Name: 2.2.13 for initrd on TQM850L
3963 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3964 Data Size: 335725 Bytes = 327 kB = 0 MB
3965 Load Address: 00000000
3966 Entry Point: 0000000c
3967 Verifying Checksum ... OK
3968 Uncompressing Kernel Image ... OK
3969 ## Loading RAMDisk Image at 40200000 ...
3970 Image Name: Simple Ramdisk Image
3971 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3972 Data Size: 566530 Bytes = 553 kB = 0 MB
3973 Load Address: 00000000
3974 Entry Point: 00000000
3975 Verifying Checksum ... OK
3976 Loading Ramdisk ... OK
3977 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
3978 Boot arguments: root=/dev/ram
3979 time_init: decrementer frequency = 187500000/60
3980 Calibrating delay loop... 49.77 BogoMIPS
3981 ...
3982 RAMDISK: Compressed image found at block 0
3983 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk2729af92004-05-03 20:45:30 +00003985 bash#
wdenkc6097192002-11-03 00:24:07 +00003986
Matthew McClintock02677682006-06-28 10:41:37 -05003987Boot Linux and pass a flat device tree:
3988-----------
3989
3990First, U-Boot must be compiled with the appropriate defines. See the section
3991titled "Linux Kernel Interface" above for a more in depth explanation. The
3992following is an example of how to start a kernel and pass an updated
3993flat device tree:
3994
3995=> print oftaddr
3996oftaddr=0x300000
3997=> print oft
3998oft=oftrees/mpc8540ads.dtb
3999=> tftp $oftaddr $oft
4000Speed: 1000, full duplex
4001Using TSEC0 device
4002TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4003Filename 'oftrees/mpc8540ads.dtb'.
4004Load address: 0x300000
4005Loading: #
4006done
4007Bytes transferred = 4106 (100a hex)
4008=> tftp $loadaddr $bootfile
4009Speed: 1000, full duplex
4010Using TSEC0 device
4011TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4012Filename 'uImage'.
4013Load address: 0x200000
4014Loading:############
4015done
4016Bytes transferred = 1029407 (fb51f hex)
4017=> print loadaddr
4018loadaddr=200000
4019=> print oftaddr
4020oftaddr=0x300000
4021=> bootm $loadaddr - $oftaddr
4022## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004023 Image Name: Linux-2.6.17-dirty
4024 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4025 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004026 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004027 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004028 Verifying Checksum ... OK
4029 Uncompressing Kernel Image ... OK
4030Booting using flat device tree at 0x300000
4031Using MPC85xx ADS machine description
4032Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4033[snip]
4034
4035
wdenk2729af92004-05-03 20:45:30 +00004036More About U-Boot Image Types:
4037------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041 "Standalone Programs" are directly runnable in the environment
4042 provided by U-Boot; it is expected that (if they behave
4043 well) you can continue to work in U-Boot after return from
4044 the Standalone Program.
4045 "OS Kernel Images" are usually images of some Embedded OS which
4046 will take over control completely. Usually these programs
4047 will install their own set of exception handlers, device
4048 drivers, set up the MMU, etc. - this means, that you cannot
4049 expect to re-enter U-Boot except by resetting the CPU.
4050 "RAMDisk Images" are more or less just data blocks, and their
4051 parameters (address, size) are passed to an OS kernel that is
4052 being started.
4053 "Multi-File Images" contain several images, typically an OS
4054 (Linux) kernel image and one or more data images like
4055 RAMDisks. This construct is useful for instance when you want
4056 to boot over the network using BOOTP etc., where the boot
4057 server provides just a single image file, but you want to get
4058 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004059
wdenk2729af92004-05-03 20:45:30 +00004060 "Multi-File Images" start with a list of image sizes, each
4061 image size (in bytes) specified by an "uint32_t" in network
4062 byte order. This list is terminated by an "(uint32_t)0".
4063 Immediately after the terminating 0 follow the images, one by
4064 one, all aligned on "uint32_t" boundaries (size rounded up to
4065 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067 "Firmware Images" are binary images containing firmware (like
4068 U-Boot or FPGA images) which usually will be programmed to
4069 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 "Script files" are command sequences that will be executed by
4072 U-Boot's command interpreter; this feature is especially
4073 useful when you configure U-Boot to use a real shell (hush)
4074 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004075
Marek Vasut44f074c2012-03-14 21:52:45 +00004076Booting the Linux zImage:
4077-------------------------
4078
4079On some platforms, it's possible to boot Linux zImage. This is done
4080using the "bootz" command. The syntax of "bootz" command is the same
4081as the syntax of "bootm" command.
4082
Tom Rini8ac28562013-05-16 11:40:11 -04004083Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004084kernel with raw initrd images. The syntax is slightly different, the
4085address of the initrd must be augmented by it's size, in the following
4086format: "<initrd addres>:<initrd size>".
4087
wdenkc6097192002-11-03 00:24:07 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089Standalone HOWTO:
4090=================
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk2729af92004-05-03 20:45:30 +00004092One of the features of U-Boot is that you can dynamically load and
4093run "standalone" applications, which can use some resources of
4094U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004097
wdenk2729af92004-05-03 20:45:30 +00004098"Hello World" Demo:
4099-------------------
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk2729af92004-05-03 20:45:30 +00004101'examples/hello_world.c' contains a small "Hello World" Demo
4102application; it is automatically compiled when you build U-Boot.
4103It's configured to run at address 0x00040004, so you can play with it
4104like that:
wdenkc6097192002-11-03 00:24:07 +00004105
wdenk2729af92004-05-03 20:45:30 +00004106 => loads
4107 ## Ready for S-Record download ...
4108 ~>examples/hello_world.srec
4109 1 2 3 4 5 6 7 8 9 10 11 ...
4110 [file transfer complete]
4111 [connected]
4112 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114 => go 40004 Hello World! This is a test.
4115 ## Starting application at 0x00040004 ...
4116 Hello World
4117 argc = 7
4118 argv[0] = "40004"
4119 argv[1] = "Hello"
4120 argv[2] = "World!"
4121 argv[3] = "This"
4122 argv[4] = "is"
4123 argv[5] = "a"
4124 argv[6] = "test."
4125 argv[7] = "<NULL>"
4126 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130Another example, which demonstrates how to register a CPM interrupt
4131handler with the U-Boot code, can be found in 'examples/timer.c'.
4132Here, a CPM timer is set up to generate an interrupt every second.
4133The interrupt service routine is trivial, just printing a '.'
4134character, but this is just a demo program. The application can be
4135controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137 ? - print current values og the CPM Timer registers
4138 b - enable interrupts and start timer
4139 e - stop timer and disable interrupts
4140 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004141
wdenk2729af92004-05-03 20:45:30 +00004142 => loads
4143 ## Ready for S-Record download ...
4144 ~>examples/timer.srec
4145 1 2 3 4 5 6 7 8 9 10 11 ...
4146 [file transfer complete]
4147 [connected]
4148 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150 => go 40004
4151 ## Starting application at 0x00040004 ...
4152 TIMERS=0xfff00980
4153 Using timer 1
4154 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156Hit 'b':
4157 [q, b, e, ?] Set interval 1000000 us
4158 Enabling timer
4159Hit '?':
4160 [q, b, e, ?] ........
4161 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4162Hit '?':
4163 [q, b, e, ?] .
4164 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4165Hit '?':
4166 [q, b, e, ?] .
4167 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4168Hit '?':
4169 [q, b, e, ?] .
4170 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4171Hit 'e':
4172 [q, b, e, ?] ...Stopping timer
4173Hit 'q':
4174 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004175
4176
wdenk2729af92004-05-03 20:45:30 +00004177Minicom warning:
4178================
wdenk85ec0bc2003-03-31 16:34:49 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180Over time, many people have reported problems when trying to use the
4181"minicom" terminal emulation program for serial download. I (wd)
4182consider minicom to be broken, and recommend not to use it. Under
4183Unix, I recommend to use C-Kermit for general purpose use (and
4184especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004185use "cu" for S-Record download ("loads" command). See
4186http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4187for help with kermit.
4188
wdenk85ec0bc2003-03-31 16:34:49 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190Nevertheless, if you absolutely want to use it try adding this
4191configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193 Name Program Name U/D FullScr IO-Red. Multi
4194 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4195 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004196
4197
wdenk2729af92004-05-03 20:45:30 +00004198NetBSD Notes:
4199=============
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201Starting at version 0.9.2, U-Boot supports NetBSD both as host
4202(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk2729af92004-05-03 20:45:30 +00004204Building requires a cross environment; it is known to work on
4205NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4206need gmake since the Makefiles are not compatible with BSD make).
4207Note that the cross-powerpc package does not install include files;
4208attempting to build U-Boot will fail because <machine/ansi.h> is
4209missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk2729af92004-05-03 20:45:30 +00004211 # cd /usr/pkg/cross/powerpc-netbsd/include
4212 # mkdir powerpc
4213 # ln -s powerpc machine
4214 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4215 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217Native builds *don't* work due to incompatibilities between native
4218and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004219
wdenk2729af92004-05-03 20:45:30 +00004220Booting assumes that (the first part of) the image booted is a
4221stage-2 loader which in turn loads and then invokes the kernel
4222proper. Loader sources will eventually appear in the NetBSD source
4223tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004224meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004225
4226
wdenk2729af92004-05-03 20:45:30 +00004227Implementation Internals:
4228=========================
wdenkc6097192002-11-03 00:24:07 +00004229
wdenk2729af92004-05-03 20:45:30 +00004230The following is not intended to be a complete description of every
4231implementation detail. However, it should help to understand the
4232inner workings of U-Boot and make it easier to port it to custom
4233hardware.
wdenkc6097192002-11-03 00:24:07 +00004234
4235
wdenk2729af92004-05-03 20:45:30 +00004236Initial Stack, Global Data:
4237---------------------------
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239The implementation of U-Boot is complicated by the fact that U-Boot
4240starts running out of ROM (flash memory), usually without access to
4241system RAM (because the memory controller is not initialized yet).
4242This means that we don't have writable Data or BSS segments, and BSS
4243is not initialized as zero. To be able to get a C environment working
4244at all, we have to allocate at least a minimal stack. Implementation
4245options for this are defined and restricted by the CPU used: Some CPU
4246models provide on-chip memory (like the IMMR area on MPC8xx and
4247MPC826x processors), on others (parts of) the data cache can be
4248locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004249
Wolfgang Denk218ca722008-03-26 10:40:12 +01004250 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004251 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4254 From: "Chris Hallinan" <clh@net1plus.com>
4255 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4256 ...
wdenk43d96162003-03-06 00:02:04 +00004257
wdenk2729af92004-05-03 20:45:30 +00004258 Correct me if I'm wrong, folks, but the way I understand it
4259 is this: Using DCACHE as initial RAM for Stack, etc, does not
4260 require any physical RAM backing up the cache. The cleverness
4261 is that the cache is being used as a temporary supply of
4262 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004263 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004264 can see how this works by studying the cache architecture and
4265 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4268 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004269 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004270 option should work for you. Using CS 4 should be fine if your
4271 board designers haven't used it for something that would
4272 cause you grief during the initial boot! It is frequently not
4273 used.
wdenk43d96162003-03-06 00:02:04 +00004274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004275 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004276 with your processor/board/system design. The default value
4277 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004278 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004279 than your SDRAM module. If you have a 64MB SDRAM module, set
4280 it above 400_0000. Just make sure your board has no resources
4281 that are supposed to respond to that address! That code in
4282 start.S has been around a while and should work as is when
4283 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004284
wdenk2729af92004-05-03 20:45:30 +00004285 -Chris Hallinan
4286 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004287
wdenk2729af92004-05-03 20:45:30 +00004288It is essential to remember this, since it has some impact on the C
4289code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004290
wdenk2729af92004-05-03 20:45:30 +00004291* Initialized global data (data segment) is read-only. Do not attempt
4292 to write it.
wdenkc6097192002-11-03 00:24:07 +00004293
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004294* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004295 as zero data - BSS segment) at all - this is undefined, initiali-
4296 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298* Stack space is very limited. Avoid big data buffers or things like
4299 that.
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004302normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004303turned out that the implementation of U-Boot can be greatly
4304simplified by making a global data structure (gd_t) available to all
4305functions. We could pass a pointer to this data as argument to _all_
4306functions, but this would bloat the code. Instead we use a feature of
4307the GCC compiler (Global Register Variables) to share the data: we
4308place a pointer (gd) to the global data into a register which we
4309reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311When choosing a register for such a purpose we are restricted by the
4312relevant (E)ABI specifications for the current architecture, and by
4313GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315For PowerPC, the following registers have specific use:
4316 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004317 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004318 R3-R4: parameter passing and return values
4319 R5-R10: parameter passing
4320 R13: small data area pointer
4321 R30: GOT pointer
4322 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004323
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004324 (U-Boot also uses R12 as internal GOT pointer. r12
4325 is a volatile register so r12 needs to be reset when
4326 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004327
Wolfgang Denke7670f62008-02-14 22:43:22 +01004328 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk2729af92004-05-03 20:45:30 +00004330 Note: on PPC, we could use a static initializer (since the
4331 address of the global data structure is known at compile time),
4332 but it turned out that reserving a register results in somewhat
4333 smaller code - although the code savings are not that big (on
4334 average for all boards 752 bytes for the whole U-Boot image,
4335 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339 R0: function argument word/integer result
4340 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004341 R9: platform specific
4342 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004343 R11: argument (frame) pointer
4344 R12: temporary workspace
4345 R13: stack pointer
4346 R14: link register
4347 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004348
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004349 ==> U-Boot will use R9 to hold a pointer to the global data
4350
4351 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004352
Thomas Chou0df01fd2010-05-21 11:08:03 +08004353On Nios II, the ABI is documented here:
4354 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4355
4356 ==> U-Boot will use gp to hold a pointer to the global data
4357
4358 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4359 to access small data sections, so gp is free.
4360
Macpaul Linafc1ce82011-10-19 20:41:11 +00004361On NDS32, the following registers are used:
4362
4363 R0-R1: argument/return
4364 R2-R5: argument
4365 R15: temporary register for assembler
4366 R16: trampoline register
4367 R28: frame pointer (FP)
4368 R29: global pointer (GP)
4369 R30: link register (LP)
4370 R31: stack pointer (SP)
4371 PC: program counter (PC)
4372
4373 ==> U-Boot will use R10 to hold a pointer to the global data
4374
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004375NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4376or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004377
Rick Chen3fafced2017-12-26 13:55:59 +08004378On RISC-V, the following registers are used:
4379
4380 x0: hard-wired zero (zero)
4381 x1: return address (ra)
4382 x2: stack pointer (sp)
4383 x3: global pointer (gp)
4384 x4: thread pointer (tp)
4385 x5: link register (t0)
4386 x8: frame pointer (fp)
4387 x10-x11: arguments/return values (a0-1)
4388 x12-x17: arguments (a2-7)
4389 x28-31: temporaries (t3-6)
4390 pc: program counter (pc)
4391
4392 ==> U-Boot will use gp to hold a pointer to the global data
4393
wdenk2729af92004-05-03 20:45:30 +00004394Memory Management:
4395------------------
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397U-Boot runs in system state and uses physical addresses, i.e. the
4398MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400The available memory is mapped to fixed addresses using the memory
4401controller. In this process, a contiguous block is formed for each
4402memory type (Flash, SDRAM, SRAM), even when it consists of several
4403physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk2729af92004-05-03 20:45:30 +00004405U-Boot is installed in the first 128 kB of the first Flash bank (on
4406TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4407booting and sizing and initializing DRAM, the code relocates itself
4408to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004409memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004410configuration setting]. Below that, a structure with global Board
4411Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk2729af92004-05-03 20:45:30 +00004413Additionally, some exception handler code is copied to the low 8 kB
4414of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004415
wdenk2729af92004-05-03 20:45:30 +00004416So a typical memory configuration with 16 MB of DRAM could look like
4417this:
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419 0x0000 0000 Exception Vector code
4420 :
4421 0x0000 1FFF
4422 0x0000 2000 Free for Application Use
4423 :
4424 :
wdenkc6097192002-11-03 00:24:07 +00004425
wdenk2729af92004-05-03 20:45:30 +00004426 :
4427 :
4428 0x00FB FF20 Monitor Stack (Growing downward)
4429 0x00FB FFAC Board Info Data and permanent copy of global data
4430 0x00FC 0000 Malloc Arena
4431 :
4432 0x00FD FFFF
4433 0x00FE 0000 RAM Copy of Monitor Code
4434 ... eventually: LCD or video framebuffer
4435 ... eventually: pRAM (Protected RAM - unchanged by reset)
4436 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004437
4438
wdenk2729af92004-05-03 20:45:30 +00004439System Initialization:
4440----------------------
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004443(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004444configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00004445To be able to re-map memory U-Boot then jumps to its link address.
4446To be able to implement the initialization code in C, a (small!)
4447initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02004448which provide such a feature like), or in a locked part of the data
4449cache. After that, U-Boot initializes the CPU core, the caches and
4450the SIU.
wdenkc6097192002-11-03 00:24:07 +00004451
wdenk2729af92004-05-03 20:45:30 +00004452Next, all (potentially) available memory banks are mapped using a
4453preliminary mapping. For example, we put them on 512 MB boundaries
4454(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4455on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4456programmed for SDRAM access. Using the temporary configuration, a
4457simple memory test is run that determines the size of the SDRAM
4458banks.
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460When there is more than one SDRAM bank, and the banks are of
4461different size, the largest is mapped first. For equal size, the first
4462bank (CS2#) is mapped first. The first mapping is always for address
44630x00000000, with any additional banks following immediately to create
4464contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk2729af92004-05-03 20:45:30 +00004466Then, the monitor installs itself at the upper end of the SDRAM area
4467and allocates memory for use by malloc() and for the global Board
4468Info data; also, the exception vector code is copied to the low RAM
4469pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk2729af92004-05-03 20:45:30 +00004471Only after this relocation will you have a "normal" C environment;
4472until that you are restricted in several ways, mostly because you are
4473running from ROM, and because the code will have to be relocated to a
4474new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004475
4476
wdenk2729af92004-05-03 20:45:30 +00004477U-Boot Porting Guide:
4478----------------------
wdenkc6097192002-11-03 00:24:07 +00004479
wdenk2729af92004-05-03 20:45:30 +00004480[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4481list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004482
4483
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004484int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004485{
4486 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004487
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004488 signal(SIGALRM, no_more_time);
4489 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004492 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004493 return 0;
4494 }
4495
wdenk2729af92004-05-03 20:45:30 +00004496 Download latest U-Boot source;
4497
Wolfgang Denk06682362008-12-30 22:56:11 +01004498 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004499
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004500 if (clueless)
4501 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk2729af92004-05-03 20:45:30 +00004503 while (learning) {
4504 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004505 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
Patrick Delaunay24bcaec2020-02-28 15:18:10 +01004506 Read applicable doc/README.*;
wdenk2729af92004-05-03 20:45:30 +00004507 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004508 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004509 }
wdenkc6097192002-11-03 00:24:07 +00004510
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004511 if (available_money > toLocalCurrency ($2500))
4512 Buy a BDI3000;
4513 else
wdenk2729af92004-05-03 20:45:30 +00004514 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004515
4516 if (a similar board exists) { /* hopefully... */
4517 cp -a board/<similar> board/<myboard>
4518 cp include/configs/<similar>.h include/configs/<myboard>.h
4519 } else {
4520 Create your own board support subdirectory;
4521 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004522 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004523 Edit new board/<myboard> files
4524 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004525
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004526 while (!accepted) {
4527 while (!running) {
4528 do {
4529 Add / modify source code;
4530 } until (compiles);
4531 Debug;
4532 if (clueless)
4533 email("Hi, I am having problems...");
4534 }
4535 Send patch file to the U-Boot email list;
4536 if (reasonable critiques)
4537 Incorporate improvements from email list code review;
4538 else
4539 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004540 }
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk2729af92004-05-03 20:45:30 +00004542 return 0;
4543}
4544
4545void no_more_time (int sig)
4546{
4547 hire_a_guru();
4548}
wdenkc6097192002-11-03 00:24:07 +00004549
4550
wdenk2729af92004-05-03 20:45:30 +00004551Coding Standards:
4552-----------------
wdenkc6097192002-11-03 00:24:07 +00004553
wdenk2729af92004-05-03 20:45:30 +00004554All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02004555coding style; see the kernel coding style guide at
4556https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4557script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004558
Detlev Zundel2c051652006-09-01 15:39:02 +02004559Source files originating from a different project (for example the
4560MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004561reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02004562sources.
4563
4564Please note that U-Boot is implemented in C (and to some small parts in
4565Assembler); no C++ is used, so please do not use C++ style comments (//)
4566in your code.
wdenk2729af92004-05-03 20:45:30 +00004567
4568Please also stick to the following formatting rules:
4569- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004570- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004571- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004572- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004573- do not add trailing empty lines to source files
4574
4575Submissions which do not conform to the standards may be returned
4576with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004577
4578
wdenk2729af92004-05-03 20:45:30 +00004579Submitting Patches:
4580-------------------
wdenkc6097192002-11-03 00:24:07 +00004581
wdenk2729af92004-05-03 20:45:30 +00004582Since the number of patches for U-Boot is growing, we need to
4583establish some rules. Submissions which do not conform to these rules
4584may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004585
Magnus Lilja0d28f342008-08-06 19:32:33 +02004586Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004587
Wolfgang Denk06682362008-12-30 22:56:11 +01004588Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08004589see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01004590
wdenk2729af92004-05-03 20:45:30 +00004591When you send a patch, please include the following information with
4592it:
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk2729af92004-05-03 20:45:30 +00004594* For bug fixes: a description of the bug and how your patch fixes
4595 this bug. Please try to include a way of demonstrating that the
4596 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598* For new features: a description of the feature and your
4599 implementation.
wdenkc6097192002-11-03 00:24:07 +00004600
Robert P. J. Day7207b362015-12-19 07:16:10 -05004601* For major contributions, add a MAINTAINERS file with your
4602 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00004603
Albert ARIBAUD27af9302013-09-11 15:52:51 +02004604* When you add support for a new board, don't forget to add a
4605 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00004606
4607* If your patch adds new configuration options, don't forget to
4608 document these in the README file.
4609
Wolfgang Denk218ca722008-03-26 10:40:12 +01004610* The patch itself. If you are using git (which is *strongly*
4611 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004612 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004613 the U-Boot mailing list, you will avoid most of the common problems
4614 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004615
Wolfgang Denk218ca722008-03-26 10:40:12 +01004616 If you cannot use git, use "diff -purN OLD NEW". If your version of
4617 diff does not support these options, then get the latest version of
4618 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004619
Wolfgang Denk218ca722008-03-26 10:40:12 +01004620 The current directory when running this command shall be the parent
4621 directory of the U-Boot source tree (i. e. please make sure that
4622 your patch includes sufficient directory information for the
4623 affected files).
4624
4625 We prefer patches as plain text. MIME attachments are discouraged,
4626 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004627
4628* If one logical set of modifications affects or creates several
4629 files, all these changes shall be submitted in a SINGLE patch file.
4630
4631* Changesets that contain different, unrelated modifications shall be
4632 submitted as SEPARATE patches, one patch per changeset.
4633
4634
4635Notes:
4636
Simon Glass6de80f22016-07-27 20:33:08 -06004637* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00004638 source tree and make sure that no errors or warnings are reported
4639 for any of the boards.
4640
4641* Keep your modifications to the necessary minimum: A patch
4642 containing several unrelated changes or arbitrary reformats will be
4643 returned with a request to re-formatting / split it.
4644
4645* If you modify existing code, make sure that your new code does not
4646 add to the memory footprint of the code ;-) Small is beautiful!
4647 When adding new features, these should compile conditionally only
4648 (using #ifdef), and the resulting code with the new feature
4649 disabled must not need more memory than the old code without your
4650 modification.
wdenk90dc6702005-05-03 14:12:25 +00004651
Wolfgang Denk06682362008-12-30 22:56:11 +01004652* Remember that there is a size limit of 100 kB per message on the
4653 u-boot mailing list. Bigger patches will be moderated. If they are
4654 reasonable and not too big, they will be acknowledged. But patches
4655 bigger than the size limit should be avoided.