blob: 1b1d7a1c3fe3cd39e1967e04352d4b6ae8d57f9f [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
702 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000703 This can be used to pass arguments to the bootm
704 command. The value of CONFIG_BOOTARGS goes into the
705 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000706
707 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000708 The value of these goes into the environment as
709 "ramboot" and "nfsboot" respectively, and can be used
710 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200711 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000712
Heiko Schocher040c5c32013-11-04 14:04:59 +0100713- Bootcount:
714 CONFIG_BOOTCOUNT_LIMIT
715 Implements a mechanism for detecting a repeating reboot
716 cycle, see:
717 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
718
719 CONFIG_BOOTCOUNT_ENV
720 If no softreset save registers are found on the hardware
721 "bootcount" is stored in the environment. To prevent a
722 saveenv on all reboots, the environment variable
723 "upgrade_available" is used. If "upgrade_available" is
724 0, "bootcount" is always 0, if "upgrade_available" is
725 1 "bootcount" is incremented in the environment.
726 So the Userspace Applikation must set the "upgrade_available"
727 and "bootcount" variable to 0, if a boot was successfully.
728
wdenkc6097192002-11-03 00:24:07 +0000729- Pre-Boot Commands:
730 CONFIG_PREBOOT
731
732 When this option is #defined, the existence of the
733 environment variable "preboot" will be checked
734 immediately before starting the CONFIG_BOOTDELAY
735 countdown and/or running the auto-boot command resp.
736 entering interactive mode.
737
738 This feature is especially useful when "preboot" is
739 automatically generated or modified. For an example
740 see the LWMON board specific code: here "preboot" is
741 modified when the user holds down a certain
742 combination of keys on the (special) keyboard when
743 booting the systems
744
745- Serial Download Echo Mode:
746 CONFIG_LOADS_ECHO
747 If defined to 1, all characters received during a
748 serial download (using the "loads" command) are
749 echoed back. This might be needed by some terminal
750 emulations (like "cu"), but may as well just take
751 time on others. This setting #define's the initial
752 value of the "loads_echo" environment variable.
753
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500754- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000755 CONFIG_KGDB_BAUDRATE
756 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200757 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000758
759- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500760 The default command configuration includes all commands
761 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000762
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100763 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500764 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500765 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500766 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400767 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500768 CONFIG_CMD_CACHE * icache, dcache
769 CONFIG_CMD_CONSOLE coninfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500770 CONFIG_CMD_DHCP * DHCP support
771 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500772 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500773 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500774 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500775 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500776 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000777 CONFIG_CMD_EXT2 * ext2 command support
778 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700779 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
780 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100781 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500782 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500783 CONFIG_CMD_FLASH flinfo, erase, protect
784 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500785 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000786 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500787 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500788 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000789 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200790 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500791 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000792 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500793 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200794 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000795 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
796 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500797 CONFIG_CMD_LOADB loadb
798 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200799 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400800 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000801 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500802 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000803 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200804 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500805 CONFIG_CMD_MISC Misc functions like sleep etc
806 CONFIG_CMD_MMC * MMC memory mapped support
807 CONFIG_CMD_MII * MII utility commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500808 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200809 CONFIG_CMD_NFS NFS support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500810 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
811 host
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500812 CONFIG_CMD_RUN run command in env variable
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700813 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800814 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200815 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500816 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000817 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000818 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000819 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
820 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500821 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500822 CONFIG_CMD_CDP * Cisco Discover Protocol support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200823 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000824
825 EXAMPLE: If you want all functions except of network
826 support you can write:
827
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500828 #include "config_cmd_all.h"
829 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000830
Gerald Van Barend6abef42007-03-31 12:23:51 -0400831 Other Commands:
832 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000833
834 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500835 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000836 what you (and your U-Boot users) are doing. Data
Heiko Schocher65d94db2017-06-07 17:33:09 +0200837 cache cannot be enabled on systems like the
Christophe Leroy069fa832017-07-06 10:23:22 +0200838 8xx (where accesses to the IMMR region must be
wdenk4a5c8a72003-03-06 00:02:04 +0000839 uncached), and it cannot be disabled on all other
840 systems where we (mis-) use the data cache to hold an
841 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000842
843
844 XXX - this list needs to get updated!
845
Simon Glassaa34ef22016-03-13 19:07:28 -0600846- Removal of commands
847 If no commands are needed to boot, you can disable
848 CONFIG_CMDLINE to remove them. In this case, the command line
849 will not be available, and when U-Boot wants to execute the
850 boot command (on start-up) it will call board_run_command()
851 instead. This can reduce image size significantly for very
852 simple boot procedures.
853
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000854- Regular expression support:
855 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200856 If this variable is defined, U-Boot is linked against
857 the SLRE (Super Light Regular Expression) library,
858 which adds regex support to some commands, as for
859 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000860
Simon Glass3d686442011-10-15 05:48:20 +0000861- Device tree:
862 CONFIG_OF_CONTROL
863 If this variable is defined, U-Boot will use a device tree
864 to configure its devices, instead of relying on statically
865 compiled #defines in the board file. This option is
866 experimental and only available on a few boards. The device
867 tree is available in the global data as gd->fdt_blob.
868
Simon Glass5cb34db2011-10-24 19:15:31 +0000869 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700870 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000871
872 CONFIG_OF_EMBED
873 If this variable is defined, U-Boot will embed a device tree
874 binary in its image. This device tree file should be in the
875 board directory and called <soc>-<board>.dts. The binary file
876 is then picked up in board_init_f() and made available through
877 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000878
Simon Glass5cb34db2011-10-24 19:15:31 +0000879 CONFIG_OF_SEPARATE
880 If this variable is defined, U-Boot will build a device tree
881 binary. It will be called u-boot.dtb. Architecture-specific
882 code will locate it at run-time. Generally this works by:
883
884 cat u-boot.bin u-boot.dtb >image.bin
885
886 and in fact, U-Boot does this for you, creating a file called
887 u-boot-dtb.bin which is useful in the common case. You can
888 still use the individual files if you need something more
889 exotic.
890
Alex Deymo5b661ec2017-04-02 01:25:20 -0700891 CONFIG_OF_BOARD
892 If this variable is defined, U-Boot will use the device tree
893 provided by the board at runtime instead of embedding one with
894 the image. Only boards defining board_fdt_blob_setup() support
895 this option (see include/fdtdec.h file).
896
wdenkc6097192002-11-03 00:24:07 +0000897- Watchdog:
898 CONFIG_WATCHDOG
899 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000900 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200901 specific code for a watchdog. For the 8xx
902 CPUs, the SIU Watchdog feature is enabled in the SYPCR
903 register. When supported for a specific SoC is
904 available, then no further board specific code should
905 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000906
907 CONFIG_HW_WATCHDOG
908 When using a watchdog circuitry external to the used
909 SoC, then define this variable and provide board
910 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000911
Heiko Schocher735326c2015-01-21 08:38:22 +0100912 CONFIG_AT91_HW_WDT_TIMEOUT
913 specify the timeout in seconds. default 2 seconds.
914
stroeseb9c17c52003-04-04 15:53:41 +0000915- U-Boot Version:
916 CONFIG_VERSION_VARIABLE
917 If this variable is defined, an environment variable
918 named "ver" is created by U-Boot showing the U-Boot
919 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200920 Any change to this variable will be reverted at the
921 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000922
wdenkc6097192002-11-03 00:24:07 +0000923- Real-Time Clock:
924
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500925 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000926 has to be selected, too. Define exactly one of the
927 following options:
928
wdenkc6097192002-11-03 00:24:07 +0000929 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000930 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000931 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000932 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000933 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000934 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200935 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000936 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100937 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000938 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200939 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200940 CONFIG_SYS_RV3029_TCR - enable trickle charger on
941 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000942
wdenkb9bbd242003-06-30 16:24:52 +0000943 Note that if the RTC uses I2C, then the I2C interface
944 must also be configured. See I2C Support, below.
945
Peter Tyser9902e422008-12-17 16:36:21 -0600946- GPIO Support:
947 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600948
Chris Packham9b383202010-12-19 10:12:13 +0000949 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
950 chip-ngpio pairs that tell the PCA953X driver the number of
951 pins supported by a particular chip.
952
Peter Tyser9902e422008-12-17 16:36:21 -0600953 Note that if the GPIO device uses I2C, then the I2C interface
954 must also be configured. See I2C Support, below.
955
Simon Glass4dc47ca2014-06-11 23:29:41 -0600956- I/O tracing:
957 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
958 accesses and can checksum them or write a list of them out
959 to memory. See the 'iotrace' command for details. This is
960 useful for testing device drivers since it can confirm that
961 the driver behaves the same way before and after a code
962 change. Currently this is supported on sandbox and arm. To
963 add support for your architecture, add '#include <iotrace.h>'
964 to the bottom of arch/<arch>/include/asm/io.h and test.
965
966 Example output from the 'iotrace stats' command is below.
967 Note that if the trace buffer is exhausted, the checksum will
968 still continue to operate.
969
970 iotrace is enabled
971 Start: 10000000 (buffer start address)
972 Size: 00010000 (buffer size)
973 Offset: 00000120 (current buffer offset)
974 Output: 10000120 (start + offset)
975 Count: 00000018 (number of trace records)
976 CRC32: 9526fb66 (CRC32 of all trace records)
977
wdenkc6097192002-11-03 00:24:07 +0000978- Timestamp Support:
979
wdenk4a5c8a72003-03-06 00:02:04 +0000980 When CONFIG_TIMESTAMP is selected, the timestamp
981 (date and time) of an image is printed by image
982 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500983 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000984
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000985- Partition Labels (disklabels) Supported:
986 Zero or more of the following:
987 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000988 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
989 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
990 bootloader. Note 2TB partition limit; see
991 disk/part_efi.c
992 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000993
Simon Glassb569a012017-05-17 03:25:30 -0600994 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -0600995 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000996 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000997
998- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000999 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1000 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001001
wdenk369d43d2004-03-14 14:09:05 +00001002 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1003 be performed by calling the function
1004 ide_set_reset(int reset)
1005 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001006
1007- ATAPI Support:
1008 CONFIG_ATAPI
1009
1010 Set this to enable ATAPI support.
1011
wdenkf602aa02004-03-13 23:29:43 +00001012- LBA48 Support
1013 CONFIG_LBA48
1014
1015 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001016 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001017 Whithout these , LBA48 support uses 32bit variables and will 'only'
1018 support disks up to 2.1TB.
1019
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001020 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001021 When enabled, makes the IDE subsystem use 64bit sector addresses.
1022 Default is 32bit.
1023
wdenkc6097192002-11-03 00:24:07 +00001024- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001025 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1026 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1027 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001028 maximum numbers of LUNs, SCSI ID's and target
1029 devices.
wdenkc6097192002-11-03 00:24:07 +00001030
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001031 The environment variable 'scsidevs' is set to the number of
1032 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001033
wdenkc6097192002-11-03 00:24:07 +00001034- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001035 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001036 Support for Intel 8254x/8257x gigabit chips.
1037
1038 CONFIG_E1000_SPI
1039 Utility code for direct access to the SPI bus on Intel 8257x.
1040 This does not do anything useful unless you set at least one
1041 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1042
1043 CONFIG_E1000_SPI_GENERIC
1044 Allow generic access to the SPI bus on the Intel 8257x, for
1045 example with the "sspi" command.
1046
1047 CONFIG_CMD_E1000
1048 Management command for E1000 devices. When used on devices
1049 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001050
wdenkc6097192002-11-03 00:24:07 +00001051 CONFIG_EEPRO100
1052 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001053 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001054 write routine for first time initialisation.
1055
1056 CONFIG_TULIP
1057 Support for Digital 2114x chips.
1058 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1059 modem chip initialisation (KS8761/QS6611).
1060
1061 CONFIG_NATSEMI
1062 Support for National dp83815 chips.
1063
1064 CONFIG_NS8382X
1065 Support for National dp8382[01] gigabit chips.
1066
wdenkaa603362003-05-12 21:50:16 +00001067- NETWORK Support (other):
1068
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001069 CONFIG_DRIVER_AT91EMAC
1070 Support for AT91RM9200 EMAC.
1071
1072 CONFIG_RMII
1073 Define this to use reduced MII inteface
1074
1075 CONFIG_DRIVER_AT91EMAC_QUIET
1076 If this defined, the driver is quiet.
1077 The driver doen't show link status messages.
1078
Rob Herringc9830dc2011-12-15 11:15:49 +00001079 CONFIG_CALXEDA_XGMAC
1080 Support for the Calxeda XGMAC device
1081
Ashok93fb8722012-10-15 06:20:47 +00001082 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001083 Support for SMSC's LAN91C96 chips.
1084
wdenkaa603362003-05-12 21:50:16 +00001085 CONFIG_LAN91C96_USE_32_BIT
1086 Define this to enable 32 bit addressing
1087
Ashok93fb8722012-10-15 06:20:47 +00001088 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001089 Support for SMSC's LAN91C111 chip
1090
1091 CONFIG_SMC91111_BASE
1092 Define this to hold the physical address
1093 of the device (I/O space)
1094
1095 CONFIG_SMC_USE_32_BIT
1096 Define this if data bus is 32 bits
1097
1098 CONFIG_SMC_USE_IOFUNCS
1099 Define this to use i/o functions instead of macros
1100 (some hardware wont work with macros)
1101
Heiko Schocher7d037f72011-11-15 10:00:04 -05001102 CONFIG_DRIVER_TI_EMAC
1103 Support for davinci emac
1104
1105 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1106 Define this if you have more then 3 PHYs.
1107
Macpaul Lin199c6252010-12-21 16:59:46 +08001108 CONFIG_FTGMAC100
1109 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1110
1111 CONFIG_FTGMAC100_EGIGA
1112 Define this to use GE link update with gigabit PHY.
1113 Define this if FTGMAC100 is connected to gigabit PHY.
1114 If your system has 10/100 PHY only, it might not occur
1115 wrong behavior. Because PHY usually return timeout or
1116 useless data when polling gigabit status and gigabit
1117 control registers. This behavior won't affect the
1118 correctnessof 10/100 link speed update.
1119
Mike Rapoportf4761af2009-11-11 10:03:03 +02001120 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001121 Support for SMSC's LAN911x and LAN921x chips
1122
Mike Rapoportf4761af2009-11-11 10:03:03 +02001123 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001124 Define this to hold the physical address
1125 of the device (I/O space)
1126
Mike Rapoportf4761af2009-11-11 10:03:03 +02001127 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001128 Define this if data bus is 32 bits
1129
Mike Rapoportf4761af2009-11-11 10:03:03 +02001130 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001131 Define this if data bus is 16 bits. If your processor
1132 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001133 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001134
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001135 CONFIG_SH_ETHER
1136 Support for Renesas on-chip Ethernet controller
1137
1138 CONFIG_SH_ETHER_USE_PORT
1139 Define the number of ports to be used
1140
1141 CONFIG_SH_ETHER_PHY_ADDR
1142 Define the ETH PHY's address
1143
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001144 CONFIG_SH_ETHER_CACHE_WRITEBACK
1145 If this option is set, the driver enables cache flush.
1146
Heiko Schocher2b387762014-07-18 06:07:19 +02001147- PWM Support:
1148 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001149 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001150
Vadim Bendeburydac69642011-10-17 08:36:14 +00001151- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001152 CONFIG_TPM
1153 Support TPM devices.
1154
Christophe Ricard8759ff82015-10-06 22:54:41 +02001155 CONFIG_TPM_TIS_INFINEON
1156 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001157 per system is supported at this time.
1158
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001159 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1160 Define the burst count bytes upper limit
1161
Christophe Ricard88249232016-01-21 23:27:13 +01001162 CONFIG_TPM_ST33ZP24
1163 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1164
1165 CONFIG_TPM_ST33ZP24_I2C
1166 Support for STMicroelectronics ST33ZP24 I2C devices.
1167 Requires TPM_ST33ZP24 and I2C.
1168
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001169 CONFIG_TPM_ST33ZP24_SPI
1170 Support for STMicroelectronics ST33ZP24 SPI devices.
1171 Requires TPM_ST33ZP24 and SPI.
1172
Dirk Eibach20489092013-06-26 15:55:15 +02001173 CONFIG_TPM_ATMEL_TWI
1174 Support for Atmel TWI TPM device. Requires I2C support.
1175
Che-liang Chiouacea5702013-04-12 11:04:34 +00001176 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001177 Support for generic parallel port TPM devices. Only one device
1178 per system is supported at this time.
1179
1180 CONFIG_TPM_TIS_BASE_ADDRESS
1181 Base address where the generic TPM device is mapped
1182 to. Contemporary x86 systems usually map it at
1183 0xfed40000.
1184
Reinhard Pfau4fece432013-06-26 15:55:13 +02001185 CONFIG_CMD_TPM
1186 Add tpm monitor functions.
1187 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1188 provides monitor access to authorized functions.
1189
1190 CONFIG_TPM
1191 Define this to enable the TPM support library which provides
1192 functional interfaces to some TPM commands.
1193 Requires support for a TPM device.
1194
1195 CONFIG_TPM_AUTH_SESSIONS
1196 Define this to enable authorized functions in the TPM library.
1197 Requires CONFIG_TPM and CONFIG_SHA1.
1198
wdenkc6097192002-11-03 00:24:07 +00001199- USB Support:
1200 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001201 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001202 CONFIG_USB_UHCI to enable it.
1203 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001204 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001205 storage devices.
1206 Note:
1207 Supported are USB Keyboards and USB Floppy drives
1208 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001209
Simon Glass5978cdb2012-02-27 10:52:47 +00001210 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1211 txfilltuning field in the EHCI controller on reset.
1212
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001213 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1214 HW module registers.
1215
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001216- USB Device:
1217 Define the below if you wish to use the USB console.
1218 Once firmware is rebuilt from a serial console issue the
1219 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001220 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001221 it has found a new device. The environment variable usbtty
1222 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001223 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001224 Common Device Class Abstract Control Model serial device.
1225 If you select usbtty = gserial you should be able to enumerate
1226 a Linux host by
1227 # modprobe usbserial vendor=0xVendorID product=0xProductID
1228 else if using cdc_acm, simply setting the environment
1229 variable usbtty to be cdc_acm should suffice. The following
1230 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001231
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001232 CONFIG_USB_DEVICE
1233 Define this to build a UDC device
1234
1235 CONFIG_USB_TTY
1236 Define this to have a tty type of device available to
1237 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001238
Vipin KUMARbdb17702012-03-26 15:38:06 +05301239 CONFIG_USBD_HS
1240 Define this to enable the high speed support for usb
1241 device and usbtty. If this feature is enabled, a routine
1242 int is_usbd_high_speed(void)
1243 also needs to be defined by the driver to dynamically poll
1244 whether the enumeration has succeded at high speed or full
1245 speed.
1246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001247 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001248 Define this if you want stdin, stdout &/or stderr to
1249 be set to usbtty.
1250
Wolfgang Denke2601822006-06-14 18:14:56 +02001251 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001252 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001253 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001254 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1255 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1256 should pretend to be a Linux device to it's target host.
1257
1258 CONFIG_USBD_MANUFACTURER
1259 Define this string as the name of your company for
1260 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001261
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001262 CONFIG_USBD_PRODUCT_NAME
1263 Define this string as the name of your product
1264 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001265
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001266 CONFIG_USBD_VENDORID
1267 Define this as your assigned Vendor ID from the USB
1268 Implementors Forum. This *must* be a genuine Vendor ID
1269 to avoid polluting the USB namespace.
1270 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001271
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001272 CONFIG_USBD_PRODUCTID
1273 Define this as the unique Product ID
1274 for your device
1275 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001276
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001277- ULPI Layer Support:
1278 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1279 the generic ULPI layer. The generic layer accesses the ULPI PHY
1280 via the platform viewport, so you need both the genric layer and
1281 the viewport enabled. Currently only Chipidea/ARC based
1282 viewport is supported.
1283 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1284 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001285 If your ULPI phy needs a different reference clock than the
1286 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1287 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001288
wdenk7a428cc2003-06-15 22:40:42 +00001289- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001290 The MMC controller on the Intel PXA is supported. To
1291 enable this define CONFIG_MMC. The MMC can be
1292 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001293 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001294 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1295 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001296
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001297 CONFIG_SH_MMCIF
1298 Support for Renesas on-chip MMCIF controller
1299
1300 CONFIG_SH_MMCIF_ADDR
1301 Define the base address of MMCIF registers
1302
1303 CONFIG_SH_MMCIF_CLK
1304 Define the clock frequency for MMCIF
1305
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001306 CONFIG_SUPPORT_EMMC_BOOT
1307 Enable some additional features of the eMMC boot partitions.
1308
1309 CONFIG_SUPPORT_EMMC_RPMB
1310 Enable the commands for reading, writing and programming the
1311 key for the Replay Protection Memory Block partition in eMMC.
1312
Tom Rini58a8d322013-03-14 05:32:47 +00001313- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001314 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001315 This enables the USB portion of the DFU USB class
1316
1317 CONFIG_CMD_DFU
1318 This enables the command "dfu" which is used to have
1319 U-Boot create a DFU class device via USB. This command
1320 requires that the "dfu_alt_info" environment variable be
1321 set and define the alt settings to expose to the host.
1322
1323 CONFIG_DFU_MMC
1324 This enables support for exposing (e)MMC devices via DFU.
1325
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001326 CONFIG_DFU_NAND
1327 This enables support for exposing NAND devices via DFU.
1328
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301329 CONFIG_DFU_RAM
1330 This enables support for exposing RAM via DFU.
1331 Note: DFU spec refer to non-volatile memory usage, but
1332 allow usages beyond the scope of spec - here RAM usage,
1333 one that would help mostly the developer.
1334
Heiko Schochera2f831e2013-06-12 06:05:51 +02001335 CONFIG_SYS_DFU_DATA_BUF_SIZE
1336 Dfu transfer uses a buffer before writing data to the
1337 raw storage device. Make the size (in bytes) of this buffer
1338 configurable. The size of this buffer is also configurable
1339 through the "dfu_bufsiz" environment variable.
1340
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001341 CONFIG_SYS_DFU_MAX_FILE_SIZE
1342 When updating files rather than the raw storage device,
1343 we use a static buffer to copy the file into and then write
1344 the buffer once we've been given the whole file. Define
1345 this to the maximum filesize (in bytes) for the buffer.
1346 Default is 4 MiB if undefined.
1347
Heiko Schochere1ba1512014-03-18 08:09:56 +01001348 DFU_DEFAULT_POLL_TIMEOUT
1349 Poll timeout [ms], is the timeout a device can send to the
1350 host. The host must wait for this timeout before sending
1351 a subsequent DFU_GET_STATUS request to the device.
1352
1353 DFU_MANIFEST_POLL_TIMEOUT
1354 Poll timeout [ms], which the device sends to the host when
1355 entering dfuMANIFEST state. Host waits this timeout, before
1356 sending again an USB request to the device.
1357
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001358- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001359 CONFIG_USB_FUNCTION_FASTBOOT
1360 This enables the USB part of the fastboot gadget
1361
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001362 CONFIG_CMD_FASTBOOT
1363 This enables the command "fastboot" which enables the Android
1364 fastboot mode for the platform's USB device. Fastboot is a USB
1365 protocol for downloading images, flashing and device control
1366 used on Android devices.
1367 See doc/README.android-fastboot for more information.
1368
1369 CONFIG_ANDROID_BOOT_IMAGE
1370 This enables support for booting images which use the Android
1371 image format header.
1372
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001373 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001374 The fastboot protocol requires a large memory buffer for
1375 downloads. Define this to the starting RAM address to use for
1376 downloaded images.
1377
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001378 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001379 The fastboot protocol requires a large memory buffer for
1380 downloads. This buffer should be as large as possible for a
1381 platform. Define this to the size available RAM for fastboot.
1382
Steve Raebfb9ba42014-08-26 11:47:28 -07001383 CONFIG_FASTBOOT_FLASH
1384 The fastboot protocol includes a "flash" command for writing
1385 the downloaded image to a non-volatile storage device. Define
1386 this to enable the "fastboot flash" command.
1387
1388 CONFIG_FASTBOOT_FLASH_MMC_DEV
1389 The fastboot "flash" command requires additional information
1390 regarding the non-volatile storage device. Define this to
1391 the eMMC device that fastboot should use to store the image.
1392
Steve Rae7d059342014-12-12 15:51:54 -08001393 CONFIG_FASTBOOT_GPT_NAME
1394 The fastboot "flash" command supports writing the downloaded
1395 image to the Protective MBR and the Primary GUID Partition
1396 Table. (Additionally, this downloaded image is post-processed
1397 to generate and write the Backup GUID Partition Table.)
1398 This occurs when the specified "partition name" on the
1399 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001400 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001401
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001402 CONFIG_FASTBOOT_MBR_NAME
1403 The fastboot "flash" command supports writing the downloaded
1404 image to DOS MBR.
1405 This occurs when the "partition name" specified on the
1406 "fastboot flash" command line matches this value.
1407 If not defined the default value "mbr" is used.
1408
wdenkda04a8b2004-08-02 23:22:59 +00001409- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001410 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001411 Define these for a default partition on a NAND device
1412
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001413 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1414 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001415 Define these for a default partition on a NOR device
1416
wdenkc6097192002-11-03 00:24:07 +00001417- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001418 See Kconfig help for available keyboard drivers.
1419
1420 CONFIG_KEYBOARD
1421
1422 Define this to enable a custom keyboard support.
1423 This simply calls drv_keyboard_init() which must be
1424 defined in your board-specific files. This option is deprecated
1425 and is only used by novena. For new boards, use driver model
1426 instead.
wdenkc6097192002-11-03 00:24:07 +00001427
1428- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001429 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001430 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001431 SOCs that have a DIU should define this macro to enable DIU
1432 support, and should also define these other macros:
1433
1434 CONFIG_SYS_DIU_ADDR
1435 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001436 CONFIG_CFB_CONSOLE
1437 CONFIG_VIDEO_SW_CURSOR
1438 CONFIG_VGA_AS_SINGLE_DEVICE
1439 CONFIG_VIDEO_LOGO
1440 CONFIG_VIDEO_BMP_LOGO
1441
Timur Tabi32f709e2011-04-11 14:18:22 -05001442 The DIU driver will look for the 'video-mode' environment
1443 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001444 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001445 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001446
wdenkc6097192002-11-03 00:24:07 +00001447- LCD Support: CONFIG_LCD
1448
1449 Define this to enable LCD support (for output to LCD
1450 display); also select one of the supported displays
1451 by defining one of these:
1452
Stelian Popf6f86652008-05-09 21:57:18 +02001453 CONFIG_ATMEL_LCD:
1454
1455 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1456
wdenkc0d54ae2003-11-25 16:55:19 +00001457 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001458
wdenkc0d54ae2003-11-25 16:55:19 +00001459 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001460
wdenkc0d54ae2003-11-25 16:55:19 +00001461 CONFIG_NEC_NL6448BC20
1462
1463 NEC NL6448BC20-08. 6.5", 640x480.
1464 Active, color, single scan.
1465
1466 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001467
wdenkc0d54ae2003-11-25 16:55:19 +00001468 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001469 Active, color, single scan.
1470
1471 CONFIG_SHARP_16x9
1472
1473 Sharp 320x240. Active, color, single scan.
1474 It isn't 16x9, and I am not sure what it is.
1475
1476 CONFIG_SHARP_LQ64D341
1477
1478 Sharp LQ64D341 display, 640x480.
1479 Active, color, single scan.
1480
1481 CONFIG_HLD1045
1482
1483 HLD1045 display, 640x480.
1484 Active, color, single scan.
1485
1486 CONFIG_OPTREX_BW
1487
1488 Optrex CBL50840-2 NF-FW 99 22 M5
1489 or
1490 Hitachi LMG6912RPFC-00T
1491 or
1492 Hitachi SP14Q002
1493
1494 320x240. Black & white.
1495
Simon Glass599a4df2012-10-17 13:24:54 +00001496 CONFIG_LCD_ALIGNMENT
1497
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001498 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001499 defined then the LCD will be aligned to this value instead.
1500 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1501 here, since it is cheaper to change data cache settings on
1502 a per-section basis.
1503
1504
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001505 CONFIG_LCD_ROTATION
1506
1507 Sometimes, for example if the display is mounted in portrait
1508 mode or even if it's mounted landscape but rotated by 180degree,
1509 we need to rotate our content of the display relative to the
1510 framebuffer, so that user can read the messages which are
1511 printed out.
1512 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1513 initialized with a given rotation from "vl_rot" out of
1514 "vidinfo_t" which is provided by the board specific code.
1515 The value for vl_rot is coded as following (matching to
1516 fbcon=rotate:<n> linux-kernel commandline):
1517 0 = no rotation respectively 0 degree
1518 1 = 90 degree rotation
1519 2 = 180 degree rotation
1520 3 = 270 degree rotation
1521
1522 If CONFIG_LCD_ROTATION is not defined, the console will be
1523 initialized with 0degree rotation.
1524
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001525 CONFIG_LCD_BMP_RLE8
1526
1527 Support drawing of RLE8-compressed bitmaps on the LCD.
1528
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001529 CONFIG_I2C_EDID
1530
1531 Enables an 'i2c edid' command which can read EDID
1532 information over I2C from an attached LCD display.
1533
wdenkeb20ad32003-09-05 23:19:14 +00001534- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001535
wdenk57b2d802003-06-27 21:31:46 +00001536 If this option is set, the environment is checked for
1537 a variable "splashimage". If found, the usual display
1538 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001539 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001540 specified in "splashimage" is loaded instead. The
1541 console is redirected to the "nulldev", too. This
1542 allows for a "silent" boot where a splash screen is
1543 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001544
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001545 CONFIG_SPLASHIMAGE_GUARD
1546
1547 If this option is set, then U-Boot will prevent the environment
1548 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001549 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001550 This option is useful for targets where, due to alignment
1551 restrictions, an improperly aligned BMP image will cause a data
1552 abort. If you think you will not have problems with unaligned
1553 accesses (for example because your toolchain prevents them)
1554 there is no need to set this option.
1555
Matthias Weisser53884182009-07-09 16:07:30 +02001556 CONFIG_SPLASH_SCREEN_ALIGN
1557
1558 If this option is set the splash image can be freely positioned
1559 on the screen. Environment variable "splashpos" specifies the
1560 position as "x,y". If a positive number is given it is used as
1561 number of pixel from left/top. If a negative number is given it
1562 is used as number of pixel from right/bottom. You can also
1563 specify 'm' for centering the image.
1564
1565 Example:
1566 setenv splashpos m,m
1567 => image at center of screen
1568
1569 setenv splashpos 30,20
1570 => image at x = 30 and y = 20
1571
1572 setenv splashpos -10,m
1573 => vertically centered image
1574 at x = dspWidth - bmpWidth - 9
1575
Stefan Roesed9d97742005-09-22 09:04:17 +02001576- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1577
1578 If this option is set, additionally to standard BMP
1579 images, gzipped BMP images can be displayed via the
1580 splashscreen support or the bmp command.
1581
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001582- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1583
1584 If this option is set, 8-bit RLE compressed BMP images
1585 can be displayed via the splashscreen support or the
1586 bmp command.
1587
wdenk710e3502003-08-29 20:57:53 +00001588- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001589 CONFIG_GZIP
1590
1591 Enabled by default to support gzip compressed images.
1592
wdenk710e3502003-08-29 20:57:53 +00001593 CONFIG_BZIP2
1594
1595 If this option is set, support for bzip2 compressed
1596 images is included. If not, only uncompressed and gzip
1597 compressed images are supported.
1598
wdenk9c53f402003-10-15 23:53:47 +00001599 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001600 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001601 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001602
wdenk0e2bd9c2004-06-06 21:51:03 +00001603- MII/PHY support:
1604 CONFIG_PHY_ADDR
1605
1606 The address of PHY on MII bus.
1607
1608 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1609
1610 The clock frequency of the MII bus
1611
wdenk0e2bd9c2004-06-06 21:51:03 +00001612 CONFIG_PHY_RESET_DELAY
1613
1614 Some PHY like Intel LXT971A need extra delay after
1615 reset before any MII register access is possible.
1616 For such PHY, set this option to the usec delay
1617 required. (minimum 300usec for LXT971A)
1618
1619 CONFIG_PHY_CMD_DELAY (ppc4xx)
1620
1621 Some PHY like Intel LXT971A need extra delay after
1622 command issued before MII status register can be read
1623
wdenkc6097192002-11-03 00:24:07 +00001624- IP address:
1625 CONFIG_IPADDR
1626
1627 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001628 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001629 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001630 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001631
1632- Server IP address:
1633 CONFIG_SERVERIP
1634
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001635 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001636 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001637 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001638
Robin Getz470a6d42009-07-21 12:15:28 -04001639 CONFIG_KEEP_SERVERADDR
1640
1641 Keeps the server's MAC address, in the env 'serveraddr'
1642 for passing to bootargs (like Linux's netconsole option)
1643
Wolfgang Denk26da2992011-10-26 10:21:22 +00001644- Gateway IP address:
1645 CONFIG_GATEWAYIP
1646
1647 Defines a default value for the IP address of the
1648 default router where packets to other networks are
1649 sent to.
1650 (Environment variable "gatewayip")
1651
1652- Subnet mask:
1653 CONFIG_NETMASK
1654
1655 Defines a default value for the subnet mask (or
1656 routing prefix) which is used to determine if an IP
1657 address belongs to the local subnet or needs to be
1658 forwarded through a router.
1659 (Environment variable "netmask")
1660
David Updegraff7280da72007-06-11 10:41:07 -05001661- Multicast TFTP Mode:
1662 CONFIG_MCAST_TFTP
1663
1664 Defines whether you want to support multicast TFTP as per
1665 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001666 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001667 driver in use must provide a function: mcast() to join/leave a
1668 multicast group.
1669
wdenkc6097192002-11-03 00:24:07 +00001670- BOOTP Recovery Mode:
1671 CONFIG_BOOTP_RANDOM_DELAY
1672
1673 If you have many targets in a network that try to
1674 boot using BOOTP, you may want to avoid that all
1675 systems send out BOOTP requests at precisely the same
1676 moment (which would happen for instance at recovery
1677 from a power failure, when all systems will try to
1678 boot, thus flooding the BOOTP server. Defining
1679 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1680 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001681 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001682
1683 1st BOOTP request: delay 0 ... 1 sec
1684 2nd BOOTP request: delay 0 ... 2 sec
1685 3rd BOOTP request: delay 0 ... 4 sec
1686 4th and following
1687 BOOTP requests: delay 0 ... 8 sec
1688
Thierry Reding8977cda2014-08-19 10:21:24 +02001689 CONFIG_BOOTP_ID_CACHE_SIZE
1690
1691 BOOTP packets are uniquely identified using a 32-bit ID. The
1692 server will copy the ID from client requests to responses and
1693 U-Boot will use this to determine if it is the destination of
1694 an incoming response. Some servers will check that addresses
1695 aren't in use before handing them out (usually using an ARP
1696 ping) and therefore take up to a few hundred milliseconds to
1697 respond. Network congestion may also influence the time it
1698 takes for a response to make it back to the client. If that
1699 time is too long, U-Boot will retransmit requests. In order
1700 to allow earlier responses to still be accepted after these
1701 retransmissions, U-Boot's BOOTP client keeps a small cache of
1702 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1703 cache. The default is to keep IDs for up to four outstanding
1704 requests. Increasing this will allow U-Boot to accept offers
1705 from a BOOTP client in networks with unusually high latency.
1706
stroesee0aadfb2003-08-28 14:17:32 +00001707- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001708 You can fine tune the DHCP functionality by defining
1709 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001710
Jon Loeliger5336a762007-07-09 22:08:34 -05001711 CONFIG_BOOTP_SUBNETMASK
1712 CONFIG_BOOTP_GATEWAY
1713 CONFIG_BOOTP_HOSTNAME
1714 CONFIG_BOOTP_NISDOMAIN
1715 CONFIG_BOOTP_BOOTPATH
1716 CONFIG_BOOTP_BOOTFILESIZE
1717 CONFIG_BOOTP_DNS
1718 CONFIG_BOOTP_DNS2
1719 CONFIG_BOOTP_SEND_HOSTNAME
1720 CONFIG_BOOTP_NTPSERVER
1721 CONFIG_BOOTP_TIMEOFFSET
1722 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001723 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001724
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001725 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1726 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001727
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001728 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1729 after the configured retry count, the call will fail
1730 instead of starting over. This can be used to fail over
1731 to Link-local IP address configuration if the DHCP server
1732 is not available.
1733
stroesee0aadfb2003-08-28 14:17:32 +00001734 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1735 serverip from a DHCP server, it is possible that more
1736 than one DNS serverip is offered to the client.
1737 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1738 serverip will be stored in the additional environment
1739 variable "dnsip2". The first DNS serverip is always
1740 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001741 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001742
1743 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1744 to do a dynamic update of a DNS server. To do this, they
1745 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001746 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001747 of the "hostname" environment variable is passed as
1748 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001749
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001750 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1751
1752 A 32bit value in microseconds for a delay between
1753 receiving a "DHCP Offer" and sending the "DHCP Request".
1754 This fixes a problem with certain DHCP servers that don't
1755 respond 100% of the time to a "DHCP request". E.g. On an
1756 AT91RM9200 processor running at 180MHz, this delay needed
1757 to be *at least* 15,000 usec before a Windows Server 2003
1758 DHCP server would reply 100% of the time. I recommend at
1759 least 50,000 usec to be safe. The alternative is to hope
1760 that one of the retries will be successful but note that
1761 the DHCP timeout and retry process takes a longer than
1762 this delay.
1763
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001764 - Link-local IP address negotiation:
1765 Negotiate with other link-local clients on the local network
1766 for an address that doesn't require explicit configuration.
1767 This is especially useful if a DHCP server cannot be guaranteed
1768 to exist in all environments that the device must operate.
1769
1770 See doc/README.link-local for more information.
1771
wdenk145d2c12004-04-15 21:48:45 +00001772 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001773 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001774
1775 The device id used in CDP trigger frames.
1776
1777 CONFIG_CDP_DEVICE_ID_PREFIX
1778
1779 A two character string which is prefixed to the MAC address
1780 of the device.
1781
1782 CONFIG_CDP_PORT_ID
1783
1784 A printf format string which contains the ascii name of
1785 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001786 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001787
1788 CONFIG_CDP_CAPABILITIES
1789
1790 A 32bit integer which indicates the device capabilities;
1791 0x00000010 for a normal host which does not forwards.
1792
1793 CONFIG_CDP_VERSION
1794
1795 An ascii string containing the version of the software.
1796
1797 CONFIG_CDP_PLATFORM
1798
1799 An ascii string containing the name of the platform.
1800
1801 CONFIG_CDP_TRIGGER
1802
1803 A 32bit integer sent on the trigger.
1804
1805 CONFIG_CDP_POWER_CONSUMPTION
1806
1807 A 16bit integer containing the power consumption of the
1808 device in .1 of milliwatts.
1809
1810 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1811
1812 A byte containing the id of the VLAN.
1813
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001814- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001815
1816 Several configurations allow to display the current
1817 status using a LED. For instance, the LED will blink
1818 fast while running U-Boot code, stop blinking as
1819 soon as a reply to a BOOTP request was received, and
1820 start blinking slow once the Linux kernel is running
1821 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001822 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001823 feature in U-Boot.
1824
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001825 Additional options:
1826
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001827 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001828 The status LED can be connected to a GPIO pin.
1829 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001830 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001831 to include the gpio_led driver in the U-Boot binary.
1832
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001833 CONFIG_GPIO_LED_INVERTED_TABLE
1834 Some GPIO connected LEDs may have inverted polarity in which
1835 case the GPIO high value corresponds to LED off state and
1836 GPIO low value corresponds to LED on state.
1837 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1838 with a list of GPIO LEDs that have inverted polarity.
1839
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001840- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001841
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001842 This enable the NEW i2c subsystem, and will allow you to use
1843 i2c commands at the u-boot command line (as long as you set
1844 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1845 based realtime clock chips or other i2c devices. See
1846 common/cmd_i2c.c for a description of the command line
1847 interface.
1848
1849 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001850 - drivers/i2c/soft_i2c.c:
1851 - activate first bus with CONFIG_SYS_I2C_SOFT define
1852 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1853 for defining speed and slave address
1854 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1855 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1856 for defining speed and slave address
1857 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1858 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1859 for defining speed and slave address
1860 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1861 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1862 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001863
Heiko Schocherf2850742012-10-24 13:48:22 +02001864 - drivers/i2c/fsl_i2c.c:
1865 - activate i2c driver with CONFIG_SYS_I2C_FSL
1866 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1867 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1868 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1869 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001870 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001871 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1872 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1873 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1874 second bus.
1875
Simon Glass026fefb2012-10-30 07:28:53 +00001876 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001877 - activate this driver with CONFIG_SYS_I2C_TEGRA
1878 - This driver adds 4 i2c buses with a fix speed from
1879 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001880
Dirk Eibach42b204f2013-04-25 02:40:01 +00001881 - drivers/i2c/ppc4xx_i2c.c
1882 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1883 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1884 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1885
trema49f40a2013-09-21 18:13:35 +02001886 - drivers/i2c/i2c_mxc.c
1887 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001888 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1889 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1890 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1891 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001892 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1893 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1894 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1895 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1896 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1897 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001898 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1899 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001900 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001901 for speed, and 0 for slave.
1902
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001903 - drivers/i2c/rcar_i2c.c:
1904 - activate this driver with CONFIG_SYS_I2C_RCAR
1905 - This driver adds 4 i2c buses
1906
1907 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1908 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1909 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1910 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1911 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1912 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1913 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1914 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1915 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1916
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001917 - drivers/i2c/sh_i2c.c:
1918 - activate this driver with CONFIG_SYS_I2C_SH
1919 - This driver adds from 2 to 5 i2c buses
1920
1921 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1922 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1923 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1924 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1925 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1926 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1927 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1928 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1929 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1930 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001931 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001932
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001933 - drivers/i2c/omap24xx_i2c.c
1934 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1935 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1936 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1937 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1938 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1939 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1940 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1941 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1942 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1943 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1944 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1945
Heiko Schocher465819a2013-11-08 07:30:53 +01001946 - drivers/i2c/zynq_i2c.c
1947 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1948 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1949 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1950
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301951 - drivers/i2c/s3c24x0_i2c.c:
1952 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1953 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1954 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1955 with a fix speed from 100000 and the slave addr 0!
1956
Dirk Eibachb9577432014-07-03 09:28:18 +02001957 - drivers/i2c/ihs_i2c.c
1958 - activate this driver with CONFIG_SYS_I2C_IHS
1959 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1960 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1961 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1962 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1963 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1964 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1965 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1966 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1967 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1968 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1969 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1970 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001971 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1972 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1973 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1974 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1975 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1976 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1977 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1978 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1979 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001980
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001981 additional defines:
1982
1983 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001984 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001985
1986 CONFIG_SYS_I2C_DIRECT_BUS
1987 define this, if you don't use i2c muxes on your hardware.
1988 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1989 omit this define.
1990
1991 CONFIG_SYS_I2C_MAX_HOPS
1992 define how many muxes are maximal consecutively connected
1993 on one i2c bus. If you not use i2c muxes, omit this
1994 define.
1995
1996 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001997 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001998 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1999 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2000 CONFIG_SYS_NUM_I2C_BUSES = 9:
2001
2002 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2003 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2004 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2005 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2006 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2007 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2008 {1, {I2C_NULL_HOP}}, \
2009 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2010 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2011 }
2012
2013 which defines
2014 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002015 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2016 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2017 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2018 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2019 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002020 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002021 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2022 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002023
2024 If you do not have i2c muxes on your board, omit this define.
2025
Simon Glass3efce392017-05-12 21:10:00 -06002026- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002027 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002028 then the following macros need to be defined (examples are
2029 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002030
2031 I2C_INIT
2032
wdenkb9bbd242003-06-30 16:24:52 +00002033 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002034 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002035
wdenk544e9732004-02-06 23:19:44 +00002036 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002037
wdenkc6097192002-11-03 00:24:07 +00002038 I2C_ACTIVE
2039
2040 The code necessary to make the I2C data line active
2041 (driven). If the data line is open collector, this
2042 define can be null.
2043
wdenkb9bbd242003-06-30 16:24:52 +00002044 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2045
wdenkc6097192002-11-03 00:24:07 +00002046 I2C_TRISTATE
2047
2048 The code necessary to make the I2C data line tri-stated
2049 (inactive). If the data line is open collector, this
2050 define can be null.
2051
wdenkb9bbd242003-06-30 16:24:52 +00002052 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2053
wdenkc6097192002-11-03 00:24:07 +00002054 I2C_READ
2055
York Sun4a598092013-04-01 11:29:11 -07002056 Code that returns true if the I2C data line is high,
2057 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002058
wdenkb9bbd242003-06-30 16:24:52 +00002059 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2060
wdenkc6097192002-11-03 00:24:07 +00002061 I2C_SDA(bit)
2062
York Sun4a598092013-04-01 11:29:11 -07002063 If <bit> is true, sets the I2C data line high. If it
2064 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002065
wdenkb9bbd242003-06-30 16:24:52 +00002066 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002067 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002068 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002069
wdenkc6097192002-11-03 00:24:07 +00002070 I2C_SCL(bit)
2071
York Sun4a598092013-04-01 11:29:11 -07002072 If <bit> is true, sets the I2C clock line high. If it
2073 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002074
wdenkb9bbd242003-06-30 16:24:52 +00002075 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002076 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002077 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002078
wdenkc6097192002-11-03 00:24:07 +00002079 I2C_DELAY
2080
2081 This delay is invoked four times per clock cycle so this
2082 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002083 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002084 like:
2085
wdenkb9bbd242003-06-30 16:24:52 +00002086 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002087
Mike Frysingeree12d542010-07-21 13:38:02 -04002088 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2089
2090 If your arch supports the generic GPIO framework (asm/gpio.h),
2091 then you may alternatively define the two GPIOs that are to be
2092 used as SCL / SDA. Any of the previous I2C_xxx macros will
2093 have GPIO-based defaults assigned to them as appropriate.
2094
2095 You should define these to the GPIO value as given directly to
2096 the generic GPIO functions.
2097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002098 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002099
wdenk57b2d802003-06-27 21:31:46 +00002100 When a board is reset during an i2c bus transfer
2101 chips might think that the current transfer is still
2102 in progress. On some boards it is possible to access
2103 the i2c SCLK line directly, either by using the
2104 processor pin as a GPIO or by having a second pin
2105 connected to the bus. If this option is defined a
2106 custom i2c_init_board() routine in boards/xxx/board.c
2107 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002108
Ben Warren45657152006-09-07 16:50:54 -04002109 CONFIG_I2C_MULTI_BUS
2110
2111 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002112 must have a controller. At any point in time, only one bus is
2113 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002114 Note that bus numbering is zero-based.
2115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002116 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002117
2118 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002119 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002120 is set, specify a list of bus-device pairs. Otherwise, specify
2121 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002122
2123 e.g.
2124 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002125 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002126
2127 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2128
Wolfgang Denk092ae952011-10-26 10:21:21 +00002129 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002130 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002131
2132 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002134 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002135
2136 If defined, then this indicates the I2C bus number for DDR SPD.
2137 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002139 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002140
2141 If defined, then this indicates the I2C bus number for the RTC.
2142 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2143
Andrew Dyer58c41f92008-12-29 17:36:01 -06002144 CONFIG_SOFT_I2C_READ_REPEATED_START
2145
2146 defining this will force the i2c_read() function in
2147 the soft_i2c driver to perform an I2C repeated start
2148 between writing the address pointer and reading the
2149 data. If this define is omitted the default behaviour
2150 of doing a stop-start sequence will be used. Most I2C
2151 devices can use either method, but some require one or
2152 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002153
wdenkc6097192002-11-03 00:24:07 +00002154- SPI Support: CONFIG_SPI
2155
2156 Enables SPI driver (so far only tested with
2157 SPI EEPROM, also an instance works with Crystal A/D and
2158 D/As on the SACSng board)
2159
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002160 CONFIG_SH_SPI
2161
2162 Enables the driver for SPI controller on SuperH. Currently
2163 only SH7757 is supported.
2164
wdenkc6097192002-11-03 00:24:07 +00002165 CONFIG_SOFT_SPI
2166
wdenk4a5c8a72003-03-06 00:02:04 +00002167 Enables a software (bit-bang) SPI driver rather than
2168 using hardware support. This is a general purpose
2169 driver that only requires three general I/O port pins
2170 (two outputs, one input) to function. If this is
2171 defined, the board configuration must define several
2172 SPI configuration items (port pins to use, etc). For
2173 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002174
Ben Warren7efe9272008-01-16 22:37:35 -05002175 CONFIG_HARD_SPI
2176
2177 Enables a hardware SPI driver for general-purpose reads
2178 and writes. As with CONFIG_SOFT_SPI, the board configuration
2179 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002180 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002181 example, see include/configs/mpc8349emds.h.
2182
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002183 CONFIG_MXC_SPI
2184
2185 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002186 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002187
Heiko Schocherb77c8882014-07-14 10:22:11 +02002188 CONFIG_SYS_SPI_MXC_WAIT
2189 Timeout for waiting until spi transfer completed.
2190 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2191
Matthias Fuchsa4400872007-12-27 17:12:34 +01002192- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002193
Matthias Fuchsa4400872007-12-27 17:12:34 +01002194 Enables FPGA subsystem.
2195
2196 CONFIG_FPGA_<vendor>
2197
2198 Enables support for specific chip vendors.
2199 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002200
Matthias Fuchsa4400872007-12-27 17:12:34 +01002201 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002202
Matthias Fuchsa4400872007-12-27 17:12:34 +01002203 Enables support for FPGA family.
2204 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2205
2206 CONFIG_FPGA_COUNT
2207
2208 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002209
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002210 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002211
wdenk57b2d802003-06-27 21:31:46 +00002212 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002214 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002215
wdenk4a5c8a72003-03-06 00:02:04 +00002216 Enable checks on FPGA configuration interface busy
2217 status by the configuration function. This option
2218 will require a board or device specific function to
2219 be written.
wdenkc6097192002-11-03 00:24:07 +00002220
2221 CONFIG_FPGA_DELAY
2222
2223 If defined, a function that provides delays in the FPGA
2224 configuration driver.
2225
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002226 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002227 Allow Control-C to interrupt FPGA configuration
2228
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002229 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002230
wdenk4a5c8a72003-03-06 00:02:04 +00002231 Check for configuration errors during FPGA bitfile
2232 loading. For example, abort during Virtex II
2233 configuration if the INIT_B line goes low (which
2234 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002236 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002237
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002238 Maximum time to wait for the INIT_B line to de-assert
2239 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002240 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002241 ms.
wdenkc6097192002-11-03 00:24:07 +00002242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002243 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002244
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002245 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002246 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002248 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002249
wdenk4a5c8a72003-03-06 00:02:04 +00002250 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002251 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002252
2253- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002254 CONFIG_BUILD_TARGET
2255
2256 Some SoCs need special image types (e.g. U-Boot binary
2257 with a special header) as build targets. By defining
2258 CONFIG_BUILD_TARGET in the SoC / board header, this
2259 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002260 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002261
wdenkc6097192002-11-03 00:24:07 +00002262 CONFIG_IDENT_STRING
2263
wdenk4a5c8a72003-03-06 00:02:04 +00002264 If defined, this string will be added to the U-Boot
2265 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002266
2267- Vendor Parameter Protection:
2268
wdenk4a5c8a72003-03-06 00:02:04 +00002269 U-Boot considers the values of the environment
2270 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002271 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002272 are set once by the board vendor / manufacturer, and
2273 protects these variables from casual modification by
2274 the user. Once set, these variables are read-only,
2275 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002276 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002277
2278 If CONFIG_ENV_OVERWRITE is #defined in your config
2279 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002280 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002281 these parameters.
2282
Joe Hershberger76f353e2015-05-04 14:55:14 -05002283 Alternatively, if you define _both_ an ethaddr in the
2284 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002285 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002286 which can be changed exactly ONCE by the user. [The
2287 serial# is unaffected by this, i. e. it remains
2288 read-only.]
2289
Joe Hershberger71497d02012-12-11 22:16:31 -06002290 The same can be accomplished in a more flexible way
2291 for any variable by configuring the type of access
2292 to allow for those variables in the ".flags" variable
2293 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2294
wdenkc6097192002-11-03 00:24:07 +00002295- Protected RAM:
2296 CONFIG_PRAM
2297
2298 Define this variable to enable the reservation of
2299 "protected RAM", i. e. RAM which is not overwritten
2300 by U-Boot. Define CONFIG_PRAM to hold the number of
2301 kB you want to reserve for pRAM. You can overwrite
2302 this default value by defining an environment
2303 variable "pram" to the number of kB you want to
2304 reserve. Note that the board info structure will
2305 still show the full amount of RAM. If pRAM is
2306 reserved, a new environment variable "mem" will
2307 automatically be defined to hold the amount of
2308 remaining RAM in a form that can be passed as boot
2309 argument to Linux, for instance like that:
2310
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002311 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002312 saveenv
2313
2314 This way you can tell Linux not to use this memory,
2315 either, which results in a memory region that will
2316 not be affected by reboots.
2317
2318 *WARNING* If your board configuration uses automatic
2319 detection of the RAM size, you must make sure that
2320 this memory test is non-destructive. So far, the
2321 following board configurations are known to be
2322 "pRAM-clean":
2323
Heiko Schocher65d94db2017-06-07 17:33:09 +02002324 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002325 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002326 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002327
Gabe Blacka2f3a932012-12-02 04:55:18 +00002328- Access to physical memory region (> 4GB)
2329 Some basic support is provided for operations on memory not
2330 normally accessible to U-Boot - e.g. some architectures
2331 support access to more than 4GB of memory on 32-bit
2332 machines using physical address extension or similar.
2333 Define CONFIG_PHYSMEM to access this basic support, which
2334 currently only supports clearing the memory.
2335
wdenkc6097192002-11-03 00:24:07 +00002336- Error Recovery:
2337 CONFIG_PANIC_HANG
2338
2339 Define this variable to stop the system in case of a
2340 fatal error, so that you have to reset it manually.
2341 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002342 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002343 automatically as fast as possible, but it may be
2344 useful during development since you can try to debug
2345 the conditions that lead to the situation.
2346
2347 CONFIG_NET_RETRY_COUNT
2348
wdenk4a5c8a72003-03-06 00:02:04 +00002349 This variable defines the number of retries for
2350 network operations like ARP, RARP, TFTP, or BOOTP
2351 before giving up the operation. If not defined, a
2352 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002353
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002354 CONFIG_ARP_TIMEOUT
2355
2356 Timeout waiting for an ARP reply in milliseconds.
2357
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002358 CONFIG_NFS_TIMEOUT
2359
2360 Timeout in milliseconds used in NFS protocol.
2361 If you encounter "ERROR: Cannot umount" in nfs command,
2362 try longer timeout such as
2363 #define CONFIG_NFS_TIMEOUT 10000UL
2364
wdenkc6097192002-11-03 00:24:07 +00002365- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002366 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002367
2368 Enable auto completion of commands using TAB.
2369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002370 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002371
2372 This defines the secondary prompt string, which is
2373 printed when the command interpreter needs more input
2374 to complete a command. Usually "> ".
2375
2376 Note:
2377
wdenk57b2d802003-06-27 21:31:46 +00002378 In the current implementation, the local variables
2379 space and global environment variables space are
2380 separated. Local variables are those you define by
2381 simply typing `name=value'. To access a local
2382 variable later on, you have write `$name' or
2383 `${name}'; to execute the contents of a variable
2384 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002385
wdenk4a5c8a72003-03-06 00:02:04 +00002386 Global environment variables are those you use
2387 setenv/printenv to work with. To run a command stored
2388 in such a variable, you need to use the run command,
2389 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002390
2391 To store commands and special characters in a
2392 variable, please use double quotation marks
2393 surrounding the whole text of the variable, instead
2394 of the backslashes before semicolons and special
2395 symbols.
2396
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002397- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002398 CONFIG_CMDLINE_EDITING
2399
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002400 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002401 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002402
Marek Vasut734fb042016-01-27 04:47:55 +01002403- Command Line PS1/PS2 support:
2404 CONFIG_CMDLINE_PS_SUPPORT
2405
2406 Enable support for changing the command prompt string
2407 at run-time. Only static string is supported so far.
2408 The string is obtained from environment variables PS1
2409 and PS2.
2410
wdenkc0aa5c52003-12-06 19:49:23 +00002411- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002412 CONFIG_EXTRA_ENV_SETTINGS
2413
wdenk4a5c8a72003-03-06 00:02:04 +00002414 Define this to contain any number of null terminated
2415 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002416 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002417
wdenk4a5c8a72003-03-06 00:02:04 +00002418 For example, place something like this in your
2419 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002420
2421 #define CONFIG_EXTRA_ENV_SETTINGS \
2422 "myvar1=value1\0" \
2423 "myvar2=value2\0"
2424
wdenk4a5c8a72003-03-06 00:02:04 +00002425 Warning: This method is based on knowledge about the
2426 internal format how the environment is stored by the
2427 U-Boot code. This is NOT an official, exported
2428 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002429 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002430 You better know what you are doing here.
2431
wdenk4a5c8a72003-03-06 00:02:04 +00002432 Note: overly (ab)use of the default environment is
2433 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002434 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002435 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002436
Stephen Warren1465d5f2012-05-22 09:21:54 +00002437 CONFIG_ENV_VARS_UBOOT_CONFIG
2438
2439 Define this in order to add variables describing the
2440 U-Boot build configuration to the default environment.
2441 These will be named arch, cpu, board, vendor, and soc.
2442
2443 Enabling this option will cause the following to be defined:
2444
2445 - CONFIG_SYS_ARCH
2446 - CONFIG_SYS_CPU
2447 - CONFIG_SYS_BOARD
2448 - CONFIG_SYS_VENDOR
2449 - CONFIG_SYS_SOC
2450
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002451 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2452
2453 Define this in order to add variables describing certain
2454 run-time determined information about the hardware to the
2455 environment. These will be named board_name, board_rev.
2456
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002457 CONFIG_DELAY_ENVIRONMENT
2458
2459 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002460 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002461 that so that the environment is not available until
2462 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2463 this is instead controlled by the value of
2464 /config/load-environment.
2465
wdenkc0aa5c52003-12-06 19:49:23 +00002466- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002467 CONFIG_HAS_DATAFLASH
2468
wdenk57b2d802003-06-27 21:31:46 +00002469 Defining this option enables DataFlash features and
2470 allows to read/write in Dataflash via the standard
2471 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002472
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002473- Serial Flash support
2474 CONFIG_CMD_SF
2475
2476 Defining this option enables SPI flash commands
2477 'sf probe/read/write/erase/update'.
2478
2479 Usage requires an initial 'probe' to define the serial
2480 flash parameters, followed by read/write/erase/update
2481 commands.
2482
2483 The following defaults may be provided by the platform
2484 to handle the common case when only a single serial
2485 flash is present on the system.
2486
2487 CONFIG_SF_DEFAULT_BUS Bus identifier
2488 CONFIG_SF_DEFAULT_CS Chip-select
2489 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2490 CONFIG_SF_DEFAULT_SPEED in Hz
2491
wdenkef893942004-02-23 16:11:30 +00002492 CONFIG_SYSTEMACE
2493
2494 Adding this option adds support for Xilinx SystemACE
2495 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002496 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002497 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002498
2499 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002500 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002501
2502 When SystemACE support is added, the "ace" device type
2503 becomes available to the fat commands, i.e. fatls.
2504
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002505- TFTP Fixed UDP Port:
2506 CONFIG_TFTP_PORT
2507
Wolfgang Denk227b5192005-09-24 23:25:46 +02002508 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002509 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002510 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002511 number generator is used.
2512
Wolfgang Denk227b5192005-09-24 23:25:46 +02002513 Also, the environment variable tftpdstp is used to supply
2514 the TFTP UDP destination port value. If tftpdstp isn't
2515 defined, the normal port 69 is used.
2516
2517 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002518 blindly start the TFTP transfer using the pre-configured
2519 target IP address and UDP port. This has the effect of
2520 "punching through" the (Windows XP) firewall, allowing
2521 the remainder of the TFTP transfer to proceed normally.
2522 A better solution is to properly configure the firewall,
2523 but sometimes that is not allowed.
2524
Heiko Schocher443ca402014-01-25 07:27:13 +01002525- bootcount support:
2526 CONFIG_BOOTCOUNT_LIMIT
2527
2528 This enables the bootcounter support, see:
2529 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2530
2531 CONFIG_AT91SAM9XE
2532 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002533 CONFIG_SOC_DA8XX
2534 enable special bootcounter support on da850 based boards.
2535 CONFIG_BOOTCOUNT_RAM
2536 enable support for the bootcounter in RAM
2537 CONFIG_BOOTCOUNT_I2C
2538 enable support for the bootcounter on an i2c (like RTC) device.
2539 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2540 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2541 the bootcounter.
2542 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002543
wdenkc0aa5c52003-12-06 19:49:23 +00002544- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002545 CONFIG_SHOW_BOOT_PROGRESS
2546
wdenk4a5c8a72003-03-06 00:02:04 +00002547 Defining this option allows to add some board-
2548 specific code (calling a user-provided function
2549 "show_boot_progress(int)") that enables you to show
2550 the system's boot progress on some display (for
2551 example, some LED's) on your board. At the moment,
2552 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002553
Simon Glass0fa36a42012-09-28 08:56:37 +00002554
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002555Legacy uImage format:
2556
wdenkc6097192002-11-03 00:24:07 +00002557 Arg Where When
2558 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002559 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002560 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002561 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002562 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002563 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002564 4 common/cmd_bootm.c Image data has correct checksum
2565 -4 common/cmd_bootm.c Image is for unsupported architecture
2566 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002567 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002568 6 common/cmd_bootm.c Image Type check OK
2569 -6 common/cmd_bootm.c gunzip uncompression error
2570 -7 common/cmd_bootm.c Unimplemented compression type
2571 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002572 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002573 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002574
2575 9 common/image.c Start initial ramdisk verification
2576 -10 common/image.c Ramdisk header has bad magic number
2577 -11 common/image.c Ramdisk header has bad checksum
2578 10 common/image.c Ramdisk header is OK
2579 -12 common/image.c Ramdisk data has bad checksum
2580 11 common/image.c Ramdisk data has correct checksum
2581 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002582 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002583 13 common/image.c Start multifile image verification
2584 14 common/image.c No initial ramdisk, no multifile, continue.
2585
Wolfgang Denk092ae952011-10-26 10:21:21 +00002586 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002587
Stefan Roese88fbf932010-04-15 16:07:28 +02002588 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002589 -31 post/post.c POST test failed, detected by post_output_backlog()
2590 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002591
Heiko Schocher633e03a2007-06-22 19:11:54 +02002592 34 common/cmd_doc.c before loading a Image from a DOC device
2593 -35 common/cmd_doc.c Bad usage of "doc" command
2594 35 common/cmd_doc.c correct usage of "doc" command
2595 -36 common/cmd_doc.c No boot device
2596 36 common/cmd_doc.c correct boot device
2597 -37 common/cmd_doc.c Unknown Chip ID on boot device
2598 37 common/cmd_doc.c correct chip ID found, device available
2599 -38 common/cmd_doc.c Read Error on boot device
2600 38 common/cmd_doc.c reading Image header from DOC device OK
2601 -39 common/cmd_doc.c Image header has bad magic number
2602 39 common/cmd_doc.c Image header has correct magic number
2603 -40 common/cmd_doc.c Error reading Image from DOC device
2604 40 common/cmd_doc.c Image header has correct magic number
2605 41 common/cmd_ide.c before loading a Image from a IDE device
2606 -42 common/cmd_ide.c Bad usage of "ide" command
2607 42 common/cmd_ide.c correct usage of "ide" command
2608 -43 common/cmd_ide.c No boot device
2609 43 common/cmd_ide.c boot device found
2610 -44 common/cmd_ide.c Device not available
2611 44 common/cmd_ide.c Device available
2612 -45 common/cmd_ide.c wrong partition selected
2613 45 common/cmd_ide.c partition selected
2614 -46 common/cmd_ide.c Unknown partition table
2615 46 common/cmd_ide.c valid partition table found
2616 -47 common/cmd_ide.c Invalid partition type
2617 47 common/cmd_ide.c correct partition type
2618 -48 common/cmd_ide.c Error reading Image Header on boot device
2619 48 common/cmd_ide.c reading Image Header from IDE device OK
2620 -49 common/cmd_ide.c Image header has bad magic number
2621 49 common/cmd_ide.c Image header has correct magic number
2622 -50 common/cmd_ide.c Image header has bad checksum
2623 50 common/cmd_ide.c Image header has correct checksum
2624 -51 common/cmd_ide.c Error reading Image from IDE device
2625 51 common/cmd_ide.c reading Image from IDE device OK
2626 52 common/cmd_nand.c before loading a Image from a NAND device
2627 -53 common/cmd_nand.c Bad usage of "nand" command
2628 53 common/cmd_nand.c correct usage of "nand" command
2629 -54 common/cmd_nand.c No boot device
2630 54 common/cmd_nand.c boot device found
2631 -55 common/cmd_nand.c Unknown Chip ID on boot device
2632 55 common/cmd_nand.c correct chip ID found, device available
2633 -56 common/cmd_nand.c Error reading Image Header on boot device
2634 56 common/cmd_nand.c reading Image Header from NAND device OK
2635 -57 common/cmd_nand.c Image header has bad magic number
2636 57 common/cmd_nand.c Image header has correct magic number
2637 -58 common/cmd_nand.c Error reading Image from NAND device
2638 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002639
Heiko Schocher633e03a2007-06-22 19:11:54 +02002640 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002641
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002642 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002643 -64 net/eth.c no Ethernet found.
2644 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002645
Heiko Schocher633e03a2007-06-22 19:11:54 +02002646 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002647 80 common/cmd_net.c before calling net_loop()
2648 -81 common/cmd_net.c some error in net_loop() occurred
2649 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002650 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2651 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002652 83 common/cmd_net.c running "source" command
2653 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002654 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002655
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002656FIT uImage format:
2657
2658 Arg Where When
2659 100 common/cmd_bootm.c Kernel FIT Image has correct format
2660 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2661 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2662 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2663 102 common/cmd_bootm.c Kernel unit name specified
2664 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002665 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002666 104 common/cmd_bootm.c Got kernel subimage node offset
2667 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2668 105 common/cmd_bootm.c Kernel subimage hash verification OK
2669 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2670 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002671 -106 common/cmd_bootm.c Kernel subimage has wrong type
2672 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002673 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2674 108 common/cmd_bootm.c Got kernel subimage data/size
2675 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2676 -109 common/cmd_bootm.c Can't get kernel subimage type
2677 -110 common/cmd_bootm.c Can't get kernel subimage comp
2678 -111 common/cmd_bootm.c Can't get kernel subimage os
2679 -112 common/cmd_bootm.c Can't get kernel subimage load address
2680 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2681
2682 120 common/image.c Start initial ramdisk verification
2683 -120 common/image.c Ramdisk FIT image has incorrect format
2684 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002685 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002686 -122 common/image.c Can't get configuration for ramdisk subimage
2687 123 common/image.c Ramdisk unit name specified
2688 -124 common/image.c Can't get ramdisk subimage node offset
2689 125 common/image.c Got ramdisk subimage node offset
2690 -125 common/image.c Ramdisk subimage hash verification failed
2691 126 common/image.c Ramdisk subimage hash verification OK
2692 -126 common/image.c Ramdisk subimage for unsupported architecture
2693 127 common/image.c Architecture check OK
2694 -127 common/image.c Can't get ramdisk subimage data/size
2695 128 common/image.c Got ramdisk subimage data/size
2696 129 common/image.c Can't get ramdisk load address
2697 -129 common/image.c Got ramdisk load address
2698
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002699 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002700 131 common/cmd_doc.c FIT image format OK
2701
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002702 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002703 141 common/cmd_ide.c FIT image format OK
2704
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002705 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002706 151 common/cmd_nand.c FIT image format OK
2707
Heiko Schocher515eb122014-05-28 11:33:33 +02002708- legacy image format:
2709 CONFIG_IMAGE_FORMAT_LEGACY
2710 enables the legacy image format support in U-Boot.
2711
2712 Default:
2713 enabled if CONFIG_FIT_SIGNATURE is not defined.
2714
2715 CONFIG_DISABLE_IMAGE_LEGACY
2716 disable the legacy image format
2717
2718 This define is introduced, as the legacy image format is
2719 enabled per default for backward compatibility.
2720
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002721- Standalone program support:
2722 CONFIG_STANDALONE_LOAD_ADDR
2723
Wolfgang Denk23f78482011-10-09 21:06:34 +02002724 This option defines a board specific value for the
2725 address where standalone program gets loaded, thus
2726 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002727 settings.
2728
2729- Frame Buffer Address:
2730 CONFIG_FB_ADDR
2731
2732 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002733 address for frame buffer. This is typically the case
2734 when using a graphics controller has separate video
2735 memory. U-Boot will then place the frame buffer at
2736 the given address instead of dynamically reserving it
2737 in system RAM by calling lcd_setmem(), which grabs
2738 the memory for the frame buffer depending on the
2739 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002740
2741 Please see board_init_f function.
2742
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002743- Automatic software updates via TFTP server
2744 CONFIG_UPDATE_TFTP
2745 CONFIG_UPDATE_TFTP_CNT_MAX
2746 CONFIG_UPDATE_TFTP_MSEC_MAX
2747
2748 These options enable and control the auto-update feature;
2749 for a more detailed description refer to doc/README.update.
2750
2751- MTD Support (mtdparts command, UBI support)
2752 CONFIG_MTD_DEVICE
2753
2754 Adds the MTD device infrastructure from the Linux kernel.
2755 Needed for mtdparts command support.
2756
2757 CONFIG_MTD_PARTITIONS
2758
2759 Adds the MTD partitioning infrastructure from the Linux
2760 kernel. Needed for UBI support.
2761
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002762- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002763 CONFIG_UBI_SILENCE_MSG
2764
2765 Make the verbose messages from UBI stop printing. This leaves
2766 warnings and errors enabled.
2767
Heiko Schocherf5895d12014-06-24 10:10:04 +02002768
2769 CONFIG_MTD_UBI_WL_THRESHOLD
2770 This parameter defines the maximum difference between the highest
2771 erase counter value and the lowest erase counter value of eraseblocks
2772 of UBI devices. When this threshold is exceeded, UBI starts performing
2773 wear leveling by means of moving data from eraseblock with low erase
2774 counter to eraseblocks with high erase counter.
2775
2776 The default value should be OK for SLC NAND flashes, NOR flashes and
2777 other flashes which have eraseblock life-cycle 100000 or more.
2778 However, in case of MLC NAND flashes which typically have eraseblock
2779 life-cycle less than 10000, the threshold should be lessened (e.g.,
2780 to 128 or 256, although it does not have to be power of 2).
2781
2782 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002783
Heiko Schocherf5895d12014-06-24 10:10:04 +02002784 CONFIG_MTD_UBI_BEB_LIMIT
2785 This option specifies the maximum bad physical eraseblocks UBI
2786 expects on the MTD device (per 1024 eraseblocks). If the
2787 underlying flash does not admit of bad eraseblocks (e.g. NOR
2788 flash), this value is ignored.
2789
2790 NAND datasheets often specify the minimum and maximum NVM
2791 (Number of Valid Blocks) for the flashes' endurance lifetime.
2792 The maximum expected bad eraseblocks per 1024 eraseblocks
2793 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2794 which gives 20 for most NANDs (MaxNVB is basically the total
2795 count of eraseblocks on the chip).
2796
2797 To put it differently, if this value is 20, UBI will try to
2798 reserve about 1.9% of physical eraseblocks for bad blocks
2799 handling. And that will be 1.9% of eraseblocks on the entire
2800 NAND chip, not just the MTD partition UBI attaches. This means
2801 that if you have, say, a NAND flash chip admits maximum 40 bad
2802 eraseblocks, and it is split on two MTD partitions of the same
2803 size, UBI will reserve 40 eraseblocks when attaching a
2804 partition.
2805
2806 default: 20
2807
2808 CONFIG_MTD_UBI_FASTMAP
2809 Fastmap is a mechanism which allows attaching an UBI device
2810 in nearly constant time. Instead of scanning the whole MTD device it
2811 only has to locate a checkpoint (called fastmap) on the device.
2812 The on-flash fastmap contains all information needed to attach
2813 the device. Using fastmap makes only sense on large devices where
2814 attaching by scanning takes long. UBI will not automatically install
2815 a fastmap on old images, but you can set the UBI parameter
2816 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2817 that fastmap-enabled images are still usable with UBI implementations
2818 without fastmap support. On typical flash devices the whole fastmap
2819 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2820
2821 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2822 Set this parameter to enable fastmap automatically on images
2823 without a fastmap.
2824 default: 0
2825
Heiko Schocher94b66de2015-10-22 06:19:21 +02002826 CONFIG_MTD_UBI_FM_DEBUG
2827 Enable UBI fastmap debug
2828 default: 0
2829
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002830- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002831 CONFIG_UBIFS_SILENCE_MSG
2832
2833 Make the verbose messages from UBIFS stop printing. This leaves
2834 warnings and errors enabled.
2835
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002836- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002837 CONFIG_SPL
2838 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002839
Tom Rini36853852012-02-14 07:29:40 +00002840 CONFIG_SPL_LDSCRIPT
2841 LDSCRIPT for linking the SPL binary.
2842
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002843 CONFIG_SPL_MAX_FOOTPRINT
2844 Maximum size in memory allocated to the SPL, BSS included.
2845 When defined, the linker checks that the actual memory
2846 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002847 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002848 must not be both defined at the same time.
2849
Tom Rini36853852012-02-14 07:29:40 +00002850 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002851 Maximum size of the SPL image (text, data, rodata, and
2852 linker lists sections), BSS excluded.
2853 When defined, the linker checks that the actual size does
2854 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002855
Wolfgang Denk825223d2011-09-11 21:24:09 +02002856 CONFIG_SPL_TEXT_BASE
2857 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002858
Scott Woodc4f0d002012-09-20 19:05:12 -05002859 CONFIG_SPL_RELOC_TEXT_BASE
2860 Address to relocate to. If unspecified, this is equal to
2861 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2862
Tom Rini36853852012-02-14 07:29:40 +00002863 CONFIG_SPL_BSS_START_ADDR
2864 Link address for the BSS within the SPL binary.
2865
2866 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002867 Maximum size in memory allocated to the SPL BSS.
2868 When defined, the linker checks that the actual memory used
2869 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002870 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002871 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002872
2873 CONFIG_SPL_STACK
2874 Adress of the start of the stack SPL will use
2875
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002876 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2877 When defined, SPL will panic() if the image it has
2878 loaded does not have a signature.
2879 Defining this is useful when code which loads images
2880 in SPL cannot guarantee that absolutely all read errors
2881 will be caught.
2882 An example is the LPC32XX MLC NAND driver, which will
2883 consider that a completely unreadable NAND block is bad,
2884 and thus should be skipped silently.
2885
Scott Woodc4f0d002012-09-20 19:05:12 -05002886 CONFIG_SPL_RELOC_STACK
2887 Adress of the start of the stack SPL will use after
2888 relocation. If unspecified, this is equal to
2889 CONFIG_SPL_STACK.
2890
Tom Rini36853852012-02-14 07:29:40 +00002891 CONFIG_SYS_SPL_MALLOC_START
2892 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002893 When this option is set the full malloc is used in SPL and
2894 it is set up by spl_init() and before that, the simple malloc()
2895 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002896
2897 CONFIG_SYS_SPL_MALLOC_SIZE
2898 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002899
Tom Rini28591df2012-08-13 12:03:19 -07002900 CONFIG_SPL_FRAMEWORK
2901 Enable the SPL framework under common/. This framework
2902 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2903 NAND loading of the Linux Kernel.
2904
Tom Rinic2b76002014-03-28 12:03:39 -04002905 CONFIG_SPL_OS_BOOT
2906 Enable booting directly to an OS from SPL.
2907 See also: doc/README.falcon
2908
Tom Rinife3b0c72012-08-13 11:37:56 -07002909 CONFIG_SPL_DISPLAY_PRINT
2910 For ARM, enable an optional function to print more information
2911 about the running system.
2912
Scott Wood7c810902012-09-20 16:35:21 -05002913 CONFIG_SPL_INIT_MINIMAL
2914 Arch init code should be built for a very small image
2915
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002916 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2917 Partition on the MMC to load U-Boot from when the MMC is being
2918 used in raw mode
2919
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002920 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2921 Sector to load kernel uImage from when MMC is being
2922 used in raw mode (for Falcon mode)
2923
2924 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2925 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2926 Sector and number of sectors to load kernel argument
2927 parameters from when MMC is being used in raw mode
2928 (for falcon mode)
2929
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002930 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2931 Partition on the MMC to load U-Boot from when the MMC is being
2932 used in fs mode
2933
Guillaume GARDET5065b712014-10-15 17:53:13 +02002934 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2935 Filename to read to load U-Boot when reading from filesystem
2936
2937 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002938 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002939 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002940
Guillaume GARDET5065b712014-10-15 17:53:13 +02002941 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002942 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002943 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002944
Scott Wood2b36fbb2012-12-06 13:33:17 +00002945 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2946 Set this for NAND SPL on PPC mpc83xx targets, so that
2947 start.S waits for the rest of the SPL to load before
2948 continuing (the hardware starts execution after just
2949 loading the first page rather than the full 4K).
2950
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302951 CONFIG_SPL_SKIP_RELOCATE
2952 Avoid SPL relocation
2953
Scott Woodc352a0c2012-09-20 19:09:07 -05002954 CONFIG_SPL_NAND_BASE
2955 Include nand_base.c in the SPL. Requires
2956 CONFIG_SPL_NAND_DRIVERS.
2957
2958 CONFIG_SPL_NAND_DRIVERS
2959 SPL uses normal NAND drivers, not minimal drivers.
2960
2961 CONFIG_SPL_NAND_ECC
2962 Include standard software ECC in the SPL
2963
Tom Rini36853852012-02-14 07:29:40 +00002964 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002965 Support for NAND boot using simple NAND drivers that
2966 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002967
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002968 CONFIG_SPL_UBI
2969 Support for a lightweight UBI (fastmap) scanner and
2970 loader
2971
Heiko Schochercf000272014-10-31 08:31:00 +01002972 CONFIG_SPL_NAND_RAW_ONLY
2973 Support to boot only raw u-boot.bin images. Use this only
2974 if you need to save space.
2975
Ying Zhangdfb2b152013-08-16 15:16:12 +08002976 CONFIG_SPL_COMMON_INIT_DDR
2977 Set for common ddr init with serial presence detect in
2978 SPL binary.
2979
Tom Rini36853852012-02-14 07:29:40 +00002980 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2981 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2982 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2983 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2984 CONFIG_SYS_NAND_ECCBYTES
2985 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002986 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002987
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302988 CONFIG_SPL_NAND_BOOT
2989 Add support NAND boot
2990
Tom Rini36853852012-02-14 07:29:40 +00002991 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002992 Location in NAND to read U-Boot from
2993
2994 CONFIG_SYS_NAND_U_BOOT_DST
2995 Location in memory to load U-Boot to
2996
2997 CONFIG_SYS_NAND_U_BOOT_SIZE
2998 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002999
3000 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003001 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003002
3003 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3004 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003005 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003006
3007 CONFIG_SPL_OMAP3_ID_NAND
3008 Support for an OMAP3-specific set of functions to return the
3009 ID and MFR of the first attached NAND chip, if present.
3010
Pavel Machekde997252012-08-30 22:42:11 +02003011 CONFIG_SPL_RAM_DEVICE
3012 Support for running image already present in ram, in SPL binary
3013
Scott Woodeb7bd972012-12-06 13:33:16 +00003014 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003015 Image offset to which the SPL should be padded before appending
3016 the SPL payload. By default, this is defined as
3017 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3018 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3019 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003020
Scott Woodf147eb72012-09-21 16:27:32 -05003021 CONFIG_SPL_TARGET
3022 Final target image containing SPL and payload. Some SPLs
3023 use an arch-specific makefile fragment instead, for
3024 example if more than one image needs to be produced.
3025
Simon Glass82d94532013-05-08 08:05:59 +00003026 CONFIG_FIT_SPL_PRINT
3027 Printing information about a FIT image adds quite a bit of
3028 code to SPL. So this is normally disabled in SPL. Use this
3029 option to re-enable it. This will affect the output of the
3030 bootm command when booting a FIT image.
3031
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003032- TPL framework
3033 CONFIG_TPL
3034 Enable building of TPL globally.
3035
3036 CONFIG_TPL_PAD_TO
3037 Image offset to which the TPL should be padded before appending
3038 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003039 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3040 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3041 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003042
wdenkc0aa5c52003-12-06 19:49:23 +00003043- Interrupt support (PPC):
3044
wdenk1ebf41e2004-01-02 14:00:00 +00003045 There are common interrupt_init() and timer_interrupt()
3046 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003047 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003048 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003049 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003050 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003051 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003052 specific handling. If board has watchdog / status_led
3053 / other_activity_monitor it works automatically from
3054 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003055
wdenkc6097192002-11-03 00:24:07 +00003056
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003057Board initialization settings:
3058------------------------------
3059
3060During Initialization u-boot calls a number of board specific functions
3061to allow the preparation of board specific prerequisites, e.g. pin setup
3062before drivers are initialized. To enable these callbacks the
3063following configuration macros have to be defined. Currently this is
3064architecture specific, so please check arch/your_architecture/lib/board.c
3065typically in board_init_f() and board_init_r().
3066
3067- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3068- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3069- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3070- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003071
wdenkc6097192002-11-03 00:24:07 +00003072Configuration Settings:
3073-----------------------
3074
York Sun6c480012014-02-26 17:03:19 -08003075- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3076 Optionally it can be defined to support 64-bit memory commands.
3077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003079 undefine this when you're short of memory.
3080
Peter Tyserdfb72b82009-01-27 18:03:12 -06003081- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3082 width of the commands listed in the 'help' command output.
3083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003084- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003085 prompt for user input.
3086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003087- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003089- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003090
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003091- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003094 the application (usually a Linux kernel) when it is
3095 booted
3096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003097- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003098 List of legal baudrate settings for this board.
3099
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003100- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003101 Begin and End addresses of the area used by the
3102 simple memory test.
3103
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003104- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003105 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003106
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003107- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003108 Scratch address used by the alternate memory test
3109 You only need to set this if address zero isn't writeable
3110
York Sun5d286cd2015-12-04 11:57:07 -08003111- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003112 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003113 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3114 is substracted from total RAM and won't be reported to OS.
3115 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003116 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003117 the RAM base is not zero, or RAM is divided into banks,
3118 this variable needs to be recalcuated to get the address.
3119
York Sun50739372015-12-07 11:05:29 -08003120- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003121 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003122 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003123 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003124 fixing up gd->ram_size the Linux kernel should gets passed
3125 the now "corrected" memory size and won't touch it either.
3126 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003127 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003128 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003129 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003130
3131 This option can be used as a workaround for the 440EPx/GRx
3132 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3133 be touched.
3134
3135 WARNING: Please make sure that this value is a multiple of
3136 the Linux page size (normally 4k). If this is not the case,
3137 then the end address of the Linux memory will be located at a
3138 non page size aligned address and this could cause major
3139 problems.
3140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003141- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003142 Enable temporary baudrate change while serial download
3143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003144- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003145 Physical start address of SDRAM. _Must_ be 0 here.
3146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003147- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003148 Physical start address of Flash memory.
3149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003150- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003151 Physical start address of boot monitor code (set by
3152 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003153 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003154 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003155
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003156- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003157 Size of memory reserved for monitor code, used to
3158 determine _at_compile_time_ (!) if the environment is
3159 embedded within the U-Boot image, or in a separate
3160 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003162- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003163 Size of DRAM reserved for malloc() use.
3164
Simon Glass863e4042014-07-10 22:23:28 -06003165- CONFIG_SYS_MALLOC_F_LEN
3166 Size of the malloc() pool for use before relocation. If
3167 this is defined, then a very simple malloc() implementation
3168 will become available before relocation. The address is just
3169 below the global data, and the stack is moved down to make
3170 space.
3171
3172 This feature allocates regions with increasing addresses
3173 within the region. calloc() is supported, but realloc()
3174 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003175 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003176 U-Boot relocates itself.
3177
Simon Glass9fa901b2014-11-10 17:16:54 -07003178- CONFIG_SYS_MALLOC_SIMPLE
3179 Provides a simple and small malloc() and calloc() for those
3180 boards which do not use the full malloc in SPL (which is
3181 enabled with CONFIG_SYS_SPL_MALLOC_START).
3182
Thierry Redingc97d9742014-12-09 22:25:22 -07003183- CONFIG_SYS_NONCACHED_MEMORY:
3184 Size of non-cached memory area. This area of memory will be
3185 typically located right below the malloc() area and mapped
3186 uncached in the MMU. This is useful for drivers that would
3187 otherwise require a lot of explicit cache maintenance. For
3188 some drivers it's also impossible to properly maintain the
3189 cache. For example if the regions that need to be flushed
3190 are not a multiple of the cache-line size, *and* padding
3191 cannot be allocated between the regions to align them (i.e.
3192 if the HW requires a contiguous array of regions, and the
3193 size of each region is not cache-aligned), then a flush of
3194 one region may result in overwriting data that hardware has
3195 written to another region in the same cache-line. This can
3196 happen for example in network drivers where descriptors for
3197 buffers are typically smaller than the CPU cache-line (e.g.
3198 16 bytes vs. 32 or 64 bytes).
3199
3200 Non-cached memory is only supported on 32-bit ARM at present.
3201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003203 Normally compressed uImages are limited to an
3204 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003205 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003206 to adjust this setting to your needs.
3207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003208- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003209 Maximum size of memory mapped by the startup code of
3210 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003211 the Linux kernel (bd_info, boot arguments, FDT blob if
3212 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003213 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003214 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003215 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003216 variable "bootm_mapsize" will override the value of
3217 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3218 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003219
John Rigbyeea8e692010-10-13 13:57:35 -06003220- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3221 Enable initrd_high functionality. If defined then the
3222 initrd_high feature is enabled and the bootm ramdisk subcommand
3223 is enabled.
3224
3225- CONFIG_SYS_BOOT_GET_CMDLINE:
3226 Enables allocating and saving kernel cmdline in space between
3227 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3228
3229- CONFIG_SYS_BOOT_GET_KBD:
3230 Enables allocating and saving a kernel copy of the bd_info in
3231 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003233- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003234 Max number of Flash memory banks
3235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003236- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003237 Max number of sectors on a Flash chip
3238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003239- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003240 Timeout for Flash erase operations (in ms)
3241
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003242- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003243 Timeout for Flash write operations (in ms)
3244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003245- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003246 Timeout for Flash set sector lock bit operation (in ms)
3247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003248- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003249 Timeout for Flash clear lock bits operation (in ms)
3250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003251- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003252 If defined, hardware flash sectors protection is used
3253 instead of U-Boot software protection.
3254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003255- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003256
3257 Enable TFTP transfers directly to flash memory;
3258 without this option such a download has to be
3259 performed in two steps: (1) download to RAM, and (2)
3260 copy from RAM to flash.
3261
3262 The two-step approach is usually more reliable, since
3263 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003264 the flash, but in some situations (when system RAM is
3265 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003266 downloaded image) this option may be very useful.
3267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003268- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003269 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003270 common flash structure for storing flash geometry.
3271
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003272- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003273 This option also enables the building of the cfi_flash driver
3274 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003275
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003276- CONFIG_FLASH_CFI_MTD
3277 This option enables the building of the cfi_mtd driver
3278 in the drivers directory. The driver exports CFI flash
3279 to the MTD layer.
3280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003281- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003282 Use buffered writes to flash.
3283
3284- CONFIG_FLASH_SPANSION_S29WS_N
3285 s29ws-n MirrorBit flash has non-standard addresses for buffered
3286 write commands.
3287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003288- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003289 If this option is defined, the common CFI flash doesn't
3290 print it's warning upon not recognized FLASH banks. This
3291 is useful, if some of the configured banks are only
3292 optionally available.
3293
Jerry Van Barenaae73572008-03-08 13:48:01 -05003294- CONFIG_FLASH_SHOW_PROGRESS
3295 If defined (must be an integer), print out countdown
3296 digits and dots. Recommended value: 45 (9..1) for 80
3297 column displays, 15 (3..1) for 40 column displays.
3298
Stefan Roesed20cba52013-04-04 15:53:14 +02003299- CONFIG_FLASH_VERIFY
3300 If defined, the content of the flash (destination) is compared
3301 against the source after the write operation. An error message
3302 will be printed when the contents are not identical.
3303 Please note that this option is useless in nearly all cases,
3304 since such flash programming errors usually are detected earlier
3305 while unprotecting/erasing/programming. Please only enable
3306 this option if you really know what you are doing.
3307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003308- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003309 Defines the number of Ethernet receive buffers. On some
3310 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003311 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3312 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003313 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003314 Defaults to 4 if not defined.
3315
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003316- CONFIG_ENV_MAX_ENTRIES
3317
Wolfgang Denk1136f69e2010-10-27 22:48:30 +02003318 Maximum number of entries in the hash table that is used
3319 internally to store the environment settings. The default
3320 setting is supposed to be generous and should work in most
3321 cases. This setting can be used to tune behaviour; see
3322 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003323
Joe Hershberger71497d02012-12-11 22:16:31 -06003324- CONFIG_ENV_FLAGS_LIST_DEFAULT
3325- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003326 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003327 calling env set. Variables can be restricted to only decimal,
3328 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3329 the variables can also be restricted to IP address or MAC address.
3330
3331 The format of the list is:
3332 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003333 access_attribute = [a|r|o|c]
3334 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003335 entry = variable_name[:attributes]
3336 list = entry[,list]
3337
3338 The type attributes are:
3339 s - String (default)
3340 d - Decimal
3341 x - Hexadecimal
3342 b - Boolean ([1yYtT|0nNfF])
3343 i - IP address
3344 m - MAC address
3345
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003346 The access attributes are:
3347 a - Any (default)
3348 r - Read-only
3349 o - Write-once
3350 c - Change-default
3351
Joe Hershberger71497d02012-12-11 22:16:31 -06003352 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3353 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003354 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003355
3356 - CONFIG_ENV_FLAGS_LIST_STATIC
3357 Define this to a list (string) to define validation that
3358 should be done if an entry is not found in the ".flags"
3359 environment variable. To override a setting in the static
3360 list, simply add an entry for the same variable name to the
3361 ".flags" variable.
3362
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003363 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3364 regular expression. This allows multiple variables to define the same
3365 flags without explicitly listing them for each variable.
3366
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003367- CONFIG_ENV_ACCESS_IGNORE_FORCE
3368 If defined, don't allow the -f switch to env set override variable
3369 access flags.
3370
Gabe Black3687fe42014-10-15 04:38:30 -06003371- CONFIG_USE_STDINT
3372 If stdint.h is available with your toolchain you can define this
3373 option to enable it. You can provide option 'USE_STDINT=1' when
3374 building U-Boot to enable this.
3375
wdenkc6097192002-11-03 00:24:07 +00003376The following definitions that deal with the placement and management
3377of environment data (variable area); in general, we support the
3378following configurations:
3379
Mike Frysinger63b8f122011-07-08 10:44:25 +00003380- CONFIG_BUILD_ENVCRC:
3381
3382 Builds up envcrc with the target environment so that external utils
3383 may easily extract it and embed it in final U-Boot images.
3384
wdenkc6097192002-11-03 00:24:07 +00003385BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003386in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003387console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003388U-Boot will hang.
3389
3390Please note that even with NVRAM we still use a copy of the
3391environment in RAM: we could work on NVRAM directly, but we want to
3392keep settings there always unmodified except somebody uses "saveenv"
3393to save the current settings.
3394
Liu Gang85bcd732012-03-08 00:33:20 +00003395BE CAREFUL! For some special cases, the local device can not use
3396"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003397environment stored in a remote NOR flash by SRIO or PCIE link,
3398but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003399
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003400- CONFIG_NAND_ENV_DST
3401
3402 Defines address in RAM to which the nand_spl code should copy the
3403 environment. If redundant environment is used, it will be copied to
3404 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3405
Bruce Adleredecc942007-11-02 13:15:42 -07003406Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003407has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003408created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003409until then to read environment variables.
3410
wdenk8dba0502003-03-31 16:34:49 +00003411The environment is protected by a CRC32 checksum. Before the monitor
3412is relocated into RAM, as a result of a bad CRC you will be working
3413with the compiled-in default environment - *silently*!!! [This is
3414necessary, because the first environment variable we need is the
3415"baudrate" setting for the console - if we have a bad CRC, we don't
3416have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003417
3418Note: once the monitor has been relocated, then it will complain if
3419the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003420use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003422- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003423 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003425 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003426 also needs to be defined.
3427
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003428- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003429 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003430
Ron Madriddfa028a2009-02-18 14:30:44 -08003431- CONFIG_NS16550_MIN_FUNCTIONS:
3432 Define this if you desire to only have use of the NS16550_init
3433 and NS16550_putc functions for the serial driver located at
3434 drivers/serial/ns16550.c. This option is useful for saving
3435 space for already greatly restricted images, including but not
3436 limited to NAND_SPL configurations.
3437
Simon Glass28a9e332012-11-30 13:01:18 +00003438- CONFIG_DISPLAY_BOARDINFO
3439 Display information about the board that U-Boot is running on
3440 when U-Boot starts up. The board function checkboard() is called
3441 to do this.
3442
Simon Glasse8822012012-11-30 13:01:19 +00003443- CONFIG_DISPLAY_BOARDINFO_LATE
3444 Similar to the previous option, but display this information
3445 later, once stdio is running and output goes to the LCD, if
3446 present.
3447
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003448- CONFIG_BOARD_SIZE_LIMIT:
3449 Maximum size of the U-Boot image. When defined, the
3450 build system checks that the actual size does not
3451 exceed it.
3452
wdenkc6097192002-11-03 00:24:07 +00003453Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003454---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003456- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003457 Cache Line Size of the CPU.
3458
Timur Tabid8f341c2011-08-04 18:03:41 -05003459- CONFIG_SYS_CCSRBAR_DEFAULT:
3460 Default (power-on reset) physical address of CCSR on Freescale
3461 PowerPC SOCs.
3462
3463- CONFIG_SYS_CCSRBAR:
3464 Virtual address of CCSR. On a 32-bit build, this is typically
3465 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3466
Timur Tabid8f341c2011-08-04 18:03:41 -05003467- CONFIG_SYS_CCSRBAR_PHYS:
3468 Physical address of CCSR. CCSR can be relocated to a new
3469 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003470 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003471 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3472 is typically relocated on 36-bit builds. It is recommended
3473 that this macro be defined via the _HIGH and _LOW macros:
3474
3475 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3476 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3477
3478- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003479 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3480 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003481 used in assembly code, so it must not contain typecasts or
3482 integer size suffixes (e.g. "ULL").
3483
3484- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3485 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3486 used in assembly code, so it must not contain typecasts or
3487 integer size suffixes (e.g. "ULL").
3488
3489- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3490 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3491 forced to a value that ensures that CCSR is not relocated.
3492
wdenk1272e232002-11-10 22:06:23 +00003493- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003494 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003495
3496 the default drive number (default value 0)
3497
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003498 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003499
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003500 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003501 (default value 1)
3502
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003503 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003504
wdenk4a5c8a72003-03-06 00:02:04 +00003505 defines the offset of register from address. It
3506 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003507 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003508
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003509 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3510 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003511 default value.
wdenk1272e232002-11-10 22:06:23 +00003512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003513 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003514 fdc_hw_init() is called at the beginning of the FDC
3515 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003516 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003517 initializations.
wdenk1272e232002-11-10 22:06:23 +00003518
Macpaul Lind1e49942011-04-11 20:45:32 +00003519- CONFIG_IDE_AHB:
3520 Most IDE controllers were designed to be connected with PCI
3521 interface. Only few of them were designed for AHB interface.
3522 When software is doing ATA command and data transfer to
3523 IDE devices through IDE-AHB controller, some additional
3524 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003525 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003527- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003528 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003529 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003531- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003532
wdenkeb20ad32003-09-05 23:19:14 +00003533 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003534 initial data and stack; please note that this must be
3535 writable memory that is working WITHOUT special
3536 initialization, i. e. you CANNOT use normal RAM which
3537 will become available only after programming the
3538 memory controller and running certain initialization
3539 sequences.
3540
3541 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003542 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003544- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003545
3546 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003547 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3548 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003549 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003550 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003551 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003552 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3553 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003554
3555 Note:
3556 On the MPC824X (or other systems that use the data
3557 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003558 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003559 point to an otherwise UNUSED address space between
3560 the top of RAM and the start of the PCI space.
3561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003562- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003564- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003565 SDRAM timing
3566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003568 periodic timer for refresh
3569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003570- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3571 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3572 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3573 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003574 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3575
3576- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003577 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3578 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003579 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3580
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003581- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003582 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003583 Don't do any setup work, presumably because someone or
3584 something has already done it, and we don't need to do it
3585 a second time. Useful for platforms that are pre-booted
3586 by coreboot or similar.
3587
Gabor Juhosb4458732013-05-30 07:06:12 +00003588- CONFIG_PCI_INDIRECT_BRIDGE:
3589 Enable support for indirect PCI bridges.
3590
Kumar Gala8975d7a2010-12-30 12:09:53 -06003591- CONFIG_SYS_SRIO:
3592 Chip has SRIO or not
3593
3594- CONFIG_SRIO1:
3595 Board has SRIO 1 port available
3596
3597- CONFIG_SRIO2:
3598 Board has SRIO 2 port available
3599
Liu Gang27afb9c2013-05-07 16:30:46 +08003600- CONFIG_SRIO_PCIE_BOOT_MASTER
3601 Board can support master function for Boot from SRIO and PCIE
3602
Kumar Gala8975d7a2010-12-30 12:09:53 -06003603- CONFIG_SYS_SRIOn_MEM_VIRT:
3604 Virtual Address of SRIO port 'n' memory region
3605
3606- CONFIG_SYS_SRIOn_MEM_PHYS:
3607 Physical Address of SRIO port 'n' memory region
3608
3609- CONFIG_SYS_SRIOn_MEM_SIZE:
3610 Size of SRIO port 'n' memory region
3611
Fabio Estevamf17e8782013-04-11 09:35:34 +00003612- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3613 Defined to tell the NAND controller that the NAND chip is using
3614 a 16 bit bus.
3615 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003616 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003617 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003618 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003619
3620- CONFIG_SYS_NDFC_EBC0_CFG
3621 Sets the EBC0_CFG register for the NDFC. If not defined
3622 a default value will be used.
3623
Ben Warren45657152006-09-07 16:50:54 -04003624- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003625 Get DDR timing information from an I2C EEPROM. Common
3626 with pluggable memory modules such as SODIMMs
3627
Ben Warren45657152006-09-07 16:50:54 -04003628 SPD_EEPROM_ADDRESS
3629 I2C address of the SPD EEPROM
3630
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003631- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003632 If SPD EEPROM is on an I2C bus other than the first
3633 one, specify here. Note that the value must resolve
3634 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003635
York Sune73cc042011-06-07 09:42:16 +08003636- CONFIG_SYS_DDR_RAW_TIMING
3637 Get DDR timing information from other than SPD. Common with
3638 soldered DDR chips onboard without SPD. DDR raw timing
3639 parameters are extracted from datasheet and hard-coded into
3640 header files or board specific files.
3641
York Sunbd495cf2011-09-16 13:21:35 -07003642- CONFIG_FSL_DDR_INTERACTIVE
3643 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3644
York Sun8ced0502015-01-06 13:18:55 -08003645- CONFIG_FSL_DDR_SYNC_REFRESH
3646 Enable sync of refresh for multiple controllers.
3647
York Sunb6a35f82015-03-19 09:30:28 -07003648- CONFIG_FSL_DDR_BIST
3649 Enable built-in memory test for Freescale DDR controllers.
3650
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003651- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003652 Only for 83xx systems. If specified, then DDR should
3653 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003654
wdenk6203e402004-04-18 10:13:26 +00003655- CONFIG_RMII
3656 Enable RMII mode for all FECs.
3657 Note that this is a global option, we can't
3658 have one FEC in standard MII mode and another in RMII mode.
3659
wdenk20c98a62004-04-23 20:32:05 +00003660- CONFIG_CRC32_VERIFY
3661 Add a verify option to the crc32 command.
3662 The syntax is:
3663
3664 => crc32 -v <address> <count> <crc32>
3665
3666 Where address/count indicate a memory area
3667 and crc32 is the correct crc32 which the
3668 area should have.
3669
wdenk64519362004-07-11 17:40:54 +00003670- CONFIG_LOOPW
3671 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003672 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003673
stroesecc3af832004-12-16 18:46:55 +00003674- CONFIG_MX_CYCLIC
3675 Add the "mdc" and "mwc" memory commands. These are cyclic
3676 "md/mw" commands.
3677 Examples:
3678
wdenk07d7e6b2004-12-16 21:44:03 +00003679 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003680 This command will print 4 bytes (10,11,12,13) each 500 ms.
3681
wdenk07d7e6b2004-12-16 21:44:03 +00003682 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003683 This command will write 12345678 to address 100 all 10 ms.
3684
wdenk07d7e6b2004-12-16 21:44:03 +00003685 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003686 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003687
wdenk3d3d99f2005-04-04 12:44:11 +00003688- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003689 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003690 low level initializations (like setting up the memory
3691 controller) are omitted and/or U-Boot does not
3692 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003693
Wolfgang Denk302141d2010-11-27 23:30:56 +01003694 Normally this variable MUST NOT be defined. The only
3695 exception is when U-Boot is loaded (to RAM) by some
3696 other boot loader or by a debugger which performs
3697 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003698
Simon Glass90844072016-05-05 07:28:06 -06003699- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3700 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003701 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003702 instruction cache) is still performed.
3703
Aneesh V552a3192011-07-13 05:11:07 +00003704- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003705 Modifies the behaviour of start.S when compiling a loader
3706 that is executed before the actual U-Boot. E.g. when
3707 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003708
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003709- CONFIG_TPL_BUILD
3710 Modifies the behaviour of start.S when compiling a loader
3711 that is executed after the SPL and before the actual U-Boot.
3712 It is loaded by the SPL.
3713
Ying Zhang0d4f5442013-05-20 14:07:23 +08003714- CONFIG_SYS_MPC85XX_NO_RESETVEC
3715 Only for 85xx systems. If this variable is specified, the section
3716 .resetvec is not kept and the section .bootpg is placed in the
3717 previous 4k of the .text section.
3718
Simon Glass17dabf02013-02-24 17:33:14 +00003719- CONFIG_ARCH_MAP_SYSMEM
3720 Generally U-Boot (and in particular the md command) uses
3721 effective address. It is therefore not necessary to regard
3722 U-Boot address as virtual addresses that need to be translated
3723 to physical addresses. However, sandbox requires this, since
3724 it maintains its own little RAM buffer which contains all
3725 addressable memory. This option causes some memory accesses
3726 to be mapped through map_sysmem() / unmap_sysmem().
3727
Simon Glassbfb59802013-02-14 04:18:54 +00003728- CONFIG_X86_RESET_VECTOR
3729 If defined, the x86 reset vector code is included. This is not
3730 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003731
Heiko Schocher2233e462013-11-04 14:05:00 +01003732- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3733 Enables the RTC32K OSC on AM33xx based plattforms
3734
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003735- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3736 Option to disable subpage write in NAND driver
3737 driver that uses this:
3738 drivers/mtd/nand/davinci_nand.c
3739
Timur Tabi275f4bb2011-11-22 09:21:25 -06003740Freescale QE/FMAN Firmware Support:
3741-----------------------------------
3742
3743The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3744loading of "firmware", which is encoded in the QE firmware binary format.
3745This firmware often needs to be loaded during U-Boot booting, so macros
3746are used to identify the storage device (NOR flash, SPI, etc) and the address
3747within that device.
3748
Zhao Qiang83a90842014-03-21 16:21:44 +08003749- CONFIG_SYS_FMAN_FW_ADDR
3750 The address in the storage device where the FMAN microcode is located. The
3751 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3752 is also specified.
3753
3754- CONFIG_SYS_QE_FW_ADDR
3755 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003756 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3757 is also specified.
3758
3759- CONFIG_SYS_QE_FMAN_FW_LENGTH
3760 The maximum possible size of the firmware. The firmware binary format
3761 has a field that specifies the actual size of the firmware, but it
3762 might not be possible to read any part of the firmware unless some
3763 local storage is allocated to hold the entire firmware first.
3764
3765- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3766 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3767 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3768 virtual address in NOR flash.
3769
3770- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3771 Specifies that QE/FMAN firmware is located in NAND flash.
3772 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3773
3774- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3775 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3776 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3777
Liu Gang1e084582012-03-08 00:33:18 +00003778- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3779 Specifies that QE/FMAN firmware is located in the remote (master)
3780 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003781 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3782 window->master inbound window->master LAW->the ucode address in
3783 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003784
J. German Rivera8ff14b72014-06-23 15:15:55 -07003785Freescale Layerscape Management Complex Firmware Support:
3786---------------------------------------------------------
3787The Freescale Layerscape Management Complex (MC) supports the loading of
3788"firmware".
3789This firmware often needs to be loaded during U-Boot booting, so macros
3790are used to identify the storage device (NOR flash, SPI, etc) and the address
3791within that device.
3792
3793- CONFIG_FSL_MC_ENET
3794 Enable the MC driver for Layerscape SoCs.
3795
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303796Freescale Layerscape Debug Server Support:
3797-------------------------------------------
3798The Freescale Layerscape Debug Server Support supports the loading of
3799"Debug Server firmware" and triggering SP boot-rom.
3800This firmware often needs to be loaded during U-Boot booting.
3801
York Sun928b6812015-12-07 11:08:58 -08003802- CONFIG_SYS_MC_RSV_MEM_ALIGN
3803 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303804
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003805Reproducible builds
3806-------------------
3807
3808In order to achieve reproducible builds, timestamps used in the U-Boot build
3809process have to be set to a fixed value.
3810
3811This is done using the SOURCE_DATE_EPOCH environment variable.
3812SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3813option for U-Boot or an environment variable in U-Boot.
3814
3815SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3816
wdenkc6097192002-11-03 00:24:07 +00003817Building the Software:
3818======================
3819
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003820Building U-Boot has been tested in several native build environments
3821and in many different cross environments. Of course we cannot support
3822all possibly existing versions of cross development tools in all
3823(potentially obsolete) versions. In case of tool chain problems we
3824recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3825which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003826
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003827If you are not using a native environment, it is assumed that you
3828have GNU cross compiling tools available in your path. In this case,
3829you must set the environment variable CROSS_COMPILE in your shell.
3830Note that no changes to the Makefile or any other source files are
3831necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003832
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003833 $ CROSS_COMPILE=ppc_4xx-
3834 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003835
Peter Tyserb06976d2009-03-13 18:54:51 -05003836Note: If you wish to generate Windows versions of the utilities in
3837 the tools directory you can use the MinGW toolchain
3838 (http://www.mingw.org). Set your HOST tools to the MinGW
3839 toolchain and execute 'make tools'. For example:
3840
3841 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3842
3843 Binaries such as tools/mkimage.exe will be created which can
3844 be executed on computers running Windows.
3845
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003846U-Boot is intended to be simple to build. After installing the
3847sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003848is done by typing:
3849
Holger Freyther7ba4e572014-08-04 09:26:05 +02003850 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003851
Holger Freyther7ba4e572014-08-04 09:26:05 +02003852where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003853rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003854
wdenk6c59edc2004-05-03 20:45:30 +00003855Note: for some board special configuration names may exist; check if
3856 additional information is available from the board vendor; for
3857 instance, the TQM823L systems are available without (standard)
3858 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003859 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003860
Holger Freyther7ba4e572014-08-04 09:26:05 +02003861 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003862 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003863
Holger Freyther7ba4e572014-08-04 09:26:05 +02003864 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003865 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk6c59edc2004-05-03 20:45:30 +00003867 etc.
wdenkc6097192002-11-03 00:24:07 +00003868
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk6c59edc2004-05-03 20:45:30 +00003870Finally, type "make all", and you should get some working U-Boot
3871images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk6c59edc2004-05-03 20:45:30 +00003873- "u-boot.bin" is a raw binary image
3874- "u-boot" is an image in ELF binary format
3875- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003876
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003877By default the build is performed locally and the objects are saved
3878in the source directory. One of the two methods can be used to change
3879this behavior and build U-Boot to some external directory:
3880
38811. Add O= to the make command line invocations:
3882
3883 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003884 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003885 make O=/tmp/build all
3886
Timo Ketolac8c67602014-11-06 14:39:05 +020038872. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003888
Timo Ketolac8c67602014-11-06 14:39:05 +02003889 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003890 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003891 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003892 make all
3893
Timo Ketolac8c67602014-11-06 14:39:05 +02003894Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003895variable.
3896
wdenkc6097192002-11-03 00:24:07 +00003897
wdenk6c59edc2004-05-03 20:45:30 +00003898Please be aware that the Makefiles assume you are using GNU make, so
3899for instance on NetBSD you might need to use "gmake" instead of
3900native "make".
wdenkc6097192002-11-03 00:24:07 +00003901
wdenkc6097192002-11-03 00:24:07 +00003902
wdenk6c59edc2004-05-03 20:45:30 +00003903If the system board that you have is not listed, then you will need
3904to port U-Boot to your hardware platform. To do this, follow these
3905steps:
wdenkc6097192002-11-03 00:24:07 +00003906
Phil Sutterc77b4882015-12-25 14:41:18 +010039071. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003908 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003909 the "Makefile" and a "<board>.c".
39102. Create a new configuration file "include/configs/<board>.h" for
3911 your board.
wdenk6c59edc2004-05-03 20:45:30 +000039123. If you're porting U-Boot to a new CPU, then also create a new
3913 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020039144. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000039155. Type "make", and you should get a working "u-boot.srec" file
3916 to be installed on your target system.
39176. Debug and solve any problems that might arise.
3918 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003919
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk6c59edc2004-05-03 20:45:30 +00003921Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3922==============================================================
wdenkc6097192002-11-03 00:24:07 +00003923
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003924If you have modified U-Boot sources (for instance added a new board
3925or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003926provide feedback to the other developers. The feedback normally takes
3927the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003928official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003929
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003930But before you submit such a patch, please verify that your modifi-
3931cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003932the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003933just run the buildman script (tools/buildman/buildman), which will
3934configure and build U-Boot for ALL supported system. Be warned, this
3935will take a while. Please see the buildman README, or run 'buildman -H'
3936for documentation.
wdenkc6097192002-11-03 00:24:07 +00003937
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003938
wdenk6c59edc2004-05-03 20:45:30 +00003939See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003940
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942Monitor Commands - Overview:
3943============================
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk6c59edc2004-05-03 20:45:30 +00003945go - start application at address 'addr'
3946run - run commands in an environment variable
3947bootm - boot application image from memory
3948bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003949bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003950tftpboot- boot image via network using TFTP protocol
3951 and env variables "ipaddr" and "serverip"
3952 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003953tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003954rarpboot- boot image via network using RARP/TFTP protocol
3955diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3956loads - load S-Record file over serial line
3957loadb - load binary file over serial line (kermit mode)
3958md - memory display
3959mm - memory modify (auto-incrementing)
3960nm - memory modify (constant address)
3961mw - memory write (fill)
3962cp - memory copy
3963cmp - memory compare
3964crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003965i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003966sspi - SPI utility commands
3967base - print or set address offset
3968printenv- print environment variables
3969setenv - set environment variables
3970saveenv - save environment variables to persistent storage
3971protect - enable or disable FLASH write protection
3972erase - erase FLASH memory
3973flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003974nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003975bdinfo - print Board Info structure
3976iminfo - print header information for application image
3977coninfo - print console devices and informations
3978ide - IDE sub-system
3979loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003980loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003981mtest - simple RAM test
3982icache - enable or disable instruction cache
3983dcache - enable or disable data cache
3984reset - Perform RESET of the CPU
3985echo - echo args to console
3986version - print monitor version
3987help - print online help
3988? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003989
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk6c59edc2004-05-03 20:45:30 +00003991Monitor Commands - Detailed Description:
3992========================================
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk6c59edc2004-05-03 20:45:30 +00003994TODO.
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk6c59edc2004-05-03 20:45:30 +00003996For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003997
3998
wdenk6c59edc2004-05-03 20:45:30 +00003999Environment Variables:
4000======================
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk6c59edc2004-05-03 20:45:30 +00004002U-Boot supports user configuration using Environment Variables which
4003can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk6c59edc2004-05-03 20:45:30 +00004005Environment Variables are set using "setenv", printed using
4006"printenv", and saved to Flash using "saveenv". Using "setenv"
4007without a value can be used to delete a variable from the
4008environment. As long as you don't save the environment you are
4009working with an in-memory copy. In case the Flash area containing the
4010environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004011
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004012Some configuration options can be set using Environment Variables.
4013
4014List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk6c59edc2004-05-03 20:45:30 +00004016 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk6c59edc2004-05-03 20:45:30 +00004018 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk6c59edc2004-05-03 20:45:30 +00004020 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk6c59edc2004-05-03 20:45:30 +00004022 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk6c59edc2004-05-03 20:45:30 +00004024 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004025
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004026 bootm_low - Memory range available for image processing in the bootm
4027 command can be restricted. This variable is given as
4028 a hexadecimal number and defines lowest address allowed
4029 for use by the bootm command. See also "bootm_size"
4030 environment variable. Address defined by "bootm_low" is
4031 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004032 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4033 bootm_mapsize.
4034
Wolfgang Denk092ae952011-10-26 10:21:21 +00004035 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004036 This variable is given as a hexadecimal number and it
4037 defines the size of the memory region starting at base
4038 address bootm_low that is accessible by the Linux kernel
4039 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4040 as the default value if it is defined, and bootm_size is
4041 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004042
4043 bootm_size - Memory range available for image processing in the bootm
4044 command can be restricted. This variable is given as
4045 a hexadecimal number and defines the size of the region
4046 allowed for use by the bootm command. See also "bootm_low"
4047 environment variable.
4048
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004049 updatefile - Location of the software update file on a TFTP server, used
4050 by the automatic software update feature. Please refer to
4051 documentation in doc/README.update for more details.
4052
wdenk6c59edc2004-05-03 20:45:30 +00004053 autoload - if set to "no" (any string beginning with 'n'),
4054 "bootp" will just load perform a lookup of the
4055 configuration from the BOOTP server, but not try to
4056 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk6c59edc2004-05-03 20:45:30 +00004058 autostart - if set to "yes", an image loaded using the "bootp",
4059 "rarpboot", "tftpboot" or "diskboot" commands will
4060 be automatically started (by internally calling
4061 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004062
wdenk6c59edc2004-05-03 20:45:30 +00004063 If set to "no", a standalone image passed to the
4064 "bootm" command will be copied to the load address
4065 (and eventually uncompressed), but NOT be started.
4066 This can be used to load and uncompress arbitrary
4067 data.
wdenkc6097192002-11-03 00:24:07 +00004068
David A. Longd558a4e2011-07-09 16:40:19 -04004069 fdt_high - if set this restricts the maximum address that the
4070 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004071 For example, if you have a system with 1 GB memory
4072 at physical address 0x10000000, while Linux kernel
4073 only recognizes the first 704 MB as low memory, you
4074 may need to set fdt_high as 0x3C000000 to have the
4075 device tree blob be copied to the maximum address
4076 of the 704 MB low memory, so that Linux kernel can
4077 access it during the boot procedure.
4078
David A. Longd558a4e2011-07-09 16:40:19 -04004079 If this is set to the special value 0xFFFFFFFF then
4080 the fdt will not be copied at all on boot. For this
4081 to work it must reside in writable memory, have
4082 sufficient padding on the end of it for u-boot to
4083 add the information it needs into it, and the memory
4084 must be accessible by the kernel.
4085
Simon Glassdc6fa642011-10-24 19:15:34 +00004086 fdtcontroladdr- if set this is the address of the control flattened
4087 device tree used by U-Boot when CONFIG_OF_CONTROL is
4088 defined.
4089
wdenk0e2bd9c2004-06-06 21:51:03 +00004090 i2cfast - (PPC405GP|PPC405EP only)
4091 if set to 'y' configures Linux I2C driver for fast
4092 mode (400kHZ). This environment variable is used in
4093 initialization code. So, for changes to be effective
4094 it must be saved and board must be reset.
4095
wdenk6c59edc2004-05-03 20:45:30 +00004096 initrd_high - restrict positioning of initrd images:
4097 If this variable is not set, initrd images will be
4098 copied to the highest possible address in RAM; this
4099 is usually what you want since it allows for
4100 maximum initrd size. If for some reason you want to
4101 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004102 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004103 variable to a value of "no" or "off" or "0".
4104 Alternatively, you can set it to a maximum upper
4105 address to use (U-Boot will still check that it
4106 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk6c59edc2004-05-03 20:45:30 +00004108 For instance, when you have a system with 16 MB
4109 RAM, and want to reserve 4 MB from use by Linux,
4110 you can do this by adding "mem=12M" to the value of
4111 the "bootargs" variable. However, now you must make
4112 sure that the initrd image is placed in the first
4113 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004114
wdenk6c59edc2004-05-03 20:45:30 +00004115 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk6c59edc2004-05-03 20:45:30 +00004117 If you set initrd_high to 0xFFFFFFFF, this is an
4118 indication to U-Boot that all addresses are legal
4119 for the Linux kernel, including addresses in flash
4120 memory. In this case U-Boot will NOT COPY the
4121 ramdisk at all. This may be useful to reduce the
4122 boot time on your system, but requires that this
4123 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004124
wdenk6c59edc2004-05-03 20:45:30 +00004125 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk6c59edc2004-05-03 20:45:30 +00004127 loadaddr - Default load address for commands like "bootp",
4128 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk6c59edc2004-05-03 20:45:30 +00004130 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004131
wdenk6c59edc2004-05-03 20:45:30 +00004132 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004133
wdenk6c59edc2004-05-03 20:45:30 +00004134 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004135
wdenk6c59edc2004-05-03 20:45:30 +00004136 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004139
Mike Frysingera23230c2011-10-02 10:01:27 +00004140 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004141
Mike Frysingera23230c2011-10-02 10:01:27 +00004142 ethact - controls which interface is currently active.
4143 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004144
Heiko Schocherc5e84052010-07-20 17:45:02 +02004145 => setenv ethact FEC
4146 => ping 192.168.0.1 # traffic sent on FEC
4147 => setenv ethact SCC
4148 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004149
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004150 ethrotate - When set to "no" U-Boot does not go through all
4151 available network interfaces.
4152 It just stays at the currently selected interface.
4153
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004154 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004155 either succeed or fail without retrying.
4156 When set to "once" the network operation will
4157 fail when all the available network interfaces
4158 are tried once without success.
4159 Useful on scripts which control the retry operation
4160 themselves.
wdenkc6097192002-11-03 00:24:07 +00004161
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004162 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004163
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004164 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004165 changing the console to be empty. If "yes" it will be
4166 made silent. If "no" it will not be made silent. If
4167 unset, then it will be made silent if the U-Boot console
4168 is silent.
4169
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004170 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004171 UDP source port.
4172
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004173 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004174 destination port instead of the Well Know Port 69.
4175
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004176 tftpblocksize - Block size to use for TFTP transfers; if not set,
4177 we use the TFTP server's default block size
4178
4179 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4180 seconds, minimum value is 1000 = 1 second). Defines
4181 when a packet is considered to be lost so it has to
4182 be retransmitted. The default is 5000 = 5 seconds.
4183 Lowering this value may make downloads succeed
4184 faster in networks with high packet loss rates or
4185 with unreliable TFTP servers.
4186
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004187 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4188 unit, minimum value = 0). Defines how many timeouts
4189 can happen during a single file transfer before that
4190 transfer is aborted. The default is 10, and 0 means
4191 'no timeouts allowed'. Increasing this value may help
4192 downloads succeed with high packet loss rates, or with
4193 unreliable TFTP servers or client hardware.
4194
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004195 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004196 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004197 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004198
Alexandre Messier15971322016-02-01 17:08:57 -05004199 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4200 Unsigned value, in milliseconds. If not set, the period will
4201 be either the default (28000), or a value based on
4202 CONFIG_NET_RETRY_COUNT, if defined. This value has
4203 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4204
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004205The following image location variables contain the location of images
4206used in booting. The "Image" column gives the role of the image and is
4207not an environment variable name. The other columns are environment
4208variable names. "File Name" gives the name of the file on a TFTP
4209server, "RAM Address" gives the location in RAM the image will be
4210loaded to, and "Flash Location" gives the image's address in NOR
4211flash or offset in NAND flash.
4212
4213*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004214boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004215boards use these variables for other purposes.
4216
Wolfgang Denk092ae952011-10-26 10:21:21 +00004217Image File Name RAM Address Flash Location
4218----- --------- ----------- --------------
4219u-boot u-boot u-boot_addr_r u-boot_addr
4220Linux kernel bootfile kernel_addr_r kernel_addr
4221device tree blob fdtfile fdt_addr_r fdt_addr
4222ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004223
wdenk6c59edc2004-05-03 20:45:30 +00004224The following environment variables may be used and automatically
4225updated by the network boot commands ("bootp" and "rarpboot"),
4226depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004227
wdenk6c59edc2004-05-03 20:45:30 +00004228 bootfile - see above
4229 dnsip - IP address of your Domain Name Server
4230 dnsip2 - IP address of your secondary Domain Name Server
4231 gatewayip - IP address of the Gateway (Router) to use
4232 hostname - Target hostname
4233 ipaddr - see above
4234 netmask - Subnet Mask
4235 rootpath - Pathname of the root filesystem on the NFS server
4236 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004237
wdenk145d2c12004-04-15 21:48:45 +00004238
wdenk6c59edc2004-05-03 20:45:30 +00004239There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk6c59edc2004-05-03 20:45:30 +00004241 serial# - contains hardware identification information such
4242 as type string and/or serial number
4243 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk6c59edc2004-05-03 20:45:30 +00004245These variables can be set only once (usually during manufacturing of
4246the board). U-Boot refuses to delete or overwrite these variables
4247once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004248
4249
wdenk6c59edc2004-05-03 20:45:30 +00004250Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk6c59edc2004-05-03 20:45:30 +00004252 ver - Contains the U-Boot version string as printed
4253 with the "version" command. This variable is
4254 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004255
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257Please note that changes to some configuration parameters may take
4258only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004259
stroeseb9c17c52003-04-04 15:53:41 +00004260
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004261Callback functions for environment variables:
4262---------------------------------------------
4263
4264For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004265when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004266be associated with arbitrary variables. On creation, overwrite, or
4267deletion, the callback will provide the opportunity for some side
4268effect to happen or for the change to be rejected.
4269
4270The callbacks are named and associated with a function using the
4271U_BOOT_ENV_CALLBACK macro in your board or driver code.
4272
4273These callbacks are associated with variables in one of two ways. The
4274static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4275in the board configuration to a string that defines a list of
4276associations. The list must be in the following format:
4277
4278 entry = variable_name[:callback_name]
4279 list = entry[,list]
4280
4281If the callback name is not specified, then the callback is deleted.
4282Spaces are also allowed anywhere in the list.
4283
4284Callbacks can also be associated by defining the ".callbacks" variable
4285with the same list format above. Any association in ".callbacks" will
4286override any association in the static list. You can define
4287CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004288".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004289
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004290If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4291regular expression. This allows multiple variables to be connected to
4292the same callback without explicitly listing them all out.
4293
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004294
wdenk6c59edc2004-05-03 20:45:30 +00004295Command Line Parsing:
4296=====================
stroeseb9c17c52003-04-04 15:53:41 +00004297
wdenk6c59edc2004-05-03 20:45:30 +00004298There are two different command line parsers available with U-Boot:
4299the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk6c59edc2004-05-03 20:45:30 +00004301Old, simple command line parser:
4302--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk6c59edc2004-05-03 20:45:30 +00004304- supports environment variables (through setenv / saveenv commands)
4305- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004306- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004307- special characters ('$', ';') can be escaped by prefixing with '\',
4308 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004309 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004310- You can also escape text by enclosing in single apostrophes, for example:
4311 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004312
wdenk6c59edc2004-05-03 20:45:30 +00004313Hush shell:
4314-----------
wdenkf4688a22003-05-28 08:06:31 +00004315
wdenk6c59edc2004-05-03 20:45:30 +00004316- similar to Bourne shell, with control structures like
4317 if...then...else...fi, for...do...done; while...do...done,
4318 until...do...done, ...
4319- supports environment ("global") variables (through setenv / saveenv
4320 commands) and local shell variables (through standard shell syntax
4321 "name=value"); only environment variables can be used with "run"
4322 command
wdenkf4688a22003-05-28 08:06:31 +00004323
wdenk6c59edc2004-05-03 20:45:30 +00004324General rules:
4325--------------
wdenkf4688a22003-05-28 08:06:31 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327(1) If a command line (or an environment variable executed by a "run"
4328 command) contains several commands separated by semicolon, and
4329 one of these commands fails, then the remaining commands will be
4330 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004333 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004334 command will cause "run" to terminate, i. e. the remaining
4335 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004336
wdenk6c59edc2004-05-03 20:45:30 +00004337Note for Redundant Ethernet Interfaces:
4338=======================================
wdenkf4688a22003-05-28 08:06:31 +00004339
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004340Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004341such configurations and is capable of automatic selection of a
4342"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004343
wdenk6c59edc2004-05-03 20:45:30 +00004344Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4345MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4346"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004347
wdenk6c59edc2004-05-03 20:45:30 +00004348If the network interface stores some valid MAC address (for instance
4349in SROM), this is used as default address if there is NO correspon-
4350ding setting in the environment; if the corresponding environment
4351variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353o If the SROM has a valid MAC address, and there is no address in the
4354 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk6c59edc2004-05-03 20:45:30 +00004356o If there is no valid address in the SROM, and a definition in the
4357 environment exists, then the value from the environment variable is
4358 used.
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk6c59edc2004-05-03 20:45:30 +00004360o If both the SROM and the environment contain a MAC address, and
4361 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004362
wdenk6c59edc2004-05-03 20:45:30 +00004363o If both the SROM and the environment contain a MAC address, and the
4364 addresses differ, the value from the environment is used and a
4365 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004368 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4369 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004370
Ben Warren6db991a2010-04-26 11:11:46 -07004371If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004372will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004373may be skipped by setting the appropriate 'ethmacskip' environment variable.
4374The naming convention is as follows:
4375"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk6c59edc2004-05-03 20:45:30 +00004377Image Formats:
4378==============
wdenkc6097192002-11-03 00:24:07 +00004379
Marian Balakowicz18710b82008-03-12 12:13:13 +01004380U-Boot is capable of booting (and performing other auxiliary operations on)
4381images in two formats:
4382
4383New uImage format (FIT)
4384-----------------------
4385
4386Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4387to Flattened Device Tree). It allows the use of images with multiple
4388components (several kernels, ramdisks, etc.), with contents protected by
4389SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4390
4391
4392Old uImage format
4393-----------------
4394
4395Old image format is based on binary files which can be basically anything,
4396preceded by a special header; see the definitions in include/image.h for
4397details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4400 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004401 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4402 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4403 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004404* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004405 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004406 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004407* Compression Type (uncompressed, gzip, bzip2)
4408* Load Address
4409* Entry Point
4410* Image Name
4411* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk6c59edc2004-05-03 20:45:30 +00004413The header is marked by a special Magic Number, and both the header
4414and the data portions of the image are secured against corruption by
4415CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004416
wdenkc6097192002-11-03 00:24:07 +00004417
wdenk6c59edc2004-05-03 20:45:30 +00004418Linux Support:
4419==============
wdenkc6097192002-11-03 00:24:07 +00004420
wdenk6c59edc2004-05-03 20:45:30 +00004421Although U-Boot should support any OS or standalone application
4422easily, the main focus has always been on Linux during the design of
4423U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425U-Boot includes many features that so far have been part of some
4426special "boot loader" code within the Linux kernel. Also, any
4427"initrd" images to be used are no longer part of one big Linux image;
4428instead, kernel and "initrd" are separate images. This implementation
4429serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk6c59edc2004-05-03 20:45:30 +00004431- the same features can be used for other OS or standalone
4432 applications (for instance: using compressed images to reduce the
4433 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk6c59edc2004-05-03 20:45:30 +00004435- it becomes much easier to port new Linux kernel versions because
4436 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004437
wdenk6c59edc2004-05-03 20:45:30 +00004438- the same Linux kernel image can now be used with different "initrd"
4439 images; of course this also means that different kernel images can
4440 be run with the same "initrd". This makes testing easier (you don't
4441 have to build a new "zImage.initrd" Linux image when you just
4442 change a file in your "initrd"). Also, a field-upgrade of the
4443 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004444
wdenkc6097192002-11-03 00:24:07 +00004445
wdenk6c59edc2004-05-03 20:45:30 +00004446Linux HOWTO:
4447============
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk6c59edc2004-05-03 20:45:30 +00004449Porting Linux to U-Boot based systems:
4450---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004451
wdenk6c59edc2004-05-03 20:45:30 +00004452U-Boot cannot save you from doing all the necessary modifications to
4453configure the Linux device drivers for use with your target hardware
4454(no, we don't intend to provide a full virtual machine interface to
4455Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004456
Stefan Roese88fbf932010-04-15 16:07:28 +02004457But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459Just make sure your machine specific header file (for instance
4460include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004461Information structure as we define in include/asm-<arch>/u-boot.h,
4462and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004463as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004464
Simon Glassd097e592014-06-11 23:29:46 -06004465Note that U-Boot now has a driver model, a unified model for drivers.
4466If you are adding a new driver, plumb it into driver model. If there
4467is no uclass available, you are encouraged to create one. See
4468doc/driver-model.
4469
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk6c59edc2004-05-03 20:45:30 +00004471Configuring the Linux kernel:
4472-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk6c59edc2004-05-03 20:45:30 +00004474No specific requirements for U-Boot. Make sure you have some root
4475device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004476
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk6c59edc2004-05-03 20:45:30 +00004478Building a Linux Image:
4479-----------------------
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4482not used. If you use recent kernel source, a new build target
4483"uImage" will exist which automatically builds an image usable by
4484U-Boot. Most older kernels also have support for a "pImage" target,
4485which was introduced for our predecessor project PPCBoot and uses a
4486100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk6c59edc2004-05-03 20:45:30 +00004488Example:
wdenkc6097192002-11-03 00:24:07 +00004489
Holger Freyther7ba4e572014-08-04 09:26:05 +02004490 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004491 make oldconfig
4492 make dep
4493 make uImage
wdenkc6097192002-11-03 00:24:07 +00004494
wdenk6c59edc2004-05-03 20:45:30 +00004495The "uImage" build target uses a special tool (in 'tools/mkimage') to
4496encapsulate a compressed Linux kernel image with header information,
4497CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004498
wdenk6c59edc2004-05-03 20:45:30 +00004499* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk6c59edc2004-05-03 20:45:30 +00004501* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk6c59edc2004-05-03 20:45:30 +00004503 ${CROSS_COMPILE}-objcopy -O binary \
4504 -R .note -R .comment \
4505 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004506
wdenk6c59edc2004-05-03 20:45:30 +00004507* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004512
wdenk6c59edc2004-05-03 20:45:30 +00004513 mkimage -A ppc -O linux -T kernel -C gzip \
4514 -a 0 -e 0 -n "Linux Kernel Image" \
4515 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004516
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk6c59edc2004-05-03 20:45:30 +00004518The "mkimage" tool can also be used to create ramdisk images for use
4519with U-Boot, either separated from the Linux kernel image, or
4520combined into one file. "mkimage" encapsulates the images with a 64
4521byte header containing information about target architecture,
4522operating system, image type, compression method, entry points, time
4523stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525"mkimage" can be called in two ways: to verify existing images and
4526print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004527
wdenk6c59edc2004-05-03 20:45:30 +00004528In the first form (with "-l" option) mkimage lists the information
4529contained in the header of an existing U-Boot image; this includes
4530checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532 tools/mkimage -l image
4533 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535The second form (with "-d" option) is used to build a U-Boot image
4536from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004537
wdenk6c59edc2004-05-03 20:45:30 +00004538 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4539 -n name -d data_file image
4540 -A ==> set architecture to 'arch'
4541 -O ==> set operating system to 'os'
4542 -T ==> set image type to 'type'
4543 -C ==> set compression type 'comp'
4544 -a ==> set load address to 'addr' (hex)
4545 -e ==> set entry point to 'ep' (hex)
4546 -n ==> set image name to 'name'
4547 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004548
wdenkcd914452004-05-29 16:53:29 +00004549Right now, all Linux kernels for PowerPC systems use the same load
4550address (0x00000000), but the entry point address depends on the
4551kernel version:
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk6c59edc2004-05-03 20:45:30 +00004553- 2.2.x kernels have the entry point at 0x0000000C,
4554- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004555
wdenk6c59edc2004-05-03 20:45:30 +00004556So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4559 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004560 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004561 > examples/uImage.TQM850L
4562 Image Name: 2.4.4 kernel for TQM850L
4563 Created: Wed Jul 19 02:34:59 2000
4564 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4565 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4566 Load Address: 0x00000000
4567 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk6c59edc2004-05-03 20:45:30 +00004571 -> tools/mkimage -l examples/uImage.TQM850L
4572 Image Name: 2.4.4 kernel for TQM850L
4573 Created: Wed Jul 19 02:34:59 2000
4574 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4575 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4576 Load Address: 0x00000000
4577 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk6c59edc2004-05-03 20:45:30 +00004579NOTE: for embedded systems where boot time is critical you can trade
4580speed for memory and install an UNCOMPRESSED image instead: this
4581needs more space in Flash, but boots much faster since it does not
4582need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004583
Stefan Roese88fbf932010-04-15 16:07:28 +02004584 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004585 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4586 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004587 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004588 > examples/uImage.TQM850L-uncompressed
4589 Image Name: 2.4.4 kernel for TQM850L
4590 Created: Wed Jul 19 02:34:59 2000
4591 Image Type: PowerPC Linux Kernel Image (uncompressed)
4592 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4593 Load Address: 0x00000000
4594 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004595
wdenkc6097192002-11-03 00:24:07 +00004596
wdenk6c59edc2004-05-03 20:45:30 +00004597Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4598when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk6c59edc2004-05-03 20:45:30 +00004600 -> tools/mkimage -n 'Simple Ramdisk Image' \
4601 > -A ppc -O linux -T ramdisk -C gzip \
4602 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4603 Image Name: Simple Ramdisk Image
4604 Created: Wed Jan 12 14:01:50 2000
4605 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4606 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4607 Load Address: 0x00000000
4608 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004609
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004610The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4611option performs the converse operation of the mkimage's second form (the "-d"
4612option). Given an image built by mkimage, the dumpimage extracts a "data file"
4613from the image:
4614
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004615 tools/dumpimage -i image -T type -p position data_file
4616 -i ==> extract from the 'image' a specific 'data_file'
4617 -T ==> set image type to 'type'
4618 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004619
wdenkc6097192002-11-03 00:24:07 +00004620
wdenk6c59edc2004-05-03 20:45:30 +00004621Installing a Linux Image:
4622-------------------------
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk6c59edc2004-05-03 20:45:30 +00004624To downloading a U-Boot image over the serial (console) interface,
4625you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk6c59edc2004-05-03 20:45:30 +00004627 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk6c59edc2004-05-03 20:45:30 +00004629The 'objcopy' does not understand the information in the U-Boot
4630image header, so the resulting S-Record file will be relative to
4631address 0x00000000. To load it to a given address, you need to
4632specify the target address as 'offset' parameter with the 'loads'
4633command.
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635Example: install the image to address 0x40100000 (which on the
4636TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk6c59edc2004-05-03 20:45:30 +00004638 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640 .......... done
4641 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643 => loads 40100000
4644 ## Ready for S-Record download ...
4645 ~>examples/image.srec
4646 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4647 ...
4648 15989 15990 15991 15992
4649 [file transfer complete]
4650 [connected]
4651 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004652
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004655this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004656corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk6c59edc2004-05-03 20:45:30 +00004658 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004659
wdenk6c59edc2004-05-03 20:45:30 +00004660 ## Checking Image at 40100000 ...
4661 Image Name: 2.2.13 for initrd on TQM850L
4662 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4663 Data Size: 335725 Bytes = 327 kB = 0 MB
4664 Load Address: 00000000
4665 Entry Point: 0000000c
4666 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004667
4668
wdenk6c59edc2004-05-03 20:45:30 +00004669Boot Linux:
4670-----------
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672The "bootm" command is used to boot an application that is stored in
4673memory (RAM or Flash). In case of a Linux kernel image, the contents
4674of the "bootargs" environment variable is passed to the kernel as
4675parameters. You can check and modify this variable using the
4676"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004677
wdenkc6097192002-11-03 00:24:07 +00004678
wdenk6c59edc2004-05-03 20:45:30 +00004679 => printenv bootargs
4680 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004681
wdenk6c59edc2004-05-03 20:45:30 +00004682 => 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 +00004683
wdenk6c59edc2004-05-03 20:45:30 +00004684 => printenv bootargs
4685 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 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687 => bootm 40020000
4688 ## Booting Linux kernel at 40020000 ...
4689 Image Name: 2.2.13 for NFS on TQM850L
4690 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4691 Data Size: 381681 Bytes = 372 kB = 0 MB
4692 Load Address: 00000000
4693 Entry Point: 0000000c
4694 Verifying Checksum ... OK
4695 Uncompressing Kernel Image ... OK
4696 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
4697 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4698 time_init: decrementer frequency = 187500000/60
4699 Calibrating delay loop... 49.77 BogoMIPS
4700 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4701 ...
wdenkc6097192002-11-03 00:24:07 +00004702
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004703If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004704the memory addresses of both the kernel and the initrd image (PPBCOOT
4705format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk6c59edc2004-05-03 20:45:30 +00004707 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk6c59edc2004-05-03 20:45:30 +00004709 ## Checking Image at 40100000 ...
4710 Image Name: 2.2.13 for initrd on TQM850L
4711 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4712 Data Size: 335725 Bytes = 327 kB = 0 MB
4713 Load Address: 00000000
4714 Entry Point: 0000000c
4715 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717 ## Checking Image at 40200000 ...
4718 Image Name: Simple Ramdisk Image
4719 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4720 Data Size: 566530 Bytes = 553 kB = 0 MB
4721 Load Address: 00000000
4722 Entry Point: 00000000
4723 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk6c59edc2004-05-03 20:45:30 +00004725 => bootm 40100000 40200000
4726 ## Booting Linux kernel at 40100000 ...
4727 Image Name: 2.2.13 for initrd on TQM850L
4728 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4729 Data Size: 335725 Bytes = 327 kB = 0 MB
4730 Load Address: 00000000
4731 Entry Point: 0000000c
4732 Verifying Checksum ... OK
4733 Uncompressing Kernel Image ... OK
4734 ## Loading RAMDisk Image at 40200000 ...
4735 Image Name: Simple Ramdisk Image
4736 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4737 Data Size: 566530 Bytes = 553 kB = 0 MB
4738 Load Address: 00000000
4739 Entry Point: 00000000
4740 Verifying Checksum ... OK
4741 Loading Ramdisk ... OK
4742 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
4743 Boot arguments: root=/dev/ram
4744 time_init: decrementer frequency = 187500000/60
4745 Calibrating delay loop... 49.77 BogoMIPS
4746 ...
4747 RAMDISK: Compressed image found at block 0
4748 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004749
wdenk6c59edc2004-05-03 20:45:30 +00004750 bash#
wdenkc6097192002-11-03 00:24:07 +00004751
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004752Boot Linux and pass a flat device tree:
4753-----------
4754
4755First, U-Boot must be compiled with the appropriate defines. See the section
4756titled "Linux Kernel Interface" above for a more in depth explanation. The
4757following is an example of how to start a kernel and pass an updated
4758flat device tree:
4759
4760=> print oftaddr
4761oftaddr=0x300000
4762=> print oft
4763oft=oftrees/mpc8540ads.dtb
4764=> tftp $oftaddr $oft
4765Speed: 1000, full duplex
4766Using TSEC0 device
4767TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4768Filename 'oftrees/mpc8540ads.dtb'.
4769Load address: 0x300000
4770Loading: #
4771done
4772Bytes transferred = 4106 (100a hex)
4773=> tftp $loadaddr $bootfile
4774Speed: 1000, full duplex
4775Using TSEC0 device
4776TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4777Filename 'uImage'.
4778Load address: 0x200000
4779Loading:############
4780done
4781Bytes transferred = 1029407 (fb51f hex)
4782=> print loadaddr
4783loadaddr=200000
4784=> print oftaddr
4785oftaddr=0x300000
4786=> bootm $loadaddr - $oftaddr
4787## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004788 Image Name: Linux-2.6.17-dirty
4789 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4790 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004791 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004792 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004793 Verifying Checksum ... OK
4794 Uncompressing Kernel Image ... OK
4795Booting using flat device tree at 0x300000
4796Using MPC85xx ADS machine description
4797Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4798[snip]
4799
4800
wdenk6c59edc2004-05-03 20:45:30 +00004801More About U-Boot Image Types:
4802------------------------------
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk6c59edc2004-05-03 20:45:30 +00004804U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk6c59edc2004-05-03 20:45:30 +00004806 "Standalone Programs" are directly runnable in the environment
4807 provided by U-Boot; it is expected that (if they behave
4808 well) you can continue to work in U-Boot after return from
4809 the Standalone Program.
4810 "OS Kernel Images" are usually images of some Embedded OS which
4811 will take over control completely. Usually these programs
4812 will install their own set of exception handlers, device
4813 drivers, set up the MMU, etc. - this means, that you cannot
4814 expect to re-enter U-Boot except by resetting the CPU.
4815 "RAMDisk Images" are more or less just data blocks, and their
4816 parameters (address, size) are passed to an OS kernel that is
4817 being started.
4818 "Multi-File Images" contain several images, typically an OS
4819 (Linux) kernel image and one or more data images like
4820 RAMDisks. This construct is useful for instance when you want
4821 to boot over the network using BOOTP etc., where the boot
4822 server provides just a single image file, but you want to get
4823 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004824
wdenk6c59edc2004-05-03 20:45:30 +00004825 "Multi-File Images" start with a list of image sizes, each
4826 image size (in bytes) specified by an "uint32_t" in network
4827 byte order. This list is terminated by an "(uint32_t)0".
4828 Immediately after the terminating 0 follow the images, one by
4829 one, all aligned on "uint32_t" boundaries (size rounded up to
4830 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832 "Firmware Images" are binary images containing firmware (like
4833 U-Boot or FPGA images) which usually will be programmed to
4834 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004835
wdenk6c59edc2004-05-03 20:45:30 +00004836 "Script files" are command sequences that will be executed by
4837 U-Boot's command interpreter; this feature is especially
4838 useful when you configure U-Boot to use a real shell (hush)
4839 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004840
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004841Booting the Linux zImage:
4842-------------------------
4843
4844On some platforms, it's possible to boot Linux zImage. This is done
4845using the "bootz" command. The syntax of "bootz" command is the same
4846as the syntax of "bootm" command.
4847
Tom Rini45f46d12013-05-16 11:40:11 -04004848Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004849kernel with raw initrd images. The syntax is slightly different, the
4850address of the initrd must be augmented by it's size, in the following
4851format: "<initrd addres>:<initrd size>".
4852
stroeseb9c17c52003-04-04 15:53:41 +00004853
wdenk6c59edc2004-05-03 20:45:30 +00004854Standalone HOWTO:
4855=================
stroeseb9c17c52003-04-04 15:53:41 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857One of the features of U-Boot is that you can dynamically load and
4858run "standalone" applications, which can use some resources of
4859U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004860
wdenk6c59edc2004-05-03 20:45:30 +00004861Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004862
wdenk6c59edc2004-05-03 20:45:30 +00004863"Hello World" Demo:
4864-------------------
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866'examples/hello_world.c' contains a small "Hello World" Demo
4867application; it is automatically compiled when you build U-Boot.
4868It's configured to run at address 0x00040004, so you can play with it
4869like that:
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk6c59edc2004-05-03 20:45:30 +00004871 => loads
4872 ## Ready for S-Record download ...
4873 ~>examples/hello_world.srec
4874 1 2 3 4 5 6 7 8 9 10 11 ...
4875 [file transfer complete]
4876 [connected]
4877 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879 => go 40004 Hello World! This is a test.
4880 ## Starting application at 0x00040004 ...
4881 Hello World
4882 argc = 7
4883 argv[0] = "40004"
4884 argv[1] = "Hello"
4885 argv[2] = "World!"
4886 argv[3] = "This"
4887 argv[4] = "is"
4888 argv[5] = "a"
4889 argv[6] = "test."
4890 argv[7] = "<NULL>"
4891 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895Another example, which demonstrates how to register a CPM interrupt
4896handler with the U-Boot code, can be found in 'examples/timer.c'.
4897Here, a CPM timer is set up to generate an interrupt every second.
4898The interrupt service routine is trivial, just printing a '.'
4899character, but this is just a demo program. The application can be
4900controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004901
wdenk6c59edc2004-05-03 20:45:30 +00004902 ? - print current values og the CPM Timer registers
4903 b - enable interrupts and start timer
4904 e - stop timer and disable interrupts
4905 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk6c59edc2004-05-03 20:45:30 +00004907 => loads
4908 ## Ready for S-Record download ...
4909 ~>examples/timer.srec
4910 1 2 3 4 5 6 7 8 9 10 11 ...
4911 [file transfer complete]
4912 [connected]
4913 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk6c59edc2004-05-03 20:45:30 +00004915 => go 40004
4916 ## Starting application at 0x00040004 ...
4917 TIMERS=0xfff00980
4918 Using timer 1
4919 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921Hit 'b':
4922 [q, b, e, ?] Set interval 1000000 us
4923 Enabling timer
4924Hit '?':
4925 [q, b, e, ?] ........
4926 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4927Hit '?':
4928 [q, b, e, ?] .
4929 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4930Hit '?':
4931 [q, b, e, ?] .
4932 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4933Hit '?':
4934 [q, b, e, ?] .
4935 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4936Hit 'e':
4937 [q, b, e, ?] ...Stopping timer
4938Hit 'q':
4939 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004940
wdenkc6097192002-11-03 00:24:07 +00004941
wdenk6c59edc2004-05-03 20:45:30 +00004942Minicom warning:
4943================
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945Over time, many people have reported problems when trying to use the
4946"minicom" terminal emulation program for serial download. I (wd)
4947consider minicom to be broken, and recommend not to use it. Under
4948Unix, I recommend to use C-Kermit for general purpose use (and
4949especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004950use "cu" for S-Record download ("loads" command). See
4951http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4952for help with kermit.
4953
wdenkc6097192002-11-03 00:24:07 +00004954
wdenk6c59edc2004-05-03 20:45:30 +00004955Nevertheless, if you absolutely want to use it try adding this
4956configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk6c59edc2004-05-03 20:45:30 +00004958 Name Program Name U/D FullScr IO-Red. Multi
4959 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4960 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004961
wdenk8dba0502003-03-31 16:34:49 +00004962
wdenk6c59edc2004-05-03 20:45:30 +00004963NetBSD Notes:
4964=============
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk6c59edc2004-05-03 20:45:30 +00004966Starting at version 0.9.2, U-Boot supports NetBSD both as host
4967(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969Building requires a cross environment; it is known to work on
4970NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4971need gmake since the Makefiles are not compatible with BSD make).
4972Note that the cross-powerpc package does not install include files;
4973attempting to build U-Boot will fail because <machine/ansi.h> is
4974missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976 # cd /usr/pkg/cross/powerpc-netbsd/include
4977 # mkdir powerpc
4978 # ln -s powerpc machine
4979 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4980 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004981
wdenk6c59edc2004-05-03 20:45:30 +00004982Native builds *don't* work due to incompatibilities between native
4983and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985Booting assumes that (the first part of) the image booted is a
4986stage-2 loader which in turn loads and then invokes the kernel
4987proper. Loader sources will eventually appear in the NetBSD source
4988tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004989meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004990
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992Implementation Internals:
4993=========================
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995The following is not intended to be a complete description of every
4996implementation detail. However, it should help to understand the
4997inner workings of U-Boot and make it easier to port it to custom
4998hardware.
wdenkc6097192002-11-03 00:24:07 +00004999
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001Initial Stack, Global Data:
5002---------------------------
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004The implementation of U-Boot is complicated by the fact that U-Boot
5005starts running out of ROM (flash memory), usually without access to
5006system RAM (because the memory controller is not initialized yet).
5007This means that we don't have writable Data or BSS segments, and BSS
5008is not initialized as zero. To be able to get a C environment working
5009at all, we have to allocate at least a minimal stack. Implementation
5010options for this are defined and restricted by the CPU used: Some CPU
5011models provide on-chip memory (like the IMMR area on MPC8xx and
5012MPC826x processors), on others (parts of) the data cache can be
5013locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005014
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005015 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005016 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5019 From: "Chris Hallinan" <clh@net1plus.com>
5020 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5021 ...
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk6c59edc2004-05-03 20:45:30 +00005023 Correct me if I'm wrong, folks, but the way I understand it
5024 is this: Using DCACHE as initial RAM for Stack, etc, does not
5025 require any physical RAM backing up the cache. The cleverness
5026 is that the cache is being used as a temporary supply of
5027 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005028 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005029 can see how this works by studying the cache architecture and
5030 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk6c59edc2004-05-03 20:45:30 +00005032 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5033 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005034 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005035 option should work for you. Using CS 4 should be fine if your
5036 board designers haven't used it for something that would
5037 cause you grief during the initial boot! It is frequently not
5038 used.
wdenkc6097192002-11-03 00:24:07 +00005039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005040 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005041 with your processor/board/system design. The default value
5042 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005043 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005044 than your SDRAM module. If you have a 64MB SDRAM module, set
5045 it above 400_0000. Just make sure your board has no resources
5046 that are supposed to respond to that address! That code in
5047 start.S has been around a while and should work as is when
5048 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005049
wdenk6c59edc2004-05-03 20:45:30 +00005050 -Chris Hallinan
5051 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053It is essential to remember this, since it has some impact on the C
5054code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056* Initialized global data (data segment) is read-only. Do not attempt
5057 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005058
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005059* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005060 as zero data - BSS segment) at all - this is undefined, initiali-
5061 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005062
wdenk6c59edc2004-05-03 20:45:30 +00005063* Stack space is very limited. Avoid big data buffers or things like
5064 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005067normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005068turned out that the implementation of U-Boot can be greatly
5069simplified by making a global data structure (gd_t) available to all
5070functions. We could pass a pointer to this data as argument to _all_
5071functions, but this would bloat the code. Instead we use a feature of
5072the GCC compiler (Global Register Variables) to share the data: we
5073place a pointer (gd) to the global data into a register which we
5074reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk6c59edc2004-05-03 20:45:30 +00005076When choosing a register for such a purpose we are restricted by the
5077relevant (E)ABI specifications for the current architecture, and by
5078GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk6c59edc2004-05-03 20:45:30 +00005080For PowerPC, the following registers have specific use:
5081 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005082 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005083 R3-R4: parameter passing and return values
5084 R5-R10: parameter passing
5085 R13: small data area pointer
5086 R30: GOT pointer
5087 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005088
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005089 (U-Boot also uses R12 as internal GOT pointer. r12
5090 is a volatile register so r12 needs to be reset when
5091 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005092
Wolfgang Denk69c09642008-02-14 22:43:22 +01005093 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095 Note: on PPC, we could use a static initializer (since the
5096 address of the global data structure is known at compile time),
5097 but it turned out that reserving a register results in somewhat
5098 smaller code - although the code savings are not that big (on
5099 average for all boards 752 bytes for the whole U-Boot image,
5100 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk6c59edc2004-05-03 20:45:30 +00005104 R0: function argument word/integer result
5105 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005106 R9: platform specific
5107 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005108 R11: argument (frame) pointer
5109 R12: temporary workspace
5110 R13: stack pointer
5111 R14: link register
5112 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005113
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005114 ==> U-Boot will use R9 to hold a pointer to the global data
5115
5116 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005117
Thomas Chou8fa38582010-05-21 11:08:03 +08005118On Nios II, the ABI is documented here:
5119 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5120
5121 ==> U-Boot will use gp to hold a pointer to the global data
5122
5123 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5124 to access small data sections, so gp is free.
5125
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005126On NDS32, the following registers are used:
5127
5128 R0-R1: argument/return
5129 R2-R5: argument
5130 R15: temporary register for assembler
5131 R16: trampoline register
5132 R28: frame pointer (FP)
5133 R29: global pointer (GP)
5134 R30: link register (LP)
5135 R31: stack pointer (SP)
5136 PC: program counter (PC)
5137
5138 ==> U-Boot will use R10 to hold a pointer to the global data
5139
Wolfgang Denk6405a152006-03-31 18:32:53 +02005140NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5141or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143Memory Management:
5144------------------
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk6c59edc2004-05-03 20:45:30 +00005146U-Boot runs in system state and uses physical addresses, i.e. the
5147MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk6c59edc2004-05-03 20:45:30 +00005149The available memory is mapped to fixed addresses using the memory
5150controller. In this process, a contiguous block is formed for each
5151memory type (Flash, SDRAM, SRAM), even when it consists of several
5152physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154U-Boot is installed in the first 128 kB of the first Flash bank (on
5155TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5156booting and sizing and initializing DRAM, the code relocates itself
5157to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005158memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005159configuration setting]. Below that, a structure with global Board
5160Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162Additionally, some exception handler code is copied to the low 8 kB
5163of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165So a typical memory configuration with 16 MB of DRAM could look like
5166this:
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168 0x0000 0000 Exception Vector code
5169 :
5170 0x0000 1FFF
5171 0x0000 2000 Free for Application Use
5172 :
5173 :
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175 :
5176 :
5177 0x00FB FF20 Monitor Stack (Growing downward)
5178 0x00FB FFAC Board Info Data and permanent copy of global data
5179 0x00FC 0000 Malloc Arena
5180 :
5181 0x00FD FFFF
5182 0x00FE 0000 RAM Copy of Monitor Code
5183 ... eventually: LCD or video framebuffer
5184 ... eventually: pRAM (Protected RAM - unchanged by reset)
5185 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005186
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188System Initialization:
5189----------------------
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005192(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005193configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005194To be able to re-map memory U-Boot then jumps to its link address.
5195To be able to implement the initialization code in C, a (small!)
5196initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005197which provide such a feature like), or in a locked part of the data
5198cache. After that, U-Boot initializes the CPU core, the caches and
5199the SIU.
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk6c59edc2004-05-03 20:45:30 +00005201Next, all (potentially) available memory banks are mapped using a
5202preliminary mapping. For example, we put them on 512 MB boundaries
5203(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5204on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5205programmed for SDRAM access. Using the temporary configuration, a
5206simple memory test is run that determines the size of the SDRAM
5207banks.
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209When there is more than one SDRAM bank, and the banks are of
5210different size, the largest is mapped first. For equal size, the first
5211bank (CS2#) is mapped first. The first mapping is always for address
52120x00000000, with any additional banks following immediately to create
5213contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215Then, the monitor installs itself at the upper end of the SDRAM area
5216and allocates memory for use by malloc() and for the global Board
5217Info data; also, the exception vector code is copied to the low RAM
5218pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220Only after this relocation will you have a "normal" C environment;
5221until that you are restricted in several ways, mostly because you are
5222running from ROM, and because the code will have to be relocated to a
5223new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005224
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226U-Boot Porting Guide:
5227----------------------
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5230list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005231
wdenkc6097192002-11-03 00:24:07 +00005232
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005233int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005234{
5235 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005236
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005237 signal(SIGALRM, no_more_time);
5238 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005241 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005242 return 0;
5243 }
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005246
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005247 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005248
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005249 if (clueless)
5250 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252 while (learning) {
5253 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005254 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5255 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005256 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005257 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005258 }
wdenkc6097192002-11-03 00:24:07 +00005259
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005260 if (available_money > toLocalCurrency ($2500))
5261 Buy a BDI3000;
5262 else
wdenk6c59edc2004-05-03 20:45:30 +00005263 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005264
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005265 if (a similar board exists) { /* hopefully... */
5266 cp -a board/<similar> board/<myboard>
5267 cp include/configs/<similar>.h include/configs/<myboard>.h
5268 } else {
5269 Create your own board support subdirectory;
5270 Create your own board include/configs/<myboard>.h file;
5271 }
5272 Edit new board/<myboard> files
5273 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005274
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005275 while (!accepted) {
5276 while (!running) {
5277 do {
5278 Add / modify source code;
5279 } until (compiles);
5280 Debug;
5281 if (clueless)
5282 email("Hi, I am having problems...");
5283 }
5284 Send patch file to the U-Boot email list;
5285 if (reasonable critiques)
5286 Incorporate improvements from email list code review;
5287 else
5288 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005289 }
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk6c59edc2004-05-03 20:45:30 +00005291 return 0;
5292}
wdenkc6097192002-11-03 00:24:07 +00005293
wdenk6c59edc2004-05-03 20:45:30 +00005294void no_more_time (int sig)
5295{
5296 hire_a_guru();
5297}
wdenkc6097192002-11-03 00:24:07 +00005298
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk6c59edc2004-05-03 20:45:30 +00005300Coding Standards:
5301-----------------
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005304coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005305"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005306
5307Source files originating from a different project (for example the
5308MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005309reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005310sources.
wdenkc6097192002-11-03 00:24:07 +00005311
Detlev Zundelaa63d482006-09-01 15:39:02 +02005312Please note that U-Boot is implemented in C (and to some small parts in
5313Assembler); no C++ is used, so please do not use C++ style comments (//)
5314in your code.
wdenkad276f22004-01-04 16:28:35 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316Please also stick to the following formatting rules:
5317- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005318- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005319- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005320- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005321- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323Submissions which do not conform to the standards may be returned
5324with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005325
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk6c59edc2004-05-03 20:45:30 +00005327Submitting Patches:
5328-------------------
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330Since the number of patches for U-Boot is growing, we need to
5331establish some rules. Submissions which do not conform to these rules
5332may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005333
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005334Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005335
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005336Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5337see http://lists.denx.de/mailman/listinfo/u-boot
5338
wdenk6c59edc2004-05-03 20:45:30 +00005339When you send a patch, please include the following information with
5340it:
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk6c59edc2004-05-03 20:45:30 +00005342* For bug fixes: a description of the bug and how your patch fixes
5343 this bug. Please try to include a way of demonstrating that the
5344 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346* For new features: a description of the feature and your
5347 implementation.
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005350
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005351* For major contributions, add a MAINTAINERS file with your
5352 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005353
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005354* When you add support for a new board, don't forget to add a
5355 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk6c59edc2004-05-03 20:45:30 +00005357* If your patch adds new configuration options, don't forget to
5358 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005359
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005360* The patch itself. If you are using git (which is *strongly*
5361 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005362 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005363 the U-Boot mailing list, you will avoid most of the common problems
5364 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005365
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005366 If you cannot use git, use "diff -purN OLD NEW". If your version of
5367 diff does not support these options, then get the latest version of
5368 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005369
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005370 The current directory when running this command shall be the parent
5371 directory of the U-Boot source tree (i. e. please make sure that
5372 your patch includes sufficient directory information for the
5373 affected files).
5374
5375 We prefer patches as plain text. MIME attachments are discouraged,
5376 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378* If one logical set of modifications affects or creates several
5379 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381* Changesets that contain different, unrelated modifications shall be
5382 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005383
wdenkc6097192002-11-03 00:24:07 +00005384
wdenk6c59edc2004-05-03 20:45:30 +00005385Notes:
wdenkc6097192002-11-03 00:24:07 +00005386
Simon Glassdc27def2016-07-27 20:33:08 -06005387* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005388 source tree and make sure that no errors or warnings are reported
5389 for any of the boards.
5390
5391* Keep your modifications to the necessary minimum: A patch
5392 containing several unrelated changes or arbitrary reformats will be
5393 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk6c59edc2004-05-03 20:45:30 +00005395* If you modify existing code, make sure that your new code does not
5396 add to the memory footprint of the code ;-) Small is beautiful!
5397 When adding new features, these should compile conditionally only
5398 (using #ifdef), and the resulting code with the new feature
5399 disabled must not need more memory than the old code without your
5400 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005401
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005402* Remember that there is a size limit of 100 kB per message on the
5403 u-boot mailing list. Bigger patches will be moderated. If they are
5404 reasonable and not too big, they will be acknowledged. But patches
5405 bigger than the size limit should be avoided.