blob: 727cacf3ae801433a5d18a6998a6151bb25dc732 [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.
Naoki Hayama6681bbb2020-10-08 13:16:18 +090054Please see https://lists.denx.de/pipermail/u-boot and
55https://marc.info/?l=u-boot
wdenkc6097192002-11-03 00:24:07 +000056
Wolfgang Denk218ca722008-03-26 10:40:12 +010057Where to get source code:
58=========================
59
Robert P. J. Day7207b362015-12-19 07:16:10 -050060The U-Boot source code is maintained in the Git repository at
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090061https://gitlab.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://gitlab.denx.de/u-boot/u-boot
Wolfgang Denk218ca722008-03-26 10:40:12 +010063
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090064The "Tags" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020065any version you might be interested in. Official releases are also
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090066available from the DENX file server through HTTPS or FTP.
67https://ftp.denx.de/pub/u-boot/
68ftp://ftp.denx.de/pub/u-boot/
Wolfgang Denk218ca722008-03-26 10:40:12 +010069
70
wdenkc6097192002-11-03 00:24:07 +000071Where we come from:
72===================
73
74- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000075- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000076- clean up code
77- make it easier to add custom boards
78- make it possible to add other [PowerPC] CPUs
79- extend functions, especially:
80 * Provide extended interface to Linux boot loader
81 * S-Record download
82 * network boot
Simon Glass9e5616d2019-08-01 09:47:14 -060083 * ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000084- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000085- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000086- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020087- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000088
89
90Names and Spelling:
91===================
92
93The "official" name of this project is "Das U-Boot". The spelling
94"U-Boot" shall be used in all written text (documentation, comments
95in source files etc.). Example:
96
97 This is the README file for the U-Boot project.
98
99File names etc. shall be based on the string "u-boot". Examples:
100
101 include/asm-ppc/u-boot.h
102
103 #include <asm/u-boot.h>
104
105Variable names, preprocessor constants etc. shall be either based on
106the string "u_boot" or on "U_BOOT". Example:
107
108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000110
111
wdenk93f19cc2002-12-17 17:55:09 +0000112Versioning:
113===========
114
Thomas Weber360d8832010-09-28 08:06:25 +0200115Starting with the release in October 2008, the names of the releases
116were changed from numerical release numbers without deeper meaning
117into a time stamp based numbering. Regular releases are identified by
118names consisting of the calendar year and month of the release date.
119Additional fields (if present) indicate release candidates or bug fix
120releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000121
Thomas Weber360d8832010-09-28 08:06:25 +0200122Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000123 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000126
127
wdenkc6097192002-11-03 00:24:07 +0000128Directory Hierarchy:
129====================
130
Peter Tyser8d321b82010-04-12 22:28:21 -0500131/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900132 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500133 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500134 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500135 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500136 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000137 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400139 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200140 /powerpc Files generic to PowerPC architecture
Rick Chen3fafced2017-12-26 13:55:59 +0800141 /riscv Files generic to RISC-V architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500142 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400144 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/api Machine/arch independent API for external apps
146/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800147/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500148/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500149/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/disk Code for disk drive partition handling
151/doc Documentation (don't expect too much)
152/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400153/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500154/examples Example code for standalone applications, etc.
155/fs Filesystem code (cramfs, ext2, jffs2, etc.)
156/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500157/lib Library routines generic to all architectures
158/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500159/net Networking code
160/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500161/scripts Various build scripts and Makefiles
162/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500163/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000164
wdenkc6097192002-11-03 00:24:07 +0000165Software Configuration:
166=======================
167
168Configuration is usually done using C preprocessor defines; the
169rationale behind that is to avoid dead code whenever possible.
170
171There are two classes of configuration variables:
172
173* Configuration _OPTIONS_:
174 These are selectable by the user and have names beginning with
175 "CONFIG_".
176
177* Configuration _SETTINGS_:
178 These depend on the hardware etc. and should not be meddled with if
179 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200180 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000181
Robert P. J. Day7207b362015-12-19 07:16:10 -0500182Previously, all configuration was done by hand, which involved creating
183symbolic links and editing configuration files manually. More recently,
184U-Boot has added the Kbuild infrastructure used by the Linux kernel,
185allowing you to use the "make menuconfig" command to configure your
186build.
wdenkc6097192002-11-03 00:24:07 +0000187
188
189Selection of Processor Architecture and Board Type:
190---------------------------------------------------
191
192For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200193configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000194
195Example: For a TQM823L module type:
196
197 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200198 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000199
Robert P. J. Day7207b362015-12-19 07:16:10 -0500200Note: If you're looking for the default configuration file for a board
201you're sure used to be there but is now missing, check the file
202doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000203
Simon Glass75b3c3a2014-03-22 17:12:59 -0600204Sandbox Environment:
205--------------------
206
207U-Boot can be built natively to run on a Linux host using the 'sandbox'
208board. This allows feature development which is not board- or architecture-
209specific to be undertaken on a native platform. The sandbox is also used to
210run some of U-Boot's tests.
211
Keerthy5917d0b2019-07-29 13:52:04 +0530212See doc/arch/index.rst for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600213
214
Simon Glassdb910352015-03-03 08:03:00 -0700215Board Initialisation Flow:
216--------------------------
217
218This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500219SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700220
Robert P. J. Day7207b362015-12-19 07:16:10 -0500221Note: "SPL" stands for "Secondary Program Loader," which is explained in
222more detail later in this file.
223
224At present, SPL mostly uses a separate code path, but the function names
225and roles of each function are the same. Some boards or architectures
226may not conform to this. At least most ARM boards which use
227CONFIG_SPL_FRAMEWORK conform to this.
228
229Execution typically starts with an architecture-specific (and possibly
230CPU-specific) start.S file, such as:
231
232 - arch/arm/cpu/armv7/start.S
233 - arch/powerpc/cpu/mpc83xx/start.S
234 - arch/mips/cpu/start.S
235
236and so on. From there, three functions are called; the purpose and
237limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700238
239lowlevel_init():
240 - purpose: essential init to permit execution to reach board_init_f()
241 - no global_data or BSS
242 - there is no stack (ARMv7 may have one but it will soon be removed)
243 - must not set up SDRAM or use console
244 - must only do the bare minimum to allow execution to continue to
245 board_init_f()
246 - this is almost never needed
247 - return normally from this function
248
249board_init_f():
250 - purpose: set up the machine ready for running board_init_r():
251 i.e. SDRAM and serial UART
252 - global_data is available
253 - stack is in SRAM
254 - BSS is not available, so you cannot use global/static variables,
255 only stack variables and global_data
256
257 Non-SPL-specific notes:
258 - dram_init() is called to set up DRAM. If already done in SPL this
259 can do nothing
260
261 SPL-specific notes:
262 - you can override the entire board_init_f() function with your own
263 version as needed.
264 - preloader_console_init() can be called here in extremis
265 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayama499696e2020-09-24 15:57:19 +0900266 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg14254652019-08-08 12:54:49 -0500267 - for specific scenarios on certain architectures an early BSS *can*
268 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
269 of BSS prior to entering board_init_f()) but doing so is discouraged.
270 Instead it is strongly recommended to architect any code changes
271 or additions such to not depend on the availability of BSS during
272 board_init_f() as indicated in other sections of this README to
273 maintain compatibility and consistency across the entire code base.
Simon Glassdb910352015-03-03 08:03:00 -0700274 - must return normally from this function (don't call board_init_r()
275 directly)
276
277Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278this point the stack and global_data are relocated to below
279CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280memory.
281
282board_init_r():
283 - purpose: main execution, common code
284 - global_data is available
285 - SDRAM is available
286 - BSS is available, all static/global variables can be used
287 - execution eventually continues to main_loop()
288
289 Non-SPL-specific notes:
290 - U-Boot is relocated to the top of memory and is now running from
291 there.
292
293 SPL-specific notes:
294 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295 CONFIG_SPL_STACK_R_ADDR points into SDRAM
296 - preloader_console_init() can be called here - typically this is
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800297 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700298 spl_board_init() function containing this call
299 - loads U-Boot or (in falcon mode) Linux
300
301
302
wdenkc6097192002-11-03 00:24:07 +0000303Configuration Options:
304----------------------
305
306Configuration depends on the combination of board and CPU type; all
307such information is kept in a configuration file
308"include/configs/<board_name>.h".
309
310Example: For a TQM823L module, all configuration settings are in
311"include/configs/TQM823L.h".
312
313
wdenk7f6c2cb2002-11-10 22:06:23 +0000314Many of the options are named exactly as the corresponding Linux
315kernel configuration options. The intention is to make it easier to
316build a config tool - later.
317
Ashish Kumar63b23162017-08-11 11:09:14 +0530318- ARM Platform Bus Type(CCI):
319 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
320 provides full cache coherency between two clusters of multi-core
321 CPUs and I/O coherency for devices and I/O masters
322
323 CONFIG_SYS_FSL_HAS_CCI400
324
325 Defined For SoC that has cache coherent interconnect
326 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000327
Ashish Kumarc055cee2017-08-18 10:54:36 +0530328 CONFIG_SYS_FSL_HAS_CCN504
329
330 Defined for SoC that has cache coherent interconnect CCN-504
331
wdenkc6097192002-11-03 00:24:07 +0000332The following options need to be configured:
333
Kim Phillips26281142007-08-10 13:28:25 -0500334- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000335
Kim Phillips26281142007-08-10 13:28:25 -0500336- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200337
Kumar Gala66412c62011-02-18 05:40:54 -0600338- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000339 CONFIG_SYS_PPC64
340
341 Specifies that the core is a 64-bit PowerPC implementation (implements
342 the "64" category of the Power ISA). This is necessary for ePAPR
343 compliance, among other possible reasons.
344
Kumar Gala66412c62011-02-18 05:40:54 -0600345 CONFIG_SYS_FSL_TBCLK_DIV
346
347 Defines the core time base clock divider ratio compared to the
348 system clock. On most PQ3 devices this is 8, on newer QorIQ
349 devices it can be 16 or 32. The ratio varies from SoC to Soc.
350
Kumar Gala8f290842011-05-20 00:39:21 -0500351 CONFIG_SYS_FSL_PCIE_COMPAT
352
353 Defines the string to utilize when trying to match PCIe device
354 tree nodes for the given platform.
355
Scott Wood33eee332012-08-14 10:14:53 +0000356 CONFIG_SYS_FSL_ERRATUM_A004510
357
358 Enables a workaround for erratum A004510. If set,
359 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
360 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
361
362 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
364
365 Defines one or two SoC revisions (low 8 bits of SVR)
366 for which the A004510 workaround should be applied.
367
368 The rest of SVR is either not relevant to the decision
369 of whether the erratum is present (e.g. p2040 versus
370 p2041) or is implied by the build target, which controls
371 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
372
373 See Freescale App Note 4493 for more information about
374 this erratum.
375
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530376 CONFIG_A003399_NOR_WORKAROUND
377 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800378 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530379
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530380 CONFIG_A008044_WORKAROUND
381 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800382 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530383
Scott Wood33eee332012-08-14 10:14:53 +0000384 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
385
386 This is the value to write into CCSR offset 0x18600
387 according to the A004510 workaround.
388
Priyanka Jain64501c62013-07-02 09:21:04 +0530389 CONFIG_SYS_FSL_DSP_DDR_ADDR
390 This value denotes start offset of DDR memory which is
391 connected exclusively to the DSP cores.
392
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530393 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
394 This value denotes start offset of M2 memory
395 which is directly connected to the DSP core.
396
Priyanka Jain64501c62013-07-02 09:21:04 +0530397 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
398 This value denotes start offset of M3 memory which is directly
399 connected to the DSP core.
400
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530401 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
402 This value denotes start offset of DSP CCSR space.
403
Priyanka Jainb1359912013-12-17 14:25:52 +0530404 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
405 Single Source Clock is clocking mode present in some of FSL SoC's.
406 In this mode, a single differential clock is used to supply
407 clocks to the sysclock, ddrclock and usbclock.
408
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530409 CONFIG_SYS_CPC_REINIT_F
410 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800411 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530412
Tang Yuantianaade2002014-04-17 15:33:46 +0800413 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800414 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800415 supported, core will start to execute uboot when wakes up.
416
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000417- Generic CPU options:
418 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
419
420 Defines the endianess of the CPU. Implementation of those
421 values is arch specific.
422
York Sun5614e712013-09-30 09:22:09 -0700423 CONFIG_SYS_FSL_DDR
424 Freescale DDR driver in use. This type of DDR controller is
425 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
426 SoCs.
427
428 CONFIG_SYS_FSL_DDR_ADDR
429 Freescale DDR memory-mapped register base.
430
431 CONFIG_SYS_FSL_DDR_EMU
432 Specify emulator support for DDR. Some DDR features such as
433 deskew training are not available.
434
435 CONFIG_SYS_FSL_DDRC_GEN1
436 Freescale DDR1 controller.
437
438 CONFIG_SYS_FSL_DDRC_GEN2
439 Freescale DDR2 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN3
442 Freescale DDR3 controller.
443
York Sun34e026f2014-03-27 17:54:47 -0700444 CONFIG_SYS_FSL_DDRC_GEN4
445 Freescale DDR4 controller.
446
York Sun9ac4ffb2013-09-30 14:20:51 -0700447 CONFIG_SYS_FSL_DDRC_ARM_GEN3
448 Freescale DDR3 controller for ARM-based SoCs.
449
York Sun5614e712013-09-30 09:22:09 -0700450 CONFIG_SYS_FSL_DDR1
451 Board config to use DDR1. It can be enabled for SoCs with
452 Freescale DDR1 or DDR2 controllers, depending on the board
453 implemetation.
454
455 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400456 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700457 Freescale DDR2 or DDR3 controllers, depending on the board
458 implementation.
459
460 CONFIG_SYS_FSL_DDR3
461 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700462 Freescale DDR3 or DDR3L controllers.
463
464 CONFIG_SYS_FSL_DDR3L
465 Board config to use DDR3L. It can be enabled for SoCs with
466 DDR3L controllers.
467
468 CONFIG_SYS_FSL_DDR4
469 Board config to use DDR4. It can be enabled for SoCs with
470 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700471
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530472 CONFIG_SYS_FSL_IFC_BE
473 Defines the IFC controller register space as Big Endian
474
475 CONFIG_SYS_FSL_IFC_LE
476 Defines the IFC controller register space as Little Endian
477
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530478 CONFIG_SYS_FSL_IFC_CLK_DIV
479 Defines divider of platform clock(clock input to IFC controller).
480
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530481 CONFIG_SYS_FSL_LBC_CLK_DIV
482 Defines divider of platform clock(clock input to eLBC controller).
483
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530484 CONFIG_SYS_FSL_PBL_PBI
485 It enables addition of RCW (Power on reset configuration) in built image.
486 Please refer doc/README.pblimage for more details
487
488 CONFIG_SYS_FSL_PBL_RCW
489 It adds PBI(pre-boot instructions) commands in u-boot build image.
490 PBI commands can be used to configure SoC before it starts the execution.
491 Please refer doc/README.pblimage for more details
492
York Sun4e5b1bd2014-02-10 13:59:42 -0800493 CONFIG_SYS_FSL_DDR_BE
494 Defines the DDR controller register space as Big Endian
495
496 CONFIG_SYS_FSL_DDR_LE
497 Defines the DDR controller register space as Little Endian
498
York Sun6b9e3092014-02-10 13:59:43 -0800499 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
500 Physical address from the view of DDR controllers. It is the
501 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
502 it could be different for ARM SoCs.
503
York Sun6b1e1252014-02-10 13:59:44 -0800504 CONFIG_SYS_FSL_DDR_INTLV_256B
505 DDR controller interleaving on 256-byte. This is a special
506 interleaving mode, handled by Dickens for Freescale layerscape
507 SoCs with ARM core.
508
York Sun1d71efb2014-08-01 15:51:00 -0700509 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
510 Number of controllers used as main memory.
511
512 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
513 Number of controllers used for other than main memory.
514
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530515 CONFIG_SYS_FSL_HAS_DP_DDR
516 Defines the SoC has DP-DDR used for DPAA.
517
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530518 CONFIG_SYS_FSL_SEC_BE
519 Defines the SEC controller register space as Big Endian
520
521 CONFIG_SYS_FSL_SEC_LE
522 Defines the SEC controller register space as Little Endian
523
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200524- MIPS CPU options:
525 CONFIG_SYS_INIT_SP_OFFSET
526
527 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
528 pointer. This is needed for the temporary stack before
529 relocation.
530
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200531 CONFIG_XWAY_SWAP_BYTES
532
533 Enable compilation of tools/xway-swap-bytes needed for Lantiq
534 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
535 be swapped if a flash programmer is used.
536
Christian Rieschb67d8812012-02-02 00:44:39 +0000537- ARM options:
538 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
539
540 Select high exception vectors of the ARM core, e.g., do not
541 clear the V bit of the c1 register of CP15.
542
York Sun207774b2015-03-20 19:28:08 -0700543 COUNTER_FREQUENCY
544 Generic timer clock source frequency.
545
546 COUNTER_FREQUENCY_REAL
547 Generic timer clock source frequency if the real clock is
548 different from COUNTER_FREQUENCY, and can only be determined
549 at run time.
550
Stephen Warren73c38932015-01-19 16:25:52 -0700551- Tegra SoC options:
552 CONFIG_TEGRA_SUPPORT_NON_SECURE
553
554 Support executing U-Boot in non-secure (NS) mode. Certain
555 impossible actions will be skipped if the CPU is in NS mode,
556 such as ARM architectural timer initialization.
557
wdenk5da627a2003-10-09 20:09:04 +0000558- Linux Kernel Interface:
wdenk5da627a2003-10-09 20:09:04 +0000559 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
560
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800561 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000562 expect it to be in bytes, others in MB.
563 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
564
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400565 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200566
567 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400568 passed using flattened device trees (based on open firmware
569 concepts).
570
571 CONFIG_OF_LIBFDT
572 * New libfdt-based support
573 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500574 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400575
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200576 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600577 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200578
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200579 boards with QUICC Engines require OF_QE to set UCC MAC
580 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500581
Kumar Gala4e253132006-01-11 13:54:17 -0600582 CONFIG_OF_BOARD_SETUP
583
584 Board code has addition modification that it wants to make
585 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000586
Simon Glassc654b512014-10-23 18:58:54 -0600587 CONFIG_OF_SYSTEM_SETUP
588
589 Other code has addition modification that it wants to make
590 to the flat device tree before handing it off to the kernel.
591 This causes ft_system_setup() to be called before booting
592 the kernel.
593
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200594 CONFIG_OF_IDE_FIXUP
595
596 U-Boot can detect if an IDE device is present or not.
597 If not, and this new config option is activated, U-Boot
598 removes the ATA node from the DTS before booting Linux,
599 so the Linux IDE driver does not probe the device and
600 crash. This is needed for buggy hardware (uc101) where
601 no pull down resistor is connected to the signal IDE5V_DD7.
602
Igor Grinberg7eb29392011-07-14 05:45:07 +0000603 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
604
605 This setting is mandatory for all boards that have only one
606 machine type and must be used to specify the machine type
607 number as it appears in the ARM machine registry
608 (see http://www.arm.linux.org.uk/developer/machines/).
609 Only boards that have multiple machine types supported
610 in a single configuration file and the machine type is
611 runtime discoverable, do not have to use this setting.
612
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100613- vxWorks boot parameters:
614
615 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700616 environments variables: bootdev, bootfile, ipaddr, netmask,
617 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100618 It loads the vxWorks image pointed bootfile.
619
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100620 Note: If a "bootargs" environment is defined, it will overwride
621 the defaults discussed just above.
622
Aneesh V2c451f72011-06-16 23:30:47 +0000623- Cache Configuration:
Aneesh V2c451f72011-06-16 23:30:47 +0000624 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
625
Aneesh V93bc2192011-06-16 23:30:51 +0000626- Cache Configuration for ARM:
627 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
628 controller
629 CONFIG_SYS_PL310_BASE - Physical base address of PL310
630 controller register space
631
wdenk6705d812004-08-02 23:22:59 +0000632- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200633 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000634
635 Define this if you want support for Amba PrimeCell PL010 UARTs.
636
Andreas Engel48d01922008-09-08 14:30:53 +0200637 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000638
639 Define this if you want support for Amba PrimeCell PL011 UARTs.
640
641 CONFIG_PL011_CLOCK
642
643 If you have Amba PrimeCell PL011 UARTs, set this variable to
644 the clock speed of the UARTs.
645
646 CONFIG_PL01x_PORTS
647
648 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
649 define this to a list of base addresses for each (supported)
650 port. See e.g. include/configs/versatile.h
651
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400652 CONFIG_SERIAL_HW_FLOW_CONTROL
653
654 Define this variable to enable hw flow control in serial driver.
655 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000656
wdenkc6097192002-11-03 00:24:07 +0000657- Autoboot Command:
658 CONFIG_BOOTCOMMAND
659 Only needed when CONFIG_BOOTDELAY is enabled;
660 define a command string that is automatically executed
661 when no character is read on the console interface
662 within "Boot Delay" after reset.
663
wdenkc6097192002-11-03 00:24:07 +0000664 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000665 The value of these goes into the environment as
666 "ramboot" and "nfsboot" respectively, and can be used
667 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200668 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000669
wdenkc6097192002-11-03 00:24:07 +0000670- Serial Download Echo Mode:
671 CONFIG_LOADS_ECHO
672 If defined to 1, all characters received during a
673 serial download (using the "loads" command) are
674 echoed back. This might be needed by some terminal
675 emulations (like "cu"), but may as well just take
676 time on others. This setting #define's the initial
677 value of the "loads_echo" environment variable.
678
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500679- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_KGDB_BAUDRATE
681 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200682 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000683
Simon Glass302a6482016-03-13 19:07:28 -0600684- Removal of commands
685 If no commands are needed to boot, you can disable
686 CONFIG_CMDLINE to remove them. In this case, the command line
687 will not be available, and when U-Boot wants to execute the
688 boot command (on start-up) it will call board_run_command()
689 instead. This can reduce image size significantly for very
690 simple boot procedures.
691
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000692- Regular expression support:
693 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200694 If this variable is defined, U-Boot is linked against
695 the SLRE (Super Light Regular Expression) library,
696 which adds regex support to some commands, as for
697 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000698
Simon Glass45ba8072011-10-15 05:48:20 +0000699- Device tree:
700 CONFIG_OF_CONTROL
701 If this variable is defined, U-Boot will use a device tree
702 to configure its devices, instead of relying on statically
703 compiled #defines in the board file. This option is
704 experimental and only available on a few boards. The device
705 tree is available in the global data as gd->fdt_blob.
706
Simon Glass2c0f79e2011-10-24 19:15:31 +0000707 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700708 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000709
710 CONFIG_OF_EMBED
711 If this variable is defined, U-Boot will embed a device tree
712 binary in its image. This device tree file should be in the
713 board directory and called <soc>-<board>.dts. The binary file
714 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900715 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000716
Simon Glass2c0f79e2011-10-24 19:15:31 +0000717 CONFIG_OF_SEPARATE
718 If this variable is defined, U-Boot will build a device tree
719 binary. It will be called u-boot.dtb. Architecture-specific
720 code will locate it at run-time. Generally this works by:
721
722 cat u-boot.bin u-boot.dtb >image.bin
723
724 and in fact, U-Boot does this for you, creating a file called
725 u-boot-dtb.bin which is useful in the common case. You can
726 still use the individual files if you need something more
727 exotic.
728
Alex Deymo82f766d2017-04-02 01:25:20 -0700729 CONFIG_OF_BOARD
730 If this variable is defined, U-Boot will use the device tree
731 provided by the board at runtime instead of embedding one with
732 the image. Only boards defining board_fdt_blob_setup() support
733 this option (see include/fdtdec.h file).
734
wdenkc6097192002-11-03 00:24:07 +0000735- Watchdog:
736 CONFIG_WATCHDOG
737 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000738 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200739 specific code for a watchdog. For the 8xx
740 CPUs, the SIU Watchdog feature is enabled in the SYPCR
741 register. When supported for a specific SoC is
742 available, then no further board specific code should
743 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000744
745 CONFIG_HW_WATCHDOG
746 When using a watchdog circuitry external to the used
747 SoC, then define this variable and provide board
748 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000749
750- Real-Time Clock:
751
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500752 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000753 has to be selected, too. Define exactly one of the
754 following options:
755
wdenkc6097192002-11-03 00:24:07 +0000756 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000757 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000758 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000759 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000760 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000761 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200762 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000763 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100764 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000765 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200766 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200767 CONFIG_SYS_RV3029_TCR - enable trickle charger on
768 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000769
wdenkb37c7e52003-06-30 16:24:52 +0000770 Note that if the RTC uses I2C, then the I2C interface
771 must also be configured. See I2C Support, below.
772
Peter Tysere92739d2008-12-17 16:36:21 -0600773- GPIO Support:
774 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600775
Chris Packham5dec49c2010-12-19 10:12:13 +0000776 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
777 chip-ngpio pairs that tell the PCA953X driver the number of
778 pins supported by a particular chip.
779
Peter Tysere92739d2008-12-17 16:36:21 -0600780 Note that if the GPIO device uses I2C, then the I2C interface
781 must also be configured. See I2C Support, below.
782
Simon Glassaa532332014-06-11 23:29:41 -0600783- I/O tracing:
784 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
785 accesses and can checksum them or write a list of them out
786 to memory. See the 'iotrace' command for details. This is
787 useful for testing device drivers since it can confirm that
788 the driver behaves the same way before and after a code
789 change. Currently this is supported on sandbox and arm. To
790 add support for your architecture, add '#include <iotrace.h>'
791 to the bottom of arch/<arch>/include/asm/io.h and test.
792
793 Example output from the 'iotrace stats' command is below.
794 Note that if the trace buffer is exhausted, the checksum will
795 still continue to operate.
796
797 iotrace is enabled
798 Start: 10000000 (buffer start address)
799 Size: 00010000 (buffer size)
800 Offset: 00000120 (current buffer offset)
801 Output: 10000120 (start + offset)
802 Count: 00000018 (number of trace records)
803 CRC32: 9526fb66 (CRC32 of all trace records)
804
wdenkc6097192002-11-03 00:24:07 +0000805- Timestamp Support:
806
wdenk43d96162003-03-06 00:02:04 +0000807 When CONFIG_TIMESTAMP is selected, the timestamp
808 (date and time) of an image is printed by image
809 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500810 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000811
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000812- Partition Labels (disklabels) Supported:
813 Zero or more of the following:
814 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000815 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
816 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
817 bootloader. Note 2TB partition limit; see
818 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600819 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000820 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000821
822- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000823 CONFIG_IDE_RESET_ROUTINE - this is defined in several
824 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000825
wdenk4d13cba2004-03-14 14:09:05 +0000826 CONFIG_IDE_RESET - is this is defined, IDE Reset will
827 be performed by calling the function
828 ide_set_reset(int reset)
829 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000830
831- ATAPI Support:
832 CONFIG_ATAPI
833
834 Set this to enable ATAPI support.
835
wdenkc40b2952004-03-13 23:29:43 +0000836- LBA48 Support
837 CONFIG_LBA48
838
839 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100840 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000841 Whithout these , LBA48 support uses 32bit variables and will 'only'
842 support disks up to 2.1TB.
843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200844 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000845 When enabled, makes the IDE subsystem use 64bit sector addresses.
846 Default is 32bit.
847
wdenkc6097192002-11-03 00:24:07 +0000848- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200849 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
850 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
851 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000852 maximum numbers of LUNs, SCSI ID's and target
853 devices.
wdenkc6097192002-11-03 00:24:07 +0000854
Wolfgang Denk93e14592013-10-04 17:43:24 +0200855 The environment variable 'scsidevs' is set to the number of
856 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000857
wdenkc6097192002-11-03 00:24:07 +0000858- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000859 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000860 Support for Intel 8254x/8257x gigabit chips.
861
862 CONFIG_E1000_SPI
863 Utility code for direct access to the SPI bus on Intel 8257x.
864 This does not do anything useful unless you set at least one
865 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
866
867 CONFIG_E1000_SPI_GENERIC
868 Allow generic access to the SPI bus on the Intel 8257x, for
869 example with the "sspi" command.
870
wdenkc6097192002-11-03 00:24:07 +0000871 CONFIG_NATSEMI
872 Support for National dp83815 chips.
873
874 CONFIG_NS8382X
875 Support for National dp8382[01] gigabit chips.
876
wdenk45219c42003-05-12 21:50:16 +0000877- NETWORK Support (other):
878
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100879 CONFIG_DRIVER_AT91EMAC
880 Support for AT91RM9200 EMAC.
881
882 CONFIG_RMII
883 Define this to use reduced MII inteface
884
885 CONFIG_DRIVER_AT91EMAC_QUIET
886 If this defined, the driver is quiet.
887 The driver doen't show link status messages.
888
Rob Herringefdd7312011-12-15 11:15:49 +0000889 CONFIG_CALXEDA_XGMAC
890 Support for the Calxeda XGMAC device
891
Ashok3bb46d22012-10-15 06:20:47 +0000892 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000893 Support for SMSC's LAN91C96 chips.
894
wdenk45219c42003-05-12 21:50:16 +0000895 CONFIG_LAN91C96_USE_32_BIT
896 Define this to enable 32 bit addressing
897
Ashok3bb46d22012-10-15 06:20:47 +0000898 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000899 Support for SMSC's LAN91C111 chip
900
901 CONFIG_SMC91111_BASE
902 Define this to hold the physical address
903 of the device (I/O space)
904
905 CONFIG_SMC_USE_32_BIT
906 Define this if data bus is 32 bits
907
908 CONFIG_SMC_USE_IOFUNCS
909 Define this to use i/o functions instead of macros
910 (some hardware wont work with macros)
911
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500912 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
913 Define this if you have more then 3 PHYs.
914
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800915 CONFIG_FTGMAC100
916 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
917
918 CONFIG_FTGMAC100_EGIGA
919 Define this to use GE link update with gigabit PHY.
920 Define this if FTGMAC100 is connected to gigabit PHY.
921 If your system has 10/100 PHY only, it might not occur
922 wrong behavior. Because PHY usually return timeout or
923 useless data when polling gigabit status and gigabit
924 control registers. This behavior won't affect the
925 correctnessof 10/100 link speed update.
926
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900927 CONFIG_SH_ETHER
928 Support for Renesas on-chip Ethernet controller
929
930 CONFIG_SH_ETHER_USE_PORT
931 Define the number of ports to be used
932
933 CONFIG_SH_ETHER_PHY_ADDR
934 Define the ETH PHY's address
935
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900936 CONFIG_SH_ETHER_CACHE_WRITEBACK
937 If this option is set, the driver enables cache flush.
938
Vadim Bendebury5e124722011-10-17 08:36:14 +0000939- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000940 CONFIG_TPM
941 Support TPM devices.
942
Christophe Ricard0766ad22015-10-06 22:54:41 +0200943 CONFIG_TPM_TIS_INFINEON
944 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000945 per system is supported at this time.
946
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000947 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
948 Define the burst count bytes upper limit
949
Christophe Ricard3aa74082016-01-21 23:27:13 +0100950 CONFIG_TPM_ST33ZP24
951 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
952
953 CONFIG_TPM_ST33ZP24_I2C
954 Support for STMicroelectronics ST33ZP24 I2C devices.
955 Requires TPM_ST33ZP24 and I2C.
956
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100957 CONFIG_TPM_ST33ZP24_SPI
958 Support for STMicroelectronics ST33ZP24 SPI devices.
959 Requires TPM_ST33ZP24 and SPI.
960
Dirk Eibachc01939c2013-06-26 15:55:15 +0200961 CONFIG_TPM_ATMEL_TWI
962 Support for Atmel TWI TPM device. Requires I2C support.
963
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000964 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000965 Support for generic parallel port TPM devices. Only one device
966 per system is supported at this time.
967
968 CONFIG_TPM_TIS_BASE_ADDRESS
969 Base address where the generic TPM device is mapped
970 to. Contemporary x86 systems usually map it at
971 0xfed40000.
972
Reinhard Pfaube6c1522013-06-26 15:55:13 +0200973 CONFIG_TPM
974 Define this to enable the TPM support library which provides
975 functional interfaces to some TPM commands.
976 Requires support for a TPM device.
977
978 CONFIG_TPM_AUTH_SESSIONS
979 Define this to enable authorized functions in the TPM library.
980 Requires CONFIG_TPM and CONFIG_SHA1.
981
wdenkc6097192002-11-03 00:24:07 +0000982- USB Support:
983 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +0200984 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000985 CONFIG_USB_UHCI to enable it.
986 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000987 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000988 storage devices.
989 Note:
990 Supported are USB Keyboards and USB Floppy drives
991 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000992
Simon Glass9ab4ce22012-02-27 10:52:47 +0000993 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
994 txfilltuning field in the EHCI controller on reset.
995
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -0700996 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
997 HW module registers.
998
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200999- USB Device:
1000 Define the below if you wish to use the USB console.
1001 Once firmware is rebuilt from a serial console issue the
1002 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001003 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001004 it has found a new device. The environment variable usbtty
1005 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001006 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001007 Common Device Class Abstract Control Model serial device.
1008 If you select usbtty = gserial you should be able to enumerate
1009 a Linux host by
1010 # modprobe usbserial vendor=0xVendorID product=0xProductID
1011 else if using cdc_acm, simply setting the environment
1012 variable usbtty to be cdc_acm should suffice. The following
1013 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001014
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001015 CONFIG_USB_DEVICE
1016 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001017
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001018 CONFIG_USB_TTY
1019 Define this to have a tty type of device available to
1020 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001021
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301022 CONFIG_USBD_HS
1023 Define this to enable the high speed support for usb
1024 device and usbtty. If this feature is enabled, a routine
1025 int is_usbd_high_speed(void)
1026 also needs to be defined by the driver to dynamically poll
1027 whether the enumeration has succeded at high speed or full
1028 speed.
1029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001030 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001031 Define this if you want stdin, stdout &/or stderr to
1032 be set to usbtty.
1033
Wolfgang Denk386eda02006-06-14 18:14:56 +02001034 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001035 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001036 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001037 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1038 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1039 should pretend to be a Linux device to it's target host.
1040
1041 CONFIG_USBD_MANUFACTURER
1042 Define this string as the name of your company for
1043 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001044
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001045 CONFIG_USBD_PRODUCT_NAME
1046 Define this string as the name of your product
1047 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1048
1049 CONFIG_USBD_VENDORID
1050 Define this as your assigned Vendor ID from the USB
1051 Implementors Forum. This *must* be a genuine Vendor ID
1052 to avoid polluting the USB namespace.
1053 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001054
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001055 CONFIG_USBD_PRODUCTID
1056 Define this as the unique Product ID
1057 for your device
1058 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001059
Igor Grinbergd70a5602011-12-12 12:08:35 +02001060- ULPI Layer Support:
1061 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1062 the generic ULPI layer. The generic layer accesses the ULPI PHY
1063 via the platform viewport, so you need both the genric layer and
1064 the viewport enabled. Currently only Chipidea/ARC based
1065 viewport is supported.
1066 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1067 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001068 If your ULPI phy needs a different reference clock than the
1069 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1070 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001071
1072- MMC Support:
1073 The MMC controller on the Intel PXA is supported. To
1074 enable this define CONFIG_MMC. The MMC can be
1075 accessed from the boot prompt by mapping the device
1076 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001077 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1078 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001079
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001080 CONFIG_SH_MMCIF
1081 Support for Renesas on-chip MMCIF controller
1082
1083 CONFIG_SH_MMCIF_ADDR
1084 Define the base address of MMCIF registers
1085
1086 CONFIG_SH_MMCIF_CLK
1087 Define the clock frequency for MMCIF
1088
Tom Rinib3ba6e92013-03-14 05:32:47 +00001089- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +01001090 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +00001091 This enables the USB portion of the DFU USB class
1092
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001093 CONFIG_DFU_NAND
1094 This enables support for exposing NAND devices via DFU.
1095
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301096 CONFIG_DFU_RAM
1097 This enables support for exposing RAM via DFU.
1098 Note: DFU spec refer to non-volatile memory usage, but
1099 allow usages beyond the scope of spec - here RAM usage,
1100 one that would help mostly the developer.
1101
Heiko Schochere7e75c72013-06-12 06:05:51 +02001102 CONFIG_SYS_DFU_DATA_BUF_SIZE
1103 Dfu transfer uses a buffer before writing data to the
1104 raw storage device. Make the size (in bytes) of this buffer
1105 configurable. The size of this buffer is also configurable
1106 through the "dfu_bufsiz" environment variable.
1107
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001108 CONFIG_SYS_DFU_MAX_FILE_SIZE
1109 When updating files rather than the raw storage device,
1110 we use a static buffer to copy the file into and then write
1111 the buffer once we've been given the whole file. Define
1112 this to the maximum filesize (in bytes) for the buffer.
1113 Default is 4 MiB if undefined.
1114
Heiko Schocher001a8312014-03-18 08:09:56 +01001115 DFU_DEFAULT_POLL_TIMEOUT
1116 Poll timeout [ms], is the timeout a device can send to the
1117 host. The host must wait for this timeout before sending
1118 a subsequent DFU_GET_STATUS request to the device.
1119
1120 DFU_MANIFEST_POLL_TIMEOUT
1121 Poll timeout [ms], which the device sends to the host when
1122 entering dfuMANIFEST state. Host waits this timeout, before
1123 sending again an USB request to the device.
1124
wdenk6705d812004-08-02 23:22:59 +00001125- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001126 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001127 Define these for a default partition on a NAND device
1128
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001129 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1130 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001131 Define these for a default partition on a NOR device
1132
wdenkc6097192002-11-03 00:24:07 +00001133- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001134 See Kconfig help for available keyboard drivers.
1135
1136 CONFIG_KEYBOARD
1137
1138 Define this to enable a custom keyboard support.
1139 This simply calls drv_keyboard_init() which must be
1140 defined in your board-specific files. This option is deprecated
1141 and is only used by novena. For new boards, use driver model
1142 instead.
wdenkc6097192002-11-03 00:24:07 +00001143
1144- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001145 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001146 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001147 SOCs that have a DIU should define this macro to enable DIU
1148 support, and should also define these other macros:
1149
1150 CONFIG_SYS_DIU_ADDR
1151 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001152 CONFIG_CFB_CONSOLE
1153 CONFIG_VIDEO_SW_CURSOR
1154 CONFIG_VGA_AS_SINGLE_DEVICE
1155 CONFIG_VIDEO_LOGO
1156 CONFIG_VIDEO_BMP_LOGO
1157
Timur Tabiba8e76b2011-04-11 14:18:22 -05001158 The DIU driver will look for the 'video-mode' environment
1159 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001160 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001161 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001162
wdenkc6097192002-11-03 00:24:07 +00001163- LCD Support: CONFIG_LCD
1164
1165 Define this to enable LCD support (for output to LCD
1166 display); also select one of the supported displays
1167 by defining one of these:
1168
Stelian Pop39cf4802008-05-09 21:57:18 +02001169 CONFIG_ATMEL_LCD:
1170
1171 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1172
wdenkfd3103b2003-11-25 16:55:19 +00001173 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001174
wdenkfd3103b2003-11-25 16:55:19 +00001175 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001176
wdenkfd3103b2003-11-25 16:55:19 +00001177 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001178
wdenkfd3103b2003-11-25 16:55:19 +00001179 NEC NL6448BC20-08. 6.5", 640x480.
1180 Active, color, single scan.
1181
1182 CONFIG_NEC_NL6448BC33_54
1183
1184 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001185 Active, color, single scan.
1186
1187 CONFIG_SHARP_16x9
1188
1189 Sharp 320x240. Active, color, single scan.
1190 It isn't 16x9, and I am not sure what it is.
1191
1192 CONFIG_SHARP_LQ64D341
1193
1194 Sharp LQ64D341 display, 640x480.
1195 Active, color, single scan.
1196
1197 CONFIG_HLD1045
1198
1199 HLD1045 display, 640x480.
1200 Active, color, single scan.
1201
1202 CONFIG_OPTREX_BW
1203
1204 Optrex CBL50840-2 NF-FW 99 22 M5
1205 or
1206 Hitachi LMG6912RPFC-00T
1207 or
1208 Hitachi SP14Q002
1209
1210 320x240. Black & white.
1211
Simon Glass676d3192012-10-17 13:24:54 +00001212 CONFIG_LCD_ALIGNMENT
1213
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001214 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001215 defined then the LCD will be aligned to this value instead.
1216 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1217 here, since it is cheaper to change data cache settings on
1218 a per-section basis.
1219
1220
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001221 CONFIG_LCD_ROTATION
1222
1223 Sometimes, for example if the display is mounted in portrait
1224 mode or even if it's mounted landscape but rotated by 180degree,
1225 we need to rotate our content of the display relative to the
1226 framebuffer, so that user can read the messages which are
1227 printed out.
1228 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1229 initialized with a given rotation from "vl_rot" out of
1230 "vidinfo_t" which is provided by the board specific code.
1231 The value for vl_rot is coded as following (matching to
1232 fbcon=rotate:<n> linux-kernel commandline):
1233 0 = no rotation respectively 0 degree
1234 1 = 90 degree rotation
1235 2 = 180 degree rotation
1236 3 = 270 degree rotation
1237
1238 If CONFIG_LCD_ROTATION is not defined, the console will be
1239 initialized with 0degree rotation.
1240
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001241 CONFIG_LCD_BMP_RLE8
1242
1243 Support drawing of RLE8-compressed bitmaps on the LCD.
1244
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001245 CONFIG_I2C_EDID
1246
1247 Enables an 'i2c edid' command which can read EDID
1248 information over I2C from an attached LCD display.
1249
wdenk17ea1172004-06-06 21:51:03 +00001250- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +00001251 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1252
1253 The clock frequency of the MII bus
1254
wdenk17ea1172004-06-06 21:51:03 +00001255 CONFIG_PHY_RESET_DELAY
1256
1257 Some PHY like Intel LXT971A need extra delay after
1258 reset before any MII register access is possible.
1259 For such PHY, set this option to the usec delay
1260 required. (minimum 300usec for LXT971A)
1261
1262 CONFIG_PHY_CMD_DELAY (ppc4xx)
1263
1264 Some PHY like Intel LXT971A need extra delay after
1265 command issued before MII status register can be read
1266
wdenkc6097192002-11-03 00:24:07 +00001267- IP address:
1268 CONFIG_IPADDR
1269
1270 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001271 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001272 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001273 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001274
1275- Server IP address:
1276 CONFIG_SERVERIP
1277
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001278 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001279 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001280 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001281
Robin Getz97cfe862009-07-21 12:15:28 -04001282 CONFIG_KEEP_SERVERADDR
1283
1284 Keeps the server's MAC address, in the env 'serveraddr'
1285 for passing to bootargs (like Linux's netconsole option)
1286
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001287- Gateway IP address:
1288 CONFIG_GATEWAYIP
1289
1290 Defines a default value for the IP address of the
1291 default router where packets to other networks are
1292 sent to.
1293 (Environment variable "gatewayip")
1294
1295- Subnet mask:
1296 CONFIG_NETMASK
1297
1298 Defines a default value for the subnet mask (or
1299 routing prefix) which is used to determine if an IP
1300 address belongs to the local subnet or needs to be
1301 forwarded through a router.
1302 (Environment variable "netmask")
1303
wdenkc6097192002-11-03 00:24:07 +00001304- BOOTP Recovery Mode:
1305 CONFIG_BOOTP_RANDOM_DELAY
1306
1307 If you have many targets in a network that try to
1308 boot using BOOTP, you may want to avoid that all
1309 systems send out BOOTP requests at precisely the same
1310 moment (which would happen for instance at recovery
1311 from a power failure, when all systems will try to
1312 boot, thus flooding the BOOTP server. Defining
1313 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1314 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001315 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001316
1317 1st BOOTP request: delay 0 ... 1 sec
1318 2nd BOOTP request: delay 0 ... 2 sec
1319 3rd BOOTP request: delay 0 ... 4 sec
1320 4th and following
1321 BOOTP requests: delay 0 ... 8 sec
1322
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001323 CONFIG_BOOTP_ID_CACHE_SIZE
1324
1325 BOOTP packets are uniquely identified using a 32-bit ID. The
1326 server will copy the ID from client requests to responses and
1327 U-Boot will use this to determine if it is the destination of
1328 an incoming response. Some servers will check that addresses
1329 aren't in use before handing them out (usually using an ARP
1330 ping) and therefore take up to a few hundred milliseconds to
1331 respond. Network congestion may also influence the time it
1332 takes for a response to make it back to the client. If that
1333 time is too long, U-Boot will retransmit requests. In order
1334 to allow earlier responses to still be accepted after these
1335 retransmissions, U-Boot's BOOTP client keeps a small cache of
1336 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1337 cache. The default is to keep IDs for up to four outstanding
1338 requests. Increasing this will allow U-Boot to accept offers
1339 from a BOOTP client in networks with unusually high latency.
1340
stroesefe389a82003-08-28 14:17:32 +00001341- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001342 You can fine tune the DHCP functionality by defining
1343 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001344
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001345 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001346 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001347 CONFIG_BOOTP_NTPSERVER
1348 CONFIG_BOOTP_TIMEOFFSET
1349 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001350 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001351
Wilson Callan5d110f02007-07-28 10:56:13 -04001352 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1353 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001354
Joe Hershberger2c00e092012-05-23 07:59:19 +00001355 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1356 after the configured retry count, the call will fail
1357 instead of starting over. This can be used to fail over
1358 to Link-local IP address configuration if the DHCP server
1359 is not available.
1360
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001361 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1362
1363 A 32bit value in microseconds for a delay between
1364 receiving a "DHCP Offer" and sending the "DHCP Request".
1365 This fixes a problem with certain DHCP servers that don't
1366 respond 100% of the time to a "DHCP request". E.g. On an
1367 AT91RM9200 processor running at 180MHz, this delay needed
1368 to be *at least* 15,000 usec before a Windows Server 2003
1369 DHCP server would reply 100% of the time. I recommend at
1370 least 50,000 usec to be safe. The alternative is to hope
1371 that one of the retries will be successful but note that
1372 the DHCP timeout and retry process takes a longer than
1373 this delay.
1374
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001375 - Link-local IP address negotiation:
1376 Negotiate with other link-local clients on the local network
1377 for an address that doesn't require explicit configuration.
1378 This is especially useful if a DHCP server cannot be guaranteed
1379 to exist in all environments that the device must operate.
1380
1381 See doc/README.link-local for more information.
1382
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301383 - MAC address from environment variables
1384
1385 FDT_SEQ_MACADDR_FROM_ENV
1386
1387 Fix-up device tree with MAC addresses fetched sequentially from
1388 environment variables. This config work on assumption that
1389 non-usable ethernet node of device-tree are either not present
1390 or their status has been marked as "disabled".
1391
wdenka3d991b2004-04-15 21:48:45 +00001392 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001393 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001394
1395 The device id used in CDP trigger frames.
1396
1397 CONFIG_CDP_DEVICE_ID_PREFIX
1398
1399 A two character string which is prefixed to the MAC address
1400 of the device.
1401
1402 CONFIG_CDP_PORT_ID
1403
1404 A printf format string which contains the ascii name of
1405 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001406 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001407
1408 CONFIG_CDP_CAPABILITIES
1409
1410 A 32bit integer which indicates the device capabilities;
1411 0x00000010 for a normal host which does not forwards.
1412
1413 CONFIG_CDP_VERSION
1414
1415 An ascii string containing the version of the software.
1416
1417 CONFIG_CDP_PLATFORM
1418
1419 An ascii string containing the name of the platform.
1420
1421 CONFIG_CDP_TRIGGER
1422
1423 A 32bit integer sent on the trigger.
1424
1425 CONFIG_CDP_POWER_CONSUMPTION
1426
1427 A 16bit integer containing the power consumption of the
1428 device in .1 of milliwatts.
1429
1430 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1431
1432 A byte containing the id of the VLAN.
1433
Uri Mashiach79267ed2017-01-19 10:51:05 +02001434- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001435
1436 Several configurations allow to display the current
1437 status using a LED. For instance, the LED will blink
1438 fast while running U-Boot code, stop blinking as
1439 soon as a reply to a BOOTP request was received, and
1440 start blinking slow once the Linux kernel is running
1441 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001442 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001443 feature in U-Boot.
1444
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001445 Additional options:
1446
Uri Mashiach79267ed2017-01-19 10:51:05 +02001447 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001448 The status LED can be connected to a GPIO pin.
1449 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001450 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001451 to include the gpio_led driver in the U-Boot binary.
1452
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001453 CONFIG_GPIO_LED_INVERTED_TABLE
1454 Some GPIO connected LEDs may have inverted polarity in which
1455 case the GPIO high value corresponds to LED off state and
1456 GPIO low value corresponds to LED on state.
1457 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1458 with a list of GPIO LEDs that have inverted polarity.
1459
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001460- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001461
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001462 This enable the NEW i2c subsystem, and will allow you to use
1463 i2c commands at the u-boot command line (as long as you set
Heiko Schocherea818db2013-01-29 08:53:15 +01001464 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1465 for defining speed and slave address
1466 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1467 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1468 for defining speed and slave address
1469 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1470 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1471 for defining speed and slave address
1472 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1473 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1474 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001475
Heiko Schocher00f792e2012-10-24 13:48:22 +02001476 - drivers/i2c/fsl_i2c.c:
1477 - activate i2c driver with CONFIG_SYS_I2C_FSL
1478 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1479 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1480 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1481 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001482 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001483 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1484 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1485 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1486 second bus.
1487
Simon Glass1f2ba722012-10-30 07:28:53 +00001488 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001489 - activate this driver with CONFIG_SYS_I2C_TEGRA
1490 - This driver adds 4 i2c buses with a fix speed from
1491 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001492
Dirk Eibach880540d2013-04-25 02:40:01 +00001493 - drivers/i2c/ppc4xx_i2c.c
1494 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1495 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1496 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1497
tremfac96402013-09-21 18:13:35 +02001498 - drivers/i2c/i2c_mxc.c
1499 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001500 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1501 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1502 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1503 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001504 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1505 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1506 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1507 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1508 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1509 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001510 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1511 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001512 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001513 for speed, and 0 for slave.
1514
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001515 - drivers/i2c/rcar_i2c.c:
1516 - activate this driver with CONFIG_SYS_I2C_RCAR
1517 - This driver adds 4 i2c buses
1518
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001519 - drivers/i2c/sh_i2c.c:
1520 - activate this driver with CONFIG_SYS_I2C_SH
1521 - This driver adds from 2 to 5 i2c buses
1522
1523 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1524 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1525 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1526 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1527 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1528 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1529 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1530 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1531 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1532 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001533 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001534
Heiko Schocher6789e842013-10-22 11:03:18 +02001535 - drivers/i2c/omap24xx_i2c.c
1536 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1537 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1538 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1539 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1540 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1541 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1542 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1543 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1544 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1545 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1546 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1547
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301548 - drivers/i2c/s3c24x0_i2c.c:
1549 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1550 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1551 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1552 with a fix speed from 100000 and the slave addr 0!
1553
Dirk Eibachb46226b2014-07-03 09:28:18 +02001554 - drivers/i2c/ihs_i2c.c
1555 - activate this driver with CONFIG_SYS_I2C_IHS
1556 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1557 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1558 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1559 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1560 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1561 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1562 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1563 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1564 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1565 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1566 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1567 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001568 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1569 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1570 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1571 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1572 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1573 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1574 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1575 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1576 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001577
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001578 additional defines:
1579
1580 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001581 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001582
1583 CONFIG_SYS_I2C_DIRECT_BUS
1584 define this, if you don't use i2c muxes on your hardware.
1585 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1586 omit this define.
1587
1588 CONFIG_SYS_I2C_MAX_HOPS
1589 define how many muxes are maximal consecutively connected
1590 on one i2c bus. If you not use i2c muxes, omit this
1591 define.
1592
1593 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001594 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001595 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1596 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1597 CONFIG_SYS_NUM_I2C_BUSES = 9:
1598
1599 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1600 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1601 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1602 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1603 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1604 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1605 {1, {I2C_NULL_HOP}}, \
1606 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1607 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1608 }
1609
1610 which defines
1611 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001612 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1613 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1614 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1615 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1616 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001617 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001618 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1619 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001620
1621 If you do not have i2c muxes on your board, omit this define.
1622
Simon Glassce3b5d62017-05-12 21:10:00 -06001623- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001624 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001625 then the following macros need to be defined (examples are
1626 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001627
1628 I2C_INIT
1629
wdenkb37c7e52003-06-30 16:24:52 +00001630 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001631 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001632
wdenkba56f622004-02-06 23:19:44 +00001633 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001634
wdenkc6097192002-11-03 00:24:07 +00001635 I2C_ACTIVE
1636
1637 The code necessary to make the I2C data line active
1638 (driven). If the data line is open collector, this
1639 define can be null.
1640
wdenkb37c7e52003-06-30 16:24:52 +00001641 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1642
wdenkc6097192002-11-03 00:24:07 +00001643 I2C_TRISTATE
1644
1645 The code necessary to make the I2C data line tri-stated
1646 (inactive). If the data line is open collector, this
1647 define can be null.
1648
wdenkb37c7e52003-06-30 16:24:52 +00001649 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1650
wdenkc6097192002-11-03 00:24:07 +00001651 I2C_READ
1652
York Sun472d5462013-04-01 11:29:11 -07001653 Code that returns true if the I2C data line is high,
1654 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001655
wdenkb37c7e52003-06-30 16:24:52 +00001656 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1657
wdenkc6097192002-11-03 00:24:07 +00001658 I2C_SDA(bit)
1659
York Sun472d5462013-04-01 11:29:11 -07001660 If <bit> is true, sets the I2C data line high. If it
1661 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001662
wdenkb37c7e52003-06-30 16:24:52 +00001663 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001664 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001665 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001666
wdenkc6097192002-11-03 00:24:07 +00001667 I2C_SCL(bit)
1668
York Sun472d5462013-04-01 11:29:11 -07001669 If <bit> is true, sets the I2C clock line high. If it
1670 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001671
wdenkb37c7e52003-06-30 16:24:52 +00001672 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001673 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001674 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001675
wdenkc6097192002-11-03 00:24:07 +00001676 I2C_DELAY
1677
1678 This delay is invoked four times per clock cycle so this
1679 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001680 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001681 like:
1682
wdenkb37c7e52003-06-30 16:24:52 +00001683 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001684
Mike Frysinger793b5722010-07-21 13:38:02 -04001685 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1686
1687 If your arch supports the generic GPIO framework (asm/gpio.h),
1688 then you may alternatively define the two GPIOs that are to be
1689 used as SCL / SDA. Any of the previous I2C_xxx macros will
1690 have GPIO-based defaults assigned to them as appropriate.
1691
1692 You should define these to the GPIO value as given directly to
1693 the generic GPIO functions.
1694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001695 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001696
wdenk8bde7f72003-06-27 21:31:46 +00001697 When a board is reset during an i2c bus transfer
1698 chips might think that the current transfer is still
1699 in progress. On some boards it is possible to access
1700 the i2c SCLK line directly, either by using the
1701 processor pin as a GPIO or by having a second pin
1702 connected to the bus. If this option is defined a
1703 custom i2c_init_board() routine in boards/xxx/board.c
1704 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001705
Ben Warrenbb99ad62006-09-07 16:50:54 -04001706 CONFIG_I2C_MULTI_BUS
1707
1708 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001709 must have a controller. At any point in time, only one bus is
1710 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001711 Note that bus numbering is zero-based.
1712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001713 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001714
1715 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001716 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001717 is set, specify a list of bus-device pairs. Otherwise, specify
1718 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001719
1720 e.g.
1721 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001722 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001723
1724 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1725
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001726 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001727 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001728
1729 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001731 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001732
1733 If defined, then this indicates the I2C bus number for DDR SPD.
1734 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001736 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001737
1738 If defined, then this indicates the I2C bus number for the RTC.
1739 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1740
Andrew Dyer2ac69852008-12-29 17:36:01 -06001741 CONFIG_SOFT_I2C_READ_REPEATED_START
1742
1743 defining this will force the i2c_read() function in
1744 the soft_i2c driver to perform an I2C repeated start
1745 between writing the address pointer and reading the
1746 data. If this define is omitted the default behaviour
1747 of doing a stop-start sequence will be used. Most I2C
1748 devices can use either method, but some require one or
1749 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001750
wdenkc6097192002-11-03 00:24:07 +00001751- SPI Support: CONFIG_SPI
1752
1753 Enables SPI driver (so far only tested with
1754 SPI EEPROM, also an instance works with Crystal A/D and
1755 D/As on the SACSng board)
1756
wdenkc6097192002-11-03 00:24:07 +00001757 CONFIG_SOFT_SPI
1758
wdenk43d96162003-03-06 00:02:04 +00001759 Enables a software (bit-bang) SPI driver rather than
1760 using hardware support. This is a general purpose
1761 driver that only requires three general I/O port pins
1762 (two outputs, one input) to function. If this is
1763 defined, the board configuration must define several
1764 SPI configuration items (port pins to use, etc). For
1765 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001766
Heiko Schocherf659b572014-07-14 10:22:11 +02001767 CONFIG_SYS_SPI_MXC_WAIT
1768 Timeout for waiting until spi transfer completed.
1769 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1770
Matthias Fuchs01335022007-12-27 17:12:34 +01001771- FPGA Support: CONFIG_FPGA
1772
1773 Enables FPGA subsystem.
1774
1775 CONFIG_FPGA_<vendor>
1776
1777 Enables support for specific chip vendors.
1778 (ALTERA, XILINX)
1779
1780 CONFIG_FPGA_<family>
1781
1782 Enables support for FPGA family.
1783 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1784
1785 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001786
wdenk43d96162003-03-06 00:02:04 +00001787 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001789 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001790
wdenk8bde7f72003-06-27 21:31:46 +00001791 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001793 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001794
wdenk43d96162003-03-06 00:02:04 +00001795 Enable checks on FPGA configuration interface busy
1796 status by the configuration function. This option
1797 will require a board or device specific function to
1798 be written.
wdenkc6097192002-11-03 00:24:07 +00001799
1800 CONFIG_FPGA_DELAY
1801
1802 If defined, a function that provides delays in the FPGA
1803 configuration driver.
1804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001805 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001806 Allow Control-C to interrupt FPGA configuration
1807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001808 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001809
wdenk43d96162003-03-06 00:02:04 +00001810 Check for configuration errors during FPGA bitfile
1811 loading. For example, abort during Virtex II
1812 configuration if the INIT_B line goes low (which
1813 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001814
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001815 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001816
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001817 Maximum time to wait for the INIT_B line to de-assert
1818 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00001819 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001820 ms.
wdenkc6097192002-11-03 00:24:07 +00001821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001822 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001823
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001824 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001825 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001827 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001828
wdenk43d96162003-03-06 00:02:04 +00001829 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001830 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001831
1832- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02001833
wdenkc6097192002-11-03 00:24:07 +00001834 CONFIG_IDENT_STRING
1835
wdenk43d96162003-03-06 00:02:04 +00001836 If defined, this string will be added to the U-Boot
1837 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001838
1839- Vendor Parameter Protection:
1840
wdenk43d96162003-03-06 00:02:04 +00001841 U-Boot considers the values of the environment
1842 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001843 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001844 are set once by the board vendor / manufacturer, and
1845 protects these variables from casual modification by
1846 the user. Once set, these variables are read-only,
1847 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001848 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001849
1850 If CONFIG_ENV_OVERWRITE is #defined in your config
1851 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001852 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001853 these parameters.
1854
Joe Hershberger92ac5202015-05-04 14:55:14 -05001855 Alternatively, if you define _both_ an ethaddr in the
1856 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001857 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001858 which can be changed exactly ONCE by the user. [The
1859 serial# is unaffected by this, i. e. it remains
1860 read-only.]
1861
Joe Hershberger25980902012-12-11 22:16:31 -06001862 The same can be accomplished in a more flexible way
1863 for any variable by configuring the type of access
1864 to allow for those variables in the ".flags" variable
1865 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1866
wdenkc6097192002-11-03 00:24:07 +00001867- Protected RAM:
1868 CONFIG_PRAM
1869
1870 Define this variable to enable the reservation of
1871 "protected RAM", i. e. RAM which is not overwritten
1872 by U-Boot. Define CONFIG_PRAM to hold the number of
1873 kB you want to reserve for pRAM. You can overwrite
1874 this default value by defining an environment
1875 variable "pram" to the number of kB you want to
1876 reserve. Note that the board info structure will
1877 still show the full amount of RAM. If pRAM is
1878 reserved, a new environment variable "mem" will
1879 automatically be defined to hold the amount of
1880 remaining RAM in a form that can be passed as boot
1881 argument to Linux, for instance like that:
1882
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001883 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001884 saveenv
1885
1886 This way you can tell Linux not to use this memory,
1887 either, which results in a memory region that will
1888 not be affected by reboots.
1889
1890 *WARNING* If your board configuration uses automatic
1891 detection of the RAM size, you must make sure that
1892 this memory test is non-destructive. So far, the
1893 following board configurations are known to be
1894 "pRAM-clean":
1895
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001896 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00001897 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02001898 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001899
Gabe Black40fef042012-12-02 04:55:18 +00001900- Access to physical memory region (> 4GB)
1901 Some basic support is provided for operations on memory not
1902 normally accessible to U-Boot - e.g. some architectures
1903 support access to more than 4GB of memory on 32-bit
1904 machines using physical address extension or similar.
1905 Define CONFIG_PHYSMEM to access this basic support, which
1906 currently only supports clearing the memory.
1907
wdenkc6097192002-11-03 00:24:07 +00001908- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001909 CONFIG_NET_RETRY_COUNT
1910
wdenk43d96162003-03-06 00:02:04 +00001911 This variable defines the number of retries for
1912 network operations like ARP, RARP, TFTP, or BOOTP
1913 before giving up the operation. If not defined, a
1914 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001915
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001916 CONFIG_ARP_TIMEOUT
1917
1918 Timeout waiting for an ARP reply in milliseconds.
1919
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00001920 CONFIG_NFS_TIMEOUT
1921
1922 Timeout in milliseconds used in NFS protocol.
1923 If you encounter "ERROR: Cannot umount" in nfs command,
1924 try longer timeout such as
1925 #define CONFIG_NFS_TIMEOUT 10000UL
1926
wdenkc6097192002-11-03 00:24:07 +00001927- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001928 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001929
1930 This defines the secondary prompt string, which is
1931 printed when the command interpreter needs more input
1932 to complete a command. Usually "> ".
1933
1934 Note:
1935
wdenk8bde7f72003-06-27 21:31:46 +00001936 In the current implementation, the local variables
1937 space and global environment variables space are
1938 separated. Local variables are those you define by
1939 simply typing `name=value'. To access a local
1940 variable later on, you have write `$name' or
1941 `${name}'; to execute the contents of a variable
1942 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001943
wdenk43d96162003-03-06 00:02:04 +00001944 Global environment variables are those you use
1945 setenv/printenv to work with. To run a command stored
1946 in such a variable, you need to use the run command,
1947 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001948
1949 To store commands and special characters in a
1950 variable, please use double quotation marks
1951 surrounding the whole text of the variable, instead
1952 of the backslashes before semicolons and special
1953 symbols.
1954
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001955- Command Line Editing and History:
Marek Vasutf3b267b2016-01-27 04:47:55 +01001956 CONFIG_CMDLINE_PS_SUPPORT
1957
1958 Enable support for changing the command prompt string
1959 at run-time. Only static string is supported so far.
1960 The string is obtained from environment variables PS1
1961 and PS2.
1962
wdenka8c7c702003-12-06 19:49:23 +00001963- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001964 CONFIG_EXTRA_ENV_SETTINGS
1965
wdenk43d96162003-03-06 00:02:04 +00001966 Define this to contain any number of null terminated
1967 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001968 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001969
wdenk43d96162003-03-06 00:02:04 +00001970 For example, place something like this in your
1971 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001972
1973 #define CONFIG_EXTRA_ENV_SETTINGS \
1974 "myvar1=value1\0" \
1975 "myvar2=value2\0"
1976
wdenk43d96162003-03-06 00:02:04 +00001977 Warning: This method is based on knowledge about the
1978 internal format how the environment is stored by the
1979 U-Boot code. This is NOT an official, exported
1980 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001981 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001982 You better know what you are doing here.
1983
wdenk43d96162003-03-06 00:02:04 +00001984 Note: overly (ab)use of the default environment is
1985 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001986 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001987 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001988
Simon Glass06fd8532012-11-30 13:01:17 +00001989 CONFIG_DELAY_ENVIRONMENT
1990
1991 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001992 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00001993 that so that the environment is not available until
1994 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1995 this is instead controlled by the value of
1996 /config/load-environment.
1997
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001998- TFTP Fixed UDP Port:
1999 CONFIG_TFTP_PORT
2000
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002001 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002002 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002003 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002004 number generator is used.
2005
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002006 Also, the environment variable tftpdstp is used to supply
2007 the TFTP UDP destination port value. If tftpdstp isn't
2008 defined, the normal port 69 is used.
2009
2010 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002011 blindly start the TFTP transfer using the pre-configured
2012 target IP address and UDP port. This has the effect of
2013 "punching through" the (Windows XP) firewall, allowing
2014 the remainder of the TFTP transfer to proceed normally.
2015 A better solution is to properly configure the firewall,
2016 but sometimes that is not allowed.
2017
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002018 CONFIG_STANDALONE_LOAD_ADDR
2019
Wolfgang Denk6feff892011-10-09 21:06:34 +02002020 This option defines a board specific value for the
2021 address where standalone program gets loaded, thus
2022 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002023 settings.
2024
2025- Frame Buffer Address:
2026 CONFIG_FB_ADDR
2027
2028 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002029 address for frame buffer. This is typically the case
2030 when using a graphics controller has separate video
2031 memory. U-Boot will then place the frame buffer at
2032 the given address instead of dynamically reserving it
2033 in system RAM by calling lcd_setmem(), which grabs
2034 the memory for the frame buffer depending on the
2035 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002036
2037 Please see board_init_f function.
2038
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002039- Automatic software updates via TFTP server
2040 CONFIG_UPDATE_TFTP
2041 CONFIG_UPDATE_TFTP_CNT_MAX
2042 CONFIG_UPDATE_TFTP_MSEC_MAX
2043
2044 These options enable and control the auto-update feature;
2045 for a more detailed description refer to doc/README.update.
2046
2047- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02002048 CONFIG_MTD_UBI_WL_THRESHOLD
2049 This parameter defines the maximum difference between the highest
2050 erase counter value and the lowest erase counter value of eraseblocks
2051 of UBI devices. When this threshold is exceeded, UBI starts performing
2052 wear leveling by means of moving data from eraseblock with low erase
2053 counter to eraseblocks with high erase counter.
2054
2055 The default value should be OK for SLC NAND flashes, NOR flashes and
2056 other flashes which have eraseblock life-cycle 100000 or more.
2057 However, in case of MLC NAND flashes which typically have eraseblock
2058 life-cycle less than 10000, the threshold should be lessened (e.g.,
2059 to 128 or 256, although it does not have to be power of 2).
2060
2061 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002062
Heiko Schocherff94bc42014-06-24 10:10:04 +02002063 CONFIG_MTD_UBI_BEB_LIMIT
2064 This option specifies the maximum bad physical eraseblocks UBI
2065 expects on the MTD device (per 1024 eraseblocks). If the
2066 underlying flash does not admit of bad eraseblocks (e.g. NOR
2067 flash), this value is ignored.
2068
2069 NAND datasheets often specify the minimum and maximum NVM
2070 (Number of Valid Blocks) for the flashes' endurance lifetime.
2071 The maximum expected bad eraseblocks per 1024 eraseblocks
2072 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2073 which gives 20 for most NANDs (MaxNVB is basically the total
2074 count of eraseblocks on the chip).
2075
2076 To put it differently, if this value is 20, UBI will try to
2077 reserve about 1.9% of physical eraseblocks for bad blocks
2078 handling. And that will be 1.9% of eraseblocks on the entire
2079 NAND chip, not just the MTD partition UBI attaches. This means
2080 that if you have, say, a NAND flash chip admits maximum 40 bad
2081 eraseblocks, and it is split on two MTD partitions of the same
2082 size, UBI will reserve 40 eraseblocks when attaching a
2083 partition.
2084
2085 default: 20
2086
2087 CONFIG_MTD_UBI_FASTMAP
2088 Fastmap is a mechanism which allows attaching an UBI device
2089 in nearly constant time. Instead of scanning the whole MTD device it
2090 only has to locate a checkpoint (called fastmap) on the device.
2091 The on-flash fastmap contains all information needed to attach
2092 the device. Using fastmap makes only sense on large devices where
2093 attaching by scanning takes long. UBI will not automatically install
2094 a fastmap on old images, but you can set the UBI parameter
2095 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2096 that fastmap-enabled images are still usable with UBI implementations
2097 without fastmap support. On typical flash devices the whole fastmap
2098 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2099
2100 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2101 Set this parameter to enable fastmap automatically on images
2102 without a fastmap.
2103 default: 0
2104
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002105 CONFIG_MTD_UBI_FM_DEBUG
2106 Enable UBI fastmap debug
2107 default: 0
2108
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002109- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002110 CONFIG_SPL
2111 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002112
Tom Rini95579792012-02-14 07:29:40 +00002113 CONFIG_SPL_LDSCRIPT
2114 LDSCRIPT for linking the SPL binary.
2115
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002116 CONFIG_SPL_MAX_FOOTPRINT
2117 Maximum size in memory allocated to the SPL, BSS included.
2118 When defined, the linker checks that the actual memory
2119 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002120 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002121 must not be both defined at the same time.
2122
Tom Rini95579792012-02-14 07:29:40 +00002123 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002124 Maximum size of the SPL image (text, data, rodata, and
2125 linker lists sections), BSS excluded.
2126 When defined, the linker checks that the actual size does
2127 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002128
Scott Wood94a45bb2012-09-20 19:05:12 -05002129 CONFIG_SPL_RELOC_TEXT_BASE
2130 Address to relocate to. If unspecified, this is equal to
2131 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2132
Tom Rini95579792012-02-14 07:29:40 +00002133 CONFIG_SPL_BSS_START_ADDR
2134 Link address for the BSS within the SPL binary.
2135
2136 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002137 Maximum size in memory allocated to the SPL BSS.
2138 When defined, the linker checks that the actual memory used
2139 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002140 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002141 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002142
2143 CONFIG_SPL_STACK
2144 Adress of the start of the stack SPL will use
2145
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002146 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2147 When defined, SPL will panic() if the image it has
2148 loaded does not have a signature.
2149 Defining this is useful when code which loads images
2150 in SPL cannot guarantee that absolutely all read errors
2151 will be caught.
2152 An example is the LPC32XX MLC NAND driver, which will
2153 consider that a completely unreadable NAND block is bad,
2154 and thus should be skipped silently.
2155
Scott Wood94a45bb2012-09-20 19:05:12 -05002156 CONFIG_SPL_RELOC_STACK
2157 Adress of the start of the stack SPL will use after
2158 relocation. If unspecified, this is equal to
2159 CONFIG_SPL_STACK.
2160
Tom Rini95579792012-02-14 07:29:40 +00002161 CONFIG_SYS_SPL_MALLOC_START
2162 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002163 When this option is set the full malloc is used in SPL and
2164 it is set up by spl_init() and before that, the simple malloc()
2165 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002166
2167 CONFIG_SYS_SPL_MALLOC_SIZE
2168 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002169
Tom Rini9607faf2014-03-28 12:03:39 -04002170 CONFIG_SPL_OS_BOOT
2171 Enable booting directly to an OS from SPL.
2172 See also: doc/README.falcon
2173
Tom Rini861a86f2012-08-13 11:37:56 -07002174 CONFIG_SPL_DISPLAY_PRINT
2175 For ARM, enable an optional function to print more information
2176 about the running system.
2177
Scott Wood4b919722012-09-20 16:35:21 -05002178 CONFIG_SPL_INIT_MINIMAL
2179 Arch init code should be built for a very small image
2180
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002181 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2182 Partition on the MMC to load U-Boot from when the MMC is being
2183 used in raw mode
2184
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002185 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2186 Sector to load kernel uImage from when MMC is being
2187 used in raw mode (for Falcon mode)
2188
2189 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2190 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2191 Sector and number of sectors to load kernel argument
2192 parameters from when MMC is being used in raw mode
2193 (for falcon mode)
2194
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002195 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2196 Filename to read to load U-Boot when reading from filesystem
2197
2198 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002199 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002200 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002201
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002202 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002203 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002204 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002205
Scott Wood06f60ae2012-12-06 13:33:17 +00002206 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2207 Set this for NAND SPL on PPC mpc83xx targets, so that
2208 start.S waits for the rest of the SPL to load before
2209 continuing (the hardware starts execution after just
2210 loading the first page rather than the full 4K).
2211
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302212 CONFIG_SPL_SKIP_RELOCATE
2213 Avoid SPL relocation
2214
Jörg Krause15e207f2018-01-14 19:26:38 +01002215 CONFIG_SPL_NAND_IDENT
2216 SPL uses the chip ID list to identify the NAND flash.
2217 Requires CONFIG_SPL_NAND_BASE.
2218
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002219 CONFIG_SPL_UBI
2220 Support for a lightweight UBI (fastmap) scanner and
2221 loader
2222
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002223 CONFIG_SPL_NAND_RAW_ONLY
2224 Support to boot only raw u-boot.bin images. Use this only
2225 if you need to save space.
2226
Ying Zhang7c8eea52013-08-16 15:16:12 +08002227 CONFIG_SPL_COMMON_INIT_DDR
2228 Set for common ddr init with serial presence detect in
2229 SPL binary.
2230
Tom Rini95579792012-02-14 07:29:40 +00002231 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2232 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2233 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2234 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2235 CONFIG_SYS_NAND_ECCBYTES
2236 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002237 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002238
2239 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002240 Location in NAND to read U-Boot from
2241
2242 CONFIG_SYS_NAND_U_BOOT_DST
2243 Location in memory to load U-Boot to
2244
2245 CONFIG_SYS_NAND_U_BOOT_SIZE
2246 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002247
2248 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002249 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002250
2251 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2252 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002253 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002254
Pavel Machekc57b9532012-08-30 22:42:11 +02002255 CONFIG_SPL_RAM_DEVICE
2256 Support for running image already present in ram, in SPL binary
2257
Scott Wood74752ba2012-12-06 13:33:16 +00002258 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002259 Image offset to which the SPL should be padded before appending
2260 the SPL payload. By default, this is defined as
2261 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2262 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2263 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002264
Scott Woodca2fca22012-09-21 16:27:32 -05002265 CONFIG_SPL_TARGET
2266 Final target image containing SPL and payload. Some SPLs
2267 use an arch-specific makefile fragment instead, for
2268 example if more than one image needs to be produced.
2269
Marek Vasutb527b9c2018-05-13 00:22:52 +02002270 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00002271 Printing information about a FIT image adds quite a bit of
2272 code to SPL. So this is normally disabled in SPL. Use this
2273 option to re-enable it. This will affect the output of the
2274 bootm command when booting a FIT image.
2275
Ying Zhang3aa29de2013-08-16 15:16:15 +08002276- TPL framework
2277 CONFIG_TPL
2278 Enable building of TPL globally.
2279
2280 CONFIG_TPL_PAD_TO
2281 Image offset to which the TPL should be padded before appending
2282 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002283 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2284 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2285 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002286
wdenka8c7c702003-12-06 19:49:23 +00002287- Interrupt support (PPC):
2288
wdenkd4ca31c2004-01-02 14:00:00 +00002289 There are common interrupt_init() and timer_interrupt()
2290 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002291 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002292 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002293 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002294 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002295 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002296 specific handling. If board has watchdog / status_led
2297 / other_activity_monitor it works automatically from
2298 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002299
wdenkc6097192002-11-03 00:24:07 +00002300
Helmut Raiger9660e442011-10-20 04:19:47 +00002301Board initialization settings:
2302------------------------------
2303
2304During Initialization u-boot calls a number of board specific functions
2305to allow the preparation of board specific prerequisites, e.g. pin setup
2306before drivers are initialized. To enable these callbacks the
2307following configuration macros have to be defined. Currently this is
2308architecture specific, so please check arch/your_architecture/lib/board.c
2309typically in board_init_f() and board_init_r().
2310
2311- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2312- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2313- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2314- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002315
wdenkc6097192002-11-03 00:24:07 +00002316Configuration Settings:
2317-----------------------
2318
Simon Glass4d979bf2019-12-28 10:45:10 -07002319- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun4d1fd7f2014-02-26 17:03:19 -08002320 Optionally it can be defined to support 64-bit memory commands.
2321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002323 undefine this when you're short of memory.
2324
Peter Tyser2fb26042009-01-27 18:03:12 -06002325- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2326 width of the commands listed in the 'help' command output.
2327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002328- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002329 prompt for user input.
2330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002331- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002333- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002338 the application (usually a Linux kernel) when it is
2339 booted
2340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002342 List of legal baudrate settings for this board.
2343
York Sune8149522015-12-04 11:57:07 -08002344- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002345 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002346 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2347 is substracted from total RAM and won't be reported to OS.
2348 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07002349 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08002350 the RAM base is not zero, or RAM is divided into banks,
2351 this variable needs to be recalcuated to get the address.
2352
York Sunaabd7dd2015-12-07 11:05:29 -08002353- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002354 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002355 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002356 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002357 fixing up gd->ram_size the Linux kernel should gets passed
2358 the now "corrected" memory size and won't touch it either.
2359 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002360 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002361 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002362 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002363
2364 This option can be used as a workaround for the 440EPx/GRx
2365 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2366 be touched.
2367
2368 WARNING: Please make sure that this value is a multiple of
2369 the Linux page size (normally 4k). If this is not the case,
2370 then the end address of the Linux memory will be located at a
2371 non page size aligned address and this could cause major
2372 problems.
2373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002374- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002375 Enable temporary baudrate change while serial download
2376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002377- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002378 Physical start address of SDRAM. _Must_ be 0 here.
2379
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002380- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002381 Physical start address of Flash memory.
2382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002383- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002384 Physical start address of boot monitor code (set by
2385 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002386 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002387 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002389- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002390 Size of memory reserved for monitor code, used to
2391 determine _at_compile_time_ (!) if the environment is
2392 embedded within the U-Boot image, or in a separate
2393 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002395- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002396 Size of DRAM reserved for malloc() use.
2397
Simon Glassd59476b2014-07-10 22:23:28 -06002398- CONFIG_SYS_MALLOC_F_LEN
2399 Size of the malloc() pool for use before relocation. If
2400 this is defined, then a very simple malloc() implementation
2401 will become available before relocation. The address is just
2402 below the global data, and the stack is moved down to make
2403 space.
2404
2405 This feature allocates regions with increasing addresses
2406 within the region. calloc() is supported, but realloc()
2407 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002408 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06002409 U-Boot relocates itself.
2410
Simon Glass38687ae2014-11-10 17:16:54 -07002411- CONFIG_SYS_MALLOC_SIMPLE
2412 Provides a simple and small malloc() and calloc() for those
2413 boards which do not use the full malloc in SPL (which is
2414 enabled with CONFIG_SYS_SPL_MALLOC_START).
2415
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07002416- CONFIG_SYS_NONCACHED_MEMORY:
2417 Size of non-cached memory area. This area of memory will be
2418 typically located right below the malloc() area and mapped
2419 uncached in the MMU. This is useful for drivers that would
2420 otherwise require a lot of explicit cache maintenance. For
2421 some drivers it's also impossible to properly maintain the
2422 cache. For example if the regions that need to be flushed
2423 are not a multiple of the cache-line size, *and* padding
2424 cannot be allocated between the regions to align them (i.e.
2425 if the HW requires a contiguous array of regions, and the
2426 size of each region is not cache-aligned), then a flush of
2427 one region may result in overwriting data that hardware has
2428 written to another region in the same cache-line. This can
2429 happen for example in network drivers where descriptors for
2430 buffers are typically smaller than the CPU cache-line (e.g.
2431 16 bytes vs. 32 or 64 bytes).
2432
2433 Non-cached memory is only supported on 32-bit ARM at present.
2434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002435- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002436 Normally compressed uImages are limited to an
2437 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002439 to adjust this setting to your needs.
2440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002441- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002442 Maximum size of memory mapped by the startup code of
2443 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002444 the Linux kernel (bd_info, boot arguments, FDT blob if
2445 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002446 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002447 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002448 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002449 variable "bootm_mapsize" will override the value of
2450 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2451 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002452
John Rigbyfca43cc2010-10-13 13:57:35 -06002453- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2454 Enable initrd_high functionality. If defined then the
2455 initrd_high feature is enabled and the bootm ramdisk subcommand
2456 is enabled.
2457
2458- CONFIG_SYS_BOOT_GET_CMDLINE:
2459 Enables allocating and saving kernel cmdline in space between
2460 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2461
2462- CONFIG_SYS_BOOT_GET_KBD:
2463 Enables allocating and saving a kernel copy of the bd_info in
2464 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002466- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002467 Max number of Flash memory banks
2468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002469- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002470 Max number of sectors on a Flash chip
2471
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002472- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002473 Timeout for Flash erase operations (in ms)
2474
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002475- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002476 Timeout for Flash write operations (in ms)
2477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002478- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002479 Timeout for Flash set sector lock bit operation (in ms)
2480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002482 Timeout for Flash clear lock bits operation (in ms)
2483
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002484- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002485 If defined, hardware flash sectors protection is used
2486 instead of U-Boot software protection.
2487
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002488- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002489
2490 Enable TFTP transfers directly to flash memory;
2491 without this option such a download has to be
2492 performed in two steps: (1) download to RAM, and (2)
2493 copy from RAM to flash.
2494
2495 The two-step approach is usually more reliable, since
2496 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002497 the flash, but in some situations (when system RAM is
2498 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002499 downloaded image) this option may be very useful.
2500
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002501- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002502 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002503 common flash structure for storing flash geometry.
2504
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002505- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002506 This option also enables the building of the cfi_flash driver
2507 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002508
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002509- CONFIG_FLASH_CFI_MTD
2510 This option enables the building of the cfi_mtd driver
2511 in the drivers directory. The driver exports CFI flash
2512 to the MTD layer.
2513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002514- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002515 Use buffered writes to flash.
2516
2517- CONFIG_FLASH_SPANSION_S29WS_N
2518 s29ws-n MirrorBit flash has non-standard addresses for buffered
2519 write commands.
2520
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002521- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002522 If this option is defined, the common CFI flash doesn't
2523 print it's warning upon not recognized FLASH banks. This
2524 is useful, if some of the configured banks are only
2525 optionally available.
2526
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002527- CONFIG_FLASH_SHOW_PROGRESS
2528 If defined (must be an integer), print out countdown
2529 digits and dots. Recommended value: 45 (9..1) for 80
2530 column displays, 15 (3..1) for 40 column displays.
2531
Stefan Roese352ef3f2013-04-04 15:53:14 +02002532- CONFIG_FLASH_VERIFY
2533 If defined, the content of the flash (destination) is compared
2534 against the source after the write operation. An error message
2535 will be printed when the contents are not identical.
2536 Please note that this option is useless in nearly all cases,
2537 since such flash programming errors usually are detected earlier
2538 while unprotecting/erasing/programming. Please only enable
2539 this option if you really know what you are doing.
2540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002541- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002542 Defines the number of Ethernet receive buffers. On some
2543 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002544 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2545 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002546 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002547 Defaults to 4 if not defined.
2548
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002549- CONFIG_ENV_MAX_ENTRIES
2550
Wolfgang Denk071bc922010-10-27 22:48:30 +02002551 Maximum number of entries in the hash table that is used
2552 internally to store the environment settings. The default
2553 setting is supposed to be generous and should work in most
2554 cases. This setting can be used to tune behaviour; see
2555 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002556
Joe Hershberger25980902012-12-11 22:16:31 -06002557- CONFIG_ENV_FLAGS_LIST_DEFAULT
2558- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04002559 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06002560 calling env set. Variables can be restricted to only decimal,
2561 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2562 the variables can also be restricted to IP address or MAC address.
2563
2564 The format of the list is:
2565 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002566 access_attribute = [a|r|o|c]
2567 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06002568 entry = variable_name[:attributes]
2569 list = entry[,list]
2570
2571 The type attributes are:
2572 s - String (default)
2573 d - Decimal
2574 x - Hexadecimal
2575 b - Boolean ([1yYtT|0nNfF])
2576 i - IP address
2577 m - MAC address
2578
Joe Hershberger267541f2012-12-11 22:16:34 -06002579 The access attributes are:
2580 a - Any (default)
2581 r - Read-only
2582 o - Write-once
2583 c - Change-default
2584
Joe Hershberger25980902012-12-11 22:16:31 -06002585 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2586 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002587 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06002588
2589 - CONFIG_ENV_FLAGS_LIST_STATIC
2590 Define this to a list (string) to define validation that
2591 should be done if an entry is not found in the ".flags"
2592 environment variable. To override a setting in the static
2593 list, simply add an entry for the same variable name to the
2594 ".flags" variable.
2595
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05002596 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2597 regular expression. This allows multiple variables to define the same
2598 flags without explicitly listing them for each variable.
2599
wdenkc6097192002-11-03 00:24:07 +00002600The following definitions that deal with the placement and management
2601of environment data (variable area); in general, we support the
2602following configurations:
2603
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002604- CONFIG_BUILD_ENVCRC:
2605
2606 Builds up envcrc with the target environment so that external utils
2607 may easily extract it and embed it in final U-Boot images.
2608
wdenkc6097192002-11-03 00:24:07 +00002609BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002610in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002611console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002612U-Boot will hang.
2613
2614Please note that even with NVRAM we still use a copy of the
2615environment in RAM: we could work on NVRAM directly, but we want to
2616keep settings there always unmodified except somebody uses "saveenv"
2617to save the current settings.
2618
Liu Gang0a85a9e2012-03-08 00:33:20 +00002619BE CAREFUL! For some special cases, the local device can not use
2620"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00002621environment stored in a remote NOR flash by SRIO or PCIE link,
2622but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00002623
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002624- CONFIG_NAND_ENV_DST
2625
2626 Defines address in RAM to which the nand_spl code should copy the
2627 environment. If redundant environment is used, it will be copied to
2628 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2629
Bruce Adlere881cb52007-11-02 13:15:42 -07002630Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002631has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06002632created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002633until then to read environment variables.
2634
wdenk85ec0bc2003-03-31 16:34:49 +00002635The environment is protected by a CRC32 checksum. Before the monitor
2636is relocated into RAM, as a result of a bad CRC you will be working
2637with the compiled-in default environment - *silently*!!! [This is
2638necessary, because the first environment variable we need is the
2639"baudrate" setting for the console - if we have a bad CRC, we don't
2640have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002641
2642Note: once the monitor has been relocated, then it will complain if
2643the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002644use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002645
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002646- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002647 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002648
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002649 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002650 also needs to be defined.
2651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002652- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002653 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002654
Ron Madridf5675aa2009-02-18 14:30:44 -08002655- CONFIG_NS16550_MIN_FUNCTIONS:
2656 Define this if you desire to only have use of the NS16550_init
2657 and NS16550_putc functions for the serial driver located at
2658 drivers/serial/ns16550.c. This option is useful for saving
2659 space for already greatly restricted images, including but not
2660 limited to NAND_SPL configurations.
2661
Simon Glassb2b92f52012-11-30 13:01:18 +00002662- CONFIG_DISPLAY_BOARDINFO
2663 Display information about the board that U-Boot is running on
2664 when U-Boot starts up. The board function checkboard() is called
2665 to do this.
2666
Simon Glasse2e3e2b2012-11-30 13:01:19 +00002667- CONFIG_DISPLAY_BOARDINFO_LATE
2668 Similar to the previous option, but display this information
2669 later, once stdio is running and output goes to the LCD, if
2670 present.
2671
Sascha Silbefeb85802013-08-11 16:40:43 +02002672- CONFIG_BOARD_SIZE_LIMIT:
2673 Maximum size of the U-Boot image. When defined, the
2674 build system checks that the actual size does not
2675 exceed it.
2676
wdenkc6097192002-11-03 00:24:07 +00002677Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002678---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002681 Cache Line Size of the CPU.
2682
Timur Tabie46fedf2011-08-04 18:03:41 -05002683- CONFIG_SYS_CCSRBAR_DEFAULT:
2684 Default (power-on reset) physical address of CCSR on Freescale
2685 PowerPC SOCs.
2686
2687- CONFIG_SYS_CCSRBAR:
2688 Virtual address of CCSR. On a 32-bit build, this is typically
2689 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2690
Timur Tabie46fedf2011-08-04 18:03:41 -05002691- CONFIG_SYS_CCSRBAR_PHYS:
2692 Physical address of CCSR. CCSR can be relocated to a new
2693 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002694 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05002695 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2696 is typically relocated on 36-bit builds. It is recommended
2697 that this macro be defined via the _HIGH and _LOW macros:
2698
2699 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2700 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2701
2702- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002703 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2704 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002705 used in assembly code, so it must not contain typecasts or
2706 integer size suffixes (e.g. "ULL").
2707
2708- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2709 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2710 used in assembly code, so it must not contain typecasts or
2711 integer size suffixes (e.g. "ULL").
2712
2713- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2714 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2715 forced to a value that ensures that CCSR is not relocated.
2716
Macpaul Lin0abddf82011-04-11 20:45:32 +00002717- CONFIG_IDE_AHB:
2718 Most IDE controllers were designed to be connected with PCI
2719 interface. Only few of them were designed for AHB interface.
2720 When software is doing ATA command and data transfer to
2721 IDE devices through IDE-AHB controller, some additional
2722 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002723 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00002724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002726 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02002727 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002730
wdenk7152b1d2003-09-05 23:19:14 +00002731 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002732 initial data and stack; please note that this must be
2733 writable memory that is working WITHOUT special
2734 initialization, i. e. you CANNOT use normal RAM which
2735 will become available only after programming the
2736 memory controller and running certain initialization
2737 sequences.
2738
2739 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02002740 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002742- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002743
2744 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002745 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2746 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002747 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002748 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06002749 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2751 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002752
2753 Note:
2754 On the MPC824X (or other systems that use the data
2755 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002757 point to an otherwise UNUSED address space between
2758 the top of RAM and the start of the PCI space.
2759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002760- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002762- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002763 SDRAM timing
2764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002766 periodic timer for refresh
2767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002768- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2769 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2770 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2771 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002772 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2773
2774- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002775 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2776 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002777 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2778
Andrew Sharp69fd2d32012-08-29 14:16:32 +00002779- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002780 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00002781 Don't do any setup work, presumably because someone or
2782 something has already done it, and we don't need to do it
2783 a second time. Useful for platforms that are pre-booted
2784 by coreboot or similar.
2785
Gabor Juhos842033e2013-05-30 07:06:12 +00002786- CONFIG_PCI_INDIRECT_BRIDGE:
2787 Enable support for indirect PCI bridges.
2788
Kumar Galaa09b9b62010-12-30 12:09:53 -06002789- CONFIG_SYS_SRIO:
2790 Chip has SRIO or not
2791
2792- CONFIG_SRIO1:
2793 Board has SRIO 1 port available
2794
2795- CONFIG_SRIO2:
2796 Board has SRIO 2 port available
2797
Liu Gangc8b28152013-05-07 16:30:46 +08002798- CONFIG_SRIO_PCIE_BOOT_MASTER
2799 Board can support master function for Boot from SRIO and PCIE
2800
Kumar Galaa09b9b62010-12-30 12:09:53 -06002801- CONFIG_SYS_SRIOn_MEM_VIRT:
2802 Virtual Address of SRIO port 'n' memory region
2803
Simon Glass62f9b652019-11-14 12:57:09 -07002804- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Galaa09b9b62010-12-30 12:09:53 -06002805 Physical Address of SRIO port 'n' memory region
2806
2807- CONFIG_SYS_SRIOn_MEM_SIZE:
2808 Size of SRIO port 'n' memory region
2809
Fabio Estevam66bd1842013-04-11 09:35:34 +00002810- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2811 Defined to tell the NAND controller that the NAND chip is using
2812 a 16 bit bus.
2813 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00002814 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02002815 - drivers/mtd/nand/raw/ndfc.c
2816 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04002817
2818- CONFIG_SYS_NDFC_EBC0_CFG
2819 Sets the EBC0_CFG register for the NDFC. If not defined
2820 a default value will be used.
2821
Ben Warrenbb99ad62006-09-07 16:50:54 -04002822- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002823 Get DDR timing information from an I2C EEPROM. Common
2824 with pluggable memory modules such as SODIMMs
2825
Ben Warrenbb99ad62006-09-07 16:50:54 -04002826 SPD_EEPROM_ADDRESS
2827 I2C address of the SPD EEPROM
2828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002830 If SPD EEPROM is on an I2C bus other than the first
2831 one, specify here. Note that the value must resolve
2832 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002833
York Sun1b3e3c42011-06-07 09:42:16 +08002834- CONFIG_SYS_DDR_RAW_TIMING
2835 Get DDR timing information from other than SPD. Common with
2836 soldered DDR chips onboard without SPD. DDR raw timing
2837 parameters are extracted from datasheet and hard-coded into
2838 header files or board specific files.
2839
York Sun6f5e1dc2011-09-16 13:21:35 -07002840- CONFIG_FSL_DDR_INTERACTIVE
2841 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2842
York Sune32d59a2015-01-06 13:18:55 -08002843- CONFIG_FSL_DDR_SYNC_REFRESH
2844 Enable sync of refresh for multiple controllers.
2845
York Sun4516ff82015-03-19 09:30:28 -07002846- CONFIG_FSL_DDR_BIST
2847 Enable built-in memory test for Freescale DDR controllers.
2848
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002849- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002850 Only for 83xx systems. If specified, then DDR should
2851 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002852
wdenkc26e4542004-04-18 10:13:26 +00002853- CONFIG_RMII
2854 Enable RMII mode for all FECs.
2855 Note that this is a global option, we can't
2856 have one FEC in standard MII mode and another in RMII mode.
2857
wdenk5cf91d62004-04-23 20:32:05 +00002858- CONFIG_CRC32_VERIFY
2859 Add a verify option to the crc32 command.
2860 The syntax is:
2861
2862 => crc32 -v <address> <count> <crc32>
2863
2864 Where address/count indicate a memory area
2865 and crc32 is the correct crc32 which the
2866 area should have.
2867
wdenk56523f12004-07-11 17:40:54 +00002868- CONFIG_LOOPW
2869 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06002870 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00002871
Joel Johnson72732312020-01-29 09:17:18 -07002872- CONFIG_CMD_MX_CYCLIC
stroese7b466642004-12-16 18:46:55 +00002873 Add the "mdc" and "mwc" memory commands. These are cyclic
2874 "md/mw" commands.
2875 Examples:
2876
wdenkefe2a4d2004-12-16 21:44:03 +00002877 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002878 This command will print 4 bytes (10,11,12,13) each 500 ms.
2879
wdenkefe2a4d2004-12-16 21:44:03 +00002880 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002881 This command will write 12345678 to address 100 all 10 ms.
2882
wdenkefe2a4d2004-12-16 21:44:03 +00002883 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06002884 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00002885
wdenk8aa1a2d2005-04-04 12:44:11 +00002886- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chen3fafced2017-12-26 13:55:59 +08002887 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002888 low level initializations (like setting up the memory
2889 controller) are omitted and/or U-Boot does not
2890 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002891
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002892 Normally this variable MUST NOT be defined. The only
2893 exception is when U-Boot is loaded (to RAM) by some
2894 other boot loader or by a debugger which performs
2895 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002896
Simon Glassb5bd0982016-05-05 07:28:06 -06002897- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
2898 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09002899 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06002900 instruction cache) is still performed.
2901
Aneesh V401bb302011-07-13 05:11:07 +00002902- CONFIG_SPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002903 Set when the currently-running compilation is for an artifact
2904 that will end up in the SPL (as opposed to the TPL or U-Boot
2905 proper). Code that needs stage-specific behavior should check
2906 this.
wdenk400558b2005-04-02 23:52:25 +00002907
Ying Zhang3aa29de2013-08-16 15:16:15 +08002908- CONFIG_TPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002909 Set when the currently-running compilation is for an artifact
2910 that will end up in the TPL (as opposed to the SPL or U-Boot
2911 proper). Code that needs stage-specific behavior should check
2912 this.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002913
Ying Zhang5df572f2013-05-20 14:07:23 +08002914- CONFIG_SYS_MPC85XX_NO_RESETVEC
2915 Only for 85xx systems. If this variable is specified, the section
2916 .resetvec is not kept and the section .bootpg is placed in the
2917 previous 4k of the .text section.
2918
Simon Glass4213fc22013-02-24 17:33:14 +00002919- CONFIG_ARCH_MAP_SYSMEM
2920 Generally U-Boot (and in particular the md command) uses
2921 effective address. It is therefore not necessary to regard
2922 U-Boot address as virtual addresses that need to be translated
2923 to physical addresses. However, sandbox requires this, since
2924 it maintains its own little RAM buffer which contains all
2925 addressable memory. This option causes some memory accesses
2926 to be mapped through map_sysmem() / unmap_sysmem().
2927
Simon Glass588a13f2013-02-14 04:18:54 +00002928- CONFIG_X86_RESET_VECTOR
2929 If defined, the x86 reset vector code is included. This is not
2930 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00002931
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002932- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2933 Option to disable subpage write in NAND driver
2934 driver that uses this:
Miquel Raynala430fa02018-08-16 17:30:07 +02002935 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002936
Timur Tabif2717b42011-11-22 09:21:25 -06002937Freescale QE/FMAN Firmware Support:
2938-----------------------------------
2939
2940The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2941loading of "firmware", which is encoded in the QE firmware binary format.
2942This firmware often needs to be loaded during U-Boot booting, so macros
2943are used to identify the storage device (NOR flash, SPI, etc) and the address
2944within that device.
2945
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002946- CONFIG_SYS_FMAN_FW_ADDR
2947 The address in the storage device where the FMAN microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002948 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002949 is also specified.
2950
2951- CONFIG_SYS_QE_FW_ADDR
2952 The address in the storage device where the QE microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002953 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabif2717b42011-11-22 09:21:25 -06002954 is also specified.
2955
2956- CONFIG_SYS_QE_FMAN_FW_LENGTH
2957 The maximum possible size of the firmware. The firmware binary format
2958 has a field that specifies the actual size of the firmware, but it
2959 might not be possible to read any part of the firmware unless some
2960 local storage is allocated to hold the entire firmware first.
2961
2962- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2963 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2964 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2965 virtual address in NOR flash.
2966
2967- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2968 Specifies that QE/FMAN firmware is located in NAND flash.
2969 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2970
2971- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2972 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2973 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2974
Liu Gang292dc6c2012-03-08 00:33:18 +00002975- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2976 Specifies that QE/FMAN firmware is located in the remote (master)
2977 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00002978 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2979 window->master inbound window->master LAW->the ucode address in
2980 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06002981
J. German Riverab940ca62014-06-23 15:15:55 -07002982Freescale Layerscape Management Complex Firmware Support:
2983---------------------------------------------------------
2984The Freescale Layerscape Management Complex (MC) supports the loading of
2985"firmware".
2986This firmware often needs to be loaded during U-Boot booting, so macros
2987are used to identify the storage device (NOR flash, SPI, etc) and the address
2988within that device.
2989
2990- CONFIG_FSL_MC_ENET
2991 Enable the MC driver for Layerscape SoCs.
2992
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05302993Freescale Layerscape Debug Server Support:
2994-------------------------------------------
2995The Freescale Layerscape Debug Server Support supports the loading of
2996"Debug Server firmware" and triggering SP boot-rom.
2997This firmware often needs to be loaded during U-Boot booting.
2998
York Sunc0492142015-12-07 11:08:58 -08002999- CONFIG_SYS_MC_RSV_MEM_ALIGN
3000 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303001
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003002Reproducible builds
3003-------------------
3004
3005In order to achieve reproducible builds, timestamps used in the U-Boot build
3006process have to be set to a fixed value.
3007
3008This is done using the SOURCE_DATE_EPOCH environment variable.
3009SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3010option for U-Boot or an environment variable in U-Boot.
3011
3012SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3013
wdenkc6097192002-11-03 00:24:07 +00003014Building the Software:
3015======================
3016
Wolfgang Denk218ca722008-03-26 10:40:12 +01003017Building U-Boot has been tested in several native build environments
3018and in many different cross environments. Of course we cannot support
3019all possibly existing versions of cross development tools in all
3020(potentially obsolete) versions. In case of tool chain problems we
3021recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3022which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003023
Wolfgang Denk218ca722008-03-26 10:40:12 +01003024If you are not using a native environment, it is assumed that you
3025have GNU cross compiling tools available in your path. In this case,
3026you must set the environment variable CROSS_COMPILE in your shell.
3027Note that no changes to the Makefile or any other source files are
3028necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003029
Wolfgang Denk218ca722008-03-26 10:40:12 +01003030 $ CROSS_COMPILE=ppc_4xx-
3031 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003032
Wolfgang Denk218ca722008-03-26 10:40:12 +01003033U-Boot is intended to be simple to build. After installing the
3034sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003035is done by typing:
3036
Holger Freytherab584d62014-08-04 09:26:05 +02003037 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003038
Holger Freytherab584d62014-08-04 09:26:05 +02003039where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01003040rations; see configs/*_defconfig for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003041
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01003042Note: for some boards special configuration names may exist; check if
wdenk2729af92004-05-03 20:45:30 +00003043 additional information is available from the board vendor; for
3044 instance, the TQM823L systems are available without (standard)
3045 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003046 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003047
Holger Freytherab584d62014-08-04 09:26:05 +02003048 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003049 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003050
Holger Freytherab584d62014-08-04 09:26:05 +02003051 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003052 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003053
wdenk2729af92004-05-03 20:45:30 +00003054 etc.
wdenkc6097192002-11-03 00:24:07 +00003055
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk2729af92004-05-03 20:45:30 +00003057Finally, type "make all", and you should get some working U-Boot
3058images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003059
wdenk2729af92004-05-03 20:45:30 +00003060- "u-boot.bin" is a raw binary image
3061- "u-boot" is an image in ELF binary format
3062- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003063
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003064By default the build is performed locally and the objects are saved
3065in the source directory. One of the two methods can be used to change
3066this behavior and build U-Boot to some external directory:
3067
30681. Add O= to the make command line invocations:
3069
3070 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003071 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003072 make O=/tmp/build all
3073
Timo Ketolaadbba992014-11-06 14:39:05 +020030742. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003075
Timo Ketolaadbba992014-11-06 14:39:05 +02003076 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003077 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003078 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003079 make all
3080
Timo Ketolaadbba992014-11-06 14:39:05 +02003081Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003082variable.
3083
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01003084User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3085setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3086For example to treat all compiler warnings as errors:
3087
3088 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003089
wdenk2729af92004-05-03 20:45:30 +00003090Please be aware that the Makefiles assume you are using GNU make, so
3091for instance on NetBSD you might need to use "gmake" instead of
3092native "make".
wdenkc6097192002-11-03 00:24:07 +00003093
wdenkc6097192002-11-03 00:24:07 +00003094
wdenk2729af92004-05-03 20:45:30 +00003095If the system board that you have is not listed, then you will need
3096to port U-Boot to your hardware platform. To do this, follow these
3097steps:
wdenkc6097192002-11-03 00:24:07 +00003098
Phil Sutter3c1496c2015-12-25 14:41:18 +010030991. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003100 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003101 the "Makefile" and a "<board>.c".
31022. Create a new configuration file "include/configs/<board>.h" for
3103 your board.
wdenk2729af92004-05-03 20:45:30 +000031043. If you're porting U-Boot to a new CPU, then also create a new
3105 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020031064. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000031075. Type "make", and you should get a working "u-boot.srec" file
3108 to be installed on your target system.
31096. Debug and solve any problems that might arise.
3110 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003111
wdenkc6097192002-11-03 00:24:07 +00003112
wdenk2729af92004-05-03 20:45:30 +00003113Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3114==============================================================
wdenkc6097192002-11-03 00:24:07 +00003115
Wolfgang Denk218ca722008-03-26 10:40:12 +01003116If you have modified U-Boot sources (for instance added a new board
3117or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003118provide feedback to the other developers. The feedback normally takes
Thomas Hebb32f2ca22019-11-13 18:18:03 -08003119the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003120official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003121
Wolfgang Denk218ca722008-03-26 10:40:12 +01003122But before you submit such a patch, please verify that your modifi-
3123cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003124the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003125just run the buildman script (tools/buildman/buildman), which will
3126configure and build U-Boot for ALL supported system. Be warned, this
3127will take a while. Please see the buildman README, or run 'buildman -H'
3128for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003129
3130
wdenk2729af92004-05-03 20:45:30 +00003131See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003132
wdenkc6097192002-11-03 00:24:07 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134Monitor Commands - Overview:
3135============================
wdenkc6097192002-11-03 00:24:07 +00003136
wdenk2729af92004-05-03 20:45:30 +00003137go - start application at address 'addr'
3138run - run commands in an environment variable
3139bootm - boot application image from memory
3140bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003141bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003142tftpboot- boot image via network using TFTP protocol
3143 and env variables "ipaddr" and "serverip"
3144 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003145tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003146rarpboot- boot image via network using RARP/TFTP protocol
3147diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3148loads - load S-Record file over serial line
3149loadb - load binary file over serial line (kermit mode)
3150md - memory display
3151mm - memory modify (auto-incrementing)
3152nm - memory modify (constant address)
3153mw - memory write (fill)
Simon Glassbdded202020-06-02 19:26:49 -06003154ms - memory search
wdenk2729af92004-05-03 20:45:30 +00003155cp - memory copy
3156cmp - memory compare
3157crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003158i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003159sspi - SPI utility commands
3160base - print or set address offset
3161printenv- print environment variables
3162setenv - set environment variables
3163saveenv - save environment variables to persistent storage
3164protect - enable or disable FLASH write protection
3165erase - erase FLASH memory
3166flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003167nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003168bdinfo - print Board Info structure
3169iminfo - print header information for application image
3170coninfo - print console devices and informations
3171ide - IDE sub-system
3172loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003173loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003174mtest - simple RAM test
3175icache - enable or disable instruction cache
3176dcache - enable or disable data cache
3177reset - Perform RESET of the CPU
3178echo - echo args to console
3179version - print monitor version
3180help - print online help
3181? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003182
wdenkc6097192002-11-03 00:24:07 +00003183
wdenk2729af92004-05-03 20:45:30 +00003184Monitor Commands - Detailed Description:
3185========================================
wdenkc6097192002-11-03 00:24:07 +00003186
wdenk2729af92004-05-03 20:45:30 +00003187TODO.
wdenkc6097192002-11-03 00:24:07 +00003188
wdenk2729af92004-05-03 20:45:30 +00003189For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003190
3191
wdenk2729af92004-05-03 20:45:30 +00003192Environment Variables:
3193======================
wdenkc6097192002-11-03 00:24:07 +00003194
wdenk2729af92004-05-03 20:45:30 +00003195U-Boot supports user configuration using Environment Variables which
3196can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198Environment Variables are set using "setenv", printed using
3199"printenv", and saved to Flash using "saveenv". Using "setenv"
3200without a value can be used to delete a variable from the
3201environment. As long as you don't save the environment you are
3202working with an in-memory copy. In case the Flash area containing the
3203environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003204
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003205Some configuration options can be set using Environment Variables.
3206
3207List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk2729af92004-05-03 20:45:30 +00003211 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003212
wdenk2729af92004-05-03 20:45:30 +00003213 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk2729af92004-05-03 20:45:30 +00003215 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003216
wdenk2729af92004-05-03 20:45:30 +00003217 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003218
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003219 bootm_low - Memory range available for image processing in the bootm
3220 command can be restricted. This variable is given as
3221 a hexadecimal number and defines lowest address allowed
3222 for use by the bootm command. See also "bootm_size"
3223 environment variable. Address defined by "bootm_low" is
3224 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003225 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3226 bootm_mapsize.
3227
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003228 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003229 This variable is given as a hexadecimal number and it
3230 defines the size of the memory region starting at base
3231 address bootm_low that is accessible by the Linux kernel
3232 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3233 as the default value if it is defined, and bootm_size is
3234 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003235
3236 bootm_size - Memory range available for image processing in the bootm
3237 command can be restricted. This variable is given as
3238 a hexadecimal number and defines the size of the region
3239 allowed for use by the bootm command. See also "bootm_low"
3240 environment variable.
3241
Simon Glass88fa4be2019-07-20 20:51:17 -06003242 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3243
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003244 updatefile - Location of the software update file on a TFTP server, used
3245 by the automatic software update feature. Please refer to
3246 documentation in doc/README.update for more details.
3247
wdenk2729af92004-05-03 20:45:30 +00003248 autoload - if set to "no" (any string beginning with 'n'),
3249 "bootp" will just load perform a lookup of the
3250 configuration from the BOOTP server, but not try to
3251 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253 autostart - if set to "yes", an image loaded using the "bootp",
3254 "rarpboot", "tftpboot" or "diskboot" commands will
3255 be automatically started (by internally calling
3256 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003257
wdenk2729af92004-05-03 20:45:30 +00003258 If set to "no", a standalone image passed to the
3259 "bootm" command will be copied to the load address
3260 (and eventually uncompressed), but NOT be started.
3261 This can be used to load and uncompress arbitrary
3262 data.
wdenkc6097192002-11-03 00:24:07 +00003263
David A. Longa28afca2011-07-09 16:40:19 -04003264 fdt_high - if set this restricts the maximum address that the
3265 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003266 For example, if you have a system with 1 GB memory
3267 at physical address 0x10000000, while Linux kernel
3268 only recognizes the first 704 MB as low memory, you
3269 may need to set fdt_high as 0x3C000000 to have the
3270 device tree blob be copied to the maximum address
3271 of the 704 MB low memory, so that Linux kernel can
3272 access it during the boot procedure.
3273
David A. Longa28afca2011-07-09 16:40:19 -04003274 If this is set to the special value 0xFFFFFFFF then
3275 the fdt will not be copied at all on boot. For this
3276 to work it must reside in writable memory, have
3277 sufficient padding on the end of it for u-boot to
3278 add the information it needs into it, and the memory
3279 must be accessible by the kernel.
3280
Simon Glasseea63e02011-10-24 19:15:34 +00003281 fdtcontroladdr- if set this is the address of the control flattened
3282 device tree used by U-Boot when CONFIG_OF_CONTROL is
3283 defined.
3284
wdenk17ea1172004-06-06 21:51:03 +00003285 i2cfast - (PPC405GP|PPC405EP only)
3286 if set to 'y' configures Linux I2C driver for fast
3287 mode (400kHZ). This environment variable is used in
3288 initialization code. So, for changes to be effective
3289 it must be saved and board must be reset.
3290
wdenk2729af92004-05-03 20:45:30 +00003291 initrd_high - restrict positioning of initrd images:
3292 If this variable is not set, initrd images will be
3293 copied to the highest possible address in RAM; this
3294 is usually what you want since it allows for
3295 maximum initrd size. If for some reason you want to
3296 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003297 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003298 variable to a value of "no" or "off" or "0".
3299 Alternatively, you can set it to a maximum upper
3300 address to use (U-Boot will still check that it
3301 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303 For instance, when you have a system with 16 MB
3304 RAM, and want to reserve 4 MB from use by Linux,
3305 you can do this by adding "mem=12M" to the value of
3306 the "bootargs" variable. However, now you must make
3307 sure that the initrd image is placed in the first
3308 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk2729af92004-05-03 20:45:30 +00003310 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312 If you set initrd_high to 0xFFFFFFFF, this is an
3313 indication to U-Boot that all addresses are legal
3314 for the Linux kernel, including addresses in flash
3315 memory. In this case U-Boot will NOT COPY the
3316 ramdisk at all. This may be useful to reduce the
3317 boot time on your system, but requires that this
3318 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk2729af92004-05-03 20:45:30 +00003322 loadaddr - Default load address for commands like "bootp",
3323 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk2729af92004-05-03 20:45:30 +00003325 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk2729af92004-05-03 20:45:30 +00003327 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk2729af92004-05-03 20:45:30 +00003333 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003334
Mike Frysingere2a53452011-10-02 10:01:27 +00003335 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003336
Mike Frysingere2a53452011-10-02 10:01:27 +00003337 ethact - controls which interface is currently active.
3338 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003339
Heiko Schocher48690d82010-07-20 17:45:02 +02003340 => setenv ethact FEC
3341 => ping 192.168.0.1 # traffic sent on FEC
3342 => setenv ethact SCC
3343 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003344
Matthias Fuchse1692572008-01-17 07:45:05 +01003345 ethrotate - When set to "no" U-Boot does not go through all
3346 available network interfaces.
3347 It just stays at the currently selected interface.
3348
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003349 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003350 either succeed or fail without retrying.
3351 When set to "once" the network operation will
3352 fail when all the available network interfaces
3353 are tried once without success.
3354 Useful on scripts which control the retry operation
3355 themselves.
wdenkc6097192002-11-03 00:24:07 +00003356
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003357 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003358
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003359 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07003360 changing the console to be empty. If "yes" it will be
3361 made silent. If "no" it will not be made silent. If
3362 unset, then it will be made silent if the U-Boot console
3363 is silent.
3364
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003365 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003366 UDP source port.
3367
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003368 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003369 destination port instead of the Well Know Port 69.
3370
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003371 tftpblocksize - Block size to use for TFTP transfers; if not set,
3372 we use the TFTP server's default block size
3373
3374 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3375 seconds, minimum value is 1000 = 1 second). Defines
3376 when a packet is considered to be lost so it has to
3377 be retransmitted. The default is 5000 = 5 seconds.
3378 Lowering this value may make downloads succeed
3379 faster in networks with high packet loss rates or
3380 with unreliable TFTP servers.
3381
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003382 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3383 unit, minimum value = 0). Defines how many timeouts
3384 can happen during a single file transfer before that
3385 transfer is aborted. The default is 10, and 0 means
3386 'no timeouts allowed'. Increasing this value may help
3387 downloads succeed with high packet loss rates, or with
3388 unreliable TFTP servers or client hardware.
3389
Ramon Friedcc6b87e2020-07-18 23:31:46 +03003390 tftpwindowsize - if this is set, the value is used for TFTP's
3391 window size as described by RFC 7440.
3392 This means the count of blocks we can receive before
3393 sending ack to server.
3394
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003395 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003396 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003397 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003398
Alexandre Messier50768f52016-02-01 17:08:57 -05003399 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3400 Unsigned value, in milliseconds. If not set, the period will
3401 be either the default (28000), or a value based on
3402 CONFIG_NET_RETRY_COUNT, if defined. This value has
3403 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3404
Simon Glassbdded202020-06-02 19:26:49 -06003405 memmatches - Number of matches found by the last 'ms' command, in hex
3406
3407 memaddr - Address of the last match found by the 'ms' command, in hex,
3408 or 0 if none
3409
3410 mempos - Index position of the last match found by the 'ms' command,
3411 in units of the size (.b, .w, .l) of the search
3412
Simon Glass126f47c2020-09-05 14:50:48 -06003413 zbootbase - (x86 only) Base address of the bzImage 'setup' block
3414
3415 zbootaddr - (x86 only) Address of the loaded bzImage, typically
3416 BZIMAGE_LOAD_ADDR which is 0x100000
Simon Glassbdded202020-06-02 19:26:49 -06003417
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003418The following image location variables contain the location of images
3419used in booting. The "Image" column gives the role of the image and is
3420not an environment variable name. The other columns are environment
3421variable names. "File Name" gives the name of the file on a TFTP
3422server, "RAM Address" gives the location in RAM the image will be
3423loaded to, and "Flash Location" gives the image's address in NOR
3424flash or offset in NAND flash.
3425
3426*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03003427boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003428boards use these variables for other purposes.
3429
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003430Image File Name RAM Address Flash Location
3431----- --------- ----------- --------------
3432u-boot u-boot u-boot_addr_r u-boot_addr
3433Linux kernel bootfile kernel_addr_r kernel_addr
3434device tree blob fdtfile fdt_addr_r fdt_addr
3435ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003436
wdenk2729af92004-05-03 20:45:30 +00003437The following environment variables may be used and automatically
3438updated by the network boot commands ("bootp" and "rarpboot"),
3439depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003440
wdenk2729af92004-05-03 20:45:30 +00003441 bootfile - see above
3442 dnsip - IP address of your Domain Name Server
3443 dnsip2 - IP address of your secondary Domain Name Server
3444 gatewayip - IP address of the Gateway (Router) to use
3445 hostname - Target hostname
3446 ipaddr - see above
3447 netmask - Subnet Mask
3448 rootpath - Pathname of the root filesystem on the NFS server
3449 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003450
wdenka3d991b2004-04-15 21:48:45 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454 serial# - contains hardware identification information such
3455 as type string and/or serial number
3456 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk2729af92004-05-03 20:45:30 +00003458These variables can be set only once (usually during manufacturing of
3459the board). U-Boot refuses to delete or overwrite these variables
3460once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003461
3462
wdenk2729af92004-05-03 20:45:30 +00003463Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465 ver - Contains the U-Boot version string as printed
3466 with the "version" command. This variable is
3467 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003468
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470Please note that changes to some configuration parameters may take
3471only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003472
stroesec1551ea2003-04-04 15:53:41 +00003473
Joe Hershberger170ab112012-12-11 22:16:24 -06003474Callback functions for environment variables:
3475---------------------------------------------
3476
3477For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003478when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06003479be associated with arbitrary variables. On creation, overwrite, or
3480deletion, the callback will provide the opportunity for some side
3481effect to happen or for the change to be rejected.
3482
3483The callbacks are named and associated with a function using the
3484U_BOOT_ENV_CALLBACK macro in your board or driver code.
3485
3486These callbacks are associated with variables in one of two ways. The
3487static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3488in the board configuration to a string that defines a list of
3489associations. The list must be in the following format:
3490
3491 entry = variable_name[:callback_name]
3492 list = entry[,list]
3493
3494If the callback name is not specified, then the callback is deleted.
3495Spaces are also allowed anywhere in the list.
3496
3497Callbacks can also be associated by defining the ".callbacks" variable
3498with the same list format above. Any association in ".callbacks" will
3499override any association in the static list. You can define
3500CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003501".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06003502
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003503If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3504regular expression. This allows multiple variables to be connected to
3505the same callback without explicitly listing them all out.
3506
Heinrich Schuchardt1b040472018-07-29 11:08:14 +02003507The signature of the callback functions is:
3508
3509 int callback(const char *name, const char *value, enum env_op op, int flags)
3510
3511* name - changed environment variable
3512* value - new value of the environment variable
3513* op - operation (create, overwrite, or delete)
3514* flags - attributes of the environment variable change, see flags H_* in
3515 include/search.h
3516
3517The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger170ab112012-12-11 22:16:24 -06003518
wdenk2729af92004-05-03 20:45:30 +00003519Command Line Parsing:
3520=====================
stroesec1551ea2003-04-04 15:53:41 +00003521
wdenk2729af92004-05-03 20:45:30 +00003522There are two different command line parsers available with U-Boot:
3523the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525Old, simple command line parser:
3526--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003527
wdenk2729af92004-05-03 20:45:30 +00003528- supports environment variables (through setenv / saveenv commands)
3529- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003530- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003531- special characters ('$', ';') can be escaped by prefixing with '\',
3532 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003533 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003534- You can also escape text by enclosing in single apostrophes, for example:
3535 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk2729af92004-05-03 20:45:30 +00003537Hush shell:
3538-----------
wdenkf07771c2003-05-28 08:06:31 +00003539
wdenk2729af92004-05-03 20:45:30 +00003540- similar to Bourne shell, with control structures like
3541 if...then...else...fi, for...do...done; while...do...done,
3542 until...do...done, ...
3543- supports environment ("global") variables (through setenv / saveenv
3544 commands) and local shell variables (through standard shell syntax
3545 "name=value"); only environment variables can be used with "run"
3546 command
wdenkf07771c2003-05-28 08:06:31 +00003547
wdenk2729af92004-05-03 20:45:30 +00003548General rules:
3549--------------
wdenkf07771c2003-05-28 08:06:31 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551(1) If a command line (or an environment variable executed by a "run"
3552 command) contains several commands separated by semicolon, and
3553 one of these commands fails, then the remaining commands will be
3554 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003557 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003558 command will cause "run" to terminate, i. e. the remaining
3559 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561Note for Redundant Ethernet Interfaces:
3562=======================================
wdenkf07771c2003-05-28 08:06:31 +00003563
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003564Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003565such configurations and is capable of automatic selection of a
3566"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3569MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3570"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572If the network interface stores some valid MAC address (for instance
3573in SROM), this is used as default address if there is NO correspon-
3574ding setting in the environment; if the corresponding environment
3575variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003576
wdenk2729af92004-05-03 20:45:30 +00003577o If the SROM has a valid MAC address, and there is no address in the
3578 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580o If there is no valid address in the SROM, and a definition in the
3581 environment exists, then the value from the environment variable is
3582 used.
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk2729af92004-05-03 20:45:30 +00003584o If both the SROM and the environment contain a MAC address, and
3585 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587o If both the SROM and the environment contain a MAC address, and the
3588 addresses differ, the value from the environment is used and a
3589 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05003592 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3593 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00003594
Ben Warrenecee9322010-04-26 11:11:46 -07003595If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003596will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003597may be skipped by setting the appropriate 'ethmacskip' environment variable.
3598The naming convention is as follows:
3599"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003600
wdenk2729af92004-05-03 20:45:30 +00003601Image Formats:
3602==============
wdenkc6097192002-11-03 00:24:07 +00003603
Marian Balakowicz3310c542008-03-12 12:13:13 +01003604U-Boot is capable of booting (and performing other auxiliary operations on)
3605images in two formats:
3606
3607New uImage format (FIT)
3608-----------------------
3609
3610Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3611to Flattened Device Tree). It allows the use of images with multiple
3612components (several kernels, ramdisks, etc.), with contents protected by
3613SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3614
3615
3616Old uImage format
3617-----------------
3618
3619Old image format is based on binary files which can be basically anything,
3620preceded by a special header; see the definitions in include/image.h for
3621details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk2729af92004-05-03 20:45:30 +00003623* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3624 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003625 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3626 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3627 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003628* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003629 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03003630 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003631* Compression Type (uncompressed, gzip, bzip2)
3632* Load Address
3633* Entry Point
3634* Image Name
3635* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003636
wdenk2729af92004-05-03 20:45:30 +00003637The header is marked by a special Magic Number, and both the header
3638and the data portions of the image are secured against corruption by
3639CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003640
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk2729af92004-05-03 20:45:30 +00003642Linux Support:
3643==============
wdenkc6097192002-11-03 00:24:07 +00003644
wdenk2729af92004-05-03 20:45:30 +00003645Although U-Boot should support any OS or standalone application
3646easily, the main focus has always been on Linux during the design of
3647U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649U-Boot includes many features that so far have been part of some
3650special "boot loader" code within the Linux kernel. Also, any
3651"initrd" images to be used are no longer part of one big Linux image;
3652instead, kernel and "initrd" are separate images. This implementation
3653serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003654
wdenk2729af92004-05-03 20:45:30 +00003655- the same features can be used for other OS or standalone
3656 applications (for instance: using compressed images to reduce the
3657 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659- it becomes much easier to port new Linux kernel versions because
3660 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662- the same Linux kernel image can now be used with different "initrd"
3663 images; of course this also means that different kernel images can
3664 be run with the same "initrd". This makes testing easier (you don't
3665 have to build a new "zImage.initrd" Linux image when you just
3666 change a file in your "initrd"). Also, a field-upgrade of the
3667 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003668
wdenkc6097192002-11-03 00:24:07 +00003669
wdenk2729af92004-05-03 20:45:30 +00003670Linux HOWTO:
3671============
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673Porting Linux to U-Boot based systems:
3674---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676U-Boot cannot save you from doing all the necessary modifications to
3677configure the Linux device drivers for use with your target hardware
3678(no, we don't intend to provide a full virtual machine interface to
3679Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003680
Stefan Roesea47a12b2010-04-15 16:07:28 +02003681But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003682
wdenk2729af92004-05-03 20:45:30 +00003683Just make sure your machine specific header file (for instance
3684include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003685Information structure as we define in include/asm-<arch>/u-boot.h,
3686and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003687as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003688
Simon Glass2eb31b12014-06-11 23:29:46 -06003689Note that U-Boot now has a driver model, a unified model for drivers.
3690If you are adding a new driver, plumb it into driver model. If there
3691is no uclass available, you are encouraged to create one. See
3692doc/driver-model.
3693
wdenkc6097192002-11-03 00:24:07 +00003694
wdenk2729af92004-05-03 20:45:30 +00003695Configuring the Linux kernel:
3696-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698No specific requirements for U-Boot. Make sure you have some root
3699device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003700
wdenkc6097192002-11-03 00:24:07 +00003701
wdenk2729af92004-05-03 20:45:30 +00003702Building a Linux Image:
3703-----------------------
wdenkc6097192002-11-03 00:24:07 +00003704
wdenk2729af92004-05-03 20:45:30 +00003705With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3706not used. If you use recent kernel source, a new build target
3707"uImage" will exist which automatically builds an image usable by
3708U-Boot. Most older kernels also have support for a "pImage" target,
3709which was introduced for our predecessor project PPCBoot and uses a
3710100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003711
wdenk2729af92004-05-03 20:45:30 +00003712Example:
wdenkc6097192002-11-03 00:24:07 +00003713
Holger Freytherab584d62014-08-04 09:26:05 +02003714 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003715 make oldconfig
3716 make dep
3717 make uImage
wdenkc6097192002-11-03 00:24:07 +00003718
wdenk2729af92004-05-03 20:45:30 +00003719The "uImage" build target uses a special tool (in 'tools/mkimage') to
3720encapsulate a compressed Linux kernel image with header information,
3721CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003722
wdenk2729af92004-05-03 20:45:30 +00003723* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003726
wdenk2729af92004-05-03 20:45:30 +00003727 ${CROSS_COMPILE}-objcopy -O binary \
3728 -R .note -R .comment \
3729 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk2729af92004-05-03 20:45:30 +00003731* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003732
wdenk2729af92004-05-03 20:45:30 +00003733 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737 mkimage -A ppc -O linux -T kernel -C gzip \
3738 -a 0 -e 0 -n "Linux Kernel Image" \
3739 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003740
wdenk24ee89b2002-11-03 17:56:27 +00003741
wdenk2729af92004-05-03 20:45:30 +00003742The "mkimage" tool can also be used to create ramdisk images for use
3743with U-Boot, either separated from the Linux kernel image, or
3744combined into one file. "mkimage" encapsulates the images with a 64
3745byte header containing information about target architecture,
3746operating system, image type, compression method, entry points, time
3747stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749"mkimage" can be called in two ways: to verify existing images and
3750print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752In the first form (with "-l" option) mkimage lists the information
3753contained in the header of an existing U-Boot image; this includes
3754checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756 tools/mkimage -l image
3757 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759The second form (with "-d" option) is used to build a U-Boot image
3760from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003761
wdenk2729af92004-05-03 20:45:30 +00003762 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3763 -n name -d data_file image
3764 -A ==> set architecture to 'arch'
3765 -O ==> set operating system to 'os'
3766 -T ==> set image type to 'type'
3767 -C ==> set compression type 'comp'
3768 -a ==> set load address to 'addr' (hex)
3769 -e ==> set entry point to 'ep' (hex)
3770 -n ==> set image name to 'name'
3771 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003772
wdenk69459792004-05-29 16:53:29 +00003773Right now, all Linux kernels for PowerPC systems use the same load
3774address (0x00000000), but the entry point address depends on the
3775kernel version:
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk2729af92004-05-03 20:45:30 +00003777- 2.2.x kernels have the entry point at 0x0000000C,
3778- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk2729af92004-05-03 20:45:30 +00003780So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk2729af92004-05-03 20:45:30 +00003782 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3783 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003784 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003785 > examples/uImage.TQM850L
3786 Image Name: 2.4.4 kernel for TQM850L
3787 Created: Wed Jul 19 02:34:59 2000
3788 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3789 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3790 Load Address: 0x00000000
3791 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003792
wdenk2729af92004-05-03 20:45:30 +00003793To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795 -> tools/mkimage -l examples/uImage.TQM850L
3796 Image Name: 2.4.4 kernel for TQM850L
3797 Created: Wed Jul 19 02:34:59 2000
3798 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3799 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3800 Load Address: 0x00000000
3801 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003802
wdenk2729af92004-05-03 20:45:30 +00003803NOTE: for embedded systems where boot time is critical you can trade
3804speed for memory and install an UNCOMPRESSED image instead: this
3805needs more space in Flash, but boots much faster since it does not
3806need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003807
Stefan Roesea47a12b2010-04-15 16:07:28 +02003808 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003809 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3810 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003811 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003812 > examples/uImage.TQM850L-uncompressed
3813 Image Name: 2.4.4 kernel for TQM850L
3814 Created: Wed Jul 19 02:34:59 2000
3815 Image Type: PowerPC Linux Kernel Image (uncompressed)
3816 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3817 Load Address: 0x00000000
3818 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003819
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3822when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824 -> tools/mkimage -n 'Simple Ramdisk Image' \
3825 > -A ppc -O linux -T ramdisk -C gzip \
3826 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3827 Image Name: Simple Ramdisk Image
3828 Created: Wed Jan 12 14:01:50 2000
3829 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3830 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3831 Load Address: 0x00000000
3832 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003833
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07003834The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3835option performs the converse operation of the mkimage's second form (the "-d"
3836option). Given an image built by mkimage, the dumpimage extracts a "data file"
3837from the image:
3838
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02003839 tools/dumpimage -i image -T type -p position data_file
3840 -i ==> extract from the 'image' a specific 'data_file'
3841 -T ==> set image type to 'type'
3842 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07003843
wdenkdb01a2e2004-04-15 23:14:49 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845Installing a Linux Image:
3846-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848To downloading a U-Boot image over the serial (console) interface,
3849you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853The 'objcopy' does not understand the information in the U-Boot
3854image header, so the resulting S-Record file will be relative to
3855address 0x00000000. To load it to a given address, you need to
3856specify the target address as 'offset' parameter with the 'loads'
3857command.
wdenkc6097192002-11-03 00:24:07 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859Example: install the image to address 0x40100000 (which on the
3860TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003861
wdenk2729af92004-05-03 20:45:30 +00003862 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864 .......... done
3865 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk2729af92004-05-03 20:45:30 +00003867 => loads 40100000
3868 ## Ready for S-Record download ...
3869 ~>examples/image.srec
3870 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3871 ...
3872 15989 15990 15991 15992
3873 [file transfer complete]
3874 [connected]
3875 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003876
3877
wdenk2729af92004-05-03 20:45:30 +00003878You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003879this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003880corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884 ## Checking Image at 40100000 ...
3885 Image Name: 2.2.13 for initrd on TQM850L
3886 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3887 Data Size: 335725 Bytes = 327 kB = 0 MB
3888 Load Address: 00000000
3889 Entry Point: 0000000c
3890 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003891
3892
wdenk2729af92004-05-03 20:45:30 +00003893Boot Linux:
3894-----------
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896The "bootm" command is used to boot an application that is stored in
3897memory (RAM or Flash). In case of a Linux kernel image, the contents
3898of the "bootargs" environment variable is passed to the kernel as
3899parameters. You can check and modify this variable using the
3900"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003901
3902
wdenk2729af92004-05-03 20:45:30 +00003903 => printenv bootargs
3904 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906 => 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 +00003907
wdenk2729af92004-05-03 20:45:30 +00003908 => printenv bootargs
3909 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 +00003910
wdenk2729af92004-05-03 20:45:30 +00003911 => bootm 40020000
3912 ## Booting Linux kernel at 40020000 ...
3913 Image Name: 2.2.13 for NFS on TQM850L
3914 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3915 Data Size: 381681 Bytes = 372 kB = 0 MB
3916 Load Address: 00000000
3917 Entry Point: 0000000c
3918 Verifying Checksum ... OK
3919 Uncompressing Kernel Image ... OK
3920 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
3921 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3922 time_init: decrementer frequency = 187500000/60
3923 Calibrating delay loop... 49.77 BogoMIPS
3924 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3925 ...
wdenkc6097192002-11-03 00:24:07 +00003926
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003927If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003928the memory addresses of both the kernel and the initrd image (PPBCOOT
3929format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933 ## Checking Image at 40100000 ...
3934 Image Name: 2.2.13 for initrd on TQM850L
3935 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3936 Data Size: 335725 Bytes = 327 kB = 0 MB
3937 Load Address: 00000000
3938 Entry Point: 0000000c
3939 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 ## Checking Image at 40200000 ...
3942 Image Name: Simple Ramdisk Image
3943 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3944 Data Size: 566530 Bytes = 553 kB = 0 MB
3945 Load Address: 00000000
3946 Entry Point: 00000000
3947 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk2729af92004-05-03 20:45:30 +00003949 => bootm 40100000 40200000
3950 ## Booting Linux kernel at 40100000 ...
3951 Image Name: 2.2.13 for initrd on TQM850L
3952 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3953 Data Size: 335725 Bytes = 327 kB = 0 MB
3954 Load Address: 00000000
3955 Entry Point: 0000000c
3956 Verifying Checksum ... OK
3957 Uncompressing Kernel Image ... OK
3958 ## Loading RAMDisk Image at 40200000 ...
3959 Image Name: Simple Ramdisk Image
3960 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3961 Data Size: 566530 Bytes = 553 kB = 0 MB
3962 Load Address: 00000000
3963 Entry Point: 00000000
3964 Verifying Checksum ... OK
3965 Loading Ramdisk ... OK
3966 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
3967 Boot arguments: root=/dev/ram
3968 time_init: decrementer frequency = 187500000/60
3969 Calibrating delay loop... 49.77 BogoMIPS
3970 ...
3971 RAMDISK: Compressed image found at block 0
3972 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk2729af92004-05-03 20:45:30 +00003974 bash#
wdenkc6097192002-11-03 00:24:07 +00003975
Matthew McClintock02677682006-06-28 10:41:37 -05003976Boot Linux and pass a flat device tree:
3977-----------
3978
3979First, U-Boot must be compiled with the appropriate defines. See the section
3980titled "Linux Kernel Interface" above for a more in depth explanation. The
3981following is an example of how to start a kernel and pass an updated
3982flat device tree:
3983
3984=> print oftaddr
3985oftaddr=0x300000
3986=> print oft
3987oft=oftrees/mpc8540ads.dtb
3988=> tftp $oftaddr $oft
3989Speed: 1000, full duplex
3990Using TSEC0 device
3991TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3992Filename 'oftrees/mpc8540ads.dtb'.
3993Load address: 0x300000
3994Loading: #
3995done
3996Bytes transferred = 4106 (100a hex)
3997=> tftp $loadaddr $bootfile
3998Speed: 1000, full duplex
3999Using TSEC0 device
4000TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4001Filename 'uImage'.
4002Load address: 0x200000
4003Loading:############
4004done
4005Bytes transferred = 1029407 (fb51f hex)
4006=> print loadaddr
4007loadaddr=200000
4008=> print oftaddr
4009oftaddr=0x300000
4010=> bootm $loadaddr - $oftaddr
4011## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004012 Image Name: Linux-2.6.17-dirty
4013 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4014 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004015 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004016 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004017 Verifying Checksum ... OK
4018 Uncompressing Kernel Image ... OK
4019Booting using flat device tree at 0x300000
4020Using MPC85xx ADS machine description
4021Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4022[snip]
4023
4024
wdenk2729af92004-05-03 20:45:30 +00004025More About U-Boot Image Types:
4026------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004027
wdenk2729af92004-05-03 20:45:30 +00004028U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030 "Standalone Programs" are directly runnable in the environment
4031 provided by U-Boot; it is expected that (if they behave
4032 well) you can continue to work in U-Boot after return from
4033 the Standalone Program.
4034 "OS Kernel Images" are usually images of some Embedded OS which
4035 will take over control completely. Usually these programs
4036 will install their own set of exception handlers, device
4037 drivers, set up the MMU, etc. - this means, that you cannot
4038 expect to re-enter U-Boot except by resetting the CPU.
4039 "RAMDisk Images" are more or less just data blocks, and their
4040 parameters (address, size) are passed to an OS kernel that is
4041 being started.
4042 "Multi-File Images" contain several images, typically an OS
4043 (Linux) kernel image and one or more data images like
4044 RAMDisks. This construct is useful for instance when you want
4045 to boot over the network using BOOTP etc., where the boot
4046 server provides just a single image file, but you want to get
4047 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004048
wdenk2729af92004-05-03 20:45:30 +00004049 "Multi-File Images" start with a list of image sizes, each
4050 image size (in bytes) specified by an "uint32_t" in network
4051 byte order. This list is terminated by an "(uint32_t)0".
4052 Immediately after the terminating 0 follow the images, one by
4053 one, all aligned on "uint32_t" boundaries (size rounded up to
4054 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056 "Firmware Images" are binary images containing firmware (like
4057 U-Boot or FPGA images) which usually will be programmed to
4058 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004059
wdenk2729af92004-05-03 20:45:30 +00004060 "Script files" are command sequences that will be executed by
4061 U-Boot's command interpreter; this feature is especially
4062 useful when you configure U-Boot to use a real shell (hush)
4063 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004064
Marek Vasut44f074c2012-03-14 21:52:45 +00004065Booting the Linux zImage:
4066-------------------------
4067
4068On some platforms, it's possible to boot Linux zImage. This is done
4069using the "bootz" command. The syntax of "bootz" command is the same
4070as the syntax of "bootm" command.
4071
Tom Rini8ac28562013-05-16 11:40:11 -04004072Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004073kernel with raw initrd images. The syntax is slightly different, the
4074address of the initrd must be augmented by it's size, in the following
4075format: "<initrd addres>:<initrd size>".
4076
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk2729af92004-05-03 20:45:30 +00004078Standalone HOWTO:
4079=================
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081One of the features of U-Boot is that you can dynamically load and
4082run "standalone" applications, which can use some resources of
4083U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087"Hello World" Demo:
4088-------------------
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090'examples/hello_world.c' contains a small "Hello World" Demo
4091application; it is automatically compiled when you build U-Boot.
4092It's configured to run at address 0x00040004, so you can play with it
4093like that:
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095 => loads
4096 ## Ready for S-Record download ...
4097 ~>examples/hello_world.srec
4098 1 2 3 4 5 6 7 8 9 10 11 ...
4099 [file transfer complete]
4100 [connected]
4101 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103 => go 40004 Hello World! This is a test.
4104 ## Starting application at 0x00040004 ...
4105 Hello World
4106 argc = 7
4107 argv[0] = "40004"
4108 argv[1] = "Hello"
4109 argv[2] = "World!"
4110 argv[3] = "This"
4111 argv[4] = "is"
4112 argv[5] = "a"
4113 argv[6] = "test."
4114 argv[7] = "<NULL>"
4115 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119Another example, which demonstrates how to register a CPM interrupt
4120handler with the U-Boot code, can be found in 'examples/timer.c'.
4121Here, a CPM timer is set up to generate an interrupt every second.
4122The interrupt service routine is trivial, just printing a '.'
4123character, but this is just a demo program. The application can be
4124controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126 ? - print current values og the CPM Timer registers
4127 b - enable interrupts and start timer
4128 e - stop timer and disable interrupts
4129 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131 => loads
4132 ## Ready for S-Record download ...
4133 ~>examples/timer.srec
4134 1 2 3 4 5 6 7 8 9 10 11 ...
4135 [file transfer complete]
4136 [connected]
4137 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139 => go 40004
4140 ## Starting application at 0x00040004 ...
4141 TIMERS=0xfff00980
4142 Using timer 1
4143 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk2729af92004-05-03 20:45:30 +00004145Hit 'b':
4146 [q, b, e, ?] Set interval 1000000 us
4147 Enabling timer
4148Hit '?':
4149 [q, b, e, ?] ........
4150 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4151Hit '?':
4152 [q, b, e, ?] .
4153 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4154Hit '?':
4155 [q, b, e, ?] .
4156 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4157Hit '?':
4158 [q, b, e, ?] .
4159 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4160Hit 'e':
4161 [q, b, e, ?] ...Stopping timer
4162Hit 'q':
4163 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004164
4165
wdenk2729af92004-05-03 20:45:30 +00004166Minicom warning:
4167================
wdenk85ec0bc2003-03-31 16:34:49 +00004168
wdenk2729af92004-05-03 20:45:30 +00004169Over time, many people have reported problems when trying to use the
4170"minicom" terminal emulation program for serial download. I (wd)
4171consider minicom to be broken, and recommend not to use it. Under
4172Unix, I recommend to use C-Kermit for general purpose use (and
4173especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004174use "cu" for S-Record download ("loads" command). See
4175http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4176for help with kermit.
4177
wdenk85ec0bc2003-03-31 16:34:49 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179Nevertheless, if you absolutely want to use it try adding this
4180configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182 Name Program Name U/D FullScr IO-Red. Multi
4183 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4184 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004185
4186
wdenk2729af92004-05-03 20:45:30 +00004187NetBSD Notes:
4188=============
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190Starting at version 0.9.2, U-Boot supports NetBSD both as host
4191(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193Building requires a cross environment; it is known to work on
4194NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4195need gmake since the Makefiles are not compatible with BSD make).
4196Note that the cross-powerpc package does not install include files;
4197attempting to build U-Boot will fail because <machine/ansi.h> is
4198missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004199
wdenk2729af92004-05-03 20:45:30 +00004200 # cd /usr/pkg/cross/powerpc-netbsd/include
4201 # mkdir powerpc
4202 # ln -s powerpc machine
4203 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4204 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206Native builds *don't* work due to incompatibilities between native
4207and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209Booting assumes that (the first part of) the image booted is a
4210stage-2 loader which in turn loads and then invokes the kernel
4211proper. Loader sources will eventually appear in the NetBSD source
4212tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004213meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004214
4215
wdenk2729af92004-05-03 20:45:30 +00004216Implementation Internals:
4217=========================
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk2729af92004-05-03 20:45:30 +00004219The following is not intended to be a complete description of every
4220implementation detail. However, it should help to understand the
4221inner workings of U-Boot and make it easier to port it to custom
4222hardware.
wdenkc6097192002-11-03 00:24:07 +00004223
4224
wdenk2729af92004-05-03 20:45:30 +00004225Initial Stack, Global Data:
4226---------------------------
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk2729af92004-05-03 20:45:30 +00004228The implementation of U-Boot is complicated by the fact that U-Boot
4229starts running out of ROM (flash memory), usually without access to
4230system RAM (because the memory controller is not initialized yet).
4231This means that we don't have writable Data or BSS segments, and BSS
4232is not initialized as zero. To be able to get a C environment working
4233at all, we have to allocate at least a minimal stack. Implementation
4234options for this are defined and restricted by the CPU used: Some CPU
4235models provide on-chip memory (like the IMMR area on MPC8xx and
4236MPC826x processors), on others (parts of) the data cache can be
4237locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004238
Wolfgang Denk218ca722008-03-26 10:40:12 +01004239 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004240 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4243 From: "Chris Hallinan" <clh@net1plus.com>
4244 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4245 ...
wdenk43d96162003-03-06 00:02:04 +00004246
wdenk2729af92004-05-03 20:45:30 +00004247 Correct me if I'm wrong, folks, but the way I understand it
4248 is this: Using DCACHE as initial RAM for Stack, etc, does not
4249 require any physical RAM backing up the cache. The cleverness
4250 is that the cache is being used as a temporary supply of
4251 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004252 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004253 can see how this works by studying the cache architecture and
4254 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004255
wdenk2729af92004-05-03 20:45:30 +00004256 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4257 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004258 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004259 option should work for you. Using CS 4 should be fine if your
4260 board designers haven't used it for something that would
4261 cause you grief during the initial boot! It is frequently not
4262 used.
wdenk43d96162003-03-06 00:02:04 +00004263
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004264 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004265 with your processor/board/system design. The default value
4266 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004267 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004268 than your SDRAM module. If you have a 64MB SDRAM module, set
4269 it above 400_0000. Just make sure your board has no resources
4270 that are supposed to respond to that address! That code in
4271 start.S has been around a while and should work as is when
4272 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274 -Chris Hallinan
4275 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277It is essential to remember this, since it has some impact on the C
4278code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004279
wdenk2729af92004-05-03 20:45:30 +00004280* Initialized global data (data segment) is read-only. Do not attempt
4281 to write it.
wdenkc6097192002-11-03 00:24:07 +00004282
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004283* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004284 as zero data - BSS segment) at all - this is undefined, initiali-
4285 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287* Stack space is very limited. Avoid big data buffers or things like
4288 that.
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004291normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004292turned out that the implementation of U-Boot can be greatly
4293simplified by making a global data structure (gd_t) available to all
4294functions. We could pass a pointer to this data as argument to _all_
4295functions, but this would bloat the code. Instead we use a feature of
4296the GCC compiler (Global Register Variables) to share the data: we
4297place a pointer (gd) to the global data into a register which we
4298reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300When choosing a register for such a purpose we are restricted by the
4301relevant (E)ABI specifications for the current architecture, and by
4302GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304For PowerPC, the following registers have specific use:
4305 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004306 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004307 R3-R4: parameter passing and return values
4308 R5-R10: parameter passing
4309 R13: small data area pointer
4310 R30: GOT pointer
4311 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004312
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004313 (U-Boot also uses R12 as internal GOT pointer. r12
4314 is a volatile register so r12 needs to be reset when
4315 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004316
Wolfgang Denke7670f62008-02-14 22:43:22 +01004317 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319 Note: on PPC, we could use a static initializer (since the
4320 address of the global data structure is known at compile time),
4321 but it turned out that reserving a register results in somewhat
4322 smaller code - although the code savings are not that big (on
4323 average for all boards 752 bytes for the whole U-Boot image,
4324 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk2729af92004-05-03 20:45:30 +00004326On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328 R0: function argument word/integer result
4329 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004330 R9: platform specific
4331 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004332 R11: argument (frame) pointer
4333 R12: temporary workspace
4334 R13: stack pointer
4335 R14: link register
4336 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004337
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004338 ==> U-Boot will use R9 to hold a pointer to the global data
4339
4340 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004341
Thomas Chou0df01fd2010-05-21 11:08:03 +08004342On Nios II, the ABI is documented here:
4343 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4344
4345 ==> U-Boot will use gp to hold a pointer to the global data
4346
4347 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4348 to access small data sections, so gp is free.
4349
Macpaul Linafc1ce82011-10-19 20:41:11 +00004350On NDS32, the following registers are used:
4351
4352 R0-R1: argument/return
4353 R2-R5: argument
4354 R15: temporary register for assembler
4355 R16: trampoline register
4356 R28: frame pointer (FP)
4357 R29: global pointer (GP)
4358 R30: link register (LP)
4359 R31: stack pointer (SP)
4360 PC: program counter (PC)
4361
4362 ==> U-Boot will use R10 to hold a pointer to the global data
4363
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004364NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4365or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004366
Rick Chen3fafced2017-12-26 13:55:59 +08004367On RISC-V, the following registers are used:
4368
4369 x0: hard-wired zero (zero)
4370 x1: return address (ra)
4371 x2: stack pointer (sp)
4372 x3: global pointer (gp)
4373 x4: thread pointer (tp)
4374 x5: link register (t0)
4375 x8: frame pointer (fp)
4376 x10-x11: arguments/return values (a0-1)
4377 x12-x17: arguments (a2-7)
4378 x28-31: temporaries (t3-6)
4379 pc: program counter (pc)
4380
4381 ==> U-Boot will use gp to hold a pointer to the global data
4382
wdenk2729af92004-05-03 20:45:30 +00004383Memory Management:
4384------------------
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386U-Boot runs in system state and uses physical addresses, i.e. the
4387MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389The available memory is mapped to fixed addresses using the memory
4390controller. In this process, a contiguous block is formed for each
4391memory type (Flash, SDRAM, SRAM), even when it consists of several
4392physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk2729af92004-05-03 20:45:30 +00004394U-Boot is installed in the first 128 kB of the first Flash bank (on
4395TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4396booting and sizing and initializing DRAM, the code relocates itself
4397to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004398memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004399configuration setting]. Below that, a structure with global Board
4400Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402Additionally, some exception handler code is copied to the low 8 kB
4403of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk2729af92004-05-03 20:45:30 +00004405So a typical memory configuration with 16 MB of DRAM could look like
4406this:
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408 0x0000 0000 Exception Vector code
4409 :
4410 0x0000 1FFF
4411 0x0000 2000 Free for Application Use
4412 :
4413 :
wdenkc6097192002-11-03 00:24:07 +00004414
wdenk2729af92004-05-03 20:45:30 +00004415 :
4416 :
4417 0x00FB FF20 Monitor Stack (Growing downward)
4418 0x00FB FFAC Board Info Data and permanent copy of global data
4419 0x00FC 0000 Malloc Arena
4420 :
4421 0x00FD FFFF
4422 0x00FE 0000 RAM Copy of Monitor Code
4423 ... eventually: LCD or video framebuffer
4424 ... eventually: pRAM (Protected RAM - unchanged by reset)
4425 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004426
4427
wdenk2729af92004-05-03 20:45:30 +00004428System Initialization:
4429----------------------
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk2729af92004-05-03 20:45:30 +00004431In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004432(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004433configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00004434To be able to re-map memory U-Boot then jumps to its link address.
4435To be able to implement the initialization code in C, a (small!)
4436initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02004437which provide such a feature like), or in a locked part of the data
4438cache. After that, U-Boot initializes the CPU core, the caches and
4439the SIU.
wdenkc6097192002-11-03 00:24:07 +00004440
wdenk2729af92004-05-03 20:45:30 +00004441Next, all (potentially) available memory banks are mapped using a
4442preliminary mapping. For example, we put them on 512 MB boundaries
4443(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4444on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4445programmed for SDRAM access. Using the temporary configuration, a
4446simple memory test is run that determines the size of the SDRAM
4447banks.
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449When there is more than one SDRAM bank, and the banks are of
4450different size, the largest is mapped first. For equal size, the first
4451bank (CS2#) is mapped first. The first mapping is always for address
44520x00000000, with any additional banks following immediately to create
4453contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455Then, the monitor installs itself at the upper end of the SDRAM area
4456and allocates memory for use by malloc() and for the global Board
4457Info data; also, the exception vector code is copied to the low RAM
4458pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460Only after this relocation will you have a "normal" C environment;
4461until that you are restricted in several ways, mostly because you are
4462running from ROM, and because the code will have to be relocated to a
4463new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004464
4465
wdenk2729af92004-05-03 20:45:30 +00004466U-Boot Porting Guide:
4467----------------------
wdenkc6097192002-11-03 00:24:07 +00004468
wdenk2729af92004-05-03 20:45:30 +00004469[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4470list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004471
4472
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004473int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004474{
4475 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004476
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004477 signal(SIGALRM, no_more_time);
4478 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004479
wdenk2729af92004-05-03 20:45:30 +00004480 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004481 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004482 return 0;
4483 }
4484
wdenk2729af92004-05-03 20:45:30 +00004485 Download latest U-Boot source;
4486
Wolfgang Denk06682362008-12-30 22:56:11 +01004487 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004488
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004489 if (clueless)
4490 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004491
wdenk2729af92004-05-03 20:45:30 +00004492 while (learning) {
4493 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004494 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
Patrick Delaunay24bcaec2020-02-28 15:18:10 +01004495 Read applicable doc/README.*;
wdenk2729af92004-05-03 20:45:30 +00004496 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004497 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004498 }
wdenkc6097192002-11-03 00:24:07 +00004499
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004500 if (available_money > toLocalCurrency ($2500))
4501 Buy a BDI3000;
4502 else
wdenk2729af92004-05-03 20:45:30 +00004503 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004504
4505 if (a similar board exists) { /* hopefully... */
4506 cp -a board/<similar> board/<myboard>
4507 cp include/configs/<similar>.h include/configs/<myboard>.h
4508 } else {
4509 Create your own board support subdirectory;
4510 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004511 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004512 Edit new board/<myboard> files
4513 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004514
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004515 while (!accepted) {
4516 while (!running) {
4517 do {
4518 Add / modify source code;
4519 } until (compiles);
4520 Debug;
4521 if (clueless)
4522 email("Hi, I am having problems...");
4523 }
4524 Send patch file to the U-Boot email list;
4525 if (reasonable critiques)
4526 Incorporate improvements from email list code review;
4527 else
4528 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004529 }
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk2729af92004-05-03 20:45:30 +00004531 return 0;
4532}
4533
4534void no_more_time (int sig)
4535{
4536 hire_a_guru();
4537}
wdenkc6097192002-11-03 00:24:07 +00004538
4539
wdenk2729af92004-05-03 20:45:30 +00004540Coding Standards:
4541-----------------
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk2729af92004-05-03 20:45:30 +00004543All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02004544coding style; see the kernel coding style guide at
4545https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4546script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004547
Detlev Zundel2c051652006-09-01 15:39:02 +02004548Source files originating from a different project (for example the
4549MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004550reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02004551sources.
4552
4553Please note that U-Boot is implemented in C (and to some small parts in
4554Assembler); no C++ is used, so please do not use C++ style comments (//)
4555in your code.
wdenk2729af92004-05-03 20:45:30 +00004556
4557Please also stick to the following formatting rules:
4558- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004559- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004560- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004561- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004562- do not add trailing empty lines to source files
4563
4564Submissions which do not conform to the standards may be returned
4565with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004566
4567
wdenk2729af92004-05-03 20:45:30 +00004568Submitting Patches:
4569-------------------
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk2729af92004-05-03 20:45:30 +00004571Since the number of patches for U-Boot is growing, we need to
4572establish some rules. Submissions which do not conform to these rules
4573may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004574
Magnus Lilja0d28f342008-08-06 19:32:33 +02004575Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004576
Wolfgang Denk06682362008-12-30 22:56:11 +01004577Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08004578see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01004579
wdenk2729af92004-05-03 20:45:30 +00004580When you send a patch, please include the following information with
4581it:
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583* For bug fixes: a description of the bug and how your patch fixes
4584 this bug. Please try to include a way of demonstrating that the
4585 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587* For new features: a description of the feature and your
4588 implementation.
wdenkc6097192002-11-03 00:24:07 +00004589
Robert P. J. Day7207b362015-12-19 07:16:10 -05004590* For major contributions, add a MAINTAINERS file with your
4591 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00004592
Albert ARIBAUD27af9302013-09-11 15:52:51 +02004593* When you add support for a new board, don't forget to add a
4594 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00004595
4596* If your patch adds new configuration options, don't forget to
4597 document these in the README file.
4598
Wolfgang Denk218ca722008-03-26 10:40:12 +01004599* The patch itself. If you are using git (which is *strongly*
4600 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004601 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004602 the U-Boot mailing list, you will avoid most of the common problems
4603 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004604
Wolfgang Denk218ca722008-03-26 10:40:12 +01004605 If you cannot use git, use "diff -purN OLD NEW". If your version of
4606 diff does not support these options, then get the latest version of
4607 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004608
Wolfgang Denk218ca722008-03-26 10:40:12 +01004609 The current directory when running this command shall be the parent
4610 directory of the U-Boot source tree (i. e. please make sure that
4611 your patch includes sufficient directory information for the
4612 affected files).
4613
4614 We prefer patches as plain text. MIME attachments are discouraged,
4615 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004616
4617* If one logical set of modifications affects or creates several
4618 files, all these changes shall be submitted in a SINGLE patch file.
4619
4620* Changesets that contain different, unrelated modifications shall be
4621 submitted as SEPARATE patches, one patch per changeset.
4622
4623
4624Notes:
4625
Simon Glass6de80f22016-07-27 20:33:08 -06004626* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00004627 source tree and make sure that no errors or warnings are reported
4628 for any of the boards.
4629
4630* Keep your modifications to the necessary minimum: A patch
4631 containing several unrelated changes or arbitrary reformats will be
4632 returned with a request to re-formatting / split it.
4633
4634* If you modify existing code, make sure that your new code does not
4635 add to the memory footprint of the code ;-) Small is beautiful!
4636 When adding new features, these should compile conditionally only
4637 (using #ifdef), and the resulting code with the new feature
4638 disabled must not need more memory than the old code without your
4639 modification.
wdenk90dc6702005-05-03 14:12:25 +00004640
Wolfgang Denk06682362008-12-30 22:56:11 +01004641* Remember that there is a size limit of 100 kB per message on the
4642 u-boot mailing list. Bigger patches will be moderated. If they are
4643 reasonable and not too big, they will be acknowledged. But patches
4644 bigger than the size limit should be avoided.