blob: 06f3ed057d5ed24fa24b7c3ebdccb07a55665048 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500146 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500147 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400148 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500149/api Machine/arch independent API for external apps
150/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800151/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500152/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500153/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500154/disk Code for disk drive partition handling
155/doc Documentation (don't expect too much)
156/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400157/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500158/examples Example code for standalone applications, etc.
159/fs Filesystem code (cramfs, ext2, jffs2, etc.)
160/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500161/lib Library routines generic to all architectures
162/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500163/net Networking code
164/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500165/scripts Various build scripts and Makefiles
166/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500167/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000168
wdenkc6097192002-11-03 00:24:07 +0000169Software Configuration:
170=======================
171
172Configuration is usually done using C preprocessor defines; the
173rationale behind that is to avoid dead code whenever possible.
174
175There are two classes of configuration variables:
176
177* Configuration _OPTIONS_:
178 These are selectable by the user and have names beginning with
179 "CONFIG_".
180
181* Configuration _SETTINGS_:
182 These depend on the hardware etc. and should not be meddled with if
183 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200184 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000185
Robert P. J. Day7207b362015-12-19 07:16:10 -0500186Previously, all configuration was done by hand, which involved creating
187symbolic links and editing configuration files manually. More recently,
188U-Boot has added the Kbuild infrastructure used by the Linux kernel,
189allowing you to use the "make menuconfig" command to configure your
190build.
wdenkc6097192002-11-03 00:24:07 +0000191
192
193Selection of Processor Architecture and Board Type:
194---------------------------------------------------
195
196For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200197configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000198
199Example: For a TQM823L module type:
200
201 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200202 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000203
Robert P. J. Day7207b362015-12-19 07:16:10 -0500204Note: If you're looking for the default configuration file for a board
205you're sure used to be there but is now missing, check the file
206doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000207
Simon Glass75b3c3a2014-03-22 17:12:59 -0600208Sandbox Environment:
209--------------------
210
211U-Boot can be built natively to run on a Linux host using the 'sandbox'
212board. This allows feature development which is not board- or architecture-
213specific to be undertaken on a native platform. The sandbox is also used to
214run some of U-Boot's tests.
215
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530216See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600217
218
Simon Glassdb910352015-03-03 08:03:00 -0700219Board Initialisation Flow:
220--------------------------
221
222This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500223SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700224
Robert P. J. Day7207b362015-12-19 07:16:10 -0500225Note: "SPL" stands for "Secondary Program Loader," which is explained in
226more detail later in this file.
227
228At present, SPL mostly uses a separate code path, but the function names
229and roles of each function are the same. Some boards or architectures
230may not conform to this. At least most ARM boards which use
231CONFIG_SPL_FRAMEWORK conform to this.
232
233Execution typically starts with an architecture-specific (and possibly
234CPU-specific) start.S file, such as:
235
236 - arch/arm/cpu/armv7/start.S
237 - arch/powerpc/cpu/mpc83xx/start.S
238 - arch/mips/cpu/start.S
239
240and so on. From there, three functions are called; the purpose and
241limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700242
243lowlevel_init():
244 - purpose: essential init to permit execution to reach board_init_f()
245 - no global_data or BSS
246 - there is no stack (ARMv7 may have one but it will soon be removed)
247 - must not set up SDRAM or use console
248 - must only do the bare minimum to allow execution to continue to
249 board_init_f()
250 - this is almost never needed
251 - return normally from this function
252
253board_init_f():
254 - purpose: set up the machine ready for running board_init_r():
255 i.e. SDRAM and serial UART
256 - global_data is available
257 - stack is in SRAM
258 - BSS is not available, so you cannot use global/static variables,
259 only stack variables and global_data
260
261 Non-SPL-specific notes:
262 - dram_init() is called to set up DRAM. If already done in SPL this
263 can do nothing
264
265 SPL-specific notes:
266 - you can override the entire board_init_f() function with your own
267 version as needed.
268 - preloader_console_init() can be called here in extremis
269 - should set up SDRAM, and anything needed to make the UART work
270 - these is no need to clear BSS, it will be done by crt0.S
271 - must return normally from this function (don't call board_init_r()
272 directly)
273
274Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
275this point the stack and global_data are relocated to below
276CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
277memory.
278
279board_init_r():
280 - purpose: main execution, common code
281 - global_data is available
282 - SDRAM is available
283 - BSS is available, all static/global variables can be used
284 - execution eventually continues to main_loop()
285
286 Non-SPL-specific notes:
287 - U-Boot is relocated to the top of memory and is now running from
288 there.
289
290 SPL-specific notes:
291 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
292 CONFIG_SPL_STACK_R_ADDR points into SDRAM
293 - preloader_console_init() can be called here - typically this is
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700295 spl_board_init() function containing this call
296 - loads U-Boot or (in falcon mode) Linux
297
298
299
wdenkc6097192002-11-03 00:24:07 +0000300Configuration Options:
301----------------------
302
303Configuration depends on the combination of board and CPU type; all
304such information is kept in a configuration file
305"include/configs/<board_name>.h".
306
307Example: For a TQM823L module, all configuration settings are in
308"include/configs/TQM823L.h".
309
310
wdenk7f6c2cb2002-11-10 22:06:23 +0000311Many of the options are named exactly as the corresponding Linux
312kernel configuration options. The intention is to make it easier to
313build a config tool - later.
314
Ashish Kumar63b23162017-08-11 11:09:14 +0530315- ARM Platform Bus Type(CCI):
316 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
317 provides full cache coherency between two clusters of multi-core
318 CPUs and I/O coherency for devices and I/O masters
319
320 CONFIG_SYS_FSL_HAS_CCI400
321
322 Defined For SoC that has cache coherent interconnect
323 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000324
Ashish Kumarc055cee2017-08-18 10:54:36 +0530325 CONFIG_SYS_FSL_HAS_CCN504
326
327 Defined for SoC that has cache coherent interconnect CCN-504
328
wdenkc6097192002-11-03 00:24:07 +0000329The following options need to be configured:
330
Kim Phillips26281142007-08-10 13:28:25 -0500331- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000332
Kim Phillips26281142007-08-10 13:28:25 -0500333- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200334
Lei Wencf946c62011-02-09 18:06:58 +0530335- Marvell Family Member
336 CONFIG_SYS_MVFS - define it if you want to enable
337 multiple fs option at one time
338 for marvell soc family
339
Kumar Gala66412c62011-02-18 05:40:54 -0600340- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000341 CONFIG_SYS_PPC64
342
343 Specifies that the core is a 64-bit PowerPC implementation (implements
344 the "64" category of the Power ISA). This is necessary for ePAPR
345 compliance, among other possible reasons.
346
Kumar Gala66412c62011-02-18 05:40:54 -0600347 CONFIG_SYS_FSL_TBCLK_DIV
348
349 Defines the core time base clock divider ratio compared to the
350 system clock. On most PQ3 devices this is 8, on newer QorIQ
351 devices it can be 16 or 32. The ratio varies from SoC to Soc.
352
Kumar Gala8f290842011-05-20 00:39:21 -0500353 CONFIG_SYS_FSL_PCIE_COMPAT
354
355 Defines the string to utilize when trying to match PCIe device
356 tree nodes for the given platform.
357
Scott Wood33eee332012-08-14 10:14:53 +0000358 CONFIG_SYS_FSL_ERRATUM_A004510
359
360 Enables a workaround for erratum A004510. If set,
361 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
362 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
363
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
366
367 Defines one or two SoC revisions (low 8 bits of SVR)
368 for which the A004510 workaround should be applied.
369
370 The rest of SVR is either not relevant to the decision
371 of whether the erratum is present (e.g. p2040 versus
372 p2041) or is implied by the build target, which controls
373 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
374
375 See Freescale App Note 4493 for more information about
376 this erratum.
377
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530378 CONFIG_A003399_NOR_WORKAROUND
379 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800380 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530381
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530382 CONFIG_A008044_WORKAROUND
383 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800384 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530385
Scott Wood33eee332012-08-14 10:14:53 +0000386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
387
388 This is the value to write into CCSR offset 0x18600
389 according to the A004510 workaround.
390
Priyanka Jain64501c62013-07-02 09:21:04 +0530391 CONFIG_SYS_FSL_DSP_DDR_ADDR
392 This value denotes start offset of DDR memory which is
393 connected exclusively to the DSP cores.
394
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530395 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
396 This value denotes start offset of M2 memory
397 which is directly connected to the DSP core.
398
Priyanka Jain64501c62013-07-02 09:21:04 +0530399 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
400 This value denotes start offset of M3 memory which is directly
401 connected to the DSP core.
402
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530403 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
404 This value denotes start offset of DSP CCSR space.
405
Priyanka Jainb1359912013-12-17 14:25:52 +0530406 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
407 Single Source Clock is clocking mode present in some of FSL SoC's.
408 In this mode, a single differential clock is used to supply
409 clocks to the sysclock, ddrclock and usbclock.
410
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530411 CONFIG_SYS_CPC_REINIT_F
412 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800413 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530414
Tang Yuantianaade2002014-04-17 15:33:46 +0800415 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800416 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800417 supported, core will start to execute uboot when wakes up.
418
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000419- Generic CPU options:
420 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
421
422 Defines the endianess of the CPU. Implementation of those
423 values is arch specific.
424
York Sun5614e712013-09-30 09:22:09 -0700425 CONFIG_SYS_FSL_DDR
426 Freescale DDR driver in use. This type of DDR controller is
427 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
428 SoCs.
429
430 CONFIG_SYS_FSL_DDR_ADDR
431 Freescale DDR memory-mapped register base.
432
433 CONFIG_SYS_FSL_DDR_EMU
434 Specify emulator support for DDR. Some DDR features such as
435 deskew training are not available.
436
437 CONFIG_SYS_FSL_DDRC_GEN1
438 Freescale DDR1 controller.
439
440 CONFIG_SYS_FSL_DDRC_GEN2
441 Freescale DDR2 controller.
442
443 CONFIG_SYS_FSL_DDRC_GEN3
444 Freescale DDR3 controller.
445
York Sun34e026f2014-03-27 17:54:47 -0700446 CONFIG_SYS_FSL_DDRC_GEN4
447 Freescale DDR4 controller.
448
York Sun9ac4ffb2013-09-30 14:20:51 -0700449 CONFIG_SYS_FSL_DDRC_ARM_GEN3
450 Freescale DDR3 controller for ARM-based SoCs.
451
York Sun5614e712013-09-30 09:22:09 -0700452 CONFIG_SYS_FSL_DDR1
453 Board config to use DDR1. It can be enabled for SoCs with
454 Freescale DDR1 or DDR2 controllers, depending on the board
455 implemetation.
456
457 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400458 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700459 Freescale DDR2 or DDR3 controllers, depending on the board
460 implementation.
461
462 CONFIG_SYS_FSL_DDR3
463 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700464 Freescale DDR3 or DDR3L controllers.
465
466 CONFIG_SYS_FSL_DDR3L
467 Board config to use DDR3L. It can be enabled for SoCs with
468 DDR3L controllers.
469
470 CONFIG_SYS_FSL_DDR4
471 Board config to use DDR4. It can be enabled for SoCs with
472 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700473
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530474 CONFIG_SYS_FSL_IFC_BE
475 Defines the IFC controller register space as Big Endian
476
477 CONFIG_SYS_FSL_IFC_LE
478 Defines the IFC controller register space as Little Endian
479
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530480 CONFIG_SYS_FSL_IFC_CLK_DIV
481 Defines divider of platform clock(clock input to IFC controller).
482
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530483 CONFIG_SYS_FSL_LBC_CLK_DIV
484 Defines divider of platform clock(clock input to eLBC controller).
485
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530486 CONFIG_SYS_FSL_PBL_PBI
487 It enables addition of RCW (Power on reset configuration) in built image.
488 Please refer doc/README.pblimage for more details
489
490 CONFIG_SYS_FSL_PBL_RCW
491 It adds PBI(pre-boot instructions) commands in u-boot build image.
492 PBI commands can be used to configure SoC before it starts the execution.
493 Please refer doc/README.pblimage for more details
494
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530495 CONFIG_SPL_FSL_PBL
496 It adds a target to create boot binary having SPL binary in PBI format
497 concatenated with u-boot binary.
498
York Sun4e5b1bd2014-02-10 13:59:42 -0800499 CONFIG_SYS_FSL_DDR_BE
500 Defines the DDR controller register space as Big Endian
501
502 CONFIG_SYS_FSL_DDR_LE
503 Defines the DDR controller register space as Little Endian
504
York Sun6b9e3092014-02-10 13:59:43 -0800505 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
506 Physical address from the view of DDR controllers. It is the
507 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
508 it could be different for ARM SoCs.
509
York Sun6b1e1252014-02-10 13:59:44 -0800510 CONFIG_SYS_FSL_DDR_INTLV_256B
511 DDR controller interleaving on 256-byte. This is a special
512 interleaving mode, handled by Dickens for Freescale layerscape
513 SoCs with ARM core.
514
York Sun1d71efb2014-08-01 15:51:00 -0700515 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
516 Number of controllers used as main memory.
517
518 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
519 Number of controllers used for other than main memory.
520
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530521 CONFIG_SYS_FSL_HAS_DP_DDR
522 Defines the SoC has DP-DDR used for DPAA.
523
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530524 CONFIG_SYS_FSL_SEC_BE
525 Defines the SEC controller register space as Big Endian
526
527 CONFIG_SYS_FSL_SEC_LE
528 Defines the SEC controller register space as Little Endian
529
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200530- MIPS CPU options:
531 CONFIG_SYS_INIT_SP_OFFSET
532
533 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
534 pointer. This is needed for the temporary stack before
535 relocation.
536
537 CONFIG_SYS_MIPS_CACHE_MODE
538
539 Cache operation mode for the MIPS CPU.
540 See also arch/mips/include/asm/mipsregs.h.
541 Possible values are:
542 CONF_CM_CACHABLE_NO_WA
543 CONF_CM_CACHABLE_WA
544 CONF_CM_UNCACHED
545 CONF_CM_CACHABLE_NONCOHERENT
546 CONF_CM_CACHABLE_CE
547 CONF_CM_CACHABLE_COW
548 CONF_CM_CACHABLE_CUW
549 CONF_CM_CACHABLE_ACCELERATED
550
551 CONFIG_SYS_XWAY_EBU_BOOTCFG
552
553 Special option for Lantiq XWAY SoCs for booting from NOR flash.
554 See also arch/mips/cpu/mips32/start.S.
555
556 CONFIG_XWAY_SWAP_BYTES
557
558 Enable compilation of tools/xway-swap-bytes needed for Lantiq
559 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
560 be swapped if a flash programmer is used.
561
Christian Rieschb67d8812012-02-02 00:44:39 +0000562- ARM options:
563 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
564
565 Select high exception vectors of the ARM core, e.g., do not
566 clear the V bit of the c1 register of CP15.
567
York Sun207774b2015-03-20 19:28:08 -0700568 COUNTER_FREQUENCY
569 Generic timer clock source frequency.
570
571 COUNTER_FREQUENCY_REAL
572 Generic timer clock source frequency if the real clock is
573 different from COUNTER_FREQUENCY, and can only be determined
574 at run time.
575
Stephen Warren73c38932015-01-19 16:25:52 -0700576- Tegra SoC options:
577 CONFIG_TEGRA_SUPPORT_NON_SECURE
578
579 Support executing U-Boot in non-secure (NS) mode. Certain
580 impossible actions will be skipped if the CPU is in NS mode,
581 such as ARM architectural timer initialization.
582
wdenk5da627a2003-10-09 20:09:04 +0000583- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000584 CONFIG_CLOCKS_IN_MHZ
585
586 U-Boot stores all clock information in Hz
587 internally. For binary compatibility with older Linux
588 kernels (which expect the clocks passed in the
589 bd_info data to be in MHz) the environment variable
590 "clocks_in_mhz" can be defined so that U-Boot
591 converts clock data to MHZ before passing it to the
592 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000593 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100594 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000595 default environment.
596
wdenk5da627a2003-10-09 20:09:04 +0000597 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
598
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800599 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000600 expect it to be in bytes, others in MB.
601 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
602
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400603 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200604
605 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400606 passed using flattened device trees (based on open firmware
607 concepts).
608
609 CONFIG_OF_LIBFDT
610 * New libfdt-based support
611 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500612 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400613
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200614 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600615 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200616
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200617 boards with QUICC Engines require OF_QE to set UCC MAC
618 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500619
Kumar Gala4e253132006-01-11 13:54:17 -0600620 CONFIG_OF_BOARD_SETUP
621
622 Board code has addition modification that it wants to make
623 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000624
Simon Glassc654b512014-10-23 18:58:54 -0600625 CONFIG_OF_SYSTEM_SETUP
626
627 Other code has addition modification that it wants to make
628 to the flat device tree before handing it off to the kernel.
629 This causes ft_system_setup() to be called before booting
630 the kernel.
631
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200632 CONFIG_OF_IDE_FIXUP
633
634 U-Boot can detect if an IDE device is present or not.
635 If not, and this new config option is activated, U-Boot
636 removes the ATA node from the DTS before booting Linux,
637 so the Linux IDE driver does not probe the device and
638 crash. This is needed for buggy hardware (uc101) where
639 no pull down resistor is connected to the signal IDE5V_DD7.
640
Igor Grinberg7eb29392011-07-14 05:45:07 +0000641 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
642
643 This setting is mandatory for all boards that have only one
644 machine type and must be used to specify the machine type
645 number as it appears in the ARM machine registry
646 (see http://www.arm.linux.org.uk/developer/machines/).
647 Only boards that have multiple machine types supported
648 in a single configuration file and the machine type is
649 runtime discoverable, do not have to use this setting.
650
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100651- vxWorks boot parameters:
652
653 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700654 environments variables: bootdev, bootfile, ipaddr, netmask,
655 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100656 It loads the vxWorks image pointed bootfile.
657
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100658 Note: If a "bootargs" environment is defined, it will overwride
659 the defaults discussed just above.
660
Aneesh V2c451f72011-06-16 23:30:47 +0000661- Cache Configuration:
662 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
663 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
664 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
665
Aneesh V93bc2192011-06-16 23:30:51 +0000666- Cache Configuration for ARM:
667 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
668 controller
669 CONFIG_SYS_PL310_BASE - Physical base address of PL310
670 controller register space
671
wdenk6705d812004-08-02 23:22:59 +0000672- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200673 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000674
675 Define this if you want support for Amba PrimeCell PL010 UARTs.
676
Andreas Engel48d01922008-09-08 14:30:53 +0200677 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000678
679 Define this if you want support for Amba PrimeCell PL011 UARTs.
680
681 CONFIG_PL011_CLOCK
682
683 If you have Amba PrimeCell PL011 UARTs, set this variable to
684 the clock speed of the UARTs.
685
686 CONFIG_PL01x_PORTS
687
688 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
689 define this to a list of base addresses for each (supported)
690 port. See e.g. include/configs/versatile.h
691
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400692 CONFIG_SERIAL_HW_FLOW_CONTROL
693
694 Define this variable to enable hw flow control in serial driver.
695 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000696
wdenkc6097192002-11-03 00:24:07 +0000697- Console Baudrate:
698 CONFIG_BAUDRATE - in bps
699 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200700 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000701
wdenkc6097192002-11-03 00:24:07 +0000702- Autoboot Command:
703 CONFIG_BOOTCOMMAND
704 Only needed when CONFIG_BOOTDELAY is enabled;
705 define a command string that is automatically executed
706 when no character is read on the console interface
707 within "Boot Delay" after reset.
708
wdenkc6097192002-11-03 00:24:07 +0000709 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000710 The value of these goes into the environment as
711 "ramboot" and "nfsboot" respectively, and can be used
712 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200713 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000714
Heiko Schochereda0ba32013-11-04 14:04:59 +0100715- Bootcount:
716 CONFIG_BOOTCOUNT_LIMIT
717 Implements a mechanism for detecting a repeating reboot
718 cycle, see:
719 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
720
721 CONFIG_BOOTCOUNT_ENV
722 If no softreset save registers are found on the hardware
723 "bootcount" is stored in the environment. To prevent a
724 saveenv on all reboots, the environment variable
725 "upgrade_available" is used. If "upgrade_available" is
726 0, "bootcount" is always 0, if "upgrade_available" is
727 1 "bootcount" is incremented in the environment.
728 So the Userspace Applikation must set the "upgrade_available"
729 and "bootcount" variable to 0, if a boot was successfully.
730
wdenkc6097192002-11-03 00:24:07 +0000731- Pre-Boot Commands:
732 CONFIG_PREBOOT
733
734 When this option is #defined, the existence of the
735 environment variable "preboot" will be checked
736 immediately before starting the CONFIG_BOOTDELAY
737 countdown and/or running the auto-boot command resp.
738 entering interactive mode.
739
740 This feature is especially useful when "preboot" is
741 automatically generated or modified. For an example
742 see the LWMON board specific code: here "preboot" is
743 modified when the user holds down a certain
744 combination of keys on the (special) keyboard when
745 booting the systems
746
747- Serial Download Echo Mode:
748 CONFIG_LOADS_ECHO
749 If defined to 1, all characters received during a
750 serial download (using the "loads" command) are
751 echoed back. This might be needed by some terminal
752 emulations (like "cu"), but may as well just take
753 time on others. This setting #define's the initial
754 value of the "loads_echo" environment variable.
755
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500756- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000757 CONFIG_KGDB_BAUDRATE
758 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200759 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000760
Simon Glass302a6482016-03-13 19:07:28 -0600761- Removal of commands
762 If no commands are needed to boot, you can disable
763 CONFIG_CMDLINE to remove them. In this case, the command line
764 will not be available, and when U-Boot wants to execute the
765 boot command (on start-up) it will call board_run_command()
766 instead. This can reduce image size significantly for very
767 simple boot procedures.
768
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000769- Regular expression support:
770 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200771 If this variable is defined, U-Boot is linked against
772 the SLRE (Super Light Regular Expression) library,
773 which adds regex support to some commands, as for
774 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000775
Simon Glass45ba8072011-10-15 05:48:20 +0000776- Device tree:
777 CONFIG_OF_CONTROL
778 If this variable is defined, U-Boot will use a device tree
779 to configure its devices, instead of relying on statically
780 compiled #defines in the board file. This option is
781 experimental and only available on a few boards. The device
782 tree is available in the global data as gd->fdt_blob.
783
Simon Glass2c0f79e2011-10-24 19:15:31 +0000784 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700785 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000786
787 CONFIG_OF_EMBED
788 If this variable is defined, U-Boot will embed a device tree
789 binary in its image. This device tree file should be in the
790 board directory and called <soc>-<board>.dts. The binary file
791 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900792 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000793
Simon Glass2c0f79e2011-10-24 19:15:31 +0000794 CONFIG_OF_SEPARATE
795 If this variable is defined, U-Boot will build a device tree
796 binary. It will be called u-boot.dtb. Architecture-specific
797 code will locate it at run-time. Generally this works by:
798
799 cat u-boot.bin u-boot.dtb >image.bin
800
801 and in fact, U-Boot does this for you, creating a file called
802 u-boot-dtb.bin which is useful in the common case. You can
803 still use the individual files if you need something more
804 exotic.
805
Alex Deymo82f766d2017-04-02 01:25:20 -0700806 CONFIG_OF_BOARD
807 If this variable is defined, U-Boot will use the device tree
808 provided by the board at runtime instead of embedding one with
809 the image. Only boards defining board_fdt_blob_setup() support
810 this option (see include/fdtdec.h file).
811
wdenkc6097192002-11-03 00:24:07 +0000812- Watchdog:
813 CONFIG_WATCHDOG
814 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000815 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200816 specific code for a watchdog. For the 8xx
817 CPUs, the SIU Watchdog feature is enabled in the SYPCR
818 register. When supported for a specific SoC is
819 available, then no further board specific code should
820 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000821
822 CONFIG_HW_WATCHDOG
823 When using a watchdog circuitry external to the used
824 SoC, then define this variable and provide board
825 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000826
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100827 CONFIG_AT91_HW_WDT_TIMEOUT
828 specify the timeout in seconds. default 2 seconds.
829
stroesec1551ea2003-04-04 15:53:41 +0000830- U-Boot Version:
831 CONFIG_VERSION_VARIABLE
832 If this variable is defined, an environment variable
833 named "ver" is created by U-Boot showing the U-Boot
834 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200835 Any change to this variable will be reverted at the
836 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000837
wdenkc6097192002-11-03 00:24:07 +0000838- Real-Time Clock:
839
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500840 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000841 has to be selected, too. Define exactly one of the
842 following options:
843
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000845 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000847 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000848 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000849 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200850 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000851 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100852 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000853 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200854 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200855 CONFIG_SYS_RV3029_TCR - enable trickle charger on
856 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000857
wdenkb37c7e52003-06-30 16:24:52 +0000858 Note that if the RTC uses I2C, then the I2C interface
859 must also be configured. See I2C Support, below.
860
Peter Tysere92739d2008-12-17 16:36:21 -0600861- GPIO Support:
862 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600863
Chris Packham5dec49c2010-12-19 10:12:13 +0000864 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
865 chip-ngpio pairs that tell the PCA953X driver the number of
866 pins supported by a particular chip.
867
Peter Tysere92739d2008-12-17 16:36:21 -0600868 Note that if the GPIO device uses I2C, then the I2C interface
869 must also be configured. See I2C Support, below.
870
Simon Glassaa532332014-06-11 23:29:41 -0600871- I/O tracing:
872 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
873 accesses and can checksum them or write a list of them out
874 to memory. See the 'iotrace' command for details. This is
875 useful for testing device drivers since it can confirm that
876 the driver behaves the same way before and after a code
877 change. Currently this is supported on sandbox and arm. To
878 add support for your architecture, add '#include <iotrace.h>'
879 to the bottom of arch/<arch>/include/asm/io.h and test.
880
881 Example output from the 'iotrace stats' command is below.
882 Note that if the trace buffer is exhausted, the checksum will
883 still continue to operate.
884
885 iotrace is enabled
886 Start: 10000000 (buffer start address)
887 Size: 00010000 (buffer size)
888 Offset: 00000120 (current buffer offset)
889 Output: 10000120 (start + offset)
890 Count: 00000018 (number of trace records)
891 CRC32: 9526fb66 (CRC32 of all trace records)
892
wdenkc6097192002-11-03 00:24:07 +0000893- Timestamp Support:
894
wdenk43d96162003-03-06 00:02:04 +0000895 When CONFIG_TIMESTAMP is selected, the timestamp
896 (date and time) of an image is printed by image
897 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500898 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000899
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000900- Partition Labels (disklabels) Supported:
901 Zero or more of the following:
902 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000903 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
904 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
905 bootloader. Note 2TB partition limit; see
906 disk/part_efi.c
907 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000908
Simon Glassfc843a02017-05-17 03:25:30 -0600909 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -0600910 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000911 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000912
913- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000914 CONFIG_IDE_RESET_ROUTINE - this is defined in several
915 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000916
wdenk4d13cba2004-03-14 14:09:05 +0000917 CONFIG_IDE_RESET - is this is defined, IDE Reset will
918 be performed by calling the function
919 ide_set_reset(int reset)
920 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000921
922- ATAPI Support:
923 CONFIG_ATAPI
924
925 Set this to enable ATAPI support.
926
wdenkc40b2952004-03-13 23:29:43 +0000927- LBA48 Support
928 CONFIG_LBA48
929
930 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100931 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000932 Whithout these , LBA48 support uses 32bit variables and will 'only'
933 support disks up to 2.1TB.
934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200935 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000936 When enabled, makes the IDE subsystem use 64bit sector addresses.
937 Default is 32bit.
938
wdenkc6097192002-11-03 00:24:07 +0000939- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200940 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
941 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
942 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000943 maximum numbers of LUNs, SCSI ID's and target
944 devices.
wdenkc6097192002-11-03 00:24:07 +0000945
Wolfgang Denk93e14592013-10-04 17:43:24 +0200946 The environment variable 'scsidevs' is set to the number of
947 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000948
wdenkc6097192002-11-03 00:24:07 +0000949- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000950 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000951 Support for Intel 8254x/8257x gigabit chips.
952
953 CONFIG_E1000_SPI
954 Utility code for direct access to the SPI bus on Intel 8257x.
955 This does not do anything useful unless you set at least one
956 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
957
958 CONFIG_E1000_SPI_GENERIC
959 Allow generic access to the SPI bus on the Intel 8257x, for
960 example with the "sspi" command.
961
wdenkc6097192002-11-03 00:24:07 +0000962 CONFIG_EEPRO100
963 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200964 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000965 write routine for first time initialisation.
966
967 CONFIG_TULIP
968 Support for Digital 2114x chips.
969 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
970 modem chip initialisation (KS8761/QS6611).
971
972 CONFIG_NATSEMI
973 Support for National dp83815 chips.
974
975 CONFIG_NS8382X
976 Support for National dp8382[01] gigabit chips.
977
wdenk45219c42003-05-12 21:50:16 +0000978- NETWORK Support (other):
979
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100980 CONFIG_DRIVER_AT91EMAC
981 Support for AT91RM9200 EMAC.
982
983 CONFIG_RMII
984 Define this to use reduced MII inteface
985
986 CONFIG_DRIVER_AT91EMAC_QUIET
987 If this defined, the driver is quiet.
988 The driver doen't show link status messages.
989
Rob Herringefdd7312011-12-15 11:15:49 +0000990 CONFIG_CALXEDA_XGMAC
991 Support for the Calxeda XGMAC device
992
Ashok3bb46d22012-10-15 06:20:47 +0000993 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000994 Support for SMSC's LAN91C96 chips.
995
wdenk45219c42003-05-12 21:50:16 +0000996 CONFIG_LAN91C96_USE_32_BIT
997 Define this to enable 32 bit addressing
998
Ashok3bb46d22012-10-15 06:20:47 +0000999 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001000 Support for SMSC's LAN91C111 chip
1001
1002 CONFIG_SMC91111_BASE
1003 Define this to hold the physical address
1004 of the device (I/O space)
1005
1006 CONFIG_SMC_USE_32_BIT
1007 Define this if data bus is 32 bits
1008
1009 CONFIG_SMC_USE_IOFUNCS
1010 Define this to use i/o functions instead of macros
1011 (some hardware wont work with macros)
1012
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001013 CONFIG_DRIVER_TI_EMAC
1014 Support for davinci emac
1015
1016 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1017 Define this if you have more then 3 PHYs.
1018
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001019 CONFIG_FTGMAC100
1020 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1021
1022 CONFIG_FTGMAC100_EGIGA
1023 Define this to use GE link update with gigabit PHY.
1024 Define this if FTGMAC100 is connected to gigabit PHY.
1025 If your system has 10/100 PHY only, it might not occur
1026 wrong behavior. Because PHY usually return timeout or
1027 useless data when polling gigabit status and gigabit
1028 control registers. This behavior won't affect the
1029 correctnessof 10/100 link speed update.
1030
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001031 CONFIG_SH_ETHER
1032 Support for Renesas on-chip Ethernet controller
1033
1034 CONFIG_SH_ETHER_USE_PORT
1035 Define the number of ports to be used
1036
1037 CONFIG_SH_ETHER_PHY_ADDR
1038 Define the ETH PHY's address
1039
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001040 CONFIG_SH_ETHER_CACHE_WRITEBACK
1041 If this option is set, the driver enables cache flush.
1042
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001043- PWM Support:
1044 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001045 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001046
Vadim Bendebury5e124722011-10-17 08:36:14 +00001047- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001048 CONFIG_TPM
1049 Support TPM devices.
1050
Christophe Ricard0766ad22015-10-06 22:54:41 +02001051 CONFIG_TPM_TIS_INFINEON
1052 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001053 per system is supported at this time.
1054
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001055 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1056 Define the burst count bytes upper limit
1057
Christophe Ricard3aa74082016-01-21 23:27:13 +01001058 CONFIG_TPM_ST33ZP24
1059 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1060
1061 CONFIG_TPM_ST33ZP24_I2C
1062 Support for STMicroelectronics ST33ZP24 I2C devices.
1063 Requires TPM_ST33ZP24 and I2C.
1064
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001065 CONFIG_TPM_ST33ZP24_SPI
1066 Support for STMicroelectronics ST33ZP24 SPI devices.
1067 Requires TPM_ST33ZP24 and SPI.
1068
Dirk Eibachc01939c2013-06-26 15:55:15 +02001069 CONFIG_TPM_ATMEL_TWI
1070 Support for Atmel TWI TPM device. Requires I2C support.
1071
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001072 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001073 Support for generic parallel port TPM devices. Only one device
1074 per system is supported at this time.
1075
1076 CONFIG_TPM_TIS_BASE_ADDRESS
1077 Base address where the generic TPM device is mapped
1078 to. Contemporary x86 systems usually map it at
1079 0xfed40000.
1080
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001081 CONFIG_TPM
1082 Define this to enable the TPM support library which provides
1083 functional interfaces to some TPM commands.
1084 Requires support for a TPM device.
1085
1086 CONFIG_TPM_AUTH_SESSIONS
1087 Define this to enable authorized functions in the TPM library.
1088 Requires CONFIG_TPM and CONFIG_SHA1.
1089
wdenkc6097192002-11-03 00:24:07 +00001090- USB Support:
1091 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001092 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001093 CONFIG_USB_UHCI to enable it.
1094 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001095 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001096 storage devices.
1097 Note:
1098 Supported are USB Keyboards and USB Floppy drives
1099 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001100
Simon Glass9ab4ce22012-02-27 10:52:47 +00001101 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1102 txfilltuning field in the EHCI controller on reset.
1103
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001104 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1105 HW module registers.
1106
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001107- USB Device:
1108 Define the below if you wish to use the USB console.
1109 Once firmware is rebuilt from a serial console issue the
1110 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001111 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001112 it has found a new device. The environment variable usbtty
1113 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001114 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001115 Common Device Class Abstract Control Model serial device.
1116 If you select usbtty = gserial you should be able to enumerate
1117 a Linux host by
1118 # modprobe usbserial vendor=0xVendorID product=0xProductID
1119 else if using cdc_acm, simply setting the environment
1120 variable usbtty to be cdc_acm should suffice. The following
1121 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001122
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001123 CONFIG_USB_DEVICE
1124 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001125
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001126 CONFIG_USB_TTY
1127 Define this to have a tty type of device available to
1128 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001129
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301130 CONFIG_USBD_HS
1131 Define this to enable the high speed support for usb
1132 device and usbtty. If this feature is enabled, a routine
1133 int is_usbd_high_speed(void)
1134 also needs to be defined by the driver to dynamically poll
1135 whether the enumeration has succeded at high speed or full
1136 speed.
1137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001138 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001139 Define this if you want stdin, stdout &/or stderr to
1140 be set to usbtty.
1141
Wolfgang Denk386eda02006-06-14 18:14:56 +02001142 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001143 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001144 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001145 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1146 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1147 should pretend to be a Linux device to it's target host.
1148
1149 CONFIG_USBD_MANUFACTURER
1150 Define this string as the name of your company for
1151 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001152
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001153 CONFIG_USBD_PRODUCT_NAME
1154 Define this string as the name of your product
1155 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1156
1157 CONFIG_USBD_VENDORID
1158 Define this as your assigned Vendor ID from the USB
1159 Implementors Forum. This *must* be a genuine Vendor ID
1160 to avoid polluting the USB namespace.
1161 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001162
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001163 CONFIG_USBD_PRODUCTID
1164 Define this as the unique Product ID
1165 for your device
1166 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001167
Igor Grinbergd70a5602011-12-12 12:08:35 +02001168- ULPI Layer Support:
1169 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1170 the generic ULPI layer. The generic layer accesses the ULPI PHY
1171 via the platform viewport, so you need both the genric layer and
1172 the viewport enabled. Currently only Chipidea/ARC based
1173 viewport is supported.
1174 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1175 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001176 If your ULPI phy needs a different reference clock than the
1177 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1178 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001179
1180- MMC Support:
1181 The MMC controller on the Intel PXA is supported. To
1182 enable this define CONFIG_MMC. The MMC can be
1183 accessed from the boot prompt by mapping the device
1184 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001185 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1186 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001187
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001188 CONFIG_SH_MMCIF
1189 Support for Renesas on-chip MMCIF controller
1190
1191 CONFIG_SH_MMCIF_ADDR
1192 Define the base address of MMCIF registers
1193
1194 CONFIG_SH_MMCIF_CLK
1195 Define the clock frequency for MMCIF
1196
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001197 CONFIG_SUPPORT_EMMC_BOOT
1198 Enable some additional features of the eMMC boot partitions.
1199
1200 CONFIG_SUPPORT_EMMC_RPMB
1201 Enable the commands for reading, writing and programming the
1202 key for the Replay Protection Memory Block partition in eMMC.
1203
Tom Rinib3ba6e92013-03-14 05:32:47 +00001204- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001205 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001206 This enables the USB portion of the DFU USB class
1207
Tom Rinib3ba6e92013-03-14 05:32:47 +00001208 CONFIG_DFU_MMC
1209 This enables support for exposing (e)MMC devices via DFU.
1210
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001211 CONFIG_DFU_NAND
1212 This enables support for exposing NAND devices via DFU.
1213
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301214 CONFIG_DFU_RAM
1215 This enables support for exposing RAM via DFU.
1216 Note: DFU spec refer to non-volatile memory usage, but
1217 allow usages beyond the scope of spec - here RAM usage,
1218 one that would help mostly the developer.
1219
Heiko Schochere7e75c72013-06-12 06:05:51 +02001220 CONFIG_SYS_DFU_DATA_BUF_SIZE
1221 Dfu transfer uses a buffer before writing data to the
1222 raw storage device. Make the size (in bytes) of this buffer
1223 configurable. The size of this buffer is also configurable
1224 through the "dfu_bufsiz" environment variable.
1225
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001226 CONFIG_SYS_DFU_MAX_FILE_SIZE
1227 When updating files rather than the raw storage device,
1228 we use a static buffer to copy the file into and then write
1229 the buffer once we've been given the whole file. Define
1230 this to the maximum filesize (in bytes) for the buffer.
1231 Default is 4 MiB if undefined.
1232
Heiko Schocher001a8312014-03-18 08:09:56 +01001233 DFU_DEFAULT_POLL_TIMEOUT
1234 Poll timeout [ms], is the timeout a device can send to the
1235 host. The host must wait for this timeout before sending
1236 a subsequent DFU_GET_STATUS request to the device.
1237
1238 DFU_MANIFEST_POLL_TIMEOUT
1239 Poll timeout [ms], which the device sends to the host when
1240 entering dfuMANIFEST state. Host waits this timeout, before
1241 sending again an USB request to the device.
1242
wdenk6705d812004-08-02 23:22:59 +00001243- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001244 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001245 Define these for a default partition on a NAND device
1246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001247 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1248 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001249 Define these for a default partition on a NOR device
1250
wdenkc6097192002-11-03 00:24:07 +00001251- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001252 See Kconfig help for available keyboard drivers.
1253
1254 CONFIG_KEYBOARD
1255
1256 Define this to enable a custom keyboard support.
1257 This simply calls drv_keyboard_init() which must be
1258 defined in your board-specific files. This option is deprecated
1259 and is only used by novena. For new boards, use driver model
1260 instead.
wdenkc6097192002-11-03 00:24:07 +00001261
1262- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001263 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001264 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001265 SOCs that have a DIU should define this macro to enable DIU
1266 support, and should also define these other macros:
1267
1268 CONFIG_SYS_DIU_ADDR
1269 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001270 CONFIG_CFB_CONSOLE
1271 CONFIG_VIDEO_SW_CURSOR
1272 CONFIG_VGA_AS_SINGLE_DEVICE
1273 CONFIG_VIDEO_LOGO
1274 CONFIG_VIDEO_BMP_LOGO
1275
Timur Tabiba8e76b2011-04-11 14:18:22 -05001276 The DIU driver will look for the 'video-mode' environment
1277 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001278 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001279 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001280
wdenkc6097192002-11-03 00:24:07 +00001281- LCD Support: CONFIG_LCD
1282
1283 Define this to enable LCD support (for output to LCD
1284 display); also select one of the supported displays
1285 by defining one of these:
1286
Stelian Pop39cf4802008-05-09 21:57:18 +02001287 CONFIG_ATMEL_LCD:
1288
1289 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1290
wdenkfd3103b2003-11-25 16:55:19 +00001291 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001292
wdenkfd3103b2003-11-25 16:55:19 +00001293 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkfd3103b2003-11-25 16:55:19 +00001295 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001296
wdenkfd3103b2003-11-25 16:55:19 +00001297 NEC NL6448BC20-08. 6.5", 640x480.
1298 Active, color, single scan.
1299
1300 CONFIG_NEC_NL6448BC33_54
1301
1302 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001303 Active, color, single scan.
1304
1305 CONFIG_SHARP_16x9
1306
1307 Sharp 320x240. Active, color, single scan.
1308 It isn't 16x9, and I am not sure what it is.
1309
1310 CONFIG_SHARP_LQ64D341
1311
1312 Sharp LQ64D341 display, 640x480.
1313 Active, color, single scan.
1314
1315 CONFIG_HLD1045
1316
1317 HLD1045 display, 640x480.
1318 Active, color, single scan.
1319
1320 CONFIG_OPTREX_BW
1321
1322 Optrex CBL50840-2 NF-FW 99 22 M5
1323 or
1324 Hitachi LMG6912RPFC-00T
1325 or
1326 Hitachi SP14Q002
1327
1328 320x240. Black & white.
1329
Simon Glass676d3192012-10-17 13:24:54 +00001330 CONFIG_LCD_ALIGNMENT
1331
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001332 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001333 defined then the LCD will be aligned to this value instead.
1334 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1335 here, since it is cheaper to change data cache settings on
1336 a per-section basis.
1337
1338
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001339 CONFIG_LCD_ROTATION
1340
1341 Sometimes, for example if the display is mounted in portrait
1342 mode or even if it's mounted landscape but rotated by 180degree,
1343 we need to rotate our content of the display relative to the
1344 framebuffer, so that user can read the messages which are
1345 printed out.
1346 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1347 initialized with a given rotation from "vl_rot" out of
1348 "vidinfo_t" which is provided by the board specific code.
1349 The value for vl_rot is coded as following (matching to
1350 fbcon=rotate:<n> linux-kernel commandline):
1351 0 = no rotation respectively 0 degree
1352 1 = 90 degree rotation
1353 2 = 180 degree rotation
1354 3 = 270 degree rotation
1355
1356 If CONFIG_LCD_ROTATION is not defined, the console will be
1357 initialized with 0degree rotation.
1358
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001359 CONFIG_LCD_BMP_RLE8
1360
1361 Support drawing of RLE8-compressed bitmaps on the LCD.
1362
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001363 CONFIG_I2C_EDID
1364
1365 Enables an 'i2c edid' command which can read EDID
1366 information over I2C from an attached LCD display.
1367
wdenk7152b1d2003-09-05 23:19:14 +00001368- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001369
wdenk8bde7f72003-06-27 21:31:46 +00001370 If this option is set, the environment is checked for
1371 a variable "splashimage". If found, the usual display
1372 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001373 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001374 specified in "splashimage" is loaded instead. The
1375 console is redirected to the "nulldev", too. This
1376 allows for a "silent" boot where a splash screen is
1377 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001378
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001379 CONFIG_SPLASHIMAGE_GUARD
1380
1381 If this option is set, then U-Boot will prevent the environment
1382 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001383 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001384 This option is useful for targets where, due to alignment
1385 restrictions, an improperly aligned BMP image will cause a data
1386 abort. If you think you will not have problems with unaligned
1387 accesses (for example because your toolchain prevents them)
1388 there is no need to set this option.
1389
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001390 CONFIG_SPLASH_SCREEN_ALIGN
1391
1392 If this option is set the splash image can be freely positioned
1393 on the screen. Environment variable "splashpos" specifies the
1394 position as "x,y". If a positive number is given it is used as
1395 number of pixel from left/top. If a negative number is given it
1396 is used as number of pixel from right/bottom. You can also
1397 specify 'm' for centering the image.
1398
1399 Example:
1400 setenv splashpos m,m
1401 => image at center of screen
1402
1403 setenv splashpos 30,20
1404 => image at x = 30 and y = 20
1405
1406 setenv splashpos -10,m
1407 => vertically centered image
1408 at x = dspWidth - bmpWidth - 9
1409
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001410- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1411
1412 If this option is set, additionally to standard BMP
1413 images, gzipped BMP images can be displayed via the
1414 splashscreen support or the bmp command.
1415
Anatolij Gustschind5011762010-03-15 14:50:25 +01001416- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1417
1418 If this option is set, 8-bit RLE compressed BMP images
1419 can be displayed via the splashscreen support or the
1420 bmp command.
1421
wdenkc29fdfc2003-08-29 20:57:53 +00001422- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001423 CONFIG_GZIP
1424
1425 Enabled by default to support gzip compressed images.
1426
wdenkc29fdfc2003-08-29 20:57:53 +00001427 CONFIG_BZIP2
1428
1429 If this option is set, support for bzip2 compressed
1430 images is included. If not, only uncompressed and gzip
1431 compressed images are supported.
1432
wdenk42d1f032003-10-15 23:53:47 +00001433 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001434 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001435 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001436
wdenk17ea1172004-06-06 21:51:03 +00001437- MII/PHY support:
1438 CONFIG_PHY_ADDR
1439
1440 The address of PHY on MII bus.
1441
1442 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1443
1444 The clock frequency of the MII bus
1445
wdenk17ea1172004-06-06 21:51:03 +00001446 CONFIG_PHY_RESET_DELAY
1447
1448 Some PHY like Intel LXT971A need extra delay after
1449 reset before any MII register access is possible.
1450 For such PHY, set this option to the usec delay
1451 required. (minimum 300usec for LXT971A)
1452
1453 CONFIG_PHY_CMD_DELAY (ppc4xx)
1454
1455 Some PHY like Intel LXT971A need extra delay after
1456 command issued before MII status register can be read
1457
wdenkc6097192002-11-03 00:24:07 +00001458- IP address:
1459 CONFIG_IPADDR
1460
1461 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001462 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001463 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001464 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001465
1466- Server IP address:
1467 CONFIG_SERVERIP
1468
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001469 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001470 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001471 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001472
Robin Getz97cfe862009-07-21 12:15:28 -04001473 CONFIG_KEEP_SERVERADDR
1474
1475 Keeps the server's MAC address, in the env 'serveraddr'
1476 for passing to bootargs (like Linux's netconsole option)
1477
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001478- Gateway IP address:
1479 CONFIG_GATEWAYIP
1480
1481 Defines a default value for the IP address of the
1482 default router where packets to other networks are
1483 sent to.
1484 (Environment variable "gatewayip")
1485
1486- Subnet mask:
1487 CONFIG_NETMASK
1488
1489 Defines a default value for the subnet mask (or
1490 routing prefix) which is used to determine if an IP
1491 address belongs to the local subnet or needs to be
1492 forwarded through a router.
1493 (Environment variable "netmask")
1494
David Updegraff53a5c422007-06-11 10:41:07 -05001495- Multicast TFTP Mode:
1496 CONFIG_MCAST_TFTP
1497
1498 Defines whether you want to support multicast TFTP as per
1499 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001500 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001501 driver in use must provide a function: mcast() to join/leave a
1502 multicast group.
1503
wdenkc6097192002-11-03 00:24:07 +00001504- BOOTP Recovery Mode:
1505 CONFIG_BOOTP_RANDOM_DELAY
1506
1507 If you have many targets in a network that try to
1508 boot using BOOTP, you may want to avoid that all
1509 systems send out BOOTP requests at precisely the same
1510 moment (which would happen for instance at recovery
1511 from a power failure, when all systems will try to
1512 boot, thus flooding the BOOTP server. Defining
1513 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1514 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001515 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001516
1517 1st BOOTP request: delay 0 ... 1 sec
1518 2nd BOOTP request: delay 0 ... 2 sec
1519 3rd BOOTP request: delay 0 ... 4 sec
1520 4th and following
1521 BOOTP requests: delay 0 ... 8 sec
1522
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001523 CONFIG_BOOTP_ID_CACHE_SIZE
1524
1525 BOOTP packets are uniquely identified using a 32-bit ID. The
1526 server will copy the ID from client requests to responses and
1527 U-Boot will use this to determine if it is the destination of
1528 an incoming response. Some servers will check that addresses
1529 aren't in use before handing them out (usually using an ARP
1530 ping) and therefore take up to a few hundred milliseconds to
1531 respond. Network congestion may also influence the time it
1532 takes for a response to make it back to the client. If that
1533 time is too long, U-Boot will retransmit requests. In order
1534 to allow earlier responses to still be accepted after these
1535 retransmissions, U-Boot's BOOTP client keeps a small cache of
1536 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1537 cache. The default is to keep IDs for up to four outstanding
1538 requests. Increasing this will allow U-Boot to accept offers
1539 from a BOOTP client in networks with unusually high latency.
1540
stroesefe389a82003-08-28 14:17:32 +00001541- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001542 You can fine tune the DHCP functionality by defining
1543 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001544
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001545 CONFIG_BOOTP_SUBNETMASK
1546 CONFIG_BOOTP_GATEWAY
1547 CONFIG_BOOTP_HOSTNAME
1548 CONFIG_BOOTP_NISDOMAIN
1549 CONFIG_BOOTP_BOOTPATH
1550 CONFIG_BOOTP_BOOTFILESIZE
1551 CONFIG_BOOTP_DNS
1552 CONFIG_BOOTP_DNS2
1553 CONFIG_BOOTP_SEND_HOSTNAME
1554 CONFIG_BOOTP_NTPSERVER
1555 CONFIG_BOOTP_TIMEOFFSET
1556 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001557 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001558
Wilson Callan5d110f02007-07-28 10:56:13 -04001559 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1560 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001561
Joe Hershberger2c00e092012-05-23 07:59:19 +00001562 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1563 after the configured retry count, the call will fail
1564 instead of starting over. This can be used to fail over
1565 to Link-local IP address configuration if the DHCP server
1566 is not available.
1567
stroesefe389a82003-08-28 14:17:32 +00001568 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1569 serverip from a DHCP server, it is possible that more
1570 than one DNS serverip is offered to the client.
1571 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1572 serverip will be stored in the additional environment
1573 variable "dnsip2". The first DNS serverip is always
1574 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001575 is defined.
stroesefe389a82003-08-28 14:17:32 +00001576
1577 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1578 to do a dynamic update of a DNS server. To do this, they
1579 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001580 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001581 of the "hostname" environment variable is passed as
1582 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001583
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001584 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1585
1586 A 32bit value in microseconds for a delay between
1587 receiving a "DHCP Offer" and sending the "DHCP Request".
1588 This fixes a problem with certain DHCP servers that don't
1589 respond 100% of the time to a "DHCP request". E.g. On an
1590 AT91RM9200 processor running at 180MHz, this delay needed
1591 to be *at least* 15,000 usec before a Windows Server 2003
1592 DHCP server would reply 100% of the time. I recommend at
1593 least 50,000 usec to be safe. The alternative is to hope
1594 that one of the retries will be successful but note that
1595 the DHCP timeout and retry process takes a longer than
1596 this delay.
1597
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001598 - Link-local IP address negotiation:
1599 Negotiate with other link-local clients on the local network
1600 for an address that doesn't require explicit configuration.
1601 This is especially useful if a DHCP server cannot be guaranteed
1602 to exist in all environments that the device must operate.
1603
1604 See doc/README.link-local for more information.
1605
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301606 - MAC address from environment variables
1607
1608 FDT_SEQ_MACADDR_FROM_ENV
1609
1610 Fix-up device tree with MAC addresses fetched sequentially from
1611 environment variables. This config work on assumption that
1612 non-usable ethernet node of device-tree are either not present
1613 or their status has been marked as "disabled".
1614
wdenka3d991b2004-04-15 21:48:45 +00001615 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001616 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001617
1618 The device id used in CDP trigger frames.
1619
1620 CONFIG_CDP_DEVICE_ID_PREFIX
1621
1622 A two character string which is prefixed to the MAC address
1623 of the device.
1624
1625 CONFIG_CDP_PORT_ID
1626
1627 A printf format string which contains the ascii name of
1628 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001629 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001630
1631 CONFIG_CDP_CAPABILITIES
1632
1633 A 32bit integer which indicates the device capabilities;
1634 0x00000010 for a normal host which does not forwards.
1635
1636 CONFIG_CDP_VERSION
1637
1638 An ascii string containing the version of the software.
1639
1640 CONFIG_CDP_PLATFORM
1641
1642 An ascii string containing the name of the platform.
1643
1644 CONFIG_CDP_TRIGGER
1645
1646 A 32bit integer sent on the trigger.
1647
1648 CONFIG_CDP_POWER_CONSUMPTION
1649
1650 A 16bit integer containing the power consumption of the
1651 device in .1 of milliwatts.
1652
1653 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1654
1655 A byte containing the id of the VLAN.
1656
Uri Mashiach79267ed2017-01-19 10:51:05 +02001657- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001658
1659 Several configurations allow to display the current
1660 status using a LED. For instance, the LED will blink
1661 fast while running U-Boot code, stop blinking as
1662 soon as a reply to a BOOTP request was received, and
1663 start blinking slow once the Linux kernel is running
1664 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001665 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001666 feature in U-Boot.
1667
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001668 Additional options:
1669
Uri Mashiach79267ed2017-01-19 10:51:05 +02001670 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001671 The status LED can be connected to a GPIO pin.
1672 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001673 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001674 to include the gpio_led driver in the U-Boot binary.
1675
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001676 CONFIG_GPIO_LED_INVERTED_TABLE
1677 Some GPIO connected LEDs may have inverted polarity in which
1678 case the GPIO high value corresponds to LED off state and
1679 GPIO low value corresponds to LED on state.
1680 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1681 with a list of GPIO LEDs that have inverted polarity.
1682
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001683- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001684
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001685 This enable the NEW i2c subsystem, and will allow you to use
1686 i2c commands at the u-boot command line (as long as you set
1687 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1688 based realtime clock chips or other i2c devices. See
1689 common/cmd_i2c.c for a description of the command line
1690 interface.
1691
1692 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001693 - drivers/i2c/soft_i2c.c:
1694 - activate first bus with CONFIG_SYS_I2C_SOFT define
1695 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1696 for defining speed and slave address
1697 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1698 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1699 for defining speed and slave address
1700 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1701 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1702 for defining speed and slave address
1703 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1704 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1705 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001706
Heiko Schocher00f792e2012-10-24 13:48:22 +02001707 - drivers/i2c/fsl_i2c.c:
1708 - activate i2c driver with CONFIG_SYS_I2C_FSL
1709 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1710 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1711 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1712 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001713 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001714 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1715 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1716 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1717 second bus.
1718
Simon Glass1f2ba722012-10-30 07:28:53 +00001719 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001720 - activate this driver with CONFIG_SYS_I2C_TEGRA
1721 - This driver adds 4 i2c buses with a fix speed from
1722 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001723
Dirk Eibach880540d2013-04-25 02:40:01 +00001724 - drivers/i2c/ppc4xx_i2c.c
1725 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1726 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1727 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1728
tremfac96402013-09-21 18:13:35 +02001729 - drivers/i2c/i2c_mxc.c
1730 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001731 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1732 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1733 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1734 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001735 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1736 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1737 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1738 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1739 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1740 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001741 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1742 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001743 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001744 for speed, and 0 for slave.
1745
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001746 - drivers/i2c/rcar_i2c.c:
1747 - activate this driver with CONFIG_SYS_I2C_RCAR
1748 - This driver adds 4 i2c buses
1749
1750 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1751 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1752 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1753 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1754 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1755 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1756 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1757 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1758 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1759
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001760 - drivers/i2c/sh_i2c.c:
1761 - activate this driver with CONFIG_SYS_I2C_SH
1762 - This driver adds from 2 to 5 i2c buses
1763
1764 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1765 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1766 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1767 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1768 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1769 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1770 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1771 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1772 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1773 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001774 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001775
Heiko Schocher6789e842013-10-22 11:03:18 +02001776 - drivers/i2c/omap24xx_i2c.c
1777 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1778 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1779 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1780 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1781 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1782 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1783 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1784 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1785 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1786 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1787 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1788
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001789 - drivers/i2c/zynq_i2c.c
1790 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1791 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1792 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1793
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301794 - drivers/i2c/s3c24x0_i2c.c:
1795 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1796 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1797 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1798 with a fix speed from 100000 and the slave addr 0!
1799
Dirk Eibachb46226b2014-07-03 09:28:18 +02001800 - drivers/i2c/ihs_i2c.c
1801 - activate this driver with CONFIG_SYS_I2C_IHS
1802 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1803 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1804 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1805 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1806 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1807 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1808 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1809 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1810 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1811 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1812 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1813 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001814 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1815 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1816 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1817 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1818 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1819 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1820 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1821 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1822 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001823
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001824 additional defines:
1825
1826 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001827 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001828
1829 CONFIG_SYS_I2C_DIRECT_BUS
1830 define this, if you don't use i2c muxes on your hardware.
1831 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1832 omit this define.
1833
1834 CONFIG_SYS_I2C_MAX_HOPS
1835 define how many muxes are maximal consecutively connected
1836 on one i2c bus. If you not use i2c muxes, omit this
1837 define.
1838
1839 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001840 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001841 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1842 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1843 CONFIG_SYS_NUM_I2C_BUSES = 9:
1844
1845 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1846 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1847 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1848 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1849 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1850 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1851 {1, {I2C_NULL_HOP}}, \
1852 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1853 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1854 }
1855
1856 which defines
1857 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001858 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1859 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1860 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1861 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1862 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001863 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001864 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1865 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001866
1867 If you do not have i2c muxes on your board, omit this define.
1868
Simon Glassce3b5d62017-05-12 21:10:00 -06001869- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001870 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001871 then the following macros need to be defined (examples are
1872 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001873
1874 I2C_INIT
1875
wdenkb37c7e52003-06-30 16:24:52 +00001876 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001877 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001878
wdenkba56f622004-02-06 23:19:44 +00001879 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001880
wdenkc6097192002-11-03 00:24:07 +00001881 I2C_ACTIVE
1882
1883 The code necessary to make the I2C data line active
1884 (driven). If the data line is open collector, this
1885 define can be null.
1886
wdenkb37c7e52003-06-30 16:24:52 +00001887 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1888
wdenkc6097192002-11-03 00:24:07 +00001889 I2C_TRISTATE
1890
1891 The code necessary to make the I2C data line tri-stated
1892 (inactive). If the data line is open collector, this
1893 define can be null.
1894
wdenkb37c7e52003-06-30 16:24:52 +00001895 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1896
wdenkc6097192002-11-03 00:24:07 +00001897 I2C_READ
1898
York Sun472d5462013-04-01 11:29:11 -07001899 Code that returns true if the I2C data line is high,
1900 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001901
wdenkb37c7e52003-06-30 16:24:52 +00001902 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1903
wdenkc6097192002-11-03 00:24:07 +00001904 I2C_SDA(bit)
1905
York Sun472d5462013-04-01 11:29:11 -07001906 If <bit> is true, sets the I2C data line high. If it
1907 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001908
wdenkb37c7e52003-06-30 16:24:52 +00001909 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001910 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001911 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001912
wdenkc6097192002-11-03 00:24:07 +00001913 I2C_SCL(bit)
1914
York Sun472d5462013-04-01 11:29:11 -07001915 If <bit> is true, sets the I2C clock line high. If it
1916 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001917
wdenkb37c7e52003-06-30 16:24:52 +00001918 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001919 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001920 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001921
wdenkc6097192002-11-03 00:24:07 +00001922 I2C_DELAY
1923
1924 This delay is invoked four times per clock cycle so this
1925 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001926 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001927 like:
1928
wdenkb37c7e52003-06-30 16:24:52 +00001929 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001930
Mike Frysinger793b5722010-07-21 13:38:02 -04001931 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1932
1933 If your arch supports the generic GPIO framework (asm/gpio.h),
1934 then you may alternatively define the two GPIOs that are to be
1935 used as SCL / SDA. Any of the previous I2C_xxx macros will
1936 have GPIO-based defaults assigned to them as appropriate.
1937
1938 You should define these to the GPIO value as given directly to
1939 the generic GPIO functions.
1940
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001941 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001942
wdenk8bde7f72003-06-27 21:31:46 +00001943 When a board is reset during an i2c bus transfer
1944 chips might think that the current transfer is still
1945 in progress. On some boards it is possible to access
1946 the i2c SCLK line directly, either by using the
1947 processor pin as a GPIO or by having a second pin
1948 connected to the bus. If this option is defined a
1949 custom i2c_init_board() routine in boards/xxx/board.c
1950 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001951
Ben Warrenbb99ad62006-09-07 16:50:54 -04001952 CONFIG_I2C_MULTI_BUS
1953
1954 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001955 must have a controller. At any point in time, only one bus is
1956 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001957 Note that bus numbering is zero-based.
1958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001959 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001960
1961 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001962 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001963 is set, specify a list of bus-device pairs. Otherwise, specify
1964 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001965
1966 e.g.
1967 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001968 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001969
1970 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1971
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001972 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001973 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001974
1975 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1976
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001977 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001978
1979 If defined, then this indicates the I2C bus number for DDR SPD.
1980 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001982 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001983
1984 If defined, then this indicates the I2C bus number for the RTC.
1985 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1986
Andrew Dyer2ac69852008-12-29 17:36:01 -06001987 CONFIG_SOFT_I2C_READ_REPEATED_START
1988
1989 defining this will force the i2c_read() function in
1990 the soft_i2c driver to perform an I2C repeated start
1991 between writing the address pointer and reading the
1992 data. If this define is omitted the default behaviour
1993 of doing a stop-start sequence will be used. Most I2C
1994 devices can use either method, but some require one or
1995 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001996
wdenkc6097192002-11-03 00:24:07 +00001997- SPI Support: CONFIG_SPI
1998
1999 Enables SPI driver (so far only tested with
2000 SPI EEPROM, also an instance works with Crystal A/D and
2001 D/As on the SACSng board)
2002
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002003 CONFIG_SH_SPI
2004
2005 Enables the driver for SPI controller on SuperH. Currently
2006 only SH7757 is supported.
2007
wdenkc6097192002-11-03 00:24:07 +00002008 CONFIG_SOFT_SPI
2009
wdenk43d96162003-03-06 00:02:04 +00002010 Enables a software (bit-bang) SPI driver rather than
2011 using hardware support. This is a general purpose
2012 driver that only requires three general I/O port pins
2013 (two outputs, one input) to function. If this is
2014 defined, the board configuration must define several
2015 SPI configuration items (port pins to use, etc). For
2016 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002017
Ben Warren04a9e112008-01-16 22:37:35 -05002018 CONFIG_HARD_SPI
2019
2020 Enables a hardware SPI driver for general-purpose reads
2021 and writes. As with CONFIG_SOFT_SPI, the board configuration
2022 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002023 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002024 example, see include/configs/mpc8349emds.h.
2025
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002026 CONFIG_MXC_SPI
2027
2028 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002029 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002030
Heiko Schocherf659b572014-07-14 10:22:11 +02002031 CONFIG_SYS_SPI_MXC_WAIT
2032 Timeout for waiting until spi transfer completed.
2033 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2034
Matthias Fuchs01335022007-12-27 17:12:34 +01002035- FPGA Support: CONFIG_FPGA
2036
2037 Enables FPGA subsystem.
2038
2039 CONFIG_FPGA_<vendor>
2040
2041 Enables support for specific chip vendors.
2042 (ALTERA, XILINX)
2043
2044 CONFIG_FPGA_<family>
2045
2046 Enables support for FPGA family.
2047 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2048
2049 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002050
wdenk43d96162003-03-06 00:02:04 +00002051 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002053 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002054
wdenk8bde7f72003-06-27 21:31:46 +00002055 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002057 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002058
wdenk43d96162003-03-06 00:02:04 +00002059 Enable checks on FPGA configuration interface busy
2060 status by the configuration function. This option
2061 will require a board or device specific function to
2062 be written.
wdenkc6097192002-11-03 00:24:07 +00002063
2064 CONFIG_FPGA_DELAY
2065
2066 If defined, a function that provides delays in the FPGA
2067 configuration driver.
2068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002069 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002070 Allow Control-C to interrupt FPGA configuration
2071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002072 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002073
wdenk43d96162003-03-06 00:02:04 +00002074 Check for configuration errors during FPGA bitfile
2075 loading. For example, abort during Virtex II
2076 configuration if the INIT_B line goes low (which
2077 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002079 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002080
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002081 Maximum time to wait for the INIT_B line to de-assert
2082 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002083 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002084 ms.
wdenkc6097192002-11-03 00:24:07 +00002085
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002086 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002087
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002088 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002089 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002091 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002092
wdenk43d96162003-03-06 00:02:04 +00002093 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002094 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002095
2096- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002097 CONFIG_BUILD_TARGET
2098
2099 Some SoCs need special image types (e.g. U-Boot binary
2100 with a special header) as build targets. By defining
2101 CONFIG_BUILD_TARGET in the SoC / board header, this
2102 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002103 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002104
wdenkc6097192002-11-03 00:24:07 +00002105 CONFIG_IDENT_STRING
2106
wdenk43d96162003-03-06 00:02:04 +00002107 If defined, this string will be added to the U-Boot
2108 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002109
2110- Vendor Parameter Protection:
2111
wdenk43d96162003-03-06 00:02:04 +00002112 U-Boot considers the values of the environment
2113 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002114 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002115 are set once by the board vendor / manufacturer, and
2116 protects these variables from casual modification by
2117 the user. Once set, these variables are read-only,
2118 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002119 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002120
2121 If CONFIG_ENV_OVERWRITE is #defined in your config
2122 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002123 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002124 these parameters.
2125
Joe Hershberger92ac5202015-05-04 14:55:14 -05002126 Alternatively, if you define _both_ an ethaddr in the
2127 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002128 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002129 which can be changed exactly ONCE by the user. [The
2130 serial# is unaffected by this, i. e. it remains
2131 read-only.]
2132
Joe Hershberger25980902012-12-11 22:16:31 -06002133 The same can be accomplished in a more flexible way
2134 for any variable by configuring the type of access
2135 to allow for those variables in the ".flags" variable
2136 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2137
wdenkc6097192002-11-03 00:24:07 +00002138- Protected RAM:
2139 CONFIG_PRAM
2140
2141 Define this variable to enable the reservation of
2142 "protected RAM", i. e. RAM which is not overwritten
2143 by U-Boot. Define CONFIG_PRAM to hold the number of
2144 kB you want to reserve for pRAM. You can overwrite
2145 this default value by defining an environment
2146 variable "pram" to the number of kB you want to
2147 reserve. Note that the board info structure will
2148 still show the full amount of RAM. If pRAM is
2149 reserved, a new environment variable "mem" will
2150 automatically be defined to hold the amount of
2151 remaining RAM in a form that can be passed as boot
2152 argument to Linux, for instance like that:
2153
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002154 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002155 saveenv
2156
2157 This way you can tell Linux not to use this memory,
2158 either, which results in a memory region that will
2159 not be affected by reboots.
2160
2161 *WARNING* If your board configuration uses automatic
2162 detection of the RAM size, you must make sure that
2163 this memory test is non-destructive. So far, the
2164 following board configurations are known to be
2165 "pRAM-clean":
2166
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002167 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002168 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002169 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002170
Gabe Black40fef042012-12-02 04:55:18 +00002171- Access to physical memory region (> 4GB)
2172 Some basic support is provided for operations on memory not
2173 normally accessible to U-Boot - e.g. some architectures
2174 support access to more than 4GB of memory on 32-bit
2175 machines using physical address extension or similar.
2176 Define CONFIG_PHYSMEM to access this basic support, which
2177 currently only supports clearing the memory.
2178
wdenkc6097192002-11-03 00:24:07 +00002179- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002180 CONFIG_NET_RETRY_COUNT
2181
wdenk43d96162003-03-06 00:02:04 +00002182 This variable defines the number of retries for
2183 network operations like ARP, RARP, TFTP, or BOOTP
2184 before giving up the operation. If not defined, a
2185 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002186
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002187 CONFIG_ARP_TIMEOUT
2188
2189 Timeout waiting for an ARP reply in milliseconds.
2190
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002191 CONFIG_NFS_TIMEOUT
2192
2193 Timeout in milliseconds used in NFS protocol.
2194 If you encounter "ERROR: Cannot umount" in nfs command,
2195 try longer timeout such as
2196 #define CONFIG_NFS_TIMEOUT 10000UL
2197
wdenkc6097192002-11-03 00:24:07 +00002198- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002199 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002200
2201 Enable auto completion of commands using TAB.
2202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002203 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002204
2205 This defines the secondary prompt string, which is
2206 printed when the command interpreter needs more input
2207 to complete a command. Usually "> ".
2208
2209 Note:
2210
wdenk8bde7f72003-06-27 21:31:46 +00002211 In the current implementation, the local variables
2212 space and global environment variables space are
2213 separated. Local variables are those you define by
2214 simply typing `name=value'. To access a local
2215 variable later on, you have write `$name' or
2216 `${name}'; to execute the contents of a variable
2217 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002218
wdenk43d96162003-03-06 00:02:04 +00002219 Global environment variables are those you use
2220 setenv/printenv to work with. To run a command stored
2221 in such a variable, you need to use the run command,
2222 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002223
2224 To store commands and special characters in a
2225 variable, please use double quotation marks
2226 surrounding the whole text of the variable, instead
2227 of the backslashes before semicolons and special
2228 symbols.
2229
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002230- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002231 CONFIG_CMDLINE_EDITING
2232
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002233 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002234 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002235
Marek Vasutf3b267b2016-01-27 04:47:55 +01002236- Command Line PS1/PS2 support:
2237 CONFIG_CMDLINE_PS_SUPPORT
2238
2239 Enable support for changing the command prompt string
2240 at run-time. Only static string is supported so far.
2241 The string is obtained from environment variables PS1
2242 and PS2.
2243
wdenka8c7c702003-12-06 19:49:23 +00002244- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002245 CONFIG_EXTRA_ENV_SETTINGS
2246
wdenk43d96162003-03-06 00:02:04 +00002247 Define this to contain any number of null terminated
2248 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002249 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002250
wdenk43d96162003-03-06 00:02:04 +00002251 For example, place something like this in your
2252 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002253
2254 #define CONFIG_EXTRA_ENV_SETTINGS \
2255 "myvar1=value1\0" \
2256 "myvar2=value2\0"
2257
wdenk43d96162003-03-06 00:02:04 +00002258 Warning: This method is based on knowledge about the
2259 internal format how the environment is stored by the
2260 U-Boot code. This is NOT an official, exported
2261 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002262 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002263 You better know what you are doing here.
2264
wdenk43d96162003-03-06 00:02:04 +00002265 Note: overly (ab)use of the default environment is
2266 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002267 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002268 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002269
Stephen Warren5e724ca2012-05-22 09:21:54 +00002270 CONFIG_ENV_VARS_UBOOT_CONFIG
2271
2272 Define this in order to add variables describing the
2273 U-Boot build configuration to the default environment.
2274 These will be named arch, cpu, board, vendor, and soc.
2275
2276 Enabling this option will cause the following to be defined:
2277
2278 - CONFIG_SYS_ARCH
2279 - CONFIG_SYS_CPU
2280 - CONFIG_SYS_BOARD
2281 - CONFIG_SYS_VENDOR
2282 - CONFIG_SYS_SOC
2283
Tom Rini7e27f892012-10-24 07:28:16 +00002284 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2285
2286 Define this in order to add variables describing certain
2287 run-time determined information about the hardware to the
2288 environment. These will be named board_name, board_rev.
2289
Simon Glass06fd8532012-11-30 13:01:17 +00002290 CONFIG_DELAY_ENVIRONMENT
2291
2292 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002293 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002294 that so that the environment is not available until
2295 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2296 this is instead controlled by the value of
2297 /config/load-environment.
2298
Eric Nelsonf61ec452012-01-31 10:52:08 -07002299- Serial Flash support
Simon Glass00fd59d2017-08-04 16:35:06 -06002300 Usage requires an initial 'sf probe' to define the serial
Eric Nelsonf61ec452012-01-31 10:52:08 -07002301 flash parameters, followed by read/write/erase/update
2302 commands.
2303
2304 The following defaults may be provided by the platform
2305 to handle the common case when only a single serial
2306 flash is present on the system.
2307
2308 CONFIG_SF_DEFAULT_BUS Bus identifier
2309 CONFIG_SF_DEFAULT_CS Chip-select
2310 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2311 CONFIG_SF_DEFAULT_SPEED in Hz
2312
wdenk3f85ce22004-02-23 16:11:30 +00002313 CONFIG_SYSTEMACE
2314
2315 Adding this option adds support for Xilinx SystemACE
2316 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002317 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002318 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002319
2320 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002321 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002322
2323 When SystemACE support is added, the "ace" device type
2324 becomes available to the fat commands, i.e. fatls.
2325
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002326- TFTP Fixed UDP Port:
2327 CONFIG_TFTP_PORT
2328
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002329 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002330 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002331 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002332 number generator is used.
2333
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002334 Also, the environment variable tftpdstp is used to supply
2335 the TFTP UDP destination port value. If tftpdstp isn't
2336 defined, the normal port 69 is used.
2337
2338 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002339 blindly start the TFTP transfer using the pre-configured
2340 target IP address and UDP port. This has the effect of
2341 "punching through" the (Windows XP) firewall, allowing
2342 the remainder of the TFTP transfer to proceed normally.
2343 A better solution is to properly configure the firewall,
2344 but sometimes that is not allowed.
2345
Heiko Schocher9e50c402014-01-25 07:27:13 +01002346- bootcount support:
2347 CONFIG_BOOTCOUNT_LIMIT
2348
2349 This enables the bootcounter support, see:
2350 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2351
2352 CONFIG_AT91SAM9XE
2353 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002354 CONFIG_SOC_DA8XX
2355 enable special bootcounter support on da850 based boards.
2356 CONFIG_BOOTCOUNT_RAM
2357 enable support for the bootcounter in RAM
2358 CONFIG_BOOTCOUNT_I2C
2359 enable support for the bootcounter on an i2c (like RTC) device.
2360 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2361 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2362 the bootcounter.
2363 CONFIG_BOOTCOUNT_ALEN = address len
Ian Rayf31dac42017-11-08 15:35:13 +00002364 CONFIG_BOOTCOUNT_EXT
2365 enable support for the bootcounter in EXT filesystem
2366 CONFIG_SYS_BOOTCOUNT_ADDR = RAM address used for read
2367 and write.
2368 CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE = interface
2369 CONFIG_SYS_BOOTCOUNT_EXT_DEVPART = device and part
2370 CONFIG_SYS_BOOTCOUNT_EXT_NAME = filename
Simon Glass19c402a2013-06-13 15:10:02 -07002371
wdenka8c7c702003-12-06 19:49:23 +00002372- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002373 CONFIG_SHOW_BOOT_PROGRESS
2374
wdenk43d96162003-03-06 00:02:04 +00002375 Defining this option allows to add some board-
2376 specific code (calling a user-provided function
2377 "show_boot_progress(int)") that enables you to show
2378 the system's boot progress on some display (for
2379 example, some LED's) on your board. At the moment,
2380 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002381
Simon Glass94fd1312012-09-28 08:56:37 +00002382
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002383Legacy uImage format:
2384
wdenkc6097192002-11-03 00:24:07 +00002385 Arg Where When
2386 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002387 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002388 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002389 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002390 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002391 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002392 4 common/cmd_bootm.c Image data has correct checksum
2393 -4 common/cmd_bootm.c Image is for unsupported architecture
2394 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002395 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002396 6 common/cmd_bootm.c Image Type check OK
2397 -6 common/cmd_bootm.c gunzip uncompression error
2398 -7 common/cmd_bootm.c Unimplemented compression type
2399 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002400 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002401 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002402
2403 9 common/image.c Start initial ramdisk verification
2404 -10 common/image.c Ramdisk header has bad magic number
2405 -11 common/image.c Ramdisk header has bad checksum
2406 10 common/image.c Ramdisk header is OK
2407 -12 common/image.c Ramdisk data has bad checksum
2408 11 common/image.c Ramdisk data has correct checksum
2409 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002410 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002411 13 common/image.c Start multifile image verification
2412 14 common/image.c No initial ramdisk, no multifile, continue.
2413
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002414 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002415
Stefan Roesea47a12b2010-04-15 16:07:28 +02002416 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002417 -31 post/post.c POST test failed, detected by post_output_backlog()
2418 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002419
Heiko Schocher566a4942007-06-22 19:11:54 +02002420 34 common/cmd_doc.c before loading a Image from a DOC device
2421 -35 common/cmd_doc.c Bad usage of "doc" command
2422 35 common/cmd_doc.c correct usage of "doc" command
2423 -36 common/cmd_doc.c No boot device
2424 36 common/cmd_doc.c correct boot device
2425 -37 common/cmd_doc.c Unknown Chip ID on boot device
2426 37 common/cmd_doc.c correct chip ID found, device available
2427 -38 common/cmd_doc.c Read Error on boot device
2428 38 common/cmd_doc.c reading Image header from DOC device OK
2429 -39 common/cmd_doc.c Image header has bad magic number
2430 39 common/cmd_doc.c Image header has correct magic number
2431 -40 common/cmd_doc.c Error reading Image from DOC device
2432 40 common/cmd_doc.c Image header has correct magic number
2433 41 common/cmd_ide.c before loading a Image from a IDE device
2434 -42 common/cmd_ide.c Bad usage of "ide" command
2435 42 common/cmd_ide.c correct usage of "ide" command
2436 -43 common/cmd_ide.c No boot device
2437 43 common/cmd_ide.c boot device found
2438 -44 common/cmd_ide.c Device not available
2439 44 common/cmd_ide.c Device available
2440 -45 common/cmd_ide.c wrong partition selected
2441 45 common/cmd_ide.c partition selected
2442 -46 common/cmd_ide.c Unknown partition table
2443 46 common/cmd_ide.c valid partition table found
2444 -47 common/cmd_ide.c Invalid partition type
2445 47 common/cmd_ide.c correct partition type
2446 -48 common/cmd_ide.c Error reading Image Header on boot device
2447 48 common/cmd_ide.c reading Image Header from IDE device OK
2448 -49 common/cmd_ide.c Image header has bad magic number
2449 49 common/cmd_ide.c Image header has correct magic number
2450 -50 common/cmd_ide.c Image header has bad checksum
2451 50 common/cmd_ide.c Image header has correct checksum
2452 -51 common/cmd_ide.c Error reading Image from IDE device
2453 51 common/cmd_ide.c reading Image from IDE device OK
2454 52 common/cmd_nand.c before loading a Image from a NAND device
2455 -53 common/cmd_nand.c Bad usage of "nand" command
2456 53 common/cmd_nand.c correct usage of "nand" command
2457 -54 common/cmd_nand.c No boot device
2458 54 common/cmd_nand.c boot device found
2459 -55 common/cmd_nand.c Unknown Chip ID on boot device
2460 55 common/cmd_nand.c correct chip ID found, device available
2461 -56 common/cmd_nand.c Error reading Image Header on boot device
2462 56 common/cmd_nand.c reading Image Header from NAND device OK
2463 -57 common/cmd_nand.c Image header has bad magic number
2464 57 common/cmd_nand.c Image header has correct magic number
2465 -58 common/cmd_nand.c Error reading Image from NAND device
2466 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002467
Heiko Schocher566a4942007-06-22 19:11:54 +02002468 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002469
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002470 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002471 -64 net/eth.c no Ethernet found.
2472 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002473
Heiko Schocher566a4942007-06-22 19:11:54 +02002474 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002475 80 common/cmd_net.c before calling net_loop()
2476 -81 common/cmd_net.c some error in net_loop() occurred
2477 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002478 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2479 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002480 83 common/cmd_net.c running "source" command
2481 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002482 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002483
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002484FIT uImage format:
2485
2486 Arg Where When
2487 100 common/cmd_bootm.c Kernel FIT Image has correct format
2488 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2489 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2490 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2491 102 common/cmd_bootm.c Kernel unit name specified
2492 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002493 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002494 104 common/cmd_bootm.c Got kernel subimage node offset
2495 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2496 105 common/cmd_bootm.c Kernel subimage hash verification OK
2497 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2498 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002499 -106 common/cmd_bootm.c Kernel subimage has wrong type
2500 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002501 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2502 108 common/cmd_bootm.c Got kernel subimage data/size
2503 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2504 -109 common/cmd_bootm.c Can't get kernel subimage type
2505 -110 common/cmd_bootm.c Can't get kernel subimage comp
2506 -111 common/cmd_bootm.c Can't get kernel subimage os
2507 -112 common/cmd_bootm.c Can't get kernel subimage load address
2508 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2509
2510 120 common/image.c Start initial ramdisk verification
2511 -120 common/image.c Ramdisk FIT image has incorrect format
2512 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002513 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002514 -122 common/image.c Can't get configuration for ramdisk subimage
2515 123 common/image.c Ramdisk unit name specified
2516 -124 common/image.c Can't get ramdisk subimage node offset
2517 125 common/image.c Got ramdisk subimage node offset
2518 -125 common/image.c Ramdisk subimage hash verification failed
2519 126 common/image.c Ramdisk subimage hash verification OK
2520 -126 common/image.c Ramdisk subimage for unsupported architecture
2521 127 common/image.c Architecture check OK
2522 -127 common/image.c Can't get ramdisk subimage data/size
2523 128 common/image.c Got ramdisk subimage data/size
2524 129 common/image.c Can't get ramdisk load address
2525 -129 common/image.c Got ramdisk load address
2526
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002527 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002528 131 common/cmd_doc.c FIT image format OK
2529
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002530 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002531 141 common/cmd_ide.c FIT image format OK
2532
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002533 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002534 151 common/cmd_nand.c FIT image format OK
2535
Heiko Schocher21d29f72014-05-28 11:33:33 +02002536- legacy image format:
2537 CONFIG_IMAGE_FORMAT_LEGACY
2538 enables the legacy image format support in U-Boot.
2539
2540 Default:
2541 enabled if CONFIG_FIT_SIGNATURE is not defined.
2542
2543 CONFIG_DISABLE_IMAGE_LEGACY
2544 disable the legacy image format
2545
2546 This define is introduced, as the legacy image format is
2547 enabled per default for backward compatibility.
2548
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002549- Standalone program support:
2550 CONFIG_STANDALONE_LOAD_ADDR
2551
Wolfgang Denk6feff892011-10-09 21:06:34 +02002552 This option defines a board specific value for the
2553 address where standalone program gets loaded, thus
2554 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002555 settings.
2556
2557- Frame Buffer Address:
2558 CONFIG_FB_ADDR
2559
2560 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002561 address for frame buffer. This is typically the case
2562 when using a graphics controller has separate video
2563 memory. U-Boot will then place the frame buffer at
2564 the given address instead of dynamically reserving it
2565 in system RAM by calling lcd_setmem(), which grabs
2566 the memory for the frame buffer depending on the
2567 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002568
2569 Please see board_init_f function.
2570
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002571- Automatic software updates via TFTP server
2572 CONFIG_UPDATE_TFTP
2573 CONFIG_UPDATE_TFTP_CNT_MAX
2574 CONFIG_UPDATE_TFTP_MSEC_MAX
2575
2576 These options enable and control the auto-update feature;
2577 for a more detailed description refer to doc/README.update.
2578
2579- MTD Support (mtdparts command, UBI support)
2580 CONFIG_MTD_DEVICE
2581
2582 Adds the MTD device infrastructure from the Linux kernel.
2583 Needed for mtdparts command support.
2584
2585 CONFIG_MTD_PARTITIONS
2586
2587 Adds the MTD partitioning infrastructure from the Linux
2588 kernel. Needed for UBI support.
2589
Joe Hershberger70c219c2013-04-08 10:32:48 +00002590- UBI support
Joe Hershberger147162d2013-04-08 10:32:49 +00002591 CONFIG_UBI_SILENCE_MSG
2592
2593 Make the verbose messages from UBI stop printing. This leaves
2594 warnings and errors enabled.
2595
Heiko Schocherff94bc42014-06-24 10:10:04 +02002596
2597 CONFIG_MTD_UBI_WL_THRESHOLD
2598 This parameter defines the maximum difference between the highest
2599 erase counter value and the lowest erase counter value of eraseblocks
2600 of UBI devices. When this threshold is exceeded, UBI starts performing
2601 wear leveling by means of moving data from eraseblock with low erase
2602 counter to eraseblocks with high erase counter.
2603
2604 The default value should be OK for SLC NAND flashes, NOR flashes and
2605 other flashes which have eraseblock life-cycle 100000 or more.
2606 However, in case of MLC NAND flashes which typically have eraseblock
2607 life-cycle less than 10000, the threshold should be lessened (e.g.,
2608 to 128 or 256, although it does not have to be power of 2).
2609
2610 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002611
Heiko Schocherff94bc42014-06-24 10:10:04 +02002612 CONFIG_MTD_UBI_BEB_LIMIT
2613 This option specifies the maximum bad physical eraseblocks UBI
2614 expects on the MTD device (per 1024 eraseblocks). If the
2615 underlying flash does not admit of bad eraseblocks (e.g. NOR
2616 flash), this value is ignored.
2617
2618 NAND datasheets often specify the minimum and maximum NVM
2619 (Number of Valid Blocks) for the flashes' endurance lifetime.
2620 The maximum expected bad eraseblocks per 1024 eraseblocks
2621 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2622 which gives 20 for most NANDs (MaxNVB is basically the total
2623 count of eraseblocks on the chip).
2624
2625 To put it differently, if this value is 20, UBI will try to
2626 reserve about 1.9% of physical eraseblocks for bad blocks
2627 handling. And that will be 1.9% of eraseblocks on the entire
2628 NAND chip, not just the MTD partition UBI attaches. This means
2629 that if you have, say, a NAND flash chip admits maximum 40 bad
2630 eraseblocks, and it is split on two MTD partitions of the same
2631 size, UBI will reserve 40 eraseblocks when attaching a
2632 partition.
2633
2634 default: 20
2635
2636 CONFIG_MTD_UBI_FASTMAP
2637 Fastmap is a mechanism which allows attaching an UBI device
2638 in nearly constant time. Instead of scanning the whole MTD device it
2639 only has to locate a checkpoint (called fastmap) on the device.
2640 The on-flash fastmap contains all information needed to attach
2641 the device. Using fastmap makes only sense on large devices where
2642 attaching by scanning takes long. UBI will not automatically install
2643 a fastmap on old images, but you can set the UBI parameter
2644 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2645 that fastmap-enabled images are still usable with UBI implementations
2646 without fastmap support. On typical flash devices the whole fastmap
2647 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2648
2649 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2650 Set this parameter to enable fastmap automatically on images
2651 without a fastmap.
2652 default: 0
2653
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002654 CONFIG_MTD_UBI_FM_DEBUG
2655 Enable UBI fastmap debug
2656 default: 0
2657
Joe Hershberger70c219c2013-04-08 10:32:48 +00002658- UBIFS support
Joe Hershberger147162d2013-04-08 10:32:49 +00002659 CONFIG_UBIFS_SILENCE_MSG
2660
2661 Make the verbose messages from UBIFS stop printing. This leaves
2662 warnings and errors enabled.
2663
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002664- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002665 CONFIG_SPL
2666 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002667
Tom Rini95579792012-02-14 07:29:40 +00002668 CONFIG_SPL_LDSCRIPT
2669 LDSCRIPT for linking the SPL binary.
2670
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002671 CONFIG_SPL_MAX_FOOTPRINT
2672 Maximum size in memory allocated to the SPL, BSS included.
2673 When defined, the linker checks that the actual memory
2674 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002675 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002676 must not be both defined at the same time.
2677
Tom Rini95579792012-02-14 07:29:40 +00002678 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002679 Maximum size of the SPL image (text, data, rodata, and
2680 linker lists sections), BSS excluded.
2681 When defined, the linker checks that the actual size does
2682 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002683
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002684 CONFIG_SPL_TEXT_BASE
2685 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002686
Scott Wood94a45bb2012-09-20 19:05:12 -05002687 CONFIG_SPL_RELOC_TEXT_BASE
2688 Address to relocate to. If unspecified, this is equal to
2689 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2690
Tom Rini95579792012-02-14 07:29:40 +00002691 CONFIG_SPL_BSS_START_ADDR
2692 Link address for the BSS within the SPL binary.
2693
2694 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002695 Maximum size in memory allocated to the SPL BSS.
2696 When defined, the linker checks that the actual memory used
2697 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002698 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002699 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002700
2701 CONFIG_SPL_STACK
2702 Adress of the start of the stack SPL will use
2703
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002704 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2705 When defined, SPL will panic() if the image it has
2706 loaded does not have a signature.
2707 Defining this is useful when code which loads images
2708 in SPL cannot guarantee that absolutely all read errors
2709 will be caught.
2710 An example is the LPC32XX MLC NAND driver, which will
2711 consider that a completely unreadable NAND block is bad,
2712 and thus should be skipped silently.
2713
Scott Wood94a45bb2012-09-20 19:05:12 -05002714 CONFIG_SPL_RELOC_STACK
2715 Adress of the start of the stack SPL will use after
2716 relocation. If unspecified, this is equal to
2717 CONFIG_SPL_STACK.
2718
Tom Rini95579792012-02-14 07:29:40 +00002719 CONFIG_SYS_SPL_MALLOC_START
2720 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002721 When this option is set the full malloc is used in SPL and
2722 it is set up by spl_init() and before that, the simple malloc()
2723 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002724
2725 CONFIG_SYS_SPL_MALLOC_SIZE
2726 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002727
Tom Rini47f7bca2012-08-13 12:03:19 -07002728 CONFIG_SPL_FRAMEWORK
2729 Enable the SPL framework under common/. This framework
2730 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2731 NAND loading of the Linux Kernel.
2732
Tom Rini9607faf2014-03-28 12:03:39 -04002733 CONFIG_SPL_OS_BOOT
2734 Enable booting directly to an OS from SPL.
2735 See also: doc/README.falcon
2736
Tom Rini861a86f2012-08-13 11:37:56 -07002737 CONFIG_SPL_DISPLAY_PRINT
2738 For ARM, enable an optional function to print more information
2739 about the running system.
2740
Scott Wood4b919722012-09-20 16:35:21 -05002741 CONFIG_SPL_INIT_MINIMAL
2742 Arch init code should be built for a very small image
2743
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002744 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2745 Partition on the MMC to load U-Boot from when the MMC is being
2746 used in raw mode
2747
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002748 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2749 Sector to load kernel uImage from when MMC is being
2750 used in raw mode (for Falcon mode)
2751
2752 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2753 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2754 Sector and number of sectors to load kernel argument
2755 parameters from when MMC is being used in raw mode
2756 (for falcon mode)
2757
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002758 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2759 Partition on the MMC to load U-Boot from when the MMC is being
2760 used in fs mode
2761
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002762 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2763 Filename to read to load U-Boot when reading from filesystem
2764
2765 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002766 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002767 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002768
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002769 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002770 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002771 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002772
Scott Wood06f60ae2012-12-06 13:33:17 +00002773 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2774 Set this for NAND SPL on PPC mpc83xx targets, so that
2775 start.S waits for the rest of the SPL to load before
2776 continuing (the hardware starts execution after just
2777 loading the first page rather than the full 4K).
2778
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302779 CONFIG_SPL_SKIP_RELOCATE
2780 Avoid SPL relocation
2781
Scott Wood6f2f01b2012-09-20 19:09:07 -05002782 CONFIG_SPL_NAND_BASE
2783 Include nand_base.c in the SPL. Requires
2784 CONFIG_SPL_NAND_DRIVERS.
2785
2786 CONFIG_SPL_NAND_DRIVERS
2787 SPL uses normal NAND drivers, not minimal drivers.
2788
2789 CONFIG_SPL_NAND_ECC
2790 Include standard software ECC in the SPL
2791
Tom Rini95579792012-02-14 07:29:40 +00002792 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002793 Support for NAND boot using simple NAND drivers that
2794 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002795
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002796 CONFIG_SPL_UBI
2797 Support for a lightweight UBI (fastmap) scanner and
2798 loader
2799
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002800 CONFIG_SPL_NAND_RAW_ONLY
2801 Support to boot only raw u-boot.bin images. Use this only
2802 if you need to save space.
2803
Ying Zhang7c8eea52013-08-16 15:16:12 +08002804 CONFIG_SPL_COMMON_INIT_DDR
2805 Set for common ddr init with serial presence detect in
2806 SPL binary.
2807
Tom Rini95579792012-02-14 07:29:40 +00002808 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2809 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2810 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2811 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2812 CONFIG_SYS_NAND_ECCBYTES
2813 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002814 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002815
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05302816 CONFIG_SPL_NAND_BOOT
2817 Add support NAND boot
2818
Tom Rini95579792012-02-14 07:29:40 +00002819 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002820 Location in NAND to read U-Boot from
2821
2822 CONFIG_SYS_NAND_U_BOOT_DST
2823 Location in memory to load U-Boot to
2824
2825 CONFIG_SYS_NAND_U_BOOT_SIZE
2826 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002827
2828 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002829 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002830
2831 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2832 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002833 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002834
Pavel Machekc57b9532012-08-30 22:42:11 +02002835 CONFIG_SPL_RAM_DEVICE
2836 Support for running image already present in ram, in SPL binary
2837
Scott Wood74752ba2012-12-06 13:33:16 +00002838 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002839 Image offset to which the SPL should be padded before appending
2840 the SPL payload. By default, this is defined as
2841 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2842 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2843 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002844
Scott Woodca2fca22012-09-21 16:27:32 -05002845 CONFIG_SPL_TARGET
2846 Final target image containing SPL and payload. Some SPLs
2847 use an arch-specific makefile fragment instead, for
2848 example if more than one image needs to be produced.
2849
Simon Glass87ebee32013-05-08 08:05:59 +00002850 CONFIG_FIT_SPL_PRINT
2851 Printing information about a FIT image adds quite a bit of
2852 code to SPL. So this is normally disabled in SPL. Use this
2853 option to re-enable it. This will affect the output of the
2854 bootm command when booting a FIT image.
2855
Ying Zhang3aa29de2013-08-16 15:16:15 +08002856- TPL framework
2857 CONFIG_TPL
2858 Enable building of TPL globally.
2859
2860 CONFIG_TPL_PAD_TO
2861 Image offset to which the TPL should be padded before appending
2862 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002863 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2864 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2865 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002866
wdenka8c7c702003-12-06 19:49:23 +00002867- Interrupt support (PPC):
2868
wdenkd4ca31c2004-01-02 14:00:00 +00002869 There are common interrupt_init() and timer_interrupt()
2870 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002871 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002872 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002873 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002874 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002875 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002876 specific handling. If board has watchdog / status_led
2877 / other_activity_monitor it works automatically from
2878 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002879
wdenkc6097192002-11-03 00:24:07 +00002880
Helmut Raiger9660e442011-10-20 04:19:47 +00002881Board initialization settings:
2882------------------------------
2883
2884During Initialization u-boot calls a number of board specific functions
2885to allow the preparation of board specific prerequisites, e.g. pin setup
2886before drivers are initialized. To enable these callbacks the
2887following configuration macros have to be defined. Currently this is
2888architecture specific, so please check arch/your_architecture/lib/board.c
2889typically in board_init_f() and board_init_r().
2890
2891- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2892- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2893- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2894- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002895
wdenkc6097192002-11-03 00:24:07 +00002896Configuration Settings:
2897-----------------------
2898
York Sun4d1fd7f2014-02-26 17:03:19 -08002899- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2900 Optionally it can be defined to support 64-bit memory commands.
2901
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002902- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002903 undefine this when you're short of memory.
2904
Peter Tyser2fb26042009-01-27 18:03:12 -06002905- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2906 width of the commands listed in the 'help' command output.
2907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002908- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002909 prompt for user input.
2910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002911- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002913- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002914
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002915- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002917- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002918 the application (usually a Linux kernel) when it is
2919 booted
2920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002921- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002922 List of legal baudrate settings for this board.
2923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002924- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002925 Begin and End addresses of the area used by the
2926 simple memory test.
2927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002928- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002929 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002930
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002931- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002932 Scratch address used by the alternate memory test
2933 You only need to set this if address zero isn't writeable
2934
York Sune8149522015-12-04 11:57:07 -08002935- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002936 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002937 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2938 is substracted from total RAM and won't be reported to OS.
2939 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07002940 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08002941 the RAM base is not zero, or RAM is divided into banks,
2942 this variable needs to be recalcuated to get the address.
2943
York Sunaabd7dd2015-12-07 11:05:29 -08002944- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002945 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002946 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002947 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002948 fixing up gd->ram_size the Linux kernel should gets passed
2949 the now "corrected" memory size and won't touch it either.
2950 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002951 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002952 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002953 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002954
2955 This option can be used as a workaround for the 440EPx/GRx
2956 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2957 be touched.
2958
2959 WARNING: Please make sure that this value is a multiple of
2960 the Linux page size (normally 4k). If this is not the case,
2961 then the end address of the Linux memory will be located at a
2962 non page size aligned address and this could cause major
2963 problems.
2964
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002965- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002966 Enable temporary baudrate change while serial download
2967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002968- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002969 Physical start address of SDRAM. _Must_ be 0 here.
2970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002971- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002972 Physical start address of Flash memory.
2973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002974- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002975 Physical start address of boot monitor code (set by
2976 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002977 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002978 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002980- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002981 Size of memory reserved for monitor code, used to
2982 determine _at_compile_time_ (!) if the environment is
2983 embedded within the U-Boot image, or in a separate
2984 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002986- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002987 Size of DRAM reserved for malloc() use.
2988
Simon Glassd59476b2014-07-10 22:23:28 -06002989- CONFIG_SYS_MALLOC_F_LEN
2990 Size of the malloc() pool for use before relocation. If
2991 this is defined, then a very simple malloc() implementation
2992 will become available before relocation. The address is just
2993 below the global data, and the stack is moved down to make
2994 space.
2995
2996 This feature allocates regions with increasing addresses
2997 within the region. calloc() is supported, but realloc()
2998 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002999 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003000 U-Boot relocates itself.
3001
Simon Glass38687ae2014-11-10 17:16:54 -07003002- CONFIG_SYS_MALLOC_SIMPLE
3003 Provides a simple and small malloc() and calloc() for those
3004 boards which do not use the full malloc in SPL (which is
3005 enabled with CONFIG_SYS_SPL_MALLOC_START).
3006
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003007- CONFIG_SYS_NONCACHED_MEMORY:
3008 Size of non-cached memory area. This area of memory will be
3009 typically located right below the malloc() area and mapped
3010 uncached in the MMU. This is useful for drivers that would
3011 otherwise require a lot of explicit cache maintenance. For
3012 some drivers it's also impossible to properly maintain the
3013 cache. For example if the regions that need to be flushed
3014 are not a multiple of the cache-line size, *and* padding
3015 cannot be allocated between the regions to align them (i.e.
3016 if the HW requires a contiguous array of regions, and the
3017 size of each region is not cache-aligned), then a flush of
3018 one region may result in overwriting data that hardware has
3019 written to another region in the same cache-line. This can
3020 happen for example in network drivers where descriptors for
3021 buffers are typically smaller than the CPU cache-line (e.g.
3022 16 bytes vs. 32 or 64 bytes).
3023
3024 Non-cached memory is only supported on 32-bit ARM at present.
3025
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003026- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003027 Normally compressed uImages are limited to an
3028 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003029 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003030 to adjust this setting to your needs.
3031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003032- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003033 Maximum size of memory mapped by the startup code of
3034 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003035 the Linux kernel (bd_info, boot arguments, FDT blob if
3036 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003037 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003038 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003039 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003040 variable "bootm_mapsize" will override the value of
3041 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3042 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003043
John Rigbyfca43cc2010-10-13 13:57:35 -06003044- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3045 Enable initrd_high functionality. If defined then the
3046 initrd_high feature is enabled and the bootm ramdisk subcommand
3047 is enabled.
3048
3049- CONFIG_SYS_BOOT_GET_CMDLINE:
3050 Enables allocating and saving kernel cmdline in space between
3051 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3052
3053- CONFIG_SYS_BOOT_GET_KBD:
3054 Enables allocating and saving a kernel copy of the bd_info in
3055 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003057- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003058 Max number of Flash memory banks
3059
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003060- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003061 Max number of sectors on a Flash chip
3062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003063- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003064 Timeout for Flash erase operations (in ms)
3065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003066- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003067 Timeout for Flash write operations (in ms)
3068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003069- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003070 Timeout for Flash set sector lock bit operation (in ms)
3071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003072- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003073 Timeout for Flash clear lock bits operation (in ms)
3074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003075- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003076 If defined, hardware flash sectors protection is used
3077 instead of U-Boot software protection.
3078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003079- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003080
3081 Enable TFTP transfers directly to flash memory;
3082 without this option such a download has to be
3083 performed in two steps: (1) download to RAM, and (2)
3084 copy from RAM to flash.
3085
3086 The two-step approach is usually more reliable, since
3087 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003088 the flash, but in some situations (when system RAM is
3089 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003090 downloaded image) this option may be very useful.
3091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003092- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003093 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003094 common flash structure for storing flash geometry.
3095
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003096- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003097 This option also enables the building of the cfi_flash driver
3098 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003099
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003100- CONFIG_FLASH_CFI_MTD
3101 This option enables the building of the cfi_mtd driver
3102 in the drivers directory. The driver exports CFI flash
3103 to the MTD layer.
3104
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003105- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003106 Use buffered writes to flash.
3107
3108- CONFIG_FLASH_SPANSION_S29WS_N
3109 s29ws-n MirrorBit flash has non-standard addresses for buffered
3110 write commands.
3111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003113 If this option is defined, the common CFI flash doesn't
3114 print it's warning upon not recognized FLASH banks. This
3115 is useful, if some of the configured banks are only
3116 optionally available.
3117
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003118- CONFIG_FLASH_SHOW_PROGRESS
3119 If defined (must be an integer), print out countdown
3120 digits and dots. Recommended value: 45 (9..1) for 80
3121 column displays, 15 (3..1) for 40 column displays.
3122
Stefan Roese352ef3f2013-04-04 15:53:14 +02003123- CONFIG_FLASH_VERIFY
3124 If defined, the content of the flash (destination) is compared
3125 against the source after the write operation. An error message
3126 will be printed when the contents are not identical.
3127 Please note that this option is useless in nearly all cases,
3128 since such flash programming errors usually are detected earlier
3129 while unprotecting/erasing/programming. Please only enable
3130 this option if you really know what you are doing.
3131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003132- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003133 Defines the number of Ethernet receive buffers. On some
3134 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003135 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3136 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003137 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003138 Defaults to 4 if not defined.
3139
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003140- CONFIG_ENV_MAX_ENTRIES
3141
Wolfgang Denk071bc922010-10-27 22:48:30 +02003142 Maximum number of entries in the hash table that is used
3143 internally to store the environment settings. The default
3144 setting is supposed to be generous and should work in most
3145 cases. This setting can be used to tune behaviour; see
3146 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003147
Joe Hershberger25980902012-12-11 22:16:31 -06003148- CONFIG_ENV_FLAGS_LIST_DEFAULT
3149- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003150 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003151 calling env set. Variables can be restricted to only decimal,
3152 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3153 the variables can also be restricted to IP address or MAC address.
3154
3155 The format of the list is:
3156 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003157 access_attribute = [a|r|o|c]
3158 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003159 entry = variable_name[:attributes]
3160 list = entry[,list]
3161
3162 The type attributes are:
3163 s - String (default)
3164 d - Decimal
3165 x - Hexadecimal
3166 b - Boolean ([1yYtT|0nNfF])
3167 i - IP address
3168 m - MAC address
3169
Joe Hershberger267541f2012-12-11 22:16:34 -06003170 The access attributes are:
3171 a - Any (default)
3172 r - Read-only
3173 o - Write-once
3174 c - Change-default
3175
Joe Hershberger25980902012-12-11 22:16:31 -06003176 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3177 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003178 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003179
3180 - CONFIG_ENV_FLAGS_LIST_STATIC
3181 Define this to a list (string) to define validation that
3182 should be done if an entry is not found in the ".flags"
3183 environment variable. To override a setting in the static
3184 list, simply add an entry for the same variable name to the
3185 ".flags" variable.
3186
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003187 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3188 regular expression. This allows multiple variables to define the same
3189 flags without explicitly listing them for each variable.
3190
Joe Hershberger267541f2012-12-11 22:16:34 -06003191- CONFIG_ENV_ACCESS_IGNORE_FORCE
3192 If defined, don't allow the -f switch to env set override variable
3193 access flags.
3194
Gabe Black0d296cc2014-10-15 04:38:30 -06003195- CONFIG_USE_STDINT
3196 If stdint.h is available with your toolchain you can define this
3197 option to enable it. You can provide option 'USE_STDINT=1' when
3198 building U-Boot to enable this.
3199
wdenkc6097192002-11-03 00:24:07 +00003200The following definitions that deal with the placement and management
3201of environment data (variable area); in general, we support the
3202following configurations:
3203
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003204- CONFIG_BUILD_ENVCRC:
3205
3206 Builds up envcrc with the target environment so that external utils
3207 may easily extract it and embed it in final U-Boot images.
3208
wdenkc6097192002-11-03 00:24:07 +00003209BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003210in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003211console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003212U-Boot will hang.
3213
3214Please note that even with NVRAM we still use a copy of the
3215environment in RAM: we could work on NVRAM directly, but we want to
3216keep settings there always unmodified except somebody uses "saveenv"
3217to save the current settings.
3218
Liu Gang0a85a9e2012-03-08 00:33:20 +00003219BE CAREFUL! For some special cases, the local device can not use
3220"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003221environment stored in a remote NOR flash by SRIO or PCIE link,
3222but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003223
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003224- CONFIG_NAND_ENV_DST
3225
3226 Defines address in RAM to which the nand_spl code should copy the
3227 environment. If redundant environment is used, it will be copied to
3228 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3229
Bruce Adlere881cb52007-11-02 13:15:42 -07003230Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003231has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06003232created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003233until then to read environment variables.
3234
wdenk85ec0bc2003-03-31 16:34:49 +00003235The environment is protected by a CRC32 checksum. Before the monitor
3236is relocated into RAM, as a result of a bad CRC you will be working
3237with the compiled-in default environment - *silently*!!! [This is
3238necessary, because the first environment variable we need is the
3239"baudrate" setting for the console - if we have a bad CRC, we don't
3240have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003241
3242Note: once the monitor has been relocated, then it will complain if
3243the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003244use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003246- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003247 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003250 also needs to be defined.
3251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003252- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003253 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003254
Ron Madridf5675aa2009-02-18 14:30:44 -08003255- CONFIG_NS16550_MIN_FUNCTIONS:
3256 Define this if you desire to only have use of the NS16550_init
3257 and NS16550_putc functions for the serial driver located at
3258 drivers/serial/ns16550.c. This option is useful for saving
3259 space for already greatly restricted images, including but not
3260 limited to NAND_SPL configurations.
3261
Simon Glassb2b92f52012-11-30 13:01:18 +00003262- CONFIG_DISPLAY_BOARDINFO
3263 Display information about the board that U-Boot is running on
3264 when U-Boot starts up. The board function checkboard() is called
3265 to do this.
3266
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003267- CONFIG_DISPLAY_BOARDINFO_LATE
3268 Similar to the previous option, but display this information
3269 later, once stdio is running and output goes to the LCD, if
3270 present.
3271
Sascha Silbefeb85802013-08-11 16:40:43 +02003272- CONFIG_BOARD_SIZE_LIMIT:
3273 Maximum size of the U-Boot image. When defined, the
3274 build system checks that the actual size does not
3275 exceed it.
3276
wdenkc6097192002-11-03 00:24:07 +00003277Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003278---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003280- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003281 Cache Line Size of the CPU.
3282
Timur Tabie46fedf2011-08-04 18:03:41 -05003283- CONFIG_SYS_CCSRBAR_DEFAULT:
3284 Default (power-on reset) physical address of CCSR on Freescale
3285 PowerPC SOCs.
3286
3287- CONFIG_SYS_CCSRBAR:
3288 Virtual address of CCSR. On a 32-bit build, this is typically
3289 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3290
Timur Tabie46fedf2011-08-04 18:03:41 -05003291- CONFIG_SYS_CCSRBAR_PHYS:
3292 Physical address of CCSR. CCSR can be relocated to a new
3293 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003294 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003295 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3296 is typically relocated on 36-bit builds. It is recommended
3297 that this macro be defined via the _HIGH and _LOW macros:
3298
3299 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3300 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3301
3302- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003303 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3304 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003305 used in assembly code, so it must not contain typecasts or
3306 integer size suffixes (e.g. "ULL").
3307
3308- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3309 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3310 used in assembly code, so it must not contain typecasts or
3311 integer size suffixes (e.g. "ULL").
3312
3313- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3314 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3315 forced to a value that ensures that CCSR is not relocated.
3316
wdenk7f6c2cb2002-11-10 22:06:23 +00003317- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003318 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003319
3320 the default drive number (default value 0)
3321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003322 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003323
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003324 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003325 (default value 1)
3326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003327 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003328
wdenk43d96162003-03-06 00:02:04 +00003329 defines the offset of register from address. It
3330 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003331 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003333 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3334 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003335 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003337 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003338 fdc_hw_init() is called at the beginning of the FDC
3339 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003340 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003341 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003342
Macpaul Lin0abddf82011-04-11 20:45:32 +00003343- CONFIG_IDE_AHB:
3344 Most IDE controllers were designed to be connected with PCI
3345 interface. Only few of them were designed for AHB interface.
3346 When software is doing ATA command and data transfer to
3347 IDE devices through IDE-AHB controller, some additional
3348 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003349 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003351- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003352 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003353 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003355- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003356
wdenk7152b1d2003-09-05 23:19:14 +00003357 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003358 initial data and stack; please note that this must be
3359 writable memory that is working WITHOUT special
3360 initialization, i. e. you CANNOT use normal RAM which
3361 will become available only after programming the
3362 memory controller and running certain initialization
3363 sequences.
3364
3365 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003366 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003367
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003368- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003369
3370 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003371 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3372 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003373 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003374 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003375 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003376 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3377 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003378
3379 Note:
3380 On the MPC824X (or other systems that use the data
3381 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003382 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003383 point to an otherwise UNUSED address space between
3384 the top of RAM and the start of the PCI space.
3385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003386- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003388- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003389 SDRAM timing
3390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003391- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003392 periodic timer for refresh
3393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003394- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3395 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3396 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3397 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003398 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3399
3400- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003401 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3402 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003403 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3404
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003405- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003406 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003407 Don't do any setup work, presumably because someone or
3408 something has already done it, and we don't need to do it
3409 a second time. Useful for platforms that are pre-booted
3410 by coreboot or similar.
3411
Gabor Juhos842033e2013-05-30 07:06:12 +00003412- CONFIG_PCI_INDIRECT_BRIDGE:
3413 Enable support for indirect PCI bridges.
3414
Kumar Galaa09b9b62010-12-30 12:09:53 -06003415- CONFIG_SYS_SRIO:
3416 Chip has SRIO or not
3417
3418- CONFIG_SRIO1:
3419 Board has SRIO 1 port available
3420
3421- CONFIG_SRIO2:
3422 Board has SRIO 2 port available
3423
Liu Gangc8b28152013-05-07 16:30:46 +08003424- CONFIG_SRIO_PCIE_BOOT_MASTER
3425 Board can support master function for Boot from SRIO and PCIE
3426
Kumar Galaa09b9b62010-12-30 12:09:53 -06003427- CONFIG_SYS_SRIOn_MEM_VIRT:
3428 Virtual Address of SRIO port 'n' memory region
3429
3430- CONFIG_SYS_SRIOn_MEM_PHYS:
3431 Physical Address of SRIO port 'n' memory region
3432
3433- CONFIG_SYS_SRIOn_MEM_SIZE:
3434 Size of SRIO port 'n' memory region
3435
Fabio Estevam66bd1842013-04-11 09:35:34 +00003436- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3437 Defined to tell the NAND controller that the NAND chip is using
3438 a 16 bit bus.
3439 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003440 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003441 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003442 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003443
3444- CONFIG_SYS_NDFC_EBC0_CFG
3445 Sets the EBC0_CFG register for the NDFC. If not defined
3446 a default value will be used.
3447
Ben Warrenbb99ad62006-09-07 16:50:54 -04003448- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003449 Get DDR timing information from an I2C EEPROM. Common
3450 with pluggable memory modules such as SODIMMs
3451
Ben Warrenbb99ad62006-09-07 16:50:54 -04003452 SPD_EEPROM_ADDRESS
3453 I2C address of the SPD EEPROM
3454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003456 If SPD EEPROM is on an I2C bus other than the first
3457 one, specify here. Note that the value must resolve
3458 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003459
York Sun1b3e3c42011-06-07 09:42:16 +08003460- CONFIG_SYS_DDR_RAW_TIMING
3461 Get DDR timing information from other than SPD. Common with
3462 soldered DDR chips onboard without SPD. DDR raw timing
3463 parameters are extracted from datasheet and hard-coded into
3464 header files or board specific files.
3465
York Sun6f5e1dc2011-09-16 13:21:35 -07003466- CONFIG_FSL_DDR_INTERACTIVE
3467 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3468
York Sune32d59a2015-01-06 13:18:55 -08003469- CONFIG_FSL_DDR_SYNC_REFRESH
3470 Enable sync of refresh for multiple controllers.
3471
York Sun4516ff82015-03-19 09:30:28 -07003472- CONFIG_FSL_DDR_BIST
3473 Enable built-in memory test for Freescale DDR controllers.
3474
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003475- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003476 Only for 83xx systems. If specified, then DDR should
3477 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003478
wdenkc26e4542004-04-18 10:13:26 +00003479- CONFIG_RMII
3480 Enable RMII mode for all FECs.
3481 Note that this is a global option, we can't
3482 have one FEC in standard MII mode and another in RMII mode.
3483
wdenk5cf91d62004-04-23 20:32:05 +00003484- CONFIG_CRC32_VERIFY
3485 Add a verify option to the crc32 command.
3486 The syntax is:
3487
3488 => crc32 -v <address> <count> <crc32>
3489
3490 Where address/count indicate a memory area
3491 and crc32 is the correct crc32 which the
3492 area should have.
3493
wdenk56523f12004-07-11 17:40:54 +00003494- CONFIG_LOOPW
3495 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06003496 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00003497
stroese7b466642004-12-16 18:46:55 +00003498- CONFIG_MX_CYCLIC
3499 Add the "mdc" and "mwc" memory commands. These are cyclic
3500 "md/mw" commands.
3501 Examples:
3502
wdenkefe2a4d2004-12-16 21:44:03 +00003503 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003504 This command will print 4 bytes (10,11,12,13) each 500 ms.
3505
wdenkefe2a4d2004-12-16 21:44:03 +00003506 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003507 This command will write 12345678 to address 100 all 10 ms.
3508
wdenkefe2a4d2004-12-16 21:44:03 +00003509 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06003510 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00003511
wdenk8aa1a2d2005-04-04 12:44:11 +00003512- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003513 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003514 low level initializations (like setting up the memory
3515 controller) are omitted and/or U-Boot does not
3516 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003517
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003518 Normally this variable MUST NOT be defined. The only
3519 exception is when U-Boot is loaded (to RAM) by some
3520 other boot loader or by a debugger which performs
3521 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003522
Simon Glassb5bd0982016-05-05 07:28:06 -06003523- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3524 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003525 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003526 instruction cache) is still performed.
3527
Aneesh V401bb302011-07-13 05:11:07 +00003528- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003529 Modifies the behaviour of start.S when compiling a loader
3530 that is executed before the actual U-Boot. E.g. when
3531 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003532
Ying Zhang3aa29de2013-08-16 15:16:15 +08003533- CONFIG_TPL_BUILD
3534 Modifies the behaviour of start.S when compiling a loader
3535 that is executed after the SPL and before the actual U-Boot.
3536 It is loaded by the SPL.
3537
Ying Zhang5df572f2013-05-20 14:07:23 +08003538- CONFIG_SYS_MPC85XX_NO_RESETVEC
3539 Only for 85xx systems. If this variable is specified, the section
3540 .resetvec is not kept and the section .bootpg is placed in the
3541 previous 4k of the .text section.
3542
Simon Glass4213fc22013-02-24 17:33:14 +00003543- CONFIG_ARCH_MAP_SYSMEM
3544 Generally U-Boot (and in particular the md command) uses
3545 effective address. It is therefore not necessary to regard
3546 U-Boot address as virtual addresses that need to be translated
3547 to physical addresses. However, sandbox requires this, since
3548 it maintains its own little RAM buffer which contains all
3549 addressable memory. This option causes some memory accesses
3550 to be mapped through map_sysmem() / unmap_sysmem().
3551
Simon Glass588a13f2013-02-14 04:18:54 +00003552- CONFIG_X86_RESET_VECTOR
3553 If defined, the x86 reset vector code is included. This is not
3554 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003555
Heiko Schocher16678eb2013-11-04 14:05:00 +01003556- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3557 Enables the RTC32K OSC on AM33xx based plattforms
3558
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003559- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3560 Option to disable subpage write in NAND driver
3561 driver that uses this:
3562 drivers/mtd/nand/davinci_nand.c
3563
Timur Tabif2717b42011-11-22 09:21:25 -06003564Freescale QE/FMAN Firmware Support:
3565-----------------------------------
3566
3567The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3568loading of "firmware", which is encoded in the QE firmware binary format.
3569This firmware often needs to be loaded during U-Boot booting, so macros
3570are used to identify the storage device (NOR flash, SPI, etc) and the address
3571within that device.
3572
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003573- CONFIG_SYS_FMAN_FW_ADDR
3574 The address in the storage device where the FMAN microcode is located. The
3575 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3576 is also specified.
3577
3578- CONFIG_SYS_QE_FW_ADDR
3579 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003580 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3581 is also specified.
3582
3583- CONFIG_SYS_QE_FMAN_FW_LENGTH
3584 The maximum possible size of the firmware. The firmware binary format
3585 has a field that specifies the actual size of the firmware, but it
3586 might not be possible to read any part of the firmware unless some
3587 local storage is allocated to hold the entire firmware first.
3588
3589- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3590 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3591 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3592 virtual address in NOR flash.
3593
3594- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3595 Specifies that QE/FMAN firmware is located in NAND flash.
3596 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3597
3598- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3599 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3600 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3601
Liu Gang292dc6c2012-03-08 00:33:18 +00003602- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3603 Specifies that QE/FMAN firmware is located in the remote (master)
3604 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003605 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3606 window->master inbound window->master LAW->the ucode address in
3607 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003608
J. German Riverab940ca62014-06-23 15:15:55 -07003609Freescale Layerscape Management Complex Firmware Support:
3610---------------------------------------------------------
3611The Freescale Layerscape Management Complex (MC) supports the loading of
3612"firmware".
3613This firmware often needs to be loaded during U-Boot booting, so macros
3614are used to identify the storage device (NOR flash, SPI, etc) and the address
3615within that device.
3616
3617- CONFIG_FSL_MC_ENET
3618 Enable the MC driver for Layerscape SoCs.
3619
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303620Freescale Layerscape Debug Server Support:
3621-------------------------------------------
3622The Freescale Layerscape Debug Server Support supports the loading of
3623"Debug Server firmware" and triggering SP boot-rom.
3624This firmware often needs to be loaded during U-Boot booting.
3625
York Sunc0492142015-12-07 11:08:58 -08003626- CONFIG_SYS_MC_RSV_MEM_ALIGN
3627 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303628
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003629Reproducible builds
3630-------------------
3631
3632In order to achieve reproducible builds, timestamps used in the U-Boot build
3633process have to be set to a fixed value.
3634
3635This is done using the SOURCE_DATE_EPOCH environment variable.
3636SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3637option for U-Boot or an environment variable in U-Boot.
3638
3639SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3640
wdenkc6097192002-11-03 00:24:07 +00003641Building the Software:
3642======================
3643
Wolfgang Denk218ca722008-03-26 10:40:12 +01003644Building U-Boot has been tested in several native build environments
3645and in many different cross environments. Of course we cannot support
3646all possibly existing versions of cross development tools in all
3647(potentially obsolete) versions. In case of tool chain problems we
3648recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3649which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003650
Wolfgang Denk218ca722008-03-26 10:40:12 +01003651If you are not using a native environment, it is assumed that you
3652have GNU cross compiling tools available in your path. In this case,
3653you must set the environment variable CROSS_COMPILE in your shell.
3654Note that no changes to the Makefile or any other source files are
3655necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003656
Wolfgang Denk218ca722008-03-26 10:40:12 +01003657 $ CROSS_COMPILE=ppc_4xx-
3658 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003659
Peter Tyser2f8d3962009-03-13 18:54:51 -05003660Note: If you wish to generate Windows versions of the utilities in
3661 the tools directory you can use the MinGW toolchain
3662 (http://www.mingw.org). Set your HOST tools to the MinGW
3663 toolchain and execute 'make tools'. For example:
3664
3665 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3666
3667 Binaries such as tools/mkimage.exe will be created which can
3668 be executed on computers running Windows.
3669
Wolfgang Denk218ca722008-03-26 10:40:12 +01003670U-Boot is intended to be simple to build. After installing the
3671sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003672is done by typing:
3673
Holger Freytherab584d62014-08-04 09:26:05 +02003674 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003675
Holger Freytherab584d62014-08-04 09:26:05 +02003676where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003677rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003678
wdenk2729af92004-05-03 20:45:30 +00003679Note: for some board special configuration names may exist; check if
3680 additional information is available from the board vendor; for
3681 instance, the TQM823L systems are available without (standard)
3682 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003683 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003684
Holger Freytherab584d62014-08-04 09:26:05 +02003685 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003686 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003687
Holger Freytherab584d62014-08-04 09:26:05 +02003688 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003689 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691 etc.
wdenkc6097192002-11-03 00:24:07 +00003692
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694Finally, type "make all", and you should get some working U-Boot
3695images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697- "u-boot.bin" is a raw binary image
3698- "u-boot" is an image in ELF binary format
3699- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003700
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003701By default the build is performed locally and the objects are saved
3702in the source directory. One of the two methods can be used to change
3703this behavior and build U-Boot to some external directory:
3704
37051. Add O= to the make command line invocations:
3706
3707 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003708 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003709 make O=/tmp/build all
3710
Timo Ketolaadbba992014-11-06 14:39:05 +020037112. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003712
Timo Ketolaadbba992014-11-06 14:39:05 +02003713 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003714 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003715 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003716 make all
3717
Timo Ketolaadbba992014-11-06 14:39:05 +02003718Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003719variable.
3720
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722Please be aware that the Makefiles assume you are using GNU make, so
3723for instance on NetBSD you might need to use "gmake" instead of
3724native "make".
wdenkc6097192002-11-03 00:24:07 +00003725
wdenkc6097192002-11-03 00:24:07 +00003726
wdenk2729af92004-05-03 20:45:30 +00003727If the system board that you have is not listed, then you will need
3728to port U-Boot to your hardware platform. To do this, follow these
3729steps:
wdenkc6097192002-11-03 00:24:07 +00003730
Phil Sutter3c1496c2015-12-25 14:41:18 +010037311. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003732 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003733 the "Makefile" and a "<board>.c".
37342. Create a new configuration file "include/configs/<board>.h" for
3735 your board.
wdenk2729af92004-05-03 20:45:30 +000037363. If you're porting U-Boot to a new CPU, then also create a new
3737 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020037384. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000037395. Type "make", and you should get a working "u-boot.srec" file
3740 to be installed on your target system.
37416. Debug and solve any problems that might arise.
3742 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003743
wdenkc6097192002-11-03 00:24:07 +00003744
wdenk2729af92004-05-03 20:45:30 +00003745Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3746==============================================================
wdenkc6097192002-11-03 00:24:07 +00003747
Wolfgang Denk218ca722008-03-26 10:40:12 +01003748If you have modified U-Boot sources (for instance added a new board
3749or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003750provide feedback to the other developers. The feedback normally takes
3751the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003752official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003753
Wolfgang Denk218ca722008-03-26 10:40:12 +01003754But before you submit such a patch, please verify that your modifi-
3755cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003756the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003757just run the buildman script (tools/buildman/buildman), which will
3758configure and build U-Boot for ALL supported system. Be warned, this
3759will take a while. Please see the buildman README, or run 'buildman -H'
3760for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003761
3762
wdenk2729af92004-05-03 20:45:30 +00003763See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003764
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766Monitor Commands - Overview:
3767============================
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk2729af92004-05-03 20:45:30 +00003769go - start application at address 'addr'
3770run - run commands in an environment variable
3771bootm - boot application image from memory
3772bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003773bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003774tftpboot- boot image via network using TFTP protocol
3775 and env variables "ipaddr" and "serverip"
3776 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003777tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003778rarpboot- boot image via network using RARP/TFTP protocol
3779diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3780loads - load S-Record file over serial line
3781loadb - load binary file over serial line (kermit mode)
3782md - memory display
3783mm - memory modify (auto-incrementing)
3784nm - memory modify (constant address)
3785mw - memory write (fill)
3786cp - memory copy
3787cmp - memory compare
3788crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003789i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003790sspi - SPI utility commands
3791base - print or set address offset
3792printenv- print environment variables
3793setenv - set environment variables
3794saveenv - save environment variables to persistent storage
3795protect - enable or disable FLASH write protection
3796erase - erase FLASH memory
3797flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003798nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003799bdinfo - print Board Info structure
3800iminfo - print header information for application image
3801coninfo - print console devices and informations
3802ide - IDE sub-system
3803loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003804loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003805mtest - simple RAM test
3806icache - enable or disable instruction cache
3807dcache - enable or disable data cache
3808reset - Perform RESET of the CPU
3809echo - echo args to console
3810version - print monitor version
3811help - print online help
3812? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003813
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk2729af92004-05-03 20:45:30 +00003815Monitor Commands - Detailed Description:
3816========================================
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818TODO.
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003821
3822
wdenk2729af92004-05-03 20:45:30 +00003823Environment Variables:
3824======================
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826U-Boot supports user configuration using Environment Variables which
3827can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk2729af92004-05-03 20:45:30 +00003829Environment Variables are set using "setenv", printed using
3830"printenv", and saved to Flash using "saveenv". Using "setenv"
3831without a value can be used to delete a variable from the
3832environment. As long as you don't save the environment you are
3833working with an in-memory copy. In case the Flash area containing the
3834environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003835
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003836Some configuration options can be set using Environment Variables.
3837
3838List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003843
wdenk2729af92004-05-03 20:45:30 +00003844 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk2729af92004-05-03 20:45:30 +00003846 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003849
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003850 bootm_low - Memory range available for image processing in the bootm
3851 command can be restricted. This variable is given as
3852 a hexadecimal number and defines lowest address allowed
3853 for use by the bootm command. See also "bootm_size"
3854 environment variable. Address defined by "bootm_low" is
3855 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003856 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3857 bootm_mapsize.
3858
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003859 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003860 This variable is given as a hexadecimal number and it
3861 defines the size of the memory region starting at base
3862 address bootm_low that is accessible by the Linux kernel
3863 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3864 as the default value if it is defined, and bootm_size is
3865 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003866
3867 bootm_size - Memory range available for image processing in the bootm
3868 command can be restricted. This variable is given as
3869 a hexadecimal number and defines the size of the region
3870 allowed for use by the bootm command. See also "bootm_low"
3871 environment variable.
3872
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003873 updatefile - Location of the software update file on a TFTP server, used
3874 by the automatic software update feature. Please refer to
3875 documentation in doc/README.update for more details.
3876
wdenk2729af92004-05-03 20:45:30 +00003877 autoload - if set to "no" (any string beginning with 'n'),
3878 "bootp" will just load perform a lookup of the
3879 configuration from the BOOTP server, but not try to
3880 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882 autostart - if set to "yes", an image loaded using the "bootp",
3883 "rarpboot", "tftpboot" or "diskboot" commands will
3884 be automatically started (by internally calling
3885 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887 If set to "no", a standalone image passed to the
3888 "bootm" command will be copied to the load address
3889 (and eventually uncompressed), but NOT be started.
3890 This can be used to load and uncompress arbitrary
3891 data.
wdenkc6097192002-11-03 00:24:07 +00003892
David A. Longa28afca2011-07-09 16:40:19 -04003893 fdt_high - if set this restricts the maximum address that the
3894 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003895 For example, if you have a system with 1 GB memory
3896 at physical address 0x10000000, while Linux kernel
3897 only recognizes the first 704 MB as low memory, you
3898 may need to set fdt_high as 0x3C000000 to have the
3899 device tree blob be copied to the maximum address
3900 of the 704 MB low memory, so that Linux kernel can
3901 access it during the boot procedure.
3902
David A. Longa28afca2011-07-09 16:40:19 -04003903 If this is set to the special value 0xFFFFFFFF then
3904 the fdt will not be copied at all on boot. For this
3905 to work it must reside in writable memory, have
3906 sufficient padding on the end of it for u-boot to
3907 add the information it needs into it, and the memory
3908 must be accessible by the kernel.
3909
Simon Glasseea63e02011-10-24 19:15:34 +00003910 fdtcontroladdr- if set this is the address of the control flattened
3911 device tree used by U-Boot when CONFIG_OF_CONTROL is
3912 defined.
3913
wdenk17ea1172004-06-06 21:51:03 +00003914 i2cfast - (PPC405GP|PPC405EP only)
3915 if set to 'y' configures Linux I2C driver for fast
3916 mode (400kHZ). This environment variable is used in
3917 initialization code. So, for changes to be effective
3918 it must be saved and board must be reset.
3919
wdenk2729af92004-05-03 20:45:30 +00003920 initrd_high - restrict positioning of initrd images:
3921 If this variable is not set, initrd images will be
3922 copied to the highest possible address in RAM; this
3923 is usually what you want since it allows for
3924 maximum initrd size. If for some reason you want to
3925 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003927 variable to a value of "no" or "off" or "0".
3928 Alternatively, you can set it to a maximum upper
3929 address to use (U-Boot will still check that it
3930 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932 For instance, when you have a system with 16 MB
3933 RAM, and want to reserve 4 MB from use by Linux,
3934 you can do this by adding "mem=12M" to the value of
3935 the "bootargs" variable. However, now you must make
3936 sure that the initrd image is placed in the first
3937 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk2729af92004-05-03 20:45:30 +00003939 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 If you set initrd_high to 0xFFFFFFFF, this is an
3942 indication to U-Boot that all addresses are legal
3943 for the Linux kernel, including addresses in flash
3944 memory. In this case U-Boot will NOT COPY the
3945 ramdisk at all. This may be useful to reduce the
3946 boot time on your system, but requires that this
3947 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003948
wdenk2729af92004-05-03 20:45:30 +00003949 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951 loadaddr - Default load address for commands like "bootp",
3952 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003957
wdenk2729af92004-05-03 20:45:30 +00003958 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003961
wdenk2729af92004-05-03 20:45:30 +00003962 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003963
Mike Frysingere2a53452011-10-02 10:01:27 +00003964 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003965
Mike Frysingere2a53452011-10-02 10:01:27 +00003966 ethact - controls which interface is currently active.
3967 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003968
Heiko Schocher48690d82010-07-20 17:45:02 +02003969 => setenv ethact FEC
3970 => ping 192.168.0.1 # traffic sent on FEC
3971 => setenv ethact SCC
3972 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003973
Matthias Fuchse1692572008-01-17 07:45:05 +01003974 ethrotate - When set to "no" U-Boot does not go through all
3975 available network interfaces.
3976 It just stays at the currently selected interface.
3977
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003978 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003979 either succeed or fail without retrying.
3980 When set to "once" the network operation will
3981 fail when all the available network interfaces
3982 are tried once without success.
3983 Useful on scripts which control the retry operation
3984 themselves.
wdenkc6097192002-11-03 00:24:07 +00003985
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003986 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003987
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003988 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07003989 changing the console to be empty. If "yes" it will be
3990 made silent. If "no" it will not be made silent. If
3991 unset, then it will be made silent if the U-Boot console
3992 is silent.
3993
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003994 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003995 UDP source port.
3996
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02003997 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003998 destination port instead of the Well Know Port 69.
3999
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004000 tftpblocksize - Block size to use for TFTP transfers; if not set,
4001 we use the TFTP server's default block size
4002
4003 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4004 seconds, minimum value is 1000 = 1 second). Defines
4005 when a packet is considered to be lost so it has to
4006 be retransmitted. The default is 5000 = 5 seconds.
4007 Lowering this value may make downloads succeed
4008 faster in networks with high packet loss rates or
4009 with unreliable TFTP servers.
4010
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004011 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4012 unit, minimum value = 0). Defines how many timeouts
4013 can happen during a single file transfer before that
4014 transfer is aborted. The default is 10, and 0 means
4015 'no timeouts allowed'. Increasing this value may help
4016 downloads succeed with high packet loss rates, or with
4017 unreliable TFTP servers or client hardware.
4018
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004019 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004020 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004021 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004022
Alexandre Messier50768f52016-02-01 17:08:57 -05004023 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4024 Unsigned value, in milliseconds. If not set, the period will
4025 be either the default (28000), or a value based on
4026 CONFIG_NET_RETRY_COUNT, if defined. This value has
4027 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4028
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004029The following image location variables contain the location of images
4030used in booting. The "Image" column gives the role of the image and is
4031not an environment variable name. The other columns are environment
4032variable names. "File Name" gives the name of the file on a TFTP
4033server, "RAM Address" gives the location in RAM the image will be
4034loaded to, and "Flash Location" gives the image's address in NOR
4035flash or offset in NAND flash.
4036
4037*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004038boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004039boards use these variables for other purposes.
4040
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004041Image File Name RAM Address Flash Location
4042----- --------- ----------- --------------
4043u-boot u-boot u-boot_addr_r u-boot_addr
4044Linux kernel bootfile kernel_addr_r kernel_addr
4045device tree blob fdtfile fdt_addr_r fdt_addr
4046ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048The following environment variables may be used and automatically
4049updated by the network boot commands ("bootp" and "rarpboot"),
4050depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052 bootfile - see above
4053 dnsip - IP address of your Domain Name Server
4054 dnsip2 - IP address of your secondary Domain Name Server
4055 gatewayip - IP address of the Gateway (Router) to use
4056 hostname - Target hostname
4057 ipaddr - see above
4058 netmask - Subnet Mask
4059 rootpath - Pathname of the root filesystem on the NFS server
4060 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004061
wdenka3d991b2004-04-15 21:48:45 +00004062
wdenk2729af92004-05-03 20:45:30 +00004063There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065 serial# - contains hardware identification information such
4066 as type string and/or serial number
4067 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069These variables can be set only once (usually during manufacturing of
4070the board). U-Boot refuses to delete or overwrite these variables
4071once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004072
4073
wdenk2729af92004-05-03 20:45:30 +00004074Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076 ver - Contains the U-Boot version string as printed
4077 with the "version" command. This variable is
4078 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004079
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081Please note that changes to some configuration parameters may take
4082only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004083
stroesec1551ea2003-04-04 15:53:41 +00004084
Joe Hershberger170ab112012-12-11 22:16:24 -06004085Callback functions for environment variables:
4086---------------------------------------------
4087
4088For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004089when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004090be associated with arbitrary variables. On creation, overwrite, or
4091deletion, the callback will provide the opportunity for some side
4092effect to happen or for the change to be rejected.
4093
4094The callbacks are named and associated with a function using the
4095U_BOOT_ENV_CALLBACK macro in your board or driver code.
4096
4097These callbacks are associated with variables in one of two ways. The
4098static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4099in the board configuration to a string that defines a list of
4100associations. The list must be in the following format:
4101
4102 entry = variable_name[:callback_name]
4103 list = entry[,list]
4104
4105If the callback name is not specified, then the callback is deleted.
4106Spaces are also allowed anywhere in the list.
4107
4108Callbacks can also be associated by defining the ".callbacks" variable
4109with the same list format above. Any association in ".callbacks" will
4110override any association in the static list. You can define
4111CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004112".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004113
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004114If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4115regular expression. This allows multiple variables to be connected to
4116the same callback without explicitly listing them all out.
4117
Joe Hershberger170ab112012-12-11 22:16:24 -06004118
wdenk2729af92004-05-03 20:45:30 +00004119Command Line Parsing:
4120=====================
stroesec1551ea2003-04-04 15:53:41 +00004121
wdenk2729af92004-05-03 20:45:30 +00004122There are two different command line parsers available with U-Boot:
4123the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004124
wdenk2729af92004-05-03 20:45:30 +00004125Old, simple command line parser:
4126--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128- supports environment variables (through setenv / saveenv commands)
4129- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004130- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004131- special characters ('$', ';') can be escaped by prefixing with '\',
4132 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004133 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004134- You can also escape text by enclosing in single apostrophes, for example:
4135 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137Hush shell:
4138-----------
wdenkf07771c2003-05-28 08:06:31 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140- similar to Bourne shell, with control structures like
4141 if...then...else...fi, for...do...done; while...do...done,
4142 until...do...done, ...
4143- supports environment ("global") variables (through setenv / saveenv
4144 commands) and local shell variables (through standard shell syntax
4145 "name=value"); only environment variables can be used with "run"
4146 command
wdenkf07771c2003-05-28 08:06:31 +00004147
wdenk2729af92004-05-03 20:45:30 +00004148General rules:
4149--------------
wdenkf07771c2003-05-28 08:06:31 +00004150
wdenk2729af92004-05-03 20:45:30 +00004151(1) If a command line (or an environment variable executed by a "run"
4152 command) contains several commands separated by semicolon, and
4153 one of these commands fails, then the remaining commands will be
4154 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004157 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004158 command will cause "run" to terminate, i. e. the remaining
4159 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004160
wdenk2729af92004-05-03 20:45:30 +00004161Note for Redundant Ethernet Interfaces:
4162=======================================
wdenkf07771c2003-05-28 08:06:31 +00004163
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004164Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004165such configurations and is capable of automatic selection of a
4166"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004167
wdenk2729af92004-05-03 20:45:30 +00004168Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4169MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4170"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172If the network interface stores some valid MAC address (for instance
4173in SROM), this is used as default address if there is NO correspon-
4174ding setting in the environment; if the corresponding environment
4175variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004176
wdenk2729af92004-05-03 20:45:30 +00004177o If the SROM has a valid MAC address, and there is no address in the
4178 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180o If there is no valid address in the SROM, and a definition in the
4181 environment exists, then the value from the environment variable is
4182 used.
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184o If both the SROM and the environment contain a MAC address, and
4185 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187o If both the SROM and the environment contain a MAC address, and the
4188 addresses differ, the value from the environment is used and a
4189 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004190
wdenk2729af92004-05-03 20:45:30 +00004191o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004192 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4193 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004194
Ben Warrenecee9322010-04-26 11:11:46 -07004195If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004196will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004197may be skipped by setting the appropriate 'ethmacskip' environment variable.
4198The naming convention is as follows:
4199"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201Image Formats:
4202==============
wdenkc6097192002-11-03 00:24:07 +00004203
Marian Balakowicz3310c542008-03-12 12:13:13 +01004204U-Boot is capable of booting (and performing other auxiliary operations on)
4205images in two formats:
4206
4207New uImage format (FIT)
4208-----------------------
4209
4210Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4211to Flattened Device Tree). It allows the use of images with multiple
4212components (several kernels, ramdisks, etc.), with contents protected by
4213SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4214
4215
4216Old uImage format
4217-----------------
4218
4219Old image format is based on binary files which can be basically anything,
4220preceded by a special header; see the definitions in include/image.h for
4221details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004222
wdenk2729af92004-05-03 20:45:30 +00004223* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4224 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004225 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4226 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4227 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004228* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004229 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004230 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004231* Compression Type (uncompressed, gzip, bzip2)
4232* Load Address
4233* Entry Point
4234* Image Name
4235* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237The header is marked by a special Magic Number, and both the header
4238and the data portions of the image are secured against corruption by
4239CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004240
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242Linux Support:
4243==============
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk2729af92004-05-03 20:45:30 +00004245Although U-Boot should support any OS or standalone application
4246easily, the main focus has always been on Linux during the design of
4247U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk2729af92004-05-03 20:45:30 +00004249U-Boot includes many features that so far have been part of some
4250special "boot loader" code within the Linux kernel. Also, any
4251"initrd" images to be used are no longer part of one big Linux image;
4252instead, kernel and "initrd" are separate images. This implementation
4253serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk2729af92004-05-03 20:45:30 +00004255- the same features can be used for other OS or standalone
4256 applications (for instance: using compressed images to reduce the
4257 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk2729af92004-05-03 20:45:30 +00004259- it becomes much easier to port new Linux kernel versions because
4260 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk2729af92004-05-03 20:45:30 +00004262- the same Linux kernel image can now be used with different "initrd"
4263 images; of course this also means that different kernel images can
4264 be run with the same "initrd". This makes testing easier (you don't
4265 have to build a new "zImage.initrd" Linux image when you just
4266 change a file in your "initrd"). Also, a field-upgrade of the
4267 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004268
wdenkc6097192002-11-03 00:24:07 +00004269
wdenk2729af92004-05-03 20:45:30 +00004270Linux HOWTO:
4271============
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273Porting Linux to U-Boot based systems:
4274---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276U-Boot cannot save you from doing all the necessary modifications to
4277configure the Linux device drivers for use with your target hardware
4278(no, we don't intend to provide a full virtual machine interface to
4279Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004280
Stefan Roesea47a12b2010-04-15 16:07:28 +02004281But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283Just make sure your machine specific header file (for instance
4284include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004285Information structure as we define in include/asm-<arch>/u-boot.h,
4286and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004287as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004288
Simon Glass2eb31b12014-06-11 23:29:46 -06004289Note that U-Boot now has a driver model, a unified model for drivers.
4290If you are adding a new driver, plumb it into driver model. If there
4291is no uclass available, you are encouraged to create one. See
4292doc/driver-model.
4293
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk2729af92004-05-03 20:45:30 +00004295Configuring the Linux kernel:
4296-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298No specific requirements for U-Boot. Make sure you have some root
4299device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004300
wdenkc6097192002-11-03 00:24:07 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302Building a Linux Image:
4303-----------------------
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4306not used. If you use recent kernel source, a new build target
4307"uImage" will exist which automatically builds an image usable by
4308U-Boot. Most older kernels also have support for a "pImage" target,
4309which was introduced for our predecessor project PPCBoot and uses a
4310100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004311
wdenk2729af92004-05-03 20:45:30 +00004312Example:
wdenkc6097192002-11-03 00:24:07 +00004313
Holger Freytherab584d62014-08-04 09:26:05 +02004314 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004315 make oldconfig
4316 make dep
4317 make uImage
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319The "uImage" build target uses a special tool (in 'tools/mkimage') to
4320encapsulate a compressed Linux kernel image with header information,
4321CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004322
wdenk2729af92004-05-03 20:45:30 +00004323* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004324
wdenk2729af92004-05-03 20:45:30 +00004325* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327 ${CROSS_COMPILE}-objcopy -O binary \
4328 -R .note -R .comment \
4329 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337 mkimage -A ppc -O linux -T kernel -C gzip \
4338 -a 0 -e 0 -n "Linux Kernel Image" \
4339 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004340
wdenk24ee89b2002-11-03 17:56:27 +00004341
wdenk2729af92004-05-03 20:45:30 +00004342The "mkimage" tool can also be used to create ramdisk images for use
4343with U-Boot, either separated from the Linux kernel image, or
4344combined into one file. "mkimage" encapsulates the images with a 64
4345byte header containing information about target architecture,
4346operating system, image type, compression method, entry points, time
4347stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004348
wdenk2729af92004-05-03 20:45:30 +00004349"mkimage" can be called in two ways: to verify existing images and
4350print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004351
wdenk2729af92004-05-03 20:45:30 +00004352In the first form (with "-l" option) mkimage lists the information
4353contained in the header of an existing U-Boot image; this includes
4354checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356 tools/mkimage -l image
4357 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004358
wdenk2729af92004-05-03 20:45:30 +00004359The second form (with "-d" option) is used to build a U-Boot image
4360from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004361
wdenk2729af92004-05-03 20:45:30 +00004362 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4363 -n name -d data_file image
4364 -A ==> set architecture to 'arch'
4365 -O ==> set operating system to 'os'
4366 -T ==> set image type to 'type'
4367 -C ==> set compression type 'comp'
4368 -a ==> set load address to 'addr' (hex)
4369 -e ==> set entry point to 'ep' (hex)
4370 -n ==> set image name to 'name'
4371 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004372
wdenk69459792004-05-29 16:53:29 +00004373Right now, all Linux kernels for PowerPC systems use the same load
4374address (0x00000000), but the entry point address depends on the
4375kernel version:
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377- 2.2.x kernels have the entry point at 0x0000000C,
4378- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk2729af92004-05-03 20:45:30 +00004380So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4383 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004384 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004385 > examples/uImage.TQM850L
4386 Image Name: 2.4.4 kernel for TQM850L
4387 Created: Wed Jul 19 02:34:59 2000
4388 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4389 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4390 Load Address: 0x00000000
4391 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395 -> tools/mkimage -l examples/uImage.TQM850L
4396 Image Name: 2.4.4 kernel for TQM850L
4397 Created: Wed Jul 19 02:34:59 2000
4398 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4399 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4400 Load Address: 0x00000000
4401 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403NOTE: for embedded systems where boot time is critical you can trade
4404speed for memory and install an UNCOMPRESSED image instead: this
4405needs more space in Flash, but boots much faster since it does not
4406need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004407
Stefan Roesea47a12b2010-04-15 16:07:28 +02004408 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004409 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4410 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004411 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004412 > examples/uImage.TQM850L-uncompressed
4413 Image Name: 2.4.4 kernel for TQM850L
4414 Created: Wed Jul 19 02:34:59 2000
4415 Image Type: PowerPC Linux Kernel Image (uncompressed)
4416 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4417 Load Address: 0x00000000
4418 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004419
wdenkc6097192002-11-03 00:24:07 +00004420
wdenk2729af92004-05-03 20:45:30 +00004421Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4422when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424 -> tools/mkimage -n 'Simple Ramdisk Image' \
4425 > -A ppc -O linux -T ramdisk -C gzip \
4426 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4427 Image Name: Simple Ramdisk Image
4428 Created: Wed Jan 12 14:01:50 2000
4429 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4430 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4431 Load Address: 0x00000000
4432 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004433
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004434The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4435option performs the converse operation of the mkimage's second form (the "-d"
4436option). Given an image built by mkimage, the dumpimage extracts a "data file"
4437from the image:
4438
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004439 tools/dumpimage -i image -T type -p position data_file
4440 -i ==> extract from the 'image' a specific 'data_file'
4441 -T ==> set image type to 'type'
4442 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004443
wdenkdb01a2e2004-04-15 23:14:49 +00004444
wdenk2729af92004-05-03 20:45:30 +00004445Installing a Linux Image:
4446-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448To downloading a U-Boot image over the serial (console) interface,
4449you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004450
wdenk2729af92004-05-03 20:45:30 +00004451 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004452
wdenk2729af92004-05-03 20:45:30 +00004453The 'objcopy' does not understand the information in the U-Boot
4454image header, so the resulting S-Record file will be relative to
4455address 0x00000000. To load it to a given address, you need to
4456specify the target address as 'offset' parameter with the 'loads'
4457command.
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459Example: install the image to address 0x40100000 (which on the
4460TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464 .......... done
4465 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467 => loads 40100000
4468 ## Ready for S-Record download ...
4469 ~>examples/image.srec
4470 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4471 ...
4472 15989 15990 15991 15992
4473 [file transfer complete]
4474 [connected]
4475 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004476
4477
wdenk2729af92004-05-03 20:45:30 +00004478You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004479this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004480corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004481
wdenk2729af92004-05-03 20:45:30 +00004482 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004483
wdenk2729af92004-05-03 20:45:30 +00004484 ## Checking Image at 40100000 ...
4485 Image Name: 2.2.13 for initrd on TQM850L
4486 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4487 Data Size: 335725 Bytes = 327 kB = 0 MB
4488 Load Address: 00000000
4489 Entry Point: 0000000c
4490 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004491
4492
wdenk2729af92004-05-03 20:45:30 +00004493Boot Linux:
4494-----------
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496The "bootm" command is used to boot an application that is stored in
4497memory (RAM or Flash). In case of a Linux kernel image, the contents
4498of the "bootargs" environment variable is passed to the kernel as
4499parameters. You can check and modify this variable using the
4500"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004501
4502
wdenk2729af92004-05-03 20:45:30 +00004503 => printenv bootargs
4504 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk2729af92004-05-03 20:45:30 +00004506 => 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 +00004507
wdenk2729af92004-05-03 20:45:30 +00004508 => printenv bootargs
4509 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 +00004510
wdenk2729af92004-05-03 20:45:30 +00004511 => bootm 40020000
4512 ## Booting Linux kernel at 40020000 ...
4513 Image Name: 2.2.13 for NFS on TQM850L
4514 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4515 Data Size: 381681 Bytes = 372 kB = 0 MB
4516 Load Address: 00000000
4517 Entry Point: 0000000c
4518 Verifying Checksum ... OK
4519 Uncompressing Kernel Image ... OK
4520 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
4521 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4522 time_init: decrementer frequency = 187500000/60
4523 Calibrating delay loop... 49.77 BogoMIPS
4524 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4525 ...
wdenkc6097192002-11-03 00:24:07 +00004526
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004527If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004528the memory addresses of both the kernel and the initrd image (PPBCOOT
4529format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk2729af92004-05-03 20:45:30 +00004531 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533 ## Checking Image at 40100000 ...
4534 Image Name: 2.2.13 for initrd on TQM850L
4535 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4536 Data Size: 335725 Bytes = 327 kB = 0 MB
4537 Load Address: 00000000
4538 Entry Point: 0000000c
4539 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541 ## Checking Image at 40200000 ...
4542 Image Name: Simple Ramdisk Image
4543 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4544 Data Size: 566530 Bytes = 553 kB = 0 MB
4545 Load Address: 00000000
4546 Entry Point: 00000000
4547 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004548
wdenk2729af92004-05-03 20:45:30 +00004549 => bootm 40100000 40200000
4550 ## Booting Linux kernel at 40100000 ...
4551 Image Name: 2.2.13 for initrd on TQM850L
4552 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4553 Data Size: 335725 Bytes = 327 kB = 0 MB
4554 Load Address: 00000000
4555 Entry Point: 0000000c
4556 Verifying Checksum ... OK
4557 Uncompressing Kernel Image ... OK
4558 ## Loading RAMDisk Image at 40200000 ...
4559 Image Name: Simple Ramdisk Image
4560 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4561 Data Size: 566530 Bytes = 553 kB = 0 MB
4562 Load Address: 00000000
4563 Entry Point: 00000000
4564 Verifying Checksum ... OK
4565 Loading Ramdisk ... OK
4566 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
4567 Boot arguments: root=/dev/ram
4568 time_init: decrementer frequency = 187500000/60
4569 Calibrating delay loop... 49.77 BogoMIPS
4570 ...
4571 RAMDISK: Compressed image found at block 0
4572 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 bash#
wdenkc6097192002-11-03 00:24:07 +00004575
Matthew McClintock02677682006-06-28 10:41:37 -05004576Boot Linux and pass a flat device tree:
4577-----------
4578
4579First, U-Boot must be compiled with the appropriate defines. See the section
4580titled "Linux Kernel Interface" above for a more in depth explanation. The
4581following is an example of how to start a kernel and pass an updated
4582flat device tree:
4583
4584=> print oftaddr
4585oftaddr=0x300000
4586=> print oft
4587oft=oftrees/mpc8540ads.dtb
4588=> tftp $oftaddr $oft
4589Speed: 1000, full duplex
4590Using TSEC0 device
4591TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4592Filename 'oftrees/mpc8540ads.dtb'.
4593Load address: 0x300000
4594Loading: #
4595done
4596Bytes transferred = 4106 (100a hex)
4597=> tftp $loadaddr $bootfile
4598Speed: 1000, full duplex
4599Using TSEC0 device
4600TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4601Filename 'uImage'.
4602Load address: 0x200000
4603Loading:############
4604done
4605Bytes transferred = 1029407 (fb51f hex)
4606=> print loadaddr
4607loadaddr=200000
4608=> print oftaddr
4609oftaddr=0x300000
4610=> bootm $loadaddr - $oftaddr
4611## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004612 Image Name: Linux-2.6.17-dirty
4613 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4614 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004615 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004616 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004617 Verifying Checksum ... OK
4618 Uncompressing Kernel Image ... OK
4619Booting using flat device tree at 0x300000
4620Using MPC85xx ADS machine description
4621Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4622[snip]
4623
4624
wdenk2729af92004-05-03 20:45:30 +00004625More About U-Boot Image Types:
4626------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004627
wdenk2729af92004-05-03 20:45:30 +00004628U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630 "Standalone Programs" are directly runnable in the environment
4631 provided by U-Boot; it is expected that (if they behave
4632 well) you can continue to work in U-Boot after return from
4633 the Standalone Program.
4634 "OS Kernel Images" are usually images of some Embedded OS which
4635 will take over control completely. Usually these programs
4636 will install their own set of exception handlers, device
4637 drivers, set up the MMU, etc. - this means, that you cannot
4638 expect to re-enter U-Boot except by resetting the CPU.
4639 "RAMDisk Images" are more or less just data blocks, and their
4640 parameters (address, size) are passed to an OS kernel that is
4641 being started.
4642 "Multi-File Images" contain several images, typically an OS
4643 (Linux) kernel image and one or more data images like
4644 RAMDisks. This construct is useful for instance when you want
4645 to boot over the network using BOOTP etc., where the boot
4646 server provides just a single image file, but you want to get
4647 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004648
wdenk2729af92004-05-03 20:45:30 +00004649 "Multi-File Images" start with a list of image sizes, each
4650 image size (in bytes) specified by an "uint32_t" in network
4651 byte order. This list is terminated by an "(uint32_t)0".
4652 Immediately after the terminating 0 follow the images, one by
4653 one, all aligned on "uint32_t" boundaries (size rounded up to
4654 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004655
wdenk2729af92004-05-03 20:45:30 +00004656 "Firmware Images" are binary images containing firmware (like
4657 U-Boot or FPGA images) which usually will be programmed to
4658 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004659
wdenk2729af92004-05-03 20:45:30 +00004660 "Script files" are command sequences that will be executed by
4661 U-Boot's command interpreter; this feature is especially
4662 useful when you configure U-Boot to use a real shell (hush)
4663 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004664
Marek Vasut44f074c2012-03-14 21:52:45 +00004665Booting the Linux zImage:
4666-------------------------
4667
4668On some platforms, it's possible to boot Linux zImage. This is done
4669using the "bootz" command. The syntax of "bootz" command is the same
4670as the syntax of "bootm" command.
4671
Tom Rini8ac28562013-05-16 11:40:11 -04004672Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004673kernel with raw initrd images. The syntax is slightly different, the
4674address of the initrd must be augmented by it's size, in the following
4675format: "<initrd addres>:<initrd size>".
4676
wdenkc6097192002-11-03 00:24:07 +00004677
wdenk2729af92004-05-03 20:45:30 +00004678Standalone HOWTO:
4679=================
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk2729af92004-05-03 20:45:30 +00004681One of the features of U-Boot is that you can dynamically load and
4682run "standalone" applications, which can use some resources of
4683U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk2729af92004-05-03 20:45:30 +00004685Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk2729af92004-05-03 20:45:30 +00004687"Hello World" Demo:
4688-------------------
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690'examples/hello_world.c' contains a small "Hello World" Demo
4691application; it is automatically compiled when you build U-Boot.
4692It's configured to run at address 0x00040004, so you can play with it
4693like that:
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk2729af92004-05-03 20:45:30 +00004695 => loads
4696 ## Ready for S-Record download ...
4697 ~>examples/hello_world.srec
4698 1 2 3 4 5 6 7 8 9 10 11 ...
4699 [file transfer complete]
4700 [connected]
4701 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703 => go 40004 Hello World! This is a test.
4704 ## Starting application at 0x00040004 ...
4705 Hello World
4706 argc = 7
4707 argv[0] = "40004"
4708 argv[1] = "Hello"
4709 argv[2] = "World!"
4710 argv[3] = "This"
4711 argv[4] = "is"
4712 argv[5] = "a"
4713 argv[6] = "test."
4714 argv[7] = "<NULL>"
4715 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk2729af92004-05-03 20:45:30 +00004717 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004718
wdenk2729af92004-05-03 20:45:30 +00004719Another example, which demonstrates how to register a CPM interrupt
4720handler with the U-Boot code, can be found in 'examples/timer.c'.
4721Here, a CPM timer is set up to generate an interrupt every second.
4722The interrupt service routine is trivial, just printing a '.'
4723character, but this is just a demo program. The application can be
4724controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk2729af92004-05-03 20:45:30 +00004726 ? - print current values og the CPM Timer registers
4727 b - enable interrupts and start timer
4728 e - stop timer and disable interrupts
4729 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk2729af92004-05-03 20:45:30 +00004731 => loads
4732 ## Ready for S-Record download ...
4733 ~>examples/timer.srec
4734 1 2 3 4 5 6 7 8 9 10 11 ...
4735 [file transfer complete]
4736 [connected]
4737 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk2729af92004-05-03 20:45:30 +00004739 => go 40004
4740 ## Starting application at 0x00040004 ...
4741 TIMERS=0xfff00980
4742 Using timer 1
4743 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk2729af92004-05-03 20:45:30 +00004745Hit 'b':
4746 [q, b, e, ?] Set interval 1000000 us
4747 Enabling timer
4748Hit '?':
4749 [q, b, e, ?] ........
4750 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4751Hit '?':
4752 [q, b, e, ?] .
4753 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4754Hit '?':
4755 [q, b, e, ?] .
4756 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4757Hit '?':
4758 [q, b, e, ?] .
4759 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4760Hit 'e':
4761 [q, b, e, ?] ...Stopping timer
4762Hit 'q':
4763 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004764
4765
wdenk2729af92004-05-03 20:45:30 +00004766Minicom warning:
4767================
wdenk85ec0bc2003-03-31 16:34:49 +00004768
wdenk2729af92004-05-03 20:45:30 +00004769Over time, many people have reported problems when trying to use the
4770"minicom" terminal emulation program for serial download. I (wd)
4771consider minicom to be broken, and recommend not to use it. Under
4772Unix, I recommend to use C-Kermit for general purpose use (and
4773especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004774use "cu" for S-Record download ("loads" command). See
4775http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4776for help with kermit.
4777
wdenk85ec0bc2003-03-31 16:34:49 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779Nevertheless, if you absolutely want to use it try adding this
4780configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004781
wdenk2729af92004-05-03 20:45:30 +00004782 Name Program Name U/D FullScr IO-Red. Multi
4783 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4784 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004785
4786
wdenk2729af92004-05-03 20:45:30 +00004787NetBSD Notes:
4788=============
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790Starting at version 0.9.2, U-Boot supports NetBSD both as host
4791(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793Building requires a cross environment; it is known to work on
4794NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4795need gmake since the Makefiles are not compatible with BSD make).
4796Note that the cross-powerpc package does not install include files;
4797attempting to build U-Boot will fail because <machine/ansi.h> is
4798missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004799
wdenk2729af92004-05-03 20:45:30 +00004800 # cd /usr/pkg/cross/powerpc-netbsd/include
4801 # mkdir powerpc
4802 # ln -s powerpc machine
4803 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4804 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk2729af92004-05-03 20:45:30 +00004806Native builds *don't* work due to incompatibilities between native
4807and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk2729af92004-05-03 20:45:30 +00004809Booting assumes that (the first part of) the image booted is a
4810stage-2 loader which in turn loads and then invokes the kernel
4811proper. Loader sources will eventually appear in the NetBSD source
4812tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004813meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004814
4815
wdenk2729af92004-05-03 20:45:30 +00004816Implementation Internals:
4817=========================
wdenkc6097192002-11-03 00:24:07 +00004818
wdenk2729af92004-05-03 20:45:30 +00004819The following is not intended to be a complete description of every
4820implementation detail. However, it should help to understand the
4821inner workings of U-Boot and make it easier to port it to custom
4822hardware.
wdenkc6097192002-11-03 00:24:07 +00004823
4824
wdenk2729af92004-05-03 20:45:30 +00004825Initial Stack, Global Data:
4826---------------------------
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828The implementation of U-Boot is complicated by the fact that U-Boot
4829starts running out of ROM (flash memory), usually without access to
4830system RAM (because the memory controller is not initialized yet).
4831This means that we don't have writable Data or BSS segments, and BSS
4832is not initialized as zero. To be able to get a C environment working
4833at all, we have to allocate at least a minimal stack. Implementation
4834options for this are defined and restricted by the CPU used: Some CPU
4835models provide on-chip memory (like the IMMR area on MPC8xx and
4836MPC826x processors), on others (parts of) the data cache can be
4837locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004838
Wolfgang Denk218ca722008-03-26 10:40:12 +01004839 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004840 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004841
wdenk2729af92004-05-03 20:45:30 +00004842 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4843 From: "Chris Hallinan" <clh@net1plus.com>
4844 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4845 ...
wdenk43d96162003-03-06 00:02:04 +00004846
wdenk2729af92004-05-03 20:45:30 +00004847 Correct me if I'm wrong, folks, but the way I understand it
4848 is this: Using DCACHE as initial RAM for Stack, etc, does not
4849 require any physical RAM backing up the cache. The cleverness
4850 is that the cache is being used as a temporary supply of
4851 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004852 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004853 can see how this works by studying the cache architecture and
4854 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004855
wdenk2729af92004-05-03 20:45:30 +00004856 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4857 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004858 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004859 option should work for you. Using CS 4 should be fine if your
4860 board designers haven't used it for something that would
4861 cause you grief during the initial boot! It is frequently not
4862 used.
wdenk43d96162003-03-06 00:02:04 +00004863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004864 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004865 with your processor/board/system design. The default value
4866 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004867 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004868 than your SDRAM module. If you have a 64MB SDRAM module, set
4869 it above 400_0000. Just make sure your board has no resources
4870 that are supposed to respond to that address! That code in
4871 start.S has been around a while and should work as is when
4872 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874 -Chris Hallinan
4875 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004876
wdenk2729af92004-05-03 20:45:30 +00004877It is essential to remember this, since it has some impact on the C
4878code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk2729af92004-05-03 20:45:30 +00004880* Initialized global data (data segment) is read-only. Do not attempt
4881 to write it.
wdenkc6097192002-11-03 00:24:07 +00004882
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004883* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004884 as zero data - BSS segment) at all - this is undefined, initiali-
4885 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887* Stack space is very limited. Avoid big data buffers or things like
4888 that.
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004891normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004892turned out that the implementation of U-Boot can be greatly
4893simplified by making a global data structure (gd_t) available to all
4894functions. We could pass a pointer to this data as argument to _all_
4895functions, but this would bloat the code. Instead we use a feature of
4896the GCC compiler (Global Register Variables) to share the data: we
4897place a pointer (gd) to the global data into a register which we
4898reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900When choosing a register for such a purpose we are restricted by the
4901relevant (E)ABI specifications for the current architecture, and by
4902GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk2729af92004-05-03 20:45:30 +00004904For PowerPC, the following registers have specific use:
4905 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004906 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004907 R3-R4: parameter passing and return values
4908 R5-R10: parameter passing
4909 R13: small data area pointer
4910 R30: GOT pointer
4911 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004912
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004913 (U-Boot also uses R12 as internal GOT pointer. r12
4914 is a volatile register so r12 needs to be reset when
4915 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004916
Wolfgang Denke7670f62008-02-14 22:43:22 +01004917 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk2729af92004-05-03 20:45:30 +00004919 Note: on PPC, we could use a static initializer (since the
4920 address of the global data structure is known at compile time),
4921 but it turned out that reserving a register results in somewhat
4922 smaller code - although the code savings are not that big (on
4923 average for all boards 752 bytes for the whole U-Boot image,
4924 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk2729af92004-05-03 20:45:30 +00004928 R0: function argument word/integer result
4929 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004930 R9: platform specific
4931 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004932 R11: argument (frame) pointer
4933 R12: temporary workspace
4934 R13: stack pointer
4935 R14: link register
4936 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004937
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004938 ==> U-Boot will use R9 to hold a pointer to the global data
4939
4940 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004941
Thomas Chou0df01fd2010-05-21 11:08:03 +08004942On Nios II, the ABI is documented here:
4943 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4944
4945 ==> U-Boot will use gp to hold a pointer to the global data
4946
4947 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4948 to access small data sections, so gp is free.
4949
Macpaul Linafc1ce82011-10-19 20:41:11 +00004950On NDS32, the following registers are used:
4951
4952 R0-R1: argument/return
4953 R2-R5: argument
4954 R15: temporary register for assembler
4955 R16: trampoline register
4956 R28: frame pointer (FP)
4957 R29: global pointer (GP)
4958 R30: link register (LP)
4959 R31: stack pointer (SP)
4960 PC: program counter (PC)
4961
4962 ==> U-Boot will use R10 to hold a pointer to the global data
4963
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004964NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4965or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004966
wdenk2729af92004-05-03 20:45:30 +00004967Memory Management:
4968------------------
wdenkc6097192002-11-03 00:24:07 +00004969
wdenk2729af92004-05-03 20:45:30 +00004970U-Boot runs in system state and uses physical addresses, i.e. the
4971MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973The available memory is mapped to fixed addresses using the memory
4974controller. In this process, a contiguous block is formed for each
4975memory type (Flash, SDRAM, SRAM), even when it consists of several
4976physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk2729af92004-05-03 20:45:30 +00004978U-Boot is installed in the first 128 kB of the first Flash bank (on
4979TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4980booting and sizing and initializing DRAM, the code relocates itself
4981to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004982memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004983configuration setting]. Below that, a structure with global Board
4984Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986Additionally, some exception handler code is copied to the low 8 kB
4987of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989So a typical memory configuration with 16 MB of DRAM could look like
4990this:
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992 0x0000 0000 Exception Vector code
4993 :
4994 0x0000 1FFF
4995 0x0000 2000 Free for Application Use
4996 :
4997 :
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk2729af92004-05-03 20:45:30 +00004999 :
5000 :
5001 0x00FB FF20 Monitor Stack (Growing downward)
5002 0x00FB FFAC Board Info Data and permanent copy of global data
5003 0x00FC 0000 Malloc Arena
5004 :
5005 0x00FD FFFF
5006 0x00FE 0000 RAM Copy of Monitor Code
5007 ... eventually: LCD or video framebuffer
5008 ... eventually: pRAM (Protected RAM - unchanged by reset)
5009 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005010
5011
wdenk2729af92004-05-03 20:45:30 +00005012System Initialization:
5013----------------------
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk2729af92004-05-03 20:45:30 +00005015In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005016(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005017configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005018To be able to re-map memory U-Boot then jumps to its link address.
5019To be able to implement the initialization code in C, a (small!)
5020initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02005021which provide such a feature like), or in a locked part of the data
5022cache. After that, U-Boot initializes the CPU core, the caches and
5023the SIU.
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025Next, all (potentially) available memory banks are mapped using a
5026preliminary mapping. For example, we put them on 512 MB boundaries
5027(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5028on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5029programmed for SDRAM access. Using the temporary configuration, a
5030simple memory test is run that determines the size of the SDRAM
5031banks.
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033When there is more than one SDRAM bank, and the banks are of
5034different size, the largest is mapped first. For equal size, the first
5035bank (CS2#) is mapped first. The first mapping is always for address
50360x00000000, with any additional banks following immediately to create
5037contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005038
wdenk2729af92004-05-03 20:45:30 +00005039Then, the monitor installs itself at the upper end of the SDRAM area
5040and allocates memory for use by malloc() and for the global Board
5041Info data; also, the exception vector code is copied to the low RAM
5042pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044Only after this relocation will you have a "normal" C environment;
5045until that you are restricted in several ways, mostly because you are
5046running from ROM, and because the code will have to be relocated to a
5047new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005048
5049
wdenk2729af92004-05-03 20:45:30 +00005050U-Boot Porting Guide:
5051----------------------
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5054list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005055
5056
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005057int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005058{
5059 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005060
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005061 signal(SIGALRM, no_more_time);
5062 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005063
wdenk2729af92004-05-03 20:45:30 +00005064 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005065 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005066 return 0;
5067 }
5068
wdenk2729af92004-05-03 20:45:30 +00005069 Download latest U-Boot source;
5070
Wolfgang Denk06682362008-12-30 22:56:11 +01005071 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005072
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005073 if (clueless)
5074 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk2729af92004-05-03 20:45:30 +00005076 while (learning) {
5077 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005078 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5079 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005080 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005081 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005082 }
wdenkc6097192002-11-03 00:24:07 +00005083
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005084 if (available_money > toLocalCurrency ($2500))
5085 Buy a BDI3000;
5086 else
wdenk2729af92004-05-03 20:45:30 +00005087 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005088
5089 if (a similar board exists) { /* hopefully... */
5090 cp -a board/<similar> board/<myboard>
5091 cp include/configs/<similar>.h include/configs/<myboard>.h
5092 } else {
5093 Create your own board support subdirectory;
5094 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005095 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005096 Edit new board/<myboard> files
5097 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005098
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005099 while (!accepted) {
5100 while (!running) {
5101 do {
5102 Add / modify source code;
5103 } until (compiles);
5104 Debug;
5105 if (clueless)
5106 email("Hi, I am having problems...");
5107 }
5108 Send patch file to the U-Boot email list;
5109 if (reasonable critiques)
5110 Incorporate improvements from email list code review;
5111 else
5112 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005113 }
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk2729af92004-05-03 20:45:30 +00005115 return 0;
5116}
5117
5118void no_more_time (int sig)
5119{
5120 hire_a_guru();
5121}
wdenkc6097192002-11-03 00:24:07 +00005122
5123
wdenk2729af92004-05-03 20:45:30 +00005124Coding Standards:
5125-----------------
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk2729af92004-05-03 20:45:30 +00005127All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02005128coding style; see the kernel coding style guide at
5129https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
5130script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005131
Detlev Zundel2c051652006-09-01 15:39:02 +02005132Source files originating from a different project (for example the
5133MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005134reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005135sources.
5136
5137Please note that U-Boot is implemented in C (and to some small parts in
5138Assembler); no C++ is used, so please do not use C++ style comments (//)
5139in your code.
wdenk2729af92004-05-03 20:45:30 +00005140
5141Please also stick to the following formatting rules:
5142- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005143- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005144- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005145- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005146- do not add trailing empty lines to source files
5147
5148Submissions which do not conform to the standards may be returned
5149with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005150
5151
wdenk2729af92004-05-03 20:45:30 +00005152Submitting Patches:
5153-------------------
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk2729af92004-05-03 20:45:30 +00005155Since the number of patches for U-Boot is growing, we need to
5156establish some rules. Submissions which do not conform to these rules
5157may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005158
Magnus Lilja0d28f342008-08-06 19:32:33 +02005159Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005160
Wolfgang Denk06682362008-12-30 22:56:11 +01005161Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08005162see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01005163
wdenk2729af92004-05-03 20:45:30 +00005164When you send a patch, please include the following information with
5165it:
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167* For bug fixes: a description of the bug and how your patch fixes
5168 this bug. Please try to include a way of demonstrating that the
5169 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171* For new features: a description of the feature and your
5172 implementation.
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk2729af92004-05-03 20:45:30 +00005174* A CHANGELOG entry as plaintext (separate from the patch)
5175
Robert P. J. Day7207b362015-12-19 07:16:10 -05005176* For major contributions, add a MAINTAINERS file with your
5177 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005178
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005179* When you add support for a new board, don't forget to add a
5180 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005181
5182* If your patch adds new configuration options, don't forget to
5183 document these in the README file.
5184
Wolfgang Denk218ca722008-03-26 10:40:12 +01005185* The patch itself. If you are using git (which is *strongly*
5186 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005187 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005188 the U-Boot mailing list, you will avoid most of the common problems
5189 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005190
Wolfgang Denk218ca722008-03-26 10:40:12 +01005191 If you cannot use git, use "diff -purN OLD NEW". If your version of
5192 diff does not support these options, then get the latest version of
5193 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005194
Wolfgang Denk218ca722008-03-26 10:40:12 +01005195 The current directory when running this command shall be the parent
5196 directory of the U-Boot source tree (i. e. please make sure that
5197 your patch includes sufficient directory information for the
5198 affected files).
5199
5200 We prefer patches as plain text. MIME attachments are discouraged,
5201 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005202
5203* If one logical set of modifications affects or creates several
5204 files, all these changes shall be submitted in a SINGLE patch file.
5205
5206* Changesets that contain different, unrelated modifications shall be
5207 submitted as SEPARATE patches, one patch per changeset.
5208
5209
5210Notes:
5211
Simon Glass6de80f22016-07-27 20:33:08 -06005212* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005213 source tree and make sure that no errors or warnings are reported
5214 for any of the boards.
5215
5216* Keep your modifications to the necessary minimum: A patch
5217 containing several unrelated changes or arbitrary reformats will be
5218 returned with a request to re-formatting / split it.
5219
5220* If you modify existing code, make sure that your new code does not
5221 add to the memory footprint of the code ;-) Small is beautiful!
5222 When adding new features, these should compile conditionally only
5223 (using #ifdef), and the resulting code with the new feature
5224 disabled must not need more memory than the old code without your
5225 modification.
wdenk90dc6702005-05-03 14:12:25 +00005226
Wolfgang Denk06682362008-12-30 22:56:11 +01005227* Remember that there is a size limit of 100 kB per message on the
5228 u-boot mailing list. Bigger patches will be moderated. If they are
5229 reasonable and not too big, they will be acknowledged. But patches
5230 bigger than the size limit should be avoided.