blob: 3cf139edebba4e9f636ff9a6360b268f9f48ff36 [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
315
wdenkc6097192002-11-03 00:24:07 +0000316The following options need to be configured:
317
Kim Phillips26281142007-08-10 13:28:25 -0500318- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000319
Kim Phillips26281142007-08-10 13:28:25 -0500320- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Kumar Gala66412c62011-02-18 05:40:54 -0600327- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000328 CONFIG_SYS_PPC64
329
330 Specifies that the core is a 64-bit PowerPC implementation (implements
331 the "64" category of the Power ISA). This is necessary for ePAPR
332 compliance, among other possible reasons.
333
Kumar Gala66412c62011-02-18 05:40:54 -0600334 CONFIG_SYS_FSL_TBCLK_DIV
335
336 Defines the core time base clock divider ratio compared to the
337 system clock. On most PQ3 devices this is 8, on newer QorIQ
338 devices it can be 16 or 32. The ratio varies from SoC to Soc.
339
Kumar Gala8f290842011-05-20 00:39:21 -0500340 CONFIG_SYS_FSL_PCIE_COMPAT
341
342 Defines the string to utilize when trying to match PCIe device
343 tree nodes for the given platform.
344
Scott Wood33eee332012-08-14 10:14:53 +0000345 CONFIG_SYS_FSL_ERRATUM_A004510
346
347 Enables a workaround for erratum A004510. If set,
348 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
350
351 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
352 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
353
354 Defines one or two SoC revisions (low 8 bits of SVR)
355 for which the A004510 workaround should be applied.
356
357 The rest of SVR is either not relevant to the decision
358 of whether the erratum is present (e.g. p2040 versus
359 p2041) or is implied by the build target, which controls
360 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
361
362 See Freescale App Note 4493 for more information about
363 this erratum.
364
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530365 CONFIG_A003399_NOR_WORKAROUND
366 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800367 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530368
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530369 CONFIG_A008044_WORKAROUND
370 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800371 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530372
Scott Wood33eee332012-08-14 10:14:53 +0000373 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
374
375 This is the value to write into CCSR offset 0x18600
376 according to the A004510 workaround.
377
Priyanka Jain64501c62013-07-02 09:21:04 +0530378 CONFIG_SYS_FSL_DSP_DDR_ADDR
379 This value denotes start offset of DDR memory which is
380 connected exclusively to the DSP cores.
381
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530382 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
383 This value denotes start offset of M2 memory
384 which is directly connected to the DSP core.
385
Priyanka Jain64501c62013-07-02 09:21:04 +0530386 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
387 This value denotes start offset of M3 memory which is directly
388 connected to the DSP core.
389
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530390 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391 This value denotes start offset of DSP CCSR space.
392
Priyanka Jainb1359912013-12-17 14:25:52 +0530393 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
394 Single Source Clock is clocking mode present in some of FSL SoC's.
395 In this mode, a single differential clock is used to supply
396 clocks to the sysclock, ddrclock and usbclock.
397
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530398 CONFIG_SYS_CPC_REINIT_F
399 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800400 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530401
Tang Yuantianaade2002014-04-17 15:33:46 +0800402 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800403 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800404 supported, core will start to execute uboot when wakes up.
405
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000406- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700407 CONFIG_SYS_GENERIC_GLOBAL_DATA
408 Defines global data is initialized in generic board board_init_f().
409 If this macro is defined, global data is created and cleared in
410 generic board board_init_f(). Without this macro, architecture/board
411 should initialize global data before calling board_init_f().
412
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000413 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
414
415 Defines the endianess of the CPU. Implementation of those
416 values is arch specific.
417
York Sun5614e712013-09-30 09:22:09 -0700418 CONFIG_SYS_FSL_DDR
419 Freescale DDR driver in use. This type of DDR controller is
420 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
421 SoCs.
422
423 CONFIG_SYS_FSL_DDR_ADDR
424 Freescale DDR memory-mapped register base.
425
426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
429
430 CONFIG_SYS_FSL_DDRC_GEN1
431 Freescale DDR1 controller.
432
433 CONFIG_SYS_FSL_DDRC_GEN2
434 Freescale DDR2 controller.
435
436 CONFIG_SYS_FSL_DDRC_GEN3
437 Freescale DDR3 controller.
438
York Sun34e026f2014-03-27 17:54:47 -0700439 CONFIG_SYS_FSL_DDRC_GEN4
440 Freescale DDR4 controller.
441
York Sun9ac4ffb2013-09-30 14:20:51 -0700442 CONFIG_SYS_FSL_DDRC_ARM_GEN3
443 Freescale DDR3 controller for ARM-based SoCs.
444
York Sun5614e712013-09-30 09:22:09 -0700445 CONFIG_SYS_FSL_DDR1
446 Board config to use DDR1. It can be enabled for SoCs with
447 Freescale DDR1 or DDR2 controllers, depending on the board
448 implemetation.
449
450 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400451 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700452 Freescale DDR2 or DDR3 controllers, depending on the board
453 implementation.
454
455 CONFIG_SYS_FSL_DDR3
456 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700457 Freescale DDR3 or DDR3L controllers.
458
459 CONFIG_SYS_FSL_DDR3L
460 Board config to use DDR3L. It can be enabled for SoCs with
461 DDR3L controllers.
462
463 CONFIG_SYS_FSL_DDR4
464 Board config to use DDR4. It can be enabled for SoCs with
465 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700466
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530467 CONFIG_SYS_FSL_IFC_BE
468 Defines the IFC controller register space as Big Endian
469
470 CONFIG_SYS_FSL_IFC_LE
471 Defines the IFC controller register space as Little Endian
472
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530473 CONFIG_SYS_FSL_IFC_CLK_DIV
474 Defines divider of platform clock(clock input to IFC controller).
475
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530476 CONFIG_SYS_FSL_LBC_CLK_DIV
477 Defines divider of platform clock(clock input to eLBC controller).
478
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530479 CONFIG_SYS_FSL_PBL_PBI
480 It enables addition of RCW (Power on reset configuration) in built image.
481 Please refer doc/README.pblimage for more details
482
483 CONFIG_SYS_FSL_PBL_RCW
484 It adds PBI(pre-boot instructions) commands in u-boot build image.
485 PBI commands can be used to configure SoC before it starts the execution.
486 Please refer doc/README.pblimage for more details
487
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530488 CONFIG_SPL_FSL_PBL
489 It adds a target to create boot binary having SPL binary in PBI format
490 concatenated with u-boot binary.
491
York Sun4e5b1bd2014-02-10 13:59:42 -0800492 CONFIG_SYS_FSL_DDR_BE
493 Defines the DDR controller register space as Big Endian
494
495 CONFIG_SYS_FSL_DDR_LE
496 Defines the DDR controller register space as Little Endian
497
York Sun6b9e3092014-02-10 13:59:43 -0800498 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
499 Physical address from the view of DDR controllers. It is the
500 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
501 it could be different for ARM SoCs.
502
York Sun6b1e1252014-02-10 13:59:44 -0800503 CONFIG_SYS_FSL_DDR_INTLV_256B
504 DDR controller interleaving on 256-byte. This is a special
505 interleaving mode, handled by Dickens for Freescale layerscape
506 SoCs with ARM core.
507
York Sun1d71efb2014-08-01 15:51:00 -0700508 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
509 Number of controllers used as main memory.
510
511 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
512 Number of controllers used for other than main memory.
513
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530514 CONFIG_SYS_FSL_HAS_DP_DDR
515 Defines the SoC has DP-DDR used for DPAA.
516
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530517 CONFIG_SYS_FSL_SEC_BE
518 Defines the SEC controller register space as Big Endian
519
520 CONFIG_SYS_FSL_SEC_LE
521 Defines the SEC controller register space as Little Endian
522
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200523- MIPS CPU options:
524 CONFIG_SYS_INIT_SP_OFFSET
525
526 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
527 pointer. This is needed for the temporary stack before
528 relocation.
529
530 CONFIG_SYS_MIPS_CACHE_MODE
531
532 Cache operation mode for the MIPS CPU.
533 See also arch/mips/include/asm/mipsregs.h.
534 Possible values are:
535 CONF_CM_CACHABLE_NO_WA
536 CONF_CM_CACHABLE_WA
537 CONF_CM_UNCACHED
538 CONF_CM_CACHABLE_NONCOHERENT
539 CONF_CM_CACHABLE_CE
540 CONF_CM_CACHABLE_COW
541 CONF_CM_CACHABLE_CUW
542 CONF_CM_CACHABLE_ACCELERATED
543
544 CONFIG_SYS_XWAY_EBU_BOOTCFG
545
546 Special option for Lantiq XWAY SoCs for booting from NOR flash.
547 See also arch/mips/cpu/mips32/start.S.
548
549 CONFIG_XWAY_SWAP_BYTES
550
551 Enable compilation of tools/xway-swap-bytes needed for Lantiq
552 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
553 be swapped if a flash programmer is used.
554
Christian Rieschb67d8812012-02-02 00:44:39 +0000555- ARM options:
556 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
557
558 Select high exception vectors of the ARM core, e.g., do not
559 clear the V bit of the c1 register of CP15.
560
York Sun207774b2015-03-20 19:28:08 -0700561 COUNTER_FREQUENCY
562 Generic timer clock source frequency.
563
564 COUNTER_FREQUENCY_REAL
565 Generic timer clock source frequency if the real clock is
566 different from COUNTER_FREQUENCY, and can only be determined
567 at run time.
568
Stephen Warren73c38932015-01-19 16:25:52 -0700569- Tegra SoC options:
570 CONFIG_TEGRA_SUPPORT_NON_SECURE
571
572 Support executing U-Boot in non-secure (NS) mode. Certain
573 impossible actions will be skipped if the CPU is in NS mode,
574 such as ARM architectural timer initialization.
575
wdenk5da627a2003-10-09 20:09:04 +0000576- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000577 CONFIG_CLOCKS_IN_MHZ
578
579 U-Boot stores all clock information in Hz
580 internally. For binary compatibility with older Linux
581 kernels (which expect the clocks passed in the
582 bd_info data to be in MHz) the environment variable
583 "clocks_in_mhz" can be defined so that U-Boot
584 converts clock data to MHZ before passing it to the
585 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000586 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100587 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000588 default environment.
589
wdenk5da627a2003-10-09 20:09:04 +0000590 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
591
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800592 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000593 expect it to be in bytes, others in MB.
594 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
595
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400596 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200597
598 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400599 passed using flattened device trees (based on open firmware
600 concepts).
601
602 CONFIG_OF_LIBFDT
603 * New libfdt-based support
604 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500605 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400606
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200607 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600608 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200609
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200610 boards with QUICC Engines require OF_QE to set UCC MAC
611 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500612
Kumar Gala4e253132006-01-11 13:54:17 -0600613 CONFIG_OF_BOARD_SETUP
614
615 Board code has addition modification that it wants to make
616 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000617
Simon Glassc654b512014-10-23 18:58:54 -0600618 CONFIG_OF_SYSTEM_SETUP
619
620 Other code has addition modification that it wants to make
621 to the flat device tree before handing it off to the kernel.
622 This causes ft_system_setup() to be called before booting
623 the kernel.
624
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200625 CONFIG_OF_IDE_FIXUP
626
627 U-Boot can detect if an IDE device is present or not.
628 If not, and this new config option is activated, U-Boot
629 removes the ATA node from the DTS before booting Linux,
630 so the Linux IDE driver does not probe the device and
631 crash. This is needed for buggy hardware (uc101) where
632 no pull down resistor is connected to the signal IDE5V_DD7.
633
Igor Grinberg7eb29392011-07-14 05:45:07 +0000634 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
635
636 This setting is mandatory for all boards that have only one
637 machine type and must be used to specify the machine type
638 number as it appears in the ARM machine registry
639 (see http://www.arm.linux.org.uk/developer/machines/).
640 Only boards that have multiple machine types supported
641 in a single configuration file and the machine type is
642 runtime discoverable, do not have to use this setting.
643
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100644- vxWorks boot parameters:
645
646 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700647 environments variables: bootdev, bootfile, ipaddr, netmask,
648 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100649 It loads the vxWorks image pointed bootfile.
650
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100651 Note: If a "bootargs" environment is defined, it will overwride
652 the defaults discussed just above.
653
Aneesh V2c451f72011-06-16 23:30:47 +0000654- Cache Configuration:
655 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
656 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
657 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
658
Aneesh V93bc2192011-06-16 23:30:51 +0000659- Cache Configuration for ARM:
660 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
661 controller
662 CONFIG_SYS_PL310_BASE - Physical base address of PL310
663 controller register space
664
wdenk6705d812004-08-02 23:22:59 +0000665- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200666 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL010 UARTs.
669
Andreas Engel48d01922008-09-08 14:30:53 +0200670 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000671
672 Define this if you want support for Amba PrimeCell PL011 UARTs.
673
674 CONFIG_PL011_CLOCK
675
676 If you have Amba PrimeCell PL011 UARTs, set this variable to
677 the clock speed of the UARTs.
678
679 CONFIG_PL01x_PORTS
680
681 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
682 define this to a list of base addresses for each (supported)
683 port. See e.g. include/configs/versatile.h
684
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400685 CONFIG_SERIAL_HW_FLOW_CONTROL
686
687 Define this variable to enable hw flow control in serial driver.
688 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000689
wdenkc6097192002-11-03 00:24:07 +0000690- Console Baudrate:
691 CONFIG_BAUDRATE - in bps
692 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200693 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000694
wdenkc6097192002-11-03 00:24:07 +0000695- Autoboot Command:
696 CONFIG_BOOTCOMMAND
697 Only needed when CONFIG_BOOTDELAY is enabled;
698 define a command string that is automatically executed
699 when no character is read on the console interface
700 within "Boot Delay" after reset.
701
702 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000703 This can be used to pass arguments to the bootm
704 command. The value of CONFIG_BOOTARGS goes into the
705 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000706
707 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000708 The value of these goes into the environment as
709 "ramboot" and "nfsboot" respectively, and can be used
710 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200711 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000712
Heiko Schochereda0ba32013-11-04 14:04:59 +0100713- Bootcount:
714 CONFIG_BOOTCOUNT_LIMIT
715 Implements a mechanism for detecting a repeating reboot
716 cycle, see:
717 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
718
719 CONFIG_BOOTCOUNT_ENV
720 If no softreset save registers are found on the hardware
721 "bootcount" is stored in the environment. To prevent a
722 saveenv on all reboots, the environment variable
723 "upgrade_available" is used. If "upgrade_available" is
724 0, "bootcount" is always 0, if "upgrade_available" is
725 1 "bootcount" is incremented in the environment.
726 So the Userspace Applikation must set the "upgrade_available"
727 and "bootcount" variable to 0, if a boot was successfully.
728
wdenkc6097192002-11-03 00:24:07 +0000729- Pre-Boot Commands:
730 CONFIG_PREBOOT
731
732 When this option is #defined, the existence of the
733 environment variable "preboot" will be checked
734 immediately before starting the CONFIG_BOOTDELAY
735 countdown and/or running the auto-boot command resp.
736 entering interactive mode.
737
738 This feature is especially useful when "preboot" is
739 automatically generated or modified. For an example
740 see the LWMON board specific code: here "preboot" is
741 modified when the user holds down a certain
742 combination of keys on the (special) keyboard when
743 booting the systems
744
745- Serial Download Echo Mode:
746 CONFIG_LOADS_ECHO
747 If defined to 1, all characters received during a
748 serial download (using the "loads" command) are
749 echoed back. This might be needed by some terminal
750 emulations (like "cu"), but may as well just take
751 time on others. This setting #define's the initial
752 value of the "loads_echo" environment variable.
753
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000755 CONFIG_KGDB_BAUDRATE
756 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200757 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000758
Simon Glass302a6482016-03-13 19:07:28 -0600759- Removal of commands
760 If no commands are needed to boot, you can disable
761 CONFIG_CMDLINE to remove them. In this case, the command line
762 will not be available, and when U-Boot wants to execute the
763 boot command (on start-up) it will call board_run_command()
764 instead. This can reduce image size significantly for very
765 simple boot procedures.
766
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000767- Regular expression support:
768 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200769 If this variable is defined, U-Boot is linked against
770 the SLRE (Super Light Regular Expression) library,
771 which adds regex support to some commands, as for
772 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000773
Simon Glass45ba8072011-10-15 05:48:20 +0000774- Device tree:
775 CONFIG_OF_CONTROL
776 If this variable is defined, U-Boot will use a device tree
777 to configure its devices, instead of relying on statically
778 compiled #defines in the board file. This option is
779 experimental and only available on a few boards. The device
780 tree is available in the global data as gd->fdt_blob.
781
Simon Glass2c0f79e2011-10-24 19:15:31 +0000782 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700783 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000784
785 CONFIG_OF_EMBED
786 If this variable is defined, U-Boot will embed a device tree
787 binary in its image. This device tree file should be in the
788 board directory and called <soc>-<board>.dts. The binary file
789 is then picked up in board_init_f() and made available through
790 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000791
Simon Glass2c0f79e2011-10-24 19:15:31 +0000792 CONFIG_OF_SEPARATE
793 If this variable is defined, U-Boot will build a device tree
794 binary. It will be called u-boot.dtb. Architecture-specific
795 code will locate it at run-time. Generally this works by:
796
797 cat u-boot.bin u-boot.dtb >image.bin
798
799 and in fact, U-Boot does this for you, creating a file called
800 u-boot-dtb.bin which is useful in the common case. You can
801 still use the individual files if you need something more
802 exotic.
803
Alex Deymo82f766d2017-04-02 01:25:20 -0700804 CONFIG_OF_BOARD
805 If this variable is defined, U-Boot will use the device tree
806 provided by the board at runtime instead of embedding one with
807 the image. Only boards defining board_fdt_blob_setup() support
808 this option (see include/fdtdec.h file).
809
wdenkc6097192002-11-03 00:24:07 +0000810- Watchdog:
811 CONFIG_WATCHDOG
812 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000813 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200814 specific code for a watchdog. For the 8xx
815 CPUs, the SIU Watchdog feature is enabled in the SYPCR
816 register. When supported for a specific SoC is
817 available, then no further board specific code should
818 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000819
820 CONFIG_HW_WATCHDOG
821 When using a watchdog circuitry external to the used
822 SoC, then define this variable and provide board
823 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000824
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100825 CONFIG_AT91_HW_WDT_TIMEOUT
826 specify the timeout in seconds. default 2 seconds.
827
stroesec1551ea2003-04-04 15:53:41 +0000828- U-Boot Version:
829 CONFIG_VERSION_VARIABLE
830 If this variable is defined, an environment variable
831 named "ver" is created by U-Boot showing the U-Boot
832 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +0200833 Any change to this variable will be reverted at the
834 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000835
wdenkc6097192002-11-03 00:24:07 +0000836- Real-Time Clock:
837
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000839 has to be selected, too. Define exactly one of the
840 following options:
841
wdenkc6097192002-11-03 00:24:07 +0000842 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000843 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000845 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000847 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200848 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000849 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100850 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000851 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200852 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200853 CONFIG_SYS_RV3029_TCR - enable trickle charger on
854 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000855
wdenkb37c7e52003-06-30 16:24:52 +0000856 Note that if the RTC uses I2C, then the I2C interface
857 must also be configured. See I2C Support, below.
858
Peter Tysere92739d2008-12-17 16:36:21 -0600859- GPIO Support:
860 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600861
Chris Packham5dec49c2010-12-19 10:12:13 +0000862 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
863 chip-ngpio pairs that tell the PCA953X driver the number of
864 pins supported by a particular chip.
865
Peter Tysere92739d2008-12-17 16:36:21 -0600866 Note that if the GPIO device uses I2C, then the I2C interface
867 must also be configured. See I2C Support, below.
868
Simon Glassaa532332014-06-11 23:29:41 -0600869- I/O tracing:
870 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
871 accesses and can checksum them or write a list of them out
872 to memory. See the 'iotrace' command for details. This is
873 useful for testing device drivers since it can confirm that
874 the driver behaves the same way before and after a code
875 change. Currently this is supported on sandbox and arm. To
876 add support for your architecture, add '#include <iotrace.h>'
877 to the bottom of arch/<arch>/include/asm/io.h and test.
878
879 Example output from the 'iotrace stats' command is below.
880 Note that if the trace buffer is exhausted, the checksum will
881 still continue to operate.
882
883 iotrace is enabled
884 Start: 10000000 (buffer start address)
885 Size: 00010000 (buffer size)
886 Offset: 00000120 (current buffer offset)
887 Output: 10000120 (start + offset)
888 Count: 00000018 (number of trace records)
889 CRC32: 9526fb66 (CRC32 of all trace records)
890
wdenkc6097192002-11-03 00:24:07 +0000891- Timestamp Support:
892
wdenk43d96162003-03-06 00:02:04 +0000893 When CONFIG_TIMESTAMP is selected, the timestamp
894 (date and time) of an image is printed by image
895 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500896 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000897
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000898- Partition Labels (disklabels) Supported:
899 Zero or more of the following:
900 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000901 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
902 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
903 bootloader. Note 2TB partition limit; see
904 disk/part_efi.c
905 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000906
Simon Glassfc843a02017-05-17 03:25:30 -0600907 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -0600908 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000909 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000910
911- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000912 CONFIG_IDE_RESET_ROUTINE - this is defined in several
913 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000914
wdenk4d13cba2004-03-14 14:09:05 +0000915 CONFIG_IDE_RESET - is this is defined, IDE Reset will
916 be performed by calling the function
917 ide_set_reset(int reset)
918 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000919
920- ATAPI Support:
921 CONFIG_ATAPI
922
923 Set this to enable ATAPI support.
924
wdenkc40b2952004-03-13 23:29:43 +0000925- LBA48 Support
926 CONFIG_LBA48
927
928 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100929 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000930 Whithout these , LBA48 support uses 32bit variables and will 'only'
931 support disks up to 2.1TB.
932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200933 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000934 When enabled, makes the IDE subsystem use 64bit sector addresses.
935 Default is 32bit.
936
wdenkc6097192002-11-03 00:24:07 +0000937- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200938 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
939 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
940 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000941 maximum numbers of LUNs, SCSI ID's and target
942 devices.
wdenkc6097192002-11-03 00:24:07 +0000943
Wolfgang Denk93e14592013-10-04 17:43:24 +0200944 The environment variable 'scsidevs' is set to the number of
945 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000946
wdenkc6097192002-11-03 00:24:07 +0000947- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000948 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000949 Support for Intel 8254x/8257x gigabit chips.
950
951 CONFIG_E1000_SPI
952 Utility code for direct access to the SPI bus on Intel 8257x.
953 This does not do anything useful unless you set at least one
954 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
955
956 CONFIG_E1000_SPI_GENERIC
957 Allow generic access to the SPI bus on the Intel 8257x, for
958 example with the "sspi" command.
959
wdenkc6097192002-11-03 00:24:07 +0000960 CONFIG_EEPRO100
961 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200962 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000963 write routine for first time initialisation.
964
965 CONFIG_TULIP
966 Support for Digital 2114x chips.
967 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
968 modem chip initialisation (KS8761/QS6611).
969
970 CONFIG_NATSEMI
971 Support for National dp83815 chips.
972
973 CONFIG_NS8382X
974 Support for National dp8382[01] gigabit chips.
975
wdenk45219c42003-05-12 21:50:16 +0000976- NETWORK Support (other):
977
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100978 CONFIG_DRIVER_AT91EMAC
979 Support for AT91RM9200 EMAC.
980
981 CONFIG_RMII
982 Define this to use reduced MII inteface
983
984 CONFIG_DRIVER_AT91EMAC_QUIET
985 If this defined, the driver is quiet.
986 The driver doen't show link status messages.
987
Rob Herringefdd7312011-12-15 11:15:49 +0000988 CONFIG_CALXEDA_XGMAC
989 Support for the Calxeda XGMAC device
990
Ashok3bb46d22012-10-15 06:20:47 +0000991 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000992 Support for SMSC's LAN91C96 chips.
993
wdenk45219c42003-05-12 21:50:16 +0000994 CONFIG_LAN91C96_USE_32_BIT
995 Define this to enable 32 bit addressing
996
Ashok3bb46d22012-10-15 06:20:47 +0000997 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000998 Support for SMSC's LAN91C111 chip
999
1000 CONFIG_SMC91111_BASE
1001 Define this to hold the physical address
1002 of the device (I/O space)
1003
1004 CONFIG_SMC_USE_32_BIT
1005 Define this if data bus is 32 bits
1006
1007 CONFIG_SMC_USE_IOFUNCS
1008 Define this to use i/o functions instead of macros
1009 (some hardware wont work with macros)
1010
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001011 CONFIG_DRIVER_TI_EMAC
1012 Support for davinci emac
1013
1014 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1015 Define this if you have more then 3 PHYs.
1016
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001017 CONFIG_FTGMAC100
1018 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1019
1020 CONFIG_FTGMAC100_EGIGA
1021 Define this to use GE link update with gigabit PHY.
1022 Define this if FTGMAC100 is connected to gigabit PHY.
1023 If your system has 10/100 PHY only, it might not occur
1024 wrong behavior. Because PHY usually return timeout or
1025 useless data when polling gigabit status and gigabit
1026 control registers. This behavior won't affect the
1027 correctnessof 10/100 link speed update.
1028
Mike Rapoportc2fff332009-11-11 10:03:03 +02001029 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001030 Support for SMSC's LAN911x and LAN921x chips
1031
Mike Rapoportc2fff332009-11-11 10:03:03 +02001032 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001033 Define this to hold the physical address
1034 of the device (I/O space)
1035
Mike Rapoportc2fff332009-11-11 10:03:03 +02001036 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001037 Define this if data bus is 32 bits
1038
Mike Rapoportc2fff332009-11-11 10:03:03 +02001039 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001040 Define this if data bus is 16 bits. If your processor
1041 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001042 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001043
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001044 CONFIG_SH_ETHER
1045 Support for Renesas on-chip Ethernet controller
1046
1047 CONFIG_SH_ETHER_USE_PORT
1048 Define the number of ports to be used
1049
1050 CONFIG_SH_ETHER_PHY_ADDR
1051 Define the ETH PHY's address
1052
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001053 CONFIG_SH_ETHER_CACHE_WRITEBACK
1054 If this option is set, the driver enables cache flush.
1055
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001056- PWM Support:
1057 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001058 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001059
Vadim Bendebury5e124722011-10-17 08:36:14 +00001060- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001061 CONFIG_TPM
1062 Support TPM devices.
1063
Christophe Ricard0766ad22015-10-06 22:54:41 +02001064 CONFIG_TPM_TIS_INFINEON
1065 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001066 per system is supported at this time.
1067
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001068 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1069 Define the burst count bytes upper limit
1070
Christophe Ricard3aa74082016-01-21 23:27:13 +01001071 CONFIG_TPM_ST33ZP24
1072 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1073
1074 CONFIG_TPM_ST33ZP24_I2C
1075 Support for STMicroelectronics ST33ZP24 I2C devices.
1076 Requires TPM_ST33ZP24 and I2C.
1077
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001078 CONFIG_TPM_ST33ZP24_SPI
1079 Support for STMicroelectronics ST33ZP24 SPI devices.
1080 Requires TPM_ST33ZP24 and SPI.
1081
Dirk Eibachc01939c2013-06-26 15:55:15 +02001082 CONFIG_TPM_ATMEL_TWI
1083 Support for Atmel TWI TPM device. Requires I2C support.
1084
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001085 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001086 Support for generic parallel port TPM devices. Only one device
1087 per system is supported at this time.
1088
1089 CONFIG_TPM_TIS_BASE_ADDRESS
1090 Base address where the generic TPM device is mapped
1091 to. Contemporary x86 systems usually map it at
1092 0xfed40000.
1093
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001094 CONFIG_TPM
1095 Define this to enable the TPM support library which provides
1096 functional interfaces to some TPM commands.
1097 Requires support for a TPM device.
1098
1099 CONFIG_TPM_AUTH_SESSIONS
1100 Define this to enable authorized functions in the TPM library.
1101 Requires CONFIG_TPM and CONFIG_SHA1.
1102
wdenkc6097192002-11-03 00:24:07 +00001103- USB Support:
1104 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001105 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001106 CONFIG_USB_UHCI to enable it.
1107 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001108 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001109 storage devices.
1110 Note:
1111 Supported are USB Keyboards and USB Floppy drives
1112 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001113
Simon Glass9ab4ce22012-02-27 10:52:47 +00001114 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1115 txfilltuning field in the EHCI controller on reset.
1116
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001117 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1118 HW module registers.
1119
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001120- USB Device:
1121 Define the below if you wish to use the USB console.
1122 Once firmware is rebuilt from a serial console issue the
1123 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001124 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001125 it has found a new device. The environment variable usbtty
1126 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001127 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001128 Common Device Class Abstract Control Model serial device.
1129 If you select usbtty = gserial you should be able to enumerate
1130 a Linux host by
1131 # modprobe usbserial vendor=0xVendorID product=0xProductID
1132 else if using cdc_acm, simply setting the environment
1133 variable usbtty to be cdc_acm should suffice. The following
1134 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001135
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001136 CONFIG_USB_DEVICE
1137 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001138
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001139 CONFIG_USB_TTY
1140 Define this to have a tty type of device available to
1141 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001142
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301143 CONFIG_USBD_HS
1144 Define this to enable the high speed support for usb
1145 device and usbtty. If this feature is enabled, a routine
1146 int is_usbd_high_speed(void)
1147 also needs to be defined by the driver to dynamically poll
1148 whether the enumeration has succeded at high speed or full
1149 speed.
1150
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001151 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001152 Define this if you want stdin, stdout &/or stderr to
1153 be set to usbtty.
1154
Wolfgang Denk386eda02006-06-14 18:14:56 +02001155 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001156 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001157 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001158 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1159 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1160 should pretend to be a Linux device to it's target host.
1161
1162 CONFIG_USBD_MANUFACTURER
1163 Define this string as the name of your company for
1164 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001165
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001166 CONFIG_USBD_PRODUCT_NAME
1167 Define this string as the name of your product
1168 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1169
1170 CONFIG_USBD_VENDORID
1171 Define this as your assigned Vendor ID from the USB
1172 Implementors Forum. This *must* be a genuine Vendor ID
1173 to avoid polluting the USB namespace.
1174 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001175
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001176 CONFIG_USBD_PRODUCTID
1177 Define this as the unique Product ID
1178 for your device
1179 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001180
Igor Grinbergd70a5602011-12-12 12:08:35 +02001181- ULPI Layer Support:
1182 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1183 the generic ULPI layer. The generic layer accesses the ULPI PHY
1184 via the platform viewport, so you need both the genric layer and
1185 the viewport enabled. Currently only Chipidea/ARC based
1186 viewport is supported.
1187 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1188 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001189 If your ULPI phy needs a different reference clock than the
1190 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1191 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001192
1193- MMC Support:
1194 The MMC controller on the Intel PXA is supported. To
1195 enable this define CONFIG_MMC. The MMC can be
1196 accessed from the boot prompt by mapping the device
1197 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001198 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1199 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001200
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001201 CONFIG_SH_MMCIF
1202 Support for Renesas on-chip MMCIF controller
1203
1204 CONFIG_SH_MMCIF_ADDR
1205 Define the base address of MMCIF registers
1206
1207 CONFIG_SH_MMCIF_CLK
1208 Define the clock frequency for MMCIF
1209
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001210 CONFIG_SUPPORT_EMMC_BOOT
1211 Enable some additional features of the eMMC boot partitions.
1212
1213 CONFIG_SUPPORT_EMMC_RPMB
1214 Enable the commands for reading, writing and programming the
1215 key for the Replay Protection Memory Block partition in eMMC.
1216
Tom Rinib3ba6e92013-03-14 05:32:47 +00001217- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001218 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001219 This enables the USB portion of the DFU USB class
1220
Tom Rinib3ba6e92013-03-14 05:32:47 +00001221 CONFIG_DFU_MMC
1222 This enables support for exposing (e)MMC devices via DFU.
1223
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001224 CONFIG_DFU_NAND
1225 This enables support for exposing NAND devices via DFU.
1226
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301227 CONFIG_DFU_RAM
1228 This enables support for exposing RAM via DFU.
1229 Note: DFU spec refer to non-volatile memory usage, but
1230 allow usages beyond the scope of spec - here RAM usage,
1231 one that would help mostly the developer.
1232
Heiko Schochere7e75c72013-06-12 06:05:51 +02001233 CONFIG_SYS_DFU_DATA_BUF_SIZE
1234 Dfu transfer uses a buffer before writing data to the
1235 raw storage device. Make the size (in bytes) of this buffer
1236 configurable. The size of this buffer is also configurable
1237 through the "dfu_bufsiz" environment variable.
1238
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001239 CONFIG_SYS_DFU_MAX_FILE_SIZE
1240 When updating files rather than the raw storage device,
1241 we use a static buffer to copy the file into and then write
1242 the buffer once we've been given the whole file. Define
1243 this to the maximum filesize (in bytes) for the buffer.
1244 Default is 4 MiB if undefined.
1245
Heiko Schocher001a8312014-03-18 08:09:56 +01001246 DFU_DEFAULT_POLL_TIMEOUT
1247 Poll timeout [ms], is the timeout a device can send to the
1248 host. The host must wait for this timeout before sending
1249 a subsequent DFU_GET_STATUS request to the device.
1250
1251 DFU_MANIFEST_POLL_TIMEOUT
1252 Poll timeout [ms], which the device sends to the host when
1253 entering dfuMANIFEST state. Host waits this timeout, before
1254 sending again an USB request to the device.
1255
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001256- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001257 CONFIG_USB_FUNCTION_FASTBOOT
1258 This enables the USB part of the fastboot gadget
1259
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001260 CONFIG_ANDROID_BOOT_IMAGE
1261 This enables support for booting images which use the Android
1262 image format header.
1263
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001264 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001265 The fastboot protocol requires a large memory buffer for
1266 downloads. Define this to the starting RAM address to use for
1267 downloaded images.
1268
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001269 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001270 The fastboot protocol requires a large memory buffer for
1271 downloads. This buffer should be as large as possible for a
1272 platform. Define this to the size available RAM for fastboot.
1273
Steve Raed1b5ed02014-08-26 11:47:28 -07001274 CONFIG_FASTBOOT_FLASH
1275 The fastboot protocol includes a "flash" command for writing
1276 the downloaded image to a non-volatile storage device. Define
1277 this to enable the "fastboot flash" command.
1278
1279 CONFIG_FASTBOOT_FLASH_MMC_DEV
1280 The fastboot "flash" command requires additional information
1281 regarding the non-volatile storage device. Define this to
1282 the eMMC device that fastboot should use to store the image.
1283
Steve Rae0ff7e582014-12-12 15:51:54 -08001284 CONFIG_FASTBOOT_GPT_NAME
1285 The fastboot "flash" command supports writing the downloaded
1286 image to the Protective MBR and the Primary GUID Partition
1287 Table. (Additionally, this downloaded image is post-processed
1288 to generate and write the Backup GUID Partition Table.)
1289 This occurs when the specified "partition name" on the
1290 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001291 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001292
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001293 CONFIG_FASTBOOT_MBR_NAME
1294 The fastboot "flash" command supports writing the downloaded
1295 image to DOS MBR.
1296 This occurs when the "partition name" specified on the
1297 "fastboot flash" command line matches this value.
1298 If not defined the default value "mbr" is used.
1299
wdenk6705d812004-08-02 23:22:59 +00001300- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001301 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001302 Define these for a default partition on a NAND device
1303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001304 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1305 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001306 Define these for a default partition on a NOR device
1307
wdenkc6097192002-11-03 00:24:07 +00001308- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001309 See Kconfig help for available keyboard drivers.
1310
1311 CONFIG_KEYBOARD
1312
1313 Define this to enable a custom keyboard support.
1314 This simply calls drv_keyboard_init() which must be
1315 defined in your board-specific files. This option is deprecated
1316 and is only used by novena. For new boards, use driver model
1317 instead.
wdenkc6097192002-11-03 00:24:07 +00001318
1319- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001320 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001321 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001322 SOCs that have a DIU should define this macro to enable DIU
1323 support, and should also define these other macros:
1324
1325 CONFIG_SYS_DIU_ADDR
1326 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001327 CONFIG_CFB_CONSOLE
1328 CONFIG_VIDEO_SW_CURSOR
1329 CONFIG_VGA_AS_SINGLE_DEVICE
1330 CONFIG_VIDEO_LOGO
1331 CONFIG_VIDEO_BMP_LOGO
1332
Timur Tabiba8e76b2011-04-11 14:18:22 -05001333 The DIU driver will look for the 'video-mode' environment
1334 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001335 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001336 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001337
wdenkc6097192002-11-03 00:24:07 +00001338- LCD Support: CONFIG_LCD
1339
1340 Define this to enable LCD support (for output to LCD
1341 display); also select one of the supported displays
1342 by defining one of these:
1343
Stelian Pop39cf4802008-05-09 21:57:18 +02001344 CONFIG_ATMEL_LCD:
1345
1346 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1347
wdenkfd3103b2003-11-25 16:55:19 +00001348 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001349
wdenkfd3103b2003-11-25 16:55:19 +00001350 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001351
wdenkfd3103b2003-11-25 16:55:19 +00001352 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001353
wdenkfd3103b2003-11-25 16:55:19 +00001354 NEC NL6448BC20-08. 6.5", 640x480.
1355 Active, color, single scan.
1356
1357 CONFIG_NEC_NL6448BC33_54
1358
1359 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001360 Active, color, single scan.
1361
1362 CONFIG_SHARP_16x9
1363
1364 Sharp 320x240. Active, color, single scan.
1365 It isn't 16x9, and I am not sure what it is.
1366
1367 CONFIG_SHARP_LQ64D341
1368
1369 Sharp LQ64D341 display, 640x480.
1370 Active, color, single scan.
1371
1372 CONFIG_HLD1045
1373
1374 HLD1045 display, 640x480.
1375 Active, color, single scan.
1376
1377 CONFIG_OPTREX_BW
1378
1379 Optrex CBL50840-2 NF-FW 99 22 M5
1380 or
1381 Hitachi LMG6912RPFC-00T
1382 or
1383 Hitachi SP14Q002
1384
1385 320x240. Black & white.
1386
Simon Glass676d3192012-10-17 13:24:54 +00001387 CONFIG_LCD_ALIGNMENT
1388
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001389 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001390 defined then the LCD will be aligned to this value instead.
1391 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1392 here, since it is cheaper to change data cache settings on
1393 a per-section basis.
1394
1395
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001396 CONFIG_LCD_ROTATION
1397
1398 Sometimes, for example if the display is mounted in portrait
1399 mode or even if it's mounted landscape but rotated by 180degree,
1400 we need to rotate our content of the display relative to the
1401 framebuffer, so that user can read the messages which are
1402 printed out.
1403 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1404 initialized with a given rotation from "vl_rot" out of
1405 "vidinfo_t" which is provided by the board specific code.
1406 The value for vl_rot is coded as following (matching to
1407 fbcon=rotate:<n> linux-kernel commandline):
1408 0 = no rotation respectively 0 degree
1409 1 = 90 degree rotation
1410 2 = 180 degree rotation
1411 3 = 270 degree rotation
1412
1413 If CONFIG_LCD_ROTATION is not defined, the console will be
1414 initialized with 0degree rotation.
1415
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001416 CONFIG_LCD_BMP_RLE8
1417
1418 Support drawing of RLE8-compressed bitmaps on the LCD.
1419
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001420 CONFIG_I2C_EDID
1421
1422 Enables an 'i2c edid' command which can read EDID
1423 information over I2C from an attached LCD display.
1424
wdenk7152b1d2003-09-05 23:19:14 +00001425- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001426
wdenk8bde7f72003-06-27 21:31:46 +00001427 If this option is set, the environment is checked for
1428 a variable "splashimage". If found, the usual display
1429 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001430 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001431 specified in "splashimage" is loaded instead. The
1432 console is redirected to the "nulldev", too. This
1433 allows for a "silent" boot where a splash screen is
1434 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001435
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001436 CONFIG_SPLASHIMAGE_GUARD
1437
1438 If this option is set, then U-Boot will prevent the environment
1439 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001440 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001441 This option is useful for targets where, due to alignment
1442 restrictions, an improperly aligned BMP image will cause a data
1443 abort. If you think you will not have problems with unaligned
1444 accesses (for example because your toolchain prevents them)
1445 there is no need to set this option.
1446
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001447 CONFIG_SPLASH_SCREEN_ALIGN
1448
1449 If this option is set the splash image can be freely positioned
1450 on the screen. Environment variable "splashpos" specifies the
1451 position as "x,y". If a positive number is given it is used as
1452 number of pixel from left/top. If a negative number is given it
1453 is used as number of pixel from right/bottom. You can also
1454 specify 'm' for centering the image.
1455
1456 Example:
1457 setenv splashpos m,m
1458 => image at center of screen
1459
1460 setenv splashpos 30,20
1461 => image at x = 30 and y = 20
1462
1463 setenv splashpos -10,m
1464 => vertically centered image
1465 at x = dspWidth - bmpWidth - 9
1466
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001467- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1468
1469 If this option is set, additionally to standard BMP
1470 images, gzipped BMP images can be displayed via the
1471 splashscreen support or the bmp command.
1472
Anatolij Gustschind5011762010-03-15 14:50:25 +01001473- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1474
1475 If this option is set, 8-bit RLE compressed BMP images
1476 can be displayed via the splashscreen support or the
1477 bmp command.
1478
wdenkc29fdfc2003-08-29 20:57:53 +00001479- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001480 CONFIG_GZIP
1481
1482 Enabled by default to support gzip compressed images.
1483
wdenkc29fdfc2003-08-29 20:57:53 +00001484 CONFIG_BZIP2
1485
1486 If this option is set, support for bzip2 compressed
1487 images is included. If not, only uncompressed and gzip
1488 compressed images are supported.
1489
wdenk42d1f032003-10-15 23:53:47 +00001490 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001491 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001492 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001493
wdenk17ea1172004-06-06 21:51:03 +00001494- MII/PHY support:
1495 CONFIG_PHY_ADDR
1496
1497 The address of PHY on MII bus.
1498
1499 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1500
1501 The clock frequency of the MII bus
1502
wdenk17ea1172004-06-06 21:51:03 +00001503 CONFIG_PHY_RESET_DELAY
1504
1505 Some PHY like Intel LXT971A need extra delay after
1506 reset before any MII register access is possible.
1507 For such PHY, set this option to the usec delay
1508 required. (minimum 300usec for LXT971A)
1509
1510 CONFIG_PHY_CMD_DELAY (ppc4xx)
1511
1512 Some PHY like Intel LXT971A need extra delay after
1513 command issued before MII status register can be read
1514
wdenkc6097192002-11-03 00:24:07 +00001515- IP address:
1516 CONFIG_IPADDR
1517
1518 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001519 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001520 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001521 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001522
1523- Server IP address:
1524 CONFIG_SERVERIP
1525
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001526 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001527 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001528 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001529
Robin Getz97cfe862009-07-21 12:15:28 -04001530 CONFIG_KEEP_SERVERADDR
1531
1532 Keeps the server's MAC address, in the env 'serveraddr'
1533 for passing to bootargs (like Linux's netconsole option)
1534
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001535- Gateway IP address:
1536 CONFIG_GATEWAYIP
1537
1538 Defines a default value for the IP address of the
1539 default router where packets to other networks are
1540 sent to.
1541 (Environment variable "gatewayip")
1542
1543- Subnet mask:
1544 CONFIG_NETMASK
1545
1546 Defines a default value for the subnet mask (or
1547 routing prefix) which is used to determine if an IP
1548 address belongs to the local subnet or needs to be
1549 forwarded through a router.
1550 (Environment variable "netmask")
1551
David Updegraff53a5c422007-06-11 10:41:07 -05001552- Multicast TFTP Mode:
1553 CONFIG_MCAST_TFTP
1554
1555 Defines whether you want to support multicast TFTP as per
1556 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001557 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001558 driver in use must provide a function: mcast() to join/leave a
1559 multicast group.
1560
wdenkc6097192002-11-03 00:24:07 +00001561- BOOTP Recovery Mode:
1562 CONFIG_BOOTP_RANDOM_DELAY
1563
1564 If you have many targets in a network that try to
1565 boot using BOOTP, you may want to avoid that all
1566 systems send out BOOTP requests at precisely the same
1567 moment (which would happen for instance at recovery
1568 from a power failure, when all systems will try to
1569 boot, thus flooding the BOOTP server. Defining
1570 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1571 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001572 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001573
1574 1st BOOTP request: delay 0 ... 1 sec
1575 2nd BOOTP request: delay 0 ... 2 sec
1576 3rd BOOTP request: delay 0 ... 4 sec
1577 4th and following
1578 BOOTP requests: delay 0 ... 8 sec
1579
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001580 CONFIG_BOOTP_ID_CACHE_SIZE
1581
1582 BOOTP packets are uniquely identified using a 32-bit ID. The
1583 server will copy the ID from client requests to responses and
1584 U-Boot will use this to determine if it is the destination of
1585 an incoming response. Some servers will check that addresses
1586 aren't in use before handing them out (usually using an ARP
1587 ping) and therefore take up to a few hundred milliseconds to
1588 respond. Network congestion may also influence the time it
1589 takes for a response to make it back to the client. If that
1590 time is too long, U-Boot will retransmit requests. In order
1591 to allow earlier responses to still be accepted after these
1592 retransmissions, U-Boot's BOOTP client keeps a small cache of
1593 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1594 cache. The default is to keep IDs for up to four outstanding
1595 requests. Increasing this will allow U-Boot to accept offers
1596 from a BOOTP client in networks with unusually high latency.
1597
stroesefe389a82003-08-28 14:17:32 +00001598- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001599 You can fine tune the DHCP functionality by defining
1600 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001601
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001602 CONFIG_BOOTP_SUBNETMASK
1603 CONFIG_BOOTP_GATEWAY
1604 CONFIG_BOOTP_HOSTNAME
1605 CONFIG_BOOTP_NISDOMAIN
1606 CONFIG_BOOTP_BOOTPATH
1607 CONFIG_BOOTP_BOOTFILESIZE
1608 CONFIG_BOOTP_DNS
1609 CONFIG_BOOTP_DNS2
1610 CONFIG_BOOTP_SEND_HOSTNAME
1611 CONFIG_BOOTP_NTPSERVER
1612 CONFIG_BOOTP_TIMEOFFSET
1613 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001614 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001615
Wilson Callan5d110f02007-07-28 10:56:13 -04001616 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1617 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001618
Joe Hershberger2c00e092012-05-23 07:59:19 +00001619 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1620 after the configured retry count, the call will fail
1621 instead of starting over. This can be used to fail over
1622 to Link-local IP address configuration if the DHCP server
1623 is not available.
1624
stroesefe389a82003-08-28 14:17:32 +00001625 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1626 serverip from a DHCP server, it is possible that more
1627 than one DNS serverip is offered to the client.
1628 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1629 serverip will be stored in the additional environment
1630 variable "dnsip2". The first DNS serverip is always
1631 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001632 is defined.
stroesefe389a82003-08-28 14:17:32 +00001633
1634 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1635 to do a dynamic update of a DNS server. To do this, they
1636 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001637 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001638 of the "hostname" environment variable is passed as
1639 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001640
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001641 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1642
1643 A 32bit value in microseconds for a delay between
1644 receiving a "DHCP Offer" and sending the "DHCP Request".
1645 This fixes a problem with certain DHCP servers that don't
1646 respond 100% of the time to a "DHCP request". E.g. On an
1647 AT91RM9200 processor running at 180MHz, this delay needed
1648 to be *at least* 15,000 usec before a Windows Server 2003
1649 DHCP server would reply 100% of the time. I recommend at
1650 least 50,000 usec to be safe. The alternative is to hope
1651 that one of the retries will be successful but note that
1652 the DHCP timeout and retry process takes a longer than
1653 this delay.
1654
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001655 - Link-local IP address negotiation:
1656 Negotiate with other link-local clients on the local network
1657 for an address that doesn't require explicit configuration.
1658 This is especially useful if a DHCP server cannot be guaranteed
1659 to exist in all environments that the device must operate.
1660
1661 See doc/README.link-local for more information.
1662
wdenka3d991b2004-04-15 21:48:45 +00001663 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001664 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001665
1666 The device id used in CDP trigger frames.
1667
1668 CONFIG_CDP_DEVICE_ID_PREFIX
1669
1670 A two character string which is prefixed to the MAC address
1671 of the device.
1672
1673 CONFIG_CDP_PORT_ID
1674
1675 A printf format string which contains the ascii name of
1676 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001677 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001678
1679 CONFIG_CDP_CAPABILITIES
1680
1681 A 32bit integer which indicates the device capabilities;
1682 0x00000010 for a normal host which does not forwards.
1683
1684 CONFIG_CDP_VERSION
1685
1686 An ascii string containing the version of the software.
1687
1688 CONFIG_CDP_PLATFORM
1689
1690 An ascii string containing the name of the platform.
1691
1692 CONFIG_CDP_TRIGGER
1693
1694 A 32bit integer sent on the trigger.
1695
1696 CONFIG_CDP_POWER_CONSUMPTION
1697
1698 A 16bit integer containing the power consumption of the
1699 device in .1 of milliwatts.
1700
1701 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1702
1703 A byte containing the id of the VLAN.
1704
Uri Mashiach79267ed2017-01-19 10:51:05 +02001705- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001706
1707 Several configurations allow to display the current
1708 status using a LED. For instance, the LED will blink
1709 fast while running U-Boot code, stop blinking as
1710 soon as a reply to a BOOTP request was received, and
1711 start blinking slow once the Linux kernel is running
1712 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001713 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001714 feature in U-Boot.
1715
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001716 Additional options:
1717
Uri Mashiach79267ed2017-01-19 10:51:05 +02001718 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001719 The status LED can be connected to a GPIO pin.
1720 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001721 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001722 to include the gpio_led driver in the U-Boot binary.
1723
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001724 CONFIG_GPIO_LED_INVERTED_TABLE
1725 Some GPIO connected LEDs may have inverted polarity in which
1726 case the GPIO high value corresponds to LED off state and
1727 GPIO low value corresponds to LED on state.
1728 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1729 with a list of GPIO LEDs that have inverted polarity.
1730
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001731- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001732
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001733 This enable the NEW i2c subsystem, and will allow you to use
1734 i2c commands at the u-boot command line (as long as you set
1735 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1736 based realtime clock chips or other i2c devices. See
1737 common/cmd_i2c.c for a description of the command line
1738 interface.
1739
1740 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001741 - drivers/i2c/soft_i2c.c:
1742 - activate first bus with CONFIG_SYS_I2C_SOFT define
1743 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1744 for defining speed and slave address
1745 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1746 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1747 for defining speed and slave address
1748 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1749 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1750 for defining speed and slave address
1751 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1752 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1753 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001754
Heiko Schocher00f792e2012-10-24 13:48:22 +02001755 - drivers/i2c/fsl_i2c.c:
1756 - activate i2c driver with CONFIG_SYS_I2C_FSL
1757 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1758 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1759 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1760 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001761 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001762 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1763 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1764 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1765 second bus.
1766
Simon Glass1f2ba722012-10-30 07:28:53 +00001767 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001768 - activate this driver with CONFIG_SYS_I2C_TEGRA
1769 - This driver adds 4 i2c buses with a fix speed from
1770 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001771
Dirk Eibach880540d2013-04-25 02:40:01 +00001772 - drivers/i2c/ppc4xx_i2c.c
1773 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1774 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1775 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1776
tremfac96402013-09-21 18:13:35 +02001777 - drivers/i2c/i2c_mxc.c
1778 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001779 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1780 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1781 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1782 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001783 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1784 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1785 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1786 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1787 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1788 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001789 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1790 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001791 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001792 for speed, and 0 for slave.
1793
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001794 - drivers/i2c/rcar_i2c.c:
1795 - activate this driver with CONFIG_SYS_I2C_RCAR
1796 - This driver adds 4 i2c buses
1797
1798 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1799 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1800 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1801 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1802 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1803 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1804 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1805 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1806 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1807
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001808 - drivers/i2c/sh_i2c.c:
1809 - activate this driver with CONFIG_SYS_I2C_SH
1810 - This driver adds from 2 to 5 i2c buses
1811
1812 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1813 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1814 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1815 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1816 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1817 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1818 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1819 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1820 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1821 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001822 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001823
Heiko Schocher6789e842013-10-22 11:03:18 +02001824 - drivers/i2c/omap24xx_i2c.c
1825 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1826 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1827 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1828 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1829 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1830 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1831 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1832 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1833 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1834 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1835 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1836
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001837 - drivers/i2c/zynq_i2c.c
1838 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1839 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1840 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1841
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301842 - drivers/i2c/s3c24x0_i2c.c:
1843 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1844 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1845 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1846 with a fix speed from 100000 and the slave addr 0!
1847
Dirk Eibachb46226b2014-07-03 09:28:18 +02001848 - drivers/i2c/ihs_i2c.c
1849 - activate this driver with CONFIG_SYS_I2C_IHS
1850 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1851 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1852 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1853 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1854 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1855 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1856 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1857 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1858 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1859 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1860 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1861 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001862 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1863 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1864 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1865 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1866 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1867 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1868 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1869 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1870 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001871
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001872 additional defines:
1873
1874 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001875 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001876
1877 CONFIG_SYS_I2C_DIRECT_BUS
1878 define this, if you don't use i2c muxes on your hardware.
1879 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1880 omit this define.
1881
1882 CONFIG_SYS_I2C_MAX_HOPS
1883 define how many muxes are maximal consecutively connected
1884 on one i2c bus. If you not use i2c muxes, omit this
1885 define.
1886
1887 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001888 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001889 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1890 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1891 CONFIG_SYS_NUM_I2C_BUSES = 9:
1892
1893 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1894 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1895 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1896 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1897 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1898 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1899 {1, {I2C_NULL_HOP}}, \
1900 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1901 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1902 }
1903
1904 which defines
1905 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001906 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1907 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1908 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1909 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1910 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001911 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001912 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1913 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001914
1915 If you do not have i2c muxes on your board, omit this define.
1916
Simon Glassce3b5d62017-05-12 21:10:00 -06001917- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001918 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001919 then the following macros need to be defined (examples are
1920 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001921
1922 I2C_INIT
1923
wdenkb37c7e52003-06-30 16:24:52 +00001924 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001925 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001926
wdenkba56f622004-02-06 23:19:44 +00001927 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001928
wdenkc6097192002-11-03 00:24:07 +00001929 I2C_ACTIVE
1930
1931 The code necessary to make the I2C data line active
1932 (driven). If the data line is open collector, this
1933 define can be null.
1934
wdenkb37c7e52003-06-30 16:24:52 +00001935 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1936
wdenkc6097192002-11-03 00:24:07 +00001937 I2C_TRISTATE
1938
1939 The code necessary to make the I2C data line tri-stated
1940 (inactive). If the data line is open collector, this
1941 define can be null.
1942
wdenkb37c7e52003-06-30 16:24:52 +00001943 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1944
wdenkc6097192002-11-03 00:24:07 +00001945 I2C_READ
1946
York Sun472d5462013-04-01 11:29:11 -07001947 Code that returns true if the I2C data line is high,
1948 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001949
wdenkb37c7e52003-06-30 16:24:52 +00001950 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1951
wdenkc6097192002-11-03 00:24:07 +00001952 I2C_SDA(bit)
1953
York Sun472d5462013-04-01 11:29:11 -07001954 If <bit> is true, sets the I2C data line high. If it
1955 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001956
wdenkb37c7e52003-06-30 16:24:52 +00001957 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001958 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001959 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001960
wdenkc6097192002-11-03 00:24:07 +00001961 I2C_SCL(bit)
1962
York Sun472d5462013-04-01 11:29:11 -07001963 If <bit> is true, sets the I2C clock line high. If it
1964 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001965
wdenkb37c7e52003-06-30 16:24:52 +00001966 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001967 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001968 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001969
wdenkc6097192002-11-03 00:24:07 +00001970 I2C_DELAY
1971
1972 This delay is invoked four times per clock cycle so this
1973 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001974 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001975 like:
1976
wdenkb37c7e52003-06-30 16:24:52 +00001977 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001978
Mike Frysinger793b5722010-07-21 13:38:02 -04001979 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1980
1981 If your arch supports the generic GPIO framework (asm/gpio.h),
1982 then you may alternatively define the two GPIOs that are to be
1983 used as SCL / SDA. Any of the previous I2C_xxx macros will
1984 have GPIO-based defaults assigned to them as appropriate.
1985
1986 You should define these to the GPIO value as given directly to
1987 the generic GPIO functions.
1988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001989 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001990
wdenk8bde7f72003-06-27 21:31:46 +00001991 When a board is reset during an i2c bus transfer
1992 chips might think that the current transfer is still
1993 in progress. On some boards it is possible to access
1994 the i2c SCLK line directly, either by using the
1995 processor pin as a GPIO or by having a second pin
1996 connected to the bus. If this option is defined a
1997 custom i2c_init_board() routine in boards/xxx/board.c
1998 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001999
Ben Warrenbb99ad62006-09-07 16:50:54 -04002000 CONFIG_I2C_MULTI_BUS
2001
2002 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002003 must have a controller. At any point in time, only one bus is
2004 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002005 Note that bus numbering is zero-based.
2006
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002007 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002008
2009 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002010 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002011 is set, specify a list of bus-device pairs. Otherwise, specify
2012 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002013
2014 e.g.
2015 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002016 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002017
2018 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2019
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002020 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002021 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002022
2023 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002025 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002026
2027 If defined, then this indicates the I2C bus number for DDR SPD.
2028 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002030 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002031
2032 If defined, then this indicates the I2C bus number for the RTC.
2033 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2034
Andrew Dyer2ac69852008-12-29 17:36:01 -06002035 CONFIG_SOFT_I2C_READ_REPEATED_START
2036
2037 defining this will force the i2c_read() function in
2038 the soft_i2c driver to perform an I2C repeated start
2039 between writing the address pointer and reading the
2040 data. If this define is omitted the default behaviour
2041 of doing a stop-start sequence will be used. Most I2C
2042 devices can use either method, but some require one or
2043 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002044
wdenkc6097192002-11-03 00:24:07 +00002045- SPI Support: CONFIG_SPI
2046
2047 Enables SPI driver (so far only tested with
2048 SPI EEPROM, also an instance works with Crystal A/D and
2049 D/As on the SACSng board)
2050
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002051 CONFIG_SH_SPI
2052
2053 Enables the driver for SPI controller on SuperH. Currently
2054 only SH7757 is supported.
2055
wdenkc6097192002-11-03 00:24:07 +00002056 CONFIG_SOFT_SPI
2057
wdenk43d96162003-03-06 00:02:04 +00002058 Enables a software (bit-bang) SPI driver rather than
2059 using hardware support. This is a general purpose
2060 driver that only requires three general I/O port pins
2061 (two outputs, one input) to function. If this is
2062 defined, the board configuration must define several
2063 SPI configuration items (port pins to use, etc). For
2064 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002065
Ben Warren04a9e112008-01-16 22:37:35 -05002066 CONFIG_HARD_SPI
2067
2068 Enables a hardware SPI driver for general-purpose reads
2069 and writes. As with CONFIG_SOFT_SPI, the board configuration
2070 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002071 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002072 example, see include/configs/mpc8349emds.h.
2073
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002074 CONFIG_MXC_SPI
2075
2076 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002077 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002078
Heiko Schocherf659b572014-07-14 10:22:11 +02002079 CONFIG_SYS_SPI_MXC_WAIT
2080 Timeout for waiting until spi transfer completed.
2081 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2082
Matthias Fuchs01335022007-12-27 17:12:34 +01002083- FPGA Support: CONFIG_FPGA
2084
2085 Enables FPGA subsystem.
2086
2087 CONFIG_FPGA_<vendor>
2088
2089 Enables support for specific chip vendors.
2090 (ALTERA, XILINX)
2091
2092 CONFIG_FPGA_<family>
2093
2094 Enables support for FPGA family.
2095 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2096
2097 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002098
wdenk43d96162003-03-06 00:02:04 +00002099 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002101 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002102
wdenk8bde7f72003-06-27 21:31:46 +00002103 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002104
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002105 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002106
wdenk43d96162003-03-06 00:02:04 +00002107 Enable checks on FPGA configuration interface busy
2108 status by the configuration function. This option
2109 will require a board or device specific function to
2110 be written.
wdenkc6097192002-11-03 00:24:07 +00002111
2112 CONFIG_FPGA_DELAY
2113
2114 If defined, a function that provides delays in the FPGA
2115 configuration driver.
2116
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002117 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002118 Allow Control-C to interrupt FPGA configuration
2119
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002120 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002121
wdenk43d96162003-03-06 00:02:04 +00002122 Check for configuration errors during FPGA bitfile
2123 loading. For example, abort during Virtex II
2124 configuration if the INIT_B line goes low (which
2125 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002127 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002128
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002129 Maximum time to wait for the INIT_B line to de-assert
2130 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002131 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002132 ms.
wdenkc6097192002-11-03 00:24:07 +00002133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002134 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002135
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002136 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002137 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002139 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002140
wdenk43d96162003-03-06 00:02:04 +00002141 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002142 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002143
2144- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002145 CONFIG_BUILD_TARGET
2146
2147 Some SoCs need special image types (e.g. U-Boot binary
2148 with a special header) as build targets. By defining
2149 CONFIG_BUILD_TARGET in the SoC / board header, this
2150 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002151 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002152
wdenkc6097192002-11-03 00:24:07 +00002153 CONFIG_IDENT_STRING
2154
wdenk43d96162003-03-06 00:02:04 +00002155 If defined, this string will be added to the U-Boot
2156 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002157
2158- Vendor Parameter Protection:
2159
wdenk43d96162003-03-06 00:02:04 +00002160 U-Boot considers the values of the environment
2161 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002162 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002163 are set once by the board vendor / manufacturer, and
2164 protects these variables from casual modification by
2165 the user. Once set, these variables are read-only,
2166 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002167 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002168
2169 If CONFIG_ENV_OVERWRITE is #defined in your config
2170 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002171 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002172 these parameters.
2173
Joe Hershberger92ac5202015-05-04 14:55:14 -05002174 Alternatively, if you define _both_ an ethaddr in the
2175 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002176 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002177 which can be changed exactly ONCE by the user. [The
2178 serial# is unaffected by this, i. e. it remains
2179 read-only.]
2180
Joe Hershberger25980902012-12-11 22:16:31 -06002181 The same can be accomplished in a more flexible way
2182 for any variable by configuring the type of access
2183 to allow for those variables in the ".flags" variable
2184 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2185
wdenkc6097192002-11-03 00:24:07 +00002186- Protected RAM:
2187 CONFIG_PRAM
2188
2189 Define this variable to enable the reservation of
2190 "protected RAM", i. e. RAM which is not overwritten
2191 by U-Boot. Define CONFIG_PRAM to hold the number of
2192 kB you want to reserve for pRAM. You can overwrite
2193 this default value by defining an environment
2194 variable "pram" to the number of kB you want to
2195 reserve. Note that the board info structure will
2196 still show the full amount of RAM. If pRAM is
2197 reserved, a new environment variable "mem" will
2198 automatically be defined to hold the amount of
2199 remaining RAM in a form that can be passed as boot
2200 argument to Linux, for instance like that:
2201
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002202 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002203 saveenv
2204
2205 This way you can tell Linux not to use this memory,
2206 either, which results in a memory region that will
2207 not be affected by reboots.
2208
2209 *WARNING* If your board configuration uses automatic
2210 detection of the RAM size, you must make sure that
2211 this memory test is non-destructive. So far, the
2212 following board configurations are known to be
2213 "pRAM-clean":
2214
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002215 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002216 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002217 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002218
Gabe Black40fef042012-12-02 04:55:18 +00002219- Access to physical memory region (> 4GB)
2220 Some basic support is provided for operations on memory not
2221 normally accessible to U-Boot - e.g. some architectures
2222 support access to more than 4GB of memory on 32-bit
2223 machines using physical address extension or similar.
2224 Define CONFIG_PHYSMEM to access this basic support, which
2225 currently only supports clearing the memory.
2226
wdenkc6097192002-11-03 00:24:07 +00002227- Error Recovery:
2228 CONFIG_PANIC_HANG
2229
2230 Define this variable to stop the system in case of a
2231 fatal error, so that you have to reset it manually.
2232 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002233 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002234 automatically as fast as possible, but it may be
2235 useful during development since you can try to debug
2236 the conditions that lead to the situation.
2237
2238 CONFIG_NET_RETRY_COUNT
2239
wdenk43d96162003-03-06 00:02:04 +00002240 This variable defines the number of retries for
2241 network operations like ARP, RARP, TFTP, or BOOTP
2242 before giving up the operation. If not defined, a
2243 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002244
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002245 CONFIG_ARP_TIMEOUT
2246
2247 Timeout waiting for an ARP reply in milliseconds.
2248
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002249 CONFIG_NFS_TIMEOUT
2250
2251 Timeout in milliseconds used in NFS protocol.
2252 If you encounter "ERROR: Cannot umount" in nfs command,
2253 try longer timeout such as
2254 #define CONFIG_NFS_TIMEOUT 10000UL
2255
wdenkc6097192002-11-03 00:24:07 +00002256- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002257 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002258
2259 Enable auto completion of commands using TAB.
2260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002261 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002262
2263 This defines the secondary prompt string, which is
2264 printed when the command interpreter needs more input
2265 to complete a command. Usually "> ".
2266
2267 Note:
2268
wdenk8bde7f72003-06-27 21:31:46 +00002269 In the current implementation, the local variables
2270 space and global environment variables space are
2271 separated. Local variables are those you define by
2272 simply typing `name=value'. To access a local
2273 variable later on, you have write `$name' or
2274 `${name}'; to execute the contents of a variable
2275 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002276
wdenk43d96162003-03-06 00:02:04 +00002277 Global environment variables are those you use
2278 setenv/printenv to work with. To run a command stored
2279 in such a variable, you need to use the run command,
2280 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002281
2282 To store commands and special characters in a
2283 variable, please use double quotation marks
2284 surrounding the whole text of the variable, instead
2285 of the backslashes before semicolons and special
2286 symbols.
2287
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002288- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002289 CONFIG_CMDLINE_EDITING
2290
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002291 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002292 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002293
Marek Vasutf3b267b2016-01-27 04:47:55 +01002294- Command Line PS1/PS2 support:
2295 CONFIG_CMDLINE_PS_SUPPORT
2296
2297 Enable support for changing the command prompt string
2298 at run-time. Only static string is supported so far.
2299 The string is obtained from environment variables PS1
2300 and PS2.
2301
wdenka8c7c702003-12-06 19:49:23 +00002302- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002303 CONFIG_EXTRA_ENV_SETTINGS
2304
wdenk43d96162003-03-06 00:02:04 +00002305 Define this to contain any number of null terminated
2306 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002307 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002308
wdenk43d96162003-03-06 00:02:04 +00002309 For example, place something like this in your
2310 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002311
2312 #define CONFIG_EXTRA_ENV_SETTINGS \
2313 "myvar1=value1\0" \
2314 "myvar2=value2\0"
2315
wdenk43d96162003-03-06 00:02:04 +00002316 Warning: This method is based on knowledge about the
2317 internal format how the environment is stored by the
2318 U-Boot code. This is NOT an official, exported
2319 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002320 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002321 You better know what you are doing here.
2322
wdenk43d96162003-03-06 00:02:04 +00002323 Note: overly (ab)use of the default environment is
2324 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002325 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002326 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002327
Stephen Warren5e724ca2012-05-22 09:21:54 +00002328 CONFIG_ENV_VARS_UBOOT_CONFIG
2329
2330 Define this in order to add variables describing the
2331 U-Boot build configuration to the default environment.
2332 These will be named arch, cpu, board, vendor, and soc.
2333
2334 Enabling this option will cause the following to be defined:
2335
2336 - CONFIG_SYS_ARCH
2337 - CONFIG_SYS_CPU
2338 - CONFIG_SYS_BOARD
2339 - CONFIG_SYS_VENDOR
2340 - CONFIG_SYS_SOC
2341
Tom Rini7e27f892012-10-24 07:28:16 +00002342 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2343
2344 Define this in order to add variables describing certain
2345 run-time determined information about the hardware to the
2346 environment. These will be named board_name, board_rev.
2347
Simon Glass06fd8532012-11-30 13:01:17 +00002348 CONFIG_DELAY_ENVIRONMENT
2349
2350 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002351 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002352 that so that the environment is not available until
2353 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2354 this is instead controlled by the value of
2355 /config/load-environment.
2356
wdenka8c7c702003-12-06 19:49:23 +00002357- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002358 CONFIG_HAS_DATAFLASH
2359
wdenk8bde7f72003-06-27 21:31:46 +00002360 Defining this option enables DataFlash features and
2361 allows to read/write in Dataflash via the standard
2362 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002363
Eric Nelsonf61ec452012-01-31 10:52:08 -07002364- Serial Flash support
Simon Glass00fd59d2017-08-04 16:35:06 -06002365 Usage requires an initial 'sf probe' to define the serial
Eric Nelsonf61ec452012-01-31 10:52:08 -07002366 flash parameters, followed by read/write/erase/update
2367 commands.
2368
2369 The following defaults may be provided by the platform
2370 to handle the common case when only a single serial
2371 flash is present on the system.
2372
2373 CONFIG_SF_DEFAULT_BUS Bus identifier
2374 CONFIG_SF_DEFAULT_CS Chip-select
2375 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2376 CONFIG_SF_DEFAULT_SPEED in Hz
2377
wdenk3f85ce22004-02-23 16:11:30 +00002378 CONFIG_SYSTEMACE
2379
2380 Adding this option adds support for Xilinx SystemACE
2381 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002382 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002383 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002384
2385 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002386 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002387
2388 When SystemACE support is added, the "ace" device type
2389 becomes available to the fat commands, i.e. fatls.
2390
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002391- TFTP Fixed UDP Port:
2392 CONFIG_TFTP_PORT
2393
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002394 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002395 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002396 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002397 number generator is used.
2398
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002399 Also, the environment variable tftpdstp is used to supply
2400 the TFTP UDP destination port value. If tftpdstp isn't
2401 defined, the normal port 69 is used.
2402
2403 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002404 blindly start the TFTP transfer using the pre-configured
2405 target IP address and UDP port. This has the effect of
2406 "punching through" the (Windows XP) firewall, allowing
2407 the remainder of the TFTP transfer to proceed normally.
2408 A better solution is to properly configure the firewall,
2409 but sometimes that is not allowed.
2410
Heiko Schocher9e50c402014-01-25 07:27:13 +01002411- bootcount support:
2412 CONFIG_BOOTCOUNT_LIMIT
2413
2414 This enables the bootcounter support, see:
2415 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2416
2417 CONFIG_AT91SAM9XE
2418 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002419 CONFIG_SOC_DA8XX
2420 enable special bootcounter support on da850 based boards.
2421 CONFIG_BOOTCOUNT_RAM
2422 enable support for the bootcounter in RAM
2423 CONFIG_BOOTCOUNT_I2C
2424 enable support for the bootcounter on an i2c (like RTC) device.
2425 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2426 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2427 the bootcounter.
2428 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002429
wdenka8c7c702003-12-06 19:49:23 +00002430- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002431 CONFIG_SHOW_BOOT_PROGRESS
2432
wdenk43d96162003-03-06 00:02:04 +00002433 Defining this option allows to add some board-
2434 specific code (calling a user-provided function
2435 "show_boot_progress(int)") that enables you to show
2436 the system's boot progress on some display (for
2437 example, some LED's) on your board. At the moment,
2438 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002439
Simon Glass94fd1312012-09-28 08:56:37 +00002440
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002441Legacy uImage format:
2442
wdenkc6097192002-11-03 00:24:07 +00002443 Arg Where When
2444 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002445 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002446 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002447 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002448 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002449 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002450 4 common/cmd_bootm.c Image data has correct checksum
2451 -4 common/cmd_bootm.c Image is for unsupported architecture
2452 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002453 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002454 6 common/cmd_bootm.c Image Type check OK
2455 -6 common/cmd_bootm.c gunzip uncompression error
2456 -7 common/cmd_bootm.c Unimplemented compression type
2457 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002458 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002459 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002460
2461 9 common/image.c Start initial ramdisk verification
2462 -10 common/image.c Ramdisk header has bad magic number
2463 -11 common/image.c Ramdisk header has bad checksum
2464 10 common/image.c Ramdisk header is OK
2465 -12 common/image.c Ramdisk data has bad checksum
2466 11 common/image.c Ramdisk data has correct checksum
2467 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002468 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002469 13 common/image.c Start multifile image verification
2470 14 common/image.c No initial ramdisk, no multifile, continue.
2471
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002472 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002473
Stefan Roesea47a12b2010-04-15 16:07:28 +02002474 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00002475 -31 post/post.c POST test failed, detected by post_output_backlog()
2476 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002477
Heiko Schocher566a4942007-06-22 19:11:54 +02002478 34 common/cmd_doc.c before loading a Image from a DOC device
2479 -35 common/cmd_doc.c Bad usage of "doc" command
2480 35 common/cmd_doc.c correct usage of "doc" command
2481 -36 common/cmd_doc.c No boot device
2482 36 common/cmd_doc.c correct boot device
2483 -37 common/cmd_doc.c Unknown Chip ID on boot device
2484 37 common/cmd_doc.c correct chip ID found, device available
2485 -38 common/cmd_doc.c Read Error on boot device
2486 38 common/cmd_doc.c reading Image header from DOC device OK
2487 -39 common/cmd_doc.c Image header has bad magic number
2488 39 common/cmd_doc.c Image header has correct magic number
2489 -40 common/cmd_doc.c Error reading Image from DOC device
2490 40 common/cmd_doc.c Image header has correct magic number
2491 41 common/cmd_ide.c before loading a Image from a IDE device
2492 -42 common/cmd_ide.c Bad usage of "ide" command
2493 42 common/cmd_ide.c correct usage of "ide" command
2494 -43 common/cmd_ide.c No boot device
2495 43 common/cmd_ide.c boot device found
2496 -44 common/cmd_ide.c Device not available
2497 44 common/cmd_ide.c Device available
2498 -45 common/cmd_ide.c wrong partition selected
2499 45 common/cmd_ide.c partition selected
2500 -46 common/cmd_ide.c Unknown partition table
2501 46 common/cmd_ide.c valid partition table found
2502 -47 common/cmd_ide.c Invalid partition type
2503 47 common/cmd_ide.c correct partition type
2504 -48 common/cmd_ide.c Error reading Image Header on boot device
2505 48 common/cmd_ide.c reading Image Header from IDE device OK
2506 -49 common/cmd_ide.c Image header has bad magic number
2507 49 common/cmd_ide.c Image header has correct magic number
2508 -50 common/cmd_ide.c Image header has bad checksum
2509 50 common/cmd_ide.c Image header has correct checksum
2510 -51 common/cmd_ide.c Error reading Image from IDE device
2511 51 common/cmd_ide.c reading Image from IDE device OK
2512 52 common/cmd_nand.c before loading a Image from a NAND device
2513 -53 common/cmd_nand.c Bad usage of "nand" command
2514 53 common/cmd_nand.c correct usage of "nand" command
2515 -54 common/cmd_nand.c No boot device
2516 54 common/cmd_nand.c boot device found
2517 -55 common/cmd_nand.c Unknown Chip ID on boot device
2518 55 common/cmd_nand.c correct chip ID found, device available
2519 -56 common/cmd_nand.c Error reading Image Header on boot device
2520 56 common/cmd_nand.c reading Image Header from NAND device OK
2521 -57 common/cmd_nand.c Image header has bad magic number
2522 57 common/cmd_nand.c Image header has correct magic number
2523 -58 common/cmd_nand.c Error reading Image from NAND device
2524 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002525
Heiko Schocher566a4942007-06-22 19:11:54 +02002526 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002527
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002528 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002529 -64 net/eth.c no Ethernet found.
2530 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002531
Heiko Schocher566a4942007-06-22 19:11:54 +02002532 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002533 80 common/cmd_net.c before calling net_loop()
2534 -81 common/cmd_net.c some error in net_loop() occurred
2535 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002536 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2537 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002538 83 common/cmd_net.c running "source" command
2539 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002540 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002541
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002542FIT uImage format:
2543
2544 Arg Where When
2545 100 common/cmd_bootm.c Kernel FIT Image has correct format
2546 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2547 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2548 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2549 102 common/cmd_bootm.c Kernel unit name specified
2550 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002551 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002552 104 common/cmd_bootm.c Got kernel subimage node offset
2553 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2554 105 common/cmd_bootm.c Kernel subimage hash verification OK
2555 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2556 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002557 -106 common/cmd_bootm.c Kernel subimage has wrong type
2558 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002559 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2560 108 common/cmd_bootm.c Got kernel subimage data/size
2561 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2562 -109 common/cmd_bootm.c Can't get kernel subimage type
2563 -110 common/cmd_bootm.c Can't get kernel subimage comp
2564 -111 common/cmd_bootm.c Can't get kernel subimage os
2565 -112 common/cmd_bootm.c Can't get kernel subimage load address
2566 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2567
2568 120 common/image.c Start initial ramdisk verification
2569 -120 common/image.c Ramdisk FIT image has incorrect format
2570 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002571 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002572 -122 common/image.c Can't get configuration for ramdisk subimage
2573 123 common/image.c Ramdisk unit name specified
2574 -124 common/image.c Can't get ramdisk subimage node offset
2575 125 common/image.c Got ramdisk subimage node offset
2576 -125 common/image.c Ramdisk subimage hash verification failed
2577 126 common/image.c Ramdisk subimage hash verification OK
2578 -126 common/image.c Ramdisk subimage for unsupported architecture
2579 127 common/image.c Architecture check OK
2580 -127 common/image.c Can't get ramdisk subimage data/size
2581 128 common/image.c Got ramdisk subimage data/size
2582 129 common/image.c Can't get ramdisk load address
2583 -129 common/image.c Got ramdisk load address
2584
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002585 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002586 131 common/cmd_doc.c FIT image format OK
2587
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002588 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002589 141 common/cmd_ide.c FIT image format OK
2590
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002591 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002592 151 common/cmd_nand.c FIT image format OK
2593
Heiko Schocher21d29f72014-05-28 11:33:33 +02002594- legacy image format:
2595 CONFIG_IMAGE_FORMAT_LEGACY
2596 enables the legacy image format support in U-Boot.
2597
2598 Default:
2599 enabled if CONFIG_FIT_SIGNATURE is not defined.
2600
2601 CONFIG_DISABLE_IMAGE_LEGACY
2602 disable the legacy image format
2603
2604 This define is introduced, as the legacy image format is
2605 enabled per default for backward compatibility.
2606
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002607- Standalone program support:
2608 CONFIG_STANDALONE_LOAD_ADDR
2609
Wolfgang Denk6feff892011-10-09 21:06:34 +02002610 This option defines a board specific value for the
2611 address where standalone program gets loaded, thus
2612 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002613 settings.
2614
2615- Frame Buffer Address:
2616 CONFIG_FB_ADDR
2617
2618 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002619 address for frame buffer. This is typically the case
2620 when using a graphics controller has separate video
2621 memory. U-Boot will then place the frame buffer at
2622 the given address instead of dynamically reserving it
2623 in system RAM by calling lcd_setmem(), which grabs
2624 the memory for the frame buffer depending on the
2625 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002626
2627 Please see board_init_f function.
2628
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002629- Automatic software updates via TFTP server
2630 CONFIG_UPDATE_TFTP
2631 CONFIG_UPDATE_TFTP_CNT_MAX
2632 CONFIG_UPDATE_TFTP_MSEC_MAX
2633
2634 These options enable and control the auto-update feature;
2635 for a more detailed description refer to doc/README.update.
2636
2637- MTD Support (mtdparts command, UBI support)
2638 CONFIG_MTD_DEVICE
2639
2640 Adds the MTD device infrastructure from the Linux kernel.
2641 Needed for mtdparts command support.
2642
2643 CONFIG_MTD_PARTITIONS
2644
2645 Adds the MTD partitioning infrastructure from the Linux
2646 kernel. Needed for UBI support.
2647
Joe Hershberger70c219c2013-04-08 10:32:48 +00002648- UBI support
Joe Hershberger147162d2013-04-08 10:32:49 +00002649 CONFIG_UBI_SILENCE_MSG
2650
2651 Make the verbose messages from UBI stop printing. This leaves
2652 warnings and errors enabled.
2653
Heiko Schocherff94bc42014-06-24 10:10:04 +02002654
2655 CONFIG_MTD_UBI_WL_THRESHOLD
2656 This parameter defines the maximum difference between the highest
2657 erase counter value and the lowest erase counter value of eraseblocks
2658 of UBI devices. When this threshold is exceeded, UBI starts performing
2659 wear leveling by means of moving data from eraseblock with low erase
2660 counter to eraseblocks with high erase counter.
2661
2662 The default value should be OK for SLC NAND flashes, NOR flashes and
2663 other flashes which have eraseblock life-cycle 100000 or more.
2664 However, in case of MLC NAND flashes which typically have eraseblock
2665 life-cycle less than 10000, the threshold should be lessened (e.g.,
2666 to 128 or 256, although it does not have to be power of 2).
2667
2668 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002669
Heiko Schocherff94bc42014-06-24 10:10:04 +02002670 CONFIG_MTD_UBI_BEB_LIMIT
2671 This option specifies the maximum bad physical eraseblocks UBI
2672 expects on the MTD device (per 1024 eraseblocks). If the
2673 underlying flash does not admit of bad eraseblocks (e.g. NOR
2674 flash), this value is ignored.
2675
2676 NAND datasheets often specify the minimum and maximum NVM
2677 (Number of Valid Blocks) for the flashes' endurance lifetime.
2678 The maximum expected bad eraseblocks per 1024 eraseblocks
2679 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2680 which gives 20 for most NANDs (MaxNVB is basically the total
2681 count of eraseblocks on the chip).
2682
2683 To put it differently, if this value is 20, UBI will try to
2684 reserve about 1.9% of physical eraseblocks for bad blocks
2685 handling. And that will be 1.9% of eraseblocks on the entire
2686 NAND chip, not just the MTD partition UBI attaches. This means
2687 that if you have, say, a NAND flash chip admits maximum 40 bad
2688 eraseblocks, and it is split on two MTD partitions of the same
2689 size, UBI will reserve 40 eraseblocks when attaching a
2690 partition.
2691
2692 default: 20
2693
2694 CONFIG_MTD_UBI_FASTMAP
2695 Fastmap is a mechanism which allows attaching an UBI device
2696 in nearly constant time. Instead of scanning the whole MTD device it
2697 only has to locate a checkpoint (called fastmap) on the device.
2698 The on-flash fastmap contains all information needed to attach
2699 the device. Using fastmap makes only sense on large devices where
2700 attaching by scanning takes long. UBI will not automatically install
2701 a fastmap on old images, but you can set the UBI parameter
2702 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2703 that fastmap-enabled images are still usable with UBI implementations
2704 without fastmap support. On typical flash devices the whole fastmap
2705 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2706
2707 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2708 Set this parameter to enable fastmap automatically on images
2709 without a fastmap.
2710 default: 0
2711
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002712 CONFIG_MTD_UBI_FM_DEBUG
2713 Enable UBI fastmap debug
2714 default: 0
2715
Joe Hershberger70c219c2013-04-08 10:32:48 +00002716- UBIFS support
Joe Hershberger147162d2013-04-08 10:32:49 +00002717 CONFIG_UBIFS_SILENCE_MSG
2718
2719 Make the verbose messages from UBIFS stop printing. This leaves
2720 warnings and errors enabled.
2721
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002722- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002723 CONFIG_SPL
2724 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002725
Tom Rini95579792012-02-14 07:29:40 +00002726 CONFIG_SPL_LDSCRIPT
2727 LDSCRIPT for linking the SPL binary.
2728
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002729 CONFIG_SPL_MAX_FOOTPRINT
2730 Maximum size in memory allocated to the SPL, BSS included.
2731 When defined, the linker checks that the actual memory
2732 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002733 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002734 must not be both defined at the same time.
2735
Tom Rini95579792012-02-14 07:29:40 +00002736 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002737 Maximum size of the SPL image (text, data, rodata, and
2738 linker lists sections), BSS excluded.
2739 When defined, the linker checks that the actual size does
2740 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002741
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002742 CONFIG_SPL_TEXT_BASE
2743 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002744
Scott Wood94a45bb2012-09-20 19:05:12 -05002745 CONFIG_SPL_RELOC_TEXT_BASE
2746 Address to relocate to. If unspecified, this is equal to
2747 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2748
Tom Rini95579792012-02-14 07:29:40 +00002749 CONFIG_SPL_BSS_START_ADDR
2750 Link address for the BSS within the SPL binary.
2751
2752 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002753 Maximum size in memory allocated to the SPL BSS.
2754 When defined, the linker checks that the actual memory used
2755 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002756 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002757 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002758
2759 CONFIG_SPL_STACK
2760 Adress of the start of the stack SPL will use
2761
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002762 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2763 When defined, SPL will panic() if the image it has
2764 loaded does not have a signature.
2765 Defining this is useful when code which loads images
2766 in SPL cannot guarantee that absolutely all read errors
2767 will be caught.
2768 An example is the LPC32XX MLC NAND driver, which will
2769 consider that a completely unreadable NAND block is bad,
2770 and thus should be skipped silently.
2771
Scott Wood94a45bb2012-09-20 19:05:12 -05002772 CONFIG_SPL_RELOC_STACK
2773 Adress of the start of the stack SPL will use after
2774 relocation. If unspecified, this is equal to
2775 CONFIG_SPL_STACK.
2776
Tom Rini95579792012-02-14 07:29:40 +00002777 CONFIG_SYS_SPL_MALLOC_START
2778 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002779 When this option is set the full malloc is used in SPL and
2780 it is set up by spl_init() and before that, the simple malloc()
2781 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002782
2783 CONFIG_SYS_SPL_MALLOC_SIZE
2784 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002785
Tom Rini47f7bca2012-08-13 12:03:19 -07002786 CONFIG_SPL_FRAMEWORK
2787 Enable the SPL framework under common/. This framework
2788 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2789 NAND loading of the Linux Kernel.
2790
Tom Rini9607faf2014-03-28 12:03:39 -04002791 CONFIG_SPL_OS_BOOT
2792 Enable booting directly to an OS from SPL.
2793 See also: doc/README.falcon
2794
Tom Rini861a86f2012-08-13 11:37:56 -07002795 CONFIG_SPL_DISPLAY_PRINT
2796 For ARM, enable an optional function to print more information
2797 about the running system.
2798
Scott Wood4b919722012-09-20 16:35:21 -05002799 CONFIG_SPL_INIT_MINIMAL
2800 Arch init code should be built for a very small image
2801
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002802 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2803 Partition on the MMC to load U-Boot from when the MMC is being
2804 used in raw mode
2805
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002806 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2807 Sector to load kernel uImage from when MMC is being
2808 used in raw mode (for Falcon mode)
2809
2810 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2811 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2812 Sector and number of sectors to load kernel argument
2813 parameters from when MMC is being used in raw mode
2814 (for falcon mode)
2815
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002816 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2817 Partition on the MMC to load U-Boot from when the MMC is being
2818 used in fs mode
2819
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002820 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2821 Filename to read to load U-Boot when reading from filesystem
2822
2823 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002824 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002825 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002826
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002827 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002828 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002829 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002830
Scott Wood06f60ae2012-12-06 13:33:17 +00002831 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2832 Set this for NAND SPL on PPC mpc83xx targets, so that
2833 start.S waits for the rest of the SPL to load before
2834 continuing (the hardware starts execution after just
2835 loading the first page rather than the full 4K).
2836
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302837 CONFIG_SPL_SKIP_RELOCATE
2838 Avoid SPL relocation
2839
Scott Wood6f2f01b2012-09-20 19:09:07 -05002840 CONFIG_SPL_NAND_BASE
2841 Include nand_base.c in the SPL. Requires
2842 CONFIG_SPL_NAND_DRIVERS.
2843
2844 CONFIG_SPL_NAND_DRIVERS
2845 SPL uses normal NAND drivers, not minimal drivers.
2846
2847 CONFIG_SPL_NAND_ECC
2848 Include standard software ECC in the SPL
2849
Tom Rini95579792012-02-14 07:29:40 +00002850 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002851 Support for NAND boot using simple NAND drivers that
2852 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002853
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002854 CONFIG_SPL_UBI
2855 Support for a lightweight UBI (fastmap) scanner and
2856 loader
2857
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002858 CONFIG_SPL_NAND_RAW_ONLY
2859 Support to boot only raw u-boot.bin images. Use this only
2860 if you need to save space.
2861
Ying Zhang7c8eea52013-08-16 15:16:12 +08002862 CONFIG_SPL_COMMON_INIT_DDR
2863 Set for common ddr init with serial presence detect in
2864 SPL binary.
2865
Tom Rini95579792012-02-14 07:29:40 +00002866 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2867 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2868 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2869 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2870 CONFIG_SYS_NAND_ECCBYTES
2871 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002872 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002873
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05302874 CONFIG_SPL_NAND_BOOT
2875 Add support NAND boot
2876
Tom Rini95579792012-02-14 07:29:40 +00002877 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002878 Location in NAND to read U-Boot from
2879
2880 CONFIG_SYS_NAND_U_BOOT_DST
2881 Location in memory to load U-Boot to
2882
2883 CONFIG_SYS_NAND_U_BOOT_SIZE
2884 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002885
2886 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002887 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002888
2889 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2890 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002891 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002892
2893 CONFIG_SPL_OMAP3_ID_NAND
2894 Support for an OMAP3-specific set of functions to return the
2895 ID and MFR of the first attached NAND chip, if present.
2896
Pavel Machekc57b9532012-08-30 22:42:11 +02002897 CONFIG_SPL_RAM_DEVICE
2898 Support for running image already present in ram, in SPL binary
2899
Scott Wood74752ba2012-12-06 13:33:16 +00002900 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002901 Image offset to which the SPL should be padded before appending
2902 the SPL payload. By default, this is defined as
2903 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2904 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2905 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002906
Scott Woodca2fca22012-09-21 16:27:32 -05002907 CONFIG_SPL_TARGET
2908 Final target image containing SPL and payload. Some SPLs
2909 use an arch-specific makefile fragment instead, for
2910 example if more than one image needs to be produced.
2911
Simon Glass87ebee32013-05-08 08:05:59 +00002912 CONFIG_FIT_SPL_PRINT
2913 Printing information about a FIT image adds quite a bit of
2914 code to SPL. So this is normally disabled in SPL. Use this
2915 option to re-enable it. This will affect the output of the
2916 bootm command when booting a FIT image.
2917
Ying Zhang3aa29de2013-08-16 15:16:15 +08002918- TPL framework
2919 CONFIG_TPL
2920 Enable building of TPL globally.
2921
2922 CONFIG_TPL_PAD_TO
2923 Image offset to which the TPL should be padded before appending
2924 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002925 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2926 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2927 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002928
wdenka8c7c702003-12-06 19:49:23 +00002929- Interrupt support (PPC):
2930
wdenkd4ca31c2004-01-02 14:00:00 +00002931 There are common interrupt_init() and timer_interrupt()
2932 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002933 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002934 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002935 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002936 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002937 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002938 specific handling. If board has watchdog / status_led
2939 / other_activity_monitor it works automatically from
2940 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002941
wdenkc6097192002-11-03 00:24:07 +00002942
Helmut Raiger9660e442011-10-20 04:19:47 +00002943Board initialization settings:
2944------------------------------
2945
2946During Initialization u-boot calls a number of board specific functions
2947to allow the preparation of board specific prerequisites, e.g. pin setup
2948before drivers are initialized. To enable these callbacks the
2949following configuration macros have to be defined. Currently this is
2950architecture specific, so please check arch/your_architecture/lib/board.c
2951typically in board_init_f() and board_init_r().
2952
2953- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2954- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2955- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2956- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002957
wdenkc6097192002-11-03 00:24:07 +00002958Configuration Settings:
2959-----------------------
2960
York Sun4d1fd7f2014-02-26 17:03:19 -08002961- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2962 Optionally it can be defined to support 64-bit memory commands.
2963
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002964- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002965 undefine this when you're short of memory.
2966
Peter Tyser2fb26042009-01-27 18:03:12 -06002967- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2968 width of the commands listed in the 'help' command output.
2969
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002970- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002971 prompt for user input.
2972
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002973- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002975- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002976
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002977- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002979- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002980 the application (usually a Linux kernel) when it is
2981 booted
2982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002983- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002984 List of legal baudrate settings for this board.
2985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002986- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002987 Begin and End addresses of the area used by the
2988 simple memory test.
2989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002990- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002991 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002994 Scratch address used by the alternate memory test
2995 You only need to set this if address zero isn't writeable
2996
York Sune8149522015-12-04 11:57:07 -08002997- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002998 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002999 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3000 is substracted from total RAM and won't be reported to OS.
3001 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003002 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003003 the RAM base is not zero, or RAM is divided into banks,
3004 this variable needs to be recalcuated to get the address.
3005
York Sunaabd7dd2015-12-07 11:05:29 -08003006- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003007 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003008 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003009 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003010 fixing up gd->ram_size the Linux kernel should gets passed
3011 the now "corrected" memory size and won't touch it either.
3012 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003013 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003014 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003015 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003016
3017 This option can be used as a workaround for the 440EPx/GRx
3018 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3019 be touched.
3020
3021 WARNING: Please make sure that this value is a multiple of
3022 the Linux page size (normally 4k). If this is not the case,
3023 then the end address of the Linux memory will be located at a
3024 non page size aligned address and this could cause major
3025 problems.
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003028 Enable temporary baudrate change while serial download
3029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003030- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003031 Physical start address of SDRAM. _Must_ be 0 here.
3032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003033- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003034 Physical start address of Flash memory.
3035
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003036- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003037 Physical start address of boot monitor code (set by
3038 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003039 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003040 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003041
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003042- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003043 Size of memory reserved for monitor code, used to
3044 determine _at_compile_time_ (!) if the environment is
3045 embedded within the U-Boot image, or in a separate
3046 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003048- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003049 Size of DRAM reserved for malloc() use.
3050
Simon Glassd59476b2014-07-10 22:23:28 -06003051- CONFIG_SYS_MALLOC_F_LEN
3052 Size of the malloc() pool for use before relocation. If
3053 this is defined, then a very simple malloc() implementation
3054 will become available before relocation. The address is just
3055 below the global data, and the stack is moved down to make
3056 space.
3057
3058 This feature allocates regions with increasing addresses
3059 within the region. calloc() is supported, but realloc()
3060 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003061 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003062 U-Boot relocates itself.
3063
Simon Glass38687ae2014-11-10 17:16:54 -07003064- CONFIG_SYS_MALLOC_SIMPLE
3065 Provides a simple and small malloc() and calloc() for those
3066 boards which do not use the full malloc in SPL (which is
3067 enabled with CONFIG_SYS_SPL_MALLOC_START).
3068
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003069- CONFIG_SYS_NONCACHED_MEMORY:
3070 Size of non-cached memory area. This area of memory will be
3071 typically located right below the malloc() area and mapped
3072 uncached in the MMU. This is useful for drivers that would
3073 otherwise require a lot of explicit cache maintenance. For
3074 some drivers it's also impossible to properly maintain the
3075 cache. For example if the regions that need to be flushed
3076 are not a multiple of the cache-line size, *and* padding
3077 cannot be allocated between the regions to align them (i.e.
3078 if the HW requires a contiguous array of regions, and the
3079 size of each region is not cache-aligned), then a flush of
3080 one region may result in overwriting data that hardware has
3081 written to another region in the same cache-line. This can
3082 happen for example in network drivers where descriptors for
3083 buffers are typically smaller than the CPU cache-line (e.g.
3084 16 bytes vs. 32 or 64 bytes).
3085
3086 Non-cached memory is only supported on 32-bit ARM at present.
3087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003088- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003089 Normally compressed uImages are limited to an
3090 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003091 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003092 to adjust this setting to your needs.
3093
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003094- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003095 Maximum size of memory mapped by the startup code of
3096 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003097 the Linux kernel (bd_info, boot arguments, FDT blob if
3098 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003099 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003100 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003101 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003102 variable "bootm_mapsize" will override the value of
3103 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3104 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003105
John Rigbyfca43cc2010-10-13 13:57:35 -06003106- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3107 Enable initrd_high functionality. If defined then the
3108 initrd_high feature is enabled and the bootm ramdisk subcommand
3109 is enabled.
3110
3111- CONFIG_SYS_BOOT_GET_CMDLINE:
3112 Enables allocating and saving kernel cmdline in space between
3113 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3114
3115- CONFIG_SYS_BOOT_GET_KBD:
3116 Enables allocating and saving a kernel copy of the bd_info in
3117 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003120 Max number of Flash memory banks
3121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003122- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003123 Max number of sectors on a Flash chip
3124
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003125- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003126 Timeout for Flash erase operations (in ms)
3127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003128- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003129 Timeout for Flash write operations (in ms)
3130
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003131- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003132 Timeout for Flash set sector lock bit operation (in ms)
3133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003134- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003135 Timeout for Flash clear lock bits operation (in ms)
3136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003137- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003138 If defined, hardware flash sectors protection is used
3139 instead of U-Boot software protection.
3140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003141- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003142
3143 Enable TFTP transfers directly to flash memory;
3144 without this option such a download has to be
3145 performed in two steps: (1) download to RAM, and (2)
3146 copy from RAM to flash.
3147
3148 The two-step approach is usually more reliable, since
3149 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003150 the flash, but in some situations (when system RAM is
3151 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003152 downloaded image) this option may be very useful.
3153
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003154- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003155 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003156 common flash structure for storing flash geometry.
3157
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003158- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003159 This option also enables the building of the cfi_flash driver
3160 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003161
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003162- CONFIG_FLASH_CFI_MTD
3163 This option enables the building of the cfi_mtd driver
3164 in the drivers directory. The driver exports CFI flash
3165 to the MTD layer.
3166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003167- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003168 Use buffered writes to flash.
3169
3170- CONFIG_FLASH_SPANSION_S29WS_N
3171 s29ws-n MirrorBit flash has non-standard addresses for buffered
3172 write commands.
3173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003174- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003175 If this option is defined, the common CFI flash doesn't
3176 print it's warning upon not recognized FLASH banks. This
3177 is useful, if some of the configured banks are only
3178 optionally available.
3179
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003180- CONFIG_FLASH_SHOW_PROGRESS
3181 If defined (must be an integer), print out countdown
3182 digits and dots. Recommended value: 45 (9..1) for 80
3183 column displays, 15 (3..1) for 40 column displays.
3184
Stefan Roese352ef3f2013-04-04 15:53:14 +02003185- CONFIG_FLASH_VERIFY
3186 If defined, the content of the flash (destination) is compared
3187 against the source after the write operation. An error message
3188 will be printed when the contents are not identical.
3189 Please note that this option is useless in nearly all cases,
3190 since such flash programming errors usually are detected earlier
3191 while unprotecting/erasing/programming. Please only enable
3192 this option if you really know what you are doing.
3193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003195 Defines the number of Ethernet receive buffers. On some
3196 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003197 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3198 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003199 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003200 Defaults to 4 if not defined.
3201
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003202- CONFIG_ENV_MAX_ENTRIES
3203
Wolfgang Denk071bc922010-10-27 22:48:30 +02003204 Maximum number of entries in the hash table that is used
3205 internally to store the environment settings. The default
3206 setting is supposed to be generous and should work in most
3207 cases. This setting can be used to tune behaviour; see
3208 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003209
Joe Hershberger25980902012-12-11 22:16:31 -06003210- CONFIG_ENV_FLAGS_LIST_DEFAULT
3211- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003212 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003213 calling env set. Variables can be restricted to only decimal,
3214 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3215 the variables can also be restricted to IP address or MAC address.
3216
3217 The format of the list is:
3218 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003219 access_attribute = [a|r|o|c]
3220 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003221 entry = variable_name[:attributes]
3222 list = entry[,list]
3223
3224 The type attributes are:
3225 s - String (default)
3226 d - Decimal
3227 x - Hexadecimal
3228 b - Boolean ([1yYtT|0nNfF])
3229 i - IP address
3230 m - MAC address
3231
Joe Hershberger267541f2012-12-11 22:16:34 -06003232 The access attributes are:
3233 a - Any (default)
3234 r - Read-only
3235 o - Write-once
3236 c - Change-default
3237
Joe Hershberger25980902012-12-11 22:16:31 -06003238 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3239 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003240 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003241
3242 - CONFIG_ENV_FLAGS_LIST_STATIC
3243 Define this to a list (string) to define validation that
3244 should be done if an entry is not found in the ".flags"
3245 environment variable. To override a setting in the static
3246 list, simply add an entry for the same variable name to the
3247 ".flags" variable.
3248
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003249 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3250 regular expression. This allows multiple variables to define the same
3251 flags without explicitly listing them for each variable.
3252
Joe Hershberger267541f2012-12-11 22:16:34 -06003253- CONFIG_ENV_ACCESS_IGNORE_FORCE
3254 If defined, don't allow the -f switch to env set override variable
3255 access flags.
3256
Gabe Black0d296cc2014-10-15 04:38:30 -06003257- CONFIG_USE_STDINT
3258 If stdint.h is available with your toolchain you can define this
3259 option to enable it. You can provide option 'USE_STDINT=1' when
3260 building U-Boot to enable this.
3261
wdenkc6097192002-11-03 00:24:07 +00003262The following definitions that deal with the placement and management
3263of environment data (variable area); in general, we support the
3264following configurations:
3265
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003266- CONFIG_BUILD_ENVCRC:
3267
3268 Builds up envcrc with the target environment so that external utils
3269 may easily extract it and embed it in final U-Boot images.
3270
wdenkc6097192002-11-03 00:24:07 +00003271BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003272in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003273console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003274U-Boot will hang.
3275
3276Please note that even with NVRAM we still use a copy of the
3277environment in RAM: we could work on NVRAM directly, but we want to
3278keep settings there always unmodified except somebody uses "saveenv"
3279to save the current settings.
3280
Liu Gang0a85a9e2012-03-08 00:33:20 +00003281BE CAREFUL! For some special cases, the local device can not use
3282"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003283environment stored in a remote NOR flash by SRIO or PCIE link,
3284but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003285
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003286- CONFIG_NAND_ENV_DST
3287
3288 Defines address in RAM to which the nand_spl code should copy the
3289 environment. If redundant environment is used, it will be copied to
3290 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3291
Bruce Adlere881cb52007-11-02 13:15:42 -07003292Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003293has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003294created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003295until then to read environment variables.
3296
wdenk85ec0bc2003-03-31 16:34:49 +00003297The environment is protected by a CRC32 checksum. Before the monitor
3298is relocated into RAM, as a result of a bad CRC you will be working
3299with the compiled-in default environment - *silently*!!! [This is
3300necessary, because the first environment variable we need is the
3301"baudrate" setting for the console - if we have a bad CRC, we don't
3302have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003303
3304Note: once the monitor has been relocated, then it will complain if
3305the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003306use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003308- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003309 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003311 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003312 also needs to be defined.
3313
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003314- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003315 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003316
Ron Madridf5675aa2009-02-18 14:30:44 -08003317- CONFIG_NS16550_MIN_FUNCTIONS:
3318 Define this if you desire to only have use of the NS16550_init
3319 and NS16550_putc functions for the serial driver located at
3320 drivers/serial/ns16550.c. This option is useful for saving
3321 space for already greatly restricted images, including but not
3322 limited to NAND_SPL configurations.
3323
Simon Glassb2b92f52012-11-30 13:01:18 +00003324- CONFIG_DISPLAY_BOARDINFO
3325 Display information about the board that U-Boot is running on
3326 when U-Boot starts up. The board function checkboard() is called
3327 to do this.
3328
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003329- CONFIG_DISPLAY_BOARDINFO_LATE
3330 Similar to the previous option, but display this information
3331 later, once stdio is running and output goes to the LCD, if
3332 present.
3333
Sascha Silbefeb85802013-08-11 16:40:43 +02003334- CONFIG_BOARD_SIZE_LIMIT:
3335 Maximum size of the U-Boot image. When defined, the
3336 build system checks that the actual size does not
3337 exceed it.
3338
wdenkc6097192002-11-03 00:24:07 +00003339Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003340---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003341
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003342- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003343 Cache Line Size of the CPU.
3344
Timur Tabie46fedf2011-08-04 18:03:41 -05003345- CONFIG_SYS_CCSRBAR_DEFAULT:
3346 Default (power-on reset) physical address of CCSR on Freescale
3347 PowerPC SOCs.
3348
3349- CONFIG_SYS_CCSRBAR:
3350 Virtual address of CCSR. On a 32-bit build, this is typically
3351 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3352
Timur Tabie46fedf2011-08-04 18:03:41 -05003353- CONFIG_SYS_CCSRBAR_PHYS:
3354 Physical address of CCSR. CCSR can be relocated to a new
3355 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003356 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003357 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3358 is typically relocated on 36-bit builds. It is recommended
3359 that this macro be defined via the _HIGH and _LOW macros:
3360
3361 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3362 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3363
3364- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003365 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3366 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003367 used in assembly code, so it must not contain typecasts or
3368 integer size suffixes (e.g. "ULL").
3369
3370- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3371 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3372 used in assembly code, so it must not contain typecasts or
3373 integer size suffixes (e.g. "ULL").
3374
3375- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3376 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3377 forced to a value that ensures that CCSR is not relocated.
3378
wdenk7f6c2cb2002-11-10 22:06:23 +00003379- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003380 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003381
3382 the default drive number (default value 0)
3383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003384 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003385
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003386 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003387 (default value 1)
3388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003389 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003390
wdenk43d96162003-03-06 00:02:04 +00003391 defines the offset of register from address. It
3392 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003393 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003395 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3396 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003397 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003398
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003399 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003400 fdc_hw_init() is called at the beginning of the FDC
3401 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003402 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003403 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003404
Macpaul Lin0abddf82011-04-11 20:45:32 +00003405- CONFIG_IDE_AHB:
3406 Most IDE controllers were designed to be connected with PCI
3407 interface. Only few of them were designed for AHB interface.
3408 When software is doing ATA command and data transfer to
3409 IDE devices through IDE-AHB controller, some additional
3410 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003411 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003413- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003414 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003415 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003416
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003417- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk7152b1d2003-09-05 23:19:14 +00003419 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003420 initial data and stack; please note that this must be
3421 writable memory that is working WITHOUT special
3422 initialization, i. e. you CANNOT use normal RAM which
3423 will become available only after programming the
3424 memory controller and running certain initialization
3425 sequences.
3426
3427 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003428 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003430- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003431
3432 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003433 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3434 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003435 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003436 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003437 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003438 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3439 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003440
3441 Note:
3442 On the MPC824X (or other systems that use the data
3443 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003444 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003445 point to an otherwise UNUSED address space between
3446 the top of RAM and the start of the PCI space.
3447
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003448- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003450- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003451 SDRAM timing
3452
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003453- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003454 periodic timer for refresh
3455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003456- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3457 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3458 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3459 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003460 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3461
3462- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003463 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3464 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003465 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3466
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003467- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003468 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003469 Don't do any setup work, presumably because someone or
3470 something has already done it, and we don't need to do it
3471 a second time. Useful for platforms that are pre-booted
3472 by coreboot or similar.
3473
Gabor Juhos842033e2013-05-30 07:06:12 +00003474- CONFIG_PCI_INDIRECT_BRIDGE:
3475 Enable support for indirect PCI bridges.
3476
Kumar Galaa09b9b62010-12-30 12:09:53 -06003477- CONFIG_SYS_SRIO:
3478 Chip has SRIO or not
3479
3480- CONFIG_SRIO1:
3481 Board has SRIO 1 port available
3482
3483- CONFIG_SRIO2:
3484 Board has SRIO 2 port available
3485
Liu Gangc8b28152013-05-07 16:30:46 +08003486- CONFIG_SRIO_PCIE_BOOT_MASTER
3487 Board can support master function for Boot from SRIO and PCIE
3488
Kumar Galaa09b9b62010-12-30 12:09:53 -06003489- CONFIG_SYS_SRIOn_MEM_VIRT:
3490 Virtual Address of SRIO port 'n' memory region
3491
3492- CONFIG_SYS_SRIOn_MEM_PHYS:
3493 Physical Address of SRIO port 'n' memory region
3494
3495- CONFIG_SYS_SRIOn_MEM_SIZE:
3496 Size of SRIO port 'n' memory region
3497
Fabio Estevam66bd1842013-04-11 09:35:34 +00003498- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3499 Defined to tell the NAND controller that the NAND chip is using
3500 a 16 bit bus.
3501 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003502 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003503 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003504 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003505
3506- CONFIG_SYS_NDFC_EBC0_CFG
3507 Sets the EBC0_CFG register for the NDFC. If not defined
3508 a default value will be used.
3509
Ben Warrenbb99ad62006-09-07 16:50:54 -04003510- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003511 Get DDR timing information from an I2C EEPROM. Common
3512 with pluggable memory modules such as SODIMMs
3513
Ben Warrenbb99ad62006-09-07 16:50:54 -04003514 SPD_EEPROM_ADDRESS
3515 I2C address of the SPD EEPROM
3516
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003517- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003518 If SPD EEPROM is on an I2C bus other than the first
3519 one, specify here. Note that the value must resolve
3520 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003521
York Sun1b3e3c42011-06-07 09:42:16 +08003522- CONFIG_SYS_DDR_RAW_TIMING
3523 Get DDR timing information from other than SPD. Common with
3524 soldered DDR chips onboard without SPD. DDR raw timing
3525 parameters are extracted from datasheet and hard-coded into
3526 header files or board specific files.
3527
York Sun6f5e1dc2011-09-16 13:21:35 -07003528- CONFIG_FSL_DDR_INTERACTIVE
3529 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3530
York Sune32d59a2015-01-06 13:18:55 -08003531- CONFIG_FSL_DDR_SYNC_REFRESH
3532 Enable sync of refresh for multiple controllers.
3533
York Sun4516ff82015-03-19 09:30:28 -07003534- CONFIG_FSL_DDR_BIST
3535 Enable built-in memory test for Freescale DDR controllers.
3536
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003537- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003538 Only for 83xx systems. If specified, then DDR should
3539 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003540
wdenkc26e4542004-04-18 10:13:26 +00003541- CONFIG_RMII
3542 Enable RMII mode for all FECs.
3543 Note that this is a global option, we can't
3544 have one FEC in standard MII mode and another in RMII mode.
3545
wdenk5cf91d62004-04-23 20:32:05 +00003546- CONFIG_CRC32_VERIFY
3547 Add a verify option to the crc32 command.
3548 The syntax is:
3549
3550 => crc32 -v <address> <count> <crc32>
3551
3552 Where address/count indicate a memory area
3553 and crc32 is the correct crc32 which the
3554 area should have.
3555
wdenk56523f12004-07-11 17:40:54 +00003556- CONFIG_LOOPW
3557 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06003558 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00003559
stroese7b466642004-12-16 18:46:55 +00003560- CONFIG_MX_CYCLIC
3561 Add the "mdc" and "mwc" memory commands. These are cyclic
3562 "md/mw" commands.
3563 Examples:
3564
wdenkefe2a4d2004-12-16 21:44:03 +00003565 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003566 This command will print 4 bytes (10,11,12,13) each 500 ms.
3567
wdenkefe2a4d2004-12-16 21:44:03 +00003568 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003569 This command will write 12345678 to address 100 all 10 ms.
3570
wdenkefe2a4d2004-12-16 21:44:03 +00003571 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06003572 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00003573
wdenk8aa1a2d2005-04-04 12:44:11 +00003574- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003575 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003576 low level initializations (like setting up the memory
3577 controller) are omitted and/or U-Boot does not
3578 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003579
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003580 Normally this variable MUST NOT be defined. The only
3581 exception is when U-Boot is loaded (to RAM) by some
3582 other boot loader or by a debugger which performs
3583 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003584
Simon Glassb5bd0982016-05-05 07:28:06 -06003585- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3586 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003587 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003588 instruction cache) is still performed.
3589
Aneesh V401bb302011-07-13 05:11:07 +00003590- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003591 Modifies the behaviour of start.S when compiling a loader
3592 that is executed before the actual U-Boot. E.g. when
3593 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003594
Ying Zhang3aa29de2013-08-16 15:16:15 +08003595- CONFIG_TPL_BUILD
3596 Modifies the behaviour of start.S when compiling a loader
3597 that is executed after the SPL and before the actual U-Boot.
3598 It is loaded by the SPL.
3599
Ying Zhang5df572f2013-05-20 14:07:23 +08003600- CONFIG_SYS_MPC85XX_NO_RESETVEC
3601 Only for 85xx systems. If this variable is specified, the section
3602 .resetvec is not kept and the section .bootpg is placed in the
3603 previous 4k of the .text section.
3604
Simon Glass4213fc22013-02-24 17:33:14 +00003605- CONFIG_ARCH_MAP_SYSMEM
3606 Generally U-Boot (and in particular the md command) uses
3607 effective address. It is therefore not necessary to regard
3608 U-Boot address as virtual addresses that need to be translated
3609 to physical addresses. However, sandbox requires this, since
3610 it maintains its own little RAM buffer which contains all
3611 addressable memory. This option causes some memory accesses
3612 to be mapped through map_sysmem() / unmap_sysmem().
3613
Simon Glass588a13f2013-02-14 04:18:54 +00003614- CONFIG_X86_RESET_VECTOR
3615 If defined, the x86 reset vector code is included. This is not
3616 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003617
Heiko Schocher16678eb2013-11-04 14:05:00 +01003618- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3619 Enables the RTC32K OSC on AM33xx based plattforms
3620
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003621- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3622 Option to disable subpage write in NAND driver
3623 driver that uses this:
3624 drivers/mtd/nand/davinci_nand.c
3625
Timur Tabif2717b42011-11-22 09:21:25 -06003626Freescale QE/FMAN Firmware Support:
3627-----------------------------------
3628
3629The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3630loading of "firmware", which is encoded in the QE firmware binary format.
3631This firmware often needs to be loaded during U-Boot booting, so macros
3632are used to identify the storage device (NOR flash, SPI, etc) and the address
3633within that device.
3634
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003635- CONFIG_SYS_FMAN_FW_ADDR
3636 The address in the storage device where the FMAN microcode is located. The
3637 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3638 is also specified.
3639
3640- CONFIG_SYS_QE_FW_ADDR
3641 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003642 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3643 is also specified.
3644
3645- CONFIG_SYS_QE_FMAN_FW_LENGTH
3646 The maximum possible size of the firmware. The firmware binary format
3647 has a field that specifies the actual size of the firmware, but it
3648 might not be possible to read any part of the firmware unless some
3649 local storage is allocated to hold the entire firmware first.
3650
3651- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3652 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3653 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3654 virtual address in NOR flash.
3655
3656- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3657 Specifies that QE/FMAN firmware is located in NAND flash.
3658 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3659
3660- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3661 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3662 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3663
Liu Gang292dc6c2012-03-08 00:33:18 +00003664- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3665 Specifies that QE/FMAN firmware is located in the remote (master)
3666 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003667 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3668 window->master inbound window->master LAW->the ucode address in
3669 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003670
J. German Riverab940ca62014-06-23 15:15:55 -07003671Freescale Layerscape Management Complex Firmware Support:
3672---------------------------------------------------------
3673The Freescale Layerscape Management Complex (MC) supports the loading of
3674"firmware".
3675This firmware often needs to be loaded during U-Boot booting, so macros
3676are used to identify the storage device (NOR flash, SPI, etc) and the address
3677within that device.
3678
3679- CONFIG_FSL_MC_ENET
3680 Enable the MC driver for Layerscape SoCs.
3681
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303682Freescale Layerscape Debug Server Support:
3683-------------------------------------------
3684The Freescale Layerscape Debug Server Support supports the loading of
3685"Debug Server firmware" and triggering SP boot-rom.
3686This firmware often needs to be loaded during U-Boot booting.
3687
York Sunc0492142015-12-07 11:08:58 -08003688- CONFIG_SYS_MC_RSV_MEM_ALIGN
3689 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303690
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003691Reproducible builds
3692-------------------
3693
3694In order to achieve reproducible builds, timestamps used in the U-Boot build
3695process have to be set to a fixed value.
3696
3697This is done using the SOURCE_DATE_EPOCH environment variable.
3698SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3699option for U-Boot or an environment variable in U-Boot.
3700
3701SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3702
wdenkc6097192002-11-03 00:24:07 +00003703Building the Software:
3704======================
3705
Wolfgang Denk218ca722008-03-26 10:40:12 +01003706Building U-Boot has been tested in several native build environments
3707and in many different cross environments. Of course we cannot support
3708all possibly existing versions of cross development tools in all
3709(potentially obsolete) versions. In case of tool chain problems we
3710recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3711which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003712
Wolfgang Denk218ca722008-03-26 10:40:12 +01003713If you are not using a native environment, it is assumed that you
3714have GNU cross compiling tools available in your path. In this case,
3715you must set the environment variable CROSS_COMPILE in your shell.
3716Note that no changes to the Makefile or any other source files are
3717necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003718
Wolfgang Denk218ca722008-03-26 10:40:12 +01003719 $ CROSS_COMPILE=ppc_4xx-
3720 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003721
Peter Tyser2f8d3962009-03-13 18:54:51 -05003722Note: If you wish to generate Windows versions of the utilities in
3723 the tools directory you can use the MinGW toolchain
3724 (http://www.mingw.org). Set your HOST tools to the MinGW
3725 toolchain and execute 'make tools'. For example:
3726
3727 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3728
3729 Binaries such as tools/mkimage.exe will be created which can
3730 be executed on computers running Windows.
3731
Wolfgang Denk218ca722008-03-26 10:40:12 +01003732U-Boot is intended to be simple to build. After installing the
3733sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003734is done by typing:
3735
Holger Freytherab584d62014-08-04 09:26:05 +02003736 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003737
Holger Freytherab584d62014-08-04 09:26:05 +02003738where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003739rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741Note: for some board special configuration names may exist; check if
3742 additional information is available from the board vendor; for
3743 instance, the TQM823L systems are available without (standard)
3744 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003745 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003746
Holger Freytherab584d62014-08-04 09:26:05 +02003747 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003748 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003749
Holger Freytherab584d62014-08-04 09:26:05 +02003750 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003751 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003752
wdenk2729af92004-05-03 20:45:30 +00003753 etc.
wdenkc6097192002-11-03 00:24:07 +00003754
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756Finally, type "make all", and you should get some working U-Boot
3757images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759- "u-boot.bin" is a raw binary image
3760- "u-boot" is an image in ELF binary format
3761- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003762
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003763By default the build is performed locally and the objects are saved
3764in the source directory. One of the two methods can be used to change
3765this behavior and build U-Boot to some external directory:
3766
37671. Add O= to the make command line invocations:
3768
3769 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003770 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003771 make O=/tmp/build all
3772
Timo Ketolaadbba992014-11-06 14:39:05 +020037732. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003774
Timo Ketolaadbba992014-11-06 14:39:05 +02003775 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003776 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003777 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003778 make all
3779
Timo Ketolaadbba992014-11-06 14:39:05 +02003780Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003781variable.
3782
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784Please be aware that the Makefiles assume you are using GNU make, so
3785for instance on NetBSD you might need to use "gmake" instead of
3786native "make".
wdenkc6097192002-11-03 00:24:07 +00003787
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk2729af92004-05-03 20:45:30 +00003789If the system board that you have is not listed, then you will need
3790to port U-Boot to your hardware platform. To do this, follow these
3791steps:
wdenkc6097192002-11-03 00:24:07 +00003792
Phil Sutter3c1496c2015-12-25 14:41:18 +010037931. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003794 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003795 the "Makefile" and a "<board>.c".
37962. Create a new configuration file "include/configs/<board>.h" for
3797 your board.
wdenk2729af92004-05-03 20:45:30 +000037983. If you're porting U-Boot to a new CPU, then also create a new
3799 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020038004. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000038015. Type "make", and you should get a working "u-boot.srec" file
3802 to be installed on your target system.
38036. Debug and solve any problems that might arise.
3804 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003805
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk2729af92004-05-03 20:45:30 +00003807Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3808==============================================================
wdenkc6097192002-11-03 00:24:07 +00003809
Wolfgang Denk218ca722008-03-26 10:40:12 +01003810If you have modified U-Boot sources (for instance added a new board
3811or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003812provide feedback to the other developers. The feedback normally takes
3813the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003814official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003815
Wolfgang Denk218ca722008-03-26 10:40:12 +01003816But before you submit such a patch, please verify that your modifi-
3817cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003818the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003819just run the buildman script (tools/buildman/buildman), which will
3820configure and build U-Boot for ALL supported system. Be warned, this
3821will take a while. Please see the buildman README, or run 'buildman -H'
3822for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003823
3824
wdenk2729af92004-05-03 20:45:30 +00003825See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003826
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828Monitor Commands - Overview:
3829============================
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk2729af92004-05-03 20:45:30 +00003831go - start application at address 'addr'
3832run - run commands in an environment variable
3833bootm - boot application image from memory
3834bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003835bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003836tftpboot- boot image via network using TFTP protocol
3837 and env variables "ipaddr" and "serverip"
3838 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003839tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003840rarpboot- boot image via network using RARP/TFTP protocol
3841diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3842loads - load S-Record file over serial line
3843loadb - load binary file over serial line (kermit mode)
3844md - memory display
3845mm - memory modify (auto-incrementing)
3846nm - memory modify (constant address)
3847mw - memory write (fill)
3848cp - memory copy
3849cmp - memory compare
3850crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003851i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003852sspi - SPI utility commands
3853base - print or set address offset
3854printenv- print environment variables
3855setenv - set environment variables
3856saveenv - save environment variables to persistent storage
3857protect - enable or disable FLASH write protection
3858erase - erase FLASH memory
3859flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003860nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003861bdinfo - print Board Info structure
3862iminfo - print header information for application image
3863coninfo - print console devices and informations
3864ide - IDE sub-system
3865loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003866loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003867mtest - simple RAM test
3868icache - enable or disable instruction cache
3869dcache - enable or disable data cache
3870reset - Perform RESET of the CPU
3871echo - echo args to console
3872version - print monitor version
3873help - print online help
3874? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003875
wdenkc6097192002-11-03 00:24:07 +00003876
wdenk2729af92004-05-03 20:45:30 +00003877Monitor Commands - Detailed Description:
3878========================================
wdenkc6097192002-11-03 00:24:07 +00003879
wdenk2729af92004-05-03 20:45:30 +00003880TODO.
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003883
3884
wdenk2729af92004-05-03 20:45:30 +00003885Environment Variables:
3886======================
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk2729af92004-05-03 20:45:30 +00003888U-Boot supports user configuration using Environment Variables which
3889can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk2729af92004-05-03 20:45:30 +00003891Environment Variables are set using "setenv", printed using
3892"printenv", and saved to Flash using "saveenv". Using "setenv"
3893without a value can be used to delete a variable from the
3894environment. As long as you don't save the environment you are
3895working with an in-memory copy. In case the Flash area containing the
3896environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003897
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003898Some configuration options can be set using Environment Variables.
3899
3900List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003907
wdenk2729af92004-05-03 20:45:30 +00003908 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk2729af92004-05-03 20:45:30 +00003910 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003911
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003912 bootm_low - Memory range available for image processing in the bootm
3913 command can be restricted. This variable is given as
3914 a hexadecimal number and defines lowest address allowed
3915 for use by the bootm command. See also "bootm_size"
3916 environment variable. Address defined by "bootm_low" is
3917 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003918 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3919 bootm_mapsize.
3920
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003921 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003922 This variable is given as a hexadecimal number and it
3923 defines the size of the memory region starting at base
3924 address bootm_low that is accessible by the Linux kernel
3925 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3926 as the default value if it is defined, and bootm_size is
3927 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003928
3929 bootm_size - Memory range available for image processing in the bootm
3930 command can be restricted. This variable is given as
3931 a hexadecimal number and defines the size of the region
3932 allowed for use by the bootm command. See also "bootm_low"
3933 environment variable.
3934
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003935 updatefile - Location of the software update file on a TFTP server, used
3936 by the automatic software update feature. Please refer to
3937 documentation in doc/README.update for more details.
3938
wdenk2729af92004-05-03 20:45:30 +00003939 autoload - if set to "no" (any string beginning with 'n'),
3940 "bootp" will just load perform a lookup of the
3941 configuration from the BOOTP server, but not try to
3942 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk2729af92004-05-03 20:45:30 +00003944 autostart - if set to "yes", an image loaded using the "bootp",
3945 "rarpboot", "tftpboot" or "diskboot" commands will
3946 be automatically started (by internally calling
3947 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk2729af92004-05-03 20:45:30 +00003949 If set to "no", a standalone image passed to the
3950 "bootm" command will be copied to the load address
3951 (and eventually uncompressed), but NOT be started.
3952 This can be used to load and uncompress arbitrary
3953 data.
wdenkc6097192002-11-03 00:24:07 +00003954
David A. Longa28afca2011-07-09 16:40:19 -04003955 fdt_high - if set this restricts the maximum address that the
3956 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003957 For example, if you have a system with 1 GB memory
3958 at physical address 0x10000000, while Linux kernel
3959 only recognizes the first 704 MB as low memory, you
3960 may need to set fdt_high as 0x3C000000 to have the
3961 device tree blob be copied to the maximum address
3962 of the 704 MB low memory, so that Linux kernel can
3963 access it during the boot procedure.
3964
David A. Longa28afca2011-07-09 16:40:19 -04003965 If this is set to the special value 0xFFFFFFFF then
3966 the fdt will not be copied at all on boot. For this
3967 to work it must reside in writable memory, have
3968 sufficient padding on the end of it for u-boot to
3969 add the information it needs into it, and the memory
3970 must be accessible by the kernel.
3971
Simon Glasseea63e02011-10-24 19:15:34 +00003972 fdtcontroladdr- if set this is the address of the control flattened
3973 device tree used by U-Boot when CONFIG_OF_CONTROL is
3974 defined.
3975
wdenk17ea1172004-06-06 21:51:03 +00003976 i2cfast - (PPC405GP|PPC405EP only)
3977 if set to 'y' configures Linux I2C driver for fast
3978 mode (400kHZ). This environment variable is used in
3979 initialization code. So, for changes to be effective
3980 it must be saved and board must be reset.
3981
wdenk2729af92004-05-03 20:45:30 +00003982 initrd_high - restrict positioning of initrd images:
3983 If this variable is not set, initrd images will be
3984 copied to the highest possible address in RAM; this
3985 is usually what you want since it allows for
3986 maximum initrd size. If for some reason you want to
3987 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003988 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003989 variable to a value of "no" or "off" or "0".
3990 Alternatively, you can set it to a maximum upper
3991 address to use (U-Boot will still check that it
3992 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994 For instance, when you have a system with 16 MB
3995 RAM, and want to reserve 4 MB from use by Linux,
3996 you can do this by adding "mem=12M" to the value of
3997 the "bootargs" variable. However, now you must make
3998 sure that the initrd image is placed in the first
3999 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003 If you set initrd_high to 0xFFFFFFFF, this is an
4004 indication to U-Boot that all addresses are legal
4005 for the Linux kernel, including addresses in flash
4006 memory. In this case U-Boot will NOT COPY the
4007 ramdisk at all. This may be useful to reduce the
4008 boot time on your system, but requires that this
4009 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013 loadaddr - Default load address for commands like "bootp",
4014 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk2729af92004-05-03 20:45:30 +00004016 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk2729af92004-05-03 20:45:30 +00004018 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004019
wdenk2729af92004-05-03 20:45:30 +00004020 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004025
Mike Frysingere2a53452011-10-02 10:01:27 +00004026 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004027
Mike Frysingere2a53452011-10-02 10:01:27 +00004028 ethact - controls which interface is currently active.
4029 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004030
Heiko Schocher48690d82010-07-20 17:45:02 +02004031 => setenv ethact FEC
4032 => ping 192.168.0.1 # traffic sent on FEC
4033 => setenv ethact SCC
4034 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004035
Matthias Fuchse1692572008-01-17 07:45:05 +01004036 ethrotate - When set to "no" U-Boot does not go through all
4037 available network interfaces.
4038 It just stays at the currently selected interface.
4039
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004040 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004041 either succeed or fail without retrying.
4042 When set to "once" the network operation will
4043 fail when all the available network interfaces
4044 are tried once without success.
4045 Useful on scripts which control the retry operation
4046 themselves.
wdenkc6097192002-11-03 00:24:07 +00004047
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004048 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004049
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004050 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07004051 changing the console to be empty. If "yes" it will be
4052 made silent. If "no" it will not be made silent. If
4053 unset, then it will be made silent if the U-Boot console
4054 is silent.
4055
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004056 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004057 UDP source port.
4058
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004059 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004060 destination port instead of the Well Know Port 69.
4061
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004062 tftpblocksize - Block size to use for TFTP transfers; if not set,
4063 we use the TFTP server's default block size
4064
4065 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4066 seconds, minimum value is 1000 = 1 second). Defines
4067 when a packet is considered to be lost so it has to
4068 be retransmitted. The default is 5000 = 5 seconds.
4069 Lowering this value may make downloads succeed
4070 faster in networks with high packet loss rates or
4071 with unreliable TFTP servers.
4072
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004073 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4074 unit, minimum value = 0). Defines how many timeouts
4075 can happen during a single file transfer before that
4076 transfer is aborted. The default is 10, and 0 means
4077 'no timeouts allowed'. Increasing this value may help
4078 downloads succeed with high packet loss rates, or with
4079 unreliable TFTP servers or client hardware.
4080
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004081 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004082 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004083 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004084
Alexandre Messier50768f52016-02-01 17:08:57 -05004085 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4086 Unsigned value, in milliseconds. If not set, the period will
4087 be either the default (28000), or a value based on
4088 CONFIG_NET_RETRY_COUNT, if defined. This value has
4089 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4090
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004091The following image location variables contain the location of images
4092used in booting. The "Image" column gives the role of the image and is
4093not an environment variable name. The other columns are environment
4094variable names. "File Name" gives the name of the file on a TFTP
4095server, "RAM Address" gives the location in RAM the image will be
4096loaded to, and "Flash Location" gives the image's address in NOR
4097flash or offset in NAND flash.
4098
4099*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004100boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004101boards use these variables for other purposes.
4102
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004103Image File Name RAM Address Flash Location
4104----- --------- ----------- --------------
4105u-boot u-boot u-boot_addr_r u-boot_addr
4106Linux kernel bootfile kernel_addr_r kernel_addr
4107device tree blob fdtfile fdt_addr_r fdt_addr
4108ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004109
wdenk2729af92004-05-03 20:45:30 +00004110The following environment variables may be used and automatically
4111updated by the network boot commands ("bootp" and "rarpboot"),
4112depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114 bootfile - see above
4115 dnsip - IP address of your Domain Name Server
4116 dnsip2 - IP address of your secondary Domain Name Server
4117 gatewayip - IP address of the Gateway (Router) to use
4118 hostname - Target hostname
4119 ipaddr - see above
4120 netmask - Subnet Mask
4121 rootpath - Pathname of the root filesystem on the NFS server
4122 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004123
wdenka3d991b2004-04-15 21:48:45 +00004124
wdenk2729af92004-05-03 20:45:30 +00004125There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127 serial# - contains hardware identification information such
4128 as type string and/or serial number
4129 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131These variables can be set only once (usually during manufacturing of
4132the board). U-Boot refuses to delete or overwrite these variables
4133once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004134
4135
wdenk2729af92004-05-03 20:45:30 +00004136Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138 ver - Contains the U-Boot version string as printed
4139 with the "version" command. This variable is
4140 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004141
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143Please note that changes to some configuration parameters may take
4144only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004145
stroesec1551ea2003-04-04 15:53:41 +00004146
Joe Hershberger170ab112012-12-11 22:16:24 -06004147Callback functions for environment variables:
4148---------------------------------------------
4149
4150For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004151when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004152be associated with arbitrary variables. On creation, overwrite, or
4153deletion, the callback will provide the opportunity for some side
4154effect to happen or for the change to be rejected.
4155
4156The callbacks are named and associated with a function using the
4157U_BOOT_ENV_CALLBACK macro in your board or driver code.
4158
4159These callbacks are associated with variables in one of two ways. The
4160static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4161in the board configuration to a string that defines a list of
4162associations. The list must be in the following format:
4163
4164 entry = variable_name[:callback_name]
4165 list = entry[,list]
4166
4167If the callback name is not specified, then the callback is deleted.
4168Spaces are also allowed anywhere in the list.
4169
4170Callbacks can also be associated by defining the ".callbacks" variable
4171with the same list format above. Any association in ".callbacks" will
4172override any association in the static list. You can define
4173CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004174".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004175
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004176If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4177regular expression. This allows multiple variables to be connected to
4178the same callback without explicitly listing them all out.
4179
Joe Hershberger170ab112012-12-11 22:16:24 -06004180
wdenk2729af92004-05-03 20:45:30 +00004181Command Line Parsing:
4182=====================
stroesec1551ea2003-04-04 15:53:41 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184There are two different command line parsers available with U-Boot:
4185the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187Old, simple command line parser:
4188--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190- supports environment variables (through setenv / saveenv commands)
4191- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004192- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004193- special characters ('$', ';') can be escaped by prefixing with '\',
4194 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004195 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004196- You can also escape text by enclosing in single apostrophes, for example:
4197 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004198
wdenk2729af92004-05-03 20:45:30 +00004199Hush shell:
4200-----------
wdenkf07771c2003-05-28 08:06:31 +00004201
wdenk2729af92004-05-03 20:45:30 +00004202- similar to Bourne shell, with control structures like
4203 if...then...else...fi, for...do...done; while...do...done,
4204 until...do...done, ...
4205- supports environment ("global") variables (through setenv / saveenv
4206 commands) and local shell variables (through standard shell syntax
4207 "name=value"); only environment variables can be used with "run"
4208 command
wdenkf07771c2003-05-28 08:06:31 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210General rules:
4211--------------
wdenkf07771c2003-05-28 08:06:31 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213(1) If a command line (or an environment variable executed by a "run"
4214 command) contains several commands separated by semicolon, and
4215 one of these commands fails, then the remaining commands will be
4216 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004217
wdenk2729af92004-05-03 20:45:30 +00004218(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004219 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004220 command will cause "run" to terminate, i. e. the remaining
4221 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004222
wdenk2729af92004-05-03 20:45:30 +00004223Note for Redundant Ethernet Interfaces:
4224=======================================
wdenkf07771c2003-05-28 08:06:31 +00004225
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004226Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004227such configurations and is capable of automatic selection of a
4228"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004229
wdenk2729af92004-05-03 20:45:30 +00004230Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4231MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4232"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004233
wdenk2729af92004-05-03 20:45:30 +00004234If the network interface stores some valid MAC address (for instance
4235in SROM), this is used as default address if there is NO correspon-
4236ding setting in the environment; if the corresponding environment
4237variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239o If the SROM has a valid MAC address, and there is no address in the
4240 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242o If there is no valid address in the SROM, and a definition in the
4243 environment exists, then the value from the environment variable is
4244 used.
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246o If both the SROM and the environment contain a MAC address, and
4247 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk2729af92004-05-03 20:45:30 +00004249o If both the SROM and the environment contain a MAC address, and the
4250 addresses differ, the value from the environment is used and a
4251 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004254 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4255 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004256
Ben Warrenecee9322010-04-26 11:11:46 -07004257If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004258will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004259may be skipped by setting the appropriate 'ethmacskip' environment variable.
4260The naming convention is as follows:
4261"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004262
wdenk2729af92004-05-03 20:45:30 +00004263Image Formats:
4264==============
wdenkc6097192002-11-03 00:24:07 +00004265
Marian Balakowicz3310c542008-03-12 12:13:13 +01004266U-Boot is capable of booting (and performing other auxiliary operations on)
4267images in two formats:
4268
4269New uImage format (FIT)
4270-----------------------
4271
4272Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4273to Flattened Device Tree). It allows the use of images with multiple
4274components (several kernels, ramdisks, etc.), with contents protected by
4275SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4276
4277
4278Old uImage format
4279-----------------
4280
4281Old image format is based on binary files which can be basically anything,
4282preceded by a special header; see the definitions in include/image.h for
4283details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004284
wdenk2729af92004-05-03 20:45:30 +00004285* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4286 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004287 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4288 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4289 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004290* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004291 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004292 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004293* Compression Type (uncompressed, gzip, bzip2)
4294* Load Address
4295* Entry Point
4296* Image Name
4297* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004298
wdenk2729af92004-05-03 20:45:30 +00004299The header is marked by a special Magic Number, and both the header
4300and the data portions of the image are secured against corruption by
4301CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004302
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304Linux Support:
4305==============
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk2729af92004-05-03 20:45:30 +00004307Although U-Boot should support any OS or standalone application
4308easily, the main focus has always been on Linux during the design of
4309U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311U-Boot includes many features that so far have been part of some
4312special "boot loader" code within the Linux kernel. Also, any
4313"initrd" images to be used are no longer part of one big Linux image;
4314instead, kernel and "initrd" are separate images. This implementation
4315serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317- the same features can be used for other OS or standalone
4318 applications (for instance: using compressed images to reduce the
4319 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004320
wdenk2729af92004-05-03 20:45:30 +00004321- it becomes much easier to port new Linux kernel versions because
4322 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324- the same Linux kernel image can now be used with different "initrd"
4325 images; of course this also means that different kernel images can
4326 be run with the same "initrd". This makes testing easier (you don't
4327 have to build a new "zImage.initrd" Linux image when you just
4328 change a file in your "initrd"). Also, a field-upgrade of the
4329 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004330
wdenkc6097192002-11-03 00:24:07 +00004331
wdenk2729af92004-05-03 20:45:30 +00004332Linux HOWTO:
4333============
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335Porting Linux to U-Boot based systems:
4336---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338U-Boot cannot save you from doing all the necessary modifications to
4339configure the Linux device drivers for use with your target hardware
4340(no, we don't intend to provide a full virtual machine interface to
4341Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004342
Stefan Roesea47a12b2010-04-15 16:07:28 +02004343But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345Just make sure your machine specific header file (for instance
4346include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004347Information structure as we define in include/asm-<arch>/u-boot.h,
4348and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004349as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004350
Simon Glass2eb31b12014-06-11 23:29:46 -06004351Note that U-Boot now has a driver model, a unified model for drivers.
4352If you are adding a new driver, plumb it into driver model. If there
4353is no uclass available, you are encouraged to create one. See
4354doc/driver-model.
4355
wdenkc6097192002-11-03 00:24:07 +00004356
wdenk2729af92004-05-03 20:45:30 +00004357Configuring the Linux kernel:
4358-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360No specific requirements for U-Boot. Make sure you have some root
4361device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004362
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364Building a Linux Image:
4365-----------------------
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk2729af92004-05-03 20:45:30 +00004367With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4368not used. If you use recent kernel source, a new build target
4369"uImage" will exist which automatically builds an image usable by
4370U-Boot. Most older kernels also have support for a "pImage" target,
4371which was introduced for our predecessor project PPCBoot and uses a
4372100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374Example:
wdenkc6097192002-11-03 00:24:07 +00004375
Holger Freytherab584d62014-08-04 09:26:05 +02004376 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004377 make oldconfig
4378 make dep
4379 make uImage
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +00004381The "uImage" build target uses a special tool (in 'tools/mkimage') to
4382encapsulate a compressed Linux kernel image with header information,
4383CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk2729af92004-05-03 20:45:30 +00004385* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk2729af92004-05-03 20:45:30 +00004387* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389 ${CROSS_COMPILE}-objcopy -O binary \
4390 -R .note -R .comment \
4391 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004398
wdenk2729af92004-05-03 20:45:30 +00004399 mkimage -A ppc -O linux -T kernel -C gzip \
4400 -a 0 -e 0 -n "Linux Kernel Image" \
4401 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004402
wdenk24ee89b2002-11-03 17:56:27 +00004403
wdenk2729af92004-05-03 20:45:30 +00004404The "mkimage" tool can also be used to create ramdisk images for use
4405with U-Boot, either separated from the Linux kernel image, or
4406combined into one file. "mkimage" encapsulates the images with a 64
4407byte header containing information about target architecture,
4408operating system, image type, compression method, entry points, time
4409stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004410
wdenk2729af92004-05-03 20:45:30 +00004411"mkimage" can be called in two ways: to verify existing images and
4412print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004413
wdenk2729af92004-05-03 20:45:30 +00004414In the first form (with "-l" option) mkimage lists the information
4415contained in the header of an existing U-Boot image; this includes
4416checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004417
wdenk2729af92004-05-03 20:45:30 +00004418 tools/mkimage -l image
4419 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004420
wdenk2729af92004-05-03 20:45:30 +00004421The second form (with "-d" option) is used to build a U-Boot image
4422from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4425 -n name -d data_file image
4426 -A ==> set architecture to 'arch'
4427 -O ==> set operating system to 'os'
4428 -T ==> set image type to 'type'
4429 -C ==> set compression type 'comp'
4430 -a ==> set load address to 'addr' (hex)
4431 -e ==> set entry point to 'ep' (hex)
4432 -n ==> set image name to 'name'
4433 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004434
wdenk69459792004-05-29 16:53:29 +00004435Right now, all Linux kernels for PowerPC systems use the same load
4436address (0x00000000), but the entry point address depends on the
4437kernel version:
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk2729af92004-05-03 20:45:30 +00004439- 2.2.x kernels have the entry point at 0x0000000C,
4440- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004443
wdenk2729af92004-05-03 20:45:30 +00004444 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4445 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004446 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004447 > examples/uImage.TQM850L
4448 Image Name: 2.4.4 kernel for TQM850L
4449 Created: Wed Jul 19 02:34:59 2000
4450 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4451 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4452 Load Address: 0x00000000
4453 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk2729af92004-05-03 20:45:30 +00004457 -> tools/mkimage -l examples/uImage.TQM850L
4458 Image Name: 2.4.4 kernel for TQM850L
4459 Created: Wed Jul 19 02:34:59 2000
4460 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4461 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4462 Load Address: 0x00000000
4463 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk2729af92004-05-03 20:45:30 +00004465NOTE: for embedded systems where boot time is critical you can trade
4466speed for memory and install an UNCOMPRESSED image instead: this
4467needs more space in Flash, but boots much faster since it does not
4468need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004469
Stefan Roesea47a12b2010-04-15 16:07:28 +02004470 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004471 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4472 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004473 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004474 > examples/uImage.TQM850L-uncompressed
4475 Image Name: 2.4.4 kernel for TQM850L
4476 Created: Wed Jul 19 02:34:59 2000
4477 Image Type: PowerPC Linux Kernel Image (uncompressed)
4478 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4479 Load Address: 0x00000000
4480 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004481
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk2729af92004-05-03 20:45:30 +00004483Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4484when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486 -> tools/mkimage -n 'Simple Ramdisk Image' \
4487 > -A ppc -O linux -T ramdisk -C gzip \
4488 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4489 Image Name: Simple Ramdisk Image
4490 Created: Wed Jan 12 14:01:50 2000
4491 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4492 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4493 Load Address: 0x00000000
4494 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004495
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004496The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4497option performs the converse operation of the mkimage's second form (the "-d"
4498option). Given an image built by mkimage, the dumpimage extracts a "data file"
4499from the image:
4500
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004501 tools/dumpimage -i image -T type -p position data_file
4502 -i ==> extract from the 'image' a specific 'data_file'
4503 -T ==> set image type to 'type'
4504 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004505
wdenkdb01a2e2004-04-15 23:14:49 +00004506
wdenk2729af92004-05-03 20:45:30 +00004507Installing a Linux Image:
4508-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004509
wdenk2729af92004-05-03 20:45:30 +00004510To downloading a U-Boot image over the serial (console) interface,
4511you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004512
wdenk2729af92004-05-03 20:45:30 +00004513 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004514
wdenk2729af92004-05-03 20:45:30 +00004515The 'objcopy' does not understand the information in the U-Boot
4516image header, so the resulting S-Record file will be relative to
4517address 0x00000000. To load it to a given address, you need to
4518specify the target address as 'offset' parameter with the 'loads'
4519command.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521Example: install the image to address 0x40100000 (which on the
4522TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004525
wdenk2729af92004-05-03 20:45:30 +00004526 .......... done
4527 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk2729af92004-05-03 20:45:30 +00004529 => loads 40100000
4530 ## Ready for S-Record download ...
4531 ~>examples/image.srec
4532 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4533 ...
4534 15989 15990 15991 15992
4535 [file transfer complete]
4536 [connected]
4537 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004538
4539
wdenk2729af92004-05-03 20:45:30 +00004540You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004541this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004542corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk2729af92004-05-03 20:45:30 +00004544 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk2729af92004-05-03 20:45:30 +00004546 ## Checking Image at 40100000 ...
4547 Image Name: 2.2.13 for initrd on TQM850L
4548 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4549 Data Size: 335725 Bytes = 327 kB = 0 MB
4550 Load Address: 00000000
4551 Entry Point: 0000000c
4552 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004553
4554
wdenk2729af92004-05-03 20:45:30 +00004555Boot Linux:
4556-----------
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk2729af92004-05-03 20:45:30 +00004558The "bootm" command is used to boot an application that is stored in
4559memory (RAM or Flash). In case of a Linux kernel image, the contents
4560of the "bootargs" environment variable is passed to the kernel as
4561parameters. You can check and modify this variable using the
4562"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004563
4564
wdenk2729af92004-05-03 20:45:30 +00004565 => printenv bootargs
4566 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk2729af92004-05-03 20:45:30 +00004568 => 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 +00004569
wdenk2729af92004-05-03 20:45:30 +00004570 => printenv bootargs
4571 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 +00004572
wdenk2729af92004-05-03 20:45:30 +00004573 => bootm 40020000
4574 ## Booting Linux kernel at 40020000 ...
4575 Image Name: 2.2.13 for NFS on TQM850L
4576 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4577 Data Size: 381681 Bytes = 372 kB = 0 MB
4578 Load Address: 00000000
4579 Entry Point: 0000000c
4580 Verifying Checksum ... OK
4581 Uncompressing Kernel Image ... OK
4582 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
4583 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4584 time_init: decrementer frequency = 187500000/60
4585 Calibrating delay loop... 49.77 BogoMIPS
4586 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4587 ...
wdenkc6097192002-11-03 00:24:07 +00004588
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004589If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004590the memory addresses of both the kernel and the initrd image (PPBCOOT
4591format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk2729af92004-05-03 20:45:30 +00004595 ## Checking Image at 40100000 ...
4596 Image Name: 2.2.13 for initrd on TQM850L
4597 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4598 Data Size: 335725 Bytes = 327 kB = 0 MB
4599 Load Address: 00000000
4600 Entry Point: 0000000c
4601 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk2729af92004-05-03 20:45:30 +00004603 ## Checking Image at 40200000 ...
4604 Image Name: Simple Ramdisk Image
4605 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4606 Data Size: 566530 Bytes = 553 kB = 0 MB
4607 Load Address: 00000000
4608 Entry Point: 00000000
4609 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk2729af92004-05-03 20:45:30 +00004611 => bootm 40100000 40200000
4612 ## Booting Linux kernel at 40100000 ...
4613 Image Name: 2.2.13 for initrd on TQM850L
4614 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4615 Data Size: 335725 Bytes = 327 kB = 0 MB
4616 Load Address: 00000000
4617 Entry Point: 0000000c
4618 Verifying Checksum ... OK
4619 Uncompressing Kernel Image ... OK
4620 ## Loading RAMDisk Image at 40200000 ...
4621 Image Name: Simple Ramdisk Image
4622 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4623 Data Size: 566530 Bytes = 553 kB = 0 MB
4624 Load Address: 00000000
4625 Entry Point: 00000000
4626 Verifying Checksum ... OK
4627 Loading Ramdisk ... OK
4628 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
4629 Boot arguments: root=/dev/ram
4630 time_init: decrementer frequency = 187500000/60
4631 Calibrating delay loop... 49.77 BogoMIPS
4632 ...
4633 RAMDISK: Compressed image found at block 0
4634 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636 bash#
wdenkc6097192002-11-03 00:24:07 +00004637
Matthew McClintock02677682006-06-28 10:41:37 -05004638Boot Linux and pass a flat device tree:
4639-----------
4640
4641First, U-Boot must be compiled with the appropriate defines. See the section
4642titled "Linux Kernel Interface" above for a more in depth explanation. The
4643following is an example of how to start a kernel and pass an updated
4644flat device tree:
4645
4646=> print oftaddr
4647oftaddr=0x300000
4648=> print oft
4649oft=oftrees/mpc8540ads.dtb
4650=> tftp $oftaddr $oft
4651Speed: 1000, full duplex
4652Using TSEC0 device
4653TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4654Filename 'oftrees/mpc8540ads.dtb'.
4655Load address: 0x300000
4656Loading: #
4657done
4658Bytes transferred = 4106 (100a hex)
4659=> tftp $loadaddr $bootfile
4660Speed: 1000, full duplex
4661Using TSEC0 device
4662TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4663Filename 'uImage'.
4664Load address: 0x200000
4665Loading:############
4666done
4667Bytes transferred = 1029407 (fb51f hex)
4668=> print loadaddr
4669loadaddr=200000
4670=> print oftaddr
4671oftaddr=0x300000
4672=> bootm $loadaddr - $oftaddr
4673## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004674 Image Name: Linux-2.6.17-dirty
4675 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4676 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004677 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004678 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004679 Verifying Checksum ... OK
4680 Uncompressing Kernel Image ... OK
4681Booting using flat device tree at 0x300000
4682Using MPC85xx ADS machine description
4683Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4684[snip]
4685
4686
wdenk2729af92004-05-03 20:45:30 +00004687More About U-Boot Image Types:
4688------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004691
wdenk2729af92004-05-03 20:45:30 +00004692 "Standalone Programs" are directly runnable in the environment
4693 provided by U-Boot; it is expected that (if they behave
4694 well) you can continue to work in U-Boot after return from
4695 the Standalone Program.
4696 "OS Kernel Images" are usually images of some Embedded OS which
4697 will take over control completely. Usually these programs
4698 will install their own set of exception handlers, device
4699 drivers, set up the MMU, etc. - this means, that you cannot
4700 expect to re-enter U-Boot except by resetting the CPU.
4701 "RAMDisk Images" are more or less just data blocks, and their
4702 parameters (address, size) are passed to an OS kernel that is
4703 being started.
4704 "Multi-File Images" contain several images, typically an OS
4705 (Linux) kernel image and one or more data images like
4706 RAMDisks. This construct is useful for instance when you want
4707 to boot over the network using BOOTP etc., where the boot
4708 server provides just a single image file, but you want to get
4709 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004710
wdenk2729af92004-05-03 20:45:30 +00004711 "Multi-File Images" start with a list of image sizes, each
4712 image size (in bytes) specified by an "uint32_t" in network
4713 byte order. This list is terminated by an "(uint32_t)0".
4714 Immediately after the terminating 0 follow the images, one by
4715 one, all aligned on "uint32_t" boundaries (size rounded up to
4716 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718 "Firmware Images" are binary images containing firmware (like
4719 U-Boot or FPGA images) which usually will be programmed to
4720 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722 "Script files" are command sequences that will be executed by
4723 U-Boot's command interpreter; this feature is especially
4724 useful when you configure U-Boot to use a real shell (hush)
4725 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004726
Marek Vasut44f074c2012-03-14 21:52:45 +00004727Booting the Linux zImage:
4728-------------------------
4729
4730On some platforms, it's possible to boot Linux zImage. This is done
4731using the "bootz" command. The syntax of "bootz" command is the same
4732as the syntax of "bootm" command.
4733
Tom Rini8ac28562013-05-16 11:40:11 -04004734Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004735kernel with raw initrd images. The syntax is slightly different, the
4736address of the initrd must be augmented by it's size, in the following
4737format: "<initrd addres>:<initrd size>".
4738
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740Standalone HOWTO:
4741=================
wdenkc6097192002-11-03 00:24:07 +00004742
wdenk2729af92004-05-03 20:45:30 +00004743One of the features of U-Boot is that you can dynamically load and
4744run "standalone" applications, which can use some resources of
4745U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk2729af92004-05-03 20:45:30 +00004749"Hello World" Demo:
4750-------------------
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk2729af92004-05-03 20:45:30 +00004752'examples/hello_world.c' contains a small "Hello World" Demo
4753application; it is automatically compiled when you build U-Boot.
4754It's configured to run at address 0x00040004, so you can play with it
4755like that:
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk2729af92004-05-03 20:45:30 +00004757 => loads
4758 ## Ready for S-Record download ...
4759 ~>examples/hello_world.srec
4760 1 2 3 4 5 6 7 8 9 10 11 ...
4761 [file transfer complete]
4762 [connected]
4763 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk2729af92004-05-03 20:45:30 +00004765 => go 40004 Hello World! This is a test.
4766 ## Starting application at 0x00040004 ...
4767 Hello World
4768 argc = 7
4769 argv[0] = "40004"
4770 argv[1] = "Hello"
4771 argv[2] = "World!"
4772 argv[3] = "This"
4773 argv[4] = "is"
4774 argv[5] = "a"
4775 argv[6] = "test."
4776 argv[7] = "<NULL>"
4777 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk2729af92004-05-03 20:45:30 +00004781Another example, which demonstrates how to register a CPM interrupt
4782handler with the U-Boot code, can be found in 'examples/timer.c'.
4783Here, a CPM timer is set up to generate an interrupt every second.
4784The interrupt service routine is trivial, just printing a '.'
4785character, but this is just a demo program. The application can be
4786controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk2729af92004-05-03 20:45:30 +00004788 ? - print current values og the CPM Timer registers
4789 b - enable interrupts and start timer
4790 e - stop timer and disable interrupts
4791 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793 => loads
4794 ## Ready for S-Record download ...
4795 ~>examples/timer.srec
4796 1 2 3 4 5 6 7 8 9 10 11 ...
4797 [file transfer complete]
4798 [connected]
4799 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004800
wdenk2729af92004-05-03 20:45:30 +00004801 => go 40004
4802 ## Starting application at 0x00040004 ...
4803 TIMERS=0xfff00980
4804 Using timer 1
4805 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk2729af92004-05-03 20:45:30 +00004807Hit 'b':
4808 [q, b, e, ?] Set interval 1000000 us
4809 Enabling timer
4810Hit '?':
4811 [q, b, e, ?] ........
4812 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4813Hit '?':
4814 [q, b, e, ?] .
4815 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4816Hit '?':
4817 [q, b, e, ?] .
4818 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4819Hit '?':
4820 [q, b, e, ?] .
4821 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4822Hit 'e':
4823 [q, b, e, ?] ...Stopping timer
4824Hit 'q':
4825 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004826
4827
wdenk2729af92004-05-03 20:45:30 +00004828Minicom warning:
4829================
wdenk85ec0bc2003-03-31 16:34:49 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831Over time, many people have reported problems when trying to use the
4832"minicom" terminal emulation program for serial download. I (wd)
4833consider minicom to be broken, and recommend not to use it. Under
4834Unix, I recommend to use C-Kermit for general purpose use (and
4835especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004836use "cu" for S-Record download ("loads" command). See
4837http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4838for help with kermit.
4839
wdenk85ec0bc2003-03-31 16:34:49 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841Nevertheless, if you absolutely want to use it try adding this
4842configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844 Name Program Name U/D FullScr IO-Red. Multi
4845 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4846 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004847
4848
wdenk2729af92004-05-03 20:45:30 +00004849NetBSD Notes:
4850=============
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852Starting at version 0.9.2, U-Boot supports NetBSD both as host
4853(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk2729af92004-05-03 20:45:30 +00004855Building requires a cross environment; it is known to work on
4856NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4857need gmake since the Makefiles are not compatible with BSD make).
4858Note that the cross-powerpc package does not install include files;
4859attempting to build U-Boot will fail because <machine/ansi.h> is
4860missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862 # cd /usr/pkg/cross/powerpc-netbsd/include
4863 # mkdir powerpc
4864 # ln -s powerpc machine
4865 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4866 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk2729af92004-05-03 20:45:30 +00004868Native builds *don't* work due to incompatibilities between native
4869and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk2729af92004-05-03 20:45:30 +00004871Booting assumes that (the first part of) the image booted is a
4872stage-2 loader which in turn loads and then invokes the kernel
4873proper. Loader sources will eventually appear in the NetBSD source
4874tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004875meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004876
4877
wdenk2729af92004-05-03 20:45:30 +00004878Implementation Internals:
4879=========================
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk2729af92004-05-03 20:45:30 +00004881The following is not intended to be a complete description of every
4882implementation detail. However, it should help to understand the
4883inner workings of U-Boot and make it easier to port it to custom
4884hardware.
wdenkc6097192002-11-03 00:24:07 +00004885
4886
wdenk2729af92004-05-03 20:45:30 +00004887Initial Stack, Global Data:
4888---------------------------
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890The implementation of U-Boot is complicated by the fact that U-Boot
4891starts running out of ROM (flash memory), usually without access to
4892system RAM (because the memory controller is not initialized yet).
4893This means that we don't have writable Data or BSS segments, and BSS
4894is not initialized as zero. To be able to get a C environment working
4895at all, we have to allocate at least a minimal stack. Implementation
4896options for this are defined and restricted by the CPU used: Some CPU
4897models provide on-chip memory (like the IMMR area on MPC8xx and
4898MPC826x processors), on others (parts of) the data cache can be
4899locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004900
Wolfgang Denk218ca722008-03-26 10:40:12 +01004901 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004902 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004903
wdenk2729af92004-05-03 20:45:30 +00004904 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4905 From: "Chris Hallinan" <clh@net1plus.com>
4906 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4907 ...
wdenk43d96162003-03-06 00:02:04 +00004908
wdenk2729af92004-05-03 20:45:30 +00004909 Correct me if I'm wrong, folks, but the way I understand it
4910 is this: Using DCACHE as initial RAM for Stack, etc, does not
4911 require any physical RAM backing up the cache. The cleverness
4912 is that the cache is being used as a temporary supply of
4913 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004914 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004915 can see how this works by studying the cache architecture and
4916 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004917
wdenk2729af92004-05-03 20:45:30 +00004918 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4919 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004920 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004921 option should work for you. Using CS 4 should be fine if your
4922 board designers haven't used it for something that would
4923 cause you grief during the initial boot! It is frequently not
4924 used.
wdenk43d96162003-03-06 00:02:04 +00004925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004926 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004927 with your processor/board/system design. The default value
4928 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004929 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004930 than your SDRAM module. If you have a 64MB SDRAM module, set
4931 it above 400_0000. Just make sure your board has no resources
4932 that are supposed to respond to that address! That code in
4933 start.S has been around a while and should work as is when
4934 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936 -Chris Hallinan
4937 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004938
wdenk2729af92004-05-03 20:45:30 +00004939It is essential to remember this, since it has some impact on the C
4940code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004941
wdenk2729af92004-05-03 20:45:30 +00004942* Initialized global data (data segment) is read-only. Do not attempt
4943 to write it.
wdenkc6097192002-11-03 00:24:07 +00004944
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004945* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004946 as zero data - BSS segment) at all - this is undefined, initiali-
4947 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk2729af92004-05-03 20:45:30 +00004949* Stack space is very limited. Avoid big data buffers or things like
4950 that.
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk2729af92004-05-03 20:45:30 +00004952Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004953normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004954turned out that the implementation of U-Boot can be greatly
4955simplified by making a global data structure (gd_t) available to all
4956functions. We could pass a pointer to this data as argument to _all_
4957functions, but this would bloat the code. Instead we use a feature of
4958the GCC compiler (Global Register Variables) to share the data: we
4959place a pointer (gd) to the global data into a register which we
4960reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk2729af92004-05-03 20:45:30 +00004962When choosing a register for such a purpose we are restricted by the
4963relevant (E)ABI specifications for the current architecture, and by
4964GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk2729af92004-05-03 20:45:30 +00004966For PowerPC, the following registers have specific use:
4967 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004968 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004969 R3-R4: parameter passing and return values
4970 R5-R10: parameter passing
4971 R13: small data area pointer
4972 R30: GOT pointer
4973 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004974
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004975 (U-Boot also uses R12 as internal GOT pointer. r12
4976 is a volatile register so r12 needs to be reset when
4977 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004978
Wolfgang Denke7670f62008-02-14 22:43:22 +01004979 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981 Note: on PPC, we could use a static initializer (since the
4982 address of the global data structure is known at compile time),
4983 but it turned out that reserving a register results in somewhat
4984 smaller code - although the code savings are not that big (on
4985 average for all boards 752 bytes for the whole U-Boot image,
4986 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990 R0: function argument word/integer result
4991 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004992 R9: platform specific
4993 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004994 R11: argument (frame) pointer
4995 R12: temporary workspace
4996 R13: stack pointer
4997 R14: link register
4998 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004999
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005000 ==> U-Boot will use R9 to hold a pointer to the global data
5001
5002 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005003
Thomas Chou0df01fd32010-05-21 11:08:03 +08005004On Nios II, the ABI is documented here:
5005 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5006
5007 ==> U-Boot will use gp to hold a pointer to the global data
5008
5009 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5010 to access small data sections, so gp is free.
5011
Macpaul Linafc1ce82011-10-19 20:41:11 +00005012On NDS32, the following registers are used:
5013
5014 R0-R1: argument/return
5015 R2-R5: argument
5016 R15: temporary register for assembler
5017 R16: trampoline register
5018 R28: frame pointer (FP)
5019 R29: global pointer (GP)
5020 R30: link register (LP)
5021 R31: stack pointer (SP)
5022 PC: program counter (PC)
5023
5024 ==> U-Boot will use R10 to hold a pointer to the global data
5025
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005026NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5027or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005028
wdenk2729af92004-05-03 20:45:30 +00005029Memory Management:
5030------------------
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk2729af92004-05-03 20:45:30 +00005032U-Boot runs in system state and uses physical addresses, i.e. the
5033MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005034
wdenk2729af92004-05-03 20:45:30 +00005035The available memory is mapped to fixed addresses using the memory
5036controller. In this process, a contiguous block is formed for each
5037memory type (Flash, SDRAM, SRAM), even when it consists of several
5038physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk2729af92004-05-03 20:45:30 +00005040U-Boot is installed in the first 128 kB of the first Flash bank (on
5041TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5042booting and sizing and initializing DRAM, the code relocates itself
5043to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005044memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005045configuration setting]. Below that, a structure with global Board
5046Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk2729af92004-05-03 20:45:30 +00005048Additionally, some exception handler code is copied to the low 8 kB
5049of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051So a typical memory configuration with 16 MB of DRAM could look like
5052this:
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk2729af92004-05-03 20:45:30 +00005054 0x0000 0000 Exception Vector code
5055 :
5056 0x0000 1FFF
5057 0x0000 2000 Free for Application Use
5058 :
5059 :
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061 :
5062 :
5063 0x00FB FF20 Monitor Stack (Growing downward)
5064 0x00FB FFAC Board Info Data and permanent copy of global data
5065 0x00FC 0000 Malloc Arena
5066 :
5067 0x00FD FFFF
5068 0x00FE 0000 RAM Copy of Monitor Code
5069 ... eventually: LCD or video framebuffer
5070 ... eventually: pRAM (Protected RAM - unchanged by reset)
5071 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005072
5073
wdenk2729af92004-05-03 20:45:30 +00005074System Initialization:
5075----------------------
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005078(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005079configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005080To be able to re-map memory U-Boot then jumps to its link address.
5081To be able to implement the initialization code in C, a (small!)
5082initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02005083which provide such a feature like), or in a locked part of the data
5084cache. After that, U-Boot initializes the CPU core, the caches and
5085the SIU.
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087Next, all (potentially) available memory banks are mapped using a
5088preliminary mapping. For example, we put them on 512 MB boundaries
5089(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5090on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5091programmed for SDRAM access. Using the temporary configuration, a
5092simple memory test is run that determines the size of the SDRAM
5093banks.
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095When there is more than one SDRAM bank, and the banks are of
5096different size, the largest is mapped first. For equal size, the first
5097bank (CS2#) is mapped first. The first mapping is always for address
50980x00000000, with any additional banks following immediately to create
5099contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005100
wdenk2729af92004-05-03 20:45:30 +00005101Then, the monitor installs itself at the upper end of the SDRAM area
5102and allocates memory for use by malloc() and for the global Board
5103Info data; also, the exception vector code is copied to the low RAM
5104pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk2729af92004-05-03 20:45:30 +00005106Only after this relocation will you have a "normal" C environment;
5107until that you are restricted in several ways, mostly because you are
5108running from ROM, and because the code will have to be relocated to a
5109new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005110
5111
wdenk2729af92004-05-03 20:45:30 +00005112U-Boot Porting Guide:
5113----------------------
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk2729af92004-05-03 20:45:30 +00005115[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5116list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005117
5118
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005119int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005120{
5121 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005122
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005123 signal(SIGALRM, no_more_time);
5124 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk2729af92004-05-03 20:45:30 +00005126 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005127 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005128 return 0;
5129 }
5130
wdenk2729af92004-05-03 20:45:30 +00005131 Download latest U-Boot source;
5132
Wolfgang Denk06682362008-12-30 22:56:11 +01005133 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005134
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005135 if (clueless)
5136 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk2729af92004-05-03 20:45:30 +00005138 while (learning) {
5139 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005140 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5141 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005142 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005143 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005144 }
wdenkc6097192002-11-03 00:24:07 +00005145
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005146 if (available_money > toLocalCurrency ($2500))
5147 Buy a BDI3000;
5148 else
wdenk2729af92004-05-03 20:45:30 +00005149 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005150
5151 if (a similar board exists) { /* hopefully... */
5152 cp -a board/<similar> board/<myboard>
5153 cp include/configs/<similar>.h include/configs/<myboard>.h
5154 } else {
5155 Create your own board support subdirectory;
5156 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005157 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005158 Edit new board/<myboard> files
5159 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005160
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005161 while (!accepted) {
5162 while (!running) {
5163 do {
5164 Add / modify source code;
5165 } until (compiles);
5166 Debug;
5167 if (clueless)
5168 email("Hi, I am having problems...");
5169 }
5170 Send patch file to the U-Boot email list;
5171 if (reasonable critiques)
5172 Incorporate improvements from email list code review;
5173 else
5174 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005175 }
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177 return 0;
5178}
5179
5180void no_more_time (int sig)
5181{
5182 hire_a_guru();
5183}
wdenkc6097192002-11-03 00:24:07 +00005184
5185
wdenk2729af92004-05-03 20:45:30 +00005186Coding Standards:
5187-----------------
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk2729af92004-05-03 20:45:30 +00005189All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005190coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005191"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005192
Detlev Zundel2c051652006-09-01 15:39:02 +02005193Source files originating from a different project (for example the
5194MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005195reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005196sources.
5197
5198Please note that U-Boot is implemented in C (and to some small parts in
5199Assembler); no C++ is used, so please do not use C++ style comments (//)
5200in your code.
wdenk2729af92004-05-03 20:45:30 +00005201
5202Please also stick to the following formatting rules:
5203- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005204- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005205- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005206- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005207- do not add trailing empty lines to source files
5208
5209Submissions which do not conform to the standards may be returned
5210with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005211
5212
wdenk2729af92004-05-03 20:45:30 +00005213Submitting Patches:
5214-------------------
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk2729af92004-05-03 20:45:30 +00005216Since the number of patches for U-Boot is growing, we need to
5217establish some rules. Submissions which do not conform to these rules
5218may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005219
Magnus Lilja0d28f342008-08-06 19:32:33 +02005220Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005221
Wolfgang Denk06682362008-12-30 22:56:11 +01005222Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5223see http://lists.denx.de/mailman/listinfo/u-boot
5224
wdenk2729af92004-05-03 20:45:30 +00005225When you send a patch, please include the following information with
5226it:
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk2729af92004-05-03 20:45:30 +00005228* For bug fixes: a description of the bug and how your patch fixes
5229 this bug. Please try to include a way of demonstrating that the
5230 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk2729af92004-05-03 20:45:30 +00005232* For new features: a description of the feature and your
5233 implementation.
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk2729af92004-05-03 20:45:30 +00005235* A CHANGELOG entry as plaintext (separate from the patch)
5236
Robert P. J. Day7207b362015-12-19 07:16:10 -05005237* For major contributions, add a MAINTAINERS file with your
5238 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005239
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005240* When you add support for a new board, don't forget to add a
5241 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005242
5243* If your patch adds new configuration options, don't forget to
5244 document these in the README file.
5245
Wolfgang Denk218ca722008-03-26 10:40:12 +01005246* The patch itself. If you are using git (which is *strongly*
5247 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005248 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005249 the U-Boot mailing list, you will avoid most of the common problems
5250 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005251
Wolfgang Denk218ca722008-03-26 10:40:12 +01005252 If you cannot use git, use "diff -purN OLD NEW". If your version of
5253 diff does not support these options, then get the latest version of
5254 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005255
Wolfgang Denk218ca722008-03-26 10:40:12 +01005256 The current directory when running this command shall be the parent
5257 directory of the U-Boot source tree (i. e. please make sure that
5258 your patch includes sufficient directory information for the
5259 affected files).
5260
5261 We prefer patches as plain text. MIME attachments are discouraged,
5262 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005263
5264* If one logical set of modifications affects or creates several
5265 files, all these changes shall be submitted in a SINGLE patch file.
5266
5267* Changesets that contain different, unrelated modifications shall be
5268 submitted as SEPARATE patches, one patch per changeset.
5269
5270
5271Notes:
5272
Simon Glass6de80f22016-07-27 20:33:08 -06005273* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005274 source tree and make sure that no errors or warnings are reported
5275 for any of the boards.
5276
5277* Keep your modifications to the necessary minimum: A patch
5278 containing several unrelated changes or arbitrary reformats will be
5279 returned with a request to re-formatting / split it.
5280
5281* If you modify existing code, make sure that your new code does not
5282 add to the memory footprint of the code ;-) Small is beautiful!
5283 When adding new features, these should compile conditionally only
5284 (using #ifdef), and the resulting code with the new feature
5285 disabled must not need more memory than the old code without your
5286 modification.
wdenk90dc6702005-05-03 14:12:25 +00005287
Wolfgang Denk06682362008-12-30 22:56:11 +01005288* Remember that there is a size limit of 100 kB per message on the
5289 u-boot mailing list. Bigger patches will be moderated. If they are
5290 reasonable and not too big, they will be acknowledged. But patches
5291 bigger than the size limit should be avoided.