blob: 1a7a788c4bf9dd9857cdede7b724faa94a827ada [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-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 Denk1234ce72013-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
wdenkce4832c2004-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. Day076ed9b2015-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. Day076ed9b2015-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. Day974ed2f2012-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. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-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 Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500146 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500147 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400148 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149/api Machine/arch independent API for external apps
150/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800151/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500153/configs Board default configuration files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400157/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Day076ed9b2015-12-19 07:16:10 -0500161/lib Library routines generic to all architectures
162/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500163/net Networking code
164/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500165/scripts Various build scripts and Makefiles
166/test Various unit test files
Peter Tysere4d1abc2010-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-VILLARD03836942008-10-16 15:01:15 +0200184 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000185
Robert P. J. Day076ed9b2015-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 Freyther7ba4e572014-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 Freyther7ba4e572014-08-04 09:26:05 +0200202 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000203
Robert P. J. Day076ed9b2015-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 Glass53552c92014-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 Teki287314f2014-08-31 21:19:43 +0530216See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600217
218
Simon Glassd8711af2015-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. Day076ed9b2015-12-19 07:16:10 -0500223SPL and U-Boot proper (i.e. they both follow the same rules).
224
225Note: "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.
Simon Glassd8711af2015-03-03 08:03:00 -0700232
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500233Execution 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 Glassd8711af2015-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 Tan48fcc4a2017-05-03 17:13:32 +0800294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500318- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000319
Kim Phillips203fee32007-08-10 13:28:25 -0500320- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200321
Lei Wen20014762011-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 Galaf4fb90f2011-02-18 05:40:54 -0600327- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Wood80806962012-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 Kushwahad324f472013-04-16 13:27:44 +0530365 CONFIG_A003399_NOR_WORKAROUND
366 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800367 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530368
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530369 CONFIG_A008044_WORKAROUND
370 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800371 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530372
Scott Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530390 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391 This value denotes start offset of DSP CCSR space.
392
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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 Meng75574052016-02-05 19:30:11 -0800400 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530401
Tang Yuantiana7364af2014-04-17 15:33:46 +0800402 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800403 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800404 supported, core will start to execute uboot when wakes up.
405
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000406- Generic CPU options:
York Sun021d2022014-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 Schwierzeckd8a49ca2012-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 Sunf0626592013-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 Sun2896cb72014-03-27 17:54:47 -0700439 CONFIG_SYS_FSL_DDRC_GEN4
440 Freescale DDR4 controller.
441
York Sun461c9392013-09-30 14:20:51 -0700442 CONFIG_SYS_FSL_DDRC_ARM_GEN3
443 Freescale DDR3 controller for ARM-based SoCs.
444
York Sunf0626592013-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. Day8d56db92016-07-15 13:44:45 -0400451 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-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 Sun2896cb72014-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 Sunf0626592013-09-30 09:22:09 -0700466
Prabhakar Kushwaha62908c22014-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 Kushwaha3c48f582017-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 Kushwahabedc5622017-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 Kushwaha950f2f72014-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 Kushwaha2c27f122014-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 Sun29647ab2014-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 Sun3a0916d2014-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 Sunc459ae62014-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 Sun79a779b2014-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 Kushwaha122bcfd2015-11-09 16:42:07 +0530514 CONFIG_SYS_FSL_HAS_DP_DDR
515 Defines the SoC has DP-DDR used for DPAA.
516
Ruchika Guptabb7143b2014-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 Schwierzeckd52a6232011-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 Riesch48c2d6d2012-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 Sun77a10972015-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 Warren8d1fb312015-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000590 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
591
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800592 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400596 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200597
598 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500605 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400606
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200607 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600608 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200609
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200610 boards with QUICC Engines require OF_QE to set UCC MAC
611 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500612
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000617
Simon Glass6c0be912014-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 Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-11-03 22:13:47 +0100644- vxWorks boot parameters:
645
646 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700647 environments variables: bootdev, bootfile, ipaddr, netmask,
648 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100649 It loads the vxWorks image pointed bootfile.
650
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100651 Note: If a "bootargs" environment is defined, it will overwride
652 the defaults discussed just above.
653
Aneesh V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000665- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200666 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL010 UARTs.
669
Andreas Engel0813b122008-09-08 14:30:53 +0200670 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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, Muralidharancbc08882014-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
wdenkda04a8b2004-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-VILLARD03836942008-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
wdenkc6097192002-11-03 00:24:07 +0000702 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000703 The value of these goes into the environment as
704 "ramboot" and "nfsboot" respectively, and can be used
705 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200706 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000707
Heiko Schocher040c5c32013-11-04 14:04:59 +0100708- Bootcount:
709 CONFIG_BOOTCOUNT_LIMIT
710 Implements a mechanism for detecting a repeating reboot
711 cycle, see:
712 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
713
714 CONFIG_BOOTCOUNT_ENV
715 If no softreset save registers are found on the hardware
716 "bootcount" is stored in the environment. To prevent a
717 saveenv on all reboots, the environment variable
718 "upgrade_available" is used. If "upgrade_available" is
719 0, "bootcount" is always 0, if "upgrade_available" is
720 1 "bootcount" is incremented in the environment.
721 So the Userspace Applikation must set the "upgrade_available"
722 and "bootcount" variable to 0, if a boot was successfully.
723
wdenkc6097192002-11-03 00:24:07 +0000724- Pre-Boot Commands:
725 CONFIG_PREBOOT
726
727 When this option is #defined, the existence of the
728 environment variable "preboot" will be checked
729 immediately before starting the CONFIG_BOOTDELAY
730 countdown and/or running the auto-boot command resp.
731 entering interactive mode.
732
733 This feature is especially useful when "preboot" is
734 automatically generated or modified. For an example
735 see the LWMON board specific code: here "preboot" is
736 modified when the user holds down a certain
737 combination of keys on the (special) keyboard when
738 booting the systems
739
740- Serial Download Echo Mode:
741 CONFIG_LOADS_ECHO
742 If defined to 1, all characters received during a
743 serial download (using the "loads" command) are
744 echoed back. This might be needed by some terminal
745 emulations (like "cu"), but may as well just take
746 time on others. This setting #define's the initial
747 value of the "loads_echo" environment variable.
748
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500749- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000750 CONFIG_KGDB_BAUDRATE
751 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200752 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000753
Simon Glassaa34ef22016-03-13 19:07:28 -0600754- Removal of commands
755 If no commands are needed to boot, you can disable
756 CONFIG_CMDLINE to remove them. In this case, the command line
757 will not be available, and when U-Boot wants to execute the
758 boot command (on start-up) it will call board_run_command()
759 instead. This can reduce image size significantly for very
760 simple boot procedures.
761
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000762- Regular expression support:
763 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200764 If this variable is defined, U-Boot is linked against
765 the SLRE (Super Light Regular Expression) library,
766 which adds regex support to some commands, as for
767 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000768
Simon Glass3d686442011-10-15 05:48:20 +0000769- Device tree:
770 CONFIG_OF_CONTROL
771 If this variable is defined, U-Boot will use a device tree
772 to configure its devices, instead of relying on statically
773 compiled #defines in the board file. This option is
774 experimental and only available on a few boards. The device
775 tree is available in the global data as gd->fdt_blob.
776
Simon Glass5cb34db2011-10-24 19:15:31 +0000777 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700778 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000779
780 CONFIG_OF_EMBED
781 If this variable is defined, U-Boot will embed a device tree
782 binary in its image. This device tree file should be in the
783 board directory and called <soc>-<board>.dts. The binary file
784 is then picked up in board_init_f() and made available through
785 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000786
Simon Glass5cb34db2011-10-24 19:15:31 +0000787 CONFIG_OF_SEPARATE
788 If this variable is defined, U-Boot will build a device tree
789 binary. It will be called u-boot.dtb. Architecture-specific
790 code will locate it at run-time. Generally this works by:
791
792 cat u-boot.bin u-boot.dtb >image.bin
793
794 and in fact, U-Boot does this for you, creating a file called
795 u-boot-dtb.bin which is useful in the common case. You can
796 still use the individual files if you need something more
797 exotic.
798
Alex Deymo5b661ec2017-04-02 01:25:20 -0700799 CONFIG_OF_BOARD
800 If this variable is defined, U-Boot will use the device tree
801 provided by the board at runtime instead of embedding one with
802 the image. Only boards defining board_fdt_blob_setup() support
803 this option (see include/fdtdec.h file).
804
wdenkc6097192002-11-03 00:24:07 +0000805- Watchdog:
806 CONFIG_WATCHDOG
807 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000808 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200809 specific code for a watchdog. For the 8xx
810 CPUs, the SIU Watchdog feature is enabled in the SYPCR
811 register. When supported for a specific SoC is
812 available, then no further board specific code should
813 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000814
815 CONFIG_HW_WATCHDOG
816 When using a watchdog circuitry external to the used
817 SoC, then define this variable and provide board
818 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000819
Heiko Schocher735326c2015-01-21 08:38:22 +0100820 CONFIG_AT91_HW_WDT_TIMEOUT
821 specify the timeout in seconds. default 2 seconds.
822
stroeseb9c17c52003-04-04 15:53:41 +0000823- U-Boot Version:
824 CONFIG_VERSION_VARIABLE
825 If this variable is defined, an environment variable
826 named "ver" is created by U-Boot showing the U-Boot
827 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200828 Any change to this variable will be reverted at the
829 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000830
wdenkc6097192002-11-03 00:24:07 +0000831- Real-Time Clock:
832
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000834 has to be selected, too. Define exactly one of the
835 following options:
836
wdenkc6097192002-11-03 00:24:07 +0000837 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000838 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000839 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000840 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000841 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000842 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200843 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000844 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100845 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000846 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200847 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200848 CONFIG_SYS_RV3029_TCR - enable trickle charger on
849 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000850
wdenkb9bbd242003-06-30 16:24:52 +0000851 Note that if the RTC uses I2C, then the I2C interface
852 must also be configured. See I2C Support, below.
853
Peter Tyser9902e422008-12-17 16:36:21 -0600854- GPIO Support:
855 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600856
Chris Packham9b383202010-12-19 10:12:13 +0000857 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
858 chip-ngpio pairs that tell the PCA953X driver the number of
859 pins supported by a particular chip.
860
Peter Tyser9902e422008-12-17 16:36:21 -0600861 Note that if the GPIO device uses I2C, then the I2C interface
862 must also be configured. See I2C Support, below.
863
Simon Glass4dc47ca2014-06-11 23:29:41 -0600864- I/O tracing:
865 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
866 accesses and can checksum them or write a list of them out
867 to memory. See the 'iotrace' command for details. This is
868 useful for testing device drivers since it can confirm that
869 the driver behaves the same way before and after a code
870 change. Currently this is supported on sandbox and arm. To
871 add support for your architecture, add '#include <iotrace.h>'
872 to the bottom of arch/<arch>/include/asm/io.h and test.
873
874 Example output from the 'iotrace stats' command is below.
875 Note that if the trace buffer is exhausted, the checksum will
876 still continue to operate.
877
878 iotrace is enabled
879 Start: 10000000 (buffer start address)
880 Size: 00010000 (buffer size)
881 Offset: 00000120 (current buffer offset)
882 Output: 10000120 (start + offset)
883 Count: 00000018 (number of trace records)
884 CRC32: 9526fb66 (CRC32 of all trace records)
885
wdenkc6097192002-11-03 00:24:07 +0000886- Timestamp Support:
887
wdenk4a5c8a72003-03-06 00:02:04 +0000888 When CONFIG_TIMESTAMP is selected, the timestamp
889 (date and time) of an image is printed by image
890 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500891 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000892
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000893- Partition Labels (disklabels) Supported:
894 Zero or more of the following:
895 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000896 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
897 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
898 bootloader. Note 2TB partition limit; see
899 disk/part_efi.c
900 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000901
Simon Glassb569a012017-05-17 03:25:30 -0600902 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -0600903 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000904 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000905
906- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000907 CONFIG_IDE_RESET_ROUTINE - this is defined in several
908 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000909
wdenk369d43d2004-03-14 14:09:05 +0000910 CONFIG_IDE_RESET - is this is defined, IDE Reset will
911 be performed by calling the function
912 ide_set_reset(int reset)
913 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000914
915- ATAPI Support:
916 CONFIG_ATAPI
917
918 Set this to enable ATAPI support.
919
wdenkf602aa02004-03-13 23:29:43 +0000920- LBA48 Support
921 CONFIG_LBA48
922
923 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100924 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000925 Whithout these , LBA48 support uses 32bit variables and will 'only'
926 support disks up to 2.1TB.
927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200928 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000929 When enabled, makes the IDE subsystem use 64bit sector addresses.
930 Default is 32bit.
931
wdenkc6097192002-11-03 00:24:07 +0000932- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200933 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
934 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
935 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000936 maximum numbers of LUNs, SCSI ID's and target
937 devices.
wdenkc6097192002-11-03 00:24:07 +0000938
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200939 The environment variable 'scsidevs' is set to the number of
940 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000941
wdenkc6097192002-11-03 00:24:07 +0000942- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000943 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000944 Support for Intel 8254x/8257x gigabit chips.
945
946 CONFIG_E1000_SPI
947 Utility code for direct access to the SPI bus on Intel 8257x.
948 This does not do anything useful unless you set at least one
949 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
950
951 CONFIG_E1000_SPI_GENERIC
952 Allow generic access to the SPI bus on the Intel 8257x, for
953 example with the "sspi" command.
954
wdenkc6097192002-11-03 00:24:07 +0000955 CONFIG_EEPRO100
956 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200957 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000958 write routine for first time initialisation.
959
960 CONFIG_TULIP
961 Support for Digital 2114x chips.
962 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
963 modem chip initialisation (KS8761/QS6611).
964
965 CONFIG_NATSEMI
966 Support for National dp83815 chips.
967
968 CONFIG_NS8382X
969 Support for National dp8382[01] gigabit chips.
970
wdenkaa603362003-05-12 21:50:16 +0000971- NETWORK Support (other):
972
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100973 CONFIG_DRIVER_AT91EMAC
974 Support for AT91RM9200 EMAC.
975
976 CONFIG_RMII
977 Define this to use reduced MII inteface
978
979 CONFIG_DRIVER_AT91EMAC_QUIET
980 If this defined, the driver is quiet.
981 The driver doen't show link status messages.
982
Rob Herringc9830dc2011-12-15 11:15:49 +0000983 CONFIG_CALXEDA_XGMAC
984 Support for the Calxeda XGMAC device
985
Ashok93fb8722012-10-15 06:20:47 +0000986 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000987 Support for SMSC's LAN91C96 chips.
988
wdenkaa603362003-05-12 21:50:16 +0000989 CONFIG_LAN91C96_USE_32_BIT
990 Define this to enable 32 bit addressing
991
Ashok93fb8722012-10-15 06:20:47 +0000992 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000993 Support for SMSC's LAN91C111 chip
994
995 CONFIG_SMC91111_BASE
996 Define this to hold the physical address
997 of the device (I/O space)
998
999 CONFIG_SMC_USE_32_BIT
1000 Define this if data bus is 32 bits
1001
1002 CONFIG_SMC_USE_IOFUNCS
1003 Define this to use i/o functions instead of macros
1004 (some hardware wont work with macros)
1005
Heiko Schocher7d037f72011-11-15 10:00:04 -05001006 CONFIG_DRIVER_TI_EMAC
1007 Support for davinci emac
1008
1009 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1010 Define this if you have more then 3 PHYs.
1011
Macpaul Lin199c6252010-12-21 16:59:46 +08001012 CONFIG_FTGMAC100
1013 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1014
1015 CONFIG_FTGMAC100_EGIGA
1016 Define this to use GE link update with gigabit PHY.
1017 Define this if FTGMAC100 is connected to gigabit PHY.
1018 If your system has 10/100 PHY only, it might not occur
1019 wrong behavior. Because PHY usually return timeout or
1020 useless data when polling gigabit status and gigabit
1021 control registers. This behavior won't affect the
1022 correctnessof 10/100 link speed update.
1023
Mike Rapoportf4761af2009-11-11 10:03:03 +02001024 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001025 Support for SMSC's LAN911x and LAN921x chips
1026
Mike Rapoportf4761af2009-11-11 10:03:03 +02001027 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001028 Define this to hold the physical address
1029 of the device (I/O space)
1030
Mike Rapoportf4761af2009-11-11 10:03:03 +02001031 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001032 Define this if data bus is 32 bits
1033
Mike Rapoportf4761af2009-11-11 10:03:03 +02001034 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001035 Define this if data bus is 16 bits. If your processor
1036 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001037 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001038
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001039 CONFIG_SH_ETHER
1040 Support for Renesas on-chip Ethernet controller
1041
1042 CONFIG_SH_ETHER_USE_PORT
1043 Define the number of ports to be used
1044
1045 CONFIG_SH_ETHER_PHY_ADDR
1046 Define the ETH PHY's address
1047
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001048 CONFIG_SH_ETHER_CACHE_WRITEBACK
1049 If this option is set, the driver enables cache flush.
1050
Heiko Schocher2b387762014-07-18 06:07:19 +02001051- PWM Support:
1052 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001053 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001054
Vadim Bendeburydac69642011-10-17 08:36:14 +00001055- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001056 CONFIG_TPM
1057 Support TPM devices.
1058
Christophe Ricard8759ff82015-10-06 22:54:41 +02001059 CONFIG_TPM_TIS_INFINEON
1060 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001061 per system is supported at this time.
1062
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001063 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1064 Define the burst count bytes upper limit
1065
Christophe Ricard88249232016-01-21 23:27:13 +01001066 CONFIG_TPM_ST33ZP24
1067 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1068
1069 CONFIG_TPM_ST33ZP24_I2C
1070 Support for STMicroelectronics ST33ZP24 I2C devices.
1071 Requires TPM_ST33ZP24 and I2C.
1072
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001073 CONFIG_TPM_ST33ZP24_SPI
1074 Support for STMicroelectronics ST33ZP24 SPI devices.
1075 Requires TPM_ST33ZP24 and SPI.
1076
Dirk Eibach20489092013-06-26 15:55:15 +02001077 CONFIG_TPM_ATMEL_TWI
1078 Support for Atmel TWI TPM device. Requires I2C support.
1079
Che-liang Chiouacea5702013-04-12 11:04:34 +00001080 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001081 Support for generic parallel port TPM devices. Only one device
1082 per system is supported at this time.
1083
1084 CONFIG_TPM_TIS_BASE_ADDRESS
1085 Base address where the generic TPM device is mapped
1086 to. Contemporary x86 systems usually map it at
1087 0xfed40000.
1088
Reinhard Pfau4fece432013-06-26 15:55:13 +02001089 CONFIG_TPM
1090 Define this to enable the TPM support library which provides
1091 functional interfaces to some TPM commands.
1092 Requires support for a TPM device.
1093
1094 CONFIG_TPM_AUTH_SESSIONS
1095 Define this to enable authorized functions in the TPM library.
1096 Requires CONFIG_TPM and CONFIG_SHA1.
1097
wdenkc6097192002-11-03 00:24:07 +00001098- USB Support:
1099 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001100 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001101 CONFIG_USB_UHCI to enable it.
1102 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001103 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001104 storage devices.
1105 Note:
1106 Supported are USB Keyboards and USB Floppy drives
1107 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001108
Simon Glass5978cdb2012-02-27 10:52:47 +00001109 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1110 txfilltuning field in the EHCI controller on reset.
1111
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001112 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1113 HW module registers.
1114
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001115- USB Device:
1116 Define the below if you wish to use the USB console.
1117 Once firmware is rebuilt from a serial console issue the
1118 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001119 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001120 it has found a new device. The environment variable usbtty
1121 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001122 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001123 Common Device Class Abstract Control Model serial device.
1124 If you select usbtty = gserial you should be able to enumerate
1125 a Linux host by
1126 # modprobe usbserial vendor=0xVendorID product=0xProductID
1127 else if using cdc_acm, simply setting the environment
1128 variable usbtty to be cdc_acm should suffice. The following
1129 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001130
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001131 CONFIG_USB_DEVICE
1132 Define this to build a UDC device
1133
1134 CONFIG_USB_TTY
1135 Define this to have a tty type of device available to
1136 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001137
Vipin KUMARbdb17702012-03-26 15:38:06 +05301138 CONFIG_USBD_HS
1139 Define this to enable the high speed support for usb
1140 device and usbtty. If this feature is enabled, a routine
1141 int is_usbd_high_speed(void)
1142 also needs to be defined by the driver to dynamically poll
1143 whether the enumeration has succeded at high speed or full
1144 speed.
1145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001146 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001147 Define this if you want stdin, stdout &/or stderr to
1148 be set to usbtty.
1149
Wolfgang Denke2601822006-06-14 18:14:56 +02001150 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001151 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001152 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001153 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1154 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1155 should pretend to be a Linux device to it's target host.
1156
1157 CONFIG_USBD_MANUFACTURER
1158 Define this string as the name of your company for
1159 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001160
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001161 CONFIG_USBD_PRODUCT_NAME
1162 Define this string as the name of your product
1163 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001164
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001165 CONFIG_USBD_VENDORID
1166 Define this as your assigned Vendor ID from the USB
1167 Implementors Forum. This *must* be a genuine Vendor ID
1168 to avoid polluting the USB namespace.
1169 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001170
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001171 CONFIG_USBD_PRODUCTID
1172 Define this as the unique Product ID
1173 for your device
1174 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001175
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001176- ULPI Layer Support:
1177 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1178 the generic ULPI layer. The generic layer accesses the ULPI PHY
1179 via the platform viewport, so you need both the genric layer and
1180 the viewport enabled. Currently only Chipidea/ARC based
1181 viewport is supported.
1182 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1183 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001184 If your ULPI phy needs a different reference clock than the
1185 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1186 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001187
wdenk7a428cc2003-06-15 22:40:42 +00001188- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001189 The MMC controller on the Intel PXA is supported. To
1190 enable this define CONFIG_MMC. The MMC can be
1191 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001192 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001193 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1194 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001195
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001196 CONFIG_SH_MMCIF
1197 Support for Renesas on-chip MMCIF controller
1198
1199 CONFIG_SH_MMCIF_ADDR
1200 Define the base address of MMCIF registers
1201
1202 CONFIG_SH_MMCIF_CLK
1203 Define the clock frequency for MMCIF
1204
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001205 CONFIG_SUPPORT_EMMC_BOOT
1206 Enable some additional features of the eMMC boot partitions.
1207
1208 CONFIG_SUPPORT_EMMC_RPMB
1209 Enable the commands for reading, writing and programming the
1210 key for the Replay Protection Memory Block partition in eMMC.
1211
Tom Rini58a8d322013-03-14 05:32:47 +00001212- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001213 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001214 This enables the USB portion of the DFU USB class
1215
Tom Rini58a8d322013-03-14 05:32:47 +00001216 CONFIG_DFU_MMC
1217 This enables support for exposing (e)MMC devices via DFU.
1218
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001219 CONFIG_DFU_NAND
1220 This enables support for exposing NAND devices via DFU.
1221
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301222 CONFIG_DFU_RAM
1223 This enables support for exposing RAM via DFU.
1224 Note: DFU spec refer to non-volatile memory usage, but
1225 allow usages beyond the scope of spec - here RAM usage,
1226 one that would help mostly the developer.
1227
Heiko Schochera2f831e2013-06-12 06:05:51 +02001228 CONFIG_SYS_DFU_DATA_BUF_SIZE
1229 Dfu transfer uses a buffer before writing data to the
1230 raw storage device. Make the size (in bytes) of this buffer
1231 configurable. The size of this buffer is also configurable
1232 through the "dfu_bufsiz" environment variable.
1233
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001234 CONFIG_SYS_DFU_MAX_FILE_SIZE
1235 When updating files rather than the raw storage device,
1236 we use a static buffer to copy the file into and then write
1237 the buffer once we've been given the whole file. Define
1238 this to the maximum filesize (in bytes) for the buffer.
1239 Default is 4 MiB if undefined.
1240
Heiko Schochere1ba1512014-03-18 08:09:56 +01001241 DFU_DEFAULT_POLL_TIMEOUT
1242 Poll timeout [ms], is the timeout a device can send to the
1243 host. The host must wait for this timeout before sending
1244 a subsequent DFU_GET_STATUS request to the device.
1245
1246 DFU_MANIFEST_POLL_TIMEOUT
1247 Poll timeout [ms], which the device sends to the host when
1248 entering dfuMANIFEST state. Host waits this timeout, before
1249 sending again an USB request to the device.
1250
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001251- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001252 CONFIG_USB_FUNCTION_FASTBOOT
1253 This enables the USB part of the fastboot gadget
1254
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001255 CONFIG_ANDROID_BOOT_IMAGE
1256 This enables support for booting images which use the Android
1257 image format header.
1258
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001259 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001260 The fastboot protocol requires a large memory buffer for
1261 downloads. Define this to the starting RAM address to use for
1262 downloaded images.
1263
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001264 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001265 The fastboot protocol requires a large memory buffer for
1266 downloads. This buffer should be as large as possible for a
1267 platform. Define this to the size available RAM for fastboot.
1268
Steve Raebfb9ba42014-08-26 11:47:28 -07001269 CONFIG_FASTBOOT_FLASH
1270 The fastboot protocol includes a "flash" command for writing
1271 the downloaded image to a non-volatile storage device. Define
1272 this to enable the "fastboot flash" command.
1273
1274 CONFIG_FASTBOOT_FLASH_MMC_DEV
1275 The fastboot "flash" command requires additional information
1276 regarding the non-volatile storage device. Define this to
1277 the eMMC device that fastboot should use to store the image.
1278
Steve Rae7d059342014-12-12 15:51:54 -08001279 CONFIG_FASTBOOT_GPT_NAME
1280 The fastboot "flash" command supports writing the downloaded
1281 image to the Protective MBR and the Primary GUID Partition
1282 Table. (Additionally, this downloaded image is post-processed
1283 to generate and write the Backup GUID Partition Table.)
1284 This occurs when the specified "partition name" on the
1285 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001286 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001287
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001288 CONFIG_FASTBOOT_MBR_NAME
1289 The fastboot "flash" command supports writing the downloaded
1290 image to DOS MBR.
1291 This occurs when the "partition name" specified on the
1292 "fastboot flash" command line matches this value.
1293 If not defined the default value "mbr" is used.
1294
wdenkda04a8b2004-08-02 23:22:59 +00001295- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001296 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001297 Define these for a default partition on a NAND device
1298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001299 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1300 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001301 Define these for a default partition on a NOR device
1302
wdenkc6097192002-11-03 00:24:07 +00001303- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001304 See Kconfig help for available keyboard drivers.
1305
1306 CONFIG_KEYBOARD
1307
1308 Define this to enable a custom keyboard support.
1309 This simply calls drv_keyboard_init() which must be
1310 defined in your board-specific files. This option is deprecated
1311 and is only used by novena. For new boards, use driver model
1312 instead.
wdenkc6097192002-11-03 00:24:07 +00001313
1314- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001315 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001316 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001317 SOCs that have a DIU should define this macro to enable DIU
1318 support, and should also define these other macros:
1319
1320 CONFIG_SYS_DIU_ADDR
1321 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001322 CONFIG_CFB_CONSOLE
1323 CONFIG_VIDEO_SW_CURSOR
1324 CONFIG_VGA_AS_SINGLE_DEVICE
1325 CONFIG_VIDEO_LOGO
1326 CONFIG_VIDEO_BMP_LOGO
1327
Timur Tabi32f709e2011-04-11 14:18:22 -05001328 The DIU driver will look for the 'video-mode' environment
1329 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001330 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001331 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001332
wdenkc6097192002-11-03 00:24:07 +00001333- LCD Support: CONFIG_LCD
1334
1335 Define this to enable LCD support (for output to LCD
1336 display); also select one of the supported displays
1337 by defining one of these:
1338
Stelian Popf6f86652008-05-09 21:57:18 +02001339 CONFIG_ATMEL_LCD:
1340
1341 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1342
wdenkc0d54ae2003-11-25 16:55:19 +00001343 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001344
wdenkc0d54ae2003-11-25 16:55:19 +00001345 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001346
wdenkc0d54ae2003-11-25 16:55:19 +00001347 CONFIG_NEC_NL6448BC20
1348
1349 NEC NL6448BC20-08. 6.5", 640x480.
1350 Active, color, single scan.
1351
1352 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001353
wdenkc0d54ae2003-11-25 16:55:19 +00001354 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001355 Active, color, single scan.
1356
1357 CONFIG_SHARP_16x9
1358
1359 Sharp 320x240. Active, color, single scan.
1360 It isn't 16x9, and I am not sure what it is.
1361
1362 CONFIG_SHARP_LQ64D341
1363
1364 Sharp LQ64D341 display, 640x480.
1365 Active, color, single scan.
1366
1367 CONFIG_HLD1045
1368
1369 HLD1045 display, 640x480.
1370 Active, color, single scan.
1371
1372 CONFIG_OPTREX_BW
1373
1374 Optrex CBL50840-2 NF-FW 99 22 M5
1375 or
1376 Hitachi LMG6912RPFC-00T
1377 or
1378 Hitachi SP14Q002
1379
1380 320x240. Black & white.
1381
Simon Glass599a4df2012-10-17 13:24:54 +00001382 CONFIG_LCD_ALIGNMENT
1383
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001384 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001385 defined then the LCD will be aligned to this value instead.
1386 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1387 here, since it is cheaper to change data cache settings on
1388 a per-section basis.
1389
1390
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001391 CONFIG_LCD_ROTATION
1392
1393 Sometimes, for example if the display is mounted in portrait
1394 mode or even if it's mounted landscape but rotated by 180degree,
1395 we need to rotate our content of the display relative to the
1396 framebuffer, so that user can read the messages which are
1397 printed out.
1398 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1399 initialized with a given rotation from "vl_rot" out of
1400 "vidinfo_t" which is provided by the board specific code.
1401 The value for vl_rot is coded as following (matching to
1402 fbcon=rotate:<n> linux-kernel commandline):
1403 0 = no rotation respectively 0 degree
1404 1 = 90 degree rotation
1405 2 = 180 degree rotation
1406 3 = 270 degree rotation
1407
1408 If CONFIG_LCD_ROTATION is not defined, the console will be
1409 initialized with 0degree rotation.
1410
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001411 CONFIG_LCD_BMP_RLE8
1412
1413 Support drawing of RLE8-compressed bitmaps on the LCD.
1414
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001415 CONFIG_I2C_EDID
1416
1417 Enables an 'i2c edid' command which can read EDID
1418 information over I2C from an attached LCD display.
1419
wdenkeb20ad32003-09-05 23:19:14 +00001420- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001421
wdenk57b2d802003-06-27 21:31:46 +00001422 If this option is set, the environment is checked for
1423 a variable "splashimage". If found, the usual display
1424 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001425 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001426 specified in "splashimage" is loaded instead. The
1427 console is redirected to the "nulldev", too. This
1428 allows for a "silent" boot where a splash screen is
1429 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001430
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001431 CONFIG_SPLASHIMAGE_GUARD
1432
1433 If this option is set, then U-Boot will prevent the environment
1434 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001435 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001436 This option is useful for targets where, due to alignment
1437 restrictions, an improperly aligned BMP image will cause a data
1438 abort. If you think you will not have problems with unaligned
1439 accesses (for example because your toolchain prevents them)
1440 there is no need to set this option.
1441
Matthias Weisser53884182009-07-09 16:07:30 +02001442 CONFIG_SPLASH_SCREEN_ALIGN
1443
1444 If this option is set the splash image can be freely positioned
1445 on the screen. Environment variable "splashpos" specifies the
1446 position as "x,y". If a positive number is given it is used as
1447 number of pixel from left/top. If a negative number is given it
1448 is used as number of pixel from right/bottom. You can also
1449 specify 'm' for centering the image.
1450
1451 Example:
1452 setenv splashpos m,m
1453 => image at center of screen
1454
1455 setenv splashpos 30,20
1456 => image at x = 30 and y = 20
1457
1458 setenv splashpos -10,m
1459 => vertically centered image
1460 at x = dspWidth - bmpWidth - 9
1461
Stefan Roesed9d97742005-09-22 09:04:17 +02001462- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1463
1464 If this option is set, additionally to standard BMP
1465 images, gzipped BMP images can be displayed via the
1466 splashscreen support or the bmp command.
1467
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001468- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1469
1470 If this option is set, 8-bit RLE compressed BMP images
1471 can be displayed via the splashscreen support or the
1472 bmp command.
1473
wdenk710e3502003-08-29 20:57:53 +00001474- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001475 CONFIG_GZIP
1476
1477 Enabled by default to support gzip compressed images.
1478
wdenk710e3502003-08-29 20:57:53 +00001479 CONFIG_BZIP2
1480
1481 If this option is set, support for bzip2 compressed
1482 images is included. If not, only uncompressed and gzip
1483 compressed images are supported.
1484
wdenk9c53f402003-10-15 23:53:47 +00001485 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001486 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001487 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001488
wdenk0e2bd9c2004-06-06 21:51:03 +00001489- MII/PHY support:
1490 CONFIG_PHY_ADDR
1491
1492 The address of PHY on MII bus.
1493
1494 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1495
1496 The clock frequency of the MII bus
1497
wdenk0e2bd9c2004-06-06 21:51:03 +00001498 CONFIG_PHY_RESET_DELAY
1499
1500 Some PHY like Intel LXT971A need extra delay after
1501 reset before any MII register access is possible.
1502 For such PHY, set this option to the usec delay
1503 required. (minimum 300usec for LXT971A)
1504
1505 CONFIG_PHY_CMD_DELAY (ppc4xx)
1506
1507 Some PHY like Intel LXT971A need extra delay after
1508 command issued before MII status register can be read
1509
wdenkc6097192002-11-03 00:24:07 +00001510- IP address:
1511 CONFIG_IPADDR
1512
1513 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001514 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001515 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001516 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001517
1518- Server IP address:
1519 CONFIG_SERVERIP
1520
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001521 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001522 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001523 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001524
Robin Getz470a6d42009-07-21 12:15:28 -04001525 CONFIG_KEEP_SERVERADDR
1526
1527 Keeps the server's MAC address, in the env 'serveraddr'
1528 for passing to bootargs (like Linux's netconsole option)
1529
Wolfgang Denk26da2992011-10-26 10:21:22 +00001530- Gateway IP address:
1531 CONFIG_GATEWAYIP
1532
1533 Defines a default value for the IP address of the
1534 default router where packets to other networks are
1535 sent to.
1536 (Environment variable "gatewayip")
1537
1538- Subnet mask:
1539 CONFIG_NETMASK
1540
1541 Defines a default value for the subnet mask (or
1542 routing prefix) which is used to determine if an IP
1543 address belongs to the local subnet or needs to be
1544 forwarded through a router.
1545 (Environment variable "netmask")
1546
David Updegraff7280da72007-06-11 10:41:07 -05001547- Multicast TFTP Mode:
1548 CONFIG_MCAST_TFTP
1549
1550 Defines whether you want to support multicast TFTP as per
1551 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001552 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001553 driver in use must provide a function: mcast() to join/leave a
1554 multicast group.
1555
wdenkc6097192002-11-03 00:24:07 +00001556- BOOTP Recovery Mode:
1557 CONFIG_BOOTP_RANDOM_DELAY
1558
1559 If you have many targets in a network that try to
1560 boot using BOOTP, you may want to avoid that all
1561 systems send out BOOTP requests at precisely the same
1562 moment (which would happen for instance at recovery
1563 from a power failure, when all systems will try to
1564 boot, thus flooding the BOOTP server. Defining
1565 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1566 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001567 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001568
1569 1st BOOTP request: delay 0 ... 1 sec
1570 2nd BOOTP request: delay 0 ... 2 sec
1571 3rd BOOTP request: delay 0 ... 4 sec
1572 4th and following
1573 BOOTP requests: delay 0 ... 8 sec
1574
Thierry Reding8977cda2014-08-19 10:21:24 +02001575 CONFIG_BOOTP_ID_CACHE_SIZE
1576
1577 BOOTP packets are uniquely identified using a 32-bit ID. The
1578 server will copy the ID from client requests to responses and
1579 U-Boot will use this to determine if it is the destination of
1580 an incoming response. Some servers will check that addresses
1581 aren't in use before handing them out (usually using an ARP
1582 ping) and therefore take up to a few hundred milliseconds to
1583 respond. Network congestion may also influence the time it
1584 takes for a response to make it back to the client. If that
1585 time is too long, U-Boot will retransmit requests. In order
1586 to allow earlier responses to still be accepted after these
1587 retransmissions, U-Boot's BOOTP client keeps a small cache of
1588 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1589 cache. The default is to keep IDs for up to four outstanding
1590 requests. Increasing this will allow U-Boot to accept offers
1591 from a BOOTP client in networks with unusually high latency.
1592
stroesee0aadfb2003-08-28 14:17:32 +00001593- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001594 You can fine tune the DHCP functionality by defining
1595 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001596
Jon Loeliger5336a762007-07-09 22:08:34 -05001597 CONFIG_BOOTP_SUBNETMASK
1598 CONFIG_BOOTP_GATEWAY
1599 CONFIG_BOOTP_HOSTNAME
1600 CONFIG_BOOTP_NISDOMAIN
1601 CONFIG_BOOTP_BOOTPATH
1602 CONFIG_BOOTP_BOOTFILESIZE
1603 CONFIG_BOOTP_DNS
1604 CONFIG_BOOTP_DNS2
1605 CONFIG_BOOTP_SEND_HOSTNAME
1606 CONFIG_BOOTP_NTPSERVER
1607 CONFIG_BOOTP_TIMEOFFSET
1608 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001609 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001610
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001611 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1612 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001613
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001614 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1615 after the configured retry count, the call will fail
1616 instead of starting over. This can be used to fail over
1617 to Link-local IP address configuration if the DHCP server
1618 is not available.
1619
stroesee0aadfb2003-08-28 14:17:32 +00001620 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1621 serverip from a DHCP server, it is possible that more
1622 than one DNS serverip is offered to the client.
1623 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1624 serverip will be stored in the additional environment
1625 variable "dnsip2". The first DNS serverip is always
1626 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001627 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001628
1629 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1630 to do a dynamic update of a DNS server. To do this, they
1631 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001632 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001633 of the "hostname" environment variable is passed as
1634 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001635
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001636 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1637
1638 A 32bit value in microseconds for a delay between
1639 receiving a "DHCP Offer" and sending the "DHCP Request".
1640 This fixes a problem with certain DHCP servers that don't
1641 respond 100% of the time to a "DHCP request". E.g. On an
1642 AT91RM9200 processor running at 180MHz, this delay needed
1643 to be *at least* 15,000 usec before a Windows Server 2003
1644 DHCP server would reply 100% of the time. I recommend at
1645 least 50,000 usec to be safe. The alternative is to hope
1646 that one of the retries will be successful but note that
1647 the DHCP timeout and retry process takes a longer than
1648 this delay.
1649
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001650 - Link-local IP address negotiation:
1651 Negotiate with other link-local clients on the local network
1652 for an address that doesn't require explicit configuration.
1653 This is especially useful if a DHCP server cannot be guaranteed
1654 to exist in all environments that the device must operate.
1655
1656 See doc/README.link-local for more information.
1657
wdenk145d2c12004-04-15 21:48:45 +00001658 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001659 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001660
1661 The device id used in CDP trigger frames.
1662
1663 CONFIG_CDP_DEVICE_ID_PREFIX
1664
1665 A two character string which is prefixed to the MAC address
1666 of the device.
1667
1668 CONFIG_CDP_PORT_ID
1669
1670 A printf format string which contains the ascii name of
1671 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001672 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001673
1674 CONFIG_CDP_CAPABILITIES
1675
1676 A 32bit integer which indicates the device capabilities;
1677 0x00000010 for a normal host which does not forwards.
1678
1679 CONFIG_CDP_VERSION
1680
1681 An ascii string containing the version of the software.
1682
1683 CONFIG_CDP_PLATFORM
1684
1685 An ascii string containing the name of the platform.
1686
1687 CONFIG_CDP_TRIGGER
1688
1689 A 32bit integer sent on the trigger.
1690
1691 CONFIG_CDP_POWER_CONSUMPTION
1692
1693 A 16bit integer containing the power consumption of the
1694 device in .1 of milliwatts.
1695
1696 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1697
1698 A byte containing the id of the VLAN.
1699
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001700- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001701
1702 Several configurations allow to display the current
1703 status using a LED. For instance, the LED will blink
1704 fast while running U-Boot code, stop blinking as
1705 soon as a reply to a BOOTP request was received, and
1706 start blinking slow once the Linux kernel is running
1707 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001708 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001709 feature in U-Boot.
1710
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001711 Additional options:
1712
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001713 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001714 The status LED can be connected to a GPIO pin.
1715 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001716 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001717 to include the gpio_led driver in the U-Boot binary.
1718
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001719 CONFIG_GPIO_LED_INVERTED_TABLE
1720 Some GPIO connected LEDs may have inverted polarity in which
1721 case the GPIO high value corresponds to LED off state and
1722 GPIO low value corresponds to LED on state.
1723 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1724 with a list of GPIO LEDs that have inverted polarity.
1725
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001726- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001727
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001728 This enable the NEW i2c subsystem, and will allow you to use
1729 i2c commands at the u-boot command line (as long as you set
1730 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1731 based realtime clock chips or other i2c devices. See
1732 common/cmd_i2c.c for a description of the command line
1733 interface.
1734
1735 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001736 - drivers/i2c/soft_i2c.c:
1737 - activate first bus with CONFIG_SYS_I2C_SOFT define
1738 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1739 for defining speed and slave address
1740 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1741 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1742 for defining speed and slave address
1743 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1744 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1745 for defining speed and slave address
1746 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1747 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1748 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001749
Heiko Schocherf2850742012-10-24 13:48:22 +02001750 - drivers/i2c/fsl_i2c.c:
1751 - activate i2c driver with CONFIG_SYS_I2C_FSL
1752 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1753 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1754 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1755 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001756 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001757 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1758 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1759 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1760 second bus.
1761
Simon Glass026fefb2012-10-30 07:28:53 +00001762 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001763 - activate this driver with CONFIG_SYS_I2C_TEGRA
1764 - This driver adds 4 i2c buses with a fix speed from
1765 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001766
Dirk Eibach42b204f2013-04-25 02:40:01 +00001767 - drivers/i2c/ppc4xx_i2c.c
1768 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1769 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1770 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1771
trema49f40a2013-09-21 18:13:35 +02001772 - drivers/i2c/i2c_mxc.c
1773 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001774 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1775 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1776 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1777 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001778 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1779 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1780 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1781 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1782 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1783 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001784 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1785 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001786 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001787 for speed, and 0 for slave.
1788
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001789 - drivers/i2c/rcar_i2c.c:
1790 - activate this driver with CONFIG_SYS_I2C_RCAR
1791 - This driver adds 4 i2c buses
1792
1793 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1794 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1795 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1796 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1797 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1798 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1799 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1800 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1801 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1802
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001803 - drivers/i2c/sh_i2c.c:
1804 - activate this driver with CONFIG_SYS_I2C_SH
1805 - This driver adds from 2 to 5 i2c buses
1806
1807 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1808 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1809 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1810 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1811 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1812 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1813 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1814 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1815 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1816 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001817 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001818
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001819 - drivers/i2c/omap24xx_i2c.c
1820 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1821 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1822 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1823 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1824 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1825 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1826 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1827 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1828 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1829 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1830 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1831
Heiko Schocher465819a2013-11-08 07:30:53 +01001832 - drivers/i2c/zynq_i2c.c
1833 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1834 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1835 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1836
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301837 - drivers/i2c/s3c24x0_i2c.c:
1838 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1839 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1840 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1841 with a fix speed from 100000 and the slave addr 0!
1842
Dirk Eibachb9577432014-07-03 09:28:18 +02001843 - drivers/i2c/ihs_i2c.c
1844 - activate this driver with CONFIG_SYS_I2C_IHS
1845 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1846 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1847 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1848 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1849 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1850 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1851 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1852 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1853 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1854 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1855 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1856 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001857 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1858 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1859 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1860 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1861 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1862 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1863 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1864 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1865 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001866
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001867 additional defines:
1868
1869 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001870 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001871
1872 CONFIG_SYS_I2C_DIRECT_BUS
1873 define this, if you don't use i2c muxes on your hardware.
1874 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1875 omit this define.
1876
1877 CONFIG_SYS_I2C_MAX_HOPS
1878 define how many muxes are maximal consecutively connected
1879 on one i2c bus. If you not use i2c muxes, omit this
1880 define.
1881
1882 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001883 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001884 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1885 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1886 CONFIG_SYS_NUM_I2C_BUSES = 9:
1887
1888 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1889 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1890 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1891 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1892 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1893 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1894 {1, {I2C_NULL_HOP}}, \
1895 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1896 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1897 }
1898
1899 which defines
1900 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001901 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1902 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1903 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1904 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1905 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001906 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001907 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1908 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001909
1910 If you do not have i2c muxes on your board, omit this define.
1911
Simon Glass3efce392017-05-12 21:10:00 -06001912- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001913 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001914 then the following macros need to be defined (examples are
1915 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001916
1917 I2C_INIT
1918
wdenkb9bbd242003-06-30 16:24:52 +00001919 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001920 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001921
wdenk544e9732004-02-06 23:19:44 +00001922 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001923
wdenkc6097192002-11-03 00:24:07 +00001924 I2C_ACTIVE
1925
1926 The code necessary to make the I2C data line active
1927 (driven). If the data line is open collector, this
1928 define can be null.
1929
wdenkb9bbd242003-06-30 16:24:52 +00001930 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1931
wdenkc6097192002-11-03 00:24:07 +00001932 I2C_TRISTATE
1933
1934 The code necessary to make the I2C data line tri-stated
1935 (inactive). If the data line is open collector, this
1936 define can be null.
1937
wdenkb9bbd242003-06-30 16:24:52 +00001938 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1939
wdenkc6097192002-11-03 00:24:07 +00001940 I2C_READ
1941
York Sun4a598092013-04-01 11:29:11 -07001942 Code that returns true if the I2C data line is high,
1943 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001944
wdenkb9bbd242003-06-30 16:24:52 +00001945 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1946
wdenkc6097192002-11-03 00:24:07 +00001947 I2C_SDA(bit)
1948
York Sun4a598092013-04-01 11:29:11 -07001949 If <bit> is true, sets the I2C data line high. If it
1950 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001951
wdenkb9bbd242003-06-30 16:24:52 +00001952 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001953 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001954 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001955
wdenkc6097192002-11-03 00:24:07 +00001956 I2C_SCL(bit)
1957
York Sun4a598092013-04-01 11:29:11 -07001958 If <bit> is true, sets the I2C clock line high. If it
1959 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001960
wdenkb9bbd242003-06-30 16:24:52 +00001961 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001962 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001963 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001964
wdenkc6097192002-11-03 00:24:07 +00001965 I2C_DELAY
1966
1967 This delay is invoked four times per clock cycle so this
1968 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001969 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001970 like:
1971
wdenkb9bbd242003-06-30 16:24:52 +00001972 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001973
Mike Frysingeree12d542010-07-21 13:38:02 -04001974 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1975
1976 If your arch supports the generic GPIO framework (asm/gpio.h),
1977 then you may alternatively define the two GPIOs that are to be
1978 used as SCL / SDA. Any of the previous I2C_xxx macros will
1979 have GPIO-based defaults assigned to them as appropriate.
1980
1981 You should define these to the GPIO value as given directly to
1982 the generic GPIO functions.
1983
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001984 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001985
wdenk57b2d802003-06-27 21:31:46 +00001986 When a board is reset during an i2c bus transfer
1987 chips might think that the current transfer is still
1988 in progress. On some boards it is possible to access
1989 the i2c SCLK line directly, either by using the
1990 processor pin as a GPIO or by having a second pin
1991 connected to the bus. If this option is defined a
1992 custom i2c_init_board() routine in boards/xxx/board.c
1993 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001994
Ben Warren45657152006-09-07 16:50:54 -04001995 CONFIG_I2C_MULTI_BUS
1996
1997 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001998 must have a controller. At any point in time, only one bus is
1999 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002000 Note that bus numbering is zero-based.
2001
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002002 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002003
2004 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002005 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002006 is set, specify a list of bus-device pairs. Otherwise, specify
2007 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002008
2009 e.g.
2010 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002011 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002012
2013 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2014
Wolfgang Denk092ae952011-10-26 10:21:21 +00002015 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002016 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002017
2018 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2019
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002020 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002021
2022 If defined, then this indicates the I2C bus number for DDR SPD.
2023 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2024
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002025 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002026
2027 If defined, then this indicates the I2C bus number for the RTC.
2028 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2029
Andrew Dyer58c41f92008-12-29 17:36:01 -06002030 CONFIG_SOFT_I2C_READ_REPEATED_START
2031
2032 defining this will force the i2c_read() function in
2033 the soft_i2c driver to perform an I2C repeated start
2034 between writing the address pointer and reading the
2035 data. If this define is omitted the default behaviour
2036 of doing a stop-start sequence will be used. Most I2C
2037 devices can use either method, but some require one or
2038 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002039
wdenkc6097192002-11-03 00:24:07 +00002040- SPI Support: CONFIG_SPI
2041
2042 Enables SPI driver (so far only tested with
2043 SPI EEPROM, also an instance works with Crystal A/D and
2044 D/As on the SACSng board)
2045
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002046 CONFIG_SH_SPI
2047
2048 Enables the driver for SPI controller on SuperH. Currently
2049 only SH7757 is supported.
2050
wdenkc6097192002-11-03 00:24:07 +00002051 CONFIG_SOFT_SPI
2052
wdenk4a5c8a72003-03-06 00:02:04 +00002053 Enables a software (bit-bang) SPI driver rather than
2054 using hardware support. This is a general purpose
2055 driver that only requires three general I/O port pins
2056 (two outputs, one input) to function. If this is
2057 defined, the board configuration must define several
2058 SPI configuration items (port pins to use, etc). For
2059 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002060
Ben Warren7efe9272008-01-16 22:37:35 -05002061 CONFIG_HARD_SPI
2062
2063 Enables a hardware SPI driver for general-purpose reads
2064 and writes. As with CONFIG_SOFT_SPI, the board configuration
2065 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002066 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002067 example, see include/configs/mpc8349emds.h.
2068
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002069 CONFIG_MXC_SPI
2070
2071 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002072 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002073
Heiko Schocherb77c8882014-07-14 10:22:11 +02002074 CONFIG_SYS_SPI_MXC_WAIT
2075 Timeout for waiting until spi transfer completed.
2076 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2077
Matthias Fuchsa4400872007-12-27 17:12:34 +01002078- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002079
Matthias Fuchsa4400872007-12-27 17:12:34 +01002080 Enables FPGA subsystem.
2081
2082 CONFIG_FPGA_<vendor>
2083
2084 Enables support for specific chip vendors.
2085 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002086
Matthias Fuchsa4400872007-12-27 17:12:34 +01002087 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002088
Matthias Fuchsa4400872007-12-27 17:12:34 +01002089 Enables support for FPGA family.
2090 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2091
2092 CONFIG_FPGA_COUNT
2093
2094 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002096 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002097
wdenk57b2d802003-06-27 21:31:46 +00002098 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002099
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002100 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002101
wdenk4a5c8a72003-03-06 00:02:04 +00002102 Enable checks on FPGA configuration interface busy
2103 status by the configuration function. This option
2104 will require a board or device specific function to
2105 be written.
wdenkc6097192002-11-03 00:24:07 +00002106
2107 CONFIG_FPGA_DELAY
2108
2109 If defined, a function that provides delays in the FPGA
2110 configuration driver.
2111
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002112 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002113 Allow Control-C to interrupt FPGA configuration
2114
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002115 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002116
wdenk4a5c8a72003-03-06 00:02:04 +00002117 Check for configuration errors during FPGA bitfile
2118 loading. For example, abort during Virtex II
2119 configuration if the INIT_B line goes low (which
2120 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002122 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002123
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002124 Maximum time to wait for the INIT_B line to de-assert
2125 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002126 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002127 ms.
wdenkc6097192002-11-03 00:24:07 +00002128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002129 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002130
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002131 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002132 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002134 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002135
wdenk4a5c8a72003-03-06 00:02:04 +00002136 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002137 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002138
2139- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002140 CONFIG_BUILD_TARGET
2141
2142 Some SoCs need special image types (e.g. U-Boot binary
2143 with a special header) as build targets. By defining
2144 CONFIG_BUILD_TARGET in the SoC / board header, this
2145 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002146 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002147
wdenkc6097192002-11-03 00:24:07 +00002148 CONFIG_IDENT_STRING
2149
wdenk4a5c8a72003-03-06 00:02:04 +00002150 If defined, this string will be added to the U-Boot
2151 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002152
2153- Vendor Parameter Protection:
2154
wdenk4a5c8a72003-03-06 00:02:04 +00002155 U-Boot considers the values of the environment
2156 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002157 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002158 are set once by the board vendor / manufacturer, and
2159 protects these variables from casual modification by
2160 the user. Once set, these variables are read-only,
2161 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002162 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002163
2164 If CONFIG_ENV_OVERWRITE is #defined in your config
2165 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002166 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002167 these parameters.
2168
Joe Hershberger76f353e2015-05-04 14:55:14 -05002169 Alternatively, if you define _both_ an ethaddr in the
2170 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002171 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002172 which can be changed exactly ONCE by the user. [The
2173 serial# is unaffected by this, i. e. it remains
2174 read-only.]
2175
Joe Hershberger71497d02012-12-11 22:16:31 -06002176 The same can be accomplished in a more flexible way
2177 for any variable by configuring the type of access
2178 to allow for those variables in the ".flags" variable
2179 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2180
wdenkc6097192002-11-03 00:24:07 +00002181- Protected RAM:
2182 CONFIG_PRAM
2183
2184 Define this variable to enable the reservation of
2185 "protected RAM", i. e. RAM which is not overwritten
2186 by U-Boot. Define CONFIG_PRAM to hold the number of
2187 kB you want to reserve for pRAM. You can overwrite
2188 this default value by defining an environment
2189 variable "pram" to the number of kB you want to
2190 reserve. Note that the board info structure will
2191 still show the full amount of RAM. If pRAM is
2192 reserved, a new environment variable "mem" will
2193 automatically be defined to hold the amount of
2194 remaining RAM in a form that can be passed as boot
2195 argument to Linux, for instance like that:
2196
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002197 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002198 saveenv
2199
2200 This way you can tell Linux not to use this memory,
2201 either, which results in a memory region that will
2202 not be affected by reboots.
2203
2204 *WARNING* If your board configuration uses automatic
2205 detection of the RAM size, you must make sure that
2206 this memory test is non-destructive. So far, the
2207 following board configurations are known to be
2208 "pRAM-clean":
2209
Heiko Schocher65d94db2017-06-07 17:33:09 +02002210 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002211 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002212 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002213
Gabe Blacka2f3a932012-12-02 04:55:18 +00002214- Access to physical memory region (> 4GB)
2215 Some basic support is provided for operations on memory not
2216 normally accessible to U-Boot - e.g. some architectures
2217 support access to more than 4GB of memory on 32-bit
2218 machines using physical address extension or similar.
2219 Define CONFIG_PHYSMEM to access this basic support, which
2220 currently only supports clearing the memory.
2221
wdenkc6097192002-11-03 00:24:07 +00002222- Error Recovery:
2223 CONFIG_PANIC_HANG
2224
2225 Define this variable to stop the system in case of a
2226 fatal error, so that you have to reset it manually.
2227 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002228 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002229 automatically as fast as possible, but it may be
2230 useful during development since you can try to debug
2231 the conditions that lead to the situation.
2232
2233 CONFIG_NET_RETRY_COUNT
2234
wdenk4a5c8a72003-03-06 00:02:04 +00002235 This variable defines the number of retries for
2236 network operations like ARP, RARP, TFTP, or BOOTP
2237 before giving up the operation. If not defined, a
2238 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002239
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002240 CONFIG_ARP_TIMEOUT
2241
2242 Timeout waiting for an ARP reply in milliseconds.
2243
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002244 CONFIG_NFS_TIMEOUT
2245
2246 Timeout in milliseconds used in NFS protocol.
2247 If you encounter "ERROR: Cannot umount" in nfs command,
2248 try longer timeout such as
2249 #define CONFIG_NFS_TIMEOUT 10000UL
2250
wdenkc6097192002-11-03 00:24:07 +00002251- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002252 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002253
2254 Enable auto completion of commands using TAB.
2255
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002256 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002257
2258 This defines the secondary prompt string, which is
2259 printed when the command interpreter needs more input
2260 to complete a command. Usually "> ".
2261
2262 Note:
2263
wdenk57b2d802003-06-27 21:31:46 +00002264 In the current implementation, the local variables
2265 space and global environment variables space are
2266 separated. Local variables are those you define by
2267 simply typing `name=value'. To access a local
2268 variable later on, you have write `$name' or
2269 `${name}'; to execute the contents of a variable
2270 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002271
wdenk4a5c8a72003-03-06 00:02:04 +00002272 Global environment variables are those you use
2273 setenv/printenv to work with. To run a command stored
2274 in such a variable, you need to use the run command,
2275 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002276
2277 To store commands and special characters in a
2278 variable, please use double quotation marks
2279 surrounding the whole text of the variable, instead
2280 of the backslashes before semicolons and special
2281 symbols.
2282
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002283- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002284 CONFIG_CMDLINE_EDITING
2285
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002287 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002288
Marek Vasut734fb042016-01-27 04:47:55 +01002289- Command Line PS1/PS2 support:
2290 CONFIG_CMDLINE_PS_SUPPORT
2291
2292 Enable support for changing the command prompt string
2293 at run-time. Only static string is supported so far.
2294 The string is obtained from environment variables PS1
2295 and PS2.
2296
wdenkc0aa5c52003-12-06 19:49:23 +00002297- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002298 CONFIG_EXTRA_ENV_SETTINGS
2299
wdenk4a5c8a72003-03-06 00:02:04 +00002300 Define this to contain any number of null terminated
2301 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002302 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002303
wdenk4a5c8a72003-03-06 00:02:04 +00002304 For example, place something like this in your
2305 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002306
2307 #define CONFIG_EXTRA_ENV_SETTINGS \
2308 "myvar1=value1\0" \
2309 "myvar2=value2\0"
2310
wdenk4a5c8a72003-03-06 00:02:04 +00002311 Warning: This method is based on knowledge about the
2312 internal format how the environment is stored by the
2313 U-Boot code. This is NOT an official, exported
2314 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002315 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002316 You better know what you are doing here.
2317
wdenk4a5c8a72003-03-06 00:02:04 +00002318 Note: overly (ab)use of the default environment is
2319 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002320 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002321 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002322
Stephen Warren1465d5f2012-05-22 09:21:54 +00002323 CONFIG_ENV_VARS_UBOOT_CONFIG
2324
2325 Define this in order to add variables describing the
2326 U-Boot build configuration to the default environment.
2327 These will be named arch, cpu, board, vendor, and soc.
2328
2329 Enabling this option will cause the following to be defined:
2330
2331 - CONFIG_SYS_ARCH
2332 - CONFIG_SYS_CPU
2333 - CONFIG_SYS_BOARD
2334 - CONFIG_SYS_VENDOR
2335 - CONFIG_SYS_SOC
2336
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002337 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2338
2339 Define this in order to add variables describing certain
2340 run-time determined information about the hardware to the
2341 environment. These will be named board_name, board_rev.
2342
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002343 CONFIG_DELAY_ENVIRONMENT
2344
2345 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002346 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002347 that so that the environment is not available until
2348 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2349 this is instead controlled by the value of
2350 /config/load-environment.
2351
wdenkc0aa5c52003-12-06 19:49:23 +00002352- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002353 CONFIG_HAS_DATAFLASH
2354
wdenk57b2d802003-06-27 21:31:46 +00002355 Defining this option enables DataFlash features and
2356 allows to read/write in Dataflash via the standard
2357 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002358
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002359- Serial Flash support
Simon Glass663b0cc2017-08-04 16:35:06 -06002360 Usage requires an initial 'sf probe' to define the serial
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002361 flash parameters, followed by read/write/erase/update
2362 commands.
2363
2364 The following defaults may be provided by the platform
2365 to handle the common case when only a single serial
2366 flash is present on the system.
2367
2368 CONFIG_SF_DEFAULT_BUS Bus identifier
2369 CONFIG_SF_DEFAULT_CS Chip-select
2370 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2371 CONFIG_SF_DEFAULT_SPEED in Hz
2372
wdenkef893942004-02-23 16:11:30 +00002373 CONFIG_SYSTEMACE
2374
2375 Adding this option adds support for Xilinx SystemACE
2376 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002377 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002378 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002379
2380 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002381 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002382
2383 When SystemACE support is added, the "ace" device type
2384 becomes available to the fat commands, i.e. fatls.
2385
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002386- TFTP Fixed UDP Port:
2387 CONFIG_TFTP_PORT
2388
Wolfgang Denk227b5192005-09-24 23:25:46 +02002389 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002390 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002391 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002392 number generator is used.
2393
Wolfgang Denk227b5192005-09-24 23:25:46 +02002394 Also, the environment variable tftpdstp is used to supply
2395 the TFTP UDP destination port value. If tftpdstp isn't
2396 defined, the normal port 69 is used.
2397
2398 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002399 blindly start the TFTP transfer using the pre-configured
2400 target IP address and UDP port. This has the effect of
2401 "punching through" the (Windows XP) firewall, allowing
2402 the remainder of the TFTP transfer to proceed normally.
2403 A better solution is to properly configure the firewall,
2404 but sometimes that is not allowed.
2405
Heiko Schocher443ca402014-01-25 07:27:13 +01002406- bootcount support:
2407 CONFIG_BOOTCOUNT_LIMIT
2408
2409 This enables the bootcounter support, see:
2410 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2411
2412 CONFIG_AT91SAM9XE
2413 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002414 CONFIG_SOC_DA8XX
2415 enable special bootcounter support on da850 based boards.
2416 CONFIG_BOOTCOUNT_RAM
2417 enable support for the bootcounter in RAM
2418 CONFIG_BOOTCOUNT_I2C
2419 enable support for the bootcounter on an i2c (like RTC) device.
2420 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2421 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2422 the bootcounter.
2423 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002424
wdenkc0aa5c52003-12-06 19:49:23 +00002425- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002426 CONFIG_SHOW_BOOT_PROGRESS
2427
wdenk4a5c8a72003-03-06 00:02:04 +00002428 Defining this option allows to add some board-
2429 specific code (calling a user-provided function
2430 "show_boot_progress(int)") that enables you to show
2431 the system's boot progress on some display (for
2432 example, some LED's) on your board. At the moment,
2433 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002434
Simon Glass0fa36a42012-09-28 08:56:37 +00002435
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002436Legacy uImage format:
2437
wdenkc6097192002-11-03 00:24:07 +00002438 Arg Where When
2439 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002440 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002441 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002442 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002443 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002444 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002445 4 common/cmd_bootm.c Image data has correct checksum
2446 -4 common/cmd_bootm.c Image is for unsupported architecture
2447 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002448 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002449 6 common/cmd_bootm.c Image Type check OK
2450 -6 common/cmd_bootm.c gunzip uncompression error
2451 -7 common/cmd_bootm.c Unimplemented compression type
2452 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002453 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002454 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002455
2456 9 common/image.c Start initial ramdisk verification
2457 -10 common/image.c Ramdisk header has bad magic number
2458 -11 common/image.c Ramdisk header has bad checksum
2459 10 common/image.c Ramdisk header is OK
2460 -12 common/image.c Ramdisk data has bad checksum
2461 11 common/image.c Ramdisk data has correct checksum
2462 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002463 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002464 13 common/image.c Start multifile image verification
2465 14 common/image.c No initial ramdisk, no multifile, continue.
2466
Wolfgang Denk092ae952011-10-26 10:21:21 +00002467 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002468
Stefan Roese88fbf932010-04-15 16:07:28 +02002469 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002470 -31 post/post.c POST test failed, detected by post_output_backlog()
2471 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002472
Heiko Schocher633e03a2007-06-22 19:11:54 +02002473 34 common/cmd_doc.c before loading a Image from a DOC device
2474 -35 common/cmd_doc.c Bad usage of "doc" command
2475 35 common/cmd_doc.c correct usage of "doc" command
2476 -36 common/cmd_doc.c No boot device
2477 36 common/cmd_doc.c correct boot device
2478 -37 common/cmd_doc.c Unknown Chip ID on boot device
2479 37 common/cmd_doc.c correct chip ID found, device available
2480 -38 common/cmd_doc.c Read Error on boot device
2481 38 common/cmd_doc.c reading Image header from DOC device OK
2482 -39 common/cmd_doc.c Image header has bad magic number
2483 39 common/cmd_doc.c Image header has correct magic number
2484 -40 common/cmd_doc.c Error reading Image from DOC device
2485 40 common/cmd_doc.c Image header has correct magic number
2486 41 common/cmd_ide.c before loading a Image from a IDE device
2487 -42 common/cmd_ide.c Bad usage of "ide" command
2488 42 common/cmd_ide.c correct usage of "ide" command
2489 -43 common/cmd_ide.c No boot device
2490 43 common/cmd_ide.c boot device found
2491 -44 common/cmd_ide.c Device not available
2492 44 common/cmd_ide.c Device available
2493 -45 common/cmd_ide.c wrong partition selected
2494 45 common/cmd_ide.c partition selected
2495 -46 common/cmd_ide.c Unknown partition table
2496 46 common/cmd_ide.c valid partition table found
2497 -47 common/cmd_ide.c Invalid partition type
2498 47 common/cmd_ide.c correct partition type
2499 -48 common/cmd_ide.c Error reading Image Header on boot device
2500 48 common/cmd_ide.c reading Image Header from IDE device OK
2501 -49 common/cmd_ide.c Image header has bad magic number
2502 49 common/cmd_ide.c Image header has correct magic number
2503 -50 common/cmd_ide.c Image header has bad checksum
2504 50 common/cmd_ide.c Image header has correct checksum
2505 -51 common/cmd_ide.c Error reading Image from IDE device
2506 51 common/cmd_ide.c reading Image from IDE device OK
2507 52 common/cmd_nand.c before loading a Image from a NAND device
2508 -53 common/cmd_nand.c Bad usage of "nand" command
2509 53 common/cmd_nand.c correct usage of "nand" command
2510 -54 common/cmd_nand.c No boot device
2511 54 common/cmd_nand.c boot device found
2512 -55 common/cmd_nand.c Unknown Chip ID on boot device
2513 55 common/cmd_nand.c correct chip ID found, device available
2514 -56 common/cmd_nand.c Error reading Image Header on boot device
2515 56 common/cmd_nand.c reading Image Header from NAND device OK
2516 -57 common/cmd_nand.c Image header has bad magic number
2517 57 common/cmd_nand.c Image header has correct magic number
2518 -58 common/cmd_nand.c Error reading Image from NAND device
2519 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002520
Heiko Schocher633e03a2007-06-22 19:11:54 +02002521 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002522
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002523 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002524 -64 net/eth.c no Ethernet found.
2525 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002526
Heiko Schocher633e03a2007-06-22 19:11:54 +02002527 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002528 80 common/cmd_net.c before calling net_loop()
2529 -81 common/cmd_net.c some error in net_loop() occurred
2530 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002531 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2532 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002533 83 common/cmd_net.c running "source" command
2534 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002535 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002536
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002537FIT uImage format:
2538
2539 Arg Where When
2540 100 common/cmd_bootm.c Kernel FIT Image has correct format
2541 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2542 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2543 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2544 102 common/cmd_bootm.c Kernel unit name specified
2545 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002546 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002547 104 common/cmd_bootm.c Got kernel subimage node offset
2548 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2549 105 common/cmd_bootm.c Kernel subimage hash verification OK
2550 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2551 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002552 -106 common/cmd_bootm.c Kernel subimage has wrong type
2553 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002554 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2555 108 common/cmd_bootm.c Got kernel subimage data/size
2556 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2557 -109 common/cmd_bootm.c Can't get kernel subimage type
2558 -110 common/cmd_bootm.c Can't get kernel subimage comp
2559 -111 common/cmd_bootm.c Can't get kernel subimage os
2560 -112 common/cmd_bootm.c Can't get kernel subimage load address
2561 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2562
2563 120 common/image.c Start initial ramdisk verification
2564 -120 common/image.c Ramdisk FIT image has incorrect format
2565 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002566 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002567 -122 common/image.c Can't get configuration for ramdisk subimage
2568 123 common/image.c Ramdisk unit name specified
2569 -124 common/image.c Can't get ramdisk subimage node offset
2570 125 common/image.c Got ramdisk subimage node offset
2571 -125 common/image.c Ramdisk subimage hash verification failed
2572 126 common/image.c Ramdisk subimage hash verification OK
2573 -126 common/image.c Ramdisk subimage for unsupported architecture
2574 127 common/image.c Architecture check OK
2575 -127 common/image.c Can't get ramdisk subimage data/size
2576 128 common/image.c Got ramdisk subimage data/size
2577 129 common/image.c Can't get ramdisk load address
2578 -129 common/image.c Got ramdisk load address
2579
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002580 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002581 131 common/cmd_doc.c FIT image format OK
2582
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002583 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002584 141 common/cmd_ide.c FIT image format OK
2585
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002586 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002587 151 common/cmd_nand.c FIT image format OK
2588
Heiko Schocher515eb122014-05-28 11:33:33 +02002589- legacy image format:
2590 CONFIG_IMAGE_FORMAT_LEGACY
2591 enables the legacy image format support in U-Boot.
2592
2593 Default:
2594 enabled if CONFIG_FIT_SIGNATURE is not defined.
2595
2596 CONFIG_DISABLE_IMAGE_LEGACY
2597 disable the legacy image format
2598
2599 This define is introduced, as the legacy image format is
2600 enabled per default for backward compatibility.
2601
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002602- Standalone program support:
2603 CONFIG_STANDALONE_LOAD_ADDR
2604
Wolfgang Denk23f78482011-10-09 21:06:34 +02002605 This option defines a board specific value for the
2606 address where standalone program gets loaded, thus
2607 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002608 settings.
2609
2610- Frame Buffer Address:
2611 CONFIG_FB_ADDR
2612
2613 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002614 address for frame buffer. This is typically the case
2615 when using a graphics controller has separate video
2616 memory. U-Boot will then place the frame buffer at
2617 the given address instead of dynamically reserving it
2618 in system RAM by calling lcd_setmem(), which grabs
2619 the memory for the frame buffer depending on the
2620 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002621
2622 Please see board_init_f function.
2623
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002624- Automatic software updates via TFTP server
2625 CONFIG_UPDATE_TFTP
2626 CONFIG_UPDATE_TFTP_CNT_MAX
2627 CONFIG_UPDATE_TFTP_MSEC_MAX
2628
2629 These options enable and control the auto-update feature;
2630 for a more detailed description refer to doc/README.update.
2631
2632- MTD Support (mtdparts command, UBI support)
2633 CONFIG_MTD_DEVICE
2634
2635 Adds the MTD device infrastructure from the Linux kernel.
2636 Needed for mtdparts command support.
2637
2638 CONFIG_MTD_PARTITIONS
2639
2640 Adds the MTD partitioning infrastructure from the Linux
2641 kernel. Needed for UBI support.
2642
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002643- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002644 CONFIG_UBI_SILENCE_MSG
2645
2646 Make the verbose messages from UBI stop printing. This leaves
2647 warnings and errors enabled.
2648
Heiko Schocherf5895d12014-06-24 10:10:04 +02002649
2650 CONFIG_MTD_UBI_WL_THRESHOLD
2651 This parameter defines the maximum difference between the highest
2652 erase counter value and the lowest erase counter value of eraseblocks
2653 of UBI devices. When this threshold is exceeded, UBI starts performing
2654 wear leveling by means of moving data from eraseblock with low erase
2655 counter to eraseblocks with high erase counter.
2656
2657 The default value should be OK for SLC NAND flashes, NOR flashes and
2658 other flashes which have eraseblock life-cycle 100000 or more.
2659 However, in case of MLC NAND flashes which typically have eraseblock
2660 life-cycle less than 10000, the threshold should be lessened (e.g.,
2661 to 128 or 256, although it does not have to be power of 2).
2662
2663 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002664
Heiko Schocherf5895d12014-06-24 10:10:04 +02002665 CONFIG_MTD_UBI_BEB_LIMIT
2666 This option specifies the maximum bad physical eraseblocks UBI
2667 expects on the MTD device (per 1024 eraseblocks). If the
2668 underlying flash does not admit of bad eraseblocks (e.g. NOR
2669 flash), this value is ignored.
2670
2671 NAND datasheets often specify the minimum and maximum NVM
2672 (Number of Valid Blocks) for the flashes' endurance lifetime.
2673 The maximum expected bad eraseblocks per 1024 eraseblocks
2674 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2675 which gives 20 for most NANDs (MaxNVB is basically the total
2676 count of eraseblocks on the chip).
2677
2678 To put it differently, if this value is 20, UBI will try to
2679 reserve about 1.9% of physical eraseblocks for bad blocks
2680 handling. And that will be 1.9% of eraseblocks on the entire
2681 NAND chip, not just the MTD partition UBI attaches. This means
2682 that if you have, say, a NAND flash chip admits maximum 40 bad
2683 eraseblocks, and it is split on two MTD partitions of the same
2684 size, UBI will reserve 40 eraseblocks when attaching a
2685 partition.
2686
2687 default: 20
2688
2689 CONFIG_MTD_UBI_FASTMAP
2690 Fastmap is a mechanism which allows attaching an UBI device
2691 in nearly constant time. Instead of scanning the whole MTD device it
2692 only has to locate a checkpoint (called fastmap) on the device.
2693 The on-flash fastmap contains all information needed to attach
2694 the device. Using fastmap makes only sense on large devices where
2695 attaching by scanning takes long. UBI will not automatically install
2696 a fastmap on old images, but you can set the UBI parameter
2697 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2698 that fastmap-enabled images are still usable with UBI implementations
2699 without fastmap support. On typical flash devices the whole fastmap
2700 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2701
2702 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2703 Set this parameter to enable fastmap automatically on images
2704 without a fastmap.
2705 default: 0
2706
Heiko Schocher94b66de2015-10-22 06:19:21 +02002707 CONFIG_MTD_UBI_FM_DEBUG
2708 Enable UBI fastmap debug
2709 default: 0
2710
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002711- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002712 CONFIG_UBIFS_SILENCE_MSG
2713
2714 Make the verbose messages from UBIFS stop printing. This leaves
2715 warnings and errors enabled.
2716
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002717- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002718 CONFIG_SPL
2719 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002720
Tom Rini36853852012-02-14 07:29:40 +00002721 CONFIG_SPL_LDSCRIPT
2722 LDSCRIPT for linking the SPL binary.
2723
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002724 CONFIG_SPL_MAX_FOOTPRINT
2725 Maximum size in memory allocated to the SPL, BSS included.
2726 When defined, the linker checks that the actual memory
2727 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002728 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002729 must not be both defined at the same time.
2730
Tom Rini36853852012-02-14 07:29:40 +00002731 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002732 Maximum size of the SPL image (text, data, rodata, and
2733 linker lists sections), BSS excluded.
2734 When defined, the linker checks that the actual size does
2735 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002736
Wolfgang Denk825223d2011-09-11 21:24:09 +02002737 CONFIG_SPL_TEXT_BASE
2738 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002739
Scott Woodc4f0d002012-09-20 19:05:12 -05002740 CONFIG_SPL_RELOC_TEXT_BASE
2741 Address to relocate to. If unspecified, this is equal to
2742 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2743
Tom Rini36853852012-02-14 07:29:40 +00002744 CONFIG_SPL_BSS_START_ADDR
2745 Link address for the BSS within the SPL binary.
2746
2747 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002748 Maximum size in memory allocated to the SPL BSS.
2749 When defined, the linker checks that the actual memory used
2750 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002751 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002752 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002753
2754 CONFIG_SPL_STACK
2755 Adress of the start of the stack SPL will use
2756
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002757 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2758 When defined, SPL will panic() if the image it has
2759 loaded does not have a signature.
2760 Defining this is useful when code which loads images
2761 in SPL cannot guarantee that absolutely all read errors
2762 will be caught.
2763 An example is the LPC32XX MLC NAND driver, which will
2764 consider that a completely unreadable NAND block is bad,
2765 and thus should be skipped silently.
2766
Scott Woodc4f0d002012-09-20 19:05:12 -05002767 CONFIG_SPL_RELOC_STACK
2768 Adress of the start of the stack SPL will use after
2769 relocation. If unspecified, this is equal to
2770 CONFIG_SPL_STACK.
2771
Tom Rini36853852012-02-14 07:29:40 +00002772 CONFIG_SYS_SPL_MALLOC_START
2773 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002774 When this option is set the full malloc is used in SPL and
2775 it is set up by spl_init() and before that, the simple malloc()
2776 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002777
2778 CONFIG_SYS_SPL_MALLOC_SIZE
2779 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002780
Tom Rini28591df2012-08-13 12:03:19 -07002781 CONFIG_SPL_FRAMEWORK
2782 Enable the SPL framework under common/. This framework
2783 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2784 NAND loading of the Linux Kernel.
2785
Tom Rinic2b76002014-03-28 12:03:39 -04002786 CONFIG_SPL_OS_BOOT
2787 Enable booting directly to an OS from SPL.
2788 See also: doc/README.falcon
2789
Tom Rinife3b0c72012-08-13 11:37:56 -07002790 CONFIG_SPL_DISPLAY_PRINT
2791 For ARM, enable an optional function to print more information
2792 about the running system.
2793
Scott Wood7c810902012-09-20 16:35:21 -05002794 CONFIG_SPL_INIT_MINIMAL
2795 Arch init code should be built for a very small image
2796
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002797 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2798 Partition on the MMC to load U-Boot from when the MMC is being
2799 used in raw mode
2800
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002801 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2802 Sector to load kernel uImage from when MMC is being
2803 used in raw mode (for Falcon mode)
2804
2805 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2806 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2807 Sector and number of sectors to load kernel argument
2808 parameters from when MMC is being used in raw mode
2809 (for falcon mode)
2810
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002811 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2812 Partition on the MMC to load U-Boot from when the MMC is being
2813 used in fs mode
2814
Guillaume GARDET5065b712014-10-15 17:53:13 +02002815 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2816 Filename to read to load U-Boot when reading from filesystem
2817
2818 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002819 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002820 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002821
Guillaume GARDET5065b712014-10-15 17:53:13 +02002822 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002823 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002824 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002825
Scott Wood2b36fbb2012-12-06 13:33:17 +00002826 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2827 Set this for NAND SPL on PPC mpc83xx targets, so that
2828 start.S waits for the rest of the SPL to load before
2829 continuing (the hardware starts execution after just
2830 loading the first page rather than the full 4K).
2831
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302832 CONFIG_SPL_SKIP_RELOCATE
2833 Avoid SPL relocation
2834
Scott Woodc352a0c2012-09-20 19:09:07 -05002835 CONFIG_SPL_NAND_BASE
2836 Include nand_base.c in the SPL. Requires
2837 CONFIG_SPL_NAND_DRIVERS.
2838
2839 CONFIG_SPL_NAND_DRIVERS
2840 SPL uses normal NAND drivers, not minimal drivers.
2841
2842 CONFIG_SPL_NAND_ECC
2843 Include standard software ECC in the SPL
2844
Tom Rini36853852012-02-14 07:29:40 +00002845 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002846 Support for NAND boot using simple NAND drivers that
2847 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002848
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002849 CONFIG_SPL_UBI
2850 Support for a lightweight UBI (fastmap) scanner and
2851 loader
2852
Heiko Schochercf000272014-10-31 08:31:00 +01002853 CONFIG_SPL_NAND_RAW_ONLY
2854 Support to boot only raw u-boot.bin images. Use this only
2855 if you need to save space.
2856
Ying Zhangdfb2b152013-08-16 15:16:12 +08002857 CONFIG_SPL_COMMON_INIT_DDR
2858 Set for common ddr init with serial presence detect in
2859 SPL binary.
2860
Tom Rini36853852012-02-14 07:29:40 +00002861 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2862 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2863 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2864 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2865 CONFIG_SYS_NAND_ECCBYTES
2866 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002867 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002868
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302869 CONFIG_SPL_NAND_BOOT
2870 Add support NAND boot
2871
Tom Rini36853852012-02-14 07:29:40 +00002872 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002873 Location in NAND to read U-Boot from
2874
2875 CONFIG_SYS_NAND_U_BOOT_DST
2876 Location in memory to load U-Boot to
2877
2878 CONFIG_SYS_NAND_U_BOOT_SIZE
2879 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002880
2881 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002882 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002883
2884 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2885 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002886 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002887
2888 CONFIG_SPL_OMAP3_ID_NAND
2889 Support for an OMAP3-specific set of functions to return the
2890 ID and MFR of the first attached NAND chip, if present.
2891
Pavel Machekde997252012-08-30 22:42:11 +02002892 CONFIG_SPL_RAM_DEVICE
2893 Support for running image already present in ram, in SPL binary
2894
Scott Woodeb7bd972012-12-06 13:33:16 +00002895 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002896 Image offset to which the SPL should be padded before appending
2897 the SPL payload. By default, this is defined as
2898 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2899 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2900 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002901
Scott Woodf147eb72012-09-21 16:27:32 -05002902 CONFIG_SPL_TARGET
2903 Final target image containing SPL and payload. Some SPLs
2904 use an arch-specific makefile fragment instead, for
2905 example if more than one image needs to be produced.
2906
Simon Glass82d94532013-05-08 08:05:59 +00002907 CONFIG_FIT_SPL_PRINT
2908 Printing information about a FIT image adds quite a bit of
2909 code to SPL. So this is normally disabled in SPL. Use this
2910 option to re-enable it. This will affect the output of the
2911 bootm command when booting a FIT image.
2912
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002913- TPL framework
2914 CONFIG_TPL
2915 Enable building of TPL globally.
2916
2917 CONFIG_TPL_PAD_TO
2918 Image offset to which the TPL should be padded before appending
2919 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002920 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2921 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2922 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002923
wdenkc0aa5c52003-12-06 19:49:23 +00002924- Interrupt support (PPC):
2925
wdenk1ebf41e2004-01-02 14:00:00 +00002926 There are common interrupt_init() and timer_interrupt()
2927 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002928 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002929 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002930 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002931 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002932 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002933 specific handling. If board has watchdog / status_led
2934 / other_activity_monitor it works automatically from
2935 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002936
wdenkc6097192002-11-03 00:24:07 +00002937
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002938Board initialization settings:
2939------------------------------
2940
2941During Initialization u-boot calls a number of board specific functions
2942to allow the preparation of board specific prerequisites, e.g. pin setup
2943before drivers are initialized. To enable these callbacks the
2944following configuration macros have to be defined. Currently this is
2945architecture specific, so please check arch/your_architecture/lib/board.c
2946typically in board_init_f() and board_init_r().
2947
2948- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2949- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2950- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2951- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002952
wdenkc6097192002-11-03 00:24:07 +00002953Configuration Settings:
2954-----------------------
2955
York Sun6c480012014-02-26 17:03:19 -08002956- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2957 Optionally it can be defined to support 64-bit memory commands.
2958
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002959- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002960 undefine this when you're short of memory.
2961
Peter Tyserdfb72b82009-01-27 18:03:12 -06002962- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2963 width of the commands listed in the 'help' command output.
2964
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002965- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002966 prompt for user input.
2967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002968- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002969
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002970- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002972- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002974- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002975 the application (usually a Linux kernel) when it is
2976 booted
2977
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002978- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002979 List of legal baudrate settings for this board.
2980
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002981- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002982 Begin and End addresses of the area used by the
2983 simple memory test.
2984
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002985- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002986 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002988- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002989 Scratch address used by the alternate memory test
2990 You only need to set this if address zero isn't writeable
2991
York Sun5d286cd2015-12-04 11:57:07 -08002992- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002993 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002994 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2995 is substracted from total RAM and won't be reported to OS.
2996 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002997 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002998 the RAM base is not zero, or RAM is divided into banks,
2999 this variable needs to be recalcuated to get the address.
3000
York Sun50739372015-12-07 11:05:29 -08003001- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003002 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003003 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003004 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003005 fixing up gd->ram_size the Linux kernel should gets passed
3006 the now "corrected" memory size and won't touch it either.
3007 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003008 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003009 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003010 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003011
3012 This option can be used as a workaround for the 440EPx/GRx
3013 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3014 be touched.
3015
3016 WARNING: Please make sure that this value is a multiple of
3017 the Linux page size (normally 4k). If this is not the case,
3018 then the end address of the Linux memory will be located at a
3019 non page size aligned address and this could cause major
3020 problems.
3021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003022- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003023 Enable temporary baudrate change while serial download
3024
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003025- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003026 Physical start address of SDRAM. _Must_ be 0 here.
3027
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003028- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003029 Physical start address of Flash memory.
3030
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003031- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003032 Physical start address of boot monitor code (set by
3033 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003034 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003035 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003036
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003037- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003038 Size of memory reserved for monitor code, used to
3039 determine _at_compile_time_ (!) if the environment is
3040 embedded within the U-Boot image, or in a separate
3041 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003042
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003043- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003044 Size of DRAM reserved for malloc() use.
3045
Simon Glass863e4042014-07-10 22:23:28 -06003046- CONFIG_SYS_MALLOC_F_LEN
3047 Size of the malloc() pool for use before relocation. If
3048 this is defined, then a very simple malloc() implementation
3049 will become available before relocation. The address is just
3050 below the global data, and the stack is moved down to make
3051 space.
3052
3053 This feature allocates regions with increasing addresses
3054 within the region. calloc() is supported, but realloc()
3055 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003056 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003057 U-Boot relocates itself.
3058
Simon Glass9fa901b2014-11-10 17:16:54 -07003059- CONFIG_SYS_MALLOC_SIMPLE
3060 Provides a simple and small malloc() and calloc() for those
3061 boards which do not use the full malloc in SPL (which is
3062 enabled with CONFIG_SYS_SPL_MALLOC_START).
3063
Thierry Redingc97d9742014-12-09 22:25:22 -07003064- CONFIG_SYS_NONCACHED_MEMORY:
3065 Size of non-cached memory area. This area of memory will be
3066 typically located right below the malloc() area and mapped
3067 uncached in the MMU. This is useful for drivers that would
3068 otherwise require a lot of explicit cache maintenance. For
3069 some drivers it's also impossible to properly maintain the
3070 cache. For example if the regions that need to be flushed
3071 are not a multiple of the cache-line size, *and* padding
3072 cannot be allocated between the regions to align them (i.e.
3073 if the HW requires a contiguous array of regions, and the
3074 size of each region is not cache-aligned), then a flush of
3075 one region may result in overwriting data that hardware has
3076 written to another region in the same cache-line. This can
3077 happen for example in network drivers where descriptors for
3078 buffers are typically smaller than the CPU cache-line (e.g.
3079 16 bytes vs. 32 or 64 bytes).
3080
3081 Non-cached memory is only supported on 32-bit ARM at present.
3082
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003083- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003084 Normally compressed uImages are limited to an
3085 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003086 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003087 to adjust this setting to your needs.
3088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003089- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003090 Maximum size of memory mapped by the startup code of
3091 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003092 the Linux kernel (bd_info, boot arguments, FDT blob if
3093 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003094 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003095 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003096 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003097 variable "bootm_mapsize" will override the value of
3098 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3099 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003100
John Rigbyeea8e692010-10-13 13:57:35 -06003101- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3102 Enable initrd_high functionality. If defined then the
3103 initrd_high feature is enabled and the bootm ramdisk subcommand
3104 is enabled.
3105
3106- CONFIG_SYS_BOOT_GET_CMDLINE:
3107 Enables allocating and saving kernel cmdline in space between
3108 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3109
3110- CONFIG_SYS_BOOT_GET_KBD:
3111 Enables allocating and saving a kernel copy of the bd_info in
3112 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003114- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003115 Max number of Flash memory banks
3116
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003117- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003118 Max number of sectors on a Flash chip
3119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003120- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003121 Timeout for Flash erase operations (in ms)
3122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003123- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003124 Timeout for Flash write operations (in ms)
3125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003126- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003127 Timeout for Flash set sector lock bit operation (in ms)
3128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003129- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003130 Timeout for Flash clear lock bits operation (in ms)
3131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003132- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003133 If defined, hardware flash sectors protection is used
3134 instead of U-Boot software protection.
3135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003136- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003137
3138 Enable TFTP transfers directly to flash memory;
3139 without this option such a download has to be
3140 performed in two steps: (1) download to RAM, and (2)
3141 copy from RAM to flash.
3142
3143 The two-step approach is usually more reliable, since
3144 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003145 the flash, but in some situations (when system RAM is
3146 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003147 downloaded image) this option may be very useful.
3148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003149- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003150 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003151 common flash structure for storing flash geometry.
3152
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003153- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003154 This option also enables the building of the cfi_flash driver
3155 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003156
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003157- CONFIG_FLASH_CFI_MTD
3158 This option enables the building of the cfi_mtd driver
3159 in the drivers directory. The driver exports CFI flash
3160 to the MTD layer.
3161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003162- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003163 Use buffered writes to flash.
3164
3165- CONFIG_FLASH_SPANSION_S29WS_N
3166 s29ws-n MirrorBit flash has non-standard addresses for buffered
3167 write commands.
3168
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003169- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003170 If this option is defined, the common CFI flash doesn't
3171 print it's warning upon not recognized FLASH banks. This
3172 is useful, if some of the configured banks are only
3173 optionally available.
3174
Jerry Van Barenaae73572008-03-08 13:48:01 -05003175- CONFIG_FLASH_SHOW_PROGRESS
3176 If defined (must be an integer), print out countdown
3177 digits and dots. Recommended value: 45 (9..1) for 80
3178 column displays, 15 (3..1) for 40 column displays.
3179
Stefan Roesed20cba52013-04-04 15:53:14 +02003180- CONFIG_FLASH_VERIFY
3181 If defined, the content of the flash (destination) is compared
3182 against the source after the write operation. An error message
3183 will be printed when the contents are not identical.
3184 Please note that this option is useless in nearly all cases,
3185 since such flash programming errors usually are detected earlier
3186 while unprotecting/erasing/programming. Please only enable
3187 this option if you really know what you are doing.
3188
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003189- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003190 Defines the number of Ethernet receive buffers. On some
3191 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003192 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3193 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003194 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003195 Defaults to 4 if not defined.
3196
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003197- CONFIG_ENV_MAX_ENTRIES
3198
Wolfgang Denk1136f692010-10-27 22:48:30 +02003199 Maximum number of entries in the hash table that is used
3200 internally to store the environment settings. The default
3201 setting is supposed to be generous and should work in most
3202 cases. This setting can be used to tune behaviour; see
3203 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003204
Joe Hershberger71497d02012-12-11 22:16:31 -06003205- CONFIG_ENV_FLAGS_LIST_DEFAULT
3206- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003207 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003208 calling env set. Variables can be restricted to only decimal,
3209 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3210 the variables can also be restricted to IP address or MAC address.
3211
3212 The format of the list is:
3213 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003214 access_attribute = [a|r|o|c]
3215 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003216 entry = variable_name[:attributes]
3217 list = entry[,list]
3218
3219 The type attributes are:
3220 s - String (default)
3221 d - Decimal
3222 x - Hexadecimal
3223 b - Boolean ([1yYtT|0nNfF])
3224 i - IP address
3225 m - MAC address
3226
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003227 The access attributes are:
3228 a - Any (default)
3229 r - Read-only
3230 o - Write-once
3231 c - Change-default
3232
Joe Hershberger71497d02012-12-11 22:16:31 -06003233 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3234 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003235 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003236
3237 - CONFIG_ENV_FLAGS_LIST_STATIC
3238 Define this to a list (string) to define validation that
3239 should be done if an entry is not found in the ".flags"
3240 environment variable. To override a setting in the static
3241 list, simply add an entry for the same variable name to the
3242 ".flags" variable.
3243
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003244 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3245 regular expression. This allows multiple variables to define the same
3246 flags without explicitly listing them for each variable.
3247
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003248- CONFIG_ENV_ACCESS_IGNORE_FORCE
3249 If defined, don't allow the -f switch to env set override variable
3250 access flags.
3251
Gabe Black3687fe42014-10-15 04:38:30 -06003252- CONFIG_USE_STDINT
3253 If stdint.h is available with your toolchain you can define this
3254 option to enable it. You can provide option 'USE_STDINT=1' when
3255 building U-Boot to enable this.
3256
wdenkc6097192002-11-03 00:24:07 +00003257The following definitions that deal with the placement and management
3258of environment data (variable area); in general, we support the
3259following configurations:
3260
Mike Frysinger63b8f122011-07-08 10:44:25 +00003261- CONFIG_BUILD_ENVCRC:
3262
3263 Builds up envcrc with the target environment so that external utils
3264 may easily extract it and embed it in final U-Boot images.
3265
wdenkc6097192002-11-03 00:24:07 +00003266BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003267in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003268console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003269U-Boot will hang.
3270
3271Please note that even with NVRAM we still use a copy of the
3272environment in RAM: we could work on NVRAM directly, but we want to
3273keep settings there always unmodified except somebody uses "saveenv"
3274to save the current settings.
3275
Liu Gang85bcd732012-03-08 00:33:20 +00003276BE CAREFUL! For some special cases, the local device can not use
3277"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003278environment stored in a remote NOR flash by SRIO or PCIE link,
3279but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003280
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003281- CONFIG_NAND_ENV_DST
3282
3283 Defines address in RAM to which the nand_spl code should copy the
3284 environment. If redundant environment is used, it will be copied to
3285 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3286
Bruce Adleredecc942007-11-02 13:15:42 -07003287Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003288has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06003289created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003290until then to read environment variables.
3291
wdenk8dba0502003-03-31 16:34:49 +00003292The environment is protected by a CRC32 checksum. Before the monitor
3293is relocated into RAM, as a result of a bad CRC you will be working
3294with the compiled-in default environment - *silently*!!! [This is
3295necessary, because the first environment variable we need is the
3296"baudrate" setting for the console - if we have a bad CRC, we don't
3297have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003298
3299Note: once the monitor has been relocated, then it will complain if
3300the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003301use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003304 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003306 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003307 also needs to be defined.
3308
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003309- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003310 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003311
Ron Madriddfa028a2009-02-18 14:30:44 -08003312- CONFIG_NS16550_MIN_FUNCTIONS:
3313 Define this if you desire to only have use of the NS16550_init
3314 and NS16550_putc functions for the serial driver located at
3315 drivers/serial/ns16550.c. This option is useful for saving
3316 space for already greatly restricted images, including but not
3317 limited to NAND_SPL configurations.
3318
Simon Glass28a9e332012-11-30 13:01:18 +00003319- CONFIG_DISPLAY_BOARDINFO
3320 Display information about the board that U-Boot is running on
3321 when U-Boot starts up. The board function checkboard() is called
3322 to do this.
3323
Simon Glasse8822012012-11-30 13:01:19 +00003324- CONFIG_DISPLAY_BOARDINFO_LATE
3325 Similar to the previous option, but display this information
3326 later, once stdio is running and output goes to the LCD, if
3327 present.
3328
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003329- CONFIG_BOARD_SIZE_LIMIT:
3330 Maximum size of the U-Boot image. When defined, the
3331 build system checks that the actual size does not
3332 exceed it.
3333
wdenkc6097192002-11-03 00:24:07 +00003334Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003335---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003336
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003337- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003338 Cache Line Size of the CPU.
3339
Timur Tabid8f341c2011-08-04 18:03:41 -05003340- CONFIG_SYS_CCSRBAR_DEFAULT:
3341 Default (power-on reset) physical address of CCSR on Freescale
3342 PowerPC SOCs.
3343
3344- CONFIG_SYS_CCSRBAR:
3345 Virtual address of CCSR. On a 32-bit build, this is typically
3346 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3347
Timur Tabid8f341c2011-08-04 18:03:41 -05003348- CONFIG_SYS_CCSRBAR_PHYS:
3349 Physical address of CCSR. CCSR can be relocated to a new
3350 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003351 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003352 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3353 is typically relocated on 36-bit builds. It is recommended
3354 that this macro be defined via the _HIGH and _LOW macros:
3355
3356 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3357 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3358
3359- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003360 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3361 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003362 used in assembly code, so it must not contain typecasts or
3363 integer size suffixes (e.g. "ULL").
3364
3365- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3366 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3367 used in assembly code, so it must not contain typecasts or
3368 integer size suffixes (e.g. "ULL").
3369
3370- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3371 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3372 forced to a value that ensures that CCSR is not relocated.
3373
wdenk1272e232002-11-10 22:06:23 +00003374- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003375 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003376
3377 the default drive number (default value 0)
3378
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003379 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003380
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003381 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003382 (default value 1)
3383
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003384 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003385
wdenk4a5c8a72003-03-06 00:02:04 +00003386 defines the offset of register from address. It
3387 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003388 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003389
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003390 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3391 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003392 default value.
wdenk1272e232002-11-10 22:06:23 +00003393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003394 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003395 fdc_hw_init() is called at the beginning of the FDC
3396 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003397 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003398 initializations.
wdenk1272e232002-11-10 22:06:23 +00003399
Macpaul Lind1e49942011-04-11 20:45:32 +00003400- CONFIG_IDE_AHB:
3401 Most IDE controllers were designed to be connected with PCI
3402 interface. Only few of them were designed for AHB interface.
3403 When software is doing ATA command and data transfer to
3404 IDE devices through IDE-AHB controller, some additional
3405 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003406 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003408- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003409 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003410 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003411
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003412- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003413
wdenkeb20ad32003-09-05 23:19:14 +00003414 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003415 initial data and stack; please note that this must be
3416 writable memory that is working WITHOUT special
3417 initialization, i. e. you CANNOT use normal RAM which
3418 will become available only after programming the
3419 memory controller and running certain initialization
3420 sequences.
3421
3422 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003423 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003425- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003426
3427 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003428 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3429 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003430 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003431 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003432 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003433 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3434 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003435
3436 Note:
3437 On the MPC824X (or other systems that use the data
3438 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003439 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003440 point to an otherwise UNUSED address space between
3441 the top of RAM and the start of the PCI space.
3442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003443- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003445- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003446 SDRAM timing
3447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003448- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003449 periodic timer for refresh
3450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003451- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3452 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3453 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3454 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003455 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3456
3457- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003458 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3459 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003460 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3461
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003462- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003463 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003464 Don't do any setup work, presumably because someone or
3465 something has already done it, and we don't need to do it
3466 a second time. Useful for platforms that are pre-booted
3467 by coreboot or similar.
3468
Gabor Juhosb4458732013-05-30 07:06:12 +00003469- CONFIG_PCI_INDIRECT_BRIDGE:
3470 Enable support for indirect PCI bridges.
3471
Kumar Gala8975d7a2010-12-30 12:09:53 -06003472- CONFIG_SYS_SRIO:
3473 Chip has SRIO or not
3474
3475- CONFIG_SRIO1:
3476 Board has SRIO 1 port available
3477
3478- CONFIG_SRIO2:
3479 Board has SRIO 2 port available
3480
Liu Gang27afb9c2013-05-07 16:30:46 +08003481- CONFIG_SRIO_PCIE_BOOT_MASTER
3482 Board can support master function for Boot from SRIO and PCIE
3483
Kumar Gala8975d7a2010-12-30 12:09:53 -06003484- CONFIG_SYS_SRIOn_MEM_VIRT:
3485 Virtual Address of SRIO port 'n' memory region
3486
3487- CONFIG_SYS_SRIOn_MEM_PHYS:
3488 Physical Address of SRIO port 'n' memory region
3489
3490- CONFIG_SYS_SRIOn_MEM_SIZE:
3491 Size of SRIO port 'n' memory region
3492
Fabio Estevamf17e8782013-04-11 09:35:34 +00003493- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3494 Defined to tell the NAND controller that the NAND chip is using
3495 a 16 bit bus.
3496 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003497 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003498 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003499 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003500
3501- CONFIG_SYS_NDFC_EBC0_CFG
3502 Sets the EBC0_CFG register for the NDFC. If not defined
3503 a default value will be used.
3504
Ben Warren45657152006-09-07 16:50:54 -04003505- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003506 Get DDR timing information from an I2C EEPROM. Common
3507 with pluggable memory modules such as SODIMMs
3508
Ben Warren45657152006-09-07 16:50:54 -04003509 SPD_EEPROM_ADDRESS
3510 I2C address of the SPD EEPROM
3511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003512- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003513 If SPD EEPROM is on an I2C bus other than the first
3514 one, specify here. Note that the value must resolve
3515 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003516
York Sune73cc042011-06-07 09:42:16 +08003517- CONFIG_SYS_DDR_RAW_TIMING
3518 Get DDR timing information from other than SPD. Common with
3519 soldered DDR chips onboard without SPD. DDR raw timing
3520 parameters are extracted from datasheet and hard-coded into
3521 header files or board specific files.
3522
York Sunbd495cf2011-09-16 13:21:35 -07003523- CONFIG_FSL_DDR_INTERACTIVE
3524 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3525
York Sun8ced0502015-01-06 13:18:55 -08003526- CONFIG_FSL_DDR_SYNC_REFRESH
3527 Enable sync of refresh for multiple controllers.
3528
York Sunb6a35f82015-03-19 09:30:28 -07003529- CONFIG_FSL_DDR_BIST
3530 Enable built-in memory test for Freescale DDR controllers.
3531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003532- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003533 Only for 83xx systems. If specified, then DDR should
3534 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003535
wdenk6203e402004-04-18 10:13:26 +00003536- CONFIG_RMII
3537 Enable RMII mode for all FECs.
3538 Note that this is a global option, we can't
3539 have one FEC in standard MII mode and another in RMII mode.
3540
wdenk20c98a62004-04-23 20:32:05 +00003541- CONFIG_CRC32_VERIFY
3542 Add a verify option to the crc32 command.
3543 The syntax is:
3544
3545 => crc32 -v <address> <count> <crc32>
3546
3547 Where address/count indicate a memory area
3548 and crc32 is the correct crc32 which the
3549 area should have.
3550
wdenk64519362004-07-11 17:40:54 +00003551- CONFIG_LOOPW
3552 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003553 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003554
stroesecc3af832004-12-16 18:46:55 +00003555- CONFIG_MX_CYCLIC
3556 Add the "mdc" and "mwc" memory commands. These are cyclic
3557 "md/mw" commands.
3558 Examples:
3559
wdenk07d7e6b2004-12-16 21:44:03 +00003560 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003561 This command will print 4 bytes (10,11,12,13) each 500 ms.
3562
wdenk07d7e6b2004-12-16 21:44:03 +00003563 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003564 This command will write 12345678 to address 100 all 10 ms.
3565
wdenk07d7e6b2004-12-16 21:44:03 +00003566 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003567 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003568
wdenk3d3d99f2005-04-04 12:44:11 +00003569- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003570 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003571 low level initializations (like setting up the memory
3572 controller) are omitted and/or U-Boot does not
3573 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003574
Wolfgang Denk302141d2010-11-27 23:30:56 +01003575 Normally this variable MUST NOT be defined. The only
3576 exception is when U-Boot is loaded (to RAM) by some
3577 other boot loader or by a debugger which performs
3578 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003579
Simon Glass90844072016-05-05 07:28:06 -06003580- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3581 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003582 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003583 instruction cache) is still performed.
3584
Aneesh V552a3192011-07-13 05:11:07 +00003585- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003586 Modifies the behaviour of start.S when compiling a loader
3587 that is executed before the actual U-Boot. E.g. when
3588 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003589
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003590- CONFIG_TPL_BUILD
3591 Modifies the behaviour of start.S when compiling a loader
3592 that is executed after the SPL and before the actual U-Boot.
3593 It is loaded by the SPL.
3594
Ying Zhang0d4f5442013-05-20 14:07:23 +08003595- CONFIG_SYS_MPC85XX_NO_RESETVEC
3596 Only for 85xx systems. If this variable is specified, the section
3597 .resetvec is not kept and the section .bootpg is placed in the
3598 previous 4k of the .text section.
3599
Simon Glass17dabf02013-02-24 17:33:14 +00003600- CONFIG_ARCH_MAP_SYSMEM
3601 Generally U-Boot (and in particular the md command) uses
3602 effective address. It is therefore not necessary to regard
3603 U-Boot address as virtual addresses that need to be translated
3604 to physical addresses. However, sandbox requires this, since
3605 it maintains its own little RAM buffer which contains all
3606 addressable memory. This option causes some memory accesses
3607 to be mapped through map_sysmem() / unmap_sysmem().
3608
Simon Glassbfb59802013-02-14 04:18:54 +00003609- CONFIG_X86_RESET_VECTOR
3610 If defined, the x86 reset vector code is included. This is not
3611 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003612
Heiko Schocher2233e462013-11-04 14:05:00 +01003613- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3614 Enables the RTC32K OSC on AM33xx based plattforms
3615
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003616- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3617 Option to disable subpage write in NAND driver
3618 driver that uses this:
3619 drivers/mtd/nand/davinci_nand.c
3620
Timur Tabi275f4bb2011-11-22 09:21:25 -06003621Freescale QE/FMAN Firmware Support:
3622-----------------------------------
3623
3624The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3625loading of "firmware", which is encoded in the QE firmware binary format.
3626This firmware often needs to be loaded during U-Boot booting, so macros
3627are used to identify the storage device (NOR flash, SPI, etc) and the address
3628within that device.
3629
Zhao Qiang83a90842014-03-21 16:21:44 +08003630- CONFIG_SYS_FMAN_FW_ADDR
3631 The address in the storage device where the FMAN microcode is located. The
3632 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3633 is also specified.
3634
3635- CONFIG_SYS_QE_FW_ADDR
3636 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003637 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3638 is also specified.
3639
3640- CONFIG_SYS_QE_FMAN_FW_LENGTH
3641 The maximum possible size of the firmware. The firmware binary format
3642 has a field that specifies the actual size of the firmware, but it
3643 might not be possible to read any part of the firmware unless some
3644 local storage is allocated to hold the entire firmware first.
3645
3646- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3647 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3648 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3649 virtual address in NOR flash.
3650
3651- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3652 Specifies that QE/FMAN firmware is located in NAND flash.
3653 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3654
3655- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3656 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3657 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3658
Liu Gang1e084582012-03-08 00:33:18 +00003659- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3660 Specifies that QE/FMAN firmware is located in the remote (master)
3661 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003662 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3663 window->master inbound window->master LAW->the ucode address in
3664 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003665
J. German Rivera8ff14b72014-06-23 15:15:55 -07003666Freescale Layerscape Management Complex Firmware Support:
3667---------------------------------------------------------
3668The Freescale Layerscape Management Complex (MC) supports the loading of
3669"firmware".
3670This firmware often needs to be loaded during U-Boot booting, so macros
3671are used to identify the storage device (NOR flash, SPI, etc) and the address
3672within that device.
3673
3674- CONFIG_FSL_MC_ENET
3675 Enable the MC driver for Layerscape SoCs.
3676
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303677Freescale Layerscape Debug Server Support:
3678-------------------------------------------
3679The Freescale Layerscape Debug Server Support supports the loading of
3680"Debug Server firmware" and triggering SP boot-rom.
3681This firmware often needs to be loaded during U-Boot booting.
3682
York Sun928b6812015-12-07 11:08:58 -08003683- CONFIG_SYS_MC_RSV_MEM_ALIGN
3684 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303685
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003686Reproducible builds
3687-------------------
3688
3689In order to achieve reproducible builds, timestamps used in the U-Boot build
3690process have to be set to a fixed value.
3691
3692This is done using the SOURCE_DATE_EPOCH environment variable.
3693SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3694option for U-Boot or an environment variable in U-Boot.
3695
3696SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3697
wdenkc6097192002-11-03 00:24:07 +00003698Building the Software:
3699======================
3700
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003701Building U-Boot has been tested in several native build environments
3702and in many different cross environments. Of course we cannot support
3703all possibly existing versions of cross development tools in all
3704(potentially obsolete) versions. In case of tool chain problems we
3705recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3706which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003707
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003708If you are not using a native environment, it is assumed that you
3709have GNU cross compiling tools available in your path. In this case,
3710you must set the environment variable CROSS_COMPILE in your shell.
3711Note that no changes to the Makefile or any other source files are
3712necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003713
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003714 $ CROSS_COMPILE=ppc_4xx-
3715 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003716
Peter Tyserb06976d2009-03-13 18:54:51 -05003717Note: If you wish to generate Windows versions of the utilities in
3718 the tools directory you can use the MinGW toolchain
3719 (http://www.mingw.org). Set your HOST tools to the MinGW
3720 toolchain and execute 'make tools'. For example:
3721
3722 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3723
3724 Binaries such as tools/mkimage.exe will be created which can
3725 be executed on computers running Windows.
3726
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003727U-Boot is intended to be simple to build. After installing the
3728sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003729is done by typing:
3730
Holger Freyther7ba4e572014-08-04 09:26:05 +02003731 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003732
Holger Freyther7ba4e572014-08-04 09:26:05 +02003733where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003734rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003735
wdenk6c59edc2004-05-03 20:45:30 +00003736Note: for some board special configuration names may exist; check if
3737 additional information is available from the board vendor; for
3738 instance, the TQM823L systems are available without (standard)
3739 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003740 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003741
Holger Freyther7ba4e572014-08-04 09:26:05 +02003742 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003743 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003744
Holger Freyther7ba4e572014-08-04 09:26:05 +02003745 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003746 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk6c59edc2004-05-03 20:45:30 +00003748 etc.
wdenkc6097192002-11-03 00:24:07 +00003749
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk6c59edc2004-05-03 20:45:30 +00003751Finally, type "make all", and you should get some working U-Boot
3752images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk6c59edc2004-05-03 20:45:30 +00003754- "u-boot.bin" is a raw binary image
3755- "u-boot" is an image in ELF binary format
3756- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003757
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003758By default the build is performed locally and the objects are saved
3759in the source directory. One of the two methods can be used to change
3760this behavior and build U-Boot to some external directory:
3761
37621. Add O= to the make command line invocations:
3763
3764 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003765 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003766 make O=/tmp/build all
3767
Timo Ketolac8c67602014-11-06 14:39:05 +020037682. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003769
Timo Ketolac8c67602014-11-06 14:39:05 +02003770 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003771 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003772 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003773 make all
3774
Timo Ketolac8c67602014-11-06 14:39:05 +02003775Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003776variable.
3777
wdenkc6097192002-11-03 00:24:07 +00003778
wdenk6c59edc2004-05-03 20:45:30 +00003779Please be aware that the Makefiles assume you are using GNU make, so
3780for instance on NetBSD you might need to use "gmake" instead of
3781native "make".
wdenkc6097192002-11-03 00:24:07 +00003782
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk6c59edc2004-05-03 20:45:30 +00003784If the system board that you have is not listed, then you will need
3785to port U-Boot to your hardware platform. To do this, follow these
3786steps:
wdenkc6097192002-11-03 00:24:07 +00003787
Phil Sutterc77b4882015-12-25 14:41:18 +010037881. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003789 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003790 the "Makefile" and a "<board>.c".
37912. Create a new configuration file "include/configs/<board>.h" for
3792 your board.
wdenk6c59edc2004-05-03 20:45:30 +000037933. If you're porting U-Boot to a new CPU, then also create a new
3794 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020037954. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000037965. Type "make", and you should get a working "u-boot.srec" file
3797 to be installed on your target system.
37986. Debug and solve any problems that might arise.
3799 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003800
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk6c59edc2004-05-03 20:45:30 +00003802Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3803==============================================================
wdenkc6097192002-11-03 00:24:07 +00003804
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003805If you have modified U-Boot sources (for instance added a new board
3806or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003807provide feedback to the other developers. The feedback normally takes
3808the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003809official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003810
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003811But before you submit such a patch, please verify that your modifi-
3812cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003813the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003814just run the buildman script (tools/buildman/buildman), which will
3815configure and build U-Boot for ALL supported system. Be warned, this
3816will take a while. Please see the buildman README, or run 'buildman -H'
3817for documentation.
wdenkc6097192002-11-03 00:24:07 +00003818
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003819
wdenk6c59edc2004-05-03 20:45:30 +00003820See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003821
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk6c59edc2004-05-03 20:45:30 +00003823Monitor Commands - Overview:
3824============================
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk6c59edc2004-05-03 20:45:30 +00003826go - start application at address 'addr'
3827run - run commands in an environment variable
3828bootm - boot application image from memory
3829bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003830bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003831tftpboot- boot image via network using TFTP protocol
3832 and env variables "ipaddr" and "serverip"
3833 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003834tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003835rarpboot- boot image via network using RARP/TFTP protocol
3836diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3837loads - load S-Record file over serial line
3838loadb - load binary file over serial line (kermit mode)
3839md - memory display
3840mm - memory modify (auto-incrementing)
3841nm - memory modify (constant address)
3842mw - memory write (fill)
3843cp - memory copy
3844cmp - memory compare
3845crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003846i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003847sspi - SPI utility commands
3848base - print or set address offset
3849printenv- print environment variables
3850setenv - set environment variables
3851saveenv - save environment variables to persistent storage
3852protect - enable or disable FLASH write protection
3853erase - erase FLASH memory
3854flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003855nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003856bdinfo - print Board Info structure
3857iminfo - print header information for application image
3858coninfo - print console devices and informations
3859ide - IDE sub-system
3860loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003861loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003862mtest - simple RAM test
3863icache - enable or disable instruction cache
3864dcache - enable or disable data cache
3865reset - Perform RESET of the CPU
3866echo - echo args to console
3867version - print monitor version
3868help - print online help
3869? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003870
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk6c59edc2004-05-03 20:45:30 +00003872Monitor Commands - Detailed Description:
3873========================================
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875TODO.
wdenkc6097192002-11-03 00:24:07 +00003876
wdenk6c59edc2004-05-03 20:45:30 +00003877For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003878
3879
wdenk6c59edc2004-05-03 20:45:30 +00003880Environment Variables:
3881======================
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883U-Boot supports user configuration using Environment Variables which
3884can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003885
wdenk6c59edc2004-05-03 20:45:30 +00003886Environment Variables are set using "setenv", printed using
3887"printenv", and saved to Flash using "saveenv". Using "setenv"
3888without a value can be used to delete a variable from the
3889environment. As long as you don't save the environment you are
3890working with an in-memory copy. In case the Flash area containing the
3891environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003892
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003893Some configuration options can be set using Environment Variables.
3894
3895List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk6c59edc2004-05-03 20:45:30 +00003897 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003898
wdenk6c59edc2004-05-03 20:45:30 +00003899 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk6c59edc2004-05-03 20:45:30 +00003901 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003902
wdenk6c59edc2004-05-03 20:45:30 +00003903 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003904
wdenk6c59edc2004-05-03 20:45:30 +00003905 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003906
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003907 bootm_low - Memory range available for image processing in the bootm
3908 command can be restricted. This variable is given as
3909 a hexadecimal number and defines lowest address allowed
3910 for use by the bootm command. See also "bootm_size"
3911 environment variable. Address defined by "bootm_low" is
3912 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003913 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3914 bootm_mapsize.
3915
Wolfgang Denk092ae952011-10-26 10:21:21 +00003916 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003917 This variable is given as a hexadecimal number and it
3918 defines the size of the memory region starting at base
3919 address bootm_low that is accessible by the Linux kernel
3920 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3921 as the default value if it is defined, and bootm_size is
3922 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003923
3924 bootm_size - Memory range available for image processing in the bootm
3925 command can be restricted. This variable is given as
3926 a hexadecimal number and defines the size of the region
3927 allowed for use by the bootm command. See also "bootm_low"
3928 environment variable.
3929
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003930 updatefile - Location of the software update file on a TFTP server, used
3931 by the automatic software update feature. Please refer to
3932 documentation in doc/README.update for more details.
3933
wdenk6c59edc2004-05-03 20:45:30 +00003934 autoload - if set to "no" (any string beginning with 'n'),
3935 "bootp" will just load perform a lookup of the
3936 configuration from the BOOTP server, but not try to
3937 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk6c59edc2004-05-03 20:45:30 +00003939 autostart - if set to "yes", an image loaded using the "bootp",
3940 "rarpboot", "tftpboot" or "diskboot" commands will
3941 be automatically started (by internally calling
3942 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944 If set to "no", a standalone image passed to the
3945 "bootm" command will be copied to the load address
3946 (and eventually uncompressed), but NOT be started.
3947 This can be used to load and uncompress arbitrary
3948 data.
wdenkc6097192002-11-03 00:24:07 +00003949
David A. Longd558a4e2011-07-09 16:40:19 -04003950 fdt_high - if set this restricts the maximum address that the
3951 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003952 For example, if you have a system with 1 GB memory
3953 at physical address 0x10000000, while Linux kernel
3954 only recognizes the first 704 MB as low memory, you
3955 may need to set fdt_high as 0x3C000000 to have the
3956 device tree blob be copied to the maximum address
3957 of the 704 MB low memory, so that Linux kernel can
3958 access it during the boot procedure.
3959
David A. Longd558a4e2011-07-09 16:40:19 -04003960 If this is set to the special value 0xFFFFFFFF then
3961 the fdt will not be copied at all on boot. For this
3962 to work it must reside in writable memory, have
3963 sufficient padding on the end of it for u-boot to
3964 add the information it needs into it, and the memory
3965 must be accessible by the kernel.
3966
Simon Glassdc6fa642011-10-24 19:15:34 +00003967 fdtcontroladdr- if set this is the address of the control flattened
3968 device tree used by U-Boot when CONFIG_OF_CONTROL is
3969 defined.
3970
wdenk0e2bd9c2004-06-06 21:51:03 +00003971 i2cfast - (PPC405GP|PPC405EP only)
3972 if set to 'y' configures Linux I2C driver for fast
3973 mode (400kHZ). This environment variable is used in
3974 initialization code. So, for changes to be effective
3975 it must be saved and board must be reset.
3976
wdenk6c59edc2004-05-03 20:45:30 +00003977 initrd_high - restrict positioning of initrd images:
3978 If this variable is not set, initrd images will be
3979 copied to the highest possible address in RAM; this
3980 is usually what you want since it allows for
3981 maximum initrd size. If for some reason you want to
3982 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003983 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003984 variable to a value of "no" or "off" or "0".
3985 Alternatively, you can set it to a maximum upper
3986 address to use (U-Boot will still check that it
3987 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk6c59edc2004-05-03 20:45:30 +00003989 For instance, when you have a system with 16 MB
3990 RAM, and want to reserve 4 MB from use by Linux,
3991 you can do this by adding "mem=12M" to the value of
3992 the "bootargs" variable. However, now you must make
3993 sure that the initrd image is placed in the first
3994 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk6c59edc2004-05-03 20:45:30 +00003996 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003997
wdenk6c59edc2004-05-03 20:45:30 +00003998 If you set initrd_high to 0xFFFFFFFF, this is an
3999 indication to U-Boot that all addresses are legal
4000 for the Linux kernel, including addresses in flash
4001 memory. In this case U-Boot will NOT COPY the
4002 ramdisk at all. This may be useful to reduce the
4003 boot time on your system, but requires that this
4004 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004005
wdenk6c59edc2004-05-03 20:45:30 +00004006 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk6c59edc2004-05-03 20:45:30 +00004008 loadaddr - Default load address for commands like "bootp",
4009 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk6c59edc2004-05-03 20:45:30 +00004013 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004014
wdenk6c59edc2004-05-03 20:45:30 +00004015 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004016
wdenk6c59edc2004-05-03 20:45:30 +00004017 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk6c59edc2004-05-03 20:45:30 +00004019 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004020
Mike Frysingera23230c2011-10-02 10:01:27 +00004021 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004022
Mike Frysingera23230c2011-10-02 10:01:27 +00004023 ethact - controls which interface is currently active.
4024 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004025
Heiko Schocherc5e84052010-07-20 17:45:02 +02004026 => setenv ethact FEC
4027 => ping 192.168.0.1 # traffic sent on FEC
4028 => setenv ethact SCC
4029 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004030
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004031 ethrotate - When set to "no" U-Boot does not go through all
4032 available network interfaces.
4033 It just stays at the currently selected interface.
4034
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004035 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004036 either succeed or fail without retrying.
4037 When set to "once" the network operation will
4038 fail when all the available network interfaces
4039 are tried once without success.
4040 Useful on scripts which control the retry operation
4041 themselves.
wdenkc6097192002-11-03 00:24:07 +00004042
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004043 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004044
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004045 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004046 changing the console to be empty. If "yes" it will be
4047 made silent. If "no" it will not be made silent. If
4048 unset, then it will be made silent if the U-Boot console
4049 is silent.
4050
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004051 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004052 UDP source port.
4053
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004054 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004055 destination port instead of the Well Know Port 69.
4056
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004057 tftpblocksize - Block size to use for TFTP transfers; if not set,
4058 we use the TFTP server's default block size
4059
4060 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4061 seconds, minimum value is 1000 = 1 second). Defines
4062 when a packet is considered to be lost so it has to
4063 be retransmitted. The default is 5000 = 5 seconds.
4064 Lowering this value may make downloads succeed
4065 faster in networks with high packet loss rates or
4066 with unreliable TFTP servers.
4067
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004068 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4069 unit, minimum value = 0). Defines how many timeouts
4070 can happen during a single file transfer before that
4071 transfer is aborted. The default is 10, and 0 means
4072 'no timeouts allowed'. Increasing this value may help
4073 downloads succeed with high packet loss rates, or with
4074 unreliable TFTP servers or client hardware.
4075
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004076 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004077 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004078 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004079
Alexandre Messier15971322016-02-01 17:08:57 -05004080 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4081 Unsigned value, in milliseconds. If not set, the period will
4082 be either the default (28000), or a value based on
4083 CONFIG_NET_RETRY_COUNT, if defined. This value has
4084 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4085
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004086The following image location variables contain the location of images
4087used in booting. The "Image" column gives the role of the image and is
4088not an environment variable name. The other columns are environment
4089variable names. "File Name" gives the name of the file on a TFTP
4090server, "RAM Address" gives the location in RAM the image will be
4091loaded to, and "Flash Location" gives the image's address in NOR
4092flash or offset in NAND flash.
4093
4094*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004095boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004096boards use these variables for other purposes.
4097
Wolfgang Denk092ae952011-10-26 10:21:21 +00004098Image File Name RAM Address Flash Location
4099----- --------- ----------- --------------
4100u-boot u-boot u-boot_addr_r u-boot_addr
4101Linux kernel bootfile kernel_addr_r kernel_addr
4102device tree blob fdtfile fdt_addr_r fdt_addr
4103ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004104
wdenk6c59edc2004-05-03 20:45:30 +00004105The following environment variables may be used and automatically
4106updated by the network boot commands ("bootp" and "rarpboot"),
4107depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004108
wdenk6c59edc2004-05-03 20:45:30 +00004109 bootfile - see above
4110 dnsip - IP address of your Domain Name Server
4111 dnsip2 - IP address of your secondary Domain Name Server
4112 gatewayip - IP address of the Gateway (Router) to use
4113 hostname - Target hostname
4114 ipaddr - see above
4115 netmask - Subnet Mask
4116 rootpath - Pathname of the root filesystem on the NFS server
4117 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004118
wdenk145d2c12004-04-15 21:48:45 +00004119
wdenk6c59edc2004-05-03 20:45:30 +00004120There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004121
wdenk6c59edc2004-05-03 20:45:30 +00004122 serial# - contains hardware identification information such
4123 as type string and/or serial number
4124 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk6c59edc2004-05-03 20:45:30 +00004126These variables can be set only once (usually during manufacturing of
4127the board). U-Boot refuses to delete or overwrite these variables
4128once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004129
4130
wdenk6c59edc2004-05-03 20:45:30 +00004131Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk6c59edc2004-05-03 20:45:30 +00004133 ver - Contains the U-Boot version string as printed
4134 with the "version" command. This variable is
4135 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004136
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138Please note that changes to some configuration parameters may take
4139only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004140
stroeseb9c17c52003-04-04 15:53:41 +00004141
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004142Callback functions for environment variables:
4143---------------------------------------------
4144
4145For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004146when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004147be associated with arbitrary variables. On creation, overwrite, or
4148deletion, the callback will provide the opportunity for some side
4149effect to happen or for the change to be rejected.
4150
4151The callbacks are named and associated with a function using the
4152U_BOOT_ENV_CALLBACK macro in your board or driver code.
4153
4154These callbacks are associated with variables in one of two ways. The
4155static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4156in the board configuration to a string that defines a list of
4157associations. The list must be in the following format:
4158
4159 entry = variable_name[:callback_name]
4160 list = entry[,list]
4161
4162If the callback name is not specified, then the callback is deleted.
4163Spaces are also allowed anywhere in the list.
4164
4165Callbacks can also be associated by defining the ".callbacks" variable
4166with the same list format above. Any association in ".callbacks" will
4167override any association in the static list. You can define
4168CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004169".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004170
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004171If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4172regular expression. This allows multiple variables to be connected to
4173the same callback without explicitly listing them all out.
4174
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004175
wdenk6c59edc2004-05-03 20:45:30 +00004176Command Line Parsing:
4177=====================
stroeseb9c17c52003-04-04 15:53:41 +00004178
wdenk6c59edc2004-05-03 20:45:30 +00004179There are two different command line parsers available with U-Boot:
4180the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk6c59edc2004-05-03 20:45:30 +00004182Old, simple command line parser:
4183--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk6c59edc2004-05-03 20:45:30 +00004185- supports environment variables (through setenv / saveenv commands)
4186- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004187- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004188- special characters ('$', ';') can be escaped by prefixing with '\',
4189 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004190 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004191- You can also escape text by enclosing in single apostrophes, for example:
4192 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk6c59edc2004-05-03 20:45:30 +00004194Hush shell:
4195-----------
wdenkf4688a22003-05-28 08:06:31 +00004196
wdenk6c59edc2004-05-03 20:45:30 +00004197- similar to Bourne shell, with control structures like
4198 if...then...else...fi, for...do...done; while...do...done,
4199 until...do...done, ...
4200- supports environment ("global") variables (through setenv / saveenv
4201 commands) and local shell variables (through standard shell syntax
4202 "name=value"); only environment variables can be used with "run"
4203 command
wdenkf4688a22003-05-28 08:06:31 +00004204
wdenk6c59edc2004-05-03 20:45:30 +00004205General rules:
4206--------------
wdenkf4688a22003-05-28 08:06:31 +00004207
wdenk6c59edc2004-05-03 20:45:30 +00004208(1) If a command line (or an environment variable executed by a "run"
4209 command) contains several commands separated by semicolon, and
4210 one of these commands fails, then the remaining commands will be
4211 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004212
wdenk6c59edc2004-05-03 20:45:30 +00004213(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004214 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004215 command will cause "run" to terminate, i. e. the remaining
4216 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004217
wdenk6c59edc2004-05-03 20:45:30 +00004218Note for Redundant Ethernet Interfaces:
4219=======================================
wdenkf4688a22003-05-28 08:06:31 +00004220
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004221Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004222such configurations and is capable of automatic selection of a
4223"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004224
wdenk6c59edc2004-05-03 20:45:30 +00004225Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4226MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4227"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004228
wdenk6c59edc2004-05-03 20:45:30 +00004229If the network interface stores some valid MAC address (for instance
4230in SROM), this is used as default address if there is NO correspon-
4231ding setting in the environment; if the corresponding environment
4232variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004233
wdenk6c59edc2004-05-03 20:45:30 +00004234o If the SROM has a valid MAC address, and there is no address in the
4235 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk6c59edc2004-05-03 20:45:30 +00004237o If there is no valid address in the SROM, and a definition in the
4238 environment exists, then the value from the environment variable is
4239 used.
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk6c59edc2004-05-03 20:45:30 +00004241o If both the SROM and the environment contain a MAC address, and
4242 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004243
wdenk6c59edc2004-05-03 20:45:30 +00004244o If both the SROM and the environment contain a MAC address, and the
4245 addresses differ, the value from the environment is used and a
4246 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk6c59edc2004-05-03 20:45:30 +00004248o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004249 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4250 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004251
Ben Warren6db991a2010-04-26 11:11:46 -07004252If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004253will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004254may be skipped by setting the appropriate 'ethmacskip' environment variable.
4255The naming convention is as follows:
4256"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258Image Formats:
4259==============
wdenkc6097192002-11-03 00:24:07 +00004260
Marian Balakowicz18710b82008-03-12 12:13:13 +01004261U-Boot is capable of booting (and performing other auxiliary operations on)
4262images in two formats:
4263
4264New uImage format (FIT)
4265-----------------------
4266
4267Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4268to Flattened Device Tree). It allows the use of images with multiple
4269components (several kernels, ramdisks, etc.), with contents protected by
4270SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4271
4272
4273Old uImage format
4274-----------------
4275
4276Old image format is based on binary files which can be basically anything,
4277preceded by a special header; see the definitions in include/image.h for
4278details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004279
wdenk6c59edc2004-05-03 20:45:30 +00004280* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4281 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004282 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4283 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4284 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004285* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004286 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004287 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004288* Compression Type (uncompressed, gzip, bzip2)
4289* Load Address
4290* Entry Point
4291* Image Name
4292* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004293
wdenk6c59edc2004-05-03 20:45:30 +00004294The header is marked by a special Magic Number, and both the header
4295and the data portions of the image are secured against corruption by
4296CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004297
wdenkc6097192002-11-03 00:24:07 +00004298
wdenk6c59edc2004-05-03 20:45:30 +00004299Linux Support:
4300==============
wdenkc6097192002-11-03 00:24:07 +00004301
wdenk6c59edc2004-05-03 20:45:30 +00004302Although U-Boot should support any OS or standalone application
4303easily, the main focus has always been on Linux during the design of
4304U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306U-Boot includes many features that so far have been part of some
4307special "boot loader" code within the Linux kernel. Also, any
4308"initrd" images to be used are no longer part of one big Linux image;
4309instead, kernel and "initrd" are separate images. This implementation
4310serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004311
wdenk6c59edc2004-05-03 20:45:30 +00004312- the same features can be used for other OS or standalone
4313 applications (for instance: using compressed images to reduce the
4314 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004315
wdenk6c59edc2004-05-03 20:45:30 +00004316- it becomes much easier to port new Linux kernel versions because
4317 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk6c59edc2004-05-03 20:45:30 +00004319- the same Linux kernel image can now be used with different "initrd"
4320 images; of course this also means that different kernel images can
4321 be run with the same "initrd". This makes testing easier (you don't
4322 have to build a new "zImage.initrd" Linux image when you just
4323 change a file in your "initrd"). Also, a field-upgrade of the
4324 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004325
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327Linux HOWTO:
4328============
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330Porting Linux to U-Boot based systems:
4331---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk6c59edc2004-05-03 20:45:30 +00004333U-Boot cannot save you from doing all the necessary modifications to
4334configure the Linux device drivers for use with your target hardware
4335(no, we don't intend to provide a full virtual machine interface to
4336Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004337
Stefan Roese88fbf932010-04-15 16:07:28 +02004338But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340Just make sure your machine specific header file (for instance
4341include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004342Information structure as we define in include/asm-<arch>/u-boot.h,
4343and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004344as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004345
Simon Glassd097e592014-06-11 23:29:46 -06004346Note that U-Boot now has a driver model, a unified model for drivers.
4347If you are adding a new driver, plumb it into driver model. If there
4348is no uclass available, you are encouraged to create one. See
4349doc/driver-model.
4350
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk6c59edc2004-05-03 20:45:30 +00004352Configuring the Linux kernel:
4353-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk6c59edc2004-05-03 20:45:30 +00004355No specific requirements for U-Boot. Make sure you have some root
4356device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004357
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk6c59edc2004-05-03 20:45:30 +00004359Building a Linux Image:
4360-----------------------
wdenkc6097192002-11-03 00:24:07 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4363not used. If you use recent kernel source, a new build target
4364"uImage" will exist which automatically builds an image usable by
4365U-Boot. Most older kernels also have support for a "pImage" target,
4366which was introduced for our predecessor project PPCBoot and uses a
4367100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369Example:
wdenkc6097192002-11-03 00:24:07 +00004370
Holger Freyther7ba4e572014-08-04 09:26:05 +02004371 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004372 make oldconfig
4373 make dep
4374 make uImage
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk6c59edc2004-05-03 20:45:30 +00004376The "uImage" build target uses a special tool (in 'tools/mkimage') to
4377encapsulate a compressed Linux kernel image with header information,
4378CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk6c59edc2004-05-03 20:45:30 +00004380* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk6c59edc2004-05-03 20:45:30 +00004382* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk6c59edc2004-05-03 20:45:30 +00004384 ${CROSS_COMPILE}-objcopy -O binary \
4385 -R .note -R .comment \
4386 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004387
wdenk6c59edc2004-05-03 20:45:30 +00004388* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004389
wdenk6c59edc2004-05-03 20:45:30 +00004390 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004391
wdenk6c59edc2004-05-03 20:45:30 +00004392* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004393
wdenk6c59edc2004-05-03 20:45:30 +00004394 mkimage -A ppc -O linux -T kernel -C gzip \
4395 -a 0 -e 0 -n "Linux Kernel Image" \
4396 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004397
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399The "mkimage" tool can also be used to create ramdisk images for use
4400with U-Boot, either separated from the Linux kernel image, or
4401combined into one file. "mkimage" encapsulates the images with a 64
4402byte header containing information about target architecture,
4403operating system, image type, compression method, entry points, time
4404stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk6c59edc2004-05-03 20:45:30 +00004406"mkimage" can be called in two ways: to verify existing images and
4407print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004408
wdenk6c59edc2004-05-03 20:45:30 +00004409In the first form (with "-l" option) mkimage lists the information
4410contained in the header of an existing U-Boot image; this includes
4411checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004412
wdenk6c59edc2004-05-03 20:45:30 +00004413 tools/mkimage -l image
4414 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004415
wdenk6c59edc2004-05-03 20:45:30 +00004416The second form (with "-d" option) is used to build a U-Boot image
4417from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004418
wdenk6c59edc2004-05-03 20:45:30 +00004419 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4420 -n name -d data_file image
4421 -A ==> set architecture to 'arch'
4422 -O ==> set operating system to 'os'
4423 -T ==> set image type to 'type'
4424 -C ==> set compression type 'comp'
4425 -a ==> set load address to 'addr' (hex)
4426 -e ==> set entry point to 'ep' (hex)
4427 -n ==> set image name to 'name'
4428 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004429
wdenkcd914452004-05-29 16:53:29 +00004430Right now, all Linux kernels for PowerPC systems use the same load
4431address (0x00000000), but the entry point address depends on the
4432kernel version:
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk6c59edc2004-05-03 20:45:30 +00004434- 2.2.x kernels have the entry point at 0x0000000C,
4435- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004436
wdenk6c59edc2004-05-03 20:45:30 +00004437So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk6c59edc2004-05-03 20:45:30 +00004439 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4440 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004441 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004442 > examples/uImage.TQM850L
4443 Image Name: 2.4.4 kernel for TQM850L
4444 Created: Wed Jul 19 02:34:59 2000
4445 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4446 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4447 Load Address: 0x00000000
4448 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk6c59edc2004-05-03 20:45:30 +00004450To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004451
wdenk6c59edc2004-05-03 20:45:30 +00004452 -> tools/mkimage -l examples/uImage.TQM850L
4453 Image Name: 2.4.4 kernel for TQM850L
4454 Created: Wed Jul 19 02:34:59 2000
4455 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4456 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4457 Load Address: 0x00000000
4458 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk6c59edc2004-05-03 20:45:30 +00004460NOTE: for embedded systems where boot time is critical you can trade
4461speed for memory and install an UNCOMPRESSED image instead: this
4462needs more space in Flash, but boots much faster since it does not
4463need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004464
Stefan Roese88fbf932010-04-15 16:07:28 +02004465 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004466 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4467 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004468 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004469 > examples/uImage.TQM850L-uncompressed
4470 Image Name: 2.4.4 kernel for TQM850L
4471 Created: Wed Jul 19 02:34:59 2000
4472 Image Type: PowerPC Linux Kernel Image (uncompressed)
4473 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4474 Load Address: 0x00000000
4475 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004476
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk6c59edc2004-05-03 20:45:30 +00004478Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4479when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481 -> tools/mkimage -n 'Simple Ramdisk Image' \
4482 > -A ppc -O linux -T ramdisk -C gzip \
4483 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4484 Image Name: Simple Ramdisk Image
4485 Created: Wed Jan 12 14:01:50 2000
4486 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4487 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4488 Load Address: 0x00000000
4489 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004490
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004491The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4492option performs the converse operation of the mkimage's second form (the "-d"
4493option). Given an image built by mkimage, the dumpimage extracts a "data file"
4494from the image:
4495
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004496 tools/dumpimage -i image -T type -p position data_file
4497 -i ==> extract from the 'image' a specific 'data_file'
4498 -T ==> set image type to 'type'
4499 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004500
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk6c59edc2004-05-03 20:45:30 +00004502Installing a Linux Image:
4503-------------------------
wdenkc6097192002-11-03 00:24:07 +00004504
wdenk6c59edc2004-05-03 20:45:30 +00004505To downloading a U-Boot image over the serial (console) interface,
4506you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004507
wdenk6c59edc2004-05-03 20:45:30 +00004508 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004509
wdenk6c59edc2004-05-03 20:45:30 +00004510The 'objcopy' does not understand the information in the U-Boot
4511image header, so the resulting S-Record file will be relative to
4512address 0x00000000. To load it to a given address, you need to
4513specify the target address as 'offset' parameter with the 'loads'
4514command.
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk6c59edc2004-05-03 20:45:30 +00004516Example: install the image to address 0x40100000 (which on the
4517TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk6c59edc2004-05-03 20:45:30 +00004519 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk6c59edc2004-05-03 20:45:30 +00004521 .......... done
4522 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk6c59edc2004-05-03 20:45:30 +00004524 => loads 40100000
4525 ## Ready for S-Record download ...
4526 ~>examples/image.srec
4527 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4528 ...
4529 15989 15990 15991 15992
4530 [file transfer complete]
4531 [connected]
4532 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004533
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004536this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004537corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk6c59edc2004-05-03 20:45:30 +00004541 ## Checking Image at 40100000 ...
4542 Image Name: 2.2.13 for initrd on TQM850L
4543 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4544 Data Size: 335725 Bytes = 327 kB = 0 MB
4545 Load Address: 00000000
4546 Entry Point: 0000000c
4547 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004548
4549
wdenk6c59edc2004-05-03 20:45:30 +00004550Boot Linux:
4551-----------
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk6c59edc2004-05-03 20:45:30 +00004553The "bootm" command is used to boot an application that is stored in
4554memory (RAM or Flash). In case of a Linux kernel image, the contents
4555of the "bootargs" environment variable is passed to the kernel as
4556parameters. You can check and modify this variable using the
4557"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004558
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk6c59edc2004-05-03 20:45:30 +00004560 => printenv bootargs
4561 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk6c59edc2004-05-03 20:45:30 +00004563 => 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 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565 => printenv bootargs
4566 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 +00004567
wdenk6c59edc2004-05-03 20:45:30 +00004568 => bootm 40020000
4569 ## Booting Linux kernel at 40020000 ...
4570 Image Name: 2.2.13 for NFS on TQM850L
4571 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4572 Data Size: 381681 Bytes = 372 kB = 0 MB
4573 Load Address: 00000000
4574 Entry Point: 0000000c
4575 Verifying Checksum ... OK
4576 Uncompressing Kernel Image ... OK
4577 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
4578 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4579 time_init: decrementer frequency = 187500000/60
4580 Calibrating delay loop... 49.77 BogoMIPS
4581 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4582 ...
wdenkc6097192002-11-03 00:24:07 +00004583
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004584If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004585the memory addresses of both the kernel and the initrd image (PPBCOOT
4586format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004587
wdenk6c59edc2004-05-03 20:45:30 +00004588 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk6c59edc2004-05-03 20:45:30 +00004590 ## Checking Image at 40100000 ...
4591 Image Name: 2.2.13 for initrd on TQM850L
4592 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4593 Data Size: 335725 Bytes = 327 kB = 0 MB
4594 Load Address: 00000000
4595 Entry Point: 0000000c
4596 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk6c59edc2004-05-03 20:45:30 +00004598 ## Checking Image at 40200000 ...
4599 Image Name: Simple Ramdisk Image
4600 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4601 Data Size: 566530 Bytes = 553 kB = 0 MB
4602 Load Address: 00000000
4603 Entry Point: 00000000
4604 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk6c59edc2004-05-03 20:45:30 +00004606 => bootm 40100000 40200000
4607 ## Booting Linux kernel at 40100000 ...
4608 Image Name: 2.2.13 for initrd on TQM850L
4609 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4610 Data Size: 335725 Bytes = 327 kB = 0 MB
4611 Load Address: 00000000
4612 Entry Point: 0000000c
4613 Verifying Checksum ... OK
4614 Uncompressing Kernel Image ... OK
4615 ## Loading RAMDisk Image at 40200000 ...
4616 Image Name: Simple Ramdisk Image
4617 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4618 Data Size: 566530 Bytes = 553 kB = 0 MB
4619 Load Address: 00000000
4620 Entry Point: 00000000
4621 Verifying Checksum ... OK
4622 Loading Ramdisk ... OK
4623 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
4624 Boot arguments: root=/dev/ram
4625 time_init: decrementer frequency = 187500000/60
4626 Calibrating delay loop... 49.77 BogoMIPS
4627 ...
4628 RAMDISK: Compressed image found at block 0
4629 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk6c59edc2004-05-03 20:45:30 +00004631 bash#
wdenkc6097192002-11-03 00:24:07 +00004632
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004633Boot Linux and pass a flat device tree:
4634-----------
4635
4636First, U-Boot must be compiled with the appropriate defines. See the section
4637titled "Linux Kernel Interface" above for a more in depth explanation. The
4638following is an example of how to start a kernel and pass an updated
4639flat device tree:
4640
4641=> print oftaddr
4642oftaddr=0x300000
4643=> print oft
4644oft=oftrees/mpc8540ads.dtb
4645=> tftp $oftaddr $oft
4646Speed: 1000, full duplex
4647Using TSEC0 device
4648TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4649Filename 'oftrees/mpc8540ads.dtb'.
4650Load address: 0x300000
4651Loading: #
4652done
4653Bytes transferred = 4106 (100a hex)
4654=> tftp $loadaddr $bootfile
4655Speed: 1000, full duplex
4656Using TSEC0 device
4657TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4658Filename 'uImage'.
4659Load address: 0x200000
4660Loading:############
4661done
4662Bytes transferred = 1029407 (fb51f hex)
4663=> print loadaddr
4664loadaddr=200000
4665=> print oftaddr
4666oftaddr=0x300000
4667=> bootm $loadaddr - $oftaddr
4668## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004669 Image Name: Linux-2.6.17-dirty
4670 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4671 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004672 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004673 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004674 Verifying Checksum ... OK
4675 Uncompressing Kernel Image ... OK
4676Booting using flat device tree at 0x300000
4677Using MPC85xx ADS machine description
4678Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4679[snip]
4680
4681
wdenk6c59edc2004-05-03 20:45:30 +00004682More About U-Boot Image Types:
4683------------------------------
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687 "Standalone Programs" are directly runnable in the environment
4688 provided by U-Boot; it is expected that (if they behave
4689 well) you can continue to work in U-Boot after return from
4690 the Standalone Program.
4691 "OS Kernel Images" are usually images of some Embedded OS which
4692 will take over control completely. Usually these programs
4693 will install their own set of exception handlers, device
4694 drivers, set up the MMU, etc. - this means, that you cannot
4695 expect to re-enter U-Boot except by resetting the CPU.
4696 "RAMDisk Images" are more or less just data blocks, and their
4697 parameters (address, size) are passed to an OS kernel that is
4698 being started.
4699 "Multi-File Images" contain several images, typically an OS
4700 (Linux) kernel image and one or more data images like
4701 RAMDisks. This construct is useful for instance when you want
4702 to boot over the network using BOOTP etc., where the boot
4703 server provides just a single image file, but you want to get
4704 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004705
wdenk6c59edc2004-05-03 20:45:30 +00004706 "Multi-File Images" start with a list of image sizes, each
4707 image size (in bytes) specified by an "uint32_t" in network
4708 byte order. This list is terminated by an "(uint32_t)0".
4709 Immediately after the terminating 0 follow the images, one by
4710 one, all aligned on "uint32_t" boundaries (size rounded up to
4711 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713 "Firmware Images" are binary images containing firmware (like
4714 U-Boot or FPGA images) which usually will be programmed to
4715 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717 "Script files" are command sequences that will be executed by
4718 U-Boot's command interpreter; this feature is especially
4719 useful when you configure U-Boot to use a real shell (hush)
4720 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004721
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004722Booting the Linux zImage:
4723-------------------------
4724
4725On some platforms, it's possible to boot Linux zImage. This is done
4726using the "bootz" command. The syntax of "bootz" command is the same
4727as the syntax of "bootm" command.
4728
Tom Rini45f46d12013-05-16 11:40:11 -04004729Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004730kernel with raw initrd images. The syntax is slightly different, the
4731address of the initrd must be augmented by it's size, in the following
4732format: "<initrd addres>:<initrd size>".
4733
stroeseb9c17c52003-04-04 15:53:41 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735Standalone HOWTO:
4736=================
stroeseb9c17c52003-04-04 15:53:41 +00004737
wdenk6c59edc2004-05-03 20:45:30 +00004738One of the features of U-Boot is that you can dynamically load and
4739run "standalone" applications, which can use some resources of
4740U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004743
wdenk6c59edc2004-05-03 20:45:30 +00004744"Hello World" Demo:
4745-------------------
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747'examples/hello_world.c' contains a small "Hello World" Demo
4748application; it is automatically compiled when you build U-Boot.
4749It's configured to run at address 0x00040004, so you can play with it
4750like that:
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk6c59edc2004-05-03 20:45:30 +00004752 => loads
4753 ## Ready for S-Record download ...
4754 ~>examples/hello_world.srec
4755 1 2 3 4 5 6 7 8 9 10 11 ...
4756 [file transfer complete]
4757 [connected]
4758 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760 => go 40004 Hello World! This is a test.
4761 ## Starting application at 0x00040004 ...
4762 Hello World
4763 argc = 7
4764 argv[0] = "40004"
4765 argv[1] = "Hello"
4766 argv[2] = "World!"
4767 argv[3] = "This"
4768 argv[4] = "is"
4769 argv[5] = "a"
4770 argv[6] = "test."
4771 argv[7] = "<NULL>"
4772 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk6c59edc2004-05-03 20:45:30 +00004774 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776Another example, which demonstrates how to register a CPM interrupt
4777handler with the U-Boot code, can be found in 'examples/timer.c'.
4778Here, a CPM timer is set up to generate an interrupt every second.
4779The interrupt service routine is trivial, just printing a '.'
4780character, but this is just a demo program. The application can be
4781controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk6c59edc2004-05-03 20:45:30 +00004783 ? - print current values og the CPM Timer registers
4784 b - enable interrupts and start timer
4785 e - stop timer and disable interrupts
4786 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788 => loads
4789 ## Ready for S-Record download ...
4790 ~>examples/timer.srec
4791 1 2 3 4 5 6 7 8 9 10 11 ...
4792 [file transfer complete]
4793 [connected]
4794 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk6c59edc2004-05-03 20:45:30 +00004796 => go 40004
4797 ## Starting application at 0x00040004 ...
4798 TIMERS=0xfff00980
4799 Using timer 1
4800 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk6c59edc2004-05-03 20:45:30 +00004802Hit 'b':
4803 [q, b, e, ?] Set interval 1000000 us
4804 Enabling timer
4805Hit '?':
4806 [q, b, e, ?] ........
4807 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4808Hit '?':
4809 [q, b, e, ?] .
4810 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4811Hit '?':
4812 [q, b, e, ?] .
4813 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4814Hit '?':
4815 [q, b, e, ?] .
4816 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4817Hit 'e':
4818 [q, b, e, ?] ...Stopping timer
4819Hit 'q':
4820 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004821
wdenkc6097192002-11-03 00:24:07 +00004822
wdenk6c59edc2004-05-03 20:45:30 +00004823Minicom warning:
4824================
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk6c59edc2004-05-03 20:45:30 +00004826Over time, many people have reported problems when trying to use the
4827"minicom" terminal emulation program for serial download. I (wd)
4828consider minicom to be broken, and recommend not to use it. Under
4829Unix, I recommend to use C-Kermit for general purpose use (and
4830especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004831use "cu" for S-Record download ("loads" command). See
4832http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4833for help with kermit.
4834
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk6c59edc2004-05-03 20:45:30 +00004836Nevertheless, if you absolutely want to use it try adding this
4837configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk6c59edc2004-05-03 20:45:30 +00004839 Name Program Name U/D FullScr IO-Red. Multi
4840 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4841 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004842
wdenk8dba0502003-03-31 16:34:49 +00004843
wdenk6c59edc2004-05-03 20:45:30 +00004844NetBSD Notes:
4845=============
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk6c59edc2004-05-03 20:45:30 +00004847Starting at version 0.9.2, U-Boot supports NetBSD both as host
4848(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004849
wdenk6c59edc2004-05-03 20:45:30 +00004850Building requires a cross environment; it is known to work on
4851NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4852need gmake since the Makefiles are not compatible with BSD make).
4853Note that the cross-powerpc package does not install include files;
4854attempting to build U-Boot will fail because <machine/ansi.h> is
4855missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857 # cd /usr/pkg/cross/powerpc-netbsd/include
4858 # mkdir powerpc
4859 # ln -s powerpc machine
4860 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4861 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004862
wdenk6c59edc2004-05-03 20:45:30 +00004863Native builds *don't* work due to incompatibilities between native
4864and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866Booting assumes that (the first part of) the image booted is a
4867stage-2 loader which in turn loads and then invokes the kernel
4868proper. Loader sources will eventually appear in the NetBSD source
4869tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004870meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004871
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk6c59edc2004-05-03 20:45:30 +00004873Implementation Internals:
4874=========================
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk6c59edc2004-05-03 20:45:30 +00004876The following is not intended to be a complete description of every
4877implementation detail. However, it should help to understand the
4878inner workings of U-Boot and make it easier to port it to custom
4879hardware.
wdenkc6097192002-11-03 00:24:07 +00004880
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882Initial Stack, Global Data:
4883---------------------------
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885The implementation of U-Boot is complicated by the fact that U-Boot
4886starts running out of ROM (flash memory), usually without access to
4887system RAM (because the memory controller is not initialized yet).
4888This means that we don't have writable Data or BSS segments, and BSS
4889is not initialized as zero. To be able to get a C environment working
4890at all, we have to allocate at least a minimal stack. Implementation
4891options for this are defined and restricted by the CPU used: Some CPU
4892models provide on-chip memory (like the IMMR area on MPC8xx and
4893MPC826x processors), on others (parts of) the data cache can be
4894locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004895
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004896 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004897 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004898
wdenk6c59edc2004-05-03 20:45:30 +00004899 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4900 From: "Chris Hallinan" <clh@net1plus.com>
4901 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4902 ...
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904 Correct me if I'm wrong, folks, but the way I understand it
4905 is this: Using DCACHE as initial RAM for Stack, etc, does not
4906 require any physical RAM backing up the cache. The cleverness
4907 is that the cache is being used as a temporary supply of
4908 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004909 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004910 can see how this works by studying the cache architecture and
4911 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk6c59edc2004-05-03 20:45:30 +00004913 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4914 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004915 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004916 option should work for you. Using CS 4 should be fine if your
4917 board designers haven't used it for something that would
4918 cause you grief during the initial boot! It is frequently not
4919 used.
wdenkc6097192002-11-03 00:24:07 +00004920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004921 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004922 with your processor/board/system design. The default value
4923 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004924 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004925 than your SDRAM module. If you have a 64MB SDRAM module, set
4926 it above 400_0000. Just make sure your board has no resources
4927 that are supposed to respond to that address! That code in
4928 start.S has been around a while and should work as is when
4929 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931 -Chris Hallinan
4932 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934It is essential to remember this, since it has some impact on the C
4935code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004936
wdenk6c59edc2004-05-03 20:45:30 +00004937* Initialized global data (data segment) is read-only. Do not attempt
4938 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004939
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004940* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004941 as zero data - BSS segment) at all - this is undefined, initiali-
4942 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944* Stack space is very limited. Avoid big data buffers or things like
4945 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004946
wdenk6c59edc2004-05-03 20:45:30 +00004947Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004948normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004949turned out that the implementation of U-Boot can be greatly
4950simplified by making a global data structure (gd_t) available to all
4951functions. We could pass a pointer to this data as argument to _all_
4952functions, but this would bloat the code. Instead we use a feature of
4953the GCC compiler (Global Register Variables) to share the data: we
4954place a pointer (gd) to the global data into a register which we
4955reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957When choosing a register for such a purpose we are restricted by the
4958relevant (E)ABI specifications for the current architecture, and by
4959GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk6c59edc2004-05-03 20:45:30 +00004961For PowerPC, the following registers have specific use:
4962 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004963 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004964 R3-R4: parameter passing and return values
4965 R5-R10: parameter passing
4966 R13: small data area pointer
4967 R30: GOT pointer
4968 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004969
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004970 (U-Boot also uses R12 as internal GOT pointer. r12
4971 is a volatile register so r12 needs to be reset when
4972 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004973
Wolfgang Denk69c09642008-02-14 22:43:22 +01004974 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976 Note: on PPC, we could use a static initializer (since the
4977 address of the global data structure is known at compile time),
4978 but it turned out that reserving a register results in somewhat
4979 smaller code - although the code savings are not that big (on
4980 average for all boards 752 bytes for the whole U-Boot image,
4981 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004982
wdenk6c59edc2004-05-03 20:45:30 +00004983On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985 R0: function argument word/integer result
4986 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004987 R9: platform specific
4988 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004989 R11: argument (frame) pointer
4990 R12: temporary workspace
4991 R13: stack pointer
4992 R14: link register
4993 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004994
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004995 ==> U-Boot will use R9 to hold a pointer to the global data
4996
4997 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004998
Thomas Chou8fa38582010-05-21 11:08:03 +08004999On Nios II, the ABI is documented here:
5000 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5001
5002 ==> U-Boot will use gp to hold a pointer to the global data
5003
5004 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5005 to access small data sections, so gp is free.
5006
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005007On NDS32, the following registers are used:
5008
5009 R0-R1: argument/return
5010 R2-R5: argument
5011 R15: temporary register for assembler
5012 R16: trampoline register
5013 R28: frame pointer (FP)
5014 R29: global pointer (GP)
5015 R30: link register (LP)
5016 R31: stack pointer (SP)
5017 PC: program counter (PC)
5018
5019 ==> U-Boot will use R10 to hold a pointer to the global data
5020
Wolfgang Denk6405a152006-03-31 18:32:53 +02005021NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5022or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005023
wdenk6c59edc2004-05-03 20:45:30 +00005024Memory Management:
5025------------------
wdenkc6097192002-11-03 00:24:07 +00005026
wdenk6c59edc2004-05-03 20:45:30 +00005027U-Boot runs in system state and uses physical addresses, i.e. the
5028MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk6c59edc2004-05-03 20:45:30 +00005030The available memory is mapped to fixed addresses using the memory
5031controller. In this process, a contiguous block is formed for each
5032memory type (Flash, SDRAM, SRAM), even when it consists of several
5033physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005034
wdenk6c59edc2004-05-03 20:45:30 +00005035U-Boot is installed in the first 128 kB of the first Flash bank (on
5036TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5037booting and sizing and initializing DRAM, the code relocates itself
5038to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005039memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005040configuration setting]. Below that, a structure with global Board
5041Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk6c59edc2004-05-03 20:45:30 +00005043Additionally, some exception handler code is copied to the low 8 kB
5044of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005045
wdenk6c59edc2004-05-03 20:45:30 +00005046So a typical memory configuration with 16 MB of DRAM could look like
5047this:
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk6c59edc2004-05-03 20:45:30 +00005049 0x0000 0000 Exception Vector code
5050 :
5051 0x0000 1FFF
5052 0x0000 2000 Free for Application Use
5053 :
5054 :
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056 :
5057 :
5058 0x00FB FF20 Monitor Stack (Growing downward)
5059 0x00FB FFAC Board Info Data and permanent copy of global data
5060 0x00FC 0000 Malloc Arena
5061 :
5062 0x00FD FFFF
5063 0x00FE 0000 RAM Copy of Monitor Code
5064 ... eventually: LCD or video framebuffer
5065 ... eventually: pRAM (Protected RAM - unchanged by reset)
5066 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005067
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069System Initialization:
5070----------------------
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005073(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005074configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005075To be able to re-map memory U-Boot then jumps to its link address.
5076To be able to implement the initialization code in C, a (small!)
5077initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005078which provide such a feature like), or in a locked part of the data
5079cache. After that, U-Boot initializes the CPU core, the caches and
5080the SIU.
wdenkc6097192002-11-03 00:24:07 +00005081
wdenk6c59edc2004-05-03 20:45:30 +00005082Next, all (potentially) available memory banks are mapped using a
5083preliminary mapping. For example, we put them on 512 MB boundaries
5084(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5085on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5086programmed for SDRAM access. Using the temporary configuration, a
5087simple memory test is run that determines the size of the SDRAM
5088banks.
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090When there is more than one SDRAM bank, and the banks are of
5091different size, the largest is mapped first. For equal size, the first
5092bank (CS2#) is mapped first. The first mapping is always for address
50930x00000000, with any additional banks following immediately to create
5094contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk6c59edc2004-05-03 20:45:30 +00005096Then, the monitor installs itself at the upper end of the SDRAM area
5097and allocates memory for use by malloc() and for the global Board
5098Info data; also, the exception vector code is copied to the low RAM
5099pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005100
wdenk6c59edc2004-05-03 20:45:30 +00005101Only after this relocation will you have a "normal" C environment;
5102until that you are restricted in several ways, mostly because you are
5103running from ROM, and because the code will have to be relocated to a
5104new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005105
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk6c59edc2004-05-03 20:45:30 +00005107U-Boot Porting Guide:
5108----------------------
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk6c59edc2004-05-03 20:45:30 +00005110[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5111list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005112
wdenkc6097192002-11-03 00:24:07 +00005113
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005114int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005115{
5116 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005117
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005118 signal(SIGALRM, no_more_time);
5119 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005122 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005123 return 0;
5124 }
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005127
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005128 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005129
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005130 if (clueless)
5131 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133 while (learning) {
5134 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005135 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5136 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005137 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005138 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005139 }
wdenkc6097192002-11-03 00:24:07 +00005140
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005141 if (available_money > toLocalCurrency ($2500))
5142 Buy a BDI3000;
5143 else
wdenk6c59edc2004-05-03 20:45:30 +00005144 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005145
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005146 if (a similar board exists) { /* hopefully... */
5147 cp -a board/<similar> board/<myboard>
5148 cp include/configs/<similar>.h include/configs/<myboard>.h
5149 } else {
5150 Create your own board support subdirectory;
5151 Create your own board include/configs/<myboard>.h file;
5152 }
5153 Edit new board/<myboard> files
5154 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005155
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005156 while (!accepted) {
5157 while (!running) {
5158 do {
5159 Add / modify source code;
5160 } until (compiles);
5161 Debug;
5162 if (clueless)
5163 email("Hi, I am having problems...");
5164 }
5165 Send patch file to the U-Boot email list;
5166 if (reasonable critiques)
5167 Incorporate improvements from email list code review;
5168 else
5169 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005170 }
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172 return 0;
5173}
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175void no_more_time (int sig)
5176{
5177 hire_a_guru();
5178}
wdenkc6097192002-11-03 00:24:07 +00005179
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk6c59edc2004-05-03 20:45:30 +00005181Coding Standards:
5182-----------------
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005185coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005186"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005187
5188Source files originating from a different project (for example the
5189MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005190reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005191sources.
wdenkc6097192002-11-03 00:24:07 +00005192
Detlev Zundelaa63d482006-09-01 15:39:02 +02005193Please note that U-Boot is implemented in C (and to some small parts in
5194Assembler); no C++ is used, so please do not use C++ style comments (//)
5195in your code.
wdenkad276f22004-01-04 16:28:35 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197Please also stick to the following formatting rules:
5198- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005199- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005200- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005201- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005202- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204Submissions which do not conform to the standards may be returned
5205with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005206
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208Submitting Patches:
5209-------------------
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211Since the number of patches for U-Boot is growing, we need to
5212establish some rules. Submissions which do not conform to these rules
5213may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005214
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005215Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005216
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005217Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5218see http://lists.denx.de/mailman/listinfo/u-boot
5219
wdenk6c59edc2004-05-03 20:45:30 +00005220When you send a patch, please include the following information with
5221it:
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223* For bug fixes: a description of the bug and how your patch fixes
5224 this bug. Please try to include a way of demonstrating that the
5225 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227* For new features: a description of the feature and your
5228 implementation.
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk6c59edc2004-05-03 20:45:30 +00005230* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005231
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005232* For major contributions, add a MAINTAINERS file with your
5233 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005234
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005235* When you add support for a new board, don't forget to add a
5236 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238* If your patch adds new configuration options, don't forget to
5239 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005240
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005241* The patch itself. If you are using git (which is *strongly*
5242 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005243 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005244 the U-Boot mailing list, you will avoid most of the common problems
5245 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005246
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005247 If you cannot use git, use "diff -purN OLD NEW". If your version of
5248 diff does not support these options, then get the latest version of
5249 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005250
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005251 The current directory when running this command shall be the parent
5252 directory of the U-Boot source tree (i. e. please make sure that
5253 your patch includes sufficient directory information for the
5254 affected files).
5255
5256 We prefer patches as plain text. MIME attachments are discouraged,
5257 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259* If one logical set of modifications affects or creates several
5260 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262* Changesets that contain different, unrelated modifications shall be
5263 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005264
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266Notes:
wdenkc6097192002-11-03 00:24:07 +00005267
Simon Glassdc27def2016-07-27 20:33:08 -06005268* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005269 source tree and make sure that no errors or warnings are reported
5270 for any of the boards.
5271
5272* Keep your modifications to the necessary minimum: A patch
5273 containing several unrelated changes or arbitrary reformats will be
5274 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276* If you modify existing code, make sure that your new code does not
5277 add to the memory footprint of the code ;-) Small is beautiful!
5278 When adding new features, these should compile conditionally only
5279 (using #ifdef), and the resulting code with the new feature
5280 disabled must not need more memory than the old code without your
5281 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005282
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005283* Remember that there is a size limit of 100 kB per message on the
5284 u-boot mailing list. Bigger patches will be moderated. If they are
5285 reasonable and not too big, they will be acknowledged. But patches
5286 bigger than the size limit should be avoided.