blob: 6336c5c4881e3a2bcf558e843a0f011de51d9bc5 [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
Ashish Kumar11234062017-08-11 11:09:14 +0530315- ARM Platform Bus Type(CCI):
316 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
317 provides full cache coherency between two clusters of multi-core
318 CPUs and I/O coherency for devices and I/O masters
319
320 CONFIG_SYS_FSL_HAS_CCI400
321
322 Defined For SoC that has cache coherent interconnect
323 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000324
Ashish Kumar97393d62017-08-18 10:54:36 +0530325 CONFIG_SYS_FSL_HAS_CCN504
326
327 Defined for SoC that has cache coherent interconnect CCN-504
328
wdenkc6097192002-11-03 00:24:07 +0000329The following options need to be configured:
330
Kim Phillips203fee32007-08-10 13:28:25 -0500331- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000332
Kim Phillips203fee32007-08-10 13:28:25 -0500333- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200334
Lei Wen20014762011-02-09 18:06:58 +0530335- Marvell Family Member
336 CONFIG_SYS_MVFS - define it if you want to enable
337 multiple fs option at one time
338 for marvell soc family
339
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600340- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000341 CONFIG_SYS_PPC64
342
343 Specifies that the core is a 64-bit PowerPC implementation (implements
344 the "64" category of the Power ISA). This is necessary for ePAPR
345 compliance, among other possible reasons.
346
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600347 CONFIG_SYS_FSL_TBCLK_DIV
348
349 Defines the core time base clock divider ratio compared to the
350 system clock. On most PQ3 devices this is 8, on newer QorIQ
351 devices it can be 16 or 32. The ratio varies from SoC to Soc.
352
Kumar Gala179b1b22011-05-20 00:39:21 -0500353 CONFIG_SYS_FSL_PCIE_COMPAT
354
355 Defines the string to utilize when trying to match PCIe device
356 tree nodes for the given platform.
357
Scott Wood80806962012-08-14 10:14:53 +0000358 CONFIG_SYS_FSL_ERRATUM_A004510
359
360 Enables a workaround for erratum A004510. If set,
361 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
362 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
363
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
366
367 Defines one or two SoC revisions (low 8 bits of SVR)
368 for which the A004510 workaround should be applied.
369
370 The rest of SVR is either not relevant to the decision
371 of whether the erratum is present (e.g. p2040 versus
372 p2041) or is implied by the build target, which controls
373 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
374
375 See Freescale App Note 4493 for more information about
376 this erratum.
377
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530378 CONFIG_A003399_NOR_WORKAROUND
379 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800380 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530381
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530382 CONFIG_A008044_WORKAROUND
383 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800384 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530385
Scott Wood80806962012-08-14 10:14:53 +0000386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
387
388 This is the value to write into CCSR offset 0x18600
389 according to the A004510 workaround.
390
Priyanka Jainc73b9032013-07-02 09:21:04 +0530391 CONFIG_SYS_FSL_DSP_DDR_ADDR
392 This value denotes start offset of DDR memory which is
393 connected exclusively to the DSP cores.
394
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530395 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
396 This value denotes start offset of M2 memory
397 which is directly connected to the DSP core.
398
Priyanka Jainc73b9032013-07-02 09:21:04 +0530399 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
400 This value denotes start offset of M3 memory which is directly
401 connected to the DSP core.
402
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530403 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
404 This value denotes start offset of DSP CCSR space.
405
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530406 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
407 Single Source Clock is clocking mode present in some of FSL SoC's.
408 In this mode, a single differential clock is used to supply
409 clocks to the sysclock, ddrclock and usbclock.
410
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530411 CONFIG_SYS_CPC_REINIT_F
412 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800413 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530414
Tang Yuantiana7364af2014-04-17 15:33:46 +0800415 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800416 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800417 supported, core will start to execute uboot when wakes up.
418
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000419- Generic CPU options:
420 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
421
422 Defines the endianess of the CPU. Implementation of those
423 values is arch specific.
424
York Sunf0626592013-09-30 09:22:09 -0700425 CONFIG_SYS_FSL_DDR
426 Freescale DDR driver in use. This type of DDR controller is
427 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
428 SoCs.
429
430 CONFIG_SYS_FSL_DDR_ADDR
431 Freescale DDR memory-mapped register base.
432
433 CONFIG_SYS_FSL_DDR_EMU
434 Specify emulator support for DDR. Some DDR features such as
435 deskew training are not available.
436
437 CONFIG_SYS_FSL_DDRC_GEN1
438 Freescale DDR1 controller.
439
440 CONFIG_SYS_FSL_DDRC_GEN2
441 Freescale DDR2 controller.
442
443 CONFIG_SYS_FSL_DDRC_GEN3
444 Freescale DDR3 controller.
445
York Sun2896cb72014-03-27 17:54:47 -0700446 CONFIG_SYS_FSL_DDRC_GEN4
447 Freescale DDR4 controller.
448
York Sun461c9392013-09-30 14:20:51 -0700449 CONFIG_SYS_FSL_DDRC_ARM_GEN3
450 Freescale DDR3 controller for ARM-based SoCs.
451
York Sunf0626592013-09-30 09:22:09 -0700452 CONFIG_SYS_FSL_DDR1
453 Board config to use DDR1. It can be enabled for SoCs with
454 Freescale DDR1 or DDR2 controllers, depending on the board
455 implemetation.
456
457 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400458 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700459 Freescale DDR2 or DDR3 controllers, depending on the board
460 implementation.
461
462 CONFIG_SYS_FSL_DDR3
463 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700464 Freescale DDR3 or DDR3L controllers.
465
466 CONFIG_SYS_FSL_DDR3L
467 Board config to use DDR3L. It can be enabled for SoCs with
468 DDR3L controllers.
469
470 CONFIG_SYS_FSL_DDR4
471 Board config to use DDR4. It can be enabled for SoCs with
472 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700473
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530474 CONFIG_SYS_FSL_IFC_BE
475 Defines the IFC controller register space as Big Endian
476
477 CONFIG_SYS_FSL_IFC_LE
478 Defines the IFC controller register space as Little Endian
479
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530480 CONFIG_SYS_FSL_IFC_CLK_DIV
481 Defines divider of platform clock(clock input to IFC controller).
482
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530483 CONFIG_SYS_FSL_LBC_CLK_DIV
484 Defines divider of platform clock(clock input to eLBC controller).
485
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530486 CONFIG_SYS_FSL_PBL_PBI
487 It enables addition of RCW (Power on reset configuration) in built image.
488 Please refer doc/README.pblimage for more details
489
490 CONFIG_SYS_FSL_PBL_RCW
491 It adds PBI(pre-boot instructions) commands in u-boot build image.
492 PBI commands can be used to configure SoC before it starts the execution.
493 Please refer doc/README.pblimage for more details
494
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530495 CONFIG_SPL_FSL_PBL
496 It adds a target to create boot binary having SPL binary in PBI format
497 concatenated with u-boot binary.
498
York Sun29647ab2014-02-10 13:59:42 -0800499 CONFIG_SYS_FSL_DDR_BE
500 Defines the DDR controller register space as Big Endian
501
502 CONFIG_SYS_FSL_DDR_LE
503 Defines the DDR controller register space as Little Endian
504
York Sun3a0916d2014-02-10 13:59:43 -0800505 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
506 Physical address from the view of DDR controllers. It is the
507 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
508 it could be different for ARM SoCs.
509
York Sunc459ae62014-02-10 13:59:44 -0800510 CONFIG_SYS_FSL_DDR_INTLV_256B
511 DDR controller interleaving on 256-byte. This is a special
512 interleaving mode, handled by Dickens for Freescale layerscape
513 SoCs with ARM core.
514
York Sun79a779b2014-08-01 15:51:00 -0700515 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
516 Number of controllers used as main memory.
517
518 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
519 Number of controllers used for other than main memory.
520
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530521 CONFIG_SYS_FSL_HAS_DP_DDR
522 Defines the SoC has DP-DDR used for DPAA.
523
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530524 CONFIG_SYS_FSL_SEC_BE
525 Defines the SEC controller register space as Big Endian
526
527 CONFIG_SYS_FSL_SEC_LE
528 Defines the SEC controller register space as Little Endian
529
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200530- MIPS CPU options:
531 CONFIG_SYS_INIT_SP_OFFSET
532
533 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
534 pointer. This is needed for the temporary stack before
535 relocation.
536
537 CONFIG_SYS_MIPS_CACHE_MODE
538
539 Cache operation mode for the MIPS CPU.
540 See also arch/mips/include/asm/mipsregs.h.
541 Possible values are:
542 CONF_CM_CACHABLE_NO_WA
543 CONF_CM_CACHABLE_WA
544 CONF_CM_UNCACHED
545 CONF_CM_CACHABLE_NONCOHERENT
546 CONF_CM_CACHABLE_CE
547 CONF_CM_CACHABLE_COW
548 CONF_CM_CACHABLE_CUW
549 CONF_CM_CACHABLE_ACCELERATED
550
551 CONFIG_SYS_XWAY_EBU_BOOTCFG
552
553 Special option for Lantiq XWAY SoCs for booting from NOR flash.
554 See also arch/mips/cpu/mips32/start.S.
555
556 CONFIG_XWAY_SWAP_BYTES
557
558 Enable compilation of tools/xway-swap-bytes needed for Lantiq
559 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
560 be swapped if a flash programmer is used.
561
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000562- ARM options:
563 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
564
565 Select high exception vectors of the ARM core, e.g., do not
566 clear the V bit of the c1 register of CP15.
567
York Sun77a10972015-03-20 19:28:08 -0700568 COUNTER_FREQUENCY
569 Generic timer clock source frequency.
570
571 COUNTER_FREQUENCY_REAL
572 Generic timer clock source frequency if the real clock is
573 different from COUNTER_FREQUENCY, and can only be determined
574 at run time.
575
Stephen Warren8d1fb312015-01-19 16:25:52 -0700576- Tegra SoC options:
577 CONFIG_TEGRA_SUPPORT_NON_SECURE
578
579 Support executing U-Boot in non-secure (NS) mode. Certain
580 impossible actions will be skipped if the CPU is in NS mode,
581 such as ARM architectural timer initialization.
582
wdenk9b7f3842003-10-09 20:09:04 +0000583- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000584 CONFIG_CLOCKS_IN_MHZ
585
586 U-Boot stores all clock information in Hz
587 internally. For binary compatibility with older Linux
588 kernels (which expect the clocks passed in the
589 bd_info data to be in MHz) the environment variable
590 "clocks_in_mhz" can be defined so that U-Boot
591 converts clock data to MHZ before passing it to the
592 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000593 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100594 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000595 default environment.
596
wdenk9b7f3842003-10-09 20:09:04 +0000597 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
598
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800599 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000600 expect it to be in bytes, others in MB.
601 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
602
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400603 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200604
605 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400606 passed using flattened device trees (based on open firmware
607 concepts).
608
609 CONFIG_OF_LIBFDT
610 * New libfdt-based support
611 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500612 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400613
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200614 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600615 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200616
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200617 boards with QUICC Engines require OF_QE to set UCC MAC
618 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500619
Kumar Gala1e26aa52006-01-11 13:54:17 -0600620 CONFIG_OF_BOARD_SETUP
621
622 Board code has addition modification that it wants to make
623 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000624
Simon Glass6c0be912014-10-23 18:58:54 -0600625 CONFIG_OF_SYSTEM_SETUP
626
627 Other code has addition modification that it wants to make
628 to the flat device tree before handing it off to the kernel.
629 This causes ft_system_setup() to be called before booting
630 the kernel.
631
Heiko Schocherffb293a2009-09-23 07:56:08 +0200632 CONFIG_OF_IDE_FIXUP
633
634 U-Boot can detect if an IDE device is present or not.
635 If not, and this new config option is activated, U-Boot
636 removes the ATA node from the DTS before booting Linux,
637 so the Linux IDE driver does not probe the device and
638 crash. This is needed for buggy hardware (uc101) where
639 no pull down resistor is connected to the signal IDE5V_DD7.
640
Igor Grinberg06890672011-07-14 05:45:07 +0000641 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
642
643 This setting is mandatory for all boards that have only one
644 machine type and must be used to specify the machine type
645 number as it appears in the ARM machine registry
646 (see http://www.arm.linux.org.uk/developer/machines/).
647 Only boards that have multiple machine types supported
648 in a single configuration file and the machine type is
649 runtime discoverable, do not have to use this setting.
650
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100651- vxWorks boot parameters:
652
653 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700654 environments variables: bootdev, bootfile, ipaddr, netmask,
655 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100656 It loads the vxWorks image pointed bootfile.
657
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100658 Note: If a "bootargs" environment is defined, it will overwride
659 the defaults discussed just above.
660
Aneesh V960f5c02011-06-16 23:30:47 +0000661- Cache Configuration:
662 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
663 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
664 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
665
Aneesh V686a0752011-06-16 23:30:51 +0000666- Cache Configuration for ARM:
667 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
668 controller
669 CONFIG_SYS_PL310_BASE - Physical base address of PL310
670 controller register space
671
wdenkda04a8b2004-08-02 23:22:59 +0000672- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200673 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000674
675 Define this if you want support for Amba PrimeCell PL010 UARTs.
676
Andreas Engel0813b122008-09-08 14:30:53 +0200677 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000678
679 Define this if you want support for Amba PrimeCell PL011 UARTs.
680
681 CONFIG_PL011_CLOCK
682
683 If you have Amba PrimeCell PL011 UARTs, set this variable to
684 the clock speed of the UARTs.
685
686 CONFIG_PL01x_PORTS
687
688 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
689 define this to a list of base addresses for each (supported)
690 port. See e.g. include/configs/versatile.h
691
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400692 CONFIG_SERIAL_HW_FLOW_CONTROL
693
694 Define this variable to enable hw flow control in serial driver.
695 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000696
wdenkc6097192002-11-03 00:24:07 +0000697- Console Baudrate:
698 CONFIG_BAUDRATE - in bps
699 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200700 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000701
wdenkc6097192002-11-03 00:24:07 +0000702- Autoboot Command:
703 CONFIG_BOOTCOMMAND
704 Only needed when CONFIG_BOOTDELAY is enabled;
705 define a command string that is automatically executed
706 when no character is read on the console interface
707 within "Boot Delay" after reset.
708
wdenkc6097192002-11-03 00:24:07 +0000709 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000710 The value of these goes into the environment as
711 "ramboot" and "nfsboot" respectively, and can be used
712 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200713 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000714
Heiko Schocher040c5c32013-11-04 14:04:59 +0100715- Bootcount:
716 CONFIG_BOOTCOUNT_LIMIT
717 Implements a mechanism for detecting a repeating reboot
718 cycle, see:
719 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
720
721 CONFIG_BOOTCOUNT_ENV
722 If no softreset save registers are found on the hardware
723 "bootcount" is stored in the environment. To prevent a
724 saveenv on all reboots, the environment variable
725 "upgrade_available" is used. If "upgrade_available" is
726 0, "bootcount" is always 0, if "upgrade_available" is
727 1 "bootcount" is incremented in the environment.
728 So the Userspace Applikation must set the "upgrade_available"
729 and "bootcount" variable to 0, if a boot was successfully.
730
wdenkc6097192002-11-03 00:24:07 +0000731- Pre-Boot Commands:
732 CONFIG_PREBOOT
733
734 When this option is #defined, the existence of the
735 environment variable "preboot" will be checked
736 immediately before starting the CONFIG_BOOTDELAY
737 countdown and/or running the auto-boot command resp.
738 entering interactive mode.
739
740 This feature is especially useful when "preboot" is
741 automatically generated or modified. For an example
742 see the LWMON board specific code: here "preboot" is
743 modified when the user holds down a certain
744 combination of keys on the (special) keyboard when
745 booting the systems
746
747- Serial Download Echo Mode:
748 CONFIG_LOADS_ECHO
749 If defined to 1, all characters received during a
750 serial download (using the "loads" command) are
751 echoed back. This might be needed by some terminal
752 emulations (like "cu"), but may as well just take
753 time on others. This setting #define's the initial
754 value of the "loads_echo" environment variable.
755
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500756- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000757 CONFIG_KGDB_BAUDRATE
758 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200759 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000760
Simon Glassaa34ef22016-03-13 19:07:28 -0600761- Removal of commands
762 If no commands are needed to boot, you can disable
763 CONFIG_CMDLINE to remove them. In this case, the command line
764 will not be available, and when U-Boot wants to execute the
765 boot command (on start-up) it will call board_run_command()
766 instead. This can reduce image size significantly for very
767 simple boot procedures.
768
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000769- Regular expression support:
770 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200771 If this variable is defined, U-Boot is linked against
772 the SLRE (Super Light Regular Expression) library,
773 which adds regex support to some commands, as for
774 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000775
Simon Glass3d686442011-10-15 05:48:20 +0000776- Device tree:
777 CONFIG_OF_CONTROL
778 If this variable is defined, U-Boot will use a device tree
779 to configure its devices, instead of relying on statically
780 compiled #defines in the board file. This option is
781 experimental and only available on a few boards. The device
782 tree is available in the global data as gd->fdt_blob.
783
Simon Glass5cb34db2011-10-24 19:15:31 +0000784 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700785 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000786
787 CONFIG_OF_EMBED
788 If this variable is defined, U-Boot will embed a device tree
789 binary in its image. This device tree file should be in the
790 board directory and called <soc>-<board>.dts. The binary file
791 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900792 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000793
Simon Glass5cb34db2011-10-24 19:15:31 +0000794 CONFIG_OF_SEPARATE
795 If this variable is defined, U-Boot will build a device tree
796 binary. It will be called u-boot.dtb. Architecture-specific
797 code will locate it at run-time. Generally this works by:
798
799 cat u-boot.bin u-boot.dtb >image.bin
800
801 and in fact, U-Boot does this for you, creating a file called
802 u-boot-dtb.bin which is useful in the common case. You can
803 still use the individual files if you need something more
804 exotic.
805
Alex Deymo5b661ec2017-04-02 01:25:20 -0700806 CONFIG_OF_BOARD
807 If this variable is defined, U-Boot will use the device tree
808 provided by the board at runtime instead of embedding one with
809 the image. Only boards defining board_fdt_blob_setup() support
810 this option (see include/fdtdec.h file).
811
wdenkc6097192002-11-03 00:24:07 +0000812- Watchdog:
813 CONFIG_WATCHDOG
814 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000815 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200816 specific code for a watchdog. For the 8xx
817 CPUs, the SIU Watchdog feature is enabled in the SYPCR
818 register. When supported for a specific SoC is
819 available, then no further board specific code should
820 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000821
822 CONFIG_HW_WATCHDOG
823 When using a watchdog circuitry external to the used
824 SoC, then define this variable and provide board
825 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000826
Heiko Schocher735326c2015-01-21 08:38:22 +0100827 CONFIG_AT91_HW_WDT_TIMEOUT
828 specify the timeout in seconds. default 2 seconds.
829
stroeseb9c17c52003-04-04 15:53:41 +0000830- U-Boot Version:
831 CONFIG_VERSION_VARIABLE
832 If this variable is defined, an environment variable
833 named "ver" is created by U-Boot showing the U-Boot
834 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200835 Any change to this variable will be reverted at the
836 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000837
wdenkc6097192002-11-03 00:24:07 +0000838- Real-Time Clock:
839
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500840 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000841 has to be selected, too. Define exactly one of the
842 following options:
843
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000845 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000847 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000848 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000849 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200850 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000851 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100852 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000853 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200854 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200855 CONFIG_SYS_RV3029_TCR - enable trickle charger on
856 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000857
wdenkb9bbd242003-06-30 16:24:52 +0000858 Note that if the RTC uses I2C, then the I2C interface
859 must also be configured. See I2C Support, below.
860
Peter Tyser9902e422008-12-17 16:36:21 -0600861- GPIO Support:
862 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600863
Chris Packham9b383202010-12-19 10:12:13 +0000864 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
865 chip-ngpio pairs that tell the PCA953X driver the number of
866 pins supported by a particular chip.
867
Peter Tyser9902e422008-12-17 16:36:21 -0600868 Note that if the GPIO device uses I2C, then the I2C interface
869 must also be configured. See I2C Support, below.
870
Simon Glass4dc47ca2014-06-11 23:29:41 -0600871- I/O tracing:
872 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
873 accesses and can checksum them or write a list of them out
874 to memory. See the 'iotrace' command for details. This is
875 useful for testing device drivers since it can confirm that
876 the driver behaves the same way before and after a code
877 change. Currently this is supported on sandbox and arm. To
878 add support for your architecture, add '#include <iotrace.h>'
879 to the bottom of arch/<arch>/include/asm/io.h and test.
880
881 Example output from the 'iotrace stats' command is below.
882 Note that if the trace buffer is exhausted, the checksum will
883 still continue to operate.
884
885 iotrace is enabled
886 Start: 10000000 (buffer start address)
887 Size: 00010000 (buffer size)
888 Offset: 00000120 (current buffer offset)
889 Output: 10000120 (start + offset)
890 Count: 00000018 (number of trace records)
891 CRC32: 9526fb66 (CRC32 of all trace records)
892
wdenkc6097192002-11-03 00:24:07 +0000893- Timestamp Support:
894
wdenk4a5c8a72003-03-06 00:02:04 +0000895 When CONFIG_TIMESTAMP is selected, the timestamp
896 (date and time) of an image is printed by image
897 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500898 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000899
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000900- Partition Labels (disklabels) Supported:
901 Zero or more of the following:
902 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000903 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
904 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
905 bootloader. Note 2TB partition limit; see
906 disk/part_efi.c
907 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000908
Simon Glassb569a012017-05-17 03:25:30 -0600909 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -0600910 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000911 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000912
913- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000914 CONFIG_IDE_RESET_ROUTINE - this is defined in several
915 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000916
wdenk369d43d2004-03-14 14:09:05 +0000917 CONFIG_IDE_RESET - is this is defined, IDE Reset will
918 be performed by calling the function
919 ide_set_reset(int reset)
920 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000921
922- ATAPI Support:
923 CONFIG_ATAPI
924
925 Set this to enable ATAPI support.
926
wdenkf602aa02004-03-13 23:29:43 +0000927- LBA48 Support
928 CONFIG_LBA48
929
930 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100931 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000932 Whithout these , LBA48 support uses 32bit variables and will 'only'
933 support disks up to 2.1TB.
934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200935 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000936 When enabled, makes the IDE subsystem use 64bit sector addresses.
937 Default is 32bit.
938
wdenkc6097192002-11-03 00:24:07 +0000939- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200940 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
941 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
942 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000943 maximum numbers of LUNs, SCSI ID's and target
944 devices.
wdenkc6097192002-11-03 00:24:07 +0000945
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200946 The environment variable 'scsidevs' is set to the number of
947 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000948
wdenkc6097192002-11-03 00:24:07 +0000949- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000950 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000951 Support for Intel 8254x/8257x gigabit chips.
952
953 CONFIG_E1000_SPI
954 Utility code for direct access to the SPI bus on Intel 8257x.
955 This does not do anything useful unless you set at least one
956 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
957
958 CONFIG_E1000_SPI_GENERIC
959 Allow generic access to the SPI bus on the Intel 8257x, for
960 example with the "sspi" command.
961
wdenkc6097192002-11-03 00:24:07 +0000962 CONFIG_EEPRO100
963 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200964 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000965 write routine for first time initialisation.
966
967 CONFIG_TULIP
968 Support for Digital 2114x chips.
969 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
970 modem chip initialisation (KS8761/QS6611).
971
972 CONFIG_NATSEMI
973 Support for National dp83815 chips.
974
975 CONFIG_NS8382X
976 Support for National dp8382[01] gigabit chips.
977
wdenkaa603362003-05-12 21:50:16 +0000978- NETWORK Support (other):
979
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100980 CONFIG_DRIVER_AT91EMAC
981 Support for AT91RM9200 EMAC.
982
983 CONFIG_RMII
984 Define this to use reduced MII inteface
985
986 CONFIG_DRIVER_AT91EMAC_QUIET
987 If this defined, the driver is quiet.
988 The driver doen't show link status messages.
989
Rob Herringc9830dc2011-12-15 11:15:49 +0000990 CONFIG_CALXEDA_XGMAC
991 Support for the Calxeda XGMAC device
992
Ashok93fb8722012-10-15 06:20:47 +0000993 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000994 Support for SMSC's LAN91C96 chips.
995
wdenkaa603362003-05-12 21:50:16 +0000996 CONFIG_LAN91C96_USE_32_BIT
997 Define this to enable 32 bit addressing
998
Ashok93fb8722012-10-15 06:20:47 +0000999 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001000 Support for SMSC's LAN91C111 chip
1001
1002 CONFIG_SMC91111_BASE
1003 Define this to hold the physical address
1004 of the device (I/O space)
1005
1006 CONFIG_SMC_USE_32_BIT
1007 Define this if data bus is 32 bits
1008
1009 CONFIG_SMC_USE_IOFUNCS
1010 Define this to use i/o functions instead of macros
1011 (some hardware wont work with macros)
1012
Heiko Schocher7d037f72011-11-15 10:00:04 -05001013 CONFIG_DRIVER_TI_EMAC
1014 Support for davinci emac
1015
1016 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1017 Define this if you have more then 3 PHYs.
1018
Macpaul Lin199c6252010-12-21 16:59:46 +08001019 CONFIG_FTGMAC100
1020 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1021
1022 CONFIG_FTGMAC100_EGIGA
1023 Define this to use GE link update with gigabit PHY.
1024 Define this if FTGMAC100 is connected to gigabit PHY.
1025 If your system has 10/100 PHY only, it might not occur
1026 wrong behavior. Because PHY usually return timeout or
1027 useless data when polling gigabit status and gigabit
1028 control registers. This behavior won't affect the
1029 correctnessof 10/100 link speed update.
1030
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001031 CONFIG_SH_ETHER
1032 Support for Renesas on-chip Ethernet controller
1033
1034 CONFIG_SH_ETHER_USE_PORT
1035 Define the number of ports to be used
1036
1037 CONFIG_SH_ETHER_PHY_ADDR
1038 Define the ETH PHY's address
1039
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001040 CONFIG_SH_ETHER_CACHE_WRITEBACK
1041 If this option is set, the driver enables cache flush.
1042
Heiko Schocher2b387762014-07-18 06:07:19 +02001043- PWM Support:
1044 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001045 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001046
Vadim Bendeburydac69642011-10-17 08:36:14 +00001047- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001048 CONFIG_TPM
1049 Support TPM devices.
1050
Christophe Ricard8759ff82015-10-06 22:54:41 +02001051 CONFIG_TPM_TIS_INFINEON
1052 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001053 per system is supported at this time.
1054
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001055 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1056 Define the burst count bytes upper limit
1057
Christophe Ricard88249232016-01-21 23:27:13 +01001058 CONFIG_TPM_ST33ZP24
1059 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1060
1061 CONFIG_TPM_ST33ZP24_I2C
1062 Support for STMicroelectronics ST33ZP24 I2C devices.
1063 Requires TPM_ST33ZP24 and I2C.
1064
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001065 CONFIG_TPM_ST33ZP24_SPI
1066 Support for STMicroelectronics ST33ZP24 SPI devices.
1067 Requires TPM_ST33ZP24 and SPI.
1068
Dirk Eibach20489092013-06-26 15:55:15 +02001069 CONFIG_TPM_ATMEL_TWI
1070 Support for Atmel TWI TPM device. Requires I2C support.
1071
Che-liang Chiouacea5702013-04-12 11:04:34 +00001072 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001073 Support for generic parallel port TPM devices. Only one device
1074 per system is supported at this time.
1075
1076 CONFIG_TPM_TIS_BASE_ADDRESS
1077 Base address where the generic TPM device is mapped
1078 to. Contemporary x86 systems usually map it at
1079 0xfed40000.
1080
Reinhard Pfau4fece432013-06-26 15:55:13 +02001081 CONFIG_TPM
1082 Define this to enable the TPM support library which provides
1083 functional interfaces to some TPM commands.
1084 Requires support for a TPM device.
1085
1086 CONFIG_TPM_AUTH_SESSIONS
1087 Define this to enable authorized functions in the TPM library.
1088 Requires CONFIG_TPM and CONFIG_SHA1.
1089
wdenkc6097192002-11-03 00:24:07 +00001090- USB Support:
1091 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001092 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001093 CONFIG_USB_UHCI to enable it.
1094 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001095 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001096 storage devices.
1097 Note:
1098 Supported are USB Keyboards and USB Floppy drives
1099 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001100
Simon Glass5978cdb2012-02-27 10:52:47 +00001101 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1102 txfilltuning field in the EHCI controller on reset.
1103
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001104 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1105 HW module registers.
1106
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001107- USB Device:
1108 Define the below if you wish to use the USB console.
1109 Once firmware is rebuilt from a serial console issue the
1110 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001111 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001112 it has found a new device. The environment variable usbtty
1113 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001114 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001115 Common Device Class Abstract Control Model serial device.
1116 If you select usbtty = gserial you should be able to enumerate
1117 a Linux host by
1118 # modprobe usbserial vendor=0xVendorID product=0xProductID
1119 else if using cdc_acm, simply setting the environment
1120 variable usbtty to be cdc_acm should suffice. The following
1121 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001122
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001123 CONFIG_USB_DEVICE
1124 Define this to build a UDC device
1125
1126 CONFIG_USB_TTY
1127 Define this to have a tty type of device available to
1128 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001129
Vipin KUMARbdb17702012-03-26 15:38:06 +05301130 CONFIG_USBD_HS
1131 Define this to enable the high speed support for usb
1132 device and usbtty. If this feature is enabled, a routine
1133 int is_usbd_high_speed(void)
1134 also needs to be defined by the driver to dynamically poll
1135 whether the enumeration has succeded at high speed or full
1136 speed.
1137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001138 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001139 Define this if you want stdin, stdout &/or stderr to
1140 be set to usbtty.
1141
Wolfgang Denke2601822006-06-14 18:14:56 +02001142 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001143 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001144 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001145 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1146 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1147 should pretend to be a Linux device to it's target host.
1148
1149 CONFIG_USBD_MANUFACTURER
1150 Define this string as the name of your company for
1151 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001152
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001153 CONFIG_USBD_PRODUCT_NAME
1154 Define this string as the name of your product
1155 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001156
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001157 CONFIG_USBD_VENDORID
1158 Define this as your assigned Vendor ID from the USB
1159 Implementors Forum. This *must* be a genuine Vendor ID
1160 to avoid polluting the USB namespace.
1161 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001162
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001163 CONFIG_USBD_PRODUCTID
1164 Define this as the unique Product ID
1165 for your device
1166 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001167
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001168- ULPI Layer Support:
1169 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1170 the generic ULPI layer. The generic layer accesses the ULPI PHY
1171 via the platform viewport, so you need both the genric layer and
1172 the viewport enabled. Currently only Chipidea/ARC based
1173 viewport is supported.
1174 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1175 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001176 If your ULPI phy needs a different reference clock than the
1177 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1178 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001179
wdenk7a428cc2003-06-15 22:40:42 +00001180- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001181 The MMC controller on the Intel PXA is supported. To
1182 enable this define CONFIG_MMC. The MMC can be
1183 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001184 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001185 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1186 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001187
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001188 CONFIG_SH_MMCIF
1189 Support for Renesas on-chip MMCIF controller
1190
1191 CONFIG_SH_MMCIF_ADDR
1192 Define the base address of MMCIF registers
1193
1194 CONFIG_SH_MMCIF_CLK
1195 Define the clock frequency for MMCIF
1196
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001197 CONFIG_SUPPORT_EMMC_BOOT
1198 Enable some additional features of the eMMC boot partitions.
1199
1200 CONFIG_SUPPORT_EMMC_RPMB
1201 Enable the commands for reading, writing and programming the
1202 key for the Replay Protection Memory Block partition in eMMC.
1203
Tom Rini58a8d322013-03-14 05:32:47 +00001204- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001205 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001206 This enables the USB portion of the DFU USB class
1207
Tom Rini58a8d322013-03-14 05:32:47 +00001208 CONFIG_DFU_MMC
1209 This enables support for exposing (e)MMC devices via DFU.
1210
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001211 CONFIG_DFU_NAND
1212 This enables support for exposing NAND devices via DFU.
1213
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301214 CONFIG_DFU_RAM
1215 This enables support for exposing RAM via DFU.
1216 Note: DFU spec refer to non-volatile memory usage, but
1217 allow usages beyond the scope of spec - here RAM usage,
1218 one that would help mostly the developer.
1219
Heiko Schochera2f831e2013-06-12 06:05:51 +02001220 CONFIG_SYS_DFU_DATA_BUF_SIZE
1221 Dfu transfer uses a buffer before writing data to the
1222 raw storage device. Make the size (in bytes) of this buffer
1223 configurable. The size of this buffer is also configurable
1224 through the "dfu_bufsiz" environment variable.
1225
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001226 CONFIG_SYS_DFU_MAX_FILE_SIZE
1227 When updating files rather than the raw storage device,
1228 we use a static buffer to copy the file into and then write
1229 the buffer once we've been given the whole file. Define
1230 this to the maximum filesize (in bytes) for the buffer.
1231 Default is 4 MiB if undefined.
1232
Heiko Schochere1ba1512014-03-18 08:09:56 +01001233 DFU_DEFAULT_POLL_TIMEOUT
1234 Poll timeout [ms], is the timeout a device can send to the
1235 host. The host must wait for this timeout before sending
1236 a subsequent DFU_GET_STATUS request to the device.
1237
1238 DFU_MANIFEST_POLL_TIMEOUT
1239 Poll timeout [ms], which the device sends to the host when
1240 entering dfuMANIFEST state. Host waits this timeout, before
1241 sending again an USB request to the device.
1242
wdenkda04a8b2004-08-02 23:22:59 +00001243- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001244 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001245 Define these for a default partition on a NAND device
1246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001247 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1248 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001249 Define these for a default partition on a NOR device
1250
wdenkc6097192002-11-03 00:24:07 +00001251- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001252 See Kconfig help for available keyboard drivers.
1253
1254 CONFIG_KEYBOARD
1255
1256 Define this to enable a custom keyboard support.
1257 This simply calls drv_keyboard_init() which must be
1258 defined in your board-specific files. This option is deprecated
1259 and is only used by novena. For new boards, use driver model
1260 instead.
wdenkc6097192002-11-03 00:24:07 +00001261
1262- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001263 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001264 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001265 SOCs that have a DIU should define this macro to enable DIU
1266 support, and should also define these other macros:
1267
1268 CONFIG_SYS_DIU_ADDR
1269 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001270 CONFIG_CFB_CONSOLE
1271 CONFIG_VIDEO_SW_CURSOR
1272 CONFIG_VGA_AS_SINGLE_DEVICE
1273 CONFIG_VIDEO_LOGO
1274 CONFIG_VIDEO_BMP_LOGO
1275
Timur Tabi32f709e2011-04-11 14:18:22 -05001276 The DIU driver will look for the 'video-mode' environment
1277 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001278 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001279 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001280
wdenkc6097192002-11-03 00:24:07 +00001281- LCD Support: CONFIG_LCD
1282
1283 Define this to enable LCD support (for output to LCD
1284 display); also select one of the supported displays
1285 by defining one of these:
1286
Stelian Popf6f86652008-05-09 21:57:18 +02001287 CONFIG_ATMEL_LCD:
1288
1289 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1290
wdenkc0d54ae2003-11-25 16:55:19 +00001291 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001292
wdenkc0d54ae2003-11-25 16:55:19 +00001293 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkc0d54ae2003-11-25 16:55:19 +00001295 CONFIG_NEC_NL6448BC20
1296
1297 NEC NL6448BC20-08. 6.5", 640x480.
1298 Active, color, single scan.
1299
1300 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001301
wdenkc0d54ae2003-11-25 16:55:19 +00001302 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001303 Active, color, single scan.
1304
1305 CONFIG_SHARP_16x9
1306
1307 Sharp 320x240. Active, color, single scan.
1308 It isn't 16x9, and I am not sure what it is.
1309
1310 CONFIG_SHARP_LQ64D341
1311
1312 Sharp LQ64D341 display, 640x480.
1313 Active, color, single scan.
1314
1315 CONFIG_HLD1045
1316
1317 HLD1045 display, 640x480.
1318 Active, color, single scan.
1319
1320 CONFIG_OPTREX_BW
1321
1322 Optrex CBL50840-2 NF-FW 99 22 M5
1323 or
1324 Hitachi LMG6912RPFC-00T
1325 or
1326 Hitachi SP14Q002
1327
1328 320x240. Black & white.
1329
Simon Glass599a4df2012-10-17 13:24:54 +00001330 CONFIG_LCD_ALIGNMENT
1331
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001332 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001333 defined then the LCD will be aligned to this value instead.
1334 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1335 here, since it is cheaper to change data cache settings on
1336 a per-section basis.
1337
1338
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001339 CONFIG_LCD_ROTATION
1340
1341 Sometimes, for example if the display is mounted in portrait
1342 mode or even if it's mounted landscape but rotated by 180degree,
1343 we need to rotate our content of the display relative to the
1344 framebuffer, so that user can read the messages which are
1345 printed out.
1346 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1347 initialized with a given rotation from "vl_rot" out of
1348 "vidinfo_t" which is provided by the board specific code.
1349 The value for vl_rot is coded as following (matching to
1350 fbcon=rotate:<n> linux-kernel commandline):
1351 0 = no rotation respectively 0 degree
1352 1 = 90 degree rotation
1353 2 = 180 degree rotation
1354 3 = 270 degree rotation
1355
1356 If CONFIG_LCD_ROTATION is not defined, the console will be
1357 initialized with 0degree rotation.
1358
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001359 CONFIG_LCD_BMP_RLE8
1360
1361 Support drawing of RLE8-compressed bitmaps on the LCD.
1362
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001363 CONFIG_I2C_EDID
1364
1365 Enables an 'i2c edid' command which can read EDID
1366 information over I2C from an attached LCD display.
1367
wdenkeb20ad32003-09-05 23:19:14 +00001368- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001369
wdenk57b2d802003-06-27 21:31:46 +00001370 If this option is set, the environment is checked for
1371 a variable "splashimage". If found, the usual display
1372 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001373 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001374 specified in "splashimage" is loaded instead. The
1375 console is redirected to the "nulldev", too. This
1376 allows for a "silent" boot where a splash screen is
1377 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001378
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001379 CONFIG_SPLASHIMAGE_GUARD
1380
1381 If this option is set, then U-Boot will prevent the environment
1382 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001383 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001384 This option is useful for targets where, due to alignment
1385 restrictions, an improperly aligned BMP image will cause a data
1386 abort. If you think you will not have problems with unaligned
1387 accesses (for example because your toolchain prevents them)
1388 there is no need to set this option.
1389
Matthias Weisser53884182009-07-09 16:07:30 +02001390 CONFIG_SPLASH_SCREEN_ALIGN
1391
1392 If this option is set the splash image can be freely positioned
1393 on the screen. Environment variable "splashpos" specifies the
1394 position as "x,y". If a positive number is given it is used as
1395 number of pixel from left/top. If a negative number is given it
1396 is used as number of pixel from right/bottom. You can also
1397 specify 'm' for centering the image.
1398
1399 Example:
1400 setenv splashpos m,m
1401 => image at center of screen
1402
1403 setenv splashpos 30,20
1404 => image at x = 30 and y = 20
1405
1406 setenv splashpos -10,m
1407 => vertically centered image
1408 at x = dspWidth - bmpWidth - 9
1409
Stefan Roesed9d97742005-09-22 09:04:17 +02001410- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1411
1412 If this option is set, additionally to standard BMP
1413 images, gzipped BMP images can be displayed via the
1414 splashscreen support or the bmp command.
1415
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001416- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1417
1418 If this option is set, 8-bit RLE compressed BMP images
1419 can be displayed via the splashscreen support or the
1420 bmp command.
1421
wdenk710e3502003-08-29 20:57:53 +00001422- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001423 CONFIG_GZIP
1424
1425 Enabled by default to support gzip compressed images.
1426
wdenk710e3502003-08-29 20:57:53 +00001427 CONFIG_BZIP2
1428
1429 If this option is set, support for bzip2 compressed
1430 images is included. If not, only uncompressed and gzip
1431 compressed images are supported.
1432
wdenk9c53f402003-10-15 23:53:47 +00001433 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001434 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001435 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001436
wdenk0e2bd9c2004-06-06 21:51:03 +00001437- MII/PHY support:
1438 CONFIG_PHY_ADDR
1439
1440 The address of PHY on MII bus.
1441
1442 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1443
1444 The clock frequency of the MII bus
1445
wdenk0e2bd9c2004-06-06 21:51:03 +00001446 CONFIG_PHY_RESET_DELAY
1447
1448 Some PHY like Intel LXT971A need extra delay after
1449 reset before any MII register access is possible.
1450 For such PHY, set this option to the usec delay
1451 required. (minimum 300usec for LXT971A)
1452
1453 CONFIG_PHY_CMD_DELAY (ppc4xx)
1454
1455 Some PHY like Intel LXT971A need extra delay after
1456 command issued before MII status register can be read
1457
wdenkc6097192002-11-03 00:24:07 +00001458- IP address:
1459 CONFIG_IPADDR
1460
1461 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001462 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001463 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001464 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001465
1466- Server IP address:
1467 CONFIG_SERVERIP
1468
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001469 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001470 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001471 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001472
Robin Getz470a6d42009-07-21 12:15:28 -04001473 CONFIG_KEEP_SERVERADDR
1474
1475 Keeps the server's MAC address, in the env 'serveraddr'
1476 for passing to bootargs (like Linux's netconsole option)
1477
Wolfgang Denk26da2992011-10-26 10:21:22 +00001478- Gateway IP address:
1479 CONFIG_GATEWAYIP
1480
1481 Defines a default value for the IP address of the
1482 default router where packets to other networks are
1483 sent to.
1484 (Environment variable "gatewayip")
1485
1486- Subnet mask:
1487 CONFIG_NETMASK
1488
1489 Defines a default value for the subnet mask (or
1490 routing prefix) which is used to determine if an IP
1491 address belongs to the local subnet or needs to be
1492 forwarded through a router.
1493 (Environment variable "netmask")
1494
David Updegraff7280da72007-06-11 10:41:07 -05001495- Multicast TFTP Mode:
1496 CONFIG_MCAST_TFTP
1497
1498 Defines whether you want to support multicast TFTP as per
1499 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001500 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001501 driver in use must provide a function: mcast() to join/leave a
1502 multicast group.
1503
wdenkc6097192002-11-03 00:24:07 +00001504- BOOTP Recovery Mode:
1505 CONFIG_BOOTP_RANDOM_DELAY
1506
1507 If you have many targets in a network that try to
1508 boot using BOOTP, you may want to avoid that all
1509 systems send out BOOTP requests at precisely the same
1510 moment (which would happen for instance at recovery
1511 from a power failure, when all systems will try to
1512 boot, thus flooding the BOOTP server. Defining
1513 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1514 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001515 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001516
1517 1st BOOTP request: delay 0 ... 1 sec
1518 2nd BOOTP request: delay 0 ... 2 sec
1519 3rd BOOTP request: delay 0 ... 4 sec
1520 4th and following
1521 BOOTP requests: delay 0 ... 8 sec
1522
Thierry Reding8977cda2014-08-19 10:21:24 +02001523 CONFIG_BOOTP_ID_CACHE_SIZE
1524
1525 BOOTP packets are uniquely identified using a 32-bit ID. The
1526 server will copy the ID from client requests to responses and
1527 U-Boot will use this to determine if it is the destination of
1528 an incoming response. Some servers will check that addresses
1529 aren't in use before handing them out (usually using an ARP
1530 ping) and therefore take up to a few hundred milliseconds to
1531 respond. Network congestion may also influence the time it
1532 takes for a response to make it back to the client. If that
1533 time is too long, U-Boot will retransmit requests. In order
1534 to allow earlier responses to still be accepted after these
1535 retransmissions, U-Boot's BOOTP client keeps a small cache of
1536 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1537 cache. The default is to keep IDs for up to four outstanding
1538 requests. Increasing this will allow U-Boot to accept offers
1539 from a BOOTP client in networks with unusually high latency.
1540
stroesee0aadfb2003-08-28 14:17:32 +00001541- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001542 You can fine tune the DHCP functionality by defining
1543 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001544
Jon Loeliger5336a762007-07-09 22:08:34 -05001545 CONFIG_BOOTP_SUBNETMASK
1546 CONFIG_BOOTP_GATEWAY
1547 CONFIG_BOOTP_HOSTNAME
1548 CONFIG_BOOTP_NISDOMAIN
1549 CONFIG_BOOTP_BOOTPATH
1550 CONFIG_BOOTP_BOOTFILESIZE
1551 CONFIG_BOOTP_DNS
1552 CONFIG_BOOTP_DNS2
1553 CONFIG_BOOTP_SEND_HOSTNAME
1554 CONFIG_BOOTP_NTPSERVER
1555 CONFIG_BOOTP_TIMEOFFSET
1556 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001557 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001558
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001559 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1560 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001561
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001562 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1563 after the configured retry count, the call will fail
1564 instead of starting over. This can be used to fail over
1565 to Link-local IP address configuration if the DHCP server
1566 is not available.
1567
stroesee0aadfb2003-08-28 14:17:32 +00001568 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1569 serverip from a DHCP server, it is possible that more
1570 than one DNS serverip is offered to the client.
1571 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1572 serverip will be stored in the additional environment
1573 variable "dnsip2". The first DNS serverip is always
1574 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001575 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001576
1577 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1578 to do a dynamic update of a DNS server. To do this, they
1579 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001580 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001581 of the "hostname" environment variable is passed as
1582 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001583
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001584 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1585
1586 A 32bit value in microseconds for a delay between
1587 receiving a "DHCP Offer" and sending the "DHCP Request".
1588 This fixes a problem with certain DHCP servers that don't
1589 respond 100% of the time to a "DHCP request". E.g. On an
1590 AT91RM9200 processor running at 180MHz, this delay needed
1591 to be *at least* 15,000 usec before a Windows Server 2003
1592 DHCP server would reply 100% of the time. I recommend at
1593 least 50,000 usec to be safe. The alternative is to hope
1594 that one of the retries will be successful but note that
1595 the DHCP timeout and retry process takes a longer than
1596 this delay.
1597
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001598 - Link-local IP address negotiation:
1599 Negotiate with other link-local clients on the local network
1600 for an address that doesn't require explicit configuration.
1601 This is especially useful if a DHCP server cannot be guaranteed
1602 to exist in all environments that the device must operate.
1603
1604 See doc/README.link-local for more information.
1605
wdenk145d2c12004-04-15 21:48:45 +00001606 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001607 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001608
1609 The device id used in CDP trigger frames.
1610
1611 CONFIG_CDP_DEVICE_ID_PREFIX
1612
1613 A two character string which is prefixed to the MAC address
1614 of the device.
1615
1616 CONFIG_CDP_PORT_ID
1617
1618 A printf format string which contains the ascii name of
1619 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001620 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001621
1622 CONFIG_CDP_CAPABILITIES
1623
1624 A 32bit integer which indicates the device capabilities;
1625 0x00000010 for a normal host which does not forwards.
1626
1627 CONFIG_CDP_VERSION
1628
1629 An ascii string containing the version of the software.
1630
1631 CONFIG_CDP_PLATFORM
1632
1633 An ascii string containing the name of the platform.
1634
1635 CONFIG_CDP_TRIGGER
1636
1637 A 32bit integer sent on the trigger.
1638
1639 CONFIG_CDP_POWER_CONSUMPTION
1640
1641 A 16bit integer containing the power consumption of the
1642 device in .1 of milliwatts.
1643
1644 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1645
1646 A byte containing the id of the VLAN.
1647
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001648- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001649
1650 Several configurations allow to display the current
1651 status using a LED. For instance, the LED will blink
1652 fast while running U-Boot code, stop blinking as
1653 soon as a reply to a BOOTP request was received, and
1654 start blinking slow once the Linux kernel is running
1655 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001656 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001657 feature in U-Boot.
1658
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001659 Additional options:
1660
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001661 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001662 The status LED can be connected to a GPIO pin.
1663 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001664 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001665 to include the gpio_led driver in the U-Boot binary.
1666
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001667 CONFIG_GPIO_LED_INVERTED_TABLE
1668 Some GPIO connected LEDs may have inverted polarity in which
1669 case the GPIO high value corresponds to LED off state and
1670 GPIO low value corresponds to LED on state.
1671 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1672 with a list of GPIO LEDs that have inverted polarity.
1673
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001674- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001675
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001676 This enable the NEW i2c subsystem, and will allow you to use
1677 i2c commands at the u-boot command line (as long as you set
1678 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1679 based realtime clock chips or other i2c devices. See
1680 common/cmd_i2c.c for a description of the command line
1681 interface.
1682
1683 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001684 - drivers/i2c/soft_i2c.c:
1685 - activate first bus with CONFIG_SYS_I2C_SOFT define
1686 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1687 for defining speed and slave address
1688 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1689 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1690 for defining speed and slave address
1691 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1692 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1693 for defining speed and slave address
1694 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1695 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1696 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001697
Heiko Schocherf2850742012-10-24 13:48:22 +02001698 - drivers/i2c/fsl_i2c.c:
1699 - activate i2c driver with CONFIG_SYS_I2C_FSL
1700 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1701 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1702 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1703 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001704 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001705 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1706 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1707 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1708 second bus.
1709
Simon Glass026fefb2012-10-30 07:28:53 +00001710 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001711 - activate this driver with CONFIG_SYS_I2C_TEGRA
1712 - This driver adds 4 i2c buses with a fix speed from
1713 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001714
Dirk Eibach42b204f2013-04-25 02:40:01 +00001715 - drivers/i2c/ppc4xx_i2c.c
1716 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1717 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1718 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1719
trema49f40a2013-09-21 18:13:35 +02001720 - drivers/i2c/i2c_mxc.c
1721 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001722 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1723 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1724 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1725 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001726 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1727 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1728 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1729 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1730 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1731 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001732 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1733 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001734 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001735 for speed, and 0 for slave.
1736
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001737 - drivers/i2c/rcar_i2c.c:
1738 - activate this driver with CONFIG_SYS_I2C_RCAR
1739 - This driver adds 4 i2c buses
1740
1741 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1742 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1743 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1744 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1745 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1746 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1747 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1748 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1749 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1750
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001751 - drivers/i2c/sh_i2c.c:
1752 - activate this driver with CONFIG_SYS_I2C_SH
1753 - This driver adds from 2 to 5 i2c buses
1754
1755 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1756 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1757 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1758 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1759 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1760 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1761 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1762 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1763 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1764 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001765 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001766
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001767 - drivers/i2c/omap24xx_i2c.c
1768 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1769 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1770 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1771 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1772 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1773 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1774 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1775 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1776 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1777 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1778 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1779
Heiko Schocher465819a2013-11-08 07:30:53 +01001780 - drivers/i2c/zynq_i2c.c
1781 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1782 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1783 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1784
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301785 - drivers/i2c/s3c24x0_i2c.c:
1786 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1787 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1788 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1789 with a fix speed from 100000 and the slave addr 0!
1790
Dirk Eibachb9577432014-07-03 09:28:18 +02001791 - drivers/i2c/ihs_i2c.c
1792 - activate this driver with CONFIG_SYS_I2C_IHS
1793 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1794 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1795 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1796 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1797 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1798 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1799 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1800 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1801 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1802 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1803 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1804 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001805 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1806 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1807 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1808 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1809 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1810 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1811 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1812 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1813 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001814
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001815 additional defines:
1816
1817 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001818 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001819
1820 CONFIG_SYS_I2C_DIRECT_BUS
1821 define this, if you don't use i2c muxes on your hardware.
1822 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1823 omit this define.
1824
1825 CONFIG_SYS_I2C_MAX_HOPS
1826 define how many muxes are maximal consecutively connected
1827 on one i2c bus. If you not use i2c muxes, omit this
1828 define.
1829
1830 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001831 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001832 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1833 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1834 CONFIG_SYS_NUM_I2C_BUSES = 9:
1835
1836 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1837 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1838 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1839 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1840 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1841 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1842 {1, {I2C_NULL_HOP}}, \
1843 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1844 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1845 }
1846
1847 which defines
1848 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001849 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1850 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1851 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1852 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1853 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001854 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001855 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1856 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001857
1858 If you do not have i2c muxes on your board, omit this define.
1859
Simon Glass3efce392017-05-12 21:10:00 -06001860- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001861 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001862 then the following macros need to be defined (examples are
1863 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001864
1865 I2C_INIT
1866
wdenkb9bbd242003-06-30 16:24:52 +00001867 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001868 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001869
wdenk544e9732004-02-06 23:19:44 +00001870 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001871
wdenkc6097192002-11-03 00:24:07 +00001872 I2C_ACTIVE
1873
1874 The code necessary to make the I2C data line active
1875 (driven). If the data line is open collector, this
1876 define can be null.
1877
wdenkb9bbd242003-06-30 16:24:52 +00001878 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1879
wdenkc6097192002-11-03 00:24:07 +00001880 I2C_TRISTATE
1881
1882 The code necessary to make the I2C data line tri-stated
1883 (inactive). If the data line is open collector, this
1884 define can be null.
1885
wdenkb9bbd242003-06-30 16:24:52 +00001886 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1887
wdenkc6097192002-11-03 00:24:07 +00001888 I2C_READ
1889
York Sun4a598092013-04-01 11:29:11 -07001890 Code that returns true if the I2C data line is high,
1891 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001892
wdenkb9bbd242003-06-30 16:24:52 +00001893 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1894
wdenkc6097192002-11-03 00:24:07 +00001895 I2C_SDA(bit)
1896
York Sun4a598092013-04-01 11:29:11 -07001897 If <bit> is true, sets the I2C data line high. If it
1898 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001899
wdenkb9bbd242003-06-30 16:24:52 +00001900 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001901 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001902 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001903
wdenkc6097192002-11-03 00:24:07 +00001904 I2C_SCL(bit)
1905
York Sun4a598092013-04-01 11:29:11 -07001906 If <bit> is true, sets the I2C clock line high. If it
1907 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001908
wdenkb9bbd242003-06-30 16:24:52 +00001909 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001910 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001911 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001912
wdenkc6097192002-11-03 00:24:07 +00001913 I2C_DELAY
1914
1915 This delay is invoked four times per clock cycle so this
1916 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001917 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001918 like:
1919
wdenkb9bbd242003-06-30 16:24:52 +00001920 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001921
Mike Frysingeree12d542010-07-21 13:38:02 -04001922 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1923
1924 If your arch supports the generic GPIO framework (asm/gpio.h),
1925 then you may alternatively define the two GPIOs that are to be
1926 used as SCL / SDA. Any of the previous I2C_xxx macros will
1927 have GPIO-based defaults assigned to them as appropriate.
1928
1929 You should define these to the GPIO value as given directly to
1930 the generic GPIO functions.
1931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001932 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001933
wdenk57b2d802003-06-27 21:31:46 +00001934 When a board is reset during an i2c bus transfer
1935 chips might think that the current transfer is still
1936 in progress. On some boards it is possible to access
1937 the i2c SCLK line directly, either by using the
1938 processor pin as a GPIO or by having a second pin
1939 connected to the bus. If this option is defined a
1940 custom i2c_init_board() routine in boards/xxx/board.c
1941 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001942
Ben Warren45657152006-09-07 16:50:54 -04001943 CONFIG_I2C_MULTI_BUS
1944
1945 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001946 must have a controller. At any point in time, only one bus is
1947 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001948 Note that bus numbering is zero-based.
1949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001950 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001951
1952 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001953 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001954 is set, specify a list of bus-device pairs. Otherwise, specify
1955 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001956
1957 e.g.
1958 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001959 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001960
1961 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1962
Wolfgang Denk092ae952011-10-26 10:21:21 +00001963 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001964 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001965
1966 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001968 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001969
1970 If defined, then this indicates the I2C bus number for DDR SPD.
1971 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1972
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001973 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001974
1975 If defined, then this indicates the I2C bus number for the RTC.
1976 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1977
Andrew Dyer58c41f92008-12-29 17:36:01 -06001978 CONFIG_SOFT_I2C_READ_REPEATED_START
1979
1980 defining this will force the i2c_read() function in
1981 the soft_i2c driver to perform an I2C repeated start
1982 between writing the address pointer and reading the
1983 data. If this define is omitted the default behaviour
1984 of doing a stop-start sequence will be used. Most I2C
1985 devices can use either method, but some require one or
1986 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001987
wdenkc6097192002-11-03 00:24:07 +00001988- SPI Support: CONFIG_SPI
1989
1990 Enables SPI driver (so far only tested with
1991 SPI EEPROM, also an instance works with Crystal A/D and
1992 D/As on the SACSng board)
1993
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09001994 CONFIG_SH_SPI
1995
1996 Enables the driver for SPI controller on SuperH. Currently
1997 only SH7757 is supported.
1998
wdenkc6097192002-11-03 00:24:07 +00001999 CONFIG_SOFT_SPI
2000
wdenk4a5c8a72003-03-06 00:02:04 +00002001 Enables a software (bit-bang) SPI driver rather than
2002 using hardware support. This is a general purpose
2003 driver that only requires three general I/O port pins
2004 (two outputs, one input) to function. If this is
2005 defined, the board configuration must define several
2006 SPI configuration items (port pins to use, etc). For
2007 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002008
Ben Warren7efe9272008-01-16 22:37:35 -05002009 CONFIG_HARD_SPI
2010
2011 Enables a hardware SPI driver for general-purpose reads
2012 and writes. As with CONFIG_SOFT_SPI, the board configuration
2013 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002014 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002015 example, see include/configs/mpc8349emds.h.
2016
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002017 CONFIG_MXC_SPI
2018
2019 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002020 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002021
Heiko Schocherb77c8882014-07-14 10:22:11 +02002022 CONFIG_SYS_SPI_MXC_WAIT
2023 Timeout for waiting until spi transfer completed.
2024 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2025
Matthias Fuchsa4400872007-12-27 17:12:34 +01002026- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002027
Matthias Fuchsa4400872007-12-27 17:12:34 +01002028 Enables FPGA subsystem.
2029
2030 CONFIG_FPGA_<vendor>
2031
2032 Enables support for specific chip vendors.
2033 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002034
Matthias Fuchsa4400872007-12-27 17:12:34 +01002035 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002036
Matthias Fuchsa4400872007-12-27 17:12:34 +01002037 Enables support for FPGA family.
2038 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2039
2040 CONFIG_FPGA_COUNT
2041
2042 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002043
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002044 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002045
wdenk57b2d802003-06-27 21:31:46 +00002046 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002047
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002048 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002049
wdenk4a5c8a72003-03-06 00:02:04 +00002050 Enable checks on FPGA configuration interface busy
2051 status by the configuration function. This option
2052 will require a board or device specific function to
2053 be written.
wdenkc6097192002-11-03 00:24:07 +00002054
2055 CONFIG_FPGA_DELAY
2056
2057 If defined, a function that provides delays in the FPGA
2058 configuration driver.
2059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002060 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002061 Allow Control-C to interrupt FPGA configuration
2062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002063 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002064
wdenk4a5c8a72003-03-06 00:02:04 +00002065 Check for configuration errors during FPGA bitfile
2066 loading. For example, abort during Virtex II
2067 configuration if the INIT_B line goes low (which
2068 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002070 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002071
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002072 Maximum time to wait for the INIT_B line to de-assert
2073 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002074 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002075 ms.
wdenkc6097192002-11-03 00:24:07 +00002076
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002077 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002078
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002079 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002080 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002082 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002083
wdenk4a5c8a72003-03-06 00:02:04 +00002084 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002085 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002086
2087- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002088 CONFIG_BUILD_TARGET
2089
2090 Some SoCs need special image types (e.g. U-Boot binary
2091 with a special header) as build targets. By defining
2092 CONFIG_BUILD_TARGET in the SoC / board header, this
2093 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002094 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002095
wdenkc6097192002-11-03 00:24:07 +00002096 CONFIG_IDENT_STRING
2097
wdenk4a5c8a72003-03-06 00:02:04 +00002098 If defined, this string will be added to the U-Boot
2099 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002100
2101- Vendor Parameter Protection:
2102
wdenk4a5c8a72003-03-06 00:02:04 +00002103 U-Boot considers the values of the environment
2104 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002105 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002106 are set once by the board vendor / manufacturer, and
2107 protects these variables from casual modification by
2108 the user. Once set, these variables are read-only,
2109 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002110 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002111
2112 If CONFIG_ENV_OVERWRITE is #defined in your config
2113 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002114 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002115 these parameters.
2116
Joe Hershberger76f353e2015-05-04 14:55:14 -05002117 Alternatively, if you define _both_ an ethaddr in the
2118 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002119 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002120 which can be changed exactly ONCE by the user. [The
2121 serial# is unaffected by this, i. e. it remains
2122 read-only.]
2123
Joe Hershberger71497d02012-12-11 22:16:31 -06002124 The same can be accomplished in a more flexible way
2125 for any variable by configuring the type of access
2126 to allow for those variables in the ".flags" variable
2127 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2128
wdenkc6097192002-11-03 00:24:07 +00002129- Protected RAM:
2130 CONFIG_PRAM
2131
2132 Define this variable to enable the reservation of
2133 "protected RAM", i. e. RAM which is not overwritten
2134 by U-Boot. Define CONFIG_PRAM to hold the number of
2135 kB you want to reserve for pRAM. You can overwrite
2136 this default value by defining an environment
2137 variable "pram" to the number of kB you want to
2138 reserve. Note that the board info structure will
2139 still show the full amount of RAM. If pRAM is
2140 reserved, a new environment variable "mem" will
2141 automatically be defined to hold the amount of
2142 remaining RAM in a form that can be passed as boot
2143 argument to Linux, for instance like that:
2144
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002145 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002146 saveenv
2147
2148 This way you can tell Linux not to use this memory,
2149 either, which results in a memory region that will
2150 not be affected by reboots.
2151
2152 *WARNING* If your board configuration uses automatic
2153 detection of the RAM size, you must make sure that
2154 this memory test is non-destructive. So far, the
2155 following board configurations are known to be
2156 "pRAM-clean":
2157
Heiko Schocher65d94db2017-06-07 17:33:09 +02002158 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002159 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002160 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002161
Gabe Blacka2f3a932012-12-02 04:55:18 +00002162- Access to physical memory region (> 4GB)
2163 Some basic support is provided for operations on memory not
2164 normally accessible to U-Boot - e.g. some architectures
2165 support access to more than 4GB of memory on 32-bit
2166 machines using physical address extension or similar.
2167 Define CONFIG_PHYSMEM to access this basic support, which
2168 currently only supports clearing the memory.
2169
wdenkc6097192002-11-03 00:24:07 +00002170- Error Recovery:
2171 CONFIG_PANIC_HANG
2172
2173 Define this variable to stop the system in case of a
2174 fatal error, so that you have to reset it manually.
2175 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002176 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002177 automatically as fast as possible, but it may be
2178 useful during development since you can try to debug
2179 the conditions that lead to the situation.
2180
2181 CONFIG_NET_RETRY_COUNT
2182
wdenk4a5c8a72003-03-06 00:02:04 +00002183 This variable defines the number of retries for
2184 network operations like ARP, RARP, TFTP, or BOOTP
2185 before giving up the operation. If not defined, a
2186 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002187
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002188 CONFIG_ARP_TIMEOUT
2189
2190 Timeout waiting for an ARP reply in milliseconds.
2191
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002192 CONFIG_NFS_TIMEOUT
2193
2194 Timeout in milliseconds used in NFS protocol.
2195 If you encounter "ERROR: Cannot umount" in nfs command,
2196 try longer timeout such as
2197 #define CONFIG_NFS_TIMEOUT 10000UL
2198
wdenkc6097192002-11-03 00:24:07 +00002199- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002200 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002201
2202 Enable auto completion of commands using TAB.
2203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002204 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002205
2206 This defines the secondary prompt string, which is
2207 printed when the command interpreter needs more input
2208 to complete a command. Usually "> ".
2209
2210 Note:
2211
wdenk57b2d802003-06-27 21:31:46 +00002212 In the current implementation, the local variables
2213 space and global environment variables space are
2214 separated. Local variables are those you define by
2215 simply typing `name=value'. To access a local
2216 variable later on, you have write `$name' or
2217 `${name}'; to execute the contents of a variable
2218 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002219
wdenk4a5c8a72003-03-06 00:02:04 +00002220 Global environment variables are those you use
2221 setenv/printenv to work with. To run a command stored
2222 in such a variable, you need to use the run command,
2223 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002224
2225 To store commands and special characters in a
2226 variable, please use double quotation marks
2227 surrounding the whole text of the variable, instead
2228 of the backslashes before semicolons and special
2229 symbols.
2230
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002231- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002232 CONFIG_CMDLINE_EDITING
2233
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002234 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002235 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002236
Marek Vasut734fb042016-01-27 04:47:55 +01002237- Command Line PS1/PS2 support:
2238 CONFIG_CMDLINE_PS_SUPPORT
2239
2240 Enable support for changing the command prompt string
2241 at run-time. Only static string is supported so far.
2242 The string is obtained from environment variables PS1
2243 and PS2.
2244
wdenkc0aa5c52003-12-06 19:49:23 +00002245- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002246 CONFIG_EXTRA_ENV_SETTINGS
2247
wdenk4a5c8a72003-03-06 00:02:04 +00002248 Define this to contain any number of null terminated
2249 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002250 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002251
wdenk4a5c8a72003-03-06 00:02:04 +00002252 For example, place something like this in your
2253 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002254
2255 #define CONFIG_EXTRA_ENV_SETTINGS \
2256 "myvar1=value1\0" \
2257 "myvar2=value2\0"
2258
wdenk4a5c8a72003-03-06 00:02:04 +00002259 Warning: This method is based on knowledge about the
2260 internal format how the environment is stored by the
2261 U-Boot code. This is NOT an official, exported
2262 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002263 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002264 You better know what you are doing here.
2265
wdenk4a5c8a72003-03-06 00:02:04 +00002266 Note: overly (ab)use of the default environment is
2267 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002268 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002269 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002270
Stephen Warren1465d5f2012-05-22 09:21:54 +00002271 CONFIG_ENV_VARS_UBOOT_CONFIG
2272
2273 Define this in order to add variables describing the
2274 U-Boot build configuration to the default environment.
2275 These will be named arch, cpu, board, vendor, and soc.
2276
2277 Enabling this option will cause the following to be defined:
2278
2279 - CONFIG_SYS_ARCH
2280 - CONFIG_SYS_CPU
2281 - CONFIG_SYS_BOARD
2282 - CONFIG_SYS_VENDOR
2283 - CONFIG_SYS_SOC
2284
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002285 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2286
2287 Define this in order to add variables describing certain
2288 run-time determined information about the hardware to the
2289 environment. These will be named board_name, board_rev.
2290
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002291 CONFIG_DELAY_ENVIRONMENT
2292
2293 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002294 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002295 that so that the environment is not available until
2296 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2297 this is instead controlled by the value of
2298 /config/load-environment.
2299
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002300- Serial Flash support
Simon Glass663b0cc2017-08-04 16:35:06 -06002301 Usage requires an initial 'sf probe' to define the serial
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002302 flash parameters, followed by read/write/erase/update
2303 commands.
2304
2305 The following defaults may be provided by the platform
2306 to handle the common case when only a single serial
2307 flash is present on the system.
2308
2309 CONFIG_SF_DEFAULT_BUS Bus identifier
2310 CONFIG_SF_DEFAULT_CS Chip-select
2311 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2312 CONFIG_SF_DEFAULT_SPEED in Hz
2313
wdenkef893942004-02-23 16:11:30 +00002314 CONFIG_SYSTEMACE
2315
2316 Adding this option adds support for Xilinx SystemACE
2317 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002318 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002319 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002320
2321 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002322 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002323
2324 When SystemACE support is added, the "ace" device type
2325 becomes available to the fat commands, i.e. fatls.
2326
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002327- TFTP Fixed UDP Port:
2328 CONFIG_TFTP_PORT
2329
Wolfgang Denk227b5192005-09-24 23:25:46 +02002330 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002331 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002332 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002333 number generator is used.
2334
Wolfgang Denk227b5192005-09-24 23:25:46 +02002335 Also, the environment variable tftpdstp is used to supply
2336 the TFTP UDP destination port value. If tftpdstp isn't
2337 defined, the normal port 69 is used.
2338
2339 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002340 blindly start the TFTP transfer using the pre-configured
2341 target IP address and UDP port. This has the effect of
2342 "punching through" the (Windows XP) firewall, allowing
2343 the remainder of the TFTP transfer to proceed normally.
2344 A better solution is to properly configure the firewall,
2345 but sometimes that is not allowed.
2346
Heiko Schocher443ca402014-01-25 07:27:13 +01002347- bootcount support:
2348 CONFIG_BOOTCOUNT_LIMIT
2349
2350 This enables the bootcounter support, see:
2351 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2352
2353 CONFIG_AT91SAM9XE
2354 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002355 CONFIG_SOC_DA8XX
2356 enable special bootcounter support on da850 based boards.
2357 CONFIG_BOOTCOUNT_RAM
2358 enable support for the bootcounter in RAM
2359 CONFIG_BOOTCOUNT_I2C
2360 enable support for the bootcounter on an i2c (like RTC) device.
2361 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2362 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2363 the bootcounter.
2364 CONFIG_BOOTCOUNT_ALEN = address len
Ian Ray542a48e2017-11-08 15:35:13 +00002365 CONFIG_BOOTCOUNT_EXT
2366 enable support for the bootcounter in EXT filesystem
2367 CONFIG_SYS_BOOTCOUNT_ADDR = RAM address used for read
2368 and write.
2369 CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE = interface
2370 CONFIG_SYS_BOOTCOUNT_EXT_DEVPART = device and part
2371 CONFIG_SYS_BOOTCOUNT_EXT_NAME = filename
Simon Glass35191a32013-06-13 15:10:02 -07002372
wdenkc0aa5c52003-12-06 19:49:23 +00002373- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002374 CONFIG_SHOW_BOOT_PROGRESS
2375
wdenk4a5c8a72003-03-06 00:02:04 +00002376 Defining this option allows to add some board-
2377 specific code (calling a user-provided function
2378 "show_boot_progress(int)") that enables you to show
2379 the system's boot progress on some display (for
2380 example, some LED's) on your board. At the moment,
2381 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002382
Simon Glass0fa36a42012-09-28 08:56:37 +00002383
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002384Legacy uImage format:
2385
wdenkc6097192002-11-03 00:24:07 +00002386 Arg Where When
2387 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002388 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002389 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002390 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002391 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002392 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002393 4 common/cmd_bootm.c Image data has correct checksum
2394 -4 common/cmd_bootm.c Image is for unsupported architecture
2395 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002396 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002397 6 common/cmd_bootm.c Image Type check OK
2398 -6 common/cmd_bootm.c gunzip uncompression error
2399 -7 common/cmd_bootm.c Unimplemented compression type
2400 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002401 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002402 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002403
2404 9 common/image.c Start initial ramdisk verification
2405 -10 common/image.c Ramdisk header has bad magic number
2406 -11 common/image.c Ramdisk header has bad checksum
2407 10 common/image.c Ramdisk header is OK
2408 -12 common/image.c Ramdisk data has bad checksum
2409 11 common/image.c Ramdisk data has correct checksum
2410 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002411 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002412 13 common/image.c Start multifile image verification
2413 14 common/image.c No initial ramdisk, no multifile, continue.
2414
Wolfgang Denk092ae952011-10-26 10:21:21 +00002415 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002416
Stefan Roese88fbf932010-04-15 16:07:28 +02002417 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002418 -31 post/post.c POST test failed, detected by post_output_backlog()
2419 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002420
Heiko Schocher633e03a2007-06-22 19:11:54 +02002421 34 common/cmd_doc.c before loading a Image from a DOC device
2422 -35 common/cmd_doc.c Bad usage of "doc" command
2423 35 common/cmd_doc.c correct usage of "doc" command
2424 -36 common/cmd_doc.c No boot device
2425 36 common/cmd_doc.c correct boot device
2426 -37 common/cmd_doc.c Unknown Chip ID on boot device
2427 37 common/cmd_doc.c correct chip ID found, device available
2428 -38 common/cmd_doc.c Read Error on boot device
2429 38 common/cmd_doc.c reading Image header from DOC device OK
2430 -39 common/cmd_doc.c Image header has bad magic number
2431 39 common/cmd_doc.c Image header has correct magic number
2432 -40 common/cmd_doc.c Error reading Image from DOC device
2433 40 common/cmd_doc.c Image header has correct magic number
2434 41 common/cmd_ide.c before loading a Image from a IDE device
2435 -42 common/cmd_ide.c Bad usage of "ide" command
2436 42 common/cmd_ide.c correct usage of "ide" command
2437 -43 common/cmd_ide.c No boot device
2438 43 common/cmd_ide.c boot device found
2439 -44 common/cmd_ide.c Device not available
2440 44 common/cmd_ide.c Device available
2441 -45 common/cmd_ide.c wrong partition selected
2442 45 common/cmd_ide.c partition selected
2443 -46 common/cmd_ide.c Unknown partition table
2444 46 common/cmd_ide.c valid partition table found
2445 -47 common/cmd_ide.c Invalid partition type
2446 47 common/cmd_ide.c correct partition type
2447 -48 common/cmd_ide.c Error reading Image Header on boot device
2448 48 common/cmd_ide.c reading Image Header from IDE device OK
2449 -49 common/cmd_ide.c Image header has bad magic number
2450 49 common/cmd_ide.c Image header has correct magic number
2451 -50 common/cmd_ide.c Image header has bad checksum
2452 50 common/cmd_ide.c Image header has correct checksum
2453 -51 common/cmd_ide.c Error reading Image from IDE device
2454 51 common/cmd_ide.c reading Image from IDE device OK
2455 52 common/cmd_nand.c before loading a Image from a NAND device
2456 -53 common/cmd_nand.c Bad usage of "nand" command
2457 53 common/cmd_nand.c correct usage of "nand" command
2458 -54 common/cmd_nand.c No boot device
2459 54 common/cmd_nand.c boot device found
2460 -55 common/cmd_nand.c Unknown Chip ID on boot device
2461 55 common/cmd_nand.c correct chip ID found, device available
2462 -56 common/cmd_nand.c Error reading Image Header on boot device
2463 56 common/cmd_nand.c reading Image Header from NAND device OK
2464 -57 common/cmd_nand.c Image header has bad magic number
2465 57 common/cmd_nand.c Image header has correct magic number
2466 -58 common/cmd_nand.c Error reading Image from NAND device
2467 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002468
Heiko Schocher633e03a2007-06-22 19:11:54 +02002469 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002470
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002471 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002472 -64 net/eth.c no Ethernet found.
2473 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002474
Heiko Schocher633e03a2007-06-22 19:11:54 +02002475 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002476 80 common/cmd_net.c before calling net_loop()
2477 -81 common/cmd_net.c some error in net_loop() occurred
2478 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002479 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2480 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002481 83 common/cmd_net.c running "source" command
2482 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002483 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002484
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002485FIT uImage format:
2486
2487 Arg Where When
2488 100 common/cmd_bootm.c Kernel FIT Image has correct format
2489 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2490 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2491 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2492 102 common/cmd_bootm.c Kernel unit name specified
2493 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002494 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002495 104 common/cmd_bootm.c Got kernel subimage node offset
2496 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2497 105 common/cmd_bootm.c Kernel subimage hash verification OK
2498 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2499 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002500 -106 common/cmd_bootm.c Kernel subimage has wrong type
2501 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002502 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2503 108 common/cmd_bootm.c Got kernel subimage data/size
2504 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2505 -109 common/cmd_bootm.c Can't get kernel subimage type
2506 -110 common/cmd_bootm.c Can't get kernel subimage comp
2507 -111 common/cmd_bootm.c Can't get kernel subimage os
2508 -112 common/cmd_bootm.c Can't get kernel subimage load address
2509 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2510
2511 120 common/image.c Start initial ramdisk verification
2512 -120 common/image.c Ramdisk FIT image has incorrect format
2513 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002514 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002515 -122 common/image.c Can't get configuration for ramdisk subimage
2516 123 common/image.c Ramdisk unit name specified
2517 -124 common/image.c Can't get ramdisk subimage node offset
2518 125 common/image.c Got ramdisk subimage node offset
2519 -125 common/image.c Ramdisk subimage hash verification failed
2520 126 common/image.c Ramdisk subimage hash verification OK
2521 -126 common/image.c Ramdisk subimage for unsupported architecture
2522 127 common/image.c Architecture check OK
2523 -127 common/image.c Can't get ramdisk subimage data/size
2524 128 common/image.c Got ramdisk subimage data/size
2525 129 common/image.c Can't get ramdisk load address
2526 -129 common/image.c Got ramdisk load address
2527
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002528 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002529 131 common/cmd_doc.c FIT image format OK
2530
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002531 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002532 141 common/cmd_ide.c FIT image format OK
2533
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002534 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002535 151 common/cmd_nand.c FIT image format OK
2536
Heiko Schocher515eb122014-05-28 11:33:33 +02002537- legacy image format:
2538 CONFIG_IMAGE_FORMAT_LEGACY
2539 enables the legacy image format support in U-Boot.
2540
2541 Default:
2542 enabled if CONFIG_FIT_SIGNATURE is not defined.
2543
2544 CONFIG_DISABLE_IMAGE_LEGACY
2545 disable the legacy image format
2546
2547 This define is introduced, as the legacy image format is
2548 enabled per default for backward compatibility.
2549
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002550- Standalone program support:
2551 CONFIG_STANDALONE_LOAD_ADDR
2552
Wolfgang Denk23f78482011-10-09 21:06:34 +02002553 This option defines a board specific value for the
2554 address where standalone program gets loaded, thus
2555 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002556 settings.
2557
2558- Frame Buffer Address:
2559 CONFIG_FB_ADDR
2560
2561 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002562 address for frame buffer. This is typically the case
2563 when using a graphics controller has separate video
2564 memory. U-Boot will then place the frame buffer at
2565 the given address instead of dynamically reserving it
2566 in system RAM by calling lcd_setmem(), which grabs
2567 the memory for the frame buffer depending on the
2568 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002569
2570 Please see board_init_f function.
2571
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002572- Automatic software updates via TFTP server
2573 CONFIG_UPDATE_TFTP
2574 CONFIG_UPDATE_TFTP_CNT_MAX
2575 CONFIG_UPDATE_TFTP_MSEC_MAX
2576
2577 These options enable and control the auto-update feature;
2578 for a more detailed description refer to doc/README.update.
2579
2580- MTD Support (mtdparts command, UBI support)
2581 CONFIG_MTD_DEVICE
2582
2583 Adds the MTD device infrastructure from the Linux kernel.
2584 Needed for mtdparts command support.
2585
2586 CONFIG_MTD_PARTITIONS
2587
2588 Adds the MTD partitioning infrastructure from the Linux
2589 kernel. Needed for UBI support.
2590
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002591- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002592 CONFIG_UBI_SILENCE_MSG
2593
2594 Make the verbose messages from UBI stop printing. This leaves
2595 warnings and errors enabled.
2596
Heiko Schocherf5895d12014-06-24 10:10:04 +02002597
2598 CONFIG_MTD_UBI_WL_THRESHOLD
2599 This parameter defines the maximum difference between the highest
2600 erase counter value and the lowest erase counter value of eraseblocks
2601 of UBI devices. When this threshold is exceeded, UBI starts performing
2602 wear leveling by means of moving data from eraseblock with low erase
2603 counter to eraseblocks with high erase counter.
2604
2605 The default value should be OK for SLC NAND flashes, NOR flashes and
2606 other flashes which have eraseblock life-cycle 100000 or more.
2607 However, in case of MLC NAND flashes which typically have eraseblock
2608 life-cycle less than 10000, the threshold should be lessened (e.g.,
2609 to 128 or 256, although it does not have to be power of 2).
2610
2611 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002612
Heiko Schocherf5895d12014-06-24 10:10:04 +02002613 CONFIG_MTD_UBI_BEB_LIMIT
2614 This option specifies the maximum bad physical eraseblocks UBI
2615 expects on the MTD device (per 1024 eraseblocks). If the
2616 underlying flash does not admit of bad eraseblocks (e.g. NOR
2617 flash), this value is ignored.
2618
2619 NAND datasheets often specify the minimum and maximum NVM
2620 (Number of Valid Blocks) for the flashes' endurance lifetime.
2621 The maximum expected bad eraseblocks per 1024 eraseblocks
2622 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2623 which gives 20 for most NANDs (MaxNVB is basically the total
2624 count of eraseblocks on the chip).
2625
2626 To put it differently, if this value is 20, UBI will try to
2627 reserve about 1.9% of physical eraseblocks for bad blocks
2628 handling. And that will be 1.9% of eraseblocks on the entire
2629 NAND chip, not just the MTD partition UBI attaches. This means
2630 that if you have, say, a NAND flash chip admits maximum 40 bad
2631 eraseblocks, and it is split on two MTD partitions of the same
2632 size, UBI will reserve 40 eraseblocks when attaching a
2633 partition.
2634
2635 default: 20
2636
2637 CONFIG_MTD_UBI_FASTMAP
2638 Fastmap is a mechanism which allows attaching an UBI device
2639 in nearly constant time. Instead of scanning the whole MTD device it
2640 only has to locate a checkpoint (called fastmap) on the device.
2641 The on-flash fastmap contains all information needed to attach
2642 the device. Using fastmap makes only sense on large devices where
2643 attaching by scanning takes long. UBI will not automatically install
2644 a fastmap on old images, but you can set the UBI parameter
2645 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2646 that fastmap-enabled images are still usable with UBI implementations
2647 without fastmap support. On typical flash devices the whole fastmap
2648 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2649
2650 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2651 Set this parameter to enable fastmap automatically on images
2652 without a fastmap.
2653 default: 0
2654
Heiko Schocher94b66de2015-10-22 06:19:21 +02002655 CONFIG_MTD_UBI_FM_DEBUG
2656 Enable UBI fastmap debug
2657 default: 0
2658
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002659- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002660 CONFIG_UBIFS_SILENCE_MSG
2661
2662 Make the verbose messages from UBIFS stop printing. This leaves
2663 warnings and errors enabled.
2664
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002665- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002666 CONFIG_SPL
2667 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002668
Tom Rini36853852012-02-14 07:29:40 +00002669 CONFIG_SPL_LDSCRIPT
2670 LDSCRIPT for linking the SPL binary.
2671
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002672 CONFIG_SPL_MAX_FOOTPRINT
2673 Maximum size in memory allocated to the SPL, BSS included.
2674 When defined, the linker checks that the actual memory
2675 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002676 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002677 must not be both defined at the same time.
2678
Tom Rini36853852012-02-14 07:29:40 +00002679 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002680 Maximum size of the SPL image (text, data, rodata, and
2681 linker lists sections), BSS excluded.
2682 When defined, the linker checks that the actual size does
2683 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002684
Wolfgang Denk825223d2011-09-11 21:24:09 +02002685 CONFIG_SPL_TEXT_BASE
2686 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002687
Scott Woodc4f0d002012-09-20 19:05:12 -05002688 CONFIG_SPL_RELOC_TEXT_BASE
2689 Address to relocate to. If unspecified, this is equal to
2690 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2691
Tom Rini36853852012-02-14 07:29:40 +00002692 CONFIG_SPL_BSS_START_ADDR
2693 Link address for the BSS within the SPL binary.
2694
2695 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002696 Maximum size in memory allocated to the SPL BSS.
2697 When defined, the linker checks that the actual memory used
2698 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002699 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002700 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002701
2702 CONFIG_SPL_STACK
2703 Adress of the start of the stack SPL will use
2704
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002705 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2706 When defined, SPL will panic() if the image it has
2707 loaded does not have a signature.
2708 Defining this is useful when code which loads images
2709 in SPL cannot guarantee that absolutely all read errors
2710 will be caught.
2711 An example is the LPC32XX MLC NAND driver, which will
2712 consider that a completely unreadable NAND block is bad,
2713 and thus should be skipped silently.
2714
Scott Woodc4f0d002012-09-20 19:05:12 -05002715 CONFIG_SPL_RELOC_STACK
2716 Adress of the start of the stack SPL will use after
2717 relocation. If unspecified, this is equal to
2718 CONFIG_SPL_STACK.
2719
Tom Rini36853852012-02-14 07:29:40 +00002720 CONFIG_SYS_SPL_MALLOC_START
2721 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002722 When this option is set the full malloc is used in SPL and
2723 it is set up by spl_init() and before that, the simple malloc()
2724 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002725
2726 CONFIG_SYS_SPL_MALLOC_SIZE
2727 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002728
Tom Rini28591df2012-08-13 12:03:19 -07002729 CONFIG_SPL_FRAMEWORK
2730 Enable the SPL framework under common/. This framework
2731 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2732 NAND loading of the Linux Kernel.
2733
Tom Rinic2b76002014-03-28 12:03:39 -04002734 CONFIG_SPL_OS_BOOT
2735 Enable booting directly to an OS from SPL.
2736 See also: doc/README.falcon
2737
Tom Rinife3b0c72012-08-13 11:37:56 -07002738 CONFIG_SPL_DISPLAY_PRINT
2739 For ARM, enable an optional function to print more information
2740 about the running system.
2741
Scott Wood7c810902012-09-20 16:35:21 -05002742 CONFIG_SPL_INIT_MINIMAL
2743 Arch init code should be built for a very small image
2744
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002745 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2746 Partition on the MMC to load U-Boot from when the MMC is being
2747 used in raw mode
2748
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002749 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2750 Sector to load kernel uImage from when MMC is being
2751 used in raw mode (for Falcon mode)
2752
2753 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2754 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2755 Sector and number of sectors to load kernel argument
2756 parameters from when MMC is being used in raw mode
2757 (for falcon mode)
2758
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002759 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2760 Partition on the MMC to load U-Boot from when the MMC is being
2761 used in fs mode
2762
Guillaume GARDET5065b712014-10-15 17:53:13 +02002763 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2764 Filename to read to load U-Boot when reading from filesystem
2765
2766 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002767 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002768 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002769
Guillaume GARDET5065b712014-10-15 17:53:13 +02002770 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002771 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002772 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002773
Scott Wood2b36fbb2012-12-06 13:33:17 +00002774 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2775 Set this for NAND SPL on PPC mpc83xx targets, so that
2776 start.S waits for the rest of the SPL to load before
2777 continuing (the hardware starts execution after just
2778 loading the first page rather than the full 4K).
2779
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302780 CONFIG_SPL_SKIP_RELOCATE
2781 Avoid SPL relocation
2782
Scott Woodc352a0c2012-09-20 19:09:07 -05002783 CONFIG_SPL_NAND_BASE
2784 Include nand_base.c in the SPL. Requires
2785 CONFIG_SPL_NAND_DRIVERS.
2786
2787 CONFIG_SPL_NAND_DRIVERS
2788 SPL uses normal NAND drivers, not minimal drivers.
2789
2790 CONFIG_SPL_NAND_ECC
2791 Include standard software ECC in the SPL
2792
Tom Rini36853852012-02-14 07:29:40 +00002793 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002794 Support for NAND boot using simple NAND drivers that
2795 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002796
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002797 CONFIG_SPL_UBI
2798 Support for a lightweight UBI (fastmap) scanner and
2799 loader
2800
Heiko Schochercf000272014-10-31 08:31:00 +01002801 CONFIG_SPL_NAND_RAW_ONLY
2802 Support to boot only raw u-boot.bin images. Use this only
2803 if you need to save space.
2804
Ying Zhangdfb2b152013-08-16 15:16:12 +08002805 CONFIG_SPL_COMMON_INIT_DDR
2806 Set for common ddr init with serial presence detect in
2807 SPL binary.
2808
Tom Rini36853852012-02-14 07:29:40 +00002809 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2810 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2811 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2812 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2813 CONFIG_SYS_NAND_ECCBYTES
2814 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002815 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002816
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302817 CONFIG_SPL_NAND_BOOT
2818 Add support NAND boot
2819
Tom Rini36853852012-02-14 07:29:40 +00002820 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002821 Location in NAND to read U-Boot from
2822
2823 CONFIG_SYS_NAND_U_BOOT_DST
2824 Location in memory to load U-Boot to
2825
2826 CONFIG_SYS_NAND_U_BOOT_SIZE
2827 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002828
2829 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002830 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002831
2832 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2833 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002834 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002835
Pavel Machekde997252012-08-30 22:42:11 +02002836 CONFIG_SPL_RAM_DEVICE
2837 Support for running image already present in ram, in SPL binary
2838
Scott Woodeb7bd972012-12-06 13:33:16 +00002839 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002840 Image offset to which the SPL should be padded before appending
2841 the SPL payload. By default, this is defined as
2842 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2843 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2844 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002845
Scott Woodf147eb72012-09-21 16:27:32 -05002846 CONFIG_SPL_TARGET
2847 Final target image containing SPL and payload. Some SPLs
2848 use an arch-specific makefile fragment instead, for
2849 example if more than one image needs to be produced.
2850
Simon Glass82d94532013-05-08 08:05:59 +00002851 CONFIG_FIT_SPL_PRINT
2852 Printing information about a FIT image adds quite a bit of
2853 code to SPL. So this is normally disabled in SPL. Use this
2854 option to re-enable it. This will affect the output of the
2855 bootm command when booting a FIT image.
2856
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002857- TPL framework
2858 CONFIG_TPL
2859 Enable building of TPL globally.
2860
2861 CONFIG_TPL_PAD_TO
2862 Image offset to which the TPL should be padded before appending
2863 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002864 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2865 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2866 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002867
wdenkc0aa5c52003-12-06 19:49:23 +00002868- Interrupt support (PPC):
2869
wdenk1ebf41e2004-01-02 14:00:00 +00002870 There are common interrupt_init() and timer_interrupt()
2871 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002872 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002873 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002874 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002875 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002876 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002877 specific handling. If board has watchdog / status_led
2878 / other_activity_monitor it works automatically from
2879 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002880
wdenkc6097192002-11-03 00:24:07 +00002881
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002882Board initialization settings:
2883------------------------------
2884
2885During Initialization u-boot calls a number of board specific functions
2886to allow the preparation of board specific prerequisites, e.g. pin setup
2887before drivers are initialized. To enable these callbacks the
2888following configuration macros have to be defined. Currently this is
2889architecture specific, so please check arch/your_architecture/lib/board.c
2890typically in board_init_f() and board_init_r().
2891
2892- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2893- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2894- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2895- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002896
wdenkc6097192002-11-03 00:24:07 +00002897Configuration Settings:
2898-----------------------
2899
York Sun6c480012014-02-26 17:03:19 -08002900- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2901 Optionally it can be defined to support 64-bit memory commands.
2902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002903- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002904 undefine this when you're short of memory.
2905
Peter Tyserdfb72b82009-01-27 18:03:12 -06002906- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2907 width of the commands listed in the 'help' command output.
2908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002909- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002910 prompt for user input.
2911
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002912- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002914- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002916- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002918- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002919 the application (usually a Linux kernel) when it is
2920 booted
2921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002922- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002923 List of legal baudrate settings for this board.
2924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002925- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002926 Begin and End addresses of the area used by the
2927 simple memory test.
2928
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002929- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002930 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002932- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002933 Scratch address used by the alternate memory test
2934 You only need to set this if address zero isn't writeable
2935
York Sun5d286cd2015-12-04 11:57:07 -08002936- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002937 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002938 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2939 is substracted from total RAM and won't be reported to OS.
2940 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002941 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002942 the RAM base is not zero, or RAM is divided into banks,
2943 this variable needs to be recalcuated to get the address.
2944
York Sun50739372015-12-07 11:05:29 -08002945- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002946 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002947 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002948 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002949 fixing up gd->ram_size the Linux kernel should gets passed
2950 the now "corrected" memory size and won't touch it either.
2951 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002952 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002953 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002954 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002955
2956 This option can be used as a workaround for the 440EPx/GRx
2957 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2958 be touched.
2959
2960 WARNING: Please make sure that this value is a multiple of
2961 the Linux page size (normally 4k). If this is not the case,
2962 then the end address of the Linux memory will be located at a
2963 non page size aligned address and this could cause major
2964 problems.
2965
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002966- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002967 Enable temporary baudrate change while serial download
2968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002969- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002970 Physical start address of SDRAM. _Must_ be 0 here.
2971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002972- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002973 Physical start address of Flash memory.
2974
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002975- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002976 Physical start address of boot monitor code (set by
2977 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002978 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002979 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002980
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002981- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002982 Size of memory reserved for monitor code, used to
2983 determine _at_compile_time_ (!) if the environment is
2984 embedded within the U-Boot image, or in a separate
2985 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002986
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002987- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002988 Size of DRAM reserved for malloc() use.
2989
Simon Glass863e4042014-07-10 22:23:28 -06002990- CONFIG_SYS_MALLOC_F_LEN
2991 Size of the malloc() pool for use before relocation. If
2992 this is defined, then a very simple malloc() implementation
2993 will become available before relocation. The address is just
2994 below the global data, and the stack is moved down to make
2995 space.
2996
2997 This feature allocates regions with increasing addresses
2998 within the region. calloc() is supported, but realloc()
2999 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003000 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003001 U-Boot relocates itself.
3002
Simon Glass9fa901b2014-11-10 17:16:54 -07003003- CONFIG_SYS_MALLOC_SIMPLE
3004 Provides a simple and small malloc() and calloc() for those
3005 boards which do not use the full malloc in SPL (which is
3006 enabled with CONFIG_SYS_SPL_MALLOC_START).
3007
Thierry Redingc97d9742014-12-09 22:25:22 -07003008- CONFIG_SYS_NONCACHED_MEMORY:
3009 Size of non-cached memory area. This area of memory will be
3010 typically located right below the malloc() area and mapped
3011 uncached in the MMU. This is useful for drivers that would
3012 otherwise require a lot of explicit cache maintenance. For
3013 some drivers it's also impossible to properly maintain the
3014 cache. For example if the regions that need to be flushed
3015 are not a multiple of the cache-line size, *and* padding
3016 cannot be allocated between the regions to align them (i.e.
3017 if the HW requires a contiguous array of regions, and the
3018 size of each region is not cache-aligned), then a flush of
3019 one region may result in overwriting data that hardware has
3020 written to another region in the same cache-line. This can
3021 happen for example in network drivers where descriptors for
3022 buffers are typically smaller than the CPU cache-line (e.g.
3023 16 bytes vs. 32 or 64 bytes).
3024
3025 Non-cached memory is only supported on 32-bit ARM at present.
3026
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003027- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003028 Normally compressed uImages are limited to an
3029 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003030 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003031 to adjust this setting to your needs.
3032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003033- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003034 Maximum size of memory mapped by the startup code of
3035 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003036 the Linux kernel (bd_info, boot arguments, FDT blob if
3037 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003038 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003039 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003040 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003041 variable "bootm_mapsize" will override the value of
3042 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3043 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003044
John Rigbyeea8e692010-10-13 13:57:35 -06003045- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3046 Enable initrd_high functionality. If defined then the
3047 initrd_high feature is enabled and the bootm ramdisk subcommand
3048 is enabled.
3049
3050- CONFIG_SYS_BOOT_GET_CMDLINE:
3051 Enables allocating and saving kernel cmdline in space between
3052 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3053
3054- CONFIG_SYS_BOOT_GET_KBD:
3055 Enables allocating and saving a kernel copy of the bd_info in
3056 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003058- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003059 Max number of Flash memory banks
3060
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003061- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003062 Max number of sectors on a Flash chip
3063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003064- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003065 Timeout for Flash erase operations (in ms)
3066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003067- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003068 Timeout for Flash write operations (in ms)
3069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003070- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003071 Timeout for Flash set sector lock bit operation (in ms)
3072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003073- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003074 Timeout for Flash clear lock bits operation (in ms)
3075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003076- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003077 If defined, hardware flash sectors protection is used
3078 instead of U-Boot software protection.
3079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003081
3082 Enable TFTP transfers directly to flash memory;
3083 without this option such a download has to be
3084 performed in two steps: (1) download to RAM, and (2)
3085 copy from RAM to flash.
3086
3087 The two-step approach is usually more reliable, since
3088 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003089 the flash, but in some situations (when system RAM is
3090 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003091 downloaded image) this option may be very useful.
3092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003094 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003095 common flash structure for storing flash geometry.
3096
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003097- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003098 This option also enables the building of the cfi_flash driver
3099 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003100
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003101- CONFIG_FLASH_CFI_MTD
3102 This option enables the building of the cfi_mtd driver
3103 in the drivers directory. The driver exports CFI flash
3104 to the MTD layer.
3105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003106- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003107 Use buffered writes to flash.
3108
3109- CONFIG_FLASH_SPANSION_S29WS_N
3110 s29ws-n MirrorBit flash has non-standard addresses for buffered
3111 write commands.
3112
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003113- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003114 If this option is defined, the common CFI flash doesn't
3115 print it's warning upon not recognized FLASH banks. This
3116 is useful, if some of the configured banks are only
3117 optionally available.
3118
Jerry Van Barenaae73572008-03-08 13:48:01 -05003119- CONFIG_FLASH_SHOW_PROGRESS
3120 If defined (must be an integer), print out countdown
3121 digits and dots. Recommended value: 45 (9..1) for 80
3122 column displays, 15 (3..1) for 40 column displays.
3123
Stefan Roesed20cba52013-04-04 15:53:14 +02003124- CONFIG_FLASH_VERIFY
3125 If defined, the content of the flash (destination) is compared
3126 against the source after the write operation. An error message
3127 will be printed when the contents are not identical.
3128 Please note that this option is useless in nearly all cases,
3129 since such flash programming errors usually are detected earlier
3130 while unprotecting/erasing/programming. Please only enable
3131 this option if you really know what you are doing.
3132
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003133- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003134 Defines the number of Ethernet receive buffers. On some
3135 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003136 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3137 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003138 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003139 Defaults to 4 if not defined.
3140
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003141- CONFIG_ENV_MAX_ENTRIES
3142
Wolfgang Denk1136f692010-10-27 22:48:30 +02003143 Maximum number of entries in the hash table that is used
3144 internally to store the environment settings. The default
3145 setting is supposed to be generous and should work in most
3146 cases. This setting can be used to tune behaviour; see
3147 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003148
Joe Hershberger71497d02012-12-11 22:16:31 -06003149- CONFIG_ENV_FLAGS_LIST_DEFAULT
3150- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003151 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003152 calling env set. Variables can be restricted to only decimal,
3153 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3154 the variables can also be restricted to IP address or MAC address.
3155
3156 The format of the list is:
3157 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003158 access_attribute = [a|r|o|c]
3159 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003160 entry = variable_name[:attributes]
3161 list = entry[,list]
3162
3163 The type attributes are:
3164 s - String (default)
3165 d - Decimal
3166 x - Hexadecimal
3167 b - Boolean ([1yYtT|0nNfF])
3168 i - IP address
3169 m - MAC address
3170
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003171 The access attributes are:
3172 a - Any (default)
3173 r - Read-only
3174 o - Write-once
3175 c - Change-default
3176
Joe Hershberger71497d02012-12-11 22:16:31 -06003177 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3178 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003179 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003180
3181 - CONFIG_ENV_FLAGS_LIST_STATIC
3182 Define this to a list (string) to define validation that
3183 should be done if an entry is not found in the ".flags"
3184 environment variable. To override a setting in the static
3185 list, simply add an entry for the same variable name to the
3186 ".flags" variable.
3187
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003188 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3189 regular expression. This allows multiple variables to define the same
3190 flags without explicitly listing them for each variable.
3191
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003192- CONFIG_ENV_ACCESS_IGNORE_FORCE
3193 If defined, don't allow the -f switch to env set override variable
3194 access flags.
3195
Gabe Black3687fe42014-10-15 04:38:30 -06003196- CONFIG_USE_STDINT
3197 If stdint.h is available with your toolchain you can define this
3198 option to enable it. You can provide option 'USE_STDINT=1' when
3199 building U-Boot to enable this.
3200
wdenkc6097192002-11-03 00:24:07 +00003201The following definitions that deal with the placement and management
3202of environment data (variable area); in general, we support the
3203following configurations:
3204
Mike Frysinger63b8f122011-07-08 10:44:25 +00003205- CONFIG_BUILD_ENVCRC:
3206
3207 Builds up envcrc with the target environment so that external utils
3208 may easily extract it and embed it in final U-Boot images.
3209
wdenkc6097192002-11-03 00:24:07 +00003210BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003211in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003212console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003213U-Boot will hang.
3214
3215Please note that even with NVRAM we still use a copy of the
3216environment in RAM: we could work on NVRAM directly, but we want to
3217keep settings there always unmodified except somebody uses "saveenv"
3218to save the current settings.
3219
Liu Gang85bcd732012-03-08 00:33:20 +00003220BE CAREFUL! For some special cases, the local device can not use
3221"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003222environment stored in a remote NOR flash by SRIO or PCIE link,
3223but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003224
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003225- CONFIG_NAND_ENV_DST
3226
3227 Defines address in RAM to which the nand_spl code should copy the
3228 environment. If redundant environment is used, it will be copied to
3229 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3230
Bruce Adleredecc942007-11-02 13:15:42 -07003231Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003232has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06003233created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003234until then to read environment variables.
3235
wdenk8dba0502003-03-31 16:34:49 +00003236The environment is protected by a CRC32 checksum. Before the monitor
3237is relocated into RAM, as a result of a bad CRC you will be working
3238with the compiled-in default environment - *silently*!!! [This is
3239necessary, because the first environment variable we need is the
3240"baudrate" setting for the console - if we have a bad CRC, we don't
3241have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003242
3243Note: once the monitor has been relocated, then it will complain if
3244the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003245use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003247- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003248 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003250 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003251 also needs to be defined.
3252
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003253- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003254 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003255
Ron Madriddfa028a2009-02-18 14:30:44 -08003256- CONFIG_NS16550_MIN_FUNCTIONS:
3257 Define this if you desire to only have use of the NS16550_init
3258 and NS16550_putc functions for the serial driver located at
3259 drivers/serial/ns16550.c. This option is useful for saving
3260 space for already greatly restricted images, including but not
3261 limited to NAND_SPL configurations.
3262
Simon Glass28a9e332012-11-30 13:01:18 +00003263- CONFIG_DISPLAY_BOARDINFO
3264 Display information about the board that U-Boot is running on
3265 when U-Boot starts up. The board function checkboard() is called
3266 to do this.
3267
Simon Glasse8822012012-11-30 13:01:19 +00003268- CONFIG_DISPLAY_BOARDINFO_LATE
3269 Similar to the previous option, but display this information
3270 later, once stdio is running and output goes to the LCD, if
3271 present.
3272
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003273- CONFIG_BOARD_SIZE_LIMIT:
3274 Maximum size of the U-Boot image. When defined, the
3275 build system checks that the actual size does not
3276 exceed it.
3277
wdenkc6097192002-11-03 00:24:07 +00003278Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003279---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003281- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003282 Cache Line Size of the CPU.
3283
Timur Tabid8f341c2011-08-04 18:03:41 -05003284- CONFIG_SYS_CCSRBAR_DEFAULT:
3285 Default (power-on reset) physical address of CCSR on Freescale
3286 PowerPC SOCs.
3287
3288- CONFIG_SYS_CCSRBAR:
3289 Virtual address of CCSR. On a 32-bit build, this is typically
3290 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3291
Timur Tabid8f341c2011-08-04 18:03:41 -05003292- CONFIG_SYS_CCSRBAR_PHYS:
3293 Physical address of CCSR. CCSR can be relocated to a new
3294 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003295 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003296 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3297 is typically relocated on 36-bit builds. It is recommended
3298 that this macro be defined via the _HIGH and _LOW macros:
3299
3300 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3301 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3302
3303- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003304 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3305 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003306 used in assembly code, so it must not contain typecasts or
3307 integer size suffixes (e.g. "ULL").
3308
3309- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3310 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3311 used in assembly code, so it must not contain typecasts or
3312 integer size suffixes (e.g. "ULL").
3313
3314- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3315 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3316 forced to a value that ensures that CCSR is not relocated.
3317
wdenk1272e232002-11-10 22:06:23 +00003318- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003319 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003320
3321 the default drive number (default value 0)
3322
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003323 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003324
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003325 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003326 (default value 1)
3327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003328 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003329
wdenk4a5c8a72003-03-06 00:02:04 +00003330 defines the offset of register from address. It
3331 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003332 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003333
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003334 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3335 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003336 default value.
wdenk1272e232002-11-10 22:06:23 +00003337
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003338 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003339 fdc_hw_init() is called at the beginning of the FDC
3340 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003341 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003342 initializations.
wdenk1272e232002-11-10 22:06:23 +00003343
Macpaul Lind1e49942011-04-11 20:45:32 +00003344- CONFIG_IDE_AHB:
3345 Most IDE controllers were designed to be connected with PCI
3346 interface. Only few of them were designed for AHB interface.
3347 When software is doing ATA command and data transfer to
3348 IDE devices through IDE-AHB controller, some additional
3349 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003350 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003352- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003353 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003354 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003356- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003357
wdenkeb20ad32003-09-05 23:19:14 +00003358 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003359 initial data and stack; please note that this must be
3360 writable memory that is working WITHOUT special
3361 initialization, i. e. you CANNOT use normal RAM which
3362 will become available only after programming the
3363 memory controller and running certain initialization
3364 sequences.
3365
3366 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003367 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003369- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003370
3371 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003372 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3373 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003374 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003375 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003376 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003377 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3378 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003379
3380 Note:
3381 On the MPC824X (or other systems that use the data
3382 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003383 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003384 point to an otherwise UNUSED address space between
3385 the top of RAM and the start of the PCI space.
3386
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003387- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003388
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003389- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003390 SDRAM timing
3391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003392- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003393 periodic timer for refresh
3394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003395- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3396 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3397 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3398 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003399 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3400
3401- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003402 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3403 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003404 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3405
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003406- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003407 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003408 Don't do any setup work, presumably because someone or
3409 something has already done it, and we don't need to do it
3410 a second time. Useful for platforms that are pre-booted
3411 by coreboot or similar.
3412
Gabor Juhosb4458732013-05-30 07:06:12 +00003413- CONFIG_PCI_INDIRECT_BRIDGE:
3414 Enable support for indirect PCI bridges.
3415
Kumar Gala8975d7a2010-12-30 12:09:53 -06003416- CONFIG_SYS_SRIO:
3417 Chip has SRIO or not
3418
3419- CONFIG_SRIO1:
3420 Board has SRIO 1 port available
3421
3422- CONFIG_SRIO2:
3423 Board has SRIO 2 port available
3424
Liu Gang27afb9c2013-05-07 16:30:46 +08003425- CONFIG_SRIO_PCIE_BOOT_MASTER
3426 Board can support master function for Boot from SRIO and PCIE
3427
Kumar Gala8975d7a2010-12-30 12:09:53 -06003428- CONFIG_SYS_SRIOn_MEM_VIRT:
3429 Virtual Address of SRIO port 'n' memory region
3430
3431- CONFIG_SYS_SRIOn_MEM_PHYS:
3432 Physical Address of SRIO port 'n' memory region
3433
3434- CONFIG_SYS_SRIOn_MEM_SIZE:
3435 Size of SRIO port 'n' memory region
3436
Fabio Estevamf17e8782013-04-11 09:35:34 +00003437- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3438 Defined to tell the NAND controller that the NAND chip is using
3439 a 16 bit bus.
3440 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003441 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003442 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003443 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003444
3445- CONFIG_SYS_NDFC_EBC0_CFG
3446 Sets the EBC0_CFG register for the NDFC. If not defined
3447 a default value will be used.
3448
Ben Warren45657152006-09-07 16:50:54 -04003449- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003450 Get DDR timing information from an I2C EEPROM. Common
3451 with pluggable memory modules such as SODIMMs
3452
Ben Warren45657152006-09-07 16:50:54 -04003453 SPD_EEPROM_ADDRESS
3454 I2C address of the SPD EEPROM
3455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003456- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003457 If SPD EEPROM is on an I2C bus other than the first
3458 one, specify here. Note that the value must resolve
3459 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003460
York Sune73cc042011-06-07 09:42:16 +08003461- CONFIG_SYS_DDR_RAW_TIMING
3462 Get DDR timing information from other than SPD. Common with
3463 soldered DDR chips onboard without SPD. DDR raw timing
3464 parameters are extracted from datasheet and hard-coded into
3465 header files or board specific files.
3466
York Sunbd495cf2011-09-16 13:21:35 -07003467- CONFIG_FSL_DDR_INTERACTIVE
3468 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3469
York Sun8ced0502015-01-06 13:18:55 -08003470- CONFIG_FSL_DDR_SYNC_REFRESH
3471 Enable sync of refresh for multiple controllers.
3472
York Sunb6a35f82015-03-19 09:30:28 -07003473- CONFIG_FSL_DDR_BIST
3474 Enable built-in memory test for Freescale DDR controllers.
3475
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003476- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003477 Only for 83xx systems. If specified, then DDR should
3478 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003479
wdenk6203e402004-04-18 10:13:26 +00003480- CONFIG_RMII
3481 Enable RMII mode for all FECs.
3482 Note that this is a global option, we can't
3483 have one FEC in standard MII mode and another in RMII mode.
3484
wdenk20c98a62004-04-23 20:32:05 +00003485- CONFIG_CRC32_VERIFY
3486 Add a verify option to the crc32 command.
3487 The syntax is:
3488
3489 => crc32 -v <address> <count> <crc32>
3490
3491 Where address/count indicate a memory area
3492 and crc32 is the correct crc32 which the
3493 area should have.
3494
wdenk64519362004-07-11 17:40:54 +00003495- CONFIG_LOOPW
3496 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003497 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003498
stroesecc3af832004-12-16 18:46:55 +00003499- CONFIG_MX_CYCLIC
3500 Add the "mdc" and "mwc" memory commands. These are cyclic
3501 "md/mw" commands.
3502 Examples:
3503
wdenk07d7e6b2004-12-16 21:44:03 +00003504 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003505 This command will print 4 bytes (10,11,12,13) each 500 ms.
3506
wdenk07d7e6b2004-12-16 21:44:03 +00003507 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003508 This command will write 12345678 to address 100 all 10 ms.
3509
wdenk07d7e6b2004-12-16 21:44:03 +00003510 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003511 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003512
wdenk3d3d99f2005-04-04 12:44:11 +00003513- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003514 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003515 low level initializations (like setting up the memory
3516 controller) are omitted and/or U-Boot does not
3517 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003518
Wolfgang Denk302141d2010-11-27 23:30:56 +01003519 Normally this variable MUST NOT be defined. The only
3520 exception is when U-Boot is loaded (to RAM) by some
3521 other boot loader or by a debugger which performs
3522 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003523
Simon Glass90844072016-05-05 07:28:06 -06003524- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3525 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003526 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003527 instruction cache) is still performed.
3528
Aneesh V552a3192011-07-13 05:11:07 +00003529- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003530 Modifies the behaviour of start.S when compiling a loader
3531 that is executed before the actual U-Boot. E.g. when
3532 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003533
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003534- CONFIG_TPL_BUILD
3535 Modifies the behaviour of start.S when compiling a loader
3536 that is executed after the SPL and before the actual U-Boot.
3537 It is loaded by the SPL.
3538
Ying Zhang0d4f5442013-05-20 14:07:23 +08003539- CONFIG_SYS_MPC85XX_NO_RESETVEC
3540 Only for 85xx systems. If this variable is specified, the section
3541 .resetvec is not kept and the section .bootpg is placed in the
3542 previous 4k of the .text section.
3543
Simon Glass17dabf02013-02-24 17:33:14 +00003544- CONFIG_ARCH_MAP_SYSMEM
3545 Generally U-Boot (and in particular the md command) uses
3546 effective address. It is therefore not necessary to regard
3547 U-Boot address as virtual addresses that need to be translated
3548 to physical addresses. However, sandbox requires this, since
3549 it maintains its own little RAM buffer which contains all
3550 addressable memory. This option causes some memory accesses
3551 to be mapped through map_sysmem() / unmap_sysmem().
3552
Simon Glassbfb59802013-02-14 04:18:54 +00003553- CONFIG_X86_RESET_VECTOR
3554 If defined, the x86 reset vector code is included. This is not
3555 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003556
Heiko Schocher2233e462013-11-04 14:05:00 +01003557- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3558 Enables the RTC32K OSC on AM33xx based plattforms
3559
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003560- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3561 Option to disable subpage write in NAND driver
3562 driver that uses this:
3563 drivers/mtd/nand/davinci_nand.c
3564
Timur Tabi275f4bb2011-11-22 09:21:25 -06003565Freescale QE/FMAN Firmware Support:
3566-----------------------------------
3567
3568The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3569loading of "firmware", which is encoded in the QE firmware binary format.
3570This firmware often needs to be loaded during U-Boot booting, so macros
3571are used to identify the storage device (NOR flash, SPI, etc) and the address
3572within that device.
3573
Zhao Qiang83a90842014-03-21 16:21:44 +08003574- CONFIG_SYS_FMAN_FW_ADDR
3575 The address in the storage device where the FMAN microcode is located. The
3576 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3577 is also specified.
3578
3579- CONFIG_SYS_QE_FW_ADDR
3580 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003581 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3582 is also specified.
3583
3584- CONFIG_SYS_QE_FMAN_FW_LENGTH
3585 The maximum possible size of the firmware. The firmware binary format
3586 has a field that specifies the actual size of the firmware, but it
3587 might not be possible to read any part of the firmware unless some
3588 local storage is allocated to hold the entire firmware first.
3589
3590- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3591 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3592 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3593 virtual address in NOR flash.
3594
3595- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3596 Specifies that QE/FMAN firmware is located in NAND flash.
3597 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3598
3599- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3600 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3601 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3602
Liu Gang1e084582012-03-08 00:33:18 +00003603- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3604 Specifies that QE/FMAN firmware is located in the remote (master)
3605 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003606 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3607 window->master inbound window->master LAW->the ucode address in
3608 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003609
J. German Rivera8ff14b72014-06-23 15:15:55 -07003610Freescale Layerscape Management Complex Firmware Support:
3611---------------------------------------------------------
3612The Freescale Layerscape Management Complex (MC) supports the loading of
3613"firmware".
3614This firmware often needs to be loaded during U-Boot booting, so macros
3615are used to identify the storage device (NOR flash, SPI, etc) and the address
3616within that device.
3617
3618- CONFIG_FSL_MC_ENET
3619 Enable the MC driver for Layerscape SoCs.
3620
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303621Freescale Layerscape Debug Server Support:
3622-------------------------------------------
3623The Freescale Layerscape Debug Server Support supports the loading of
3624"Debug Server firmware" and triggering SP boot-rom.
3625This firmware often needs to be loaded during U-Boot booting.
3626
York Sun928b6812015-12-07 11:08:58 -08003627- CONFIG_SYS_MC_RSV_MEM_ALIGN
3628 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303629
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003630Reproducible builds
3631-------------------
3632
3633In order to achieve reproducible builds, timestamps used in the U-Boot build
3634process have to be set to a fixed value.
3635
3636This is done using the SOURCE_DATE_EPOCH environment variable.
3637SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3638option for U-Boot or an environment variable in U-Boot.
3639
3640SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3641
wdenkc6097192002-11-03 00:24:07 +00003642Building the Software:
3643======================
3644
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003645Building U-Boot has been tested in several native build environments
3646and in many different cross environments. Of course we cannot support
3647all possibly existing versions of cross development tools in all
3648(potentially obsolete) versions. In case of tool chain problems we
3649recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3650which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003651
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003652If you are not using a native environment, it is assumed that you
3653have GNU cross compiling tools available in your path. In this case,
3654you must set the environment variable CROSS_COMPILE in your shell.
3655Note that no changes to the Makefile or any other source files are
3656necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003657
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003658 $ CROSS_COMPILE=ppc_4xx-
3659 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003660
Peter Tyserb06976d2009-03-13 18:54:51 -05003661Note: If you wish to generate Windows versions of the utilities in
3662 the tools directory you can use the MinGW toolchain
3663 (http://www.mingw.org). Set your HOST tools to the MinGW
3664 toolchain and execute 'make tools'. For example:
3665
3666 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3667
3668 Binaries such as tools/mkimage.exe will be created which can
3669 be executed on computers running Windows.
3670
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003671U-Boot is intended to be simple to build. After installing the
3672sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003673is done by typing:
3674
Holger Freyther7ba4e572014-08-04 09:26:05 +02003675 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003676
Holger Freyther7ba4e572014-08-04 09:26:05 +02003677where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003678rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003679
wdenk6c59edc2004-05-03 20:45:30 +00003680Note: for some board special configuration names may exist; check if
3681 additional information is available from the board vendor; for
3682 instance, the TQM823L systems are available without (standard)
3683 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003684 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003685
Holger Freyther7ba4e572014-08-04 09:26:05 +02003686 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003687 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003688
Holger Freyther7ba4e572014-08-04 09:26:05 +02003689 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003690 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk6c59edc2004-05-03 20:45:30 +00003692 etc.
wdenkc6097192002-11-03 00:24:07 +00003693
wdenkc6097192002-11-03 00:24:07 +00003694
wdenk6c59edc2004-05-03 20:45:30 +00003695Finally, type "make all", and you should get some working U-Boot
3696images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk6c59edc2004-05-03 20:45:30 +00003698- "u-boot.bin" is a raw binary image
3699- "u-boot" is an image in ELF binary format
3700- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003701
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003702By default the build is performed locally and the objects are saved
3703in the source directory. One of the two methods can be used to change
3704this behavior and build U-Boot to some external directory:
3705
37061. Add O= to the make command line invocations:
3707
3708 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003709 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003710 make O=/tmp/build all
3711
Timo Ketolac8c67602014-11-06 14:39:05 +020037122. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003713
Timo Ketolac8c67602014-11-06 14:39:05 +02003714 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003715 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003716 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003717 make all
3718
Timo Ketolac8c67602014-11-06 14:39:05 +02003719Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003720variable.
3721
wdenkc6097192002-11-03 00:24:07 +00003722
wdenk6c59edc2004-05-03 20:45:30 +00003723Please be aware that the Makefiles assume you are using GNU make, so
3724for instance on NetBSD you might need to use "gmake" instead of
3725native "make".
wdenkc6097192002-11-03 00:24:07 +00003726
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk6c59edc2004-05-03 20:45:30 +00003728If the system board that you have is not listed, then you will need
3729to port U-Boot to your hardware platform. To do this, follow these
3730steps:
wdenkc6097192002-11-03 00:24:07 +00003731
Phil Sutterc77b4882015-12-25 14:41:18 +010037321. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003733 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003734 the "Makefile" and a "<board>.c".
37352. Create a new configuration file "include/configs/<board>.h" for
3736 your board.
wdenk6c59edc2004-05-03 20:45:30 +000037373. If you're porting U-Boot to a new CPU, then also create a new
3738 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020037394. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000037405. Type "make", and you should get a working "u-boot.srec" file
3741 to be installed on your target system.
37426. Debug and solve any problems that might arise.
3743 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003744
wdenkc6097192002-11-03 00:24:07 +00003745
wdenk6c59edc2004-05-03 20:45:30 +00003746Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3747==============================================================
wdenkc6097192002-11-03 00:24:07 +00003748
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003749If you have modified U-Boot sources (for instance added a new board
3750or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003751provide feedback to the other developers. The feedback normally takes
3752the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003753official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003754
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003755But before you submit such a patch, please verify that your modifi-
3756cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003757the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003758just run the buildman script (tools/buildman/buildman), which will
3759configure and build U-Boot for ALL supported system. Be warned, this
3760will take a while. Please see the buildman README, or run 'buildman -H'
3761for documentation.
wdenkc6097192002-11-03 00:24:07 +00003762
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003763
wdenk6c59edc2004-05-03 20:45:30 +00003764See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003765
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk6c59edc2004-05-03 20:45:30 +00003767Monitor Commands - Overview:
3768============================
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk6c59edc2004-05-03 20:45:30 +00003770go - start application at address 'addr'
3771run - run commands in an environment variable
3772bootm - boot application image from memory
3773bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003774bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003775tftpboot- boot image via network using TFTP protocol
3776 and env variables "ipaddr" and "serverip"
3777 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003778tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003779rarpboot- boot image via network using RARP/TFTP protocol
3780diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3781loads - load S-Record file over serial line
3782loadb - load binary file over serial line (kermit mode)
3783md - memory display
3784mm - memory modify (auto-incrementing)
3785nm - memory modify (constant address)
3786mw - memory write (fill)
3787cp - memory copy
3788cmp - memory compare
3789crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003790i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003791sspi - SPI utility commands
3792base - print or set address offset
3793printenv- print environment variables
3794setenv - set environment variables
3795saveenv - save environment variables to persistent storage
3796protect - enable or disable FLASH write protection
3797erase - erase FLASH memory
3798flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003799nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003800bdinfo - print Board Info structure
3801iminfo - print header information for application image
3802coninfo - print console devices and informations
3803ide - IDE sub-system
3804loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003805loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003806mtest - simple RAM test
3807icache - enable or disable instruction cache
3808dcache - enable or disable data cache
3809reset - Perform RESET of the CPU
3810echo - echo args to console
3811version - print monitor version
3812help - print online help
3813? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003814
wdenkc6097192002-11-03 00:24:07 +00003815
wdenk6c59edc2004-05-03 20:45:30 +00003816Monitor Commands - Detailed Description:
3817========================================
wdenkc6097192002-11-03 00:24:07 +00003818
wdenk6c59edc2004-05-03 20:45:30 +00003819TODO.
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk6c59edc2004-05-03 20:45:30 +00003821For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003822
3823
wdenk6c59edc2004-05-03 20:45:30 +00003824Environment Variables:
3825======================
wdenkc6097192002-11-03 00:24:07 +00003826
wdenk6c59edc2004-05-03 20:45:30 +00003827U-Boot supports user configuration using Environment Variables which
3828can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk6c59edc2004-05-03 20:45:30 +00003830Environment Variables are set using "setenv", printed using
3831"printenv", and saved to Flash using "saveenv". Using "setenv"
3832without a value can be used to delete a variable from the
3833environment. As long as you don't save the environment you are
3834working with an in-memory copy. In case the Flash area containing the
3835environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003836
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003837Some configuration options can be set using Environment Variables.
3838
3839List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk6c59edc2004-05-03 20:45:30 +00003841 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk6c59edc2004-05-03 20:45:30 +00003845 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk6c59edc2004-05-03 20:45:30 +00003847 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk6c59edc2004-05-03 20:45:30 +00003849 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003850
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003851 bootm_low - Memory range available for image processing in the bootm
3852 command can be restricted. This variable is given as
3853 a hexadecimal number and defines lowest address allowed
3854 for use by the bootm command. See also "bootm_size"
3855 environment variable. Address defined by "bootm_low" is
3856 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003857 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3858 bootm_mapsize.
3859
Wolfgang Denk092ae952011-10-26 10:21:21 +00003860 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003861 This variable is given as a hexadecimal number and it
3862 defines the size of the memory region starting at base
3863 address bootm_low that is accessible by the Linux kernel
3864 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3865 as the default value if it is defined, and bootm_size is
3866 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003867
3868 bootm_size - Memory range available for image processing in the bootm
3869 command can be restricted. This variable is given as
3870 a hexadecimal number and defines the size of the region
3871 allowed for use by the bootm command. See also "bootm_low"
3872 environment variable.
3873
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003874 updatefile - Location of the software update file on a TFTP server, used
3875 by the automatic software update feature. Please refer to
3876 documentation in doc/README.update for more details.
3877
wdenk6c59edc2004-05-03 20:45:30 +00003878 autoload - if set to "no" (any string beginning with 'n'),
3879 "bootp" will just load perform a lookup of the
3880 configuration from the BOOTP server, but not try to
3881 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883 autostart - if set to "yes", an image loaded using the "bootp",
3884 "rarpboot", "tftpboot" or "diskboot" commands will
3885 be automatically started (by internally calling
3886 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk6c59edc2004-05-03 20:45:30 +00003888 If set to "no", a standalone image passed to the
3889 "bootm" command will be copied to the load address
3890 (and eventually uncompressed), but NOT be started.
3891 This can be used to load and uncompress arbitrary
3892 data.
wdenkc6097192002-11-03 00:24:07 +00003893
David A. Longd558a4e2011-07-09 16:40:19 -04003894 fdt_high - if set this restricts the maximum address that the
3895 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003896 For example, if you have a system with 1 GB memory
3897 at physical address 0x10000000, while Linux kernel
3898 only recognizes the first 704 MB as low memory, you
3899 may need to set fdt_high as 0x3C000000 to have the
3900 device tree blob be copied to the maximum address
3901 of the 704 MB low memory, so that Linux kernel can
3902 access it during the boot procedure.
3903
David A. Longd558a4e2011-07-09 16:40:19 -04003904 If this is set to the special value 0xFFFFFFFF then
3905 the fdt will not be copied at all on boot. For this
3906 to work it must reside in writable memory, have
3907 sufficient padding on the end of it for u-boot to
3908 add the information it needs into it, and the memory
3909 must be accessible by the kernel.
3910
Simon Glassdc6fa642011-10-24 19:15:34 +00003911 fdtcontroladdr- if set this is the address of the control flattened
3912 device tree used by U-Boot when CONFIG_OF_CONTROL is
3913 defined.
3914
wdenk0e2bd9c2004-06-06 21:51:03 +00003915 i2cfast - (PPC405GP|PPC405EP only)
3916 if set to 'y' configures Linux I2C driver for fast
3917 mode (400kHZ). This environment variable is used in
3918 initialization code. So, for changes to be effective
3919 it must be saved and board must be reset.
3920
wdenk6c59edc2004-05-03 20:45:30 +00003921 initrd_high - restrict positioning of initrd images:
3922 If this variable is not set, initrd images will be
3923 copied to the highest possible address in RAM; this
3924 is usually what you want since it allows for
3925 maximum initrd size. If for some reason you want to
3926 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003927 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003928 variable to a value of "no" or "off" or "0".
3929 Alternatively, you can set it to a maximum upper
3930 address to use (U-Boot will still check that it
3931 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk6c59edc2004-05-03 20:45:30 +00003933 For instance, when you have a system with 16 MB
3934 RAM, and want to reserve 4 MB from use by Linux,
3935 you can do this by adding "mem=12M" to the value of
3936 the "bootargs" variable. However, now you must make
3937 sure that the initrd image is placed in the first
3938 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk6c59edc2004-05-03 20:45:30 +00003940 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942 If you set initrd_high to 0xFFFFFFFF, this is an
3943 indication to U-Boot that all addresses are legal
3944 for the Linux kernel, including addresses in flash
3945 memory. In this case U-Boot will NOT COPY the
3946 ramdisk at all. This may be useful to reduce the
3947 boot time on your system, but requires that this
3948 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003949
wdenk6c59edc2004-05-03 20:45:30 +00003950 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk6c59edc2004-05-03 20:45:30 +00003952 loadaddr - Default load address for commands like "bootp",
3953 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk6c59edc2004-05-03 20:45:30 +00003955 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk6c59edc2004-05-03 20:45:30 +00003957 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003958
wdenk6c59edc2004-05-03 20:45:30 +00003959 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk6c59edc2004-05-03 20:45:30 +00003961 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk6c59edc2004-05-03 20:45:30 +00003963 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003964
Mike Frysingera23230c2011-10-02 10:01:27 +00003965 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003966
Mike Frysingera23230c2011-10-02 10:01:27 +00003967 ethact - controls which interface is currently active.
3968 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003969
Heiko Schocherc5e84052010-07-20 17:45:02 +02003970 => setenv ethact FEC
3971 => ping 192.168.0.1 # traffic sent on FEC
3972 => setenv ethact SCC
3973 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003974
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003975 ethrotate - When set to "no" U-Boot does not go through all
3976 available network interfaces.
3977 It just stays at the currently selected interface.
3978
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003979 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003980 either succeed or fail without retrying.
3981 When set to "once" the network operation will
3982 fail when all the available network interfaces
3983 are tried once without success.
3984 Useful on scripts which control the retry operation
3985 themselves.
wdenkc6097192002-11-03 00:24:07 +00003986
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003987 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003988
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003989 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003990 changing the console to be empty. If "yes" it will be
3991 made silent. If "no" it will not be made silent. If
3992 unset, then it will be made silent if the U-Boot console
3993 is silent.
3994
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003995 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003996 UDP source port.
3997
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003998 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003999 destination port instead of the Well Know Port 69.
4000
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004001 tftpblocksize - Block size to use for TFTP transfers; if not set,
4002 we use the TFTP server's default block size
4003
4004 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4005 seconds, minimum value is 1000 = 1 second). Defines
4006 when a packet is considered to be lost so it has to
4007 be retransmitted. The default is 5000 = 5 seconds.
4008 Lowering this value may make downloads succeed
4009 faster in networks with high packet loss rates or
4010 with unreliable TFTP servers.
4011
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004012 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4013 unit, minimum value = 0). Defines how many timeouts
4014 can happen during a single file transfer before that
4015 transfer is aborted. The default is 10, and 0 means
4016 'no timeouts allowed'. Increasing this value may help
4017 downloads succeed with high packet loss rates, or with
4018 unreliable TFTP servers or client hardware.
4019
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004020 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004021 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004022 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004023
Alexandre Messier15971322016-02-01 17:08:57 -05004024 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4025 Unsigned value, in milliseconds. If not set, the period will
4026 be either the default (28000), or a value based on
4027 CONFIG_NET_RETRY_COUNT, if defined. This value has
4028 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4029
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004030The following image location variables contain the location of images
4031used in booting. The "Image" column gives the role of the image and is
4032not an environment variable name. The other columns are environment
4033variable names. "File Name" gives the name of the file on a TFTP
4034server, "RAM Address" gives the location in RAM the image will be
4035loaded to, and "Flash Location" gives the image's address in NOR
4036flash or offset in NAND flash.
4037
4038*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004039boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004040boards use these variables for other purposes.
4041
Wolfgang Denk092ae952011-10-26 10:21:21 +00004042Image File Name RAM Address Flash Location
4043----- --------- ----------- --------------
4044u-boot u-boot u-boot_addr_r u-boot_addr
4045Linux kernel bootfile kernel_addr_r kernel_addr
4046device tree blob fdtfile fdt_addr_r fdt_addr
4047ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004048
wdenk6c59edc2004-05-03 20:45:30 +00004049The following environment variables may be used and automatically
4050updated by the network boot commands ("bootp" and "rarpboot"),
4051depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004052
wdenk6c59edc2004-05-03 20:45:30 +00004053 bootfile - see above
4054 dnsip - IP address of your Domain Name Server
4055 dnsip2 - IP address of your secondary Domain Name Server
4056 gatewayip - IP address of the Gateway (Router) to use
4057 hostname - Target hostname
4058 ipaddr - see above
4059 netmask - Subnet Mask
4060 rootpath - Pathname of the root filesystem on the NFS server
4061 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004062
wdenk145d2c12004-04-15 21:48:45 +00004063
wdenk6c59edc2004-05-03 20:45:30 +00004064There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066 serial# - contains hardware identification information such
4067 as type string and/or serial number
4068 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk6c59edc2004-05-03 20:45:30 +00004070These variables can be set only once (usually during manufacturing of
4071the board). U-Boot refuses to delete or overwrite these variables
4072once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004073
4074
wdenk6c59edc2004-05-03 20:45:30 +00004075Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk6c59edc2004-05-03 20:45:30 +00004077 ver - Contains the U-Boot version string as printed
4078 with the "version" command. This variable is
4079 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004080
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk6c59edc2004-05-03 20:45:30 +00004082Please note that changes to some configuration parameters may take
4083only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004084
stroeseb9c17c52003-04-04 15:53:41 +00004085
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004086Callback functions for environment variables:
4087---------------------------------------------
4088
4089For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004090when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004091be associated with arbitrary variables. On creation, overwrite, or
4092deletion, the callback will provide the opportunity for some side
4093effect to happen or for the change to be rejected.
4094
4095The callbacks are named and associated with a function using the
4096U_BOOT_ENV_CALLBACK macro in your board or driver code.
4097
4098These callbacks are associated with variables in one of two ways. The
4099static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4100in the board configuration to a string that defines a list of
4101associations. The list must be in the following format:
4102
4103 entry = variable_name[:callback_name]
4104 list = entry[,list]
4105
4106If the callback name is not specified, then the callback is deleted.
4107Spaces are also allowed anywhere in the list.
4108
4109Callbacks can also be associated by defining the ".callbacks" variable
4110with the same list format above. Any association in ".callbacks" will
4111override any association in the static list. You can define
4112CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004113".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004114
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004115If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4116regular expression. This allows multiple variables to be connected to
4117the same callback without explicitly listing them all out.
4118
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004119
wdenk6c59edc2004-05-03 20:45:30 +00004120Command Line Parsing:
4121=====================
stroeseb9c17c52003-04-04 15:53:41 +00004122
wdenk6c59edc2004-05-03 20:45:30 +00004123There are two different command line parsers available with U-Boot:
4124the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk6c59edc2004-05-03 20:45:30 +00004126Old, simple command line parser:
4127--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk6c59edc2004-05-03 20:45:30 +00004129- supports environment variables (through setenv / saveenv commands)
4130- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004131- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004132- special characters ('$', ';') can be escaped by prefixing with '\',
4133 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004134 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004135- You can also escape text by enclosing in single apostrophes, for example:
4136 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138Hush shell:
4139-----------
wdenkf4688a22003-05-28 08:06:31 +00004140
wdenk6c59edc2004-05-03 20:45:30 +00004141- similar to Bourne shell, with control structures like
4142 if...then...else...fi, for...do...done; while...do...done,
4143 until...do...done, ...
4144- supports environment ("global") variables (through setenv / saveenv
4145 commands) and local shell variables (through standard shell syntax
4146 "name=value"); only environment variables can be used with "run"
4147 command
wdenkf4688a22003-05-28 08:06:31 +00004148
wdenk6c59edc2004-05-03 20:45:30 +00004149General rules:
4150--------------
wdenkf4688a22003-05-28 08:06:31 +00004151
wdenk6c59edc2004-05-03 20:45:30 +00004152(1) If a command line (or an environment variable executed by a "run"
4153 command) contains several commands separated by semicolon, and
4154 one of these commands fails, then the remaining commands will be
4155 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004158 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004159 command will cause "run" to terminate, i. e. the remaining
4160 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004161
wdenk6c59edc2004-05-03 20:45:30 +00004162Note for Redundant Ethernet Interfaces:
4163=======================================
wdenkf4688a22003-05-28 08:06:31 +00004164
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004165Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004166such configurations and is capable of automatic selection of a
4167"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004168
wdenk6c59edc2004-05-03 20:45:30 +00004169Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4170MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4171"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004172
wdenk6c59edc2004-05-03 20:45:30 +00004173If the network interface stores some valid MAC address (for instance
4174in SROM), this is used as default address if there is NO correspon-
4175ding setting in the environment; if the corresponding environment
4176variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004177
wdenk6c59edc2004-05-03 20:45:30 +00004178o If the SROM has a valid MAC address, and there is no address in the
4179 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk6c59edc2004-05-03 20:45:30 +00004181o If there is no valid address in the SROM, and a definition in the
4182 environment exists, then the value from the environment variable is
4183 used.
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk6c59edc2004-05-03 20:45:30 +00004185o If both the SROM and the environment contain a MAC address, and
4186 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk6c59edc2004-05-03 20:45:30 +00004188o If both the SROM and the environment contain a MAC address, and the
4189 addresses differ, the value from the environment is used and a
4190 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004191
wdenk6c59edc2004-05-03 20:45:30 +00004192o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004193 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4194 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004195
Ben Warren6db991a2010-04-26 11:11:46 -07004196If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004197will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004198may be skipped by setting the appropriate 'ethmacskip' environment variable.
4199The naming convention is as follows:
4200"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004201
wdenk6c59edc2004-05-03 20:45:30 +00004202Image Formats:
4203==============
wdenkc6097192002-11-03 00:24:07 +00004204
Marian Balakowicz18710b82008-03-12 12:13:13 +01004205U-Boot is capable of booting (and performing other auxiliary operations on)
4206images in two formats:
4207
4208New uImage format (FIT)
4209-----------------------
4210
4211Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4212to Flattened Device Tree). It allows the use of images with multiple
4213components (several kernels, ramdisks, etc.), with contents protected by
4214SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4215
4216
4217Old uImage format
4218-----------------
4219
4220Old image format is based on binary files which can be basically anything,
4221preceded by a special header; see the definitions in include/image.h for
4222details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk6c59edc2004-05-03 20:45:30 +00004224* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4225 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004226 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4227 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4228 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004229* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004230 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004231 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004232* Compression Type (uncompressed, gzip, bzip2)
4233* Load Address
4234* Entry Point
4235* Image Name
4236* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004237
wdenk6c59edc2004-05-03 20:45:30 +00004238The header is marked by a special Magic Number, and both the header
4239and the data portions of the image are secured against corruption by
4240CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004241
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk6c59edc2004-05-03 20:45:30 +00004243Linux Support:
4244==============
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246Although U-Boot should support any OS or standalone application
4247easily, the main focus has always been on Linux during the design of
4248U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk6c59edc2004-05-03 20:45:30 +00004250U-Boot includes many features that so far have been part of some
4251special "boot loader" code within the Linux kernel. Also, any
4252"initrd" images to be used are no longer part of one big Linux image;
4253instead, kernel and "initrd" are separate images. This implementation
4254serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk6c59edc2004-05-03 20:45:30 +00004256- the same features can be used for other OS or standalone
4257 applications (for instance: using compressed images to reduce the
4258 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk6c59edc2004-05-03 20:45:30 +00004260- it becomes much easier to port new Linux kernel versions because
4261 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004262
wdenk6c59edc2004-05-03 20:45:30 +00004263- the same Linux kernel image can now be used with different "initrd"
4264 images; of course this also means that different kernel images can
4265 be run with the same "initrd". This makes testing easier (you don't
4266 have to build a new "zImage.initrd" Linux image when you just
4267 change a file in your "initrd"). Also, a field-upgrade of the
4268 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004269
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271Linux HOWTO:
4272============
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk6c59edc2004-05-03 20:45:30 +00004274Porting Linux to U-Boot based systems:
4275---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk6c59edc2004-05-03 20:45:30 +00004277U-Boot cannot save you from doing all the necessary modifications to
4278configure the Linux device drivers for use with your target hardware
4279(no, we don't intend to provide a full virtual machine interface to
4280Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004281
Stefan Roese88fbf932010-04-15 16:07:28 +02004282But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk6c59edc2004-05-03 20:45:30 +00004284Just make sure your machine specific header file (for instance
4285include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004286Information structure as we define in include/asm-<arch>/u-boot.h,
4287and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004288as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004289
Simon Glassd097e592014-06-11 23:29:46 -06004290Note that U-Boot now has a driver model, a unified model for drivers.
4291If you are adding a new driver, plumb it into driver model. If there
4292is no uclass available, you are encouraged to create one. See
4293doc/driver-model.
4294
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk6c59edc2004-05-03 20:45:30 +00004296Configuring the Linux kernel:
4297-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004298
wdenk6c59edc2004-05-03 20:45:30 +00004299No specific requirements for U-Boot. Make sure you have some root
4300device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004301
wdenkc6097192002-11-03 00:24:07 +00004302
wdenk6c59edc2004-05-03 20:45:30 +00004303Building a Linux Image:
4304-----------------------
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4307not used. If you use recent kernel source, a new build target
4308"uImage" will exist which automatically builds an image usable by
4309U-Boot. Most older kernels also have support for a "pImage" target,
4310which was introduced for our predecessor project PPCBoot and uses a
4311100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004312
wdenk6c59edc2004-05-03 20:45:30 +00004313Example:
wdenkc6097192002-11-03 00:24:07 +00004314
Holger Freyther7ba4e572014-08-04 09:26:05 +02004315 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004316 make oldconfig
4317 make dep
4318 make uImage
wdenkc6097192002-11-03 00:24:07 +00004319
wdenk6c59edc2004-05-03 20:45:30 +00004320The "uImage" build target uses a special tool (in 'tools/mkimage') to
4321encapsulate a compressed Linux kernel image with header information,
4322CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk6c59edc2004-05-03 20:45:30 +00004324* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk6c59edc2004-05-03 20:45:30 +00004326* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk6c59edc2004-05-03 20:45:30 +00004328 ${CROSS_COMPILE}-objcopy -O binary \
4329 -R .note -R .comment \
4330 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004333
wdenk6c59edc2004-05-03 20:45:30 +00004334 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004337
wdenk6c59edc2004-05-03 20:45:30 +00004338 mkimage -A ppc -O linux -T kernel -C gzip \
4339 -a 0 -e 0 -n "Linux Kernel Image" \
4340 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004341
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk6c59edc2004-05-03 20:45:30 +00004343The "mkimage" tool can also be used to create ramdisk images for use
4344with U-Boot, either separated from the Linux kernel image, or
4345combined into one file. "mkimage" encapsulates the images with a 64
4346byte header containing information about target architecture,
4347operating system, image type, compression method, entry points, time
4348stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk6c59edc2004-05-03 20:45:30 +00004350"mkimage" can be called in two ways: to verify existing images and
4351print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353In the first form (with "-l" option) mkimage lists the information
4354contained in the header of an existing U-Boot image; this includes
4355checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004356
wdenk6c59edc2004-05-03 20:45:30 +00004357 tools/mkimage -l image
4358 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004359
wdenk6c59edc2004-05-03 20:45:30 +00004360The second form (with "-d" option) is used to build a U-Boot image
4361from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004362
wdenk6c59edc2004-05-03 20:45:30 +00004363 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4364 -n name -d data_file image
4365 -A ==> set architecture to 'arch'
4366 -O ==> set operating system to 'os'
4367 -T ==> set image type to 'type'
4368 -C ==> set compression type 'comp'
4369 -a ==> set load address to 'addr' (hex)
4370 -e ==> set entry point to 'ep' (hex)
4371 -n ==> set image name to 'name'
4372 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004373
wdenkcd914452004-05-29 16:53:29 +00004374Right now, all Linux kernels for PowerPC systems use the same load
4375address (0x00000000), but the entry point address depends on the
4376kernel version:
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk6c59edc2004-05-03 20:45:30 +00004378- 2.2.x kernels have the entry point at 0x0000000C,
4379- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk6c59edc2004-05-03 20:45:30 +00004381So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4384 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004385 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004386 > examples/uImage.TQM850L
4387 Image Name: 2.4.4 kernel for TQM850L
4388 Created: Wed Jul 19 02:34:59 2000
4389 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4390 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4391 Load Address: 0x00000000
4392 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk6c59edc2004-05-03 20:45:30 +00004394To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004395
wdenk6c59edc2004-05-03 20:45:30 +00004396 -> tools/mkimage -l examples/uImage.TQM850L
4397 Image Name: 2.4.4 kernel for TQM850L
4398 Created: Wed Jul 19 02:34:59 2000
4399 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4400 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4401 Load Address: 0x00000000
4402 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404NOTE: for embedded systems where boot time is critical you can trade
4405speed for memory and install an UNCOMPRESSED image instead: this
4406needs more space in Flash, but boots much faster since it does not
4407need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004408
Stefan Roese88fbf932010-04-15 16:07:28 +02004409 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004410 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4411 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004412 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004413 > examples/uImage.TQM850L-uncompressed
4414 Image Name: 2.4.4 kernel for TQM850L
4415 Created: Wed Jul 19 02:34:59 2000
4416 Image Type: PowerPC Linux Kernel Image (uncompressed)
4417 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4418 Load Address: 0x00000000
4419 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004420
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk6c59edc2004-05-03 20:45:30 +00004422Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4423when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425 -> tools/mkimage -n 'Simple Ramdisk Image' \
4426 > -A ppc -O linux -T ramdisk -C gzip \
4427 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4428 Image Name: Simple Ramdisk Image
4429 Created: Wed Jan 12 14:01:50 2000
4430 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4431 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4432 Load Address: 0x00000000
4433 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004434
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004435The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4436option performs the converse operation of the mkimage's second form (the "-d"
4437option). Given an image built by mkimage, the dumpimage extracts a "data file"
4438from the image:
4439
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004440 tools/dumpimage -i image -T type -p position data_file
4441 -i ==> extract from the 'image' a specific 'data_file'
4442 -T ==> set image type to 'type'
4443 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004444
wdenkc6097192002-11-03 00:24:07 +00004445
wdenk6c59edc2004-05-03 20:45:30 +00004446Installing a Linux Image:
4447-------------------------
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk6c59edc2004-05-03 20:45:30 +00004449To downloading a U-Boot image over the serial (console) interface,
4450you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004451
wdenk6c59edc2004-05-03 20:45:30 +00004452 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk6c59edc2004-05-03 20:45:30 +00004454The 'objcopy' does not understand the information in the U-Boot
4455image header, so the resulting S-Record file will be relative to
4456address 0x00000000. To load it to a given address, you need to
4457specify the target address as 'offset' parameter with the 'loads'
4458command.
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk6c59edc2004-05-03 20:45:30 +00004460Example: install the image to address 0x40100000 (which on the
4461TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004462
wdenk6c59edc2004-05-03 20:45:30 +00004463 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk6c59edc2004-05-03 20:45:30 +00004465 .......... done
4466 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk6c59edc2004-05-03 20:45:30 +00004468 => loads 40100000
4469 ## Ready for S-Record download ...
4470 ~>examples/image.srec
4471 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4472 ...
4473 15989 15990 15991 15992
4474 [file transfer complete]
4475 [connected]
4476 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004477
wdenkc6097192002-11-03 00:24:07 +00004478
wdenk6c59edc2004-05-03 20:45:30 +00004479You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004480this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004481corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk6c59edc2004-05-03 20:45:30 +00004483 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485 ## Checking Image at 40100000 ...
4486 Image Name: 2.2.13 for initrd on TQM850L
4487 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4488 Data Size: 335725 Bytes = 327 kB = 0 MB
4489 Load Address: 00000000
4490 Entry Point: 0000000c
4491 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004492
4493
wdenk6c59edc2004-05-03 20:45:30 +00004494Boot Linux:
4495-----------
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk6c59edc2004-05-03 20:45:30 +00004497The "bootm" command is used to boot an application that is stored in
4498memory (RAM or Flash). In case of a Linux kernel image, the contents
4499of the "bootargs" environment variable is passed to the kernel as
4500parameters. You can check and modify this variable using the
4501"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004502
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk6c59edc2004-05-03 20:45:30 +00004504 => printenv bootargs
4505 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004506
wdenk6c59edc2004-05-03 20:45:30 +00004507 => 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 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509 => printenv bootargs
4510 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 +00004511
wdenk6c59edc2004-05-03 20:45:30 +00004512 => bootm 40020000
4513 ## Booting Linux kernel at 40020000 ...
4514 Image Name: 2.2.13 for NFS on TQM850L
4515 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4516 Data Size: 381681 Bytes = 372 kB = 0 MB
4517 Load Address: 00000000
4518 Entry Point: 0000000c
4519 Verifying Checksum ... OK
4520 Uncompressing Kernel Image ... OK
4521 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
4522 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4523 time_init: decrementer frequency = 187500000/60
4524 Calibrating delay loop... 49.77 BogoMIPS
4525 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4526 ...
wdenkc6097192002-11-03 00:24:07 +00004527
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004528If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004529the memory addresses of both the kernel and the initrd image (PPBCOOT
4530format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534 ## Checking Image at 40100000 ...
4535 Image Name: 2.2.13 for initrd on TQM850L
4536 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4537 Data Size: 335725 Bytes = 327 kB = 0 MB
4538 Load Address: 00000000
4539 Entry Point: 0000000c
4540 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542 ## Checking Image at 40200000 ...
4543 Image Name: Simple Ramdisk Image
4544 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4545 Data Size: 566530 Bytes = 553 kB = 0 MB
4546 Load Address: 00000000
4547 Entry Point: 00000000
4548 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550 => bootm 40100000 40200000
4551 ## Booting Linux kernel at 40100000 ...
4552 Image Name: 2.2.13 for initrd on TQM850L
4553 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4554 Data Size: 335725 Bytes = 327 kB = 0 MB
4555 Load Address: 00000000
4556 Entry Point: 0000000c
4557 Verifying Checksum ... OK
4558 Uncompressing Kernel Image ... OK
4559 ## Loading RAMDisk Image at 40200000 ...
4560 Image Name: Simple Ramdisk Image
4561 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4562 Data Size: 566530 Bytes = 553 kB = 0 MB
4563 Load Address: 00000000
4564 Entry Point: 00000000
4565 Verifying Checksum ... OK
4566 Loading Ramdisk ... OK
4567 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
4568 Boot arguments: root=/dev/ram
4569 time_init: decrementer frequency = 187500000/60
4570 Calibrating delay loop... 49.77 BogoMIPS
4571 ...
4572 RAMDISK: Compressed image found at block 0
4573 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004574
wdenk6c59edc2004-05-03 20:45:30 +00004575 bash#
wdenkc6097192002-11-03 00:24:07 +00004576
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004577Boot Linux and pass a flat device tree:
4578-----------
4579
4580First, U-Boot must be compiled with the appropriate defines. See the section
4581titled "Linux Kernel Interface" above for a more in depth explanation. The
4582following is an example of how to start a kernel and pass an updated
4583flat device tree:
4584
4585=> print oftaddr
4586oftaddr=0x300000
4587=> print oft
4588oft=oftrees/mpc8540ads.dtb
4589=> tftp $oftaddr $oft
4590Speed: 1000, full duplex
4591Using TSEC0 device
4592TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4593Filename 'oftrees/mpc8540ads.dtb'.
4594Load address: 0x300000
4595Loading: #
4596done
4597Bytes transferred = 4106 (100a hex)
4598=> tftp $loadaddr $bootfile
4599Speed: 1000, full duplex
4600Using TSEC0 device
4601TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4602Filename 'uImage'.
4603Load address: 0x200000
4604Loading:############
4605done
4606Bytes transferred = 1029407 (fb51f hex)
4607=> print loadaddr
4608loadaddr=200000
4609=> print oftaddr
4610oftaddr=0x300000
4611=> bootm $loadaddr - $oftaddr
4612## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004613 Image Name: Linux-2.6.17-dirty
4614 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4615 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004616 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004617 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004618 Verifying Checksum ... OK
4619 Uncompressing Kernel Image ... OK
4620Booting using flat device tree at 0x300000
4621Using MPC85xx ADS machine description
4622Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4623[snip]
4624
4625
wdenk6c59edc2004-05-03 20:45:30 +00004626More About U-Boot Image Types:
4627------------------------------
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk6c59edc2004-05-03 20:45:30 +00004629U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk6c59edc2004-05-03 20:45:30 +00004631 "Standalone Programs" are directly runnable in the environment
4632 provided by U-Boot; it is expected that (if they behave
4633 well) you can continue to work in U-Boot after return from
4634 the Standalone Program.
4635 "OS Kernel Images" are usually images of some Embedded OS which
4636 will take over control completely. Usually these programs
4637 will install their own set of exception handlers, device
4638 drivers, set up the MMU, etc. - this means, that you cannot
4639 expect to re-enter U-Boot except by resetting the CPU.
4640 "RAMDisk Images" are more or less just data blocks, and their
4641 parameters (address, size) are passed to an OS kernel that is
4642 being started.
4643 "Multi-File Images" contain several images, typically an OS
4644 (Linux) kernel image and one or more data images like
4645 RAMDisks. This construct is useful for instance when you want
4646 to boot over the network using BOOTP etc., where the boot
4647 server provides just a single image file, but you want to get
4648 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk6c59edc2004-05-03 20:45:30 +00004650 "Multi-File Images" start with a list of image sizes, each
4651 image size (in bytes) specified by an "uint32_t" in network
4652 byte order. This list is terminated by an "(uint32_t)0".
4653 Immediately after the terminating 0 follow the images, one by
4654 one, all aligned on "uint32_t" boundaries (size rounded up to
4655 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657 "Firmware Images" are binary images containing firmware (like
4658 U-Boot or FPGA images) which usually will be programmed to
4659 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661 "Script files" are command sequences that will be executed by
4662 U-Boot's command interpreter; this feature is especially
4663 useful when you configure U-Boot to use a real shell (hush)
4664 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004665
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004666Booting the Linux zImage:
4667-------------------------
4668
4669On some platforms, it's possible to boot Linux zImage. This is done
4670using the "bootz" command. The syntax of "bootz" command is the same
4671as the syntax of "bootm" command.
4672
Tom Rini45f46d12013-05-16 11:40:11 -04004673Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004674kernel with raw initrd images. The syntax is slightly different, the
4675address of the initrd must be augmented by it's size, in the following
4676format: "<initrd addres>:<initrd size>".
4677
stroeseb9c17c52003-04-04 15:53:41 +00004678
wdenk6c59edc2004-05-03 20:45:30 +00004679Standalone HOWTO:
4680=================
stroeseb9c17c52003-04-04 15:53:41 +00004681
wdenk6c59edc2004-05-03 20:45:30 +00004682One of the features of U-Boot is that you can dynamically load and
4683run "standalone" applications, which can use some resources of
4684U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004685
wdenk6c59edc2004-05-03 20:45:30 +00004686Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688"Hello World" Demo:
4689-------------------
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk6c59edc2004-05-03 20:45:30 +00004691'examples/hello_world.c' contains a small "Hello World" Demo
4692application; it is automatically compiled when you build U-Boot.
4693It's configured to run at address 0x00040004, so you can play with it
4694like that:
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 => loads
4697 ## Ready for S-Record download ...
4698 ~>examples/hello_world.srec
4699 1 2 3 4 5 6 7 8 9 10 11 ...
4700 [file transfer complete]
4701 [connected]
4702 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004703
wdenk6c59edc2004-05-03 20:45:30 +00004704 => go 40004 Hello World! This is a test.
4705 ## Starting application at 0x00040004 ...
4706 Hello World
4707 argc = 7
4708 argv[0] = "40004"
4709 argv[1] = "Hello"
4710 argv[2] = "World!"
4711 argv[3] = "This"
4712 argv[4] = "is"
4713 argv[5] = "a"
4714 argv[6] = "test."
4715 argv[7] = "<NULL>"
4716 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk6c59edc2004-05-03 20:45:30 +00004718 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720Another example, which demonstrates how to register a CPM interrupt
4721handler with the U-Boot code, can be found in 'examples/timer.c'.
4722Here, a CPM timer is set up to generate an interrupt every second.
4723The interrupt service routine is trivial, just printing a '.'
4724character, but this is just a demo program. The application can be
4725controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk6c59edc2004-05-03 20:45:30 +00004727 ? - print current values og the CPM Timer registers
4728 b - enable interrupts and start timer
4729 e - stop timer and disable interrupts
4730 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk6c59edc2004-05-03 20:45:30 +00004732 => loads
4733 ## Ready for S-Record download ...
4734 ~>examples/timer.srec
4735 1 2 3 4 5 6 7 8 9 10 11 ...
4736 [file transfer complete]
4737 [connected]
4738 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740 => go 40004
4741 ## Starting application at 0x00040004 ...
4742 TIMERS=0xfff00980
4743 Using timer 1
4744 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004745
wdenk6c59edc2004-05-03 20:45:30 +00004746Hit 'b':
4747 [q, b, e, ?] Set interval 1000000 us
4748 Enabling timer
4749Hit '?':
4750 [q, b, e, ?] ........
4751 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4752Hit '?':
4753 [q, b, e, ?] .
4754 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4755Hit '?':
4756 [q, b, e, ?] .
4757 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4758Hit '?':
4759 [q, b, e, ?] .
4760 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4761Hit 'e':
4762 [q, b, e, ?] ...Stopping timer
4763Hit 'q':
4764 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004765
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk6c59edc2004-05-03 20:45:30 +00004767Minicom warning:
4768================
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk6c59edc2004-05-03 20:45:30 +00004770Over time, many people have reported problems when trying to use the
4771"minicom" terminal emulation program for serial download. I (wd)
4772consider minicom to be broken, and recommend not to use it. Under
4773Unix, I recommend to use C-Kermit for general purpose use (and
4774especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004775use "cu" for S-Record download ("loads" command). See
4776http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4777for help with kermit.
4778
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk6c59edc2004-05-03 20:45:30 +00004780Nevertheless, if you absolutely want to use it try adding this
4781configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk6c59edc2004-05-03 20:45:30 +00004783 Name Program Name U/D FullScr IO-Red. Multi
4784 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4785 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004786
wdenk8dba0502003-03-31 16:34:49 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788NetBSD Notes:
4789=============
wdenkc6097192002-11-03 00:24:07 +00004790
wdenk6c59edc2004-05-03 20:45:30 +00004791Starting at version 0.9.2, U-Boot supports NetBSD both as host
4792(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004793
wdenk6c59edc2004-05-03 20:45:30 +00004794Building requires a cross environment; it is known to work on
4795NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4796need gmake since the Makefiles are not compatible with BSD make).
4797Note that the cross-powerpc package does not install include files;
4798attempting to build U-Boot will fail because <machine/ansi.h> is
4799missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004800
wdenk6c59edc2004-05-03 20:45:30 +00004801 # cd /usr/pkg/cross/powerpc-netbsd/include
4802 # mkdir powerpc
4803 # ln -s powerpc machine
4804 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4805 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004806
wdenk6c59edc2004-05-03 20:45:30 +00004807Native builds *don't* work due to incompatibilities between native
4808and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk6c59edc2004-05-03 20:45:30 +00004810Booting assumes that (the first part of) the image booted is a
4811stage-2 loader which in turn loads and then invokes the kernel
4812proper. Loader sources will eventually appear in the NetBSD source
4813tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004814meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004815
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk6c59edc2004-05-03 20:45:30 +00004817Implementation Internals:
4818=========================
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820The following is not intended to be a complete description of every
4821implementation detail. However, it should help to understand the
4822inner workings of U-Boot and make it easier to port it to custom
4823hardware.
wdenkc6097192002-11-03 00:24:07 +00004824
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk6c59edc2004-05-03 20:45:30 +00004826Initial Stack, Global Data:
4827---------------------------
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829The implementation of U-Boot is complicated by the fact that U-Boot
4830starts running out of ROM (flash memory), usually without access to
4831system RAM (because the memory controller is not initialized yet).
4832This means that we don't have writable Data or BSS segments, and BSS
4833is not initialized as zero. To be able to get a C environment working
4834at all, we have to allocate at least a minimal stack. Implementation
4835options for this are defined and restricted by the CPU used: Some CPU
4836models provide on-chip memory (like the IMMR area on MPC8xx and
4837MPC826x processors), on others (parts of) the data cache can be
4838locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004839
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004840 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004841 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk6c59edc2004-05-03 20:45:30 +00004843 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4844 From: "Chris Hallinan" <clh@net1plus.com>
4845 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4846 ...
wdenkc6097192002-11-03 00:24:07 +00004847
wdenk6c59edc2004-05-03 20:45:30 +00004848 Correct me if I'm wrong, folks, but the way I understand it
4849 is this: Using DCACHE as initial RAM for Stack, etc, does not
4850 require any physical RAM backing up the cache. The cleverness
4851 is that the cache is being used as a temporary supply of
4852 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004853 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004854 can see how this works by studying the cache architecture and
4855 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4858 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004859 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004860 option should work for you. Using CS 4 should be fine if your
4861 board designers haven't used it for something that would
4862 cause you grief during the initial boot! It is frequently not
4863 used.
wdenkc6097192002-11-03 00:24:07 +00004864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004865 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004866 with your processor/board/system design. The default value
4867 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004868 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004869 than your SDRAM module. If you have a 64MB SDRAM module, set
4870 it above 400_0000. Just make sure your board has no resources
4871 that are supposed to respond to that address! That code in
4872 start.S has been around a while and should work as is when
4873 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875 -Chris Hallinan
4876 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004877
wdenk6c59edc2004-05-03 20:45:30 +00004878It is essential to remember this, since it has some impact on the C
4879code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881* Initialized global data (data segment) is read-only. Do not attempt
4882 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004883
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004884* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004885 as zero data - BSS segment) at all - this is undefined, initiali-
4886 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004887
wdenk6c59edc2004-05-03 20:45:30 +00004888* Stack space is very limited. Avoid big data buffers or things like
4889 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004892normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004893turned out that the implementation of U-Boot can be greatly
4894simplified by making a global data structure (gd_t) available to all
4895functions. We could pass a pointer to this data as argument to _all_
4896functions, but this would bloat the code. Instead we use a feature of
4897the GCC compiler (Global Register Variables) to share the data: we
4898place a pointer (gd) to the global data into a register which we
4899reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901When choosing a register for such a purpose we are restricted by the
4902relevant (E)ABI specifications for the current architecture, and by
4903GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004904
wdenk6c59edc2004-05-03 20:45:30 +00004905For PowerPC, the following registers have specific use:
4906 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004907 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004908 R3-R4: parameter passing and return values
4909 R5-R10: parameter passing
4910 R13: small data area pointer
4911 R30: GOT pointer
4912 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004913
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004914 (U-Boot also uses R12 as internal GOT pointer. r12
4915 is a volatile register so r12 needs to be reset when
4916 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004917
Wolfgang Denk69c09642008-02-14 22:43:22 +01004918 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004919
wdenk6c59edc2004-05-03 20:45:30 +00004920 Note: on PPC, we could use a static initializer (since the
4921 address of the global data structure is known at compile time),
4922 but it turned out that reserving a register results in somewhat
4923 smaller code - although the code savings are not that big (on
4924 average for all boards 752 bytes for the whole U-Boot image,
4925 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk6c59edc2004-05-03 20:45:30 +00004929 R0: function argument word/integer result
4930 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004931 R9: platform specific
4932 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004933 R11: argument (frame) pointer
4934 R12: temporary workspace
4935 R13: stack pointer
4936 R14: link register
4937 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004938
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004939 ==> U-Boot will use R9 to hold a pointer to the global data
4940
4941 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004942
Thomas Chou8fa38582010-05-21 11:08:03 +08004943On Nios II, the ABI is documented here:
4944 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4945
4946 ==> U-Boot will use gp to hold a pointer to the global data
4947
4948 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4949 to access small data sections, so gp is free.
4950
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004951On NDS32, the following registers are used:
4952
4953 R0-R1: argument/return
4954 R2-R5: argument
4955 R15: temporary register for assembler
4956 R16: trampoline register
4957 R28: frame pointer (FP)
4958 R29: global pointer (GP)
4959 R30: link register (LP)
4960 R31: stack pointer (SP)
4961 PC: program counter (PC)
4962
4963 ==> U-Boot will use R10 to hold a pointer to the global data
4964
Wolfgang Denk6405a152006-03-31 18:32:53 +02004965NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4966or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968Memory Management:
4969------------------
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971U-Boot runs in system state and uses physical addresses, i.e. the
4972MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974The available memory is mapped to fixed addresses using the memory
4975controller. In this process, a contiguous block is formed for each
4976memory type (Flash, SDRAM, SRAM), even when it consists of several
4977physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979U-Boot is installed in the first 128 kB of the first Flash bank (on
4980TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4981booting and sizing and initializing DRAM, the code relocates itself
4982to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004983memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004984configuration setting]. Below that, a structure with global Board
4985Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk6c59edc2004-05-03 20:45:30 +00004987Additionally, some exception handler code is copied to the low 8 kB
4988of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990So a typical memory configuration with 16 MB of DRAM could look like
4991this:
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk6c59edc2004-05-03 20:45:30 +00004993 0x0000 0000 Exception Vector code
4994 :
4995 0x0000 1FFF
4996 0x0000 2000 Free for Application Use
4997 :
4998 :
wdenkc6097192002-11-03 00:24:07 +00004999
wdenk6c59edc2004-05-03 20:45:30 +00005000 :
5001 :
5002 0x00FB FF20 Monitor Stack (Growing downward)
5003 0x00FB FFAC Board Info Data and permanent copy of global data
5004 0x00FC 0000 Malloc Arena
5005 :
5006 0x00FD FFFF
5007 0x00FE 0000 RAM Copy of Monitor Code
5008 ... eventually: LCD or video framebuffer
5009 ... eventually: pRAM (Protected RAM - unchanged by reset)
5010 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005011
wdenkc6097192002-11-03 00:24:07 +00005012
wdenk6c59edc2004-05-03 20:45:30 +00005013System Initialization:
5014----------------------
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk6c59edc2004-05-03 20:45:30 +00005016In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005017(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005018configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005019To be able to re-map memory U-Boot then jumps to its link address.
5020To be able to implement the initialization code in C, a (small!)
5021initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005022which provide such a feature like), or in a locked part of the data
5023cache. After that, U-Boot initializes the CPU core, the caches and
5024the SIU.
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026Next, all (potentially) available memory banks are mapped using a
5027preliminary mapping. For example, we put them on 512 MB boundaries
5028(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5029on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5030programmed for SDRAM access. Using the temporary configuration, a
5031simple memory test is run that determines the size of the SDRAM
5032banks.
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034When there is more than one SDRAM bank, and the banks are of
5035different size, the largest is mapped first. For equal size, the first
5036bank (CS2#) is mapped first. The first mapping is always for address
50370x00000000, with any additional banks following immediately to create
5038contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040Then, the monitor installs itself at the upper end of the SDRAM area
5041and allocates memory for use by malloc() and for the global Board
5042Info data; also, the exception vector code is copied to the low RAM
5043pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045Only after this relocation will you have a "normal" C environment;
5046until that you are restricted in several ways, mostly because you are
5047running from ROM, and because the code will have to be relocated to a
5048new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005049
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051U-Boot Porting Guide:
5052----------------------
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5055list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005056
wdenkc6097192002-11-03 00:24:07 +00005057
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005058int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005059{
5060 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005061
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005062 signal(SIGALRM, no_more_time);
5063 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk6c59edc2004-05-03 20:45:30 +00005065 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005066 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005067 return 0;
5068 }
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk6c59edc2004-05-03 20:45:30 +00005070 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005071
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005072 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005073
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005074 if (clueless)
5075 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077 while (learning) {
5078 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005079 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5080 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005081 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005082 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005083 }
wdenkc6097192002-11-03 00:24:07 +00005084
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005085 if (available_money > toLocalCurrency ($2500))
5086 Buy a BDI3000;
5087 else
wdenk6c59edc2004-05-03 20:45:30 +00005088 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005089
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005090 if (a similar board exists) { /* hopefully... */
5091 cp -a board/<similar> board/<myboard>
5092 cp include/configs/<similar>.h include/configs/<myboard>.h
5093 } else {
5094 Create your own board support subdirectory;
5095 Create your own board include/configs/<myboard>.h file;
5096 }
5097 Edit new board/<myboard> files
5098 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005099
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005100 while (!accepted) {
5101 while (!running) {
5102 do {
5103 Add / modify source code;
5104 } until (compiles);
5105 Debug;
5106 if (clueless)
5107 email("Hi, I am having problems...");
5108 }
5109 Send patch file to the U-Boot email list;
5110 if (reasonable critiques)
5111 Incorporate improvements from email list code review;
5112 else
5113 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005114 }
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116 return 0;
5117}
wdenkc6097192002-11-03 00:24:07 +00005118
wdenk6c59edc2004-05-03 20:45:30 +00005119void no_more_time (int sig)
5120{
5121 hire_a_guru();
5122}
wdenkc6097192002-11-03 00:24:07 +00005123
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125Coding Standards:
5126-----------------
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005129coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005130"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005131
5132Source files originating from a different project (for example the
5133MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005134reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005135sources.
wdenkc6097192002-11-03 00:24:07 +00005136
Detlev Zundelaa63d482006-09-01 15:39:02 +02005137Please note that U-Boot is implemented in C (and to some small parts in
5138Assembler); no C++ is used, so please do not use C++ style comments (//)
5139in your code.
wdenkad276f22004-01-04 16:28:35 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141Please also stick to the following formatting rules:
5142- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005143- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005144- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005145- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005146- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk6c59edc2004-05-03 20:45:30 +00005148Submissions which do not conform to the standards may be returned
5149with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005150
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk6c59edc2004-05-03 20:45:30 +00005152Submitting Patches:
5153-------------------
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155Since the number of patches for U-Boot is growing, we need to
5156establish some rules. Submissions which do not conform to these rules
5157may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005158
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005159Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005160
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005161Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5162see http://lists.denx.de/mailman/listinfo/u-boot
5163
wdenk6c59edc2004-05-03 20:45:30 +00005164When you send a patch, please include the following information with
5165it:
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167* For bug fixes: a description of the bug and how your patch fixes
5168 this bug. Please try to include a way of demonstrating that the
5169 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +00005171* For new features: a description of the feature and your
5172 implementation.
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005175
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005176* For major contributions, add a MAINTAINERS file with your
5177 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005178
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005179* When you add support for a new board, don't forget to add a
5180 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182* If your patch adds new configuration options, don't forget to
5183 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005184
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005185* The patch itself. If you are using git (which is *strongly*
5186 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005187 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005188 the U-Boot mailing list, you will avoid most of the common problems
5189 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005190
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005191 If you cannot use git, use "diff -purN OLD NEW". If your version of
5192 diff does not support these options, then get the latest version of
5193 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005194
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005195 The current directory when running this command shall be the parent
5196 directory of the U-Boot source tree (i. e. please make sure that
5197 your patch includes sufficient directory information for the
5198 affected files).
5199
5200 We prefer patches as plain text. MIME attachments are discouraged,
5201 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203* If one logical set of modifications affects or creates several
5204 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206* Changesets that contain different, unrelated modifications shall be
5207 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005208
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +00005210Notes:
wdenkc6097192002-11-03 00:24:07 +00005211
Simon Glassdc27def2016-07-27 20:33:08 -06005212* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005213 source tree and make sure that no errors or warnings are reported
5214 for any of the boards.
5215
5216* Keep your modifications to the necessary minimum: A patch
5217 containing several unrelated changes or arbitrary reformats will be
5218 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220* If you modify existing code, make sure that your new code does not
5221 add to the memory footprint of the code ;-) Small is beautiful!
5222 When adding new features, these should compile conditionally only
5223 (using #ifdef), and the resulting code with the new feature
5224 disabled must not need more memory than the old code without your
5225 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005226
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005227* Remember that there is a size limit of 100 kB per message on the
5228 u-boot mailing list. Bigger patches will be moderated. If they are
5229 reasonable and not too big, they will be acknowledged. But patches
5230 bigger than the size limit should be avoided.