blob: a46850c8085d5ced315e54cea8e18269367687a5 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500146 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500147 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400148 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149/api Machine/arch independent API for external apps
150/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800151/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500153/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500154/disk Code for disk drive partition handling
155/doc Documentation (don't expect too much)
156/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400157/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500158/examples Example code for standalone applications, etc.
159/fs Filesystem code (cramfs, ext2, jffs2, etc.)
160/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500161/lib Library routines generic to all architectures
162/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500163/net Networking code
164/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500165/scripts Various build scripts and Makefiles
166/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500167/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000168
wdenkc6097192002-11-03 00:24:07 +0000169Software Configuration:
170=======================
171
172Configuration is usually done using C preprocessor defines; the
173rationale behind that is to avoid dead code whenever possible.
174
175There are two classes of configuration variables:
176
177* Configuration _OPTIONS_:
178 These are selectable by the user and have names beginning with
179 "CONFIG_".
180
181* Configuration _SETTINGS_:
182 These depend on the hardware etc. and should not be meddled with if
183 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200184 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000185
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500186Previously, all configuration was done by hand, which involved creating
187symbolic links and editing configuration files manually. More recently,
188U-Boot has added the Kbuild infrastructure used by the Linux kernel,
189allowing you to use the "make menuconfig" command to configure your
190build.
wdenkc6097192002-11-03 00:24:07 +0000191
192
193Selection of Processor Architecture and Board Type:
194---------------------------------------------------
195
196For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200197configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000198
199Example: For a TQM823L module type:
200
201 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200202 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000203
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500204Note: If you're looking for the default configuration file for a board
205you're sure used to be there but is now missing, check the file
206doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000207
Simon Glass53552c92014-03-22 17:12:59 -0600208Sandbox Environment:
209--------------------
210
211U-Boot can be built natively to run on a Linux host using the 'sandbox'
212board. This allows feature development which is not board- or architecture-
213specific to be undertaken on a native platform. The sandbox is also used to
214run some of U-Boot's tests.
215
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530216See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600217
218
Simon Glassd8711af2015-03-03 08:03:00 -0700219Board Initialisation Flow:
220--------------------------
221
222This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500223SPL and U-Boot proper (i.e. they both follow the same rules).
224
225Note: "SPL" stands for "Secondary Program Loader," which is explained in
226more detail later in this file.
227
228At present, SPL mostly uses a separate code path, but the function names
229and roles of each function are the same. Some boards or architectures
230may not conform to this. At least most ARM boards which use
231CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700232
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500233Execution typically starts with an architecture-specific (and possibly
234CPU-specific) start.S file, such as:
235
236 - arch/arm/cpu/armv7/start.S
237 - arch/powerpc/cpu/mpc83xx/start.S
238 - arch/mips/cpu/start.S
239
240and so on. From there, three functions are called; the purpose and
241limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700242
243lowlevel_init():
244 - purpose: essential init to permit execution to reach board_init_f()
245 - no global_data or BSS
246 - there is no stack (ARMv7 may have one but it will soon be removed)
247 - must not set up SDRAM or use console
248 - must only do the bare minimum to allow execution to continue to
249 board_init_f()
250 - this is almost never needed
251 - return normally from this function
252
253board_init_f():
254 - purpose: set up the machine ready for running board_init_r():
255 i.e. SDRAM and serial UART
256 - global_data is available
257 - stack is in SRAM
258 - BSS is not available, so you cannot use global/static variables,
259 only stack variables and global_data
260
261 Non-SPL-specific notes:
262 - dram_init() is called to set up DRAM. If already done in SPL this
263 can do nothing
264
265 SPL-specific notes:
266 - you can override the entire board_init_f() function with your own
267 version as needed.
268 - preloader_console_init() can be called here in extremis
269 - should set up SDRAM, and anything needed to make the UART work
270 - these is no need to clear BSS, it will be done by crt0.S
271 - must return normally from this function (don't call board_init_r()
272 directly)
273
274Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
275this point the stack and global_data are relocated to below
276CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
277memory.
278
279board_init_r():
280 - purpose: main execution, common code
281 - global_data is available
282 - SDRAM is available
283 - BSS is available, all static/global variables can be used
284 - execution eventually continues to main_loop()
285
286 Non-SPL-specific notes:
287 - U-Boot is relocated to the top of memory and is now running from
288 there.
289
290 SPL-specific notes:
291 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
292 CONFIG_SPL_STACK_R_ADDR points into SDRAM
293 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700295 spl_board_init() function containing this call
296 - loads U-Boot or (in falcon mode) Linux
297
298
299
wdenkc6097192002-11-03 00:24:07 +0000300Configuration Options:
301----------------------
302
303Configuration depends on the combination of board and CPU type; all
304such information is kept in a configuration file
305"include/configs/<board_name>.h".
306
307Example: For a TQM823L module, all configuration settings are in
308"include/configs/TQM823L.h".
309
310
wdenk1272e232002-11-10 22:06:23 +0000311Many of the options are named exactly as the corresponding Linux
312kernel configuration options. The intention is to make it easier to
313build a config tool - later.
314
315
wdenkc6097192002-11-03 00:24:07 +0000316The following options need to be configured:
317
Kim Phillips203fee32007-08-10 13:28:25 -0500318- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000319
Kim Phillips203fee32007-08-10 13:28:25 -0500320- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200321
Lei Wen20014762011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600327- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000328 CONFIG_SYS_PPC64
329
330 Specifies that the core is a 64-bit PowerPC implementation (implements
331 the "64" category of the Power ISA). This is necessary for ePAPR
332 compliance, among other possible reasons.
333
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600334 CONFIG_SYS_FSL_TBCLK_DIV
335
336 Defines the core time base clock divider ratio compared to the
337 system clock. On most PQ3 devices this is 8, on newer QorIQ
338 devices it can be 16 or 32. The ratio varies from SoC to Soc.
339
Kumar Gala179b1b22011-05-20 00:39:21 -0500340 CONFIG_SYS_FSL_PCIE_COMPAT
341
342 Defines the string to utilize when trying to match PCIe device
343 tree nodes for the given platform.
344
Scott Wood80806962012-08-14 10:14:53 +0000345 CONFIG_SYS_FSL_ERRATUM_A004510
346
347 Enables a workaround for erratum A004510. If set,
348 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
350
351 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
352 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
353
354 Defines one or two SoC revisions (low 8 bits of SVR)
355 for which the A004510 workaround should be applied.
356
357 The rest of SVR is either not relevant to the decision
358 of whether the erratum is present (e.g. p2040 versus
359 p2041) or is implied by the build target, which controls
360 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
361
362 See Freescale App Note 4493 for more information about
363 this erratum.
364
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530365 CONFIG_A003399_NOR_WORKAROUND
366 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800367 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530368
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530369 CONFIG_A008044_WORKAROUND
370 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800371 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530372
Scott Wood80806962012-08-14 10:14:53 +0000373 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
374
375 This is the value to write into CCSR offset 0x18600
376 according to the A004510 workaround.
377
Priyanka Jainc73b9032013-07-02 09:21:04 +0530378 CONFIG_SYS_FSL_DSP_DDR_ADDR
379 This value denotes start offset of DDR memory which is
380 connected exclusively to the DSP cores.
381
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530382 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
383 This value denotes start offset of M2 memory
384 which is directly connected to the DSP core.
385
Priyanka Jainc73b9032013-07-02 09:21:04 +0530386 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
387 This value denotes start offset of M3 memory which is directly
388 connected to the DSP core.
389
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530390 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391 This value denotes start offset of DSP CCSR space.
392
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530393 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
394 Single Source Clock is clocking mode present in some of FSL SoC's.
395 In this mode, a single differential clock is used to supply
396 clocks to the sysclock, ddrclock and usbclock.
397
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530398 CONFIG_SYS_CPC_REINIT_F
399 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800400 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530401
Tang Yuantiana7364af2014-04-17 15:33:46 +0800402 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800403 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800404 supported, core will start to execute uboot when wakes up.
405
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000406- Generic CPU options:
407 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
408
409 Defines the endianess of the CPU. Implementation of those
410 values is arch specific.
411
York Sunf0626592013-09-30 09:22:09 -0700412 CONFIG_SYS_FSL_DDR
413 Freescale DDR driver in use. This type of DDR controller is
414 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
415 SoCs.
416
417 CONFIG_SYS_FSL_DDR_ADDR
418 Freescale DDR memory-mapped register base.
419
420 CONFIG_SYS_FSL_DDR_EMU
421 Specify emulator support for DDR. Some DDR features such as
422 deskew training are not available.
423
424 CONFIG_SYS_FSL_DDRC_GEN1
425 Freescale DDR1 controller.
426
427 CONFIG_SYS_FSL_DDRC_GEN2
428 Freescale DDR2 controller.
429
430 CONFIG_SYS_FSL_DDRC_GEN3
431 Freescale DDR3 controller.
432
York Sun2896cb72014-03-27 17:54:47 -0700433 CONFIG_SYS_FSL_DDRC_GEN4
434 Freescale DDR4 controller.
435
York Sun461c9392013-09-30 14:20:51 -0700436 CONFIG_SYS_FSL_DDRC_ARM_GEN3
437 Freescale DDR3 controller for ARM-based SoCs.
438
York Sunf0626592013-09-30 09:22:09 -0700439 CONFIG_SYS_FSL_DDR1
440 Board config to use DDR1. It can be enabled for SoCs with
441 Freescale DDR1 or DDR2 controllers, depending on the board
442 implemetation.
443
444 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400445 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700446 Freescale DDR2 or DDR3 controllers, depending on the board
447 implementation.
448
449 CONFIG_SYS_FSL_DDR3
450 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700451 Freescale DDR3 or DDR3L controllers.
452
453 CONFIG_SYS_FSL_DDR3L
454 Board config to use DDR3L. It can be enabled for SoCs with
455 DDR3L controllers.
456
457 CONFIG_SYS_FSL_DDR4
458 Board config to use DDR4. It can be enabled for SoCs with
459 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700460
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530461 CONFIG_SYS_FSL_IFC_BE
462 Defines the IFC controller register space as Big Endian
463
464 CONFIG_SYS_FSL_IFC_LE
465 Defines the IFC controller register space as Little Endian
466
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530467 CONFIG_SYS_FSL_IFC_CLK_DIV
468 Defines divider of platform clock(clock input to IFC controller).
469
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530470 CONFIG_SYS_FSL_LBC_CLK_DIV
471 Defines divider of platform clock(clock input to eLBC controller).
472
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530473 CONFIG_SYS_FSL_PBL_PBI
474 It enables addition of RCW (Power on reset configuration) in built image.
475 Please refer doc/README.pblimage for more details
476
477 CONFIG_SYS_FSL_PBL_RCW
478 It adds PBI(pre-boot instructions) commands in u-boot build image.
479 PBI commands can be used to configure SoC before it starts the execution.
480 Please refer doc/README.pblimage for more details
481
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530482 CONFIG_SPL_FSL_PBL
483 It adds a target to create boot binary having SPL binary in PBI format
484 concatenated with u-boot binary.
485
York Sun29647ab2014-02-10 13:59:42 -0800486 CONFIG_SYS_FSL_DDR_BE
487 Defines the DDR controller register space as Big Endian
488
489 CONFIG_SYS_FSL_DDR_LE
490 Defines the DDR controller register space as Little Endian
491
York Sun3a0916d2014-02-10 13:59:43 -0800492 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
493 Physical address from the view of DDR controllers. It is the
494 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
495 it could be different for ARM SoCs.
496
York Sunc459ae62014-02-10 13:59:44 -0800497 CONFIG_SYS_FSL_DDR_INTLV_256B
498 DDR controller interleaving on 256-byte. This is a special
499 interleaving mode, handled by Dickens for Freescale layerscape
500 SoCs with ARM core.
501
York Sun79a779b2014-08-01 15:51:00 -0700502 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
503 Number of controllers used as main memory.
504
505 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
506 Number of controllers used for other than main memory.
507
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530508 CONFIG_SYS_FSL_HAS_DP_DDR
509 Defines the SoC has DP-DDR used for DPAA.
510
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530511 CONFIG_SYS_FSL_SEC_BE
512 Defines the SEC controller register space as Big Endian
513
514 CONFIG_SYS_FSL_SEC_LE
515 Defines the SEC controller register space as Little Endian
516
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200517- MIPS CPU options:
518 CONFIG_SYS_INIT_SP_OFFSET
519
520 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
521 pointer. This is needed for the temporary stack before
522 relocation.
523
524 CONFIG_SYS_MIPS_CACHE_MODE
525
526 Cache operation mode for the MIPS CPU.
527 See also arch/mips/include/asm/mipsregs.h.
528 Possible values are:
529 CONF_CM_CACHABLE_NO_WA
530 CONF_CM_CACHABLE_WA
531 CONF_CM_UNCACHED
532 CONF_CM_CACHABLE_NONCOHERENT
533 CONF_CM_CACHABLE_CE
534 CONF_CM_CACHABLE_COW
535 CONF_CM_CACHABLE_CUW
536 CONF_CM_CACHABLE_ACCELERATED
537
538 CONFIG_SYS_XWAY_EBU_BOOTCFG
539
540 Special option for Lantiq XWAY SoCs for booting from NOR flash.
541 See also arch/mips/cpu/mips32/start.S.
542
543 CONFIG_XWAY_SWAP_BYTES
544
545 Enable compilation of tools/xway-swap-bytes needed for Lantiq
546 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
547 be swapped if a flash programmer is used.
548
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000549- ARM options:
550 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
551
552 Select high exception vectors of the ARM core, e.g., do not
553 clear the V bit of the c1 register of CP15.
554
York Sun77a10972015-03-20 19:28:08 -0700555 COUNTER_FREQUENCY
556 Generic timer clock source frequency.
557
558 COUNTER_FREQUENCY_REAL
559 Generic timer clock source frequency if the real clock is
560 different from COUNTER_FREQUENCY, and can only be determined
561 at run time.
562
Stephen Warren8d1fb312015-01-19 16:25:52 -0700563- Tegra SoC options:
564 CONFIG_TEGRA_SUPPORT_NON_SECURE
565
566 Support executing U-Boot in non-secure (NS) mode. Certain
567 impossible actions will be skipped if the CPU is in NS mode,
568 such as ARM architectural timer initialization.
569
wdenk9b7f3842003-10-09 20:09:04 +0000570- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000571 CONFIG_CLOCKS_IN_MHZ
572
573 U-Boot stores all clock information in Hz
574 internally. For binary compatibility with older Linux
575 kernels (which expect the clocks passed in the
576 bd_info data to be in MHz) the environment variable
577 "clocks_in_mhz" can be defined so that U-Boot
578 converts clock data to MHZ before passing it to the
579 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000580 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100581 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000582 default environment.
583
wdenk9b7f3842003-10-09 20:09:04 +0000584 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
585
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800586 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000587 expect it to be in bytes, others in MB.
588 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
589
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400590 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200591
592 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400593 passed using flattened device trees (based on open firmware
594 concepts).
595
596 CONFIG_OF_LIBFDT
597 * New libfdt-based support
598 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500599 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400600
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200601 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600602 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200603
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200604 boards with QUICC Engines require OF_QE to set UCC MAC
605 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500606
Kumar Gala1e26aa52006-01-11 13:54:17 -0600607 CONFIG_OF_BOARD_SETUP
608
609 Board code has addition modification that it wants to make
610 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000611
Simon Glass6c0be912014-10-23 18:58:54 -0600612 CONFIG_OF_SYSTEM_SETUP
613
614 Other code has addition modification that it wants to make
615 to the flat device tree before handing it off to the kernel.
616 This causes ft_system_setup() to be called before booting
617 the kernel.
618
Heiko Schocherffb293a2009-09-23 07:56:08 +0200619 CONFIG_OF_IDE_FIXUP
620
621 U-Boot can detect if an IDE device is present or not.
622 If not, and this new config option is activated, U-Boot
623 removes the ATA node from the DTS before booting Linux,
624 so the Linux IDE driver does not probe the device and
625 crash. This is needed for buggy hardware (uc101) where
626 no pull down resistor is connected to the signal IDE5V_DD7.
627
Igor Grinberg06890672011-07-14 05:45:07 +0000628 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
629
630 This setting is mandatory for all boards that have only one
631 machine type and must be used to specify the machine type
632 number as it appears in the ARM machine registry
633 (see http://www.arm.linux.org.uk/developer/machines/).
634 Only boards that have multiple machine types supported
635 in a single configuration file and the machine type is
636 runtime discoverable, do not have to use this setting.
637
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100638- vxWorks boot parameters:
639
640 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700641 environments variables: bootdev, bootfile, ipaddr, netmask,
642 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100643 It loads the vxWorks image pointed bootfile.
644
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100645 Note: If a "bootargs" environment is defined, it will overwride
646 the defaults discussed just above.
647
Aneesh V960f5c02011-06-16 23:30:47 +0000648- Cache Configuration:
649 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
650 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
651 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
652
Aneesh V686a0752011-06-16 23:30:51 +0000653- Cache Configuration for ARM:
654 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
655 controller
656 CONFIG_SYS_PL310_BASE - Physical base address of PL310
657 controller register space
658
wdenkda04a8b2004-08-02 23:22:59 +0000659- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200660 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000661
662 Define this if you want support for Amba PrimeCell PL010 UARTs.
663
Andreas Engel0813b122008-09-08 14:30:53 +0200664 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000665
666 Define this if you want support for Amba PrimeCell PL011 UARTs.
667
668 CONFIG_PL011_CLOCK
669
670 If you have Amba PrimeCell PL011 UARTs, set this variable to
671 the clock speed of the UARTs.
672
673 CONFIG_PL01x_PORTS
674
675 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
676 define this to a list of base addresses for each (supported)
677 port. See e.g. include/configs/versatile.h
678
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400679 CONFIG_SERIAL_HW_FLOW_CONTROL
680
681 Define this variable to enable hw flow control in serial driver.
682 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000683
wdenkc6097192002-11-03 00:24:07 +0000684- Console Baudrate:
685 CONFIG_BAUDRATE - in bps
686 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200687 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000688
wdenkc6097192002-11-03 00:24:07 +0000689- Autoboot Command:
690 CONFIG_BOOTCOMMAND
691 Only needed when CONFIG_BOOTDELAY is enabled;
692 define a command string that is automatically executed
693 when no character is read on the console interface
694 within "Boot Delay" after reset.
695
wdenkc6097192002-11-03 00:24:07 +0000696 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000697 The value of these goes into the environment as
698 "ramboot" and "nfsboot" respectively, and can be used
699 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200700 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000701
Heiko Schocher040c5c32013-11-04 14:04:59 +0100702- Bootcount:
703 CONFIG_BOOTCOUNT_LIMIT
704 Implements a mechanism for detecting a repeating reboot
705 cycle, see:
706 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
707
708 CONFIG_BOOTCOUNT_ENV
709 If no softreset save registers are found on the hardware
710 "bootcount" is stored in the environment. To prevent a
711 saveenv on all reboots, the environment variable
712 "upgrade_available" is used. If "upgrade_available" is
713 0, "bootcount" is always 0, if "upgrade_available" is
714 1 "bootcount" is incremented in the environment.
715 So the Userspace Applikation must set the "upgrade_available"
716 and "bootcount" variable to 0, if a boot was successfully.
717
wdenkc6097192002-11-03 00:24:07 +0000718- Pre-Boot Commands:
719 CONFIG_PREBOOT
720
721 When this option is #defined, the existence of the
722 environment variable "preboot" will be checked
723 immediately before starting the CONFIG_BOOTDELAY
724 countdown and/or running the auto-boot command resp.
725 entering interactive mode.
726
727 This feature is especially useful when "preboot" is
728 automatically generated or modified. For an example
729 see the LWMON board specific code: here "preboot" is
730 modified when the user holds down a certain
731 combination of keys on the (special) keyboard when
732 booting the systems
733
734- Serial Download Echo Mode:
735 CONFIG_LOADS_ECHO
736 If defined to 1, all characters received during a
737 serial download (using the "loads" command) are
738 echoed back. This might be needed by some terminal
739 emulations (like "cu"), but may as well just take
740 time on others. This setting #define's the initial
741 value of the "loads_echo" environment variable.
742
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500743- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000744 CONFIG_KGDB_BAUDRATE
745 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200746 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000747
Simon Glassaa34ef22016-03-13 19:07:28 -0600748- Removal of commands
749 If no commands are needed to boot, you can disable
750 CONFIG_CMDLINE to remove them. In this case, the command line
751 will not be available, and when U-Boot wants to execute the
752 boot command (on start-up) it will call board_run_command()
753 instead. This can reduce image size significantly for very
754 simple boot procedures.
755
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000756- Regular expression support:
757 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200758 If this variable is defined, U-Boot is linked against
759 the SLRE (Super Light Regular Expression) library,
760 which adds regex support to some commands, as for
761 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000762
Simon Glass3d686442011-10-15 05:48:20 +0000763- Device tree:
764 CONFIG_OF_CONTROL
765 If this variable is defined, U-Boot will use a device tree
766 to configure its devices, instead of relying on statically
767 compiled #defines in the board file. This option is
768 experimental and only available on a few boards. The device
769 tree is available in the global data as gd->fdt_blob.
770
Simon Glass5cb34db2011-10-24 19:15:31 +0000771 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700772 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000773
774 CONFIG_OF_EMBED
775 If this variable is defined, U-Boot will embed a device tree
776 binary in its image. This device tree file should be in the
777 board directory and called <soc>-<board>.dts. The binary file
778 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900779 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000780
Simon Glass5cb34db2011-10-24 19:15:31 +0000781 CONFIG_OF_SEPARATE
782 If this variable is defined, U-Boot will build a device tree
783 binary. It will be called u-boot.dtb. Architecture-specific
784 code will locate it at run-time. Generally this works by:
785
786 cat u-boot.bin u-boot.dtb >image.bin
787
788 and in fact, U-Boot does this for you, creating a file called
789 u-boot-dtb.bin which is useful in the common case. You can
790 still use the individual files if you need something more
791 exotic.
792
Alex Deymo5b661ec2017-04-02 01:25:20 -0700793 CONFIG_OF_BOARD
794 If this variable is defined, U-Boot will use the device tree
795 provided by the board at runtime instead of embedding one with
796 the image. Only boards defining board_fdt_blob_setup() support
797 this option (see include/fdtdec.h file).
798
wdenkc6097192002-11-03 00:24:07 +0000799- Watchdog:
800 CONFIG_WATCHDOG
801 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000802 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200803 specific code for a watchdog. For the 8xx
804 CPUs, the SIU Watchdog feature is enabled in the SYPCR
805 register. When supported for a specific SoC is
806 available, then no further board specific code should
807 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000808
809 CONFIG_HW_WATCHDOG
810 When using a watchdog circuitry external to the used
811 SoC, then define this variable and provide board
812 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000813
Heiko Schocher735326c2015-01-21 08:38:22 +0100814 CONFIG_AT91_HW_WDT_TIMEOUT
815 specify the timeout in seconds. default 2 seconds.
816
stroeseb9c17c52003-04-04 15:53:41 +0000817- U-Boot Version:
818 CONFIG_VERSION_VARIABLE
819 If this variable is defined, an environment variable
820 named "ver" is created by U-Boot showing the U-Boot
821 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200822 Any change to this variable will be reverted at the
823 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000824
wdenkc6097192002-11-03 00:24:07 +0000825- Real-Time Clock:
826
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500827 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000828 has to be selected, too. Define exactly one of the
829 following options:
830
wdenkc6097192002-11-03 00:24:07 +0000831 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000832 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000833 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000834 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000835 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000836 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200837 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000838 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100839 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000840 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200841 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200842 CONFIG_SYS_RV3029_TCR - enable trickle charger on
843 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000844
wdenkb9bbd242003-06-30 16:24:52 +0000845 Note that if the RTC uses I2C, then the I2C interface
846 must also be configured. See I2C Support, below.
847
Peter Tyser9902e422008-12-17 16:36:21 -0600848- GPIO Support:
849 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600850
Chris Packham9b383202010-12-19 10:12:13 +0000851 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
852 chip-ngpio pairs that tell the PCA953X driver the number of
853 pins supported by a particular chip.
854
Peter Tyser9902e422008-12-17 16:36:21 -0600855 Note that if the GPIO device uses I2C, then the I2C interface
856 must also be configured. See I2C Support, below.
857
Simon Glass4dc47ca2014-06-11 23:29:41 -0600858- I/O tracing:
859 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
860 accesses and can checksum them or write a list of them out
861 to memory. See the 'iotrace' command for details. This is
862 useful for testing device drivers since it can confirm that
863 the driver behaves the same way before and after a code
864 change. Currently this is supported on sandbox and arm. To
865 add support for your architecture, add '#include <iotrace.h>'
866 to the bottom of arch/<arch>/include/asm/io.h and test.
867
868 Example output from the 'iotrace stats' command is below.
869 Note that if the trace buffer is exhausted, the checksum will
870 still continue to operate.
871
872 iotrace is enabled
873 Start: 10000000 (buffer start address)
874 Size: 00010000 (buffer size)
875 Offset: 00000120 (current buffer offset)
876 Output: 10000120 (start + offset)
877 Count: 00000018 (number of trace records)
878 CRC32: 9526fb66 (CRC32 of all trace records)
879
wdenkc6097192002-11-03 00:24:07 +0000880- Timestamp Support:
881
wdenk4a5c8a72003-03-06 00:02:04 +0000882 When CONFIG_TIMESTAMP is selected, the timestamp
883 (date and time) of an image is printed by image
884 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000886
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000887- Partition Labels (disklabels) Supported:
888 Zero or more of the following:
889 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000890 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
891 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
892 bootloader. Note 2TB partition limit; see
893 disk/part_efi.c
894 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000895
Simon Glassb569a012017-05-17 03:25:30 -0600896 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -0600897 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000898 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000899
900- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000901 CONFIG_IDE_RESET_ROUTINE - this is defined in several
902 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000903
wdenk369d43d2004-03-14 14:09:05 +0000904 CONFIG_IDE_RESET - is this is defined, IDE Reset will
905 be performed by calling the function
906 ide_set_reset(int reset)
907 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000908
909- ATAPI Support:
910 CONFIG_ATAPI
911
912 Set this to enable ATAPI support.
913
wdenkf602aa02004-03-13 23:29:43 +0000914- LBA48 Support
915 CONFIG_LBA48
916
917 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100918 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000919 Whithout these , LBA48 support uses 32bit variables and will 'only'
920 support disks up to 2.1TB.
921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200922 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000923 When enabled, makes the IDE subsystem use 64bit sector addresses.
924 Default is 32bit.
925
wdenkc6097192002-11-03 00:24:07 +0000926- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200927 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
928 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
929 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000930 maximum numbers of LUNs, SCSI ID's and target
931 devices.
wdenkc6097192002-11-03 00:24:07 +0000932
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200933 The environment variable 'scsidevs' is set to the number of
934 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000935
wdenkc6097192002-11-03 00:24:07 +0000936- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000937 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000938 Support for Intel 8254x/8257x gigabit chips.
939
940 CONFIG_E1000_SPI
941 Utility code for direct access to the SPI bus on Intel 8257x.
942 This does not do anything useful unless you set at least one
943 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
944
945 CONFIG_E1000_SPI_GENERIC
946 Allow generic access to the SPI bus on the Intel 8257x, for
947 example with the "sspi" command.
948
wdenkc6097192002-11-03 00:24:07 +0000949 CONFIG_EEPRO100
950 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200951 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000952 write routine for first time initialisation.
953
954 CONFIG_TULIP
955 Support for Digital 2114x chips.
956 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
957 modem chip initialisation (KS8761/QS6611).
958
959 CONFIG_NATSEMI
960 Support for National dp83815 chips.
961
962 CONFIG_NS8382X
963 Support for National dp8382[01] gigabit chips.
964
wdenkaa603362003-05-12 21:50:16 +0000965- NETWORK Support (other):
966
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100967 CONFIG_DRIVER_AT91EMAC
968 Support for AT91RM9200 EMAC.
969
970 CONFIG_RMII
971 Define this to use reduced MII inteface
972
973 CONFIG_DRIVER_AT91EMAC_QUIET
974 If this defined, the driver is quiet.
975 The driver doen't show link status messages.
976
Rob Herringc9830dc2011-12-15 11:15:49 +0000977 CONFIG_CALXEDA_XGMAC
978 Support for the Calxeda XGMAC device
979
Ashok93fb8722012-10-15 06:20:47 +0000980 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000981 Support for SMSC's LAN91C96 chips.
982
wdenkaa603362003-05-12 21:50:16 +0000983 CONFIG_LAN91C96_USE_32_BIT
984 Define this to enable 32 bit addressing
985
Ashok93fb8722012-10-15 06:20:47 +0000986 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000987 Support for SMSC's LAN91C111 chip
988
989 CONFIG_SMC91111_BASE
990 Define this to hold the physical address
991 of the device (I/O space)
992
993 CONFIG_SMC_USE_32_BIT
994 Define this if data bus is 32 bits
995
996 CONFIG_SMC_USE_IOFUNCS
997 Define this to use i/o functions instead of macros
998 (some hardware wont work with macros)
999
Heiko Schocher7d037f72011-11-15 10:00:04 -05001000 CONFIG_DRIVER_TI_EMAC
1001 Support for davinci emac
1002
1003 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1004 Define this if you have more then 3 PHYs.
1005
Macpaul Lin199c6252010-12-21 16:59:46 +08001006 CONFIG_FTGMAC100
1007 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1008
1009 CONFIG_FTGMAC100_EGIGA
1010 Define this to use GE link update with gigabit PHY.
1011 Define this if FTGMAC100 is connected to gigabit PHY.
1012 If your system has 10/100 PHY only, it might not occur
1013 wrong behavior. Because PHY usually return timeout or
1014 useless data when polling gigabit status and gigabit
1015 control registers. This behavior won't affect the
1016 correctnessof 10/100 link speed update.
1017
Mike Rapoportf4761af2009-11-11 10:03:03 +02001018 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001019 Support for SMSC's LAN911x and LAN921x chips
1020
Mike Rapoportf4761af2009-11-11 10:03:03 +02001021 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001022 Define this to hold the physical address
1023 of the device (I/O space)
1024
Mike Rapoportf4761af2009-11-11 10:03:03 +02001025 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001026 Define this if data bus is 32 bits
1027
Mike Rapoportf4761af2009-11-11 10:03:03 +02001028 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001029 Define this if data bus is 16 bits. If your processor
1030 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001031 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001032
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001033 CONFIG_SH_ETHER
1034 Support for Renesas on-chip Ethernet controller
1035
1036 CONFIG_SH_ETHER_USE_PORT
1037 Define the number of ports to be used
1038
1039 CONFIG_SH_ETHER_PHY_ADDR
1040 Define the ETH PHY's address
1041
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001042 CONFIG_SH_ETHER_CACHE_WRITEBACK
1043 If this option is set, the driver enables cache flush.
1044
Heiko Schocher2b387762014-07-18 06:07:19 +02001045- PWM Support:
1046 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001047 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001048
Vadim Bendeburydac69642011-10-17 08:36:14 +00001049- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001050 CONFIG_TPM
1051 Support TPM devices.
1052
Christophe Ricard8759ff82015-10-06 22:54:41 +02001053 CONFIG_TPM_TIS_INFINEON
1054 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001055 per system is supported at this time.
1056
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001057 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1058 Define the burst count bytes upper limit
1059
Christophe Ricard88249232016-01-21 23:27:13 +01001060 CONFIG_TPM_ST33ZP24
1061 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1062
1063 CONFIG_TPM_ST33ZP24_I2C
1064 Support for STMicroelectronics ST33ZP24 I2C devices.
1065 Requires TPM_ST33ZP24 and I2C.
1066
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001067 CONFIG_TPM_ST33ZP24_SPI
1068 Support for STMicroelectronics ST33ZP24 SPI devices.
1069 Requires TPM_ST33ZP24 and SPI.
1070
Dirk Eibach20489092013-06-26 15:55:15 +02001071 CONFIG_TPM_ATMEL_TWI
1072 Support for Atmel TWI TPM device. Requires I2C support.
1073
Che-liang Chiouacea5702013-04-12 11:04:34 +00001074 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001075 Support for generic parallel port TPM devices. Only one device
1076 per system is supported at this time.
1077
1078 CONFIG_TPM_TIS_BASE_ADDRESS
1079 Base address where the generic TPM device is mapped
1080 to. Contemporary x86 systems usually map it at
1081 0xfed40000.
1082
Reinhard Pfau4fece432013-06-26 15:55:13 +02001083 CONFIG_TPM
1084 Define this to enable the TPM support library which provides
1085 functional interfaces to some TPM commands.
1086 Requires support for a TPM device.
1087
1088 CONFIG_TPM_AUTH_SESSIONS
1089 Define this to enable authorized functions in the TPM library.
1090 Requires CONFIG_TPM and CONFIG_SHA1.
1091
wdenkc6097192002-11-03 00:24:07 +00001092- USB Support:
1093 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001094 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001095 CONFIG_USB_UHCI to enable it.
1096 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001097 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001098 storage devices.
1099 Note:
1100 Supported are USB Keyboards and USB Floppy drives
1101 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001102
Simon Glass5978cdb2012-02-27 10:52:47 +00001103 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1104 txfilltuning field in the EHCI controller on reset.
1105
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001106 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1107 HW module registers.
1108
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001109- USB Device:
1110 Define the below if you wish to use the USB console.
1111 Once firmware is rebuilt from a serial console issue the
1112 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001113 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001114 it has found a new device. The environment variable usbtty
1115 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001116 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001117 Common Device Class Abstract Control Model serial device.
1118 If you select usbtty = gserial you should be able to enumerate
1119 a Linux host by
1120 # modprobe usbserial vendor=0xVendorID product=0xProductID
1121 else if using cdc_acm, simply setting the environment
1122 variable usbtty to be cdc_acm should suffice. The following
1123 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001124
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001125 CONFIG_USB_DEVICE
1126 Define this to build a UDC device
1127
1128 CONFIG_USB_TTY
1129 Define this to have a tty type of device available to
1130 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001131
Vipin KUMARbdb17702012-03-26 15:38:06 +05301132 CONFIG_USBD_HS
1133 Define this to enable the high speed support for usb
1134 device and usbtty. If this feature is enabled, a routine
1135 int is_usbd_high_speed(void)
1136 also needs to be defined by the driver to dynamically poll
1137 whether the enumeration has succeded at high speed or full
1138 speed.
1139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001140 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001141 Define this if you want stdin, stdout &/or stderr to
1142 be set to usbtty.
1143
Wolfgang Denke2601822006-06-14 18:14:56 +02001144 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001145 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001146 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001147 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1148 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1149 should pretend to be a Linux device to it's target host.
1150
1151 CONFIG_USBD_MANUFACTURER
1152 Define this string as the name of your company for
1153 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001154
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001155 CONFIG_USBD_PRODUCT_NAME
1156 Define this string as the name of your product
1157 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001158
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001159 CONFIG_USBD_VENDORID
1160 Define this as your assigned Vendor ID from the USB
1161 Implementors Forum. This *must* be a genuine Vendor ID
1162 to avoid polluting the USB namespace.
1163 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001164
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001165 CONFIG_USBD_PRODUCTID
1166 Define this as the unique Product ID
1167 for your device
1168 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001169
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001170- ULPI Layer Support:
1171 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1172 the generic ULPI layer. The generic layer accesses the ULPI PHY
1173 via the platform viewport, so you need both the genric layer and
1174 the viewport enabled. Currently only Chipidea/ARC based
1175 viewport is supported.
1176 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1177 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001178 If your ULPI phy needs a different reference clock than the
1179 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1180 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001181
wdenk7a428cc2003-06-15 22:40:42 +00001182- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001183 The MMC controller on the Intel PXA is supported. To
1184 enable this define CONFIG_MMC. The MMC can be
1185 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001186 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001187 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1188 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001189
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001190 CONFIG_SH_MMCIF
1191 Support for Renesas on-chip MMCIF controller
1192
1193 CONFIG_SH_MMCIF_ADDR
1194 Define the base address of MMCIF registers
1195
1196 CONFIG_SH_MMCIF_CLK
1197 Define the clock frequency for MMCIF
1198
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001199 CONFIG_SUPPORT_EMMC_BOOT
1200 Enable some additional features of the eMMC boot partitions.
1201
1202 CONFIG_SUPPORT_EMMC_RPMB
1203 Enable the commands for reading, writing and programming the
1204 key for the Replay Protection Memory Block partition in eMMC.
1205
Tom Rini58a8d322013-03-14 05:32:47 +00001206- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001207 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001208 This enables the USB portion of the DFU USB class
1209
Tom Rini58a8d322013-03-14 05:32:47 +00001210 CONFIG_DFU_MMC
1211 This enables support for exposing (e)MMC devices via DFU.
1212
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001213 CONFIG_DFU_NAND
1214 This enables support for exposing NAND devices via DFU.
1215
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301216 CONFIG_DFU_RAM
1217 This enables support for exposing RAM via DFU.
1218 Note: DFU spec refer to non-volatile memory usage, but
1219 allow usages beyond the scope of spec - here RAM usage,
1220 one that would help mostly the developer.
1221
Heiko Schochera2f831e2013-06-12 06:05:51 +02001222 CONFIG_SYS_DFU_DATA_BUF_SIZE
1223 Dfu transfer uses a buffer before writing data to the
1224 raw storage device. Make the size (in bytes) of this buffer
1225 configurable. The size of this buffer is also configurable
1226 through the "dfu_bufsiz" environment variable.
1227
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001228 CONFIG_SYS_DFU_MAX_FILE_SIZE
1229 When updating files rather than the raw storage device,
1230 we use a static buffer to copy the file into and then write
1231 the buffer once we've been given the whole file. Define
1232 this to the maximum filesize (in bytes) for the buffer.
1233 Default is 4 MiB if undefined.
1234
Heiko Schochere1ba1512014-03-18 08:09:56 +01001235 DFU_DEFAULT_POLL_TIMEOUT
1236 Poll timeout [ms], is the timeout a device can send to the
1237 host. The host must wait for this timeout before sending
1238 a subsequent DFU_GET_STATUS request to the device.
1239
1240 DFU_MANIFEST_POLL_TIMEOUT
1241 Poll timeout [ms], which the device sends to the host when
1242 entering dfuMANIFEST state. Host waits this timeout, before
1243 sending again an USB request to the device.
1244
wdenkda04a8b2004-08-02 23:22:59 +00001245- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001246 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001247 Define these for a default partition on a NAND device
1248
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001249 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1250 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001251 Define these for a default partition on a NOR device
1252
wdenkc6097192002-11-03 00:24:07 +00001253- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001254 See Kconfig help for available keyboard drivers.
1255
1256 CONFIG_KEYBOARD
1257
1258 Define this to enable a custom keyboard support.
1259 This simply calls drv_keyboard_init() which must be
1260 defined in your board-specific files. This option is deprecated
1261 and is only used by novena. For new boards, use driver model
1262 instead.
wdenkc6097192002-11-03 00:24:07 +00001263
1264- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001265 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001266 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001267 SOCs that have a DIU should define this macro to enable DIU
1268 support, and should also define these other macros:
1269
1270 CONFIG_SYS_DIU_ADDR
1271 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001272 CONFIG_CFB_CONSOLE
1273 CONFIG_VIDEO_SW_CURSOR
1274 CONFIG_VGA_AS_SINGLE_DEVICE
1275 CONFIG_VIDEO_LOGO
1276 CONFIG_VIDEO_BMP_LOGO
1277
Timur Tabi32f709e2011-04-11 14:18:22 -05001278 The DIU driver will look for the 'video-mode' environment
1279 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001280 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001281 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001282
wdenkc6097192002-11-03 00:24:07 +00001283- LCD Support: CONFIG_LCD
1284
1285 Define this to enable LCD support (for output to LCD
1286 display); also select one of the supported displays
1287 by defining one of these:
1288
Stelian Popf6f86652008-05-09 21:57:18 +02001289 CONFIG_ATMEL_LCD:
1290
1291 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1292
wdenkc0d54ae2003-11-25 16:55:19 +00001293 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkc0d54ae2003-11-25 16:55:19 +00001295 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001296
wdenkc0d54ae2003-11-25 16:55:19 +00001297 CONFIG_NEC_NL6448BC20
1298
1299 NEC NL6448BC20-08. 6.5", 640x480.
1300 Active, color, single scan.
1301
1302 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001303
wdenkc0d54ae2003-11-25 16:55:19 +00001304 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001305 Active, color, single scan.
1306
1307 CONFIG_SHARP_16x9
1308
1309 Sharp 320x240. Active, color, single scan.
1310 It isn't 16x9, and I am not sure what it is.
1311
1312 CONFIG_SHARP_LQ64D341
1313
1314 Sharp LQ64D341 display, 640x480.
1315 Active, color, single scan.
1316
1317 CONFIG_HLD1045
1318
1319 HLD1045 display, 640x480.
1320 Active, color, single scan.
1321
1322 CONFIG_OPTREX_BW
1323
1324 Optrex CBL50840-2 NF-FW 99 22 M5
1325 or
1326 Hitachi LMG6912RPFC-00T
1327 or
1328 Hitachi SP14Q002
1329
1330 320x240. Black & white.
1331
Simon Glass599a4df2012-10-17 13:24:54 +00001332 CONFIG_LCD_ALIGNMENT
1333
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001334 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001335 defined then the LCD will be aligned to this value instead.
1336 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1337 here, since it is cheaper to change data cache settings on
1338 a per-section basis.
1339
1340
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001341 CONFIG_LCD_ROTATION
1342
1343 Sometimes, for example if the display is mounted in portrait
1344 mode or even if it's mounted landscape but rotated by 180degree,
1345 we need to rotate our content of the display relative to the
1346 framebuffer, so that user can read the messages which are
1347 printed out.
1348 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1349 initialized with a given rotation from "vl_rot" out of
1350 "vidinfo_t" which is provided by the board specific code.
1351 The value for vl_rot is coded as following (matching to
1352 fbcon=rotate:<n> linux-kernel commandline):
1353 0 = no rotation respectively 0 degree
1354 1 = 90 degree rotation
1355 2 = 180 degree rotation
1356 3 = 270 degree rotation
1357
1358 If CONFIG_LCD_ROTATION is not defined, the console will be
1359 initialized with 0degree rotation.
1360
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001361 CONFIG_LCD_BMP_RLE8
1362
1363 Support drawing of RLE8-compressed bitmaps on the LCD.
1364
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001365 CONFIG_I2C_EDID
1366
1367 Enables an 'i2c edid' command which can read EDID
1368 information over I2C from an attached LCD display.
1369
wdenkeb20ad32003-09-05 23:19:14 +00001370- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001371
wdenk57b2d802003-06-27 21:31:46 +00001372 If this option is set, the environment is checked for
1373 a variable "splashimage". If found, the usual display
1374 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001375 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001376 specified in "splashimage" is loaded instead. The
1377 console is redirected to the "nulldev", too. This
1378 allows for a "silent" boot where a splash screen is
1379 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001380
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001381 CONFIG_SPLASHIMAGE_GUARD
1382
1383 If this option is set, then U-Boot will prevent the environment
1384 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001385 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001386 This option is useful for targets where, due to alignment
1387 restrictions, an improperly aligned BMP image will cause a data
1388 abort. If you think you will not have problems with unaligned
1389 accesses (for example because your toolchain prevents them)
1390 there is no need to set this option.
1391
Matthias Weisser53884182009-07-09 16:07:30 +02001392 CONFIG_SPLASH_SCREEN_ALIGN
1393
1394 If this option is set the splash image can be freely positioned
1395 on the screen. Environment variable "splashpos" specifies the
1396 position as "x,y". If a positive number is given it is used as
1397 number of pixel from left/top. If a negative number is given it
1398 is used as number of pixel from right/bottom. You can also
1399 specify 'm' for centering the image.
1400
1401 Example:
1402 setenv splashpos m,m
1403 => image at center of screen
1404
1405 setenv splashpos 30,20
1406 => image at x = 30 and y = 20
1407
1408 setenv splashpos -10,m
1409 => vertically centered image
1410 at x = dspWidth - bmpWidth - 9
1411
Stefan Roesed9d97742005-09-22 09:04:17 +02001412- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1413
1414 If this option is set, additionally to standard BMP
1415 images, gzipped BMP images can be displayed via the
1416 splashscreen support or the bmp command.
1417
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001418- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1419
1420 If this option is set, 8-bit RLE compressed BMP images
1421 can be displayed via the splashscreen support or the
1422 bmp command.
1423
wdenk710e3502003-08-29 20:57:53 +00001424- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001425 CONFIG_GZIP
1426
1427 Enabled by default to support gzip compressed images.
1428
wdenk710e3502003-08-29 20:57:53 +00001429 CONFIG_BZIP2
1430
1431 If this option is set, support for bzip2 compressed
1432 images is included. If not, only uncompressed and gzip
1433 compressed images are supported.
1434
wdenk9c53f402003-10-15 23:53:47 +00001435 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001436 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001437 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001438
wdenk0e2bd9c2004-06-06 21:51:03 +00001439- MII/PHY support:
1440 CONFIG_PHY_ADDR
1441
1442 The address of PHY on MII bus.
1443
1444 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1445
1446 The clock frequency of the MII bus
1447
wdenk0e2bd9c2004-06-06 21:51:03 +00001448 CONFIG_PHY_RESET_DELAY
1449
1450 Some PHY like Intel LXT971A need extra delay after
1451 reset before any MII register access is possible.
1452 For such PHY, set this option to the usec delay
1453 required. (minimum 300usec for LXT971A)
1454
1455 CONFIG_PHY_CMD_DELAY (ppc4xx)
1456
1457 Some PHY like Intel LXT971A need extra delay after
1458 command issued before MII status register can be read
1459
wdenkc6097192002-11-03 00:24:07 +00001460- IP address:
1461 CONFIG_IPADDR
1462
1463 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001464 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001465 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001466 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001467
1468- Server IP address:
1469 CONFIG_SERVERIP
1470
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001471 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001472 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001473 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001474
Robin Getz470a6d42009-07-21 12:15:28 -04001475 CONFIG_KEEP_SERVERADDR
1476
1477 Keeps the server's MAC address, in the env 'serveraddr'
1478 for passing to bootargs (like Linux's netconsole option)
1479
Wolfgang Denk26da2992011-10-26 10:21:22 +00001480- Gateway IP address:
1481 CONFIG_GATEWAYIP
1482
1483 Defines a default value for the IP address of the
1484 default router where packets to other networks are
1485 sent to.
1486 (Environment variable "gatewayip")
1487
1488- Subnet mask:
1489 CONFIG_NETMASK
1490
1491 Defines a default value for the subnet mask (or
1492 routing prefix) which is used to determine if an IP
1493 address belongs to the local subnet or needs to be
1494 forwarded through a router.
1495 (Environment variable "netmask")
1496
David Updegraff7280da72007-06-11 10:41:07 -05001497- Multicast TFTP Mode:
1498 CONFIG_MCAST_TFTP
1499
1500 Defines whether you want to support multicast TFTP as per
1501 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001502 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001503 driver in use must provide a function: mcast() to join/leave a
1504 multicast group.
1505
wdenkc6097192002-11-03 00:24:07 +00001506- BOOTP Recovery Mode:
1507 CONFIG_BOOTP_RANDOM_DELAY
1508
1509 If you have many targets in a network that try to
1510 boot using BOOTP, you may want to avoid that all
1511 systems send out BOOTP requests at precisely the same
1512 moment (which would happen for instance at recovery
1513 from a power failure, when all systems will try to
1514 boot, thus flooding the BOOTP server. Defining
1515 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1516 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001517 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001518
1519 1st BOOTP request: delay 0 ... 1 sec
1520 2nd BOOTP request: delay 0 ... 2 sec
1521 3rd BOOTP request: delay 0 ... 4 sec
1522 4th and following
1523 BOOTP requests: delay 0 ... 8 sec
1524
Thierry Reding8977cda2014-08-19 10:21:24 +02001525 CONFIG_BOOTP_ID_CACHE_SIZE
1526
1527 BOOTP packets are uniquely identified using a 32-bit ID. The
1528 server will copy the ID from client requests to responses and
1529 U-Boot will use this to determine if it is the destination of
1530 an incoming response. Some servers will check that addresses
1531 aren't in use before handing them out (usually using an ARP
1532 ping) and therefore take up to a few hundred milliseconds to
1533 respond. Network congestion may also influence the time it
1534 takes for a response to make it back to the client. If that
1535 time is too long, U-Boot will retransmit requests. In order
1536 to allow earlier responses to still be accepted after these
1537 retransmissions, U-Boot's BOOTP client keeps a small cache of
1538 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1539 cache. The default is to keep IDs for up to four outstanding
1540 requests. Increasing this will allow U-Boot to accept offers
1541 from a BOOTP client in networks with unusually high latency.
1542
stroesee0aadfb2003-08-28 14:17:32 +00001543- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001544 You can fine tune the DHCP functionality by defining
1545 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001546
Jon Loeliger5336a762007-07-09 22:08:34 -05001547 CONFIG_BOOTP_SUBNETMASK
1548 CONFIG_BOOTP_GATEWAY
1549 CONFIG_BOOTP_HOSTNAME
1550 CONFIG_BOOTP_NISDOMAIN
1551 CONFIG_BOOTP_BOOTPATH
1552 CONFIG_BOOTP_BOOTFILESIZE
1553 CONFIG_BOOTP_DNS
1554 CONFIG_BOOTP_DNS2
1555 CONFIG_BOOTP_SEND_HOSTNAME
1556 CONFIG_BOOTP_NTPSERVER
1557 CONFIG_BOOTP_TIMEOFFSET
1558 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001559 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001560
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001561 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1562 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001563
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001564 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1565 after the configured retry count, the call will fail
1566 instead of starting over. This can be used to fail over
1567 to Link-local IP address configuration if the DHCP server
1568 is not available.
1569
stroesee0aadfb2003-08-28 14:17:32 +00001570 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1571 serverip from a DHCP server, it is possible that more
1572 than one DNS serverip is offered to the client.
1573 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1574 serverip will be stored in the additional environment
1575 variable "dnsip2". The first DNS serverip is always
1576 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001577 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001578
1579 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1580 to do a dynamic update of a DNS server. To do this, they
1581 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001582 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001583 of the "hostname" environment variable is passed as
1584 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001585
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001586 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1587
1588 A 32bit value in microseconds for a delay between
1589 receiving a "DHCP Offer" and sending the "DHCP Request".
1590 This fixes a problem with certain DHCP servers that don't
1591 respond 100% of the time to a "DHCP request". E.g. On an
1592 AT91RM9200 processor running at 180MHz, this delay needed
1593 to be *at least* 15,000 usec before a Windows Server 2003
1594 DHCP server would reply 100% of the time. I recommend at
1595 least 50,000 usec to be safe. The alternative is to hope
1596 that one of the retries will be successful but note that
1597 the DHCP timeout and retry process takes a longer than
1598 this delay.
1599
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001600 - Link-local IP address negotiation:
1601 Negotiate with other link-local clients on the local network
1602 for an address that doesn't require explicit configuration.
1603 This is especially useful if a DHCP server cannot be guaranteed
1604 to exist in all environments that the device must operate.
1605
1606 See doc/README.link-local for more information.
1607
wdenk145d2c12004-04-15 21:48:45 +00001608 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001609 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001610
1611 The device id used in CDP trigger frames.
1612
1613 CONFIG_CDP_DEVICE_ID_PREFIX
1614
1615 A two character string which is prefixed to the MAC address
1616 of the device.
1617
1618 CONFIG_CDP_PORT_ID
1619
1620 A printf format string which contains the ascii name of
1621 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001622 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001623
1624 CONFIG_CDP_CAPABILITIES
1625
1626 A 32bit integer which indicates the device capabilities;
1627 0x00000010 for a normal host which does not forwards.
1628
1629 CONFIG_CDP_VERSION
1630
1631 An ascii string containing the version of the software.
1632
1633 CONFIG_CDP_PLATFORM
1634
1635 An ascii string containing the name of the platform.
1636
1637 CONFIG_CDP_TRIGGER
1638
1639 A 32bit integer sent on the trigger.
1640
1641 CONFIG_CDP_POWER_CONSUMPTION
1642
1643 A 16bit integer containing the power consumption of the
1644 device in .1 of milliwatts.
1645
1646 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1647
1648 A byte containing the id of the VLAN.
1649
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001650- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001651
1652 Several configurations allow to display the current
1653 status using a LED. For instance, the LED will blink
1654 fast while running U-Boot code, stop blinking as
1655 soon as a reply to a BOOTP request was received, and
1656 start blinking slow once the Linux kernel is running
1657 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001658 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001659 feature in U-Boot.
1660
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001661 Additional options:
1662
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001663 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001664 The status LED can be connected to a GPIO pin.
1665 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001666 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001667 to include the gpio_led driver in the U-Boot binary.
1668
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001669 CONFIG_GPIO_LED_INVERTED_TABLE
1670 Some GPIO connected LEDs may have inverted polarity in which
1671 case the GPIO high value corresponds to LED off state and
1672 GPIO low value corresponds to LED on state.
1673 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1674 with a list of GPIO LEDs that have inverted polarity.
1675
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001676- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001677
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001678 This enable the NEW i2c subsystem, and will allow you to use
1679 i2c commands at the u-boot command line (as long as you set
1680 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1681 based realtime clock chips or other i2c devices. See
1682 common/cmd_i2c.c for a description of the command line
1683 interface.
1684
1685 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001686 - drivers/i2c/soft_i2c.c:
1687 - activate first bus with CONFIG_SYS_I2C_SOFT define
1688 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1689 for defining speed and slave address
1690 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1691 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1692 for defining speed and slave address
1693 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1694 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1695 for defining speed and slave address
1696 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1697 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1698 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001699
Heiko Schocherf2850742012-10-24 13:48:22 +02001700 - drivers/i2c/fsl_i2c.c:
1701 - activate i2c driver with CONFIG_SYS_I2C_FSL
1702 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1703 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1704 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1705 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001706 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001707 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1708 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1709 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1710 second bus.
1711
Simon Glass026fefb2012-10-30 07:28:53 +00001712 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001713 - activate this driver with CONFIG_SYS_I2C_TEGRA
1714 - This driver adds 4 i2c buses with a fix speed from
1715 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001716
Dirk Eibach42b204f2013-04-25 02:40:01 +00001717 - drivers/i2c/ppc4xx_i2c.c
1718 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1719 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1720 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1721
trema49f40a2013-09-21 18:13:35 +02001722 - drivers/i2c/i2c_mxc.c
1723 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001724 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1725 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1726 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1727 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001728 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1729 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1730 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1731 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1732 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1733 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001734 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1735 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001736 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001737 for speed, and 0 for slave.
1738
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001739 - drivers/i2c/rcar_i2c.c:
1740 - activate this driver with CONFIG_SYS_I2C_RCAR
1741 - This driver adds 4 i2c buses
1742
1743 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1744 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1745 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1746 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1747 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1748 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1749 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1750 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1751 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1752
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001753 - drivers/i2c/sh_i2c.c:
1754 - activate this driver with CONFIG_SYS_I2C_SH
1755 - This driver adds from 2 to 5 i2c buses
1756
1757 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1758 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1759 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1760 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1761 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1762 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1763 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1764 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1765 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1766 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001767 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001768
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001769 - drivers/i2c/omap24xx_i2c.c
1770 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1771 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1772 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1773 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1774 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1775 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1776 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1777 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1778 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1779 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1780 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1781
Heiko Schocher465819a2013-11-08 07:30:53 +01001782 - drivers/i2c/zynq_i2c.c
1783 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1784 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1785 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1786
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301787 - drivers/i2c/s3c24x0_i2c.c:
1788 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1789 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1790 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1791 with a fix speed from 100000 and the slave addr 0!
1792
Dirk Eibachb9577432014-07-03 09:28:18 +02001793 - drivers/i2c/ihs_i2c.c
1794 - activate this driver with CONFIG_SYS_I2C_IHS
1795 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1796 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1797 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1798 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1799 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1800 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1801 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1802 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1803 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1804 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1805 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1806 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001807 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1808 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1809 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1810 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1811 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1812 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1813 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1814 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1815 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001816
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001817 additional defines:
1818
1819 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001820 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001821
1822 CONFIG_SYS_I2C_DIRECT_BUS
1823 define this, if you don't use i2c muxes on your hardware.
1824 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1825 omit this define.
1826
1827 CONFIG_SYS_I2C_MAX_HOPS
1828 define how many muxes are maximal consecutively connected
1829 on one i2c bus. If you not use i2c muxes, omit this
1830 define.
1831
1832 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001833 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001834 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1835 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1836 CONFIG_SYS_NUM_I2C_BUSES = 9:
1837
1838 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1839 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1840 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1841 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1842 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1843 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1844 {1, {I2C_NULL_HOP}}, \
1845 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1846 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1847 }
1848
1849 which defines
1850 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001851 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1852 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1853 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1854 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1855 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001856 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001857 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1858 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001859
1860 If you do not have i2c muxes on your board, omit this define.
1861
Simon Glass3efce392017-05-12 21:10:00 -06001862- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001863 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001864 then the following macros need to be defined (examples are
1865 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001866
1867 I2C_INIT
1868
wdenkb9bbd242003-06-30 16:24:52 +00001869 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001870 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001871
wdenk544e9732004-02-06 23:19:44 +00001872 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001873
wdenkc6097192002-11-03 00:24:07 +00001874 I2C_ACTIVE
1875
1876 The code necessary to make the I2C data line active
1877 (driven). If the data line is open collector, this
1878 define can be null.
1879
wdenkb9bbd242003-06-30 16:24:52 +00001880 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1881
wdenkc6097192002-11-03 00:24:07 +00001882 I2C_TRISTATE
1883
1884 The code necessary to make the I2C data line tri-stated
1885 (inactive). If the data line is open collector, this
1886 define can be null.
1887
wdenkb9bbd242003-06-30 16:24:52 +00001888 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1889
wdenkc6097192002-11-03 00:24:07 +00001890 I2C_READ
1891
York Sun4a598092013-04-01 11:29:11 -07001892 Code that returns true if the I2C data line is high,
1893 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001894
wdenkb9bbd242003-06-30 16:24:52 +00001895 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1896
wdenkc6097192002-11-03 00:24:07 +00001897 I2C_SDA(bit)
1898
York Sun4a598092013-04-01 11:29:11 -07001899 If <bit> is true, sets the I2C data line high. If it
1900 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001901
wdenkb9bbd242003-06-30 16:24:52 +00001902 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001903 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001904 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001905
wdenkc6097192002-11-03 00:24:07 +00001906 I2C_SCL(bit)
1907
York Sun4a598092013-04-01 11:29:11 -07001908 If <bit> is true, sets the I2C clock line high. If it
1909 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001910
wdenkb9bbd242003-06-30 16:24:52 +00001911 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001912 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001913 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001914
wdenkc6097192002-11-03 00:24:07 +00001915 I2C_DELAY
1916
1917 This delay is invoked four times per clock cycle so this
1918 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001919 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001920 like:
1921
wdenkb9bbd242003-06-30 16:24:52 +00001922 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001923
Mike Frysingeree12d542010-07-21 13:38:02 -04001924 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1925
1926 If your arch supports the generic GPIO framework (asm/gpio.h),
1927 then you may alternatively define the two GPIOs that are to be
1928 used as SCL / SDA. Any of the previous I2C_xxx macros will
1929 have GPIO-based defaults assigned to them as appropriate.
1930
1931 You should define these to the GPIO value as given directly to
1932 the generic GPIO functions.
1933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001934 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001935
wdenk57b2d802003-06-27 21:31:46 +00001936 When a board is reset during an i2c bus transfer
1937 chips might think that the current transfer is still
1938 in progress. On some boards it is possible to access
1939 the i2c SCLK line directly, either by using the
1940 processor pin as a GPIO or by having a second pin
1941 connected to the bus. If this option is defined a
1942 custom i2c_init_board() routine in boards/xxx/board.c
1943 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001944
Ben Warren45657152006-09-07 16:50:54 -04001945 CONFIG_I2C_MULTI_BUS
1946
1947 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001948 must have a controller. At any point in time, only one bus is
1949 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001950 Note that bus numbering is zero-based.
1951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001952 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001953
1954 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001955 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001956 is set, specify a list of bus-device pairs. Otherwise, specify
1957 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001958
1959 e.g.
1960 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001961 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001962
1963 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1964
Wolfgang Denk092ae952011-10-26 10:21:21 +00001965 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001966 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001967
1968 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1969
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001970 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001971
1972 If defined, then this indicates the I2C bus number for DDR SPD.
1973 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1974
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001975 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001976
1977 If defined, then this indicates the I2C bus number for the RTC.
1978 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1979
Andrew Dyer58c41f92008-12-29 17:36:01 -06001980 CONFIG_SOFT_I2C_READ_REPEATED_START
1981
1982 defining this will force the i2c_read() function in
1983 the soft_i2c driver to perform an I2C repeated start
1984 between writing the address pointer and reading the
1985 data. If this define is omitted the default behaviour
1986 of doing a stop-start sequence will be used. Most I2C
1987 devices can use either method, but some require one or
1988 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001989
wdenkc6097192002-11-03 00:24:07 +00001990- SPI Support: CONFIG_SPI
1991
1992 Enables SPI driver (so far only tested with
1993 SPI EEPROM, also an instance works with Crystal A/D and
1994 D/As on the SACSng board)
1995
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09001996 CONFIG_SH_SPI
1997
1998 Enables the driver for SPI controller on SuperH. Currently
1999 only SH7757 is supported.
2000
wdenkc6097192002-11-03 00:24:07 +00002001 CONFIG_SOFT_SPI
2002
wdenk4a5c8a72003-03-06 00:02:04 +00002003 Enables a software (bit-bang) SPI driver rather than
2004 using hardware support. This is a general purpose
2005 driver that only requires three general I/O port pins
2006 (two outputs, one input) to function. If this is
2007 defined, the board configuration must define several
2008 SPI configuration items (port pins to use, etc). For
2009 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002010
Ben Warren7efe9272008-01-16 22:37:35 -05002011 CONFIG_HARD_SPI
2012
2013 Enables a hardware SPI driver for general-purpose reads
2014 and writes. As with CONFIG_SOFT_SPI, the board configuration
2015 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002016 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002017 example, see include/configs/mpc8349emds.h.
2018
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002019 CONFIG_MXC_SPI
2020
2021 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002022 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002023
Heiko Schocherb77c8882014-07-14 10:22:11 +02002024 CONFIG_SYS_SPI_MXC_WAIT
2025 Timeout for waiting until spi transfer completed.
2026 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2027
Matthias Fuchsa4400872007-12-27 17:12:34 +01002028- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002029
Matthias Fuchsa4400872007-12-27 17:12:34 +01002030 Enables FPGA subsystem.
2031
2032 CONFIG_FPGA_<vendor>
2033
2034 Enables support for specific chip vendors.
2035 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002036
Matthias Fuchsa4400872007-12-27 17:12:34 +01002037 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002038
Matthias Fuchsa4400872007-12-27 17:12:34 +01002039 Enables support for FPGA family.
2040 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2041
2042 CONFIG_FPGA_COUNT
2043
2044 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002045
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002046 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002047
wdenk57b2d802003-06-27 21:31:46 +00002048 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002049
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002050 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002051
wdenk4a5c8a72003-03-06 00:02:04 +00002052 Enable checks on FPGA configuration interface busy
2053 status by the configuration function. This option
2054 will require a board or device specific function to
2055 be written.
wdenkc6097192002-11-03 00:24:07 +00002056
2057 CONFIG_FPGA_DELAY
2058
2059 If defined, a function that provides delays in the FPGA
2060 configuration driver.
2061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002062 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002063 Allow Control-C to interrupt FPGA configuration
2064
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002065 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002066
wdenk4a5c8a72003-03-06 00:02:04 +00002067 Check for configuration errors during FPGA bitfile
2068 loading. For example, abort during Virtex II
2069 configuration if the INIT_B line goes low (which
2070 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002072 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002073
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002074 Maximum time to wait for the INIT_B line to de-assert
2075 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002076 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002077 ms.
wdenkc6097192002-11-03 00:24:07 +00002078
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002079 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002080
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002081 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002082 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002084 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002085
wdenk4a5c8a72003-03-06 00:02:04 +00002086 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002087 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002088
2089- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002090 CONFIG_BUILD_TARGET
2091
2092 Some SoCs need special image types (e.g. U-Boot binary
2093 with a special header) as build targets. By defining
2094 CONFIG_BUILD_TARGET in the SoC / board header, this
2095 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002096 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002097
wdenkc6097192002-11-03 00:24:07 +00002098 CONFIG_IDENT_STRING
2099
wdenk4a5c8a72003-03-06 00:02:04 +00002100 If defined, this string will be added to the U-Boot
2101 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002102
2103- Vendor Parameter Protection:
2104
wdenk4a5c8a72003-03-06 00:02:04 +00002105 U-Boot considers the values of the environment
2106 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002107 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002108 are set once by the board vendor / manufacturer, and
2109 protects these variables from casual modification by
2110 the user. Once set, these variables are read-only,
2111 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002112 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002113
2114 If CONFIG_ENV_OVERWRITE is #defined in your config
2115 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002116 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002117 these parameters.
2118
Joe Hershberger76f353e2015-05-04 14:55:14 -05002119 Alternatively, if you define _both_ an ethaddr in the
2120 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002121 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002122 which can be changed exactly ONCE by the user. [The
2123 serial# is unaffected by this, i. e. it remains
2124 read-only.]
2125
Joe Hershberger71497d02012-12-11 22:16:31 -06002126 The same can be accomplished in a more flexible way
2127 for any variable by configuring the type of access
2128 to allow for those variables in the ".flags" variable
2129 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2130
wdenkc6097192002-11-03 00:24:07 +00002131- Protected RAM:
2132 CONFIG_PRAM
2133
2134 Define this variable to enable the reservation of
2135 "protected RAM", i. e. RAM which is not overwritten
2136 by U-Boot. Define CONFIG_PRAM to hold the number of
2137 kB you want to reserve for pRAM. You can overwrite
2138 this default value by defining an environment
2139 variable "pram" to the number of kB you want to
2140 reserve. Note that the board info structure will
2141 still show the full amount of RAM. If pRAM is
2142 reserved, a new environment variable "mem" will
2143 automatically be defined to hold the amount of
2144 remaining RAM in a form that can be passed as boot
2145 argument to Linux, for instance like that:
2146
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002147 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002148 saveenv
2149
2150 This way you can tell Linux not to use this memory,
2151 either, which results in a memory region that will
2152 not be affected by reboots.
2153
2154 *WARNING* If your board configuration uses automatic
2155 detection of the RAM size, you must make sure that
2156 this memory test is non-destructive. So far, the
2157 following board configurations are known to be
2158 "pRAM-clean":
2159
Heiko Schocher65d94db2017-06-07 17:33:09 +02002160 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002161 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002162 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002163
Gabe Blacka2f3a932012-12-02 04:55:18 +00002164- Access to physical memory region (> 4GB)
2165 Some basic support is provided for operations on memory not
2166 normally accessible to U-Boot - e.g. some architectures
2167 support access to more than 4GB of memory on 32-bit
2168 machines using physical address extension or similar.
2169 Define CONFIG_PHYSMEM to access this basic support, which
2170 currently only supports clearing the memory.
2171
wdenkc6097192002-11-03 00:24:07 +00002172- Error Recovery:
2173 CONFIG_PANIC_HANG
2174
2175 Define this variable to stop the system in case of a
2176 fatal error, so that you have to reset it manually.
2177 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002178 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002179 automatically as fast as possible, but it may be
2180 useful during development since you can try to debug
2181 the conditions that lead to the situation.
2182
2183 CONFIG_NET_RETRY_COUNT
2184
wdenk4a5c8a72003-03-06 00:02:04 +00002185 This variable defines the number of retries for
2186 network operations like ARP, RARP, TFTP, or BOOTP
2187 before giving up the operation. If not defined, a
2188 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002189
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002190 CONFIG_ARP_TIMEOUT
2191
2192 Timeout waiting for an ARP reply in milliseconds.
2193
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002194 CONFIG_NFS_TIMEOUT
2195
2196 Timeout in milliseconds used in NFS protocol.
2197 If you encounter "ERROR: Cannot umount" in nfs command,
2198 try longer timeout such as
2199 #define CONFIG_NFS_TIMEOUT 10000UL
2200
wdenkc6097192002-11-03 00:24:07 +00002201- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002202 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002203
2204 Enable auto completion of commands using TAB.
2205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002206 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002207
2208 This defines the secondary prompt string, which is
2209 printed when the command interpreter needs more input
2210 to complete a command. Usually "> ".
2211
2212 Note:
2213
wdenk57b2d802003-06-27 21:31:46 +00002214 In the current implementation, the local variables
2215 space and global environment variables space are
2216 separated. Local variables are those you define by
2217 simply typing `name=value'. To access a local
2218 variable later on, you have write `$name' or
2219 `${name}'; to execute the contents of a variable
2220 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002221
wdenk4a5c8a72003-03-06 00:02:04 +00002222 Global environment variables are those you use
2223 setenv/printenv to work with. To run a command stored
2224 in such a variable, you need to use the run command,
2225 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002226
2227 To store commands and special characters in a
2228 variable, please use double quotation marks
2229 surrounding the whole text of the variable, instead
2230 of the backslashes before semicolons and special
2231 symbols.
2232
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002233- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002234 CONFIG_CMDLINE_EDITING
2235
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002236 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002237 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002238
Marek Vasut734fb042016-01-27 04:47:55 +01002239- Command Line PS1/PS2 support:
2240 CONFIG_CMDLINE_PS_SUPPORT
2241
2242 Enable support for changing the command prompt string
2243 at run-time. Only static string is supported so far.
2244 The string is obtained from environment variables PS1
2245 and PS2.
2246
wdenkc0aa5c52003-12-06 19:49:23 +00002247- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002248 CONFIG_EXTRA_ENV_SETTINGS
2249
wdenk4a5c8a72003-03-06 00:02:04 +00002250 Define this to contain any number of null terminated
2251 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002252 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002253
wdenk4a5c8a72003-03-06 00:02:04 +00002254 For example, place something like this in your
2255 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002256
2257 #define CONFIG_EXTRA_ENV_SETTINGS \
2258 "myvar1=value1\0" \
2259 "myvar2=value2\0"
2260
wdenk4a5c8a72003-03-06 00:02:04 +00002261 Warning: This method is based on knowledge about the
2262 internal format how the environment is stored by the
2263 U-Boot code. This is NOT an official, exported
2264 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002265 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002266 You better know what you are doing here.
2267
wdenk4a5c8a72003-03-06 00:02:04 +00002268 Note: overly (ab)use of the default environment is
2269 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002270 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002271 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002272
Stephen Warren1465d5f2012-05-22 09:21:54 +00002273 CONFIG_ENV_VARS_UBOOT_CONFIG
2274
2275 Define this in order to add variables describing the
2276 U-Boot build configuration to the default environment.
2277 These will be named arch, cpu, board, vendor, and soc.
2278
2279 Enabling this option will cause the following to be defined:
2280
2281 - CONFIG_SYS_ARCH
2282 - CONFIG_SYS_CPU
2283 - CONFIG_SYS_BOARD
2284 - CONFIG_SYS_VENDOR
2285 - CONFIG_SYS_SOC
2286
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002287 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2288
2289 Define this in order to add variables describing certain
2290 run-time determined information about the hardware to the
2291 environment. These will be named board_name, board_rev.
2292
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002293 CONFIG_DELAY_ENVIRONMENT
2294
2295 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002296 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002297 that so that the environment is not available until
2298 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2299 this is instead controlled by the value of
2300 /config/load-environment.
2301
wdenkc0aa5c52003-12-06 19:49:23 +00002302- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002303 CONFIG_HAS_DATAFLASH
2304
wdenk57b2d802003-06-27 21:31:46 +00002305 Defining this option enables DataFlash features and
2306 allows to read/write in Dataflash via the standard
2307 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002308
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002309- Serial Flash support
Simon Glass663b0cc2017-08-04 16:35:06 -06002310 Usage requires an initial 'sf probe' to define the serial
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002311 flash parameters, followed by read/write/erase/update
2312 commands.
2313
2314 The following defaults may be provided by the platform
2315 to handle the common case when only a single serial
2316 flash is present on the system.
2317
2318 CONFIG_SF_DEFAULT_BUS Bus identifier
2319 CONFIG_SF_DEFAULT_CS Chip-select
2320 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2321 CONFIG_SF_DEFAULT_SPEED in Hz
2322
wdenkef893942004-02-23 16:11:30 +00002323 CONFIG_SYSTEMACE
2324
2325 Adding this option adds support for Xilinx SystemACE
2326 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002327 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002328 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002329
2330 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002331 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002332
2333 When SystemACE support is added, the "ace" device type
2334 becomes available to the fat commands, i.e. fatls.
2335
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002336- TFTP Fixed UDP Port:
2337 CONFIG_TFTP_PORT
2338
Wolfgang Denk227b5192005-09-24 23:25:46 +02002339 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002340 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002341 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002342 number generator is used.
2343
Wolfgang Denk227b5192005-09-24 23:25:46 +02002344 Also, the environment variable tftpdstp is used to supply
2345 the TFTP UDP destination port value. If tftpdstp isn't
2346 defined, the normal port 69 is used.
2347
2348 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002349 blindly start the TFTP transfer using the pre-configured
2350 target IP address and UDP port. This has the effect of
2351 "punching through" the (Windows XP) firewall, allowing
2352 the remainder of the TFTP transfer to proceed normally.
2353 A better solution is to properly configure the firewall,
2354 but sometimes that is not allowed.
2355
Heiko Schocher443ca402014-01-25 07:27:13 +01002356- bootcount support:
2357 CONFIG_BOOTCOUNT_LIMIT
2358
2359 This enables the bootcounter support, see:
2360 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2361
2362 CONFIG_AT91SAM9XE
2363 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002364 CONFIG_SOC_DA8XX
2365 enable special bootcounter support on da850 based boards.
2366 CONFIG_BOOTCOUNT_RAM
2367 enable support for the bootcounter in RAM
2368 CONFIG_BOOTCOUNT_I2C
2369 enable support for the bootcounter on an i2c (like RTC) device.
2370 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2371 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2372 the bootcounter.
2373 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002374
wdenkc0aa5c52003-12-06 19:49:23 +00002375- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002376 CONFIG_SHOW_BOOT_PROGRESS
2377
wdenk4a5c8a72003-03-06 00:02:04 +00002378 Defining this option allows to add some board-
2379 specific code (calling a user-provided function
2380 "show_boot_progress(int)") that enables you to show
2381 the system's boot progress on some display (for
2382 example, some LED's) on your board. At the moment,
2383 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002384
Simon Glass0fa36a42012-09-28 08:56:37 +00002385
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002386Legacy uImage format:
2387
wdenkc6097192002-11-03 00:24:07 +00002388 Arg Where When
2389 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002390 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002391 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002392 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002393 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002394 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002395 4 common/cmd_bootm.c Image data has correct checksum
2396 -4 common/cmd_bootm.c Image is for unsupported architecture
2397 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002398 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002399 6 common/cmd_bootm.c Image Type check OK
2400 -6 common/cmd_bootm.c gunzip uncompression error
2401 -7 common/cmd_bootm.c Unimplemented compression type
2402 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002403 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002404 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002405
2406 9 common/image.c Start initial ramdisk verification
2407 -10 common/image.c Ramdisk header has bad magic number
2408 -11 common/image.c Ramdisk header has bad checksum
2409 10 common/image.c Ramdisk header is OK
2410 -12 common/image.c Ramdisk data has bad checksum
2411 11 common/image.c Ramdisk data has correct checksum
2412 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002413 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002414 13 common/image.c Start multifile image verification
2415 14 common/image.c No initial ramdisk, no multifile, continue.
2416
Wolfgang Denk092ae952011-10-26 10:21:21 +00002417 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002418
Stefan Roese88fbf932010-04-15 16:07:28 +02002419 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002420 -31 post/post.c POST test failed, detected by post_output_backlog()
2421 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002422
Heiko Schocher633e03a2007-06-22 19:11:54 +02002423 34 common/cmd_doc.c before loading a Image from a DOC device
2424 -35 common/cmd_doc.c Bad usage of "doc" command
2425 35 common/cmd_doc.c correct usage of "doc" command
2426 -36 common/cmd_doc.c No boot device
2427 36 common/cmd_doc.c correct boot device
2428 -37 common/cmd_doc.c Unknown Chip ID on boot device
2429 37 common/cmd_doc.c correct chip ID found, device available
2430 -38 common/cmd_doc.c Read Error on boot device
2431 38 common/cmd_doc.c reading Image header from DOC device OK
2432 -39 common/cmd_doc.c Image header has bad magic number
2433 39 common/cmd_doc.c Image header has correct magic number
2434 -40 common/cmd_doc.c Error reading Image from DOC device
2435 40 common/cmd_doc.c Image header has correct magic number
2436 41 common/cmd_ide.c before loading a Image from a IDE device
2437 -42 common/cmd_ide.c Bad usage of "ide" command
2438 42 common/cmd_ide.c correct usage of "ide" command
2439 -43 common/cmd_ide.c No boot device
2440 43 common/cmd_ide.c boot device found
2441 -44 common/cmd_ide.c Device not available
2442 44 common/cmd_ide.c Device available
2443 -45 common/cmd_ide.c wrong partition selected
2444 45 common/cmd_ide.c partition selected
2445 -46 common/cmd_ide.c Unknown partition table
2446 46 common/cmd_ide.c valid partition table found
2447 -47 common/cmd_ide.c Invalid partition type
2448 47 common/cmd_ide.c correct partition type
2449 -48 common/cmd_ide.c Error reading Image Header on boot device
2450 48 common/cmd_ide.c reading Image Header from IDE device OK
2451 -49 common/cmd_ide.c Image header has bad magic number
2452 49 common/cmd_ide.c Image header has correct magic number
2453 -50 common/cmd_ide.c Image header has bad checksum
2454 50 common/cmd_ide.c Image header has correct checksum
2455 -51 common/cmd_ide.c Error reading Image from IDE device
2456 51 common/cmd_ide.c reading Image from IDE device OK
2457 52 common/cmd_nand.c before loading a Image from a NAND device
2458 -53 common/cmd_nand.c Bad usage of "nand" command
2459 53 common/cmd_nand.c correct usage of "nand" command
2460 -54 common/cmd_nand.c No boot device
2461 54 common/cmd_nand.c boot device found
2462 -55 common/cmd_nand.c Unknown Chip ID on boot device
2463 55 common/cmd_nand.c correct chip ID found, device available
2464 -56 common/cmd_nand.c Error reading Image Header on boot device
2465 56 common/cmd_nand.c reading Image Header from NAND device OK
2466 -57 common/cmd_nand.c Image header has bad magic number
2467 57 common/cmd_nand.c Image header has correct magic number
2468 -58 common/cmd_nand.c Error reading Image from NAND device
2469 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002470
Heiko Schocher633e03a2007-06-22 19:11:54 +02002471 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002472
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002473 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002474 -64 net/eth.c no Ethernet found.
2475 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002476
Heiko Schocher633e03a2007-06-22 19:11:54 +02002477 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002478 80 common/cmd_net.c before calling net_loop()
2479 -81 common/cmd_net.c some error in net_loop() occurred
2480 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002481 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2482 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002483 83 common/cmd_net.c running "source" command
2484 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002485 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002486
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002487FIT uImage format:
2488
2489 Arg Where When
2490 100 common/cmd_bootm.c Kernel FIT Image has correct format
2491 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2492 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2493 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2494 102 common/cmd_bootm.c Kernel unit name specified
2495 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002496 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002497 104 common/cmd_bootm.c Got kernel subimage node offset
2498 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2499 105 common/cmd_bootm.c Kernel subimage hash verification OK
2500 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2501 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002502 -106 common/cmd_bootm.c Kernel subimage has wrong type
2503 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002504 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2505 108 common/cmd_bootm.c Got kernel subimage data/size
2506 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2507 -109 common/cmd_bootm.c Can't get kernel subimage type
2508 -110 common/cmd_bootm.c Can't get kernel subimage comp
2509 -111 common/cmd_bootm.c Can't get kernel subimage os
2510 -112 common/cmd_bootm.c Can't get kernel subimage load address
2511 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2512
2513 120 common/image.c Start initial ramdisk verification
2514 -120 common/image.c Ramdisk FIT image has incorrect format
2515 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002516 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002517 -122 common/image.c Can't get configuration for ramdisk subimage
2518 123 common/image.c Ramdisk unit name specified
2519 -124 common/image.c Can't get ramdisk subimage node offset
2520 125 common/image.c Got ramdisk subimage node offset
2521 -125 common/image.c Ramdisk subimage hash verification failed
2522 126 common/image.c Ramdisk subimage hash verification OK
2523 -126 common/image.c Ramdisk subimage for unsupported architecture
2524 127 common/image.c Architecture check OK
2525 -127 common/image.c Can't get ramdisk subimage data/size
2526 128 common/image.c Got ramdisk subimage data/size
2527 129 common/image.c Can't get ramdisk load address
2528 -129 common/image.c Got ramdisk load address
2529
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002530 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002531 131 common/cmd_doc.c FIT image format OK
2532
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002533 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002534 141 common/cmd_ide.c FIT image format OK
2535
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002536 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002537 151 common/cmd_nand.c FIT image format OK
2538
Heiko Schocher515eb122014-05-28 11:33:33 +02002539- legacy image format:
2540 CONFIG_IMAGE_FORMAT_LEGACY
2541 enables the legacy image format support in U-Boot.
2542
2543 Default:
2544 enabled if CONFIG_FIT_SIGNATURE is not defined.
2545
2546 CONFIG_DISABLE_IMAGE_LEGACY
2547 disable the legacy image format
2548
2549 This define is introduced, as the legacy image format is
2550 enabled per default for backward compatibility.
2551
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002552- Standalone program support:
2553 CONFIG_STANDALONE_LOAD_ADDR
2554
Wolfgang Denk23f78482011-10-09 21:06:34 +02002555 This option defines a board specific value for the
2556 address where standalone program gets loaded, thus
2557 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002558 settings.
2559
2560- Frame Buffer Address:
2561 CONFIG_FB_ADDR
2562
2563 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002564 address for frame buffer. This is typically the case
2565 when using a graphics controller has separate video
2566 memory. U-Boot will then place the frame buffer at
2567 the given address instead of dynamically reserving it
2568 in system RAM by calling lcd_setmem(), which grabs
2569 the memory for the frame buffer depending on the
2570 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002571
2572 Please see board_init_f function.
2573
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002574- Automatic software updates via TFTP server
2575 CONFIG_UPDATE_TFTP
2576 CONFIG_UPDATE_TFTP_CNT_MAX
2577 CONFIG_UPDATE_TFTP_MSEC_MAX
2578
2579 These options enable and control the auto-update feature;
2580 for a more detailed description refer to doc/README.update.
2581
2582- MTD Support (mtdparts command, UBI support)
2583 CONFIG_MTD_DEVICE
2584
2585 Adds the MTD device infrastructure from the Linux kernel.
2586 Needed for mtdparts command support.
2587
2588 CONFIG_MTD_PARTITIONS
2589
2590 Adds the MTD partitioning infrastructure from the Linux
2591 kernel. Needed for UBI support.
2592
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002593- UBI support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002594 CONFIG_UBI_SILENCE_MSG
2595
2596 Make the verbose messages from UBI stop printing. This leaves
2597 warnings and errors enabled.
2598
Heiko Schocherf5895d12014-06-24 10:10:04 +02002599
2600 CONFIG_MTD_UBI_WL_THRESHOLD
2601 This parameter defines the maximum difference between the highest
2602 erase counter value and the lowest erase counter value of eraseblocks
2603 of UBI devices. When this threshold is exceeded, UBI starts performing
2604 wear leveling by means of moving data from eraseblock with low erase
2605 counter to eraseblocks with high erase counter.
2606
2607 The default value should be OK for SLC NAND flashes, NOR flashes and
2608 other flashes which have eraseblock life-cycle 100000 or more.
2609 However, in case of MLC NAND flashes which typically have eraseblock
2610 life-cycle less than 10000, the threshold should be lessened (e.g.,
2611 to 128 or 256, although it does not have to be power of 2).
2612
2613 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002614
Heiko Schocherf5895d12014-06-24 10:10:04 +02002615 CONFIG_MTD_UBI_BEB_LIMIT
2616 This option specifies the maximum bad physical eraseblocks UBI
2617 expects on the MTD device (per 1024 eraseblocks). If the
2618 underlying flash does not admit of bad eraseblocks (e.g. NOR
2619 flash), this value is ignored.
2620
2621 NAND datasheets often specify the minimum and maximum NVM
2622 (Number of Valid Blocks) for the flashes' endurance lifetime.
2623 The maximum expected bad eraseblocks per 1024 eraseblocks
2624 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2625 which gives 20 for most NANDs (MaxNVB is basically the total
2626 count of eraseblocks on the chip).
2627
2628 To put it differently, if this value is 20, UBI will try to
2629 reserve about 1.9% of physical eraseblocks for bad blocks
2630 handling. And that will be 1.9% of eraseblocks on the entire
2631 NAND chip, not just the MTD partition UBI attaches. This means
2632 that if you have, say, a NAND flash chip admits maximum 40 bad
2633 eraseblocks, and it is split on two MTD partitions of the same
2634 size, UBI will reserve 40 eraseblocks when attaching a
2635 partition.
2636
2637 default: 20
2638
2639 CONFIG_MTD_UBI_FASTMAP
2640 Fastmap is a mechanism which allows attaching an UBI device
2641 in nearly constant time. Instead of scanning the whole MTD device it
2642 only has to locate a checkpoint (called fastmap) on the device.
2643 The on-flash fastmap contains all information needed to attach
2644 the device. Using fastmap makes only sense on large devices where
2645 attaching by scanning takes long. UBI will not automatically install
2646 a fastmap on old images, but you can set the UBI parameter
2647 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2648 that fastmap-enabled images are still usable with UBI implementations
2649 without fastmap support. On typical flash devices the whole fastmap
2650 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2651
2652 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2653 Set this parameter to enable fastmap automatically on images
2654 without a fastmap.
2655 default: 0
2656
Heiko Schocher94b66de2015-10-22 06:19:21 +02002657 CONFIG_MTD_UBI_FM_DEBUG
2658 Enable UBI fastmap debug
2659 default: 0
2660
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002661- UBIFS support
Joe Hershberger47550fc2013-04-08 10:32:49 +00002662 CONFIG_UBIFS_SILENCE_MSG
2663
2664 Make the verbose messages from UBIFS stop printing. This leaves
2665 warnings and errors enabled.
2666
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002667- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002668 CONFIG_SPL
2669 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002670
Tom Rini36853852012-02-14 07:29:40 +00002671 CONFIG_SPL_LDSCRIPT
2672 LDSCRIPT for linking the SPL binary.
2673
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002674 CONFIG_SPL_MAX_FOOTPRINT
2675 Maximum size in memory allocated to the SPL, BSS included.
2676 When defined, the linker checks that the actual memory
2677 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002678 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002679 must not be both defined at the same time.
2680
Tom Rini36853852012-02-14 07:29:40 +00002681 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002682 Maximum size of the SPL image (text, data, rodata, and
2683 linker lists sections), BSS excluded.
2684 When defined, the linker checks that the actual size does
2685 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002686
Wolfgang Denk825223d2011-09-11 21:24:09 +02002687 CONFIG_SPL_TEXT_BASE
2688 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002689
Scott Woodc4f0d002012-09-20 19:05:12 -05002690 CONFIG_SPL_RELOC_TEXT_BASE
2691 Address to relocate to. If unspecified, this is equal to
2692 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2693
Tom Rini36853852012-02-14 07:29:40 +00002694 CONFIG_SPL_BSS_START_ADDR
2695 Link address for the BSS within the SPL binary.
2696
2697 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002698 Maximum size in memory allocated to the SPL BSS.
2699 When defined, the linker checks that the actual memory used
2700 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002701 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002702 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002703
2704 CONFIG_SPL_STACK
2705 Adress of the start of the stack SPL will use
2706
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002707 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2708 When defined, SPL will panic() if the image it has
2709 loaded does not have a signature.
2710 Defining this is useful when code which loads images
2711 in SPL cannot guarantee that absolutely all read errors
2712 will be caught.
2713 An example is the LPC32XX MLC NAND driver, which will
2714 consider that a completely unreadable NAND block is bad,
2715 and thus should be skipped silently.
2716
Scott Woodc4f0d002012-09-20 19:05:12 -05002717 CONFIG_SPL_RELOC_STACK
2718 Adress of the start of the stack SPL will use after
2719 relocation. If unspecified, this is equal to
2720 CONFIG_SPL_STACK.
2721
Tom Rini36853852012-02-14 07:29:40 +00002722 CONFIG_SYS_SPL_MALLOC_START
2723 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002724 When this option is set the full malloc is used in SPL and
2725 it is set up by spl_init() and before that, the simple malloc()
2726 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002727
2728 CONFIG_SYS_SPL_MALLOC_SIZE
2729 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002730
Tom Rini28591df2012-08-13 12:03:19 -07002731 CONFIG_SPL_FRAMEWORK
2732 Enable the SPL framework under common/. This framework
2733 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2734 NAND loading of the Linux Kernel.
2735
Tom Rinic2b76002014-03-28 12:03:39 -04002736 CONFIG_SPL_OS_BOOT
2737 Enable booting directly to an OS from SPL.
2738 See also: doc/README.falcon
2739
Tom Rinife3b0c72012-08-13 11:37:56 -07002740 CONFIG_SPL_DISPLAY_PRINT
2741 For ARM, enable an optional function to print more information
2742 about the running system.
2743
Scott Wood7c810902012-09-20 16:35:21 -05002744 CONFIG_SPL_INIT_MINIMAL
2745 Arch init code should be built for a very small image
2746
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002747 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2748 Partition on the MMC to load U-Boot from when the MMC is being
2749 used in raw mode
2750
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002751 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2752 Sector to load kernel uImage from when MMC is being
2753 used in raw mode (for Falcon mode)
2754
2755 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2756 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2757 Sector and number of sectors to load kernel argument
2758 parameters from when MMC is being used in raw mode
2759 (for falcon mode)
2760
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002761 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2762 Partition on the MMC to load U-Boot from when the MMC is being
2763 used in fs mode
2764
Guillaume GARDET5065b712014-10-15 17:53:13 +02002765 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2766 Filename to read to load U-Boot when reading from filesystem
2767
2768 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002769 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002770 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002771
Guillaume GARDET5065b712014-10-15 17:53:13 +02002772 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002773 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002774 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002775
Scott Wood2b36fbb2012-12-06 13:33:17 +00002776 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2777 Set this for NAND SPL on PPC mpc83xx targets, so that
2778 start.S waits for the rest of the SPL to load before
2779 continuing (the hardware starts execution after just
2780 loading the first page rather than the full 4K).
2781
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302782 CONFIG_SPL_SKIP_RELOCATE
2783 Avoid SPL relocation
2784
Scott Woodc352a0c2012-09-20 19:09:07 -05002785 CONFIG_SPL_NAND_BASE
2786 Include nand_base.c in the SPL. Requires
2787 CONFIG_SPL_NAND_DRIVERS.
2788
2789 CONFIG_SPL_NAND_DRIVERS
2790 SPL uses normal NAND drivers, not minimal drivers.
2791
2792 CONFIG_SPL_NAND_ECC
2793 Include standard software ECC in the SPL
2794
Tom Rini36853852012-02-14 07:29:40 +00002795 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002796 Support for NAND boot using simple NAND drivers that
2797 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002798
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002799 CONFIG_SPL_UBI
2800 Support for a lightweight UBI (fastmap) scanner and
2801 loader
2802
Heiko Schochercf000272014-10-31 08:31:00 +01002803 CONFIG_SPL_NAND_RAW_ONLY
2804 Support to boot only raw u-boot.bin images. Use this only
2805 if you need to save space.
2806
Ying Zhangdfb2b152013-08-16 15:16:12 +08002807 CONFIG_SPL_COMMON_INIT_DDR
2808 Set for common ddr init with serial presence detect in
2809 SPL binary.
2810
Tom Rini36853852012-02-14 07:29:40 +00002811 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2812 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2813 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2814 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2815 CONFIG_SYS_NAND_ECCBYTES
2816 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002817 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002818
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302819 CONFIG_SPL_NAND_BOOT
2820 Add support NAND boot
2821
Tom Rini36853852012-02-14 07:29:40 +00002822 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002823 Location in NAND to read U-Boot from
2824
2825 CONFIG_SYS_NAND_U_BOOT_DST
2826 Location in memory to load U-Boot to
2827
2828 CONFIG_SYS_NAND_U_BOOT_SIZE
2829 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002830
2831 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002832 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002833
2834 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2835 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002836 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002837
Pavel Machekde997252012-08-30 22:42:11 +02002838 CONFIG_SPL_RAM_DEVICE
2839 Support for running image already present in ram, in SPL binary
2840
Scott Woodeb7bd972012-12-06 13:33:16 +00002841 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002842 Image offset to which the SPL should be padded before appending
2843 the SPL payload. By default, this is defined as
2844 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2845 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2846 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002847
Scott Woodf147eb72012-09-21 16:27:32 -05002848 CONFIG_SPL_TARGET
2849 Final target image containing SPL and payload. Some SPLs
2850 use an arch-specific makefile fragment instead, for
2851 example if more than one image needs to be produced.
2852
Simon Glass82d94532013-05-08 08:05:59 +00002853 CONFIG_FIT_SPL_PRINT
2854 Printing information about a FIT image adds quite a bit of
2855 code to SPL. So this is normally disabled in SPL. Use this
2856 option to re-enable it. This will affect the output of the
2857 bootm command when booting a FIT image.
2858
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002859- TPL framework
2860 CONFIG_TPL
2861 Enable building of TPL globally.
2862
2863 CONFIG_TPL_PAD_TO
2864 Image offset to which the TPL should be padded before appending
2865 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002866 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2867 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2868 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002869
wdenkc0aa5c52003-12-06 19:49:23 +00002870- Interrupt support (PPC):
2871
wdenk1ebf41e2004-01-02 14:00:00 +00002872 There are common interrupt_init() and timer_interrupt()
2873 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002874 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002875 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002876 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002877 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002878 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002879 specific handling. If board has watchdog / status_led
2880 / other_activity_monitor it works automatically from
2881 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002882
wdenkc6097192002-11-03 00:24:07 +00002883
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002884Board initialization settings:
2885------------------------------
2886
2887During Initialization u-boot calls a number of board specific functions
2888to allow the preparation of board specific prerequisites, e.g. pin setup
2889before drivers are initialized. To enable these callbacks the
2890following configuration macros have to be defined. Currently this is
2891architecture specific, so please check arch/your_architecture/lib/board.c
2892typically in board_init_f() and board_init_r().
2893
2894- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2895- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2896- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2897- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002898
wdenkc6097192002-11-03 00:24:07 +00002899Configuration Settings:
2900-----------------------
2901
York Sun6c480012014-02-26 17:03:19 -08002902- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2903 Optionally it can be defined to support 64-bit memory commands.
2904
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002905- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002906 undefine this when you're short of memory.
2907
Peter Tyserdfb72b82009-01-27 18:03:12 -06002908- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2909 width of the commands listed in the 'help' command output.
2910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002911- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002912 prompt for user input.
2913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002914- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002916- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002918- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002920- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002921 the application (usually a Linux kernel) when it is
2922 booted
2923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002924- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002925 List of legal baudrate settings for this board.
2926
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002927- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002928 Begin and End addresses of the area used by the
2929 simple memory test.
2930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002931- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002932 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002934- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002935 Scratch address used by the alternate memory test
2936 You only need to set this if address zero isn't writeable
2937
York Sun5d286cd2015-12-04 11:57:07 -08002938- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002939 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002940 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2941 is substracted from total RAM and won't be reported to OS.
2942 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002943 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002944 the RAM base is not zero, or RAM is divided into banks,
2945 this variable needs to be recalcuated to get the address.
2946
York Sun50739372015-12-07 11:05:29 -08002947- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002948 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002949 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002950 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002951 fixing up gd->ram_size the Linux kernel should gets passed
2952 the now "corrected" memory size and won't touch it either.
2953 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002954 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002955 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002956 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002957
2958 This option can be used as a workaround for the 440EPx/GRx
2959 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2960 be touched.
2961
2962 WARNING: Please make sure that this value is a multiple of
2963 the Linux page size (normally 4k). If this is not the case,
2964 then the end address of the Linux memory will be located at a
2965 non page size aligned address and this could cause major
2966 problems.
2967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002968- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002969 Enable temporary baudrate change while serial download
2970
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002971- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002972 Physical start address of SDRAM. _Must_ be 0 here.
2973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002974- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002975 Physical start address of Flash memory.
2976
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002977- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002978 Physical start address of boot monitor code (set by
2979 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002980 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002981 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002982
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002983- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002984 Size of memory reserved for monitor code, used to
2985 determine _at_compile_time_ (!) if the environment is
2986 embedded within the U-Boot image, or in a separate
2987 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002988
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002989- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002990 Size of DRAM reserved for malloc() use.
2991
Simon Glass863e4042014-07-10 22:23:28 -06002992- CONFIG_SYS_MALLOC_F_LEN
2993 Size of the malloc() pool for use before relocation. If
2994 this is defined, then a very simple malloc() implementation
2995 will become available before relocation. The address is just
2996 below the global data, and the stack is moved down to make
2997 space.
2998
2999 This feature allocates regions with increasing addresses
3000 within the region. calloc() is supported, but realloc()
3001 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003002 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003003 U-Boot relocates itself.
3004
Simon Glass9fa901b2014-11-10 17:16:54 -07003005- CONFIG_SYS_MALLOC_SIMPLE
3006 Provides a simple and small malloc() and calloc() for those
3007 boards which do not use the full malloc in SPL (which is
3008 enabled with CONFIG_SYS_SPL_MALLOC_START).
3009
Thierry Redingc97d9742014-12-09 22:25:22 -07003010- CONFIG_SYS_NONCACHED_MEMORY:
3011 Size of non-cached memory area. This area of memory will be
3012 typically located right below the malloc() area and mapped
3013 uncached in the MMU. This is useful for drivers that would
3014 otherwise require a lot of explicit cache maintenance. For
3015 some drivers it's also impossible to properly maintain the
3016 cache. For example if the regions that need to be flushed
3017 are not a multiple of the cache-line size, *and* padding
3018 cannot be allocated between the regions to align them (i.e.
3019 if the HW requires a contiguous array of regions, and the
3020 size of each region is not cache-aligned), then a flush of
3021 one region may result in overwriting data that hardware has
3022 written to another region in the same cache-line. This can
3023 happen for example in network drivers where descriptors for
3024 buffers are typically smaller than the CPU cache-line (e.g.
3025 16 bytes vs. 32 or 64 bytes).
3026
3027 Non-cached memory is only supported on 32-bit ARM at present.
3028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003029- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003030 Normally compressed uImages are limited to an
3031 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003032 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003033 to adjust this setting to your needs.
3034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003035- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003036 Maximum size of memory mapped by the startup code of
3037 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003038 the Linux kernel (bd_info, boot arguments, FDT blob if
3039 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003040 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003041 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003042 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003043 variable "bootm_mapsize" will override the value of
3044 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3045 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003046
John Rigbyeea8e692010-10-13 13:57:35 -06003047- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3048 Enable initrd_high functionality. If defined then the
3049 initrd_high feature is enabled and the bootm ramdisk subcommand
3050 is enabled.
3051
3052- CONFIG_SYS_BOOT_GET_CMDLINE:
3053 Enables allocating and saving kernel cmdline in space between
3054 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3055
3056- CONFIG_SYS_BOOT_GET_KBD:
3057 Enables allocating and saving a kernel copy of the bd_info in
3058 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003060- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003061 Max number of Flash memory banks
3062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003063- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003064 Max number of sectors on a Flash chip
3065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003066- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003067 Timeout for Flash erase operations (in ms)
3068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003069- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003070 Timeout for Flash write operations (in ms)
3071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003073 Timeout for Flash set sector lock bit operation (in ms)
3074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003075- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003076 Timeout for Flash clear lock bits operation (in ms)
3077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003079 If defined, hardware flash sectors protection is used
3080 instead of U-Boot software protection.
3081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003082- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003083
3084 Enable TFTP transfers directly to flash memory;
3085 without this option such a download has to be
3086 performed in two steps: (1) download to RAM, and (2)
3087 copy from RAM to flash.
3088
3089 The two-step approach is usually more reliable, since
3090 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003091 the flash, but in some situations (when system RAM is
3092 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003093 downloaded image) this option may be very useful.
3094
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003095- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003096 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003097 common flash structure for storing flash geometry.
3098
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003099- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003100 This option also enables the building of the cfi_flash driver
3101 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003102
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003103- CONFIG_FLASH_CFI_MTD
3104 This option enables the building of the cfi_mtd driver
3105 in the drivers directory. The driver exports CFI flash
3106 to the MTD layer.
3107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003108- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003109 Use buffered writes to flash.
3110
3111- CONFIG_FLASH_SPANSION_S29WS_N
3112 s29ws-n MirrorBit flash has non-standard addresses for buffered
3113 write commands.
3114
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003115- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003116 If this option is defined, the common CFI flash doesn't
3117 print it's warning upon not recognized FLASH banks. This
3118 is useful, if some of the configured banks are only
3119 optionally available.
3120
Jerry Van Barenaae73572008-03-08 13:48:01 -05003121- CONFIG_FLASH_SHOW_PROGRESS
3122 If defined (must be an integer), print out countdown
3123 digits and dots. Recommended value: 45 (9..1) for 80
3124 column displays, 15 (3..1) for 40 column displays.
3125
Stefan Roesed20cba52013-04-04 15:53:14 +02003126- CONFIG_FLASH_VERIFY
3127 If defined, the content of the flash (destination) is compared
3128 against the source after the write operation. An error message
3129 will be printed when the contents are not identical.
3130 Please note that this option is useless in nearly all cases,
3131 since such flash programming errors usually are detected earlier
3132 while unprotecting/erasing/programming. Please only enable
3133 this option if you really know what you are doing.
3134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003135- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003136 Defines the number of Ethernet receive buffers. On some
3137 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003138 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3139 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003140 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003141 Defaults to 4 if not defined.
3142
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003143- CONFIG_ENV_MAX_ENTRIES
3144
Wolfgang Denk1136f692010-10-27 22:48:30 +02003145 Maximum number of entries in the hash table that is used
3146 internally to store the environment settings. The default
3147 setting is supposed to be generous and should work in most
3148 cases. This setting can be used to tune behaviour; see
3149 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003150
Joe Hershberger71497d02012-12-11 22:16:31 -06003151- CONFIG_ENV_FLAGS_LIST_DEFAULT
3152- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003153 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003154 calling env set. Variables can be restricted to only decimal,
3155 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3156 the variables can also be restricted to IP address or MAC address.
3157
3158 The format of the list is:
3159 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003160 access_attribute = [a|r|o|c]
3161 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003162 entry = variable_name[:attributes]
3163 list = entry[,list]
3164
3165 The type attributes are:
3166 s - String (default)
3167 d - Decimal
3168 x - Hexadecimal
3169 b - Boolean ([1yYtT|0nNfF])
3170 i - IP address
3171 m - MAC address
3172
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003173 The access attributes are:
3174 a - Any (default)
3175 r - Read-only
3176 o - Write-once
3177 c - Change-default
3178
Joe Hershberger71497d02012-12-11 22:16:31 -06003179 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3180 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003181 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003182
3183 - CONFIG_ENV_FLAGS_LIST_STATIC
3184 Define this to a list (string) to define validation that
3185 should be done if an entry is not found in the ".flags"
3186 environment variable. To override a setting in the static
3187 list, simply add an entry for the same variable name to the
3188 ".flags" variable.
3189
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003190 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3191 regular expression. This allows multiple variables to define the same
3192 flags without explicitly listing them for each variable.
3193
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003194- CONFIG_ENV_ACCESS_IGNORE_FORCE
3195 If defined, don't allow the -f switch to env set override variable
3196 access flags.
3197
Gabe Black3687fe42014-10-15 04:38:30 -06003198- CONFIG_USE_STDINT
3199 If stdint.h is available with your toolchain you can define this
3200 option to enable it. You can provide option 'USE_STDINT=1' when
3201 building U-Boot to enable this.
3202
wdenkc6097192002-11-03 00:24:07 +00003203The following definitions that deal with the placement and management
3204of environment data (variable area); in general, we support the
3205following configurations:
3206
Mike Frysinger63b8f122011-07-08 10:44:25 +00003207- CONFIG_BUILD_ENVCRC:
3208
3209 Builds up envcrc with the target environment so that external utils
3210 may easily extract it and embed it in final U-Boot images.
3211
wdenkc6097192002-11-03 00:24:07 +00003212BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003213in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003214console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003215U-Boot will hang.
3216
3217Please note that even with NVRAM we still use a copy of the
3218environment in RAM: we could work on NVRAM directly, but we want to
3219keep settings there always unmodified except somebody uses "saveenv"
3220to save the current settings.
3221
Liu Gang85bcd732012-03-08 00:33:20 +00003222BE CAREFUL! For some special cases, the local device can not use
3223"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003224environment stored in a remote NOR flash by SRIO or PCIE link,
3225but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003226
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003227- CONFIG_NAND_ENV_DST
3228
3229 Defines address in RAM to which the nand_spl code should copy the
3230 environment. If redundant environment is used, it will be copied to
3231 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3232
Bruce Adleredecc942007-11-02 13:15:42 -07003233Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003234has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06003235created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003236until then to read environment variables.
3237
wdenk8dba0502003-03-31 16:34:49 +00003238The environment is protected by a CRC32 checksum. Before the monitor
3239is relocated into RAM, as a result of a bad CRC you will be working
3240with the compiled-in default environment - *silently*!!! [This is
3241necessary, because the first environment variable we need is the
3242"baudrate" setting for the console - if we have a bad CRC, we don't
3243have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003244
3245Note: once the monitor has been relocated, then it will complain if
3246the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003247use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003248
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003249- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003250 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003251
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003252 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003253 also needs to be defined.
3254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003255- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003256 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003257
Ron Madriddfa028a2009-02-18 14:30:44 -08003258- CONFIG_NS16550_MIN_FUNCTIONS:
3259 Define this if you desire to only have use of the NS16550_init
3260 and NS16550_putc functions for the serial driver located at
3261 drivers/serial/ns16550.c. This option is useful for saving
3262 space for already greatly restricted images, including but not
3263 limited to NAND_SPL configurations.
3264
Simon Glass28a9e332012-11-30 13:01:18 +00003265- CONFIG_DISPLAY_BOARDINFO
3266 Display information about the board that U-Boot is running on
3267 when U-Boot starts up. The board function checkboard() is called
3268 to do this.
3269
Simon Glasse8822012012-11-30 13:01:19 +00003270- CONFIG_DISPLAY_BOARDINFO_LATE
3271 Similar to the previous option, but display this information
3272 later, once stdio is running and output goes to the LCD, if
3273 present.
3274
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003275- CONFIG_BOARD_SIZE_LIMIT:
3276 Maximum size of the U-Boot image. When defined, the
3277 build system checks that the actual size does not
3278 exceed it.
3279
wdenkc6097192002-11-03 00:24:07 +00003280Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003281---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003282
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003283- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003284 Cache Line Size of the CPU.
3285
Timur Tabid8f341c2011-08-04 18:03:41 -05003286- CONFIG_SYS_CCSRBAR_DEFAULT:
3287 Default (power-on reset) physical address of CCSR on Freescale
3288 PowerPC SOCs.
3289
3290- CONFIG_SYS_CCSRBAR:
3291 Virtual address of CCSR. On a 32-bit build, this is typically
3292 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3293
Timur Tabid8f341c2011-08-04 18:03:41 -05003294- CONFIG_SYS_CCSRBAR_PHYS:
3295 Physical address of CCSR. CCSR can be relocated to a new
3296 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003297 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003298 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3299 is typically relocated on 36-bit builds. It is recommended
3300 that this macro be defined via the _HIGH and _LOW macros:
3301
3302 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3303 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3304
3305- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003306 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3307 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003308 used in assembly code, so it must not contain typecasts or
3309 integer size suffixes (e.g. "ULL").
3310
3311- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3312 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3313 used in assembly code, so it must not contain typecasts or
3314 integer size suffixes (e.g. "ULL").
3315
3316- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3317 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3318 forced to a value that ensures that CCSR is not relocated.
3319
wdenk1272e232002-11-10 22:06:23 +00003320- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003321 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003322
3323 the default drive number (default value 0)
3324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003325 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003326
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003327 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003328 (default value 1)
3329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003330 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003331
wdenk4a5c8a72003-03-06 00:02:04 +00003332 defines the offset of register from address. It
3333 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003334 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003335
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003336 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3337 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003338 default value.
wdenk1272e232002-11-10 22:06:23 +00003339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003340 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003341 fdc_hw_init() is called at the beginning of the FDC
3342 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003343 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003344 initializations.
wdenk1272e232002-11-10 22:06:23 +00003345
Macpaul Lind1e49942011-04-11 20:45:32 +00003346- CONFIG_IDE_AHB:
3347 Most IDE controllers were designed to be connected with PCI
3348 interface. Only few of them were designed for AHB interface.
3349 When software is doing ATA command and data transfer to
3350 IDE devices through IDE-AHB controller, some additional
3351 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003352 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003353
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003354- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003355 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003356 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003358- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003359
wdenkeb20ad32003-09-05 23:19:14 +00003360 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003361 initial data and stack; please note that this must be
3362 writable memory that is working WITHOUT special
3363 initialization, i. e. you CANNOT use normal RAM which
3364 will become available only after programming the
3365 memory controller and running certain initialization
3366 sequences.
3367
3368 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003369 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003370
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003371- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003372
3373 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003374 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3375 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003376 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003377 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003378 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003379 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3380 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003381
3382 Note:
3383 On the MPC824X (or other systems that use the data
3384 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003385 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003386 point to an otherwise UNUSED address space between
3387 the top of RAM and the start of the PCI space.
3388
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003389- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003390
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003391- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003392 SDRAM timing
3393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003394- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003395 periodic timer for refresh
3396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003397- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3398 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3399 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3400 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003401 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3402
3403- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003404 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3405 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003406 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3407
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003408- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003409 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003410 Don't do any setup work, presumably because someone or
3411 something has already done it, and we don't need to do it
3412 a second time. Useful for platforms that are pre-booted
3413 by coreboot or similar.
3414
Gabor Juhosb4458732013-05-30 07:06:12 +00003415- CONFIG_PCI_INDIRECT_BRIDGE:
3416 Enable support for indirect PCI bridges.
3417
Kumar Gala8975d7a2010-12-30 12:09:53 -06003418- CONFIG_SYS_SRIO:
3419 Chip has SRIO or not
3420
3421- CONFIG_SRIO1:
3422 Board has SRIO 1 port available
3423
3424- CONFIG_SRIO2:
3425 Board has SRIO 2 port available
3426
Liu Gang27afb9c2013-05-07 16:30:46 +08003427- CONFIG_SRIO_PCIE_BOOT_MASTER
3428 Board can support master function for Boot from SRIO and PCIE
3429
Kumar Gala8975d7a2010-12-30 12:09:53 -06003430- CONFIG_SYS_SRIOn_MEM_VIRT:
3431 Virtual Address of SRIO port 'n' memory region
3432
3433- CONFIG_SYS_SRIOn_MEM_PHYS:
3434 Physical Address of SRIO port 'n' memory region
3435
3436- CONFIG_SYS_SRIOn_MEM_SIZE:
3437 Size of SRIO port 'n' memory region
3438
Fabio Estevamf17e8782013-04-11 09:35:34 +00003439- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3440 Defined to tell the NAND controller that the NAND chip is using
3441 a 16 bit bus.
3442 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003443 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003444 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003445 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003446
3447- CONFIG_SYS_NDFC_EBC0_CFG
3448 Sets the EBC0_CFG register for the NDFC. If not defined
3449 a default value will be used.
3450
Ben Warren45657152006-09-07 16:50:54 -04003451- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003452 Get DDR timing information from an I2C EEPROM. Common
3453 with pluggable memory modules such as SODIMMs
3454
Ben Warren45657152006-09-07 16:50:54 -04003455 SPD_EEPROM_ADDRESS
3456 I2C address of the SPD EEPROM
3457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003458- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003459 If SPD EEPROM is on an I2C bus other than the first
3460 one, specify here. Note that the value must resolve
3461 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003462
York Sune73cc042011-06-07 09:42:16 +08003463- CONFIG_SYS_DDR_RAW_TIMING
3464 Get DDR timing information from other than SPD. Common with
3465 soldered DDR chips onboard without SPD. DDR raw timing
3466 parameters are extracted from datasheet and hard-coded into
3467 header files or board specific files.
3468
York Sunbd495cf2011-09-16 13:21:35 -07003469- CONFIG_FSL_DDR_INTERACTIVE
3470 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3471
York Sun8ced0502015-01-06 13:18:55 -08003472- CONFIG_FSL_DDR_SYNC_REFRESH
3473 Enable sync of refresh for multiple controllers.
3474
York Sunb6a35f82015-03-19 09:30:28 -07003475- CONFIG_FSL_DDR_BIST
3476 Enable built-in memory test for Freescale DDR controllers.
3477
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003478- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003479 Only for 83xx systems. If specified, then DDR should
3480 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003481
wdenk6203e402004-04-18 10:13:26 +00003482- CONFIG_RMII
3483 Enable RMII mode for all FECs.
3484 Note that this is a global option, we can't
3485 have one FEC in standard MII mode and another in RMII mode.
3486
wdenk20c98a62004-04-23 20:32:05 +00003487- CONFIG_CRC32_VERIFY
3488 Add a verify option to the crc32 command.
3489 The syntax is:
3490
3491 => crc32 -v <address> <count> <crc32>
3492
3493 Where address/count indicate a memory area
3494 and crc32 is the correct crc32 which the
3495 area should have.
3496
wdenk64519362004-07-11 17:40:54 +00003497- CONFIG_LOOPW
3498 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003499 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003500
stroesecc3af832004-12-16 18:46:55 +00003501- CONFIG_MX_CYCLIC
3502 Add the "mdc" and "mwc" memory commands. These are cyclic
3503 "md/mw" commands.
3504 Examples:
3505
wdenk07d7e6b2004-12-16 21:44:03 +00003506 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003507 This command will print 4 bytes (10,11,12,13) each 500 ms.
3508
wdenk07d7e6b2004-12-16 21:44:03 +00003509 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003510 This command will write 12345678 to address 100 all 10 ms.
3511
wdenk07d7e6b2004-12-16 21:44:03 +00003512 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003513 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003514
wdenk3d3d99f2005-04-04 12:44:11 +00003515- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003516 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003517 low level initializations (like setting up the memory
3518 controller) are omitted and/or U-Boot does not
3519 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003520
Wolfgang Denk302141d2010-11-27 23:30:56 +01003521 Normally this variable MUST NOT be defined. The only
3522 exception is when U-Boot is loaded (to RAM) by some
3523 other boot loader or by a debugger which performs
3524 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003525
Simon Glass90844072016-05-05 07:28:06 -06003526- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3527 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003528 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003529 instruction cache) is still performed.
3530
Aneesh V552a3192011-07-13 05:11:07 +00003531- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003532 Modifies the behaviour of start.S when compiling a loader
3533 that is executed before the actual U-Boot. E.g. when
3534 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003535
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003536- CONFIG_TPL_BUILD
3537 Modifies the behaviour of start.S when compiling a loader
3538 that is executed after the SPL and before the actual U-Boot.
3539 It is loaded by the SPL.
3540
Ying Zhang0d4f5442013-05-20 14:07:23 +08003541- CONFIG_SYS_MPC85XX_NO_RESETVEC
3542 Only for 85xx systems. If this variable is specified, the section
3543 .resetvec is not kept and the section .bootpg is placed in the
3544 previous 4k of the .text section.
3545
Simon Glass17dabf02013-02-24 17:33:14 +00003546- CONFIG_ARCH_MAP_SYSMEM
3547 Generally U-Boot (and in particular the md command) uses
3548 effective address. It is therefore not necessary to regard
3549 U-Boot address as virtual addresses that need to be translated
3550 to physical addresses. However, sandbox requires this, since
3551 it maintains its own little RAM buffer which contains all
3552 addressable memory. This option causes some memory accesses
3553 to be mapped through map_sysmem() / unmap_sysmem().
3554
Simon Glassbfb59802013-02-14 04:18:54 +00003555- CONFIG_X86_RESET_VECTOR
3556 If defined, the x86 reset vector code is included. This is not
3557 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003558
Heiko Schocher2233e462013-11-04 14:05:00 +01003559- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3560 Enables the RTC32K OSC on AM33xx based plattforms
3561
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003562- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3563 Option to disable subpage write in NAND driver
3564 driver that uses this:
3565 drivers/mtd/nand/davinci_nand.c
3566
Timur Tabi275f4bb2011-11-22 09:21:25 -06003567Freescale QE/FMAN Firmware Support:
3568-----------------------------------
3569
3570The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3571loading of "firmware", which is encoded in the QE firmware binary format.
3572This firmware often needs to be loaded during U-Boot booting, so macros
3573are used to identify the storage device (NOR flash, SPI, etc) and the address
3574within that device.
3575
Zhao Qiang83a90842014-03-21 16:21:44 +08003576- CONFIG_SYS_FMAN_FW_ADDR
3577 The address in the storage device where the FMAN microcode is located. The
3578 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3579 is also specified.
3580
3581- CONFIG_SYS_QE_FW_ADDR
3582 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003583 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3584 is also specified.
3585
3586- CONFIG_SYS_QE_FMAN_FW_LENGTH
3587 The maximum possible size of the firmware. The firmware binary format
3588 has a field that specifies the actual size of the firmware, but it
3589 might not be possible to read any part of the firmware unless some
3590 local storage is allocated to hold the entire firmware first.
3591
3592- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3593 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3594 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3595 virtual address in NOR flash.
3596
3597- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3598 Specifies that QE/FMAN firmware is located in NAND flash.
3599 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3600
3601- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3602 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3603 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3604
Liu Gang1e084582012-03-08 00:33:18 +00003605- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3606 Specifies that QE/FMAN firmware is located in the remote (master)
3607 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003608 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3609 window->master inbound window->master LAW->the ucode address in
3610 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003611
J. German Rivera8ff14b72014-06-23 15:15:55 -07003612Freescale Layerscape Management Complex Firmware Support:
3613---------------------------------------------------------
3614The Freescale Layerscape Management Complex (MC) supports the loading of
3615"firmware".
3616This firmware often needs to be loaded during U-Boot booting, so macros
3617are used to identify the storage device (NOR flash, SPI, etc) and the address
3618within that device.
3619
3620- CONFIG_FSL_MC_ENET
3621 Enable the MC driver for Layerscape SoCs.
3622
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303623Freescale Layerscape Debug Server Support:
3624-------------------------------------------
3625The Freescale Layerscape Debug Server Support supports the loading of
3626"Debug Server firmware" and triggering SP boot-rom.
3627This firmware often needs to be loaded during U-Boot booting.
3628
York Sun928b6812015-12-07 11:08:58 -08003629- CONFIG_SYS_MC_RSV_MEM_ALIGN
3630 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303631
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003632Reproducible builds
3633-------------------
3634
3635In order to achieve reproducible builds, timestamps used in the U-Boot build
3636process have to be set to a fixed value.
3637
3638This is done using the SOURCE_DATE_EPOCH environment variable.
3639SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3640option for U-Boot or an environment variable in U-Boot.
3641
3642SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3643
wdenkc6097192002-11-03 00:24:07 +00003644Building the Software:
3645======================
3646
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003647Building U-Boot has been tested in several native build environments
3648and in many different cross environments. Of course we cannot support
3649all possibly existing versions of cross development tools in all
3650(potentially obsolete) versions. In case of tool chain problems we
3651recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3652which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003653
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003654If you are not using a native environment, it is assumed that you
3655have GNU cross compiling tools available in your path. In this case,
3656you must set the environment variable CROSS_COMPILE in your shell.
3657Note that no changes to the Makefile or any other source files are
3658necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003659
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003660 $ CROSS_COMPILE=ppc_4xx-
3661 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003662
Peter Tyserb06976d2009-03-13 18:54:51 -05003663Note: If you wish to generate Windows versions of the utilities in
3664 the tools directory you can use the MinGW toolchain
3665 (http://www.mingw.org). Set your HOST tools to the MinGW
3666 toolchain and execute 'make tools'. For example:
3667
3668 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3669
3670 Binaries such as tools/mkimage.exe will be created which can
3671 be executed on computers running Windows.
3672
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003673U-Boot is intended to be simple to build. After installing the
3674sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003675is done by typing:
3676
Holger Freyther7ba4e572014-08-04 09:26:05 +02003677 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003678
Holger Freyther7ba4e572014-08-04 09:26:05 +02003679where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003680rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003681
wdenk6c59edc2004-05-03 20:45:30 +00003682Note: for some board special configuration names may exist; check if
3683 additional information is available from the board vendor; for
3684 instance, the TQM823L systems are available without (standard)
3685 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003686 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003687
Holger Freyther7ba4e572014-08-04 09:26:05 +02003688 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003689 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003690
Holger Freyther7ba4e572014-08-04 09:26:05 +02003691 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003692 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk6c59edc2004-05-03 20:45:30 +00003694 etc.
wdenkc6097192002-11-03 00:24:07 +00003695
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk6c59edc2004-05-03 20:45:30 +00003697Finally, type "make all", and you should get some working U-Boot
3698images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk6c59edc2004-05-03 20:45:30 +00003700- "u-boot.bin" is a raw binary image
3701- "u-boot" is an image in ELF binary format
3702- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003703
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003704By default the build is performed locally and the objects are saved
3705in the source directory. One of the two methods can be used to change
3706this behavior and build U-Boot to some external directory:
3707
37081. Add O= to the make command line invocations:
3709
3710 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003711 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003712 make O=/tmp/build all
3713
Timo Ketolac8c67602014-11-06 14:39:05 +020037142. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003715
Timo Ketolac8c67602014-11-06 14:39:05 +02003716 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003717 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003718 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003719 make all
3720
Timo Ketolac8c67602014-11-06 14:39:05 +02003721Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003722variable.
3723
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk6c59edc2004-05-03 20:45:30 +00003725Please be aware that the Makefiles assume you are using GNU make, so
3726for instance on NetBSD you might need to use "gmake" instead of
3727native "make".
wdenkc6097192002-11-03 00:24:07 +00003728
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk6c59edc2004-05-03 20:45:30 +00003730If the system board that you have is not listed, then you will need
3731to port U-Boot to your hardware platform. To do this, follow these
3732steps:
wdenkc6097192002-11-03 00:24:07 +00003733
Phil Sutterc77b4882015-12-25 14:41:18 +010037341. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003735 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003736 the "Makefile" and a "<board>.c".
37372. Create a new configuration file "include/configs/<board>.h" for
3738 your board.
wdenk6c59edc2004-05-03 20:45:30 +000037393. If you're porting U-Boot to a new CPU, then also create a new
3740 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020037414. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000037425. Type "make", and you should get a working "u-boot.srec" file
3743 to be installed on your target system.
37446. Debug and solve any problems that might arise.
3745 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003746
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk6c59edc2004-05-03 20:45:30 +00003748Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3749==============================================================
wdenkc6097192002-11-03 00:24:07 +00003750
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003751If you have modified U-Boot sources (for instance added a new board
3752or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003753provide feedback to the other developers. The feedback normally takes
3754the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003755official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003756
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003757But before you submit such a patch, please verify that your modifi-
3758cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003759the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003760just run the buildman script (tools/buildman/buildman), which will
3761configure and build U-Boot for ALL supported system. Be warned, this
3762will take a while. Please see the buildman README, or run 'buildman -H'
3763for documentation.
wdenkc6097192002-11-03 00:24:07 +00003764
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003765
wdenk6c59edc2004-05-03 20:45:30 +00003766See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003767
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769Monitor Commands - Overview:
3770============================
wdenkc6097192002-11-03 00:24:07 +00003771
wdenk6c59edc2004-05-03 20:45:30 +00003772go - start application at address 'addr'
3773run - run commands in an environment variable
3774bootm - boot application image from memory
3775bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003776bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003777tftpboot- boot image via network using TFTP protocol
3778 and env variables "ipaddr" and "serverip"
3779 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003780tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003781rarpboot- boot image via network using RARP/TFTP protocol
3782diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3783loads - load S-Record file over serial line
3784loadb - load binary file over serial line (kermit mode)
3785md - memory display
3786mm - memory modify (auto-incrementing)
3787nm - memory modify (constant address)
3788mw - memory write (fill)
3789cp - memory copy
3790cmp - memory compare
3791crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003792i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003793sspi - SPI utility commands
3794base - print or set address offset
3795printenv- print environment variables
3796setenv - set environment variables
3797saveenv - save environment variables to persistent storage
3798protect - enable or disable FLASH write protection
3799erase - erase FLASH memory
3800flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003801nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003802bdinfo - print Board Info structure
3803iminfo - print header information for application image
3804coninfo - print console devices and informations
3805ide - IDE sub-system
3806loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003807loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003808mtest - simple RAM test
3809icache - enable or disable instruction cache
3810dcache - enable or disable data cache
3811reset - Perform RESET of the CPU
3812echo - echo args to console
3813version - print monitor version
3814help - print online help
3815? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003816
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk6c59edc2004-05-03 20:45:30 +00003818Monitor Commands - Detailed Description:
3819========================================
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk6c59edc2004-05-03 20:45:30 +00003821TODO.
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk6c59edc2004-05-03 20:45:30 +00003823For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003824
3825
wdenk6c59edc2004-05-03 20:45:30 +00003826Environment Variables:
3827======================
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk6c59edc2004-05-03 20:45:30 +00003829U-Boot supports user configuration using Environment Variables which
3830can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk6c59edc2004-05-03 20:45:30 +00003832Environment Variables are set using "setenv", printed using
3833"printenv", and saved to Flash using "saveenv". Using "setenv"
3834without a value can be used to delete a variable from the
3835environment. As long as you don't save the environment you are
3836working with an in-memory copy. In case the Flash area containing the
3837environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003838
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003839Some configuration options can be set using Environment Variables.
3840
3841List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk6c59edc2004-05-03 20:45:30 +00003845 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk6c59edc2004-05-03 20:45:30 +00003847 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk6c59edc2004-05-03 20:45:30 +00003849 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk6c59edc2004-05-03 20:45:30 +00003851 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003852
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003853 bootm_low - Memory range available for image processing in the bootm
3854 command can be restricted. This variable is given as
3855 a hexadecimal number and defines lowest address allowed
3856 for use by the bootm command. See also "bootm_size"
3857 environment variable. Address defined by "bootm_low" is
3858 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003859 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3860 bootm_mapsize.
3861
Wolfgang Denk092ae952011-10-26 10:21:21 +00003862 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003863 This variable is given as a hexadecimal number and it
3864 defines the size of the memory region starting at base
3865 address bootm_low that is accessible by the Linux kernel
3866 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3867 as the default value if it is defined, and bootm_size is
3868 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003869
3870 bootm_size - Memory range available for image processing in the bootm
3871 command can be restricted. This variable is given as
3872 a hexadecimal number and defines the size of the region
3873 allowed for use by the bootm command. See also "bootm_low"
3874 environment variable.
3875
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003876 updatefile - Location of the software update file on a TFTP server, used
3877 by the automatic software update feature. Please refer to
3878 documentation in doc/README.update for more details.
3879
wdenk6c59edc2004-05-03 20:45:30 +00003880 autoload - if set to "no" (any string beginning with 'n'),
3881 "bootp" will just load perform a lookup of the
3882 configuration from the BOOTP server, but not try to
3883 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885 autostart - if set to "yes", an image loaded using the "bootp",
3886 "rarpboot", "tftpboot" or "diskboot" commands will
3887 be automatically started (by internally calling
3888 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003889
wdenk6c59edc2004-05-03 20:45:30 +00003890 If set to "no", a standalone image passed to the
3891 "bootm" command will be copied to the load address
3892 (and eventually uncompressed), but NOT be started.
3893 This can be used to load and uncompress arbitrary
3894 data.
wdenkc6097192002-11-03 00:24:07 +00003895
David A. Longd558a4e2011-07-09 16:40:19 -04003896 fdt_high - if set this restricts the maximum address that the
3897 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003898 For example, if you have a system with 1 GB memory
3899 at physical address 0x10000000, while Linux kernel
3900 only recognizes the first 704 MB as low memory, you
3901 may need to set fdt_high as 0x3C000000 to have the
3902 device tree blob be copied to the maximum address
3903 of the 704 MB low memory, so that Linux kernel can
3904 access it during the boot procedure.
3905
David A. Longd558a4e2011-07-09 16:40:19 -04003906 If this is set to the special value 0xFFFFFFFF then
3907 the fdt will not be copied at all on boot. For this
3908 to work it must reside in writable memory, have
3909 sufficient padding on the end of it for u-boot to
3910 add the information it needs into it, and the memory
3911 must be accessible by the kernel.
3912
Simon Glassdc6fa642011-10-24 19:15:34 +00003913 fdtcontroladdr- if set this is the address of the control flattened
3914 device tree used by U-Boot when CONFIG_OF_CONTROL is
3915 defined.
3916
wdenk0e2bd9c2004-06-06 21:51:03 +00003917 i2cfast - (PPC405GP|PPC405EP only)
3918 if set to 'y' configures Linux I2C driver for fast
3919 mode (400kHZ). This environment variable is used in
3920 initialization code. So, for changes to be effective
3921 it must be saved and board must be reset.
3922
wdenk6c59edc2004-05-03 20:45:30 +00003923 initrd_high - restrict positioning of initrd images:
3924 If this variable is not set, initrd images will be
3925 copied to the highest possible address in RAM; this
3926 is usually what you want since it allows for
3927 maximum initrd size. If for some reason you want to
3928 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003930 variable to a value of "no" or "off" or "0".
3931 Alternatively, you can set it to a maximum upper
3932 address to use (U-Boot will still check that it
3933 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk6c59edc2004-05-03 20:45:30 +00003935 For instance, when you have a system with 16 MB
3936 RAM, and want to reserve 4 MB from use by Linux,
3937 you can do this by adding "mem=12M" to the value of
3938 the "bootargs" variable. However, now you must make
3939 sure that the initrd image is placed in the first
3940 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944 If you set initrd_high to 0xFFFFFFFF, this is an
3945 indication to U-Boot that all addresses are legal
3946 for the Linux kernel, including addresses in flash
3947 memory. In this case U-Boot will NOT COPY the
3948 ramdisk at all. This may be useful to reduce the
3949 boot time on your system, but requires that this
3950 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003951
wdenk6c59edc2004-05-03 20:45:30 +00003952 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk6c59edc2004-05-03 20:45:30 +00003954 loadaddr - Default load address for commands like "bootp",
3955 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk6c59edc2004-05-03 20:45:30 +00003957 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003958
wdenk6c59edc2004-05-03 20:45:30 +00003959 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003960
wdenk6c59edc2004-05-03 20:45:30 +00003961 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk6c59edc2004-05-03 20:45:30 +00003963 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk6c59edc2004-05-03 20:45:30 +00003965 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003966
Mike Frysingera23230c2011-10-02 10:01:27 +00003967 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003968
Mike Frysingera23230c2011-10-02 10:01:27 +00003969 ethact - controls which interface is currently active.
3970 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003971
Heiko Schocherc5e84052010-07-20 17:45:02 +02003972 => setenv ethact FEC
3973 => ping 192.168.0.1 # traffic sent on FEC
3974 => setenv ethact SCC
3975 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003976
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003977 ethrotate - When set to "no" U-Boot does not go through all
3978 available network interfaces.
3979 It just stays at the currently selected interface.
3980
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003981 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003982 either succeed or fail without retrying.
3983 When set to "once" the network operation will
3984 fail when all the available network interfaces
3985 are tried once without success.
3986 Useful on scripts which control the retry operation
3987 themselves.
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003989 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003990
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003991 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003992 changing the console to be empty. If "yes" it will be
3993 made silent. If "no" it will not be made silent. If
3994 unset, then it will be made silent if the U-Boot console
3995 is silent.
3996
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003997 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003998 UDP source port.
3999
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004000 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004001 destination port instead of the Well Know Port 69.
4002
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004003 tftpblocksize - Block size to use for TFTP transfers; if not set,
4004 we use the TFTP server's default block size
4005
4006 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4007 seconds, minimum value is 1000 = 1 second). Defines
4008 when a packet is considered to be lost so it has to
4009 be retransmitted. The default is 5000 = 5 seconds.
4010 Lowering this value may make downloads succeed
4011 faster in networks with high packet loss rates or
4012 with unreliable TFTP servers.
4013
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004014 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4015 unit, minimum value = 0). Defines how many timeouts
4016 can happen during a single file transfer before that
4017 transfer is aborted. The default is 10, and 0 means
4018 'no timeouts allowed'. Increasing this value may help
4019 downloads succeed with high packet loss rates, or with
4020 unreliable TFTP servers or client hardware.
4021
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004022 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004023 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004024 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004025
Alexandre Messier15971322016-02-01 17:08:57 -05004026 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4027 Unsigned value, in milliseconds. If not set, the period will
4028 be either the default (28000), or a value based on
4029 CONFIG_NET_RETRY_COUNT, if defined. This value has
4030 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4031
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004032The following image location variables contain the location of images
4033used in booting. The "Image" column gives the role of the image and is
4034not an environment variable name. The other columns are environment
4035variable names. "File Name" gives the name of the file on a TFTP
4036server, "RAM Address" gives the location in RAM the image will be
4037loaded to, and "Flash Location" gives the image's address in NOR
4038flash or offset in NAND flash.
4039
4040*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004041boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004042boards use these variables for other purposes.
4043
Wolfgang Denk092ae952011-10-26 10:21:21 +00004044Image File Name RAM Address Flash Location
4045----- --------- ----------- --------------
4046u-boot u-boot u-boot_addr_r u-boot_addr
4047Linux kernel bootfile kernel_addr_r kernel_addr
4048device tree blob fdtfile fdt_addr_r fdt_addr
4049ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004050
wdenk6c59edc2004-05-03 20:45:30 +00004051The following environment variables may be used and automatically
4052updated by the network boot commands ("bootp" and "rarpboot"),
4053depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004054
wdenk6c59edc2004-05-03 20:45:30 +00004055 bootfile - see above
4056 dnsip - IP address of your Domain Name Server
4057 dnsip2 - IP address of your secondary Domain Name Server
4058 gatewayip - IP address of the Gateway (Router) to use
4059 hostname - Target hostname
4060 ipaddr - see above
4061 netmask - Subnet Mask
4062 rootpath - Pathname of the root filesystem on the NFS server
4063 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004064
wdenk145d2c12004-04-15 21:48:45 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk6c59edc2004-05-03 20:45:30 +00004068 serial# - contains hardware identification information such
4069 as type string and/or serial number
4070 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072These variables can be set only once (usually during manufacturing of
4073the board). U-Boot refuses to delete or overwrite these variables
4074once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004075
4076
wdenk6c59edc2004-05-03 20:45:30 +00004077Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk6c59edc2004-05-03 20:45:30 +00004079 ver - Contains the U-Boot version string as printed
4080 with the "version" command. This variable is
4081 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004082
wdenkc6097192002-11-03 00:24:07 +00004083
wdenk6c59edc2004-05-03 20:45:30 +00004084Please note that changes to some configuration parameters may take
4085only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004086
stroeseb9c17c52003-04-04 15:53:41 +00004087
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004088Callback functions for environment variables:
4089---------------------------------------------
4090
4091For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004092when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004093be associated with arbitrary variables. On creation, overwrite, or
4094deletion, the callback will provide the opportunity for some side
4095effect to happen or for the change to be rejected.
4096
4097The callbacks are named and associated with a function using the
4098U_BOOT_ENV_CALLBACK macro in your board or driver code.
4099
4100These callbacks are associated with variables in one of two ways. The
4101static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4102in the board configuration to a string that defines a list of
4103associations. The list must be in the following format:
4104
4105 entry = variable_name[:callback_name]
4106 list = entry[,list]
4107
4108If the callback name is not specified, then the callback is deleted.
4109Spaces are also allowed anywhere in the list.
4110
4111Callbacks can also be associated by defining the ".callbacks" variable
4112with the same list format above. Any association in ".callbacks" will
4113override any association in the static list. You can define
4114CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004115".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004116
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004117If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4118regular expression. This allows multiple variables to be connected to
4119the same callback without explicitly listing them all out.
4120
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004121
wdenk6c59edc2004-05-03 20:45:30 +00004122Command Line Parsing:
4123=====================
stroeseb9c17c52003-04-04 15:53:41 +00004124
wdenk6c59edc2004-05-03 20:45:30 +00004125There are two different command line parsers available with U-Boot:
4126the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk6c59edc2004-05-03 20:45:30 +00004128Old, simple command line parser:
4129--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131- supports environment variables (through setenv / saveenv commands)
4132- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004133- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004134- special characters ('$', ';') can be escaped by prefixing with '\',
4135 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004136 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004137- You can also escape text by enclosing in single apostrophes, for example:
4138 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk6c59edc2004-05-03 20:45:30 +00004140Hush shell:
4141-----------
wdenkf4688a22003-05-28 08:06:31 +00004142
wdenk6c59edc2004-05-03 20:45:30 +00004143- similar to Bourne shell, with control structures like
4144 if...then...else...fi, for...do...done; while...do...done,
4145 until...do...done, ...
4146- supports environment ("global") variables (through setenv / saveenv
4147 commands) and local shell variables (through standard shell syntax
4148 "name=value"); only environment variables can be used with "run"
4149 command
wdenkf4688a22003-05-28 08:06:31 +00004150
wdenk6c59edc2004-05-03 20:45:30 +00004151General rules:
4152--------------
wdenkf4688a22003-05-28 08:06:31 +00004153
wdenk6c59edc2004-05-03 20:45:30 +00004154(1) If a command line (or an environment variable executed by a "run"
4155 command) contains several commands separated by semicolon, and
4156 one of these commands fails, then the remaining commands will be
4157 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004158
wdenk6c59edc2004-05-03 20:45:30 +00004159(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004160 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004161 command will cause "run" to terminate, i. e. the remaining
4162 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004163
wdenk6c59edc2004-05-03 20:45:30 +00004164Note for Redundant Ethernet Interfaces:
4165=======================================
wdenkf4688a22003-05-28 08:06:31 +00004166
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004167Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004168such configurations and is capable of automatic selection of a
4169"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004170
wdenk6c59edc2004-05-03 20:45:30 +00004171Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4172MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4173"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004174
wdenk6c59edc2004-05-03 20:45:30 +00004175If the network interface stores some valid MAC address (for instance
4176in SROM), this is used as default address if there is NO correspon-
4177ding setting in the environment; if the corresponding environment
4178variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004179
wdenk6c59edc2004-05-03 20:45:30 +00004180o If the SROM has a valid MAC address, and there is no address in the
4181 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk6c59edc2004-05-03 20:45:30 +00004183o If there is no valid address in the SROM, and a definition in the
4184 environment exists, then the value from the environment variable is
4185 used.
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk6c59edc2004-05-03 20:45:30 +00004187o If both the SROM and the environment contain a MAC address, and
4188 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk6c59edc2004-05-03 20:45:30 +00004190o If both the SROM and the environment contain a MAC address, and the
4191 addresses differ, the value from the environment is used and a
4192 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk6c59edc2004-05-03 20:45:30 +00004194o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004195 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4196 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004197
Ben Warren6db991a2010-04-26 11:11:46 -07004198If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004199will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004200may be skipped by setting the appropriate 'ethmacskip' environment variable.
4201The naming convention is as follows:
4202"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk6c59edc2004-05-03 20:45:30 +00004204Image Formats:
4205==============
wdenkc6097192002-11-03 00:24:07 +00004206
Marian Balakowicz18710b82008-03-12 12:13:13 +01004207U-Boot is capable of booting (and performing other auxiliary operations on)
4208images in two formats:
4209
4210New uImage format (FIT)
4211-----------------------
4212
4213Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4214to Flattened Device Tree). It allows the use of images with multiple
4215components (several kernels, ramdisks, etc.), with contents protected by
4216SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4217
4218
4219Old uImage format
4220-----------------
4221
4222Old image format is based on binary files which can be basically anything,
4223preceded by a special header; see the definitions in include/image.h for
4224details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004225
wdenk6c59edc2004-05-03 20:45:30 +00004226* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4227 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004228 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4229 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4230 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004231* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004232 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004233 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004234* Compression Type (uncompressed, gzip, bzip2)
4235* Load Address
4236* Entry Point
4237* Image Name
4238* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk6c59edc2004-05-03 20:45:30 +00004240The header is marked by a special Magic Number, and both the header
4241and the data portions of the image are secured against corruption by
4242CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004243
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk6c59edc2004-05-03 20:45:30 +00004245Linux Support:
4246==============
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk6c59edc2004-05-03 20:45:30 +00004248Although U-Boot should support any OS or standalone application
4249easily, the main focus has always been on Linux during the design of
4250U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk6c59edc2004-05-03 20:45:30 +00004252U-Boot includes many features that so far have been part of some
4253special "boot loader" code within the Linux kernel. Also, any
4254"initrd" images to be used are no longer part of one big Linux image;
4255instead, kernel and "initrd" are separate images. This implementation
4256serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258- the same features can be used for other OS or standalone
4259 applications (for instance: using compressed images to reduce the
4260 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk6c59edc2004-05-03 20:45:30 +00004262- it becomes much easier to port new Linux kernel versions because
4263 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk6c59edc2004-05-03 20:45:30 +00004265- the same Linux kernel image can now be used with different "initrd"
4266 images; of course this also means that different kernel images can
4267 be run with the same "initrd". This makes testing easier (you don't
4268 have to build a new "zImage.initrd" Linux image when you just
4269 change a file in your "initrd"). Also, a field-upgrade of the
4270 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004271
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk6c59edc2004-05-03 20:45:30 +00004273Linux HOWTO:
4274============
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk6c59edc2004-05-03 20:45:30 +00004276Porting Linux to U-Boot based systems:
4277---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279U-Boot cannot save you from doing all the necessary modifications to
4280configure the Linux device drivers for use with your target hardware
4281(no, we don't intend to provide a full virtual machine interface to
4282Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004283
Stefan Roese88fbf932010-04-15 16:07:28 +02004284But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk6c59edc2004-05-03 20:45:30 +00004286Just make sure your machine specific header file (for instance
4287include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004288Information structure as we define in include/asm-<arch>/u-boot.h,
4289and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004290as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004291
Simon Glassd097e592014-06-11 23:29:46 -06004292Note that U-Boot now has a driver model, a unified model for drivers.
4293If you are adding a new driver, plumb it into driver model. If there
4294is no uclass available, you are encouraged to create one. See
4295doc/driver-model.
4296
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk6c59edc2004-05-03 20:45:30 +00004298Configuring the Linux kernel:
4299-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk6c59edc2004-05-03 20:45:30 +00004301No specific requirements for U-Boot. Make sure you have some root
4302device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004303
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk6c59edc2004-05-03 20:45:30 +00004305Building a Linux Image:
4306-----------------------
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk6c59edc2004-05-03 20:45:30 +00004308With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4309not used. If you use recent kernel source, a new build target
4310"uImage" will exist which automatically builds an image usable by
4311U-Boot. Most older kernels also have support for a "pImage" target,
4312which was introduced for our predecessor project PPCBoot and uses a
4313100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk6c59edc2004-05-03 20:45:30 +00004315Example:
wdenkc6097192002-11-03 00:24:07 +00004316
Holger Freyther7ba4e572014-08-04 09:26:05 +02004317 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004318 make oldconfig
4319 make dep
4320 make uImage
wdenkc6097192002-11-03 00:24:07 +00004321
wdenk6c59edc2004-05-03 20:45:30 +00004322The "uImage" build target uses a special tool (in 'tools/mkimage') to
4323encapsulate a compressed Linux kernel image with header information,
4324CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk6c59edc2004-05-03 20:45:30 +00004326* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk6c59edc2004-05-03 20:45:30 +00004328* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330 ${CROSS_COMPILE}-objcopy -O binary \
4331 -R .note -R .comment \
4332 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004333
wdenk6c59edc2004-05-03 20:45:30 +00004334* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004337
wdenk6c59edc2004-05-03 20:45:30 +00004338* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340 mkimage -A ppc -O linux -T kernel -C gzip \
4341 -a 0 -e 0 -n "Linux Kernel Image" \
4342 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004343
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk6c59edc2004-05-03 20:45:30 +00004345The "mkimage" tool can also be used to create ramdisk images for use
4346with U-Boot, either separated from the Linux kernel image, or
4347combined into one file. "mkimage" encapsulates the images with a 64
4348byte header containing information about target architecture,
4349operating system, image type, compression method, entry points, time
4350stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk6c59edc2004-05-03 20:45:30 +00004352"mkimage" can be called in two ways: to verify existing images and
4353print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004354
wdenk6c59edc2004-05-03 20:45:30 +00004355In the first form (with "-l" option) mkimage lists the information
4356contained in the header of an existing U-Boot image; this includes
4357checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004358
wdenk6c59edc2004-05-03 20:45:30 +00004359 tools/mkimage -l image
4360 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362The second form (with "-d" option) is used to build a U-Boot image
4363from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4366 -n name -d data_file image
4367 -A ==> set architecture to 'arch'
4368 -O ==> set operating system to 'os'
4369 -T ==> set image type to 'type'
4370 -C ==> set compression type 'comp'
4371 -a ==> set load address to 'addr' (hex)
4372 -e ==> set entry point to 'ep' (hex)
4373 -n ==> set image name to 'name'
4374 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004375
wdenkcd914452004-05-29 16:53:29 +00004376Right now, all Linux kernels for PowerPC systems use the same load
4377address (0x00000000), but the entry point address depends on the
4378kernel version:
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk6c59edc2004-05-03 20:45:30 +00004380- 2.2.x kernels have the entry point at 0x0000000C,
4381- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk6c59edc2004-05-03 20:45:30 +00004385 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4386 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004387 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004388 > examples/uImage.TQM850L
4389 Image Name: 2.4.4 kernel for TQM850L
4390 Created: Wed Jul 19 02:34:59 2000
4391 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4392 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4393 Load Address: 0x00000000
4394 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004395
wdenk6c59edc2004-05-03 20:45:30 +00004396To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004397
wdenk6c59edc2004-05-03 20:45:30 +00004398 -> tools/mkimage -l examples/uImage.TQM850L
4399 Image Name: 2.4.4 kernel for TQM850L
4400 Created: Wed Jul 19 02:34:59 2000
4401 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4402 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4403 Load Address: 0x00000000
4404 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk6c59edc2004-05-03 20:45:30 +00004406NOTE: for embedded systems where boot time is critical you can trade
4407speed for memory and install an UNCOMPRESSED image instead: this
4408needs more space in Flash, but boots much faster since it does not
4409need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004410
Stefan Roese88fbf932010-04-15 16:07:28 +02004411 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004412 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4413 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004414 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004415 > examples/uImage.TQM850L-uncompressed
4416 Image Name: 2.4.4 kernel for TQM850L
4417 Created: Wed Jul 19 02:34:59 2000
4418 Image Type: PowerPC Linux Kernel Image (uncompressed)
4419 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4420 Load Address: 0x00000000
4421 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004422
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk6c59edc2004-05-03 20:45:30 +00004424Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4425when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk6c59edc2004-05-03 20:45:30 +00004427 -> tools/mkimage -n 'Simple Ramdisk Image' \
4428 > -A ppc -O linux -T ramdisk -C gzip \
4429 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4430 Image Name: Simple Ramdisk Image
4431 Created: Wed Jan 12 14:01:50 2000
4432 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4433 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4434 Load Address: 0x00000000
4435 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004436
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004437The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4438option performs the converse operation of the mkimage's second form (the "-d"
4439option). Given an image built by mkimage, the dumpimage extracts a "data file"
4440from the image:
4441
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004442 tools/dumpimage -i image -T type -p position data_file
4443 -i ==> extract from the 'image' a specific 'data_file'
4444 -T ==> set image type to 'type'
4445 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004446
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448Installing a Linux Image:
4449-------------------------
wdenkc6097192002-11-03 00:24:07 +00004450
wdenk6c59edc2004-05-03 20:45:30 +00004451To downloading a U-Boot image over the serial (console) interface,
4452you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk6c59edc2004-05-03 20:45:30 +00004454 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004455
wdenk6c59edc2004-05-03 20:45:30 +00004456The 'objcopy' does not understand the information in the U-Boot
4457image header, so the resulting S-Record file will be relative to
4458address 0x00000000. To load it to a given address, you need to
4459specify the target address as 'offset' parameter with the 'loads'
4460command.
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462Example: install the image to address 0x40100000 (which on the
4463TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk6c59edc2004-05-03 20:45:30 +00004465 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk6c59edc2004-05-03 20:45:30 +00004467 .......... done
4468 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004469
wdenk6c59edc2004-05-03 20:45:30 +00004470 => loads 40100000
4471 ## Ready for S-Record download ...
4472 ~>examples/image.srec
4473 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4474 ...
4475 15989 15990 15991 15992
4476 [file transfer complete]
4477 [connected]
4478 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004479
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004482this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004483corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487 ## Checking Image at 40100000 ...
4488 Image Name: 2.2.13 for initrd on TQM850L
4489 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4490 Data Size: 335725 Bytes = 327 kB = 0 MB
4491 Load Address: 00000000
4492 Entry Point: 0000000c
4493 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004494
4495
wdenk6c59edc2004-05-03 20:45:30 +00004496Boot Linux:
4497-----------
wdenkc6097192002-11-03 00:24:07 +00004498
wdenk6c59edc2004-05-03 20:45:30 +00004499The "bootm" command is used to boot an application that is stored in
4500memory (RAM or Flash). In case of a Linux kernel image, the contents
4501of the "bootargs" environment variable is passed to the kernel as
4502parameters. You can check and modify this variable using the
4503"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004504
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk6c59edc2004-05-03 20:45:30 +00004506 => printenv bootargs
4507 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509 => 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 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511 => printenv bootargs
4512 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 +00004513
wdenk6c59edc2004-05-03 20:45:30 +00004514 => bootm 40020000
4515 ## Booting Linux kernel at 40020000 ...
4516 Image Name: 2.2.13 for NFS on TQM850L
4517 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4518 Data Size: 381681 Bytes = 372 kB = 0 MB
4519 Load Address: 00000000
4520 Entry Point: 0000000c
4521 Verifying Checksum ... OK
4522 Uncompressing Kernel Image ... OK
4523 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
4524 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4525 time_init: decrementer frequency = 187500000/60
4526 Calibrating delay loop... 49.77 BogoMIPS
4527 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4528 ...
wdenkc6097192002-11-03 00:24:07 +00004529
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004530If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004531the memory addresses of both the kernel and the initrd image (PPBCOOT
4532format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk6c59edc2004-05-03 20:45:30 +00004536 ## Checking Image at 40100000 ...
4537 Image Name: 2.2.13 for initrd on TQM850L
4538 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4539 Data Size: 335725 Bytes = 327 kB = 0 MB
4540 Load Address: 00000000
4541 Entry Point: 0000000c
4542 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544 ## Checking Image at 40200000 ...
4545 Image Name: Simple Ramdisk Image
4546 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4547 Data Size: 566530 Bytes = 553 kB = 0 MB
4548 Load Address: 00000000
4549 Entry Point: 00000000
4550 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552 => bootm 40100000 40200000
4553 ## Booting Linux kernel at 40100000 ...
4554 Image Name: 2.2.13 for initrd on TQM850L
4555 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4556 Data Size: 335725 Bytes = 327 kB = 0 MB
4557 Load Address: 00000000
4558 Entry Point: 0000000c
4559 Verifying Checksum ... OK
4560 Uncompressing Kernel Image ... OK
4561 ## Loading RAMDisk Image at 40200000 ...
4562 Image Name: Simple Ramdisk Image
4563 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4564 Data Size: 566530 Bytes = 553 kB = 0 MB
4565 Load Address: 00000000
4566 Entry Point: 00000000
4567 Verifying Checksum ... OK
4568 Loading Ramdisk ... OK
4569 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
4570 Boot arguments: root=/dev/ram
4571 time_init: decrementer frequency = 187500000/60
4572 Calibrating delay loop... 49.77 BogoMIPS
4573 ...
4574 RAMDISK: Compressed image found at block 0
4575 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004576
wdenk6c59edc2004-05-03 20:45:30 +00004577 bash#
wdenkc6097192002-11-03 00:24:07 +00004578
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004579Boot Linux and pass a flat device tree:
4580-----------
4581
4582First, U-Boot must be compiled with the appropriate defines. See the section
4583titled "Linux Kernel Interface" above for a more in depth explanation. The
4584following is an example of how to start a kernel and pass an updated
4585flat device tree:
4586
4587=> print oftaddr
4588oftaddr=0x300000
4589=> print oft
4590oft=oftrees/mpc8540ads.dtb
4591=> tftp $oftaddr $oft
4592Speed: 1000, full duplex
4593Using TSEC0 device
4594TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4595Filename 'oftrees/mpc8540ads.dtb'.
4596Load address: 0x300000
4597Loading: #
4598done
4599Bytes transferred = 4106 (100a hex)
4600=> tftp $loadaddr $bootfile
4601Speed: 1000, full duplex
4602Using TSEC0 device
4603TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4604Filename 'uImage'.
4605Load address: 0x200000
4606Loading:############
4607done
4608Bytes transferred = 1029407 (fb51f hex)
4609=> print loadaddr
4610loadaddr=200000
4611=> print oftaddr
4612oftaddr=0x300000
4613=> bootm $loadaddr - $oftaddr
4614## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004615 Image Name: Linux-2.6.17-dirty
4616 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4617 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004618 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004619 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004620 Verifying Checksum ... OK
4621 Uncompressing Kernel Image ... OK
4622Booting using flat device tree at 0x300000
4623Using MPC85xx ADS machine description
4624Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4625[snip]
4626
4627
wdenk6c59edc2004-05-03 20:45:30 +00004628More About U-Boot Image Types:
4629------------------------------
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk6c59edc2004-05-03 20:45:30 +00004631U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633 "Standalone Programs" are directly runnable in the environment
4634 provided by U-Boot; it is expected that (if they behave
4635 well) you can continue to work in U-Boot after return from
4636 the Standalone Program.
4637 "OS Kernel Images" are usually images of some Embedded OS which
4638 will take over control completely. Usually these programs
4639 will install their own set of exception handlers, device
4640 drivers, set up the MMU, etc. - this means, that you cannot
4641 expect to re-enter U-Boot except by resetting the CPU.
4642 "RAMDisk Images" are more or less just data blocks, and their
4643 parameters (address, size) are passed to an OS kernel that is
4644 being started.
4645 "Multi-File Images" contain several images, typically an OS
4646 (Linux) kernel image and one or more data images like
4647 RAMDisks. This construct is useful for instance when you want
4648 to boot over the network using BOOTP etc., where the boot
4649 server provides just a single image file, but you want to get
4650 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk6c59edc2004-05-03 20:45:30 +00004652 "Multi-File Images" start with a list of image sizes, each
4653 image size (in bytes) specified by an "uint32_t" in network
4654 byte order. This list is terminated by an "(uint32_t)0".
4655 Immediately after the terminating 0 follow the images, one by
4656 one, all aligned on "uint32_t" boundaries (size rounded up to
4657 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk6c59edc2004-05-03 20:45:30 +00004659 "Firmware Images" are binary images containing firmware (like
4660 U-Boot or FPGA images) which usually will be programmed to
4661 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004662
wdenk6c59edc2004-05-03 20:45:30 +00004663 "Script files" are command sequences that will be executed by
4664 U-Boot's command interpreter; this feature is especially
4665 useful when you configure U-Boot to use a real shell (hush)
4666 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004667
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004668Booting the Linux zImage:
4669-------------------------
4670
4671On some platforms, it's possible to boot Linux zImage. This is done
4672using the "bootz" command. The syntax of "bootz" command is the same
4673as the syntax of "bootm" command.
4674
Tom Rini45f46d12013-05-16 11:40:11 -04004675Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004676kernel with raw initrd images. The syntax is slightly different, the
4677address of the initrd must be augmented by it's size, in the following
4678format: "<initrd addres>:<initrd size>".
4679
stroeseb9c17c52003-04-04 15:53:41 +00004680
wdenk6c59edc2004-05-03 20:45:30 +00004681Standalone HOWTO:
4682=================
stroeseb9c17c52003-04-04 15:53:41 +00004683
wdenk6c59edc2004-05-03 20:45:30 +00004684One of the features of U-Boot is that you can dynamically load and
4685run "standalone" applications, which can use some resources of
4686U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004689
wdenk6c59edc2004-05-03 20:45:30 +00004690"Hello World" Demo:
4691-------------------
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk6c59edc2004-05-03 20:45:30 +00004693'examples/hello_world.c' contains a small "Hello World" Demo
4694application; it is automatically compiled when you build U-Boot.
4695It's configured to run at address 0x00040004, so you can play with it
4696like that:
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698 => loads
4699 ## Ready for S-Record download ...
4700 ~>examples/hello_world.srec
4701 1 2 3 4 5 6 7 8 9 10 11 ...
4702 [file transfer complete]
4703 [connected]
4704 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004705
wdenk6c59edc2004-05-03 20:45:30 +00004706 => go 40004 Hello World! This is a test.
4707 ## Starting application at 0x00040004 ...
4708 Hello World
4709 argc = 7
4710 argv[0] = "40004"
4711 argv[1] = "Hello"
4712 argv[2] = "World!"
4713 argv[3] = "This"
4714 argv[4] = "is"
4715 argv[5] = "a"
4716 argv[6] = "test."
4717 argv[7] = "<NULL>"
4718 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk6c59edc2004-05-03 20:45:30 +00004722Another example, which demonstrates how to register a CPM interrupt
4723handler with the U-Boot code, can be found in 'examples/timer.c'.
4724Here, a CPM timer is set up to generate an interrupt every second.
4725The interrupt service routine is trivial, just printing a '.'
4726character, but this is just a demo program. The application can be
4727controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004728
wdenk6c59edc2004-05-03 20:45:30 +00004729 ? - print current values og the CPM Timer registers
4730 b - enable interrupts and start timer
4731 e - stop timer and disable interrupts
4732 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004733
wdenk6c59edc2004-05-03 20:45:30 +00004734 => loads
4735 ## Ready for S-Record download ...
4736 ~>examples/timer.srec
4737 1 2 3 4 5 6 7 8 9 10 11 ...
4738 [file transfer complete]
4739 [connected]
4740 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742 => go 40004
4743 ## Starting application at 0x00040004 ...
4744 TIMERS=0xfff00980
4745 Using timer 1
4746 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk6c59edc2004-05-03 20:45:30 +00004748Hit 'b':
4749 [q, b, e, ?] Set interval 1000000 us
4750 Enabling timer
4751Hit '?':
4752 [q, b, e, ?] ........
4753 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4754Hit '?':
4755 [q, b, e, ?] .
4756 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4757Hit '?':
4758 [q, b, e, ?] .
4759 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4760Hit '?':
4761 [q, b, e, ?] .
4762 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4763Hit 'e':
4764 [q, b, e, ?] ...Stopping timer
4765Hit 'q':
4766 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004767
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769Minicom warning:
4770================
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772Over time, many people have reported problems when trying to use the
4773"minicom" terminal emulation program for serial download. I (wd)
4774consider minicom to be broken, and recommend not to use it. Under
4775Unix, I recommend to use C-Kermit for general purpose use (and
4776especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004777use "cu" for S-Record download ("loads" command). See
4778http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4779for help with kermit.
4780
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782Nevertheless, if you absolutely want to use it try adding this
4783configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004784
wdenk6c59edc2004-05-03 20:45:30 +00004785 Name Program Name U/D FullScr IO-Red. Multi
4786 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4787 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004788
wdenk8dba0502003-03-31 16:34:49 +00004789
wdenk6c59edc2004-05-03 20:45:30 +00004790NetBSD Notes:
4791=============
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk6c59edc2004-05-03 20:45:30 +00004793Starting at version 0.9.2, U-Boot supports NetBSD both as host
4794(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004795
wdenk6c59edc2004-05-03 20:45:30 +00004796Building requires a cross environment; it is known to work on
4797NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4798need gmake since the Makefiles are not compatible with BSD make).
4799Note that the cross-powerpc package does not install include files;
4800attempting to build U-Boot will fail because <machine/ansi.h> is
4801missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004802
wdenk6c59edc2004-05-03 20:45:30 +00004803 # cd /usr/pkg/cross/powerpc-netbsd/include
4804 # mkdir powerpc
4805 # ln -s powerpc machine
4806 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4807 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004808
wdenk6c59edc2004-05-03 20:45:30 +00004809Native builds *don't* work due to incompatibilities between native
4810and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk6c59edc2004-05-03 20:45:30 +00004812Booting assumes that (the first part of) the image booted is a
4813stage-2 loader which in turn loads and then invokes the kernel
4814proper. Loader sources will eventually appear in the NetBSD source
4815tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004816meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004817
wdenkc6097192002-11-03 00:24:07 +00004818
wdenk6c59edc2004-05-03 20:45:30 +00004819Implementation Internals:
4820=========================
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk6c59edc2004-05-03 20:45:30 +00004822The following is not intended to be a complete description of every
4823implementation detail. However, it should help to understand the
4824inner workings of U-Boot and make it easier to port it to custom
4825hardware.
wdenkc6097192002-11-03 00:24:07 +00004826
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk6c59edc2004-05-03 20:45:30 +00004828Initial Stack, Global Data:
4829---------------------------
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk6c59edc2004-05-03 20:45:30 +00004831The implementation of U-Boot is complicated by the fact that U-Boot
4832starts running out of ROM (flash memory), usually without access to
4833system RAM (because the memory controller is not initialized yet).
4834This means that we don't have writable Data or BSS segments, and BSS
4835is not initialized as zero. To be able to get a C environment working
4836at all, we have to allocate at least a minimal stack. Implementation
4837options for this are defined and restricted by the CPU used: Some CPU
4838models provide on-chip memory (like the IMMR area on MPC8xx and
4839MPC826x processors), on others (parts of) the data cache can be
4840locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004841
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004842 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004843 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004844
wdenk6c59edc2004-05-03 20:45:30 +00004845 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4846 From: "Chris Hallinan" <clh@net1plus.com>
4847 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4848 ...
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk6c59edc2004-05-03 20:45:30 +00004850 Correct me if I'm wrong, folks, but the way I understand it
4851 is this: Using DCACHE as initial RAM for Stack, etc, does not
4852 require any physical RAM backing up the cache. The cleverness
4853 is that the cache is being used as a temporary supply of
4854 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004855 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004856 can see how this works by studying the cache architecture and
4857 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk6c59edc2004-05-03 20:45:30 +00004859 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4860 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004861 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004862 option should work for you. Using CS 4 should be fine if your
4863 board designers haven't used it for something that would
4864 cause you grief during the initial boot! It is frequently not
4865 used.
wdenkc6097192002-11-03 00:24:07 +00004866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004867 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004868 with your processor/board/system design. The default value
4869 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004870 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004871 than your SDRAM module. If you have a 64MB SDRAM module, set
4872 it above 400_0000. Just make sure your board has no resources
4873 that are supposed to respond to that address! That code in
4874 start.S has been around a while and should work as is when
4875 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877 -Chris Hallinan
4878 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880It is essential to remember this, since it has some impact on the C
4881code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883* Initialized global data (data segment) is read-only. Do not attempt
4884 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004885
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004886* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004887 as zero data - BSS segment) at all - this is undefined, initiali-
4888 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004889
wdenk6c59edc2004-05-03 20:45:30 +00004890* Stack space is very limited. Avoid big data buffers or things like
4891 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004894normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004895turned out that the implementation of U-Boot can be greatly
4896simplified by making a global data structure (gd_t) available to all
4897functions. We could pass a pointer to this data as argument to _all_
4898functions, but this would bloat the code. Instead we use a feature of
4899the GCC compiler (Global Register Variables) to share the data: we
4900place a pointer (gd) to the global data into a register which we
4901reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk6c59edc2004-05-03 20:45:30 +00004903When choosing a register for such a purpose we are restricted by the
4904relevant (E)ABI specifications for the current architecture, and by
4905GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk6c59edc2004-05-03 20:45:30 +00004907For PowerPC, the following registers have specific use:
4908 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004909 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004910 R3-R4: parameter passing and return values
4911 R5-R10: parameter passing
4912 R13: small data area pointer
4913 R30: GOT pointer
4914 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004915
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004916 (U-Boot also uses R12 as internal GOT pointer. r12
4917 is a volatile register so r12 needs to be reset when
4918 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004919
Wolfgang Denk69c09642008-02-14 22:43:22 +01004920 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004921
wdenk6c59edc2004-05-03 20:45:30 +00004922 Note: on PPC, we could use a static initializer (since the
4923 address of the global data structure is known at compile time),
4924 but it turned out that reserving a register results in somewhat
4925 smaller code - although the code savings are not that big (on
4926 average for all boards 752 bytes for the whole U-Boot image,
4927 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk6c59edc2004-05-03 20:45:30 +00004929On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931 R0: function argument word/integer result
4932 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004933 R9: platform specific
4934 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004935 R11: argument (frame) pointer
4936 R12: temporary workspace
4937 R13: stack pointer
4938 R14: link register
4939 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004940
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004941 ==> U-Boot will use R9 to hold a pointer to the global data
4942
4943 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004944
Thomas Chou8fa38582010-05-21 11:08:03 +08004945On Nios II, the ABI is documented here:
4946 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4947
4948 ==> U-Boot will use gp to hold a pointer to the global data
4949
4950 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4951 to access small data sections, so gp is free.
4952
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004953On NDS32, the following registers are used:
4954
4955 R0-R1: argument/return
4956 R2-R5: argument
4957 R15: temporary register for assembler
4958 R16: trampoline register
4959 R28: frame pointer (FP)
4960 R29: global pointer (GP)
4961 R30: link register (LP)
4962 R31: stack pointer (SP)
4963 PC: program counter (PC)
4964
4965 ==> U-Boot will use R10 to hold a pointer to the global data
4966
Wolfgang Denk6405a152006-03-31 18:32:53 +02004967NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4968or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004969
wdenk6c59edc2004-05-03 20:45:30 +00004970Memory Management:
4971------------------
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk6c59edc2004-05-03 20:45:30 +00004973U-Boot runs in system state and uses physical addresses, i.e. the
4974MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976The available memory is mapped to fixed addresses using the memory
4977controller. In this process, a contiguous block is formed for each
4978memory type (Flash, SDRAM, SRAM), even when it consists of several
4979physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk6c59edc2004-05-03 20:45:30 +00004981U-Boot is installed in the first 128 kB of the first Flash bank (on
4982TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4983booting and sizing and initializing DRAM, the code relocates itself
4984to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004985memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004986configuration setting]. Below that, a structure with global Board
4987Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989Additionally, some exception handler code is copied to the low 8 kB
4990of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992So a typical memory configuration with 16 MB of DRAM could look like
4993this:
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995 0x0000 0000 Exception Vector code
4996 :
4997 0x0000 1FFF
4998 0x0000 2000 Free for Application Use
4999 :
5000 :
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk6c59edc2004-05-03 20:45:30 +00005002 :
5003 :
5004 0x00FB FF20 Monitor Stack (Growing downward)
5005 0x00FB FFAC Board Info Data and permanent copy of global data
5006 0x00FC 0000 Malloc Arena
5007 :
5008 0x00FD FFFF
5009 0x00FE 0000 RAM Copy of Monitor Code
5010 ... eventually: LCD or video framebuffer
5011 ... eventually: pRAM (Protected RAM - unchanged by reset)
5012 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005013
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015System Initialization:
5016----------------------
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005019(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005020configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005021To be able to re-map memory U-Boot then jumps to its link address.
5022To be able to implement the initialization code in C, a (small!)
5023initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02005024which provide such a feature like), or in a locked part of the data
5025cache. After that, U-Boot initializes the CPU core, the caches and
5026the SIU.
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028Next, all (potentially) available memory banks are mapped using a
5029preliminary mapping. For example, we put them on 512 MB boundaries
5030(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5031on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5032programmed for SDRAM access. Using the temporary configuration, a
5033simple memory test is run that determines the size of the SDRAM
5034banks.
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036When there is more than one SDRAM bank, and the banks are of
5037different size, the largest is mapped first. For equal size, the first
5038bank (CS2#) is mapped first. The first mapping is always for address
50390x00000000, with any additional banks following immediately to create
5040contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005041
wdenk6c59edc2004-05-03 20:45:30 +00005042Then, the monitor installs itself at the upper end of the SDRAM area
5043and allocates memory for use by malloc() and for the global Board
5044Info data; also, the exception vector code is copied to the low RAM
5045pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047Only after this relocation will you have a "normal" C environment;
5048until that you are restricted in several ways, mostly because you are
5049running from ROM, and because the code will have to be relocated to a
5050new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005051
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053U-Boot Porting Guide:
5054----------------------
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5057list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005058
wdenkc6097192002-11-03 00:24:07 +00005059
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005060int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005061{
5062 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005063
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005064 signal(SIGALRM, no_more_time);
5065 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005068 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005069 return 0;
5070 }
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005073
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005074 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005075
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005076 if (clueless)
5077 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079 while (learning) {
5080 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005081 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5082 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005083 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005084 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005085 }
wdenkc6097192002-11-03 00:24:07 +00005086
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005087 if (available_money > toLocalCurrency ($2500))
5088 Buy a BDI3000;
5089 else
wdenk6c59edc2004-05-03 20:45:30 +00005090 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005091
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005092 if (a similar board exists) { /* hopefully... */
5093 cp -a board/<similar> board/<myboard>
5094 cp include/configs/<similar>.h include/configs/<myboard>.h
5095 } else {
5096 Create your own board support subdirectory;
5097 Create your own board include/configs/<myboard>.h file;
5098 }
5099 Edit new board/<myboard> files
5100 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005101
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005102 while (!accepted) {
5103 while (!running) {
5104 do {
5105 Add / modify source code;
5106 } until (compiles);
5107 Debug;
5108 if (clueless)
5109 email("Hi, I am having problems...");
5110 }
5111 Send patch file to the U-Boot email list;
5112 if (reasonable critiques)
5113 Incorporate improvements from email list code review;
5114 else
5115 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005116 }
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118 return 0;
5119}
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121void no_more_time (int sig)
5122{
5123 hire_a_guru();
5124}
wdenkc6097192002-11-03 00:24:07 +00005125
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk6c59edc2004-05-03 20:45:30 +00005127Coding Standards:
5128-----------------
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk6c59edc2004-05-03 20:45:30 +00005130All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005131coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005132"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005133
5134Source files originating from a different project (for example the
5135MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005136reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005137sources.
wdenkc6097192002-11-03 00:24:07 +00005138
Detlev Zundelaa63d482006-09-01 15:39:02 +02005139Please note that U-Boot is implemented in C (and to some small parts in
5140Assembler); no C++ is used, so please do not use C++ style comments (//)
5141in your code.
wdenkad276f22004-01-04 16:28:35 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143Please also stick to the following formatting rules:
5144- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005145- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005146- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005147- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005148- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005149
wdenk6c59edc2004-05-03 20:45:30 +00005150Submissions which do not conform to the standards may be returned
5151with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005152
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154Submitting Patches:
5155-------------------
wdenkc6097192002-11-03 00:24:07 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157Since the number of patches for U-Boot is growing, we need to
5158establish some rules. Submissions which do not conform to these rules
5159may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005160
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005161Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005162
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005163Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5164see http://lists.denx.de/mailman/listinfo/u-boot
5165
wdenk6c59edc2004-05-03 20:45:30 +00005166When you send a patch, please include the following information with
5167it:
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169* For bug fixes: a description of the bug and how your patch fixes
5170 this bug. Please try to include a way of demonstrating that the
5171 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk6c59edc2004-05-03 20:45:30 +00005173* For new features: a description of the feature and your
5174 implementation.
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005177
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005178* For major contributions, add a MAINTAINERS file with your
5179 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005180
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005181* When you add support for a new board, don't forget to add a
5182 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184* If your patch adds new configuration options, don't forget to
5185 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005186
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005187* The patch itself. If you are using git (which is *strongly*
5188 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005189 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005190 the U-Boot mailing list, you will avoid most of the common problems
5191 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005192
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005193 If you cannot use git, use "diff -purN OLD NEW". If your version of
5194 diff does not support these options, then get the latest version of
5195 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005196
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005197 The current directory when running this command shall be the parent
5198 directory of the U-Boot source tree (i. e. please make sure that
5199 your patch includes sufficient directory information for the
5200 affected files).
5201
5202 We prefer patches as plain text. MIME attachments are discouraged,
5203 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205* If one logical set of modifications affects or creates several
5206 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208* Changesets that contain different, unrelated modifications shall be
5209 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005210
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212Notes:
wdenkc6097192002-11-03 00:24:07 +00005213
Simon Glassdc27def2016-07-27 20:33:08 -06005214* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005215 source tree and make sure that no errors or warnings are reported
5216 for any of the boards.
5217
5218* Keep your modifications to the necessary minimum: A patch
5219 containing several unrelated changes or arbitrary reformats will be
5220 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222* If you modify existing code, make sure that your new code does not
5223 add to the memory footprint of the code ;-) Small is beautiful!
5224 When adding new features, these should compile conditionally only
5225 (using #ifdef), and the resulting code with the new feature
5226 disabled must not need more memory than the old code without your
5227 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005228
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005229* Remember that there is a size limit of 100 kB per message on the
5230 u-boot mailing list. Bigger patches will be moderated. If they are
5231 reasonable and not too big, they will be acknowledged. But patches
5232 bigger than the size limit should be avoided.