blob: 21d1f8a007ba8c33360017f79f6524897abd6c6e [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000043
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050061The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010062git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500137 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000140 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400142 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200143 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800144 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500145 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400147 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148/api Machine/arch independent API for external apps
149/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800150/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500152/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/disk Code for disk drive partition handling
154/doc Documentation (don't expect too much)
155/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400156/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157/examples Example code for standalone applications, etc.
158/fs Filesystem code (cramfs, ext2, jffs2, etc.)
159/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500160/lib Library routines generic to all architectures
161/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500162/net Networking code
163/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500164/scripts Various build scripts and Makefiles
165/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000167
wdenkc6097192002-11-03 00:24:07 +0000168Software Configuration:
169=======================
170
171Configuration is usually done using C preprocessor defines; the
172rationale behind that is to avoid dead code whenever possible.
173
174There are two classes of configuration variables:
175
176* Configuration _OPTIONS_:
177 These are selectable by the user and have names beginning with
178 "CONFIG_".
179
180* Configuration _SETTINGS_:
181 These depend on the hardware etc. and should not be meddled with if
182 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200183 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000184
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500185Previously, all configuration was done by hand, which involved creating
186symbolic links and editing configuration files manually. More recently,
187U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188allowing you to use the "make menuconfig" command to configure your
189build.
wdenkc6097192002-11-03 00:24:07 +0000190
191
192Selection of Processor Architecture and Board Type:
193---------------------------------------------------
194
195For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200196configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000197
198Example: For a TQM823L module type:
199
200 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200201 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000202
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500203Note: If you're looking for the default configuration file for a board
204you're sure used to be there but is now missing, check the file
205doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000206
Simon Glass53552c92014-03-22 17:12:59 -0600207Sandbox Environment:
208--------------------
209
210U-Boot can be built natively to run on a Linux host using the 'sandbox'
211board. This allows feature development which is not board- or architecture-
212specific to be undertaken on a native platform. The sandbox is also used to
213run some of U-Boot's tests.
214
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530215See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600216
217
Simon Glassd8711af2015-03-03 08:03:00 -0700218Board Initialisation Flow:
219--------------------------
220
221This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500222SPL and U-Boot proper (i.e. they both follow the same rules).
223
224Note: "SPL" stands for "Secondary Program Loader," which is explained in
225more detail later in this file.
226
227At present, SPL mostly uses a separate code path, but the function names
228and roles of each function are the same. Some boards or architectures
229may not conform to this. At least most ARM boards which use
230CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700231
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500232Execution typically starts with an architecture-specific (and possibly
233CPU-specific) start.S file, such as:
234
235 - arch/arm/cpu/armv7/start.S
236 - arch/powerpc/cpu/mpc83xx/start.S
237 - arch/mips/cpu/start.S
238
239and so on. From there, three functions are called; the purpose and
240limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700241
242lowlevel_init():
243 - purpose: essential init to permit execution to reach board_init_f()
244 - no global_data or BSS
245 - there is no stack (ARMv7 may have one but it will soon be removed)
246 - must not set up SDRAM or use console
247 - must only do the bare minimum to allow execution to continue to
248 board_init_f()
249 - this is almost never needed
250 - return normally from this function
251
252board_init_f():
253 - purpose: set up the machine ready for running board_init_r():
254 i.e. SDRAM and serial UART
255 - global_data is available
256 - stack is in SRAM
257 - BSS is not available, so you cannot use global/static variables,
258 only stack variables and global_data
259
260 Non-SPL-specific notes:
261 - dram_init() is called to set up DRAM. If already done in SPL this
262 can do nothing
263
264 SPL-specific notes:
265 - you can override the entire board_init_f() function with your own
266 version as needed.
267 - preloader_console_init() can be called here in extremis
268 - should set up SDRAM, and anything needed to make the UART work
269 - these is no need to clear BSS, it will be done by crt0.S
270 - must return normally from this function (don't call board_init_r()
271 directly)
272
273Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
274this point the stack and global_data are relocated to below
275CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
276memory.
277
278board_init_r():
279 - purpose: main execution, common code
280 - global_data is available
281 - SDRAM is available
282 - BSS is available, all static/global variables can be used
283 - execution eventually continues to main_loop()
284
285 Non-SPL-specific notes:
286 - U-Boot is relocated to the top of memory and is now running from
287 there.
288
289 SPL-specific notes:
290 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
291 CONFIG_SPL_STACK_R_ADDR points into SDRAM
292 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800293 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700294 spl_board_init() function containing this call
295 - loads U-Boot or (in falcon mode) Linux
296
297
298
wdenkc6097192002-11-03 00:24:07 +0000299Configuration Options:
300----------------------
301
302Configuration depends on the combination of board and CPU type; all
303such information is kept in a configuration file
304"include/configs/<board_name>.h".
305
306Example: For a TQM823L module, all configuration settings are in
307"include/configs/TQM823L.h".
308
309
wdenk1272e232002-11-10 22:06:23 +0000310Many of the options are named exactly as the corresponding Linux
311kernel configuration options. The intention is to make it easier to
312build a config tool - later.
313
Ashish Kumar11234062017-08-11 11:09:14 +0530314- ARM Platform Bus Type(CCI):
315 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
316 provides full cache coherency between two clusters of multi-core
317 CPUs and I/O coherency for devices and I/O masters
318
319 CONFIG_SYS_FSL_HAS_CCI400
320
321 Defined For SoC that has cache coherent interconnect
322 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000323
Ashish Kumar97393d62017-08-18 10:54:36 +0530324 CONFIG_SYS_FSL_HAS_CCN504
325
326 Defined for SoC that has cache coherent interconnect CCN-504
327
wdenkc6097192002-11-03 00:24:07 +0000328The following options need to be configured:
329
Kim Phillips203fee32007-08-10 13:28:25 -0500330- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000331
Kim Phillips203fee32007-08-10 13:28:25 -0500332- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200333
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600334- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000335 CONFIG_SYS_PPC64
336
337 Specifies that the core is a 64-bit PowerPC implementation (implements
338 the "64" category of the Power ISA). This is necessary for ePAPR
339 compliance, among other possible reasons.
340
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600341 CONFIG_SYS_FSL_TBCLK_DIV
342
343 Defines the core time base clock divider ratio compared to the
344 system clock. On most PQ3 devices this is 8, on newer QorIQ
345 devices it can be 16 or 32. The ratio varies from SoC to Soc.
346
Kumar Gala179b1b22011-05-20 00:39:21 -0500347 CONFIG_SYS_FSL_PCIE_COMPAT
348
349 Defines the string to utilize when trying to match PCIe device
350 tree nodes for the given platform.
351
Scott Wood80806962012-08-14 10:14:53 +0000352 CONFIG_SYS_FSL_ERRATUM_A004510
353
354 Enables a workaround for erratum A004510. If set,
355 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
356 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
357
358 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
359 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
360
361 Defines one or two SoC revisions (low 8 bits of SVR)
362 for which the A004510 workaround should be applied.
363
364 The rest of SVR is either not relevant to the decision
365 of whether the erratum is present (e.g. p2040 versus
366 p2041) or is implied by the build target, which controls
367 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
368
369 See Freescale App Note 4493 for more information about
370 this erratum.
371
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530372 CONFIG_A003399_NOR_WORKAROUND
373 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800374 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530375
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530376 CONFIG_A008044_WORKAROUND
377 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800378 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530379
Scott Wood80806962012-08-14 10:14:53 +0000380 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
381
382 This is the value to write into CCSR offset 0x18600
383 according to the A004510 workaround.
384
Priyanka Jainc73b9032013-07-02 09:21:04 +0530385 CONFIG_SYS_FSL_DSP_DDR_ADDR
386 This value denotes start offset of DDR memory which is
387 connected exclusively to the DSP cores.
388
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530389 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
390 This value denotes start offset of M2 memory
391 which is directly connected to the DSP core.
392
Priyanka Jainc73b9032013-07-02 09:21:04 +0530393 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
394 This value denotes start offset of M3 memory which is directly
395 connected to the DSP core.
396
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530397 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
398 This value denotes start offset of DSP CCSR space.
399
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530400 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
401 Single Source Clock is clocking mode present in some of FSL SoC's.
402 In this mode, a single differential clock is used to supply
403 clocks to the sysclock, ddrclock and usbclock.
404
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530405 CONFIG_SYS_CPC_REINIT_F
406 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800407 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530408
Tang Yuantiana7364af2014-04-17 15:33:46 +0800409 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800410 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800411 supported, core will start to execute uboot when wakes up.
412
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000413- Generic CPU options:
414 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
415
416 Defines the endianess of the CPU. Implementation of those
417 values is arch specific.
418
York Sunf0626592013-09-30 09:22:09 -0700419 CONFIG_SYS_FSL_DDR
420 Freescale DDR driver in use. This type of DDR controller is
421 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
422 SoCs.
423
424 CONFIG_SYS_FSL_DDR_ADDR
425 Freescale DDR memory-mapped register base.
426
427 CONFIG_SYS_FSL_DDR_EMU
428 Specify emulator support for DDR. Some DDR features such as
429 deskew training are not available.
430
431 CONFIG_SYS_FSL_DDRC_GEN1
432 Freescale DDR1 controller.
433
434 CONFIG_SYS_FSL_DDRC_GEN2
435 Freescale DDR2 controller.
436
437 CONFIG_SYS_FSL_DDRC_GEN3
438 Freescale DDR3 controller.
439
York Sun2896cb72014-03-27 17:54:47 -0700440 CONFIG_SYS_FSL_DDRC_GEN4
441 Freescale DDR4 controller.
442
York Sun461c9392013-09-30 14:20:51 -0700443 CONFIG_SYS_FSL_DDRC_ARM_GEN3
444 Freescale DDR3 controller for ARM-based SoCs.
445
York Sunf0626592013-09-30 09:22:09 -0700446 CONFIG_SYS_FSL_DDR1
447 Board config to use DDR1. It can be enabled for SoCs with
448 Freescale DDR1 or DDR2 controllers, depending on the board
449 implemetation.
450
451 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400452 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700453 Freescale DDR2 or DDR3 controllers, depending on the board
454 implementation.
455
456 CONFIG_SYS_FSL_DDR3
457 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700458 Freescale DDR3 or DDR3L controllers.
459
460 CONFIG_SYS_FSL_DDR3L
461 Board config to use DDR3L. It can be enabled for SoCs with
462 DDR3L controllers.
463
464 CONFIG_SYS_FSL_DDR4
465 Board config to use DDR4. It can be enabled for SoCs with
466 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700467
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530468 CONFIG_SYS_FSL_IFC_BE
469 Defines the IFC controller register space as Big Endian
470
471 CONFIG_SYS_FSL_IFC_LE
472 Defines the IFC controller register space as Little Endian
473
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530474 CONFIG_SYS_FSL_IFC_CLK_DIV
475 Defines divider of platform clock(clock input to IFC controller).
476
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530477 CONFIG_SYS_FSL_LBC_CLK_DIV
478 Defines divider of platform clock(clock input to eLBC controller).
479
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530480 CONFIG_SYS_FSL_PBL_PBI
481 It enables addition of RCW (Power on reset configuration) in built image.
482 Please refer doc/README.pblimage for more details
483
484 CONFIG_SYS_FSL_PBL_RCW
485 It adds PBI(pre-boot instructions) commands in u-boot build image.
486 PBI commands can be used to configure SoC before it starts the execution.
487 Please refer doc/README.pblimage for more details
488
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530489 CONFIG_SPL_FSL_PBL
490 It adds a target to create boot binary having SPL binary in PBI format
491 concatenated with u-boot binary.
492
York Sun29647ab2014-02-10 13:59:42 -0800493 CONFIG_SYS_FSL_DDR_BE
494 Defines the DDR controller register space as Big Endian
495
496 CONFIG_SYS_FSL_DDR_LE
497 Defines the DDR controller register space as Little Endian
498
York Sun3a0916d2014-02-10 13:59:43 -0800499 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
500 Physical address from the view of DDR controllers. It is the
501 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
502 it could be different for ARM SoCs.
503
York Sunc459ae62014-02-10 13:59:44 -0800504 CONFIG_SYS_FSL_DDR_INTLV_256B
505 DDR controller interleaving on 256-byte. This is a special
506 interleaving mode, handled by Dickens for Freescale layerscape
507 SoCs with ARM core.
508
York Sun79a779b2014-08-01 15:51:00 -0700509 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
510 Number of controllers used as main memory.
511
512 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
513 Number of controllers used for other than main memory.
514
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530515 CONFIG_SYS_FSL_HAS_DP_DDR
516 Defines the SoC has DP-DDR used for DPAA.
517
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530518 CONFIG_SYS_FSL_SEC_BE
519 Defines the SEC controller register space as Big Endian
520
521 CONFIG_SYS_FSL_SEC_LE
522 Defines the SEC controller register space as Little Endian
523
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200524- MIPS CPU options:
525 CONFIG_SYS_INIT_SP_OFFSET
526
527 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
528 pointer. This is needed for the temporary stack before
529 relocation.
530
531 CONFIG_SYS_MIPS_CACHE_MODE
532
533 Cache operation mode for the MIPS CPU.
534 See also arch/mips/include/asm/mipsregs.h.
535 Possible values are:
536 CONF_CM_CACHABLE_NO_WA
537 CONF_CM_CACHABLE_WA
538 CONF_CM_UNCACHED
539 CONF_CM_CACHABLE_NONCOHERENT
540 CONF_CM_CACHABLE_CE
541 CONF_CM_CACHABLE_COW
542 CONF_CM_CACHABLE_CUW
543 CONF_CM_CACHABLE_ACCELERATED
544
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200545 CONFIG_XWAY_SWAP_BYTES
546
547 Enable compilation of tools/xway-swap-bytes needed for Lantiq
548 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
549 be swapped if a flash programmer is used.
550
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000551- ARM options:
552 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
553
554 Select high exception vectors of the ARM core, e.g., do not
555 clear the V bit of the c1 register of CP15.
556
York Sun77a10972015-03-20 19:28:08 -0700557 COUNTER_FREQUENCY
558 Generic timer clock source frequency.
559
560 COUNTER_FREQUENCY_REAL
561 Generic timer clock source frequency if the real clock is
562 different from COUNTER_FREQUENCY, and can only be determined
563 at run time.
564
Stephen Warren8d1fb312015-01-19 16:25:52 -0700565- Tegra SoC options:
566 CONFIG_TEGRA_SUPPORT_NON_SECURE
567
568 Support executing U-Boot in non-secure (NS) mode. Certain
569 impossible actions will be skipped if the CPU is in NS mode,
570 such as ARM architectural timer initialization.
571
wdenk9b7f3842003-10-09 20:09:04 +0000572- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000573 CONFIG_CLOCKS_IN_MHZ
574
575 U-Boot stores all clock information in Hz
576 internally. For binary compatibility with older Linux
577 kernels (which expect the clocks passed in the
578 bd_info data to be in MHz) the environment variable
579 "clocks_in_mhz" can be defined so that U-Boot
580 converts clock data to MHZ before passing it to the
581 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000582 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100583 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000584 default environment.
585
wdenk9b7f3842003-10-09 20:09:04 +0000586 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
587
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800588 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000589 expect it to be in bytes, others in MB.
590 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
591
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400592 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200593
594 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400595 passed using flattened device trees (based on open firmware
596 concepts).
597
598 CONFIG_OF_LIBFDT
599 * New libfdt-based support
600 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500601 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400602
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200603 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600604 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200605
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200606 boards with QUICC Engines require OF_QE to set UCC MAC
607 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500608
Kumar Gala1e26aa52006-01-11 13:54:17 -0600609 CONFIG_OF_BOARD_SETUP
610
611 Board code has addition modification that it wants to make
612 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000613
Simon Glass6c0be912014-10-23 18:58:54 -0600614 CONFIG_OF_SYSTEM_SETUP
615
616 Other code has addition modification that it wants to make
617 to the flat device tree before handing it off to the kernel.
618 This causes ft_system_setup() to be called before booting
619 the kernel.
620
Heiko Schocherffb293a2009-09-23 07:56:08 +0200621 CONFIG_OF_IDE_FIXUP
622
623 U-Boot can detect if an IDE device is present or not.
624 If not, and this new config option is activated, U-Boot
625 removes the ATA node from the DTS before booting Linux,
626 so the Linux IDE driver does not probe the device and
627 crash. This is needed for buggy hardware (uc101) where
628 no pull down resistor is connected to the signal IDE5V_DD7.
629
Igor Grinberg06890672011-07-14 05:45:07 +0000630 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
631
632 This setting is mandatory for all boards that have only one
633 machine type and must be used to specify the machine type
634 number as it appears in the ARM machine registry
635 (see http://www.arm.linux.org.uk/developer/machines/).
636 Only boards that have multiple machine types supported
637 in a single configuration file and the machine type is
638 runtime discoverable, do not have to use this setting.
639
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100640- vxWorks boot parameters:
641
642 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700643 environments variables: bootdev, bootfile, ipaddr, netmask,
644 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100645 It loads the vxWorks image pointed bootfile.
646
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100647 Note: If a "bootargs" environment is defined, it will overwride
648 the defaults discussed just above.
649
Aneesh V960f5c02011-06-16 23:30:47 +0000650- Cache Configuration:
651 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
652 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
653 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
654
Aneesh V686a0752011-06-16 23:30:51 +0000655- Cache Configuration for ARM:
656 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
657 controller
658 CONFIG_SYS_PL310_BASE - Physical base address of PL310
659 controller register space
660
wdenkda04a8b2004-08-02 23:22:59 +0000661- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200662 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000663
664 Define this if you want support for Amba PrimeCell PL010 UARTs.
665
Andreas Engel0813b122008-09-08 14:30:53 +0200666 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL011 UARTs.
669
670 CONFIG_PL011_CLOCK
671
672 If you have Amba PrimeCell PL011 UARTs, set this variable to
673 the clock speed of the UARTs.
674
675 CONFIG_PL01x_PORTS
676
677 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
678 define this to a list of base addresses for each (supported)
679 port. See e.g. include/configs/versatile.h
680
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400681 CONFIG_SERIAL_HW_FLOW_CONTROL
682
683 Define this variable to enable hw flow control in serial driver.
684 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000685
wdenkc6097192002-11-03 00:24:07 +0000686- Console Baudrate:
687 CONFIG_BAUDRATE - in bps
688 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200689 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000690
wdenkc6097192002-11-03 00:24:07 +0000691- Autoboot Command:
692 CONFIG_BOOTCOMMAND
693 Only needed when CONFIG_BOOTDELAY is enabled;
694 define a command string that is automatically executed
695 when no character is read on the console interface
696 within "Boot Delay" after reset.
697
wdenkc6097192002-11-03 00:24:07 +0000698 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000699 The value of these goes into the environment as
700 "ramboot" and "nfsboot" respectively, and can be used
701 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200702 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000703
704- Pre-Boot Commands:
705 CONFIG_PREBOOT
706
707 When this option is #defined, the existence of the
708 environment variable "preboot" will be checked
709 immediately before starting the CONFIG_BOOTDELAY
710 countdown and/or running the auto-boot command resp.
711 entering interactive mode.
712
713 This feature is especially useful when "preboot" is
714 automatically generated or modified. For an example
715 see the LWMON board specific code: here "preboot" is
716 modified when the user holds down a certain
717 combination of keys on the (special) keyboard when
718 booting the systems
719
720- Serial Download Echo Mode:
721 CONFIG_LOADS_ECHO
722 If defined to 1, all characters received during a
723 serial download (using the "loads" command) are
724 echoed back. This might be needed by some terminal
725 emulations (like "cu"), but may as well just take
726 time on others. This setting #define's the initial
727 value of the "loads_echo" environment variable.
728
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500729- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000730 CONFIG_KGDB_BAUDRATE
731 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200732 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000733
Simon Glassaa34ef22016-03-13 19:07:28 -0600734- Removal of commands
735 If no commands are needed to boot, you can disable
736 CONFIG_CMDLINE to remove them. In this case, the command line
737 will not be available, and when U-Boot wants to execute the
738 boot command (on start-up) it will call board_run_command()
739 instead. This can reduce image size significantly for very
740 simple boot procedures.
741
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000742- Regular expression support:
743 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200744 If this variable is defined, U-Boot is linked against
745 the SLRE (Super Light Regular Expression) library,
746 which adds regex support to some commands, as for
747 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000748
Simon Glass3d686442011-10-15 05:48:20 +0000749- Device tree:
750 CONFIG_OF_CONTROL
751 If this variable is defined, U-Boot will use a device tree
752 to configure its devices, instead of relying on statically
753 compiled #defines in the board file. This option is
754 experimental and only available on a few boards. The device
755 tree is available in the global data as gd->fdt_blob.
756
Simon Glass5cb34db2011-10-24 19:15:31 +0000757 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700758 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000759
760 CONFIG_OF_EMBED
761 If this variable is defined, U-Boot will embed a device tree
762 binary in its image. This device tree file should be in the
763 board directory and called <soc>-<board>.dts. The binary file
764 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsu1f17f192017-08-26 07:34:14 +0900765 the global data structure as gd->fdt_blob.
Simon Glass3d686442011-10-15 05:48:20 +0000766
Simon Glass5cb34db2011-10-24 19:15:31 +0000767 CONFIG_OF_SEPARATE
768 If this variable is defined, U-Boot will build a device tree
769 binary. It will be called u-boot.dtb. Architecture-specific
770 code will locate it at run-time. Generally this works by:
771
772 cat u-boot.bin u-boot.dtb >image.bin
773
774 and in fact, U-Boot does this for you, creating a file called
775 u-boot-dtb.bin which is useful in the common case. You can
776 still use the individual files if you need something more
777 exotic.
778
Alex Deymo5b661ec2017-04-02 01:25:20 -0700779 CONFIG_OF_BOARD
780 If this variable is defined, U-Boot will use the device tree
781 provided by the board at runtime instead of embedding one with
782 the image. Only boards defining board_fdt_blob_setup() support
783 this option (see include/fdtdec.h file).
784
wdenkc6097192002-11-03 00:24:07 +0000785- Watchdog:
786 CONFIG_WATCHDOG
787 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000788 support for the SoC. There must be support in the SoC
Christophe Leroy069fa832017-07-06 10:23:22 +0200789 specific code for a watchdog. For the 8xx
790 CPUs, the SIU Watchdog feature is enabled in the SYPCR
791 register. When supported for a specific SoC is
792 available, then no further board specific code should
793 be needed to use it.
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000794
795 CONFIG_HW_WATCHDOG
796 When using a watchdog circuitry external to the used
797 SoC, then define this variable and provide board
798 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000799
Heiko Schocher735326c2015-01-21 08:38:22 +0100800 CONFIG_AT91_HW_WDT_TIMEOUT
801 specify the timeout in seconds. default 2 seconds.
802
wdenkc6097192002-11-03 00:24:07 +0000803- Real-Time Clock:
804
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500805 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000806 has to be selected, too. Define exactly one of the
807 following options:
808
wdenkc6097192002-11-03 00:24:07 +0000809 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000810 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000811 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000812 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000813 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000814 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200815 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000816 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100817 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000818 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200819 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200820 CONFIG_SYS_RV3029_TCR - enable trickle charger on
821 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000822
wdenkb9bbd242003-06-30 16:24:52 +0000823 Note that if the RTC uses I2C, then the I2C interface
824 must also be configured. See I2C Support, below.
825
Peter Tyser9902e422008-12-17 16:36:21 -0600826- GPIO Support:
827 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600828
Chris Packham9b383202010-12-19 10:12:13 +0000829 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
830 chip-ngpio pairs that tell the PCA953X driver the number of
831 pins supported by a particular chip.
832
Peter Tyser9902e422008-12-17 16:36:21 -0600833 Note that if the GPIO device uses I2C, then the I2C interface
834 must also be configured. See I2C Support, below.
835
Simon Glass4dc47ca2014-06-11 23:29:41 -0600836- I/O tracing:
837 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
838 accesses and can checksum them or write a list of them out
839 to memory. See the 'iotrace' command for details. This is
840 useful for testing device drivers since it can confirm that
841 the driver behaves the same way before and after a code
842 change. Currently this is supported on sandbox and arm. To
843 add support for your architecture, add '#include <iotrace.h>'
844 to the bottom of arch/<arch>/include/asm/io.h and test.
845
846 Example output from the 'iotrace stats' command is below.
847 Note that if the trace buffer is exhausted, the checksum will
848 still continue to operate.
849
850 iotrace is enabled
851 Start: 10000000 (buffer start address)
852 Size: 00010000 (buffer size)
853 Offset: 00000120 (current buffer offset)
854 Output: 10000120 (start + offset)
855 Count: 00000018 (number of trace records)
856 CRC32: 9526fb66 (CRC32 of all trace records)
857
wdenkc6097192002-11-03 00:24:07 +0000858- Timestamp Support:
859
wdenk4a5c8a72003-03-06 00:02:04 +0000860 When CONFIG_TIMESTAMP is selected, the timestamp
861 (date and time) of an image is printed by image
862 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500863 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000864
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000865- Partition Labels (disklabels) Supported:
866 Zero or more of the following:
867 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000868 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
869 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
870 bootloader. Note 2TB partition limit; see
871 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600872 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000873 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000874
875- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000876 CONFIG_IDE_RESET_ROUTINE - this is defined in several
877 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000878
wdenk369d43d2004-03-14 14:09:05 +0000879 CONFIG_IDE_RESET - is this is defined, IDE Reset will
880 be performed by calling the function
881 ide_set_reset(int reset)
882 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000883
884- ATAPI Support:
885 CONFIG_ATAPI
886
887 Set this to enable ATAPI support.
888
wdenkf602aa02004-03-13 23:29:43 +0000889- LBA48 Support
890 CONFIG_LBA48
891
892 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100893 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000894 Whithout these , LBA48 support uses 32bit variables and will 'only'
895 support disks up to 2.1TB.
896
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200897 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000898 When enabled, makes the IDE subsystem use 64bit sector addresses.
899 Default is 32bit.
900
wdenkc6097192002-11-03 00:24:07 +0000901- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200902 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
903 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
904 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000905 maximum numbers of LUNs, SCSI ID's and target
906 devices.
wdenkc6097192002-11-03 00:24:07 +0000907
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200908 The environment variable 'scsidevs' is set to the number of
909 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +0000910
wdenkc6097192002-11-03 00:24:07 +0000911- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000912 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000913 Support for Intel 8254x/8257x gigabit chips.
914
915 CONFIG_E1000_SPI
916 Utility code for direct access to the SPI bus on Intel 8257x.
917 This does not do anything useful unless you set at least one
918 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
919
920 CONFIG_E1000_SPI_GENERIC
921 Allow generic access to the SPI bus on the Intel 8257x, for
922 example with the "sspi" command.
923
wdenkc6097192002-11-03 00:24:07 +0000924 CONFIG_EEPRO100
925 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200926 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000927 write routine for first time initialisation.
928
929 CONFIG_TULIP
930 Support for Digital 2114x chips.
931 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
932 modem chip initialisation (KS8761/QS6611).
933
934 CONFIG_NATSEMI
935 Support for National dp83815 chips.
936
937 CONFIG_NS8382X
938 Support for National dp8382[01] gigabit chips.
939
wdenkaa603362003-05-12 21:50:16 +0000940- NETWORK Support (other):
941
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100942 CONFIG_DRIVER_AT91EMAC
943 Support for AT91RM9200 EMAC.
944
945 CONFIG_RMII
946 Define this to use reduced MII inteface
947
948 CONFIG_DRIVER_AT91EMAC_QUIET
949 If this defined, the driver is quiet.
950 The driver doen't show link status messages.
951
Rob Herringc9830dc2011-12-15 11:15:49 +0000952 CONFIG_CALXEDA_XGMAC
953 Support for the Calxeda XGMAC device
954
Ashok93fb8722012-10-15 06:20:47 +0000955 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000956 Support for SMSC's LAN91C96 chips.
957
wdenkaa603362003-05-12 21:50:16 +0000958 CONFIG_LAN91C96_USE_32_BIT
959 Define this to enable 32 bit addressing
960
Ashok93fb8722012-10-15 06:20:47 +0000961 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000962 Support for SMSC's LAN91C111 chip
963
964 CONFIG_SMC91111_BASE
965 Define this to hold the physical address
966 of the device (I/O space)
967
968 CONFIG_SMC_USE_32_BIT
969 Define this if data bus is 32 bits
970
971 CONFIG_SMC_USE_IOFUNCS
972 Define this to use i/o functions instead of macros
973 (some hardware wont work with macros)
974
Heiko Schocher7d037f72011-11-15 10:00:04 -0500975 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
976 Define this if you have more then 3 PHYs.
977
Macpaul Lin199c6252010-12-21 16:59:46 +0800978 CONFIG_FTGMAC100
979 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
980
981 CONFIG_FTGMAC100_EGIGA
982 Define this to use GE link update with gigabit PHY.
983 Define this if FTGMAC100 is connected to gigabit PHY.
984 If your system has 10/100 PHY only, it might not occur
985 wrong behavior. Because PHY usually return timeout or
986 useless data when polling gigabit status and gigabit
987 control registers. This behavior won't affect the
988 correctnessof 10/100 link speed update.
989
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900990 CONFIG_SH_ETHER
991 Support for Renesas on-chip Ethernet controller
992
993 CONFIG_SH_ETHER_USE_PORT
994 Define the number of ports to be used
995
996 CONFIG_SH_ETHER_PHY_ADDR
997 Define the ETH PHY's address
998
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900999 CONFIG_SH_ETHER_CACHE_WRITEBACK
1000 If this option is set, the driver enables cache flush.
1001
Heiko Schocher2b387762014-07-18 06:07:19 +02001002- PWM Support:
1003 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001004 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001005
Vadim Bendeburydac69642011-10-17 08:36:14 +00001006- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001007 CONFIG_TPM
1008 Support TPM devices.
1009
Christophe Ricard8759ff82015-10-06 22:54:41 +02001010 CONFIG_TPM_TIS_INFINEON
1011 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001012 per system is supported at this time.
1013
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001014 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1015 Define the burst count bytes upper limit
1016
Christophe Ricard88249232016-01-21 23:27:13 +01001017 CONFIG_TPM_ST33ZP24
1018 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1019
1020 CONFIG_TPM_ST33ZP24_I2C
1021 Support for STMicroelectronics ST33ZP24 I2C devices.
1022 Requires TPM_ST33ZP24 and I2C.
1023
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001024 CONFIG_TPM_ST33ZP24_SPI
1025 Support for STMicroelectronics ST33ZP24 SPI devices.
1026 Requires TPM_ST33ZP24 and SPI.
1027
Dirk Eibach20489092013-06-26 15:55:15 +02001028 CONFIG_TPM_ATMEL_TWI
1029 Support for Atmel TWI TPM device. Requires I2C support.
1030
Che-liang Chiouacea5702013-04-12 11:04:34 +00001031 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001032 Support for generic parallel port TPM devices. Only one device
1033 per system is supported at this time.
1034
1035 CONFIG_TPM_TIS_BASE_ADDRESS
1036 Base address where the generic TPM device is mapped
1037 to. Contemporary x86 systems usually map it at
1038 0xfed40000.
1039
Reinhard Pfau4fece432013-06-26 15:55:13 +02001040 CONFIG_TPM
1041 Define this to enable the TPM support library which provides
1042 functional interfaces to some TPM commands.
1043 Requires support for a TPM device.
1044
1045 CONFIG_TPM_AUTH_SESSIONS
1046 Define this to enable authorized functions in the TPM library.
1047 Requires CONFIG_TPM and CONFIG_SHA1.
1048
wdenkc6097192002-11-03 00:24:07 +00001049- USB Support:
1050 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +02001051 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001052 CONFIG_USB_UHCI to enable it.
1053 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001054 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001055 storage devices.
1056 Note:
1057 Supported are USB Keyboards and USB Floppy drives
1058 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001059
Simon Glass5978cdb2012-02-27 10:52:47 +00001060 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1061 txfilltuning field in the EHCI controller on reset.
1062
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001063 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1064 HW module registers.
1065
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001066- USB Device:
1067 Define the below if you wish to use the USB console.
1068 Once firmware is rebuilt from a serial console issue the
1069 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001070 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001071 it has found a new device. The environment variable usbtty
1072 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001073 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001074 Common Device Class Abstract Control Model serial device.
1075 If you select usbtty = gserial you should be able to enumerate
1076 a Linux host by
1077 # modprobe usbserial vendor=0xVendorID product=0xProductID
1078 else if using cdc_acm, simply setting the environment
1079 variable usbtty to be cdc_acm should suffice. The following
1080 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001081
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001082 CONFIG_USB_DEVICE
1083 Define this to build a UDC device
1084
1085 CONFIG_USB_TTY
1086 Define this to have a tty type of device available to
1087 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001088
Vipin KUMARbdb17702012-03-26 15:38:06 +05301089 CONFIG_USBD_HS
1090 Define this to enable the high speed support for usb
1091 device and usbtty. If this feature is enabled, a routine
1092 int is_usbd_high_speed(void)
1093 also needs to be defined by the driver to dynamically poll
1094 whether the enumeration has succeded at high speed or full
1095 speed.
1096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001097 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001098 Define this if you want stdin, stdout &/or stderr to
1099 be set to usbtty.
1100
Wolfgang Denke2601822006-06-14 18:14:56 +02001101 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001102 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001103 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001104 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1105 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1106 should pretend to be a Linux device to it's target host.
1107
1108 CONFIG_USBD_MANUFACTURER
1109 Define this string as the name of your company for
1110 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001111
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001112 CONFIG_USBD_PRODUCT_NAME
1113 Define this string as the name of your product
1114 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001115
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001116 CONFIG_USBD_VENDORID
1117 Define this as your assigned Vendor ID from the USB
1118 Implementors Forum. This *must* be a genuine Vendor ID
1119 to avoid polluting the USB namespace.
1120 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001121
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001122 CONFIG_USBD_PRODUCTID
1123 Define this as the unique Product ID
1124 for your device
1125 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001126
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001127- ULPI Layer Support:
1128 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1129 the generic ULPI layer. The generic layer accesses the ULPI PHY
1130 via the platform viewport, so you need both the genric layer and
1131 the viewport enabled. Currently only Chipidea/ARC based
1132 viewport is supported.
1133 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1134 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001135 If your ULPI phy needs a different reference clock than the
1136 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1137 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001138
wdenk7a428cc2003-06-15 22:40:42 +00001139- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001140 The MMC controller on the Intel PXA is supported. To
1141 enable this define CONFIG_MMC. The MMC can be
1142 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001143 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001144 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1145 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001146
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001147 CONFIG_SH_MMCIF
1148 Support for Renesas on-chip MMCIF controller
1149
1150 CONFIG_SH_MMCIF_ADDR
1151 Define the base address of MMCIF registers
1152
1153 CONFIG_SH_MMCIF_CLK
1154 Define the clock frequency for MMCIF
1155
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001156 CONFIG_SUPPORT_EMMC_BOOT
1157 Enable some additional features of the eMMC boot partitions.
1158
Tom Rini58a8d322013-03-14 05:32:47 +00001159- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +01001160 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +00001161 This enables the USB portion of the DFU USB class
1162
Tom Rini58a8d322013-03-14 05:32:47 +00001163 CONFIG_DFU_MMC
1164 This enables support for exposing (e)MMC devices via DFU.
1165
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001166 CONFIG_DFU_NAND
1167 This enables support for exposing NAND devices via DFU.
1168
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301169 CONFIG_DFU_RAM
1170 This enables support for exposing RAM via DFU.
1171 Note: DFU spec refer to non-volatile memory usage, but
1172 allow usages beyond the scope of spec - here RAM usage,
1173 one that would help mostly the developer.
1174
Heiko Schochera2f831e2013-06-12 06:05:51 +02001175 CONFIG_SYS_DFU_DATA_BUF_SIZE
1176 Dfu transfer uses a buffer before writing data to the
1177 raw storage device. Make the size (in bytes) of this buffer
1178 configurable. The size of this buffer is also configurable
1179 through the "dfu_bufsiz" environment variable.
1180
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001181 CONFIG_SYS_DFU_MAX_FILE_SIZE
1182 When updating files rather than the raw storage device,
1183 we use a static buffer to copy the file into and then write
1184 the buffer once we've been given the whole file. Define
1185 this to the maximum filesize (in bytes) for the buffer.
1186 Default is 4 MiB if undefined.
1187
Heiko Schochere1ba1512014-03-18 08:09:56 +01001188 DFU_DEFAULT_POLL_TIMEOUT
1189 Poll timeout [ms], is the timeout a device can send to the
1190 host. The host must wait for this timeout before sending
1191 a subsequent DFU_GET_STATUS request to the device.
1192
1193 DFU_MANIFEST_POLL_TIMEOUT
1194 Poll timeout [ms], which the device sends to the host when
1195 entering dfuMANIFEST state. Host waits this timeout, before
1196 sending again an USB request to the device.
1197
wdenkda04a8b2004-08-02 23:22:59 +00001198- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001199 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001200 Define these for a default partition on a NAND device
1201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001202 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1203 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001204 Define these for a default partition on a NOR device
1205
wdenkc6097192002-11-03 00:24:07 +00001206- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001207 See Kconfig help for available keyboard drivers.
1208
1209 CONFIG_KEYBOARD
1210
1211 Define this to enable a custom keyboard support.
1212 This simply calls drv_keyboard_init() which must be
1213 defined in your board-specific files. This option is deprecated
1214 and is only used by novena. For new boards, use driver model
1215 instead.
wdenkc6097192002-11-03 00:24:07 +00001216
1217- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001218 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001219 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001220 SOCs that have a DIU should define this macro to enable DIU
1221 support, and should also define these other macros:
1222
1223 CONFIG_SYS_DIU_ADDR
1224 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001225 CONFIG_CFB_CONSOLE
1226 CONFIG_VIDEO_SW_CURSOR
1227 CONFIG_VGA_AS_SINGLE_DEVICE
1228 CONFIG_VIDEO_LOGO
1229 CONFIG_VIDEO_BMP_LOGO
1230
Timur Tabi32f709e2011-04-11 14:18:22 -05001231 The DIU driver will look for the 'video-mode' environment
1232 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001233 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001234 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001235
wdenkc6097192002-11-03 00:24:07 +00001236- LCD Support: CONFIG_LCD
1237
1238 Define this to enable LCD support (for output to LCD
1239 display); also select one of the supported displays
1240 by defining one of these:
1241
Stelian Popf6f86652008-05-09 21:57:18 +02001242 CONFIG_ATMEL_LCD:
1243
1244 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1245
wdenkc0d54ae2003-11-25 16:55:19 +00001246 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001247
wdenkc0d54ae2003-11-25 16:55:19 +00001248 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001249
wdenkc0d54ae2003-11-25 16:55:19 +00001250 CONFIG_NEC_NL6448BC20
1251
1252 NEC NL6448BC20-08. 6.5", 640x480.
1253 Active, color, single scan.
1254
1255 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001256
wdenkc0d54ae2003-11-25 16:55:19 +00001257 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001258 Active, color, single scan.
1259
1260 CONFIG_SHARP_16x9
1261
1262 Sharp 320x240. Active, color, single scan.
1263 It isn't 16x9, and I am not sure what it is.
1264
1265 CONFIG_SHARP_LQ64D341
1266
1267 Sharp LQ64D341 display, 640x480.
1268 Active, color, single scan.
1269
1270 CONFIG_HLD1045
1271
1272 HLD1045 display, 640x480.
1273 Active, color, single scan.
1274
1275 CONFIG_OPTREX_BW
1276
1277 Optrex CBL50840-2 NF-FW 99 22 M5
1278 or
1279 Hitachi LMG6912RPFC-00T
1280 or
1281 Hitachi SP14Q002
1282
1283 320x240. Black & white.
1284
Simon Glass599a4df2012-10-17 13:24:54 +00001285 CONFIG_LCD_ALIGNMENT
1286
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001287 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001288 defined then the LCD will be aligned to this value instead.
1289 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1290 here, since it is cheaper to change data cache settings on
1291 a per-section basis.
1292
1293
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001294 CONFIG_LCD_ROTATION
1295
1296 Sometimes, for example if the display is mounted in portrait
1297 mode or even if it's mounted landscape but rotated by 180degree,
1298 we need to rotate our content of the display relative to the
1299 framebuffer, so that user can read the messages which are
1300 printed out.
1301 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1302 initialized with a given rotation from "vl_rot" out of
1303 "vidinfo_t" which is provided by the board specific code.
1304 The value for vl_rot is coded as following (matching to
1305 fbcon=rotate:<n> linux-kernel commandline):
1306 0 = no rotation respectively 0 degree
1307 1 = 90 degree rotation
1308 2 = 180 degree rotation
1309 3 = 270 degree rotation
1310
1311 If CONFIG_LCD_ROTATION is not defined, the console will be
1312 initialized with 0degree rotation.
1313
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001314 CONFIG_LCD_BMP_RLE8
1315
1316 Support drawing of RLE8-compressed bitmaps on the LCD.
1317
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001318 CONFIG_I2C_EDID
1319
1320 Enables an 'i2c edid' command which can read EDID
1321 information over I2C from an attached LCD display.
1322
wdenkeb20ad32003-09-05 23:19:14 +00001323- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001324
wdenk57b2d802003-06-27 21:31:46 +00001325 If this option is set, the environment is checked for
1326 a variable "splashimage". If found, the usual display
1327 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001328 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001329 specified in "splashimage" is loaded instead. The
1330 console is redirected to the "nulldev", too. This
1331 allows for a "silent" boot where a splash screen is
1332 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001333
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001334 CONFIG_SPLASHIMAGE_GUARD
1335
1336 If this option is set, then U-Boot will prevent the environment
1337 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001338 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001339 This option is useful for targets where, due to alignment
1340 restrictions, an improperly aligned BMP image will cause a data
1341 abort. If you think you will not have problems with unaligned
1342 accesses (for example because your toolchain prevents them)
1343 there is no need to set this option.
1344
Matthias Weisser53884182009-07-09 16:07:30 +02001345 CONFIG_SPLASH_SCREEN_ALIGN
1346
1347 If this option is set the splash image can be freely positioned
1348 on the screen. Environment variable "splashpos" specifies the
1349 position as "x,y". If a positive number is given it is used as
1350 number of pixel from left/top. If a negative number is given it
1351 is used as number of pixel from right/bottom. You can also
1352 specify 'm' for centering the image.
1353
1354 Example:
1355 setenv splashpos m,m
1356 => image at center of screen
1357
1358 setenv splashpos 30,20
1359 => image at x = 30 and y = 20
1360
1361 setenv splashpos -10,m
1362 => vertically centered image
1363 at x = dspWidth - bmpWidth - 9
1364
Stefan Roesed9d97742005-09-22 09:04:17 +02001365- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1366
1367 If this option is set, additionally to standard BMP
1368 images, gzipped BMP images can be displayed via the
1369 splashscreen support or the bmp command.
1370
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001371- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1372
1373 If this option is set, 8-bit RLE compressed BMP images
1374 can be displayed via the splashscreen support or the
1375 bmp command.
1376
wdenk710e3502003-08-29 20:57:53 +00001377- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001378 CONFIG_GZIP
1379
1380 Enabled by default to support gzip compressed images.
1381
wdenk710e3502003-08-29 20:57:53 +00001382 CONFIG_BZIP2
1383
1384 If this option is set, support for bzip2 compressed
1385 images is included. If not, only uncompressed and gzip
1386 compressed images are supported.
1387
wdenk9c53f402003-10-15 23:53:47 +00001388 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001389 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001390 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001391
wdenk0e2bd9c2004-06-06 21:51:03 +00001392- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001393 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1394
1395 The clock frequency of the MII bus
1396
wdenk0e2bd9c2004-06-06 21:51:03 +00001397 CONFIG_PHY_RESET_DELAY
1398
1399 Some PHY like Intel LXT971A need extra delay after
1400 reset before any MII register access is possible.
1401 For such PHY, set this option to the usec delay
1402 required. (minimum 300usec for LXT971A)
1403
1404 CONFIG_PHY_CMD_DELAY (ppc4xx)
1405
1406 Some PHY like Intel LXT971A need extra delay after
1407 command issued before MII status register can be read
1408
wdenkc6097192002-11-03 00:24:07 +00001409- IP address:
1410 CONFIG_IPADDR
1411
1412 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001413 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001414 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001415 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001416
1417- Server IP address:
1418 CONFIG_SERVERIP
1419
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001420 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001421 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001422 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001423
Robin Getz470a6d42009-07-21 12:15:28 -04001424 CONFIG_KEEP_SERVERADDR
1425
1426 Keeps the server's MAC address, in the env 'serveraddr'
1427 for passing to bootargs (like Linux's netconsole option)
1428
Wolfgang Denk26da2992011-10-26 10:21:22 +00001429- Gateway IP address:
1430 CONFIG_GATEWAYIP
1431
1432 Defines a default value for the IP address of the
1433 default router where packets to other networks are
1434 sent to.
1435 (Environment variable "gatewayip")
1436
1437- Subnet mask:
1438 CONFIG_NETMASK
1439
1440 Defines a default value for the subnet mask (or
1441 routing prefix) which is used to determine if an IP
1442 address belongs to the local subnet or needs to be
1443 forwarded through a router.
1444 (Environment variable "netmask")
1445
David Updegraff7280da72007-06-11 10:41:07 -05001446- Multicast TFTP Mode:
1447 CONFIG_MCAST_TFTP
1448
1449 Defines whether you want to support multicast TFTP as per
1450 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001451 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001452 driver in use must provide a function: mcast() to join/leave a
1453 multicast group.
1454
wdenkc6097192002-11-03 00:24:07 +00001455- BOOTP Recovery Mode:
1456 CONFIG_BOOTP_RANDOM_DELAY
1457
1458 If you have many targets in a network that try to
1459 boot using BOOTP, you may want to avoid that all
1460 systems send out BOOTP requests at precisely the same
1461 moment (which would happen for instance at recovery
1462 from a power failure, when all systems will try to
1463 boot, thus flooding the BOOTP server. Defining
1464 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1465 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001466 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001467
1468 1st BOOTP request: delay 0 ... 1 sec
1469 2nd BOOTP request: delay 0 ... 2 sec
1470 3rd BOOTP request: delay 0 ... 4 sec
1471 4th and following
1472 BOOTP requests: delay 0 ... 8 sec
1473
Thierry Reding8977cda2014-08-19 10:21:24 +02001474 CONFIG_BOOTP_ID_CACHE_SIZE
1475
1476 BOOTP packets are uniquely identified using a 32-bit ID. The
1477 server will copy the ID from client requests to responses and
1478 U-Boot will use this to determine if it is the destination of
1479 an incoming response. Some servers will check that addresses
1480 aren't in use before handing them out (usually using an ARP
1481 ping) and therefore take up to a few hundred milliseconds to
1482 respond. Network congestion may also influence the time it
1483 takes for a response to make it back to the client. If that
1484 time is too long, U-Boot will retransmit requests. In order
1485 to allow earlier responses to still be accepted after these
1486 retransmissions, U-Boot's BOOTP client keeps a small cache of
1487 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1488 cache. The default is to keep IDs for up to four outstanding
1489 requests. Increasing this will allow U-Boot to accept offers
1490 from a BOOTP client in networks with unusually high latency.
1491
stroesee0aadfb2003-08-28 14:17:32 +00001492- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001493 You can fine tune the DHCP functionality by defining
1494 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001495
Jon Loeliger5336a762007-07-09 22:08:34 -05001496 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger5336a762007-07-09 22:08:34 -05001497 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger5336a762007-07-09 22:08:34 -05001498 CONFIG_BOOTP_SEND_HOSTNAME
1499 CONFIG_BOOTP_NTPSERVER
1500 CONFIG_BOOTP_TIMEOFFSET
1501 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001502 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001503
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001504 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1505 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001506
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001507 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1508 after the configured retry count, the call will fail
1509 instead of starting over. This can be used to fail over
1510 to Link-local IP address configuration if the DHCP server
1511 is not available.
1512
stroesee0aadfb2003-08-28 14:17:32 +00001513 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1514 to do a dynamic update of a DNS server. To do this, they
1515 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001516 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001517 of the "hostname" environment variable is passed as
1518 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001519
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001520 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1521
1522 A 32bit value in microseconds for a delay between
1523 receiving a "DHCP Offer" and sending the "DHCP Request".
1524 This fixes a problem with certain DHCP servers that don't
1525 respond 100% of the time to a "DHCP request". E.g. On an
1526 AT91RM9200 processor running at 180MHz, this delay needed
1527 to be *at least* 15,000 usec before a Windows Server 2003
1528 DHCP server would reply 100% of the time. I recommend at
1529 least 50,000 usec to be safe. The alternative is to hope
1530 that one of the retries will be successful but note that
1531 the DHCP timeout and retry process takes a longer than
1532 this delay.
1533
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001534 - Link-local IP address negotiation:
1535 Negotiate with other link-local clients on the local network
1536 for an address that doesn't require explicit configuration.
1537 This is especially useful if a DHCP server cannot be guaranteed
1538 to exist in all environments that the device must operate.
1539
1540 See doc/README.link-local for more information.
1541
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301542 - MAC address from environment variables
1543
1544 FDT_SEQ_MACADDR_FROM_ENV
1545
1546 Fix-up device tree with MAC addresses fetched sequentially from
1547 environment variables. This config work on assumption that
1548 non-usable ethernet node of device-tree are either not present
1549 or their status has been marked as "disabled".
1550
wdenk145d2c12004-04-15 21:48:45 +00001551 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001552 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001553
1554 The device id used in CDP trigger frames.
1555
1556 CONFIG_CDP_DEVICE_ID_PREFIX
1557
1558 A two character string which is prefixed to the MAC address
1559 of the device.
1560
1561 CONFIG_CDP_PORT_ID
1562
1563 A printf format string which contains the ascii name of
1564 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001565 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001566
1567 CONFIG_CDP_CAPABILITIES
1568
1569 A 32bit integer which indicates the device capabilities;
1570 0x00000010 for a normal host which does not forwards.
1571
1572 CONFIG_CDP_VERSION
1573
1574 An ascii string containing the version of the software.
1575
1576 CONFIG_CDP_PLATFORM
1577
1578 An ascii string containing the name of the platform.
1579
1580 CONFIG_CDP_TRIGGER
1581
1582 A 32bit integer sent on the trigger.
1583
1584 CONFIG_CDP_POWER_CONSUMPTION
1585
1586 A 16bit integer containing the power consumption of the
1587 device in .1 of milliwatts.
1588
1589 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1590
1591 A byte containing the id of the VLAN.
1592
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001593- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001594
1595 Several configurations allow to display the current
1596 status using a LED. For instance, the LED will blink
1597 fast while running U-Boot code, stop blinking as
1598 soon as a reply to a BOOTP request was received, and
1599 start blinking slow once the Linux kernel is running
1600 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001601 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001602 feature in U-Boot.
1603
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001604 Additional options:
1605
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001606 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001607 The status LED can be connected to a GPIO pin.
1608 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001609 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001610 to include the gpio_led driver in the U-Boot binary.
1611
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001612 CONFIG_GPIO_LED_INVERTED_TABLE
1613 Some GPIO connected LEDs may have inverted polarity in which
1614 case the GPIO high value corresponds to LED off state and
1615 GPIO low value corresponds to LED on state.
1616 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1617 with a list of GPIO LEDs that have inverted polarity.
1618
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001619- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001620
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001621 This enable the NEW i2c subsystem, and will allow you to use
1622 i2c commands at the u-boot command line (as long as you set
1623 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1624 based realtime clock chips or other i2c devices. See
1625 common/cmd_i2c.c for a description of the command line
1626 interface.
1627
1628 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001629 - drivers/i2c/soft_i2c.c:
1630 - activate first bus with CONFIG_SYS_I2C_SOFT define
1631 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1632 for defining speed and slave address
1633 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1634 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1635 for defining speed and slave address
1636 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1637 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1638 for defining speed and slave address
1639 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1640 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1641 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001642
Heiko Schocherf2850742012-10-24 13:48:22 +02001643 - drivers/i2c/fsl_i2c.c:
1644 - activate i2c driver with CONFIG_SYS_I2C_FSL
1645 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1646 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1647 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1648 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001649 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001650 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1651 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1652 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1653 second bus.
1654
Simon Glass026fefb2012-10-30 07:28:53 +00001655 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001656 - activate this driver with CONFIG_SYS_I2C_TEGRA
1657 - This driver adds 4 i2c buses with a fix speed from
1658 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001659
Dirk Eibach42b204f2013-04-25 02:40:01 +00001660 - drivers/i2c/ppc4xx_i2c.c
1661 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1662 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1663 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1664
trema49f40a2013-09-21 18:13:35 +02001665 - drivers/i2c/i2c_mxc.c
1666 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001667 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1668 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1669 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1670 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02001671 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1672 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1673 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1674 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1675 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1676 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02001677 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1678 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001679 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02001680 for speed, and 0 for slave.
1681
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09001682 - drivers/i2c/rcar_i2c.c:
1683 - activate this driver with CONFIG_SYS_I2C_RCAR
1684 - This driver adds 4 i2c buses
1685
1686 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1687 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1688 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1689 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1690 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1691 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1692 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1693 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1694 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1695
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001696 - drivers/i2c/sh_i2c.c:
1697 - activate this driver with CONFIG_SYS_I2C_SH
1698 - This driver adds from 2 to 5 i2c buses
1699
1700 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1701 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1702 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1703 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1704 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1705 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1706 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1707 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1708 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1709 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001710 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09001711
Heiko Schocherf53f2b82013-10-22 11:03:18 +02001712 - drivers/i2c/omap24xx_i2c.c
1713 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1714 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1715 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1716 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1717 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1718 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1719 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1720 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1721 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1722 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1723 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1724
Heiko Schocher465819a2013-11-08 07:30:53 +01001725 - drivers/i2c/zynq_i2c.c
1726 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1727 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1728 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1729
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05301730 - drivers/i2c/s3c24x0_i2c.c:
1731 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1732 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1733 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1734 with a fix speed from 100000 and the slave addr 0!
1735
Dirk Eibachb9577432014-07-03 09:28:18 +02001736 - drivers/i2c/ihs_i2c.c
1737 - activate this driver with CONFIG_SYS_I2C_IHS
1738 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1739 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1740 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1741 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1742 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1743 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1744 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1745 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1746 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1747 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1748 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1749 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01001750 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1751 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1752 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1753 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1754 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1755 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1756 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1757 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1758 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02001759
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001760 additional defines:
1761
1762 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001763 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001764
1765 CONFIG_SYS_I2C_DIRECT_BUS
1766 define this, if you don't use i2c muxes on your hardware.
1767 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1768 omit this define.
1769
1770 CONFIG_SYS_I2C_MAX_HOPS
1771 define how many muxes are maximal consecutively connected
1772 on one i2c bus. If you not use i2c muxes, omit this
1773 define.
1774
1775 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001776 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001777 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1778 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1779 CONFIG_SYS_NUM_I2C_BUSES = 9:
1780
1781 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1782 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1783 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1784 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1785 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1786 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1787 {1, {I2C_NULL_HOP}}, \
1788 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1789 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1790 }
1791
1792 which defines
1793 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001794 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1795 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1796 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1797 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1798 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001799 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001800 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1801 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001802
1803 If you do not have i2c muxes on your board, omit this define.
1804
Simon Glass3efce392017-05-12 21:10:00 -06001805- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001806 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001807 then the following macros need to be defined (examples are
1808 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001809
1810 I2C_INIT
1811
wdenkb9bbd242003-06-30 16:24:52 +00001812 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001813 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001814
wdenk544e9732004-02-06 23:19:44 +00001815 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001816
wdenkc6097192002-11-03 00:24:07 +00001817 I2C_ACTIVE
1818
1819 The code necessary to make the I2C data line active
1820 (driven). If the data line is open collector, this
1821 define can be null.
1822
wdenkb9bbd242003-06-30 16:24:52 +00001823 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1824
wdenkc6097192002-11-03 00:24:07 +00001825 I2C_TRISTATE
1826
1827 The code necessary to make the I2C data line tri-stated
1828 (inactive). If the data line is open collector, this
1829 define can be null.
1830
wdenkb9bbd242003-06-30 16:24:52 +00001831 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1832
wdenkc6097192002-11-03 00:24:07 +00001833 I2C_READ
1834
York Sun4a598092013-04-01 11:29:11 -07001835 Code that returns true if the I2C data line is high,
1836 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001837
wdenkb9bbd242003-06-30 16:24:52 +00001838 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1839
wdenkc6097192002-11-03 00:24:07 +00001840 I2C_SDA(bit)
1841
York Sun4a598092013-04-01 11:29:11 -07001842 If <bit> is true, sets the I2C data line high. If it
1843 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001844
wdenkb9bbd242003-06-30 16:24:52 +00001845 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001846 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001847 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001848
wdenkc6097192002-11-03 00:24:07 +00001849 I2C_SCL(bit)
1850
York Sun4a598092013-04-01 11:29:11 -07001851 If <bit> is true, sets the I2C clock line high. If it
1852 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001853
wdenkb9bbd242003-06-30 16:24:52 +00001854 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001855 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001856 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001857
wdenkc6097192002-11-03 00:24:07 +00001858 I2C_DELAY
1859
1860 This delay is invoked four times per clock cycle so this
1861 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001862 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001863 like:
1864
wdenkb9bbd242003-06-30 16:24:52 +00001865 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001866
Mike Frysingeree12d542010-07-21 13:38:02 -04001867 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1868
1869 If your arch supports the generic GPIO framework (asm/gpio.h),
1870 then you may alternatively define the two GPIOs that are to be
1871 used as SCL / SDA. Any of the previous I2C_xxx macros will
1872 have GPIO-based defaults assigned to them as appropriate.
1873
1874 You should define these to the GPIO value as given directly to
1875 the generic GPIO functions.
1876
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001877 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001878
wdenk57b2d802003-06-27 21:31:46 +00001879 When a board is reset during an i2c bus transfer
1880 chips might think that the current transfer is still
1881 in progress. On some boards it is possible to access
1882 the i2c SCLK line directly, either by using the
1883 processor pin as a GPIO or by having a second pin
1884 connected to the bus. If this option is defined a
1885 custom i2c_init_board() routine in boards/xxx/board.c
1886 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001887
Ben Warren45657152006-09-07 16:50:54 -04001888 CONFIG_I2C_MULTI_BUS
1889
1890 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001891 must have a controller. At any point in time, only one bus is
1892 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001893 Note that bus numbering is zero-based.
1894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001895 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001896
1897 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001898 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001899 is set, specify a list of bus-device pairs. Otherwise, specify
1900 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001901
1902 e.g.
1903 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001904 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001905
1906 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1907
Wolfgang Denk092ae952011-10-26 10:21:21 +00001908 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001909 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001910
1911 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1912
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001913 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001914
1915 If defined, then this indicates the I2C bus number for DDR SPD.
1916 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001918 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001919
1920 If defined, then this indicates the I2C bus number for the RTC.
1921 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1922
Andrew Dyer58c41f92008-12-29 17:36:01 -06001923 CONFIG_SOFT_I2C_READ_REPEATED_START
1924
1925 defining this will force the i2c_read() function in
1926 the soft_i2c driver to perform an I2C repeated start
1927 between writing the address pointer and reading the
1928 data. If this define is omitted the default behaviour
1929 of doing a stop-start sequence will be used. Most I2C
1930 devices can use either method, but some require one or
1931 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001932
wdenkc6097192002-11-03 00:24:07 +00001933- SPI Support: CONFIG_SPI
1934
1935 Enables SPI driver (so far only tested with
1936 SPI EEPROM, also an instance works with Crystal A/D and
1937 D/As on the SACSng board)
1938
wdenkc6097192002-11-03 00:24:07 +00001939 CONFIG_SOFT_SPI
1940
wdenk4a5c8a72003-03-06 00:02:04 +00001941 Enables a software (bit-bang) SPI driver rather than
1942 using hardware support. This is a general purpose
1943 driver that only requires three general I/O port pins
1944 (two outputs, one input) to function. If this is
1945 defined, the board configuration must define several
1946 SPI configuration items (port pins to use, etc). For
1947 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001948
Ben Warren7efe9272008-01-16 22:37:35 -05001949 CONFIG_HARD_SPI
1950
1951 Enables a hardware SPI driver for general-purpose reads
1952 and writes. As with CONFIG_SOFT_SPI, the board configuration
1953 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00001954 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05001955 example, see include/configs/mpc8349emds.h.
1956
Heiko Schocherb77c8882014-07-14 10:22:11 +02001957 CONFIG_SYS_SPI_MXC_WAIT
1958 Timeout for waiting until spi transfer completed.
1959 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1960
Matthias Fuchsa4400872007-12-27 17:12:34 +01001961- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001962
Matthias Fuchsa4400872007-12-27 17:12:34 +01001963 Enables FPGA subsystem.
1964
1965 CONFIG_FPGA_<vendor>
1966
1967 Enables support for specific chip vendors.
1968 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001969
Matthias Fuchsa4400872007-12-27 17:12:34 +01001970 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001971
Matthias Fuchsa4400872007-12-27 17:12:34 +01001972 Enables support for FPGA family.
1973 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1974
1975 CONFIG_FPGA_COUNT
1976
1977 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001978
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001979 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001980
wdenk57b2d802003-06-27 21:31:46 +00001981 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001982
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001983 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001984
wdenk4a5c8a72003-03-06 00:02:04 +00001985 Enable checks on FPGA configuration interface busy
1986 status by the configuration function. This option
1987 will require a board or device specific function to
1988 be written.
wdenkc6097192002-11-03 00:24:07 +00001989
1990 CONFIG_FPGA_DELAY
1991
1992 If defined, a function that provides delays in the FPGA
1993 configuration driver.
1994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001995 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001996 Allow Control-C to interrupt FPGA configuration
1997
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001998 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001999
wdenk4a5c8a72003-03-06 00:02:04 +00002000 Check for configuration errors during FPGA bitfile
2001 loading. For example, abort during Virtex II
2002 configuration if the INIT_B line goes low (which
2003 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002004
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002005 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002006
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002007 Maximum time to wait for the INIT_B line to de-assert
2008 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002009 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002010 ms.
wdenkc6097192002-11-03 00:24:07 +00002011
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002012 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002013
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002014 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002015 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002017 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002018
wdenk4a5c8a72003-03-06 00:02:04 +00002019 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002020 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002021
2022- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002023 CONFIG_BUILD_TARGET
2024
2025 Some SoCs need special image types (e.g. U-Boot binary
2026 with a special header) as build targets. By defining
2027 CONFIG_BUILD_TARGET in the SoC / board header, this
2028 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002029 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002030
wdenkc6097192002-11-03 00:24:07 +00002031 CONFIG_IDENT_STRING
2032
wdenk4a5c8a72003-03-06 00:02:04 +00002033 If defined, this string will be added to the U-Boot
2034 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002035
2036- Vendor Parameter Protection:
2037
wdenk4a5c8a72003-03-06 00:02:04 +00002038 U-Boot considers the values of the environment
2039 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002040 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002041 are set once by the board vendor / manufacturer, and
2042 protects these variables from casual modification by
2043 the user. Once set, these variables are read-only,
2044 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002045 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002046
2047 If CONFIG_ENV_OVERWRITE is #defined in your config
2048 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002049 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002050 these parameters.
2051
Joe Hershberger76f353e2015-05-04 14:55:14 -05002052 Alternatively, if you define _both_ an ethaddr in the
2053 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002054 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002055 which can be changed exactly ONCE by the user. [The
2056 serial# is unaffected by this, i. e. it remains
2057 read-only.]
2058
Joe Hershberger71497d02012-12-11 22:16:31 -06002059 The same can be accomplished in a more flexible way
2060 for any variable by configuring the type of access
2061 to allow for those variables in the ".flags" variable
2062 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2063
wdenkc6097192002-11-03 00:24:07 +00002064- Protected RAM:
2065 CONFIG_PRAM
2066
2067 Define this variable to enable the reservation of
2068 "protected RAM", i. e. RAM which is not overwritten
2069 by U-Boot. Define CONFIG_PRAM to hold the number of
2070 kB you want to reserve for pRAM. You can overwrite
2071 this default value by defining an environment
2072 variable "pram" to the number of kB you want to
2073 reserve. Note that the board info structure will
2074 still show the full amount of RAM. If pRAM is
2075 reserved, a new environment variable "mem" will
2076 automatically be defined to hold the amount of
2077 remaining RAM in a form that can be passed as boot
2078 argument to Linux, for instance like that:
2079
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002080 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002081 saveenv
2082
2083 This way you can tell Linux not to use this memory,
2084 either, which results in a memory region that will
2085 not be affected by reboots.
2086
2087 *WARNING* If your board configuration uses automatic
2088 detection of the RAM size, you must make sure that
2089 this memory test is non-destructive. So far, the
2090 following board configurations are known to be
2091 "pRAM-clean":
2092
Heiko Schocher65d94db2017-06-07 17:33:09 +02002093 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00002094 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02002095 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002096
Gabe Blacka2f3a932012-12-02 04:55:18 +00002097- Access to physical memory region (> 4GB)
2098 Some basic support is provided for operations on memory not
2099 normally accessible to U-Boot - e.g. some architectures
2100 support access to more than 4GB of memory on 32-bit
2101 machines using physical address extension or similar.
2102 Define CONFIG_PHYSMEM to access this basic support, which
2103 currently only supports clearing the memory.
2104
wdenkc6097192002-11-03 00:24:07 +00002105- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002106 CONFIG_NET_RETRY_COUNT
2107
wdenk4a5c8a72003-03-06 00:02:04 +00002108 This variable defines the number of retries for
2109 network operations like ARP, RARP, TFTP, or BOOTP
2110 before giving up the operation. If not defined, a
2111 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002112
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002113 CONFIG_ARP_TIMEOUT
2114
2115 Timeout waiting for an ARP reply in milliseconds.
2116
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002117 CONFIG_NFS_TIMEOUT
2118
2119 Timeout in milliseconds used in NFS protocol.
2120 If you encounter "ERROR: Cannot umount" in nfs command,
2121 try longer timeout such as
2122 #define CONFIG_NFS_TIMEOUT 10000UL
2123
wdenkc6097192002-11-03 00:24:07 +00002124- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002125 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002126
2127 This defines the secondary prompt string, which is
2128 printed when the command interpreter needs more input
2129 to complete a command. Usually "> ".
2130
2131 Note:
2132
wdenk57b2d802003-06-27 21:31:46 +00002133 In the current implementation, the local variables
2134 space and global environment variables space are
2135 separated. Local variables are those you define by
2136 simply typing `name=value'. To access a local
2137 variable later on, you have write `$name' or
2138 `${name}'; to execute the contents of a variable
2139 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002140
wdenk4a5c8a72003-03-06 00:02:04 +00002141 Global environment variables are those you use
2142 setenv/printenv to work with. To run a command stored
2143 in such a variable, you need to use the run command,
2144 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002145
2146 To store commands and special characters in a
2147 variable, please use double quotation marks
2148 surrounding the whole text of the variable, instead
2149 of the backslashes before semicolons and special
2150 symbols.
2151
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002152- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01002153 CONFIG_CMDLINE_PS_SUPPORT
2154
2155 Enable support for changing the command prompt string
2156 at run-time. Only static string is supported so far.
2157 The string is obtained from environment variables PS1
2158 and PS2.
2159
wdenkc0aa5c52003-12-06 19:49:23 +00002160- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002161 CONFIG_EXTRA_ENV_SETTINGS
2162
wdenk4a5c8a72003-03-06 00:02:04 +00002163 Define this to contain any number of null terminated
2164 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002165 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002166
wdenk4a5c8a72003-03-06 00:02:04 +00002167 For example, place something like this in your
2168 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002169
2170 #define CONFIG_EXTRA_ENV_SETTINGS \
2171 "myvar1=value1\0" \
2172 "myvar2=value2\0"
2173
wdenk4a5c8a72003-03-06 00:02:04 +00002174 Warning: This method is based on knowledge about the
2175 internal format how the environment is stored by the
2176 U-Boot code. This is NOT an official, exported
2177 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002178 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002179 You better know what you are doing here.
2180
wdenk4a5c8a72003-03-06 00:02:04 +00002181 Note: overly (ab)use of the default environment is
2182 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002183 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002184 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002185
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002186 CONFIG_DELAY_ENVIRONMENT
2187
2188 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002189 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002190 that so that the environment is not available until
2191 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2192 this is instead controlled by the value of
2193 /config/load-environment.
2194
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002195- Serial Flash support
Simon Glass663b0cc2017-08-04 16:35:06 -06002196 Usage requires an initial 'sf probe' to define the serial
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002197 flash parameters, followed by read/write/erase/update
2198 commands.
2199
2200 The following defaults may be provided by the platform
2201 to handle the common case when only a single serial
2202 flash is present on the system.
2203
2204 CONFIG_SF_DEFAULT_BUS Bus identifier
2205 CONFIG_SF_DEFAULT_CS Chip-select
2206 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2207 CONFIG_SF_DEFAULT_SPEED in Hz
2208
wdenkef893942004-02-23 16:11:30 +00002209
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002210- TFTP Fixed UDP Port:
2211 CONFIG_TFTP_PORT
2212
Wolfgang Denk227b5192005-09-24 23:25:46 +02002213 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002214 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002215 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002216 number generator is used.
2217
Wolfgang Denk227b5192005-09-24 23:25:46 +02002218 Also, the environment variable tftpdstp is used to supply
2219 the TFTP UDP destination port value. If tftpdstp isn't
2220 defined, the normal port 69 is used.
2221
2222 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002223 blindly start the TFTP transfer using the pre-configured
2224 target IP address and UDP port. This has the effect of
2225 "punching through" the (Windows XP) firewall, allowing
2226 the remainder of the TFTP transfer to proceed normally.
2227 A better solution is to properly configure the firewall,
2228 but sometimes that is not allowed.
2229
wdenkc0aa5c52003-12-06 19:49:23 +00002230- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002231 CONFIG_SHOW_BOOT_PROGRESS
2232
wdenk4a5c8a72003-03-06 00:02:04 +00002233 Defining this option allows to add some board-
2234 specific code (calling a user-provided function
2235 "show_boot_progress(int)") that enables you to show
2236 the system's boot progress on some display (for
2237 example, some LED's) on your board. At the moment,
2238 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002239
Simon Glass0fa36a42012-09-28 08:56:37 +00002240
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002241Legacy uImage format:
2242
wdenkc6097192002-11-03 00:24:07 +00002243 Arg Where When
2244 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002245 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002246 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002247 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002248 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002249 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002250 4 common/cmd_bootm.c Image data has correct checksum
2251 -4 common/cmd_bootm.c Image is for unsupported architecture
2252 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002253 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002254 6 common/cmd_bootm.c Image Type check OK
2255 -6 common/cmd_bootm.c gunzip uncompression error
2256 -7 common/cmd_bootm.c Unimplemented compression type
2257 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002258 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002259 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002260
2261 9 common/image.c Start initial ramdisk verification
2262 -10 common/image.c Ramdisk header has bad magic number
2263 -11 common/image.c Ramdisk header has bad checksum
2264 10 common/image.c Ramdisk header is OK
2265 -12 common/image.c Ramdisk data has bad checksum
2266 11 common/image.c Ramdisk data has correct checksum
2267 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002268 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002269 13 common/image.c Start multifile image verification
2270 14 common/image.c No initial ramdisk, no multifile, continue.
2271
Wolfgang Denk092ae952011-10-26 10:21:21 +00002272 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002273
Stefan Roese88fbf932010-04-15 16:07:28 +02002274 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002275 -31 post/post.c POST test failed, detected by post_output_backlog()
2276 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002277
Heiko Schocher633e03a2007-06-22 19:11:54 +02002278 34 common/cmd_doc.c before loading a Image from a DOC device
2279 -35 common/cmd_doc.c Bad usage of "doc" command
2280 35 common/cmd_doc.c correct usage of "doc" command
2281 -36 common/cmd_doc.c No boot device
2282 36 common/cmd_doc.c correct boot device
2283 -37 common/cmd_doc.c Unknown Chip ID on boot device
2284 37 common/cmd_doc.c correct chip ID found, device available
2285 -38 common/cmd_doc.c Read Error on boot device
2286 38 common/cmd_doc.c reading Image header from DOC device OK
2287 -39 common/cmd_doc.c Image header has bad magic number
2288 39 common/cmd_doc.c Image header has correct magic number
2289 -40 common/cmd_doc.c Error reading Image from DOC device
2290 40 common/cmd_doc.c Image header has correct magic number
2291 41 common/cmd_ide.c before loading a Image from a IDE device
2292 -42 common/cmd_ide.c Bad usage of "ide" command
2293 42 common/cmd_ide.c correct usage of "ide" command
2294 -43 common/cmd_ide.c No boot device
2295 43 common/cmd_ide.c boot device found
2296 -44 common/cmd_ide.c Device not available
2297 44 common/cmd_ide.c Device available
2298 -45 common/cmd_ide.c wrong partition selected
2299 45 common/cmd_ide.c partition selected
2300 -46 common/cmd_ide.c Unknown partition table
2301 46 common/cmd_ide.c valid partition table found
2302 -47 common/cmd_ide.c Invalid partition type
2303 47 common/cmd_ide.c correct partition type
2304 -48 common/cmd_ide.c Error reading Image Header on boot device
2305 48 common/cmd_ide.c reading Image Header from IDE device OK
2306 -49 common/cmd_ide.c Image header has bad magic number
2307 49 common/cmd_ide.c Image header has correct magic number
2308 -50 common/cmd_ide.c Image header has bad checksum
2309 50 common/cmd_ide.c Image header has correct checksum
2310 -51 common/cmd_ide.c Error reading Image from IDE device
2311 51 common/cmd_ide.c reading Image from IDE device OK
2312 52 common/cmd_nand.c before loading a Image from a NAND device
2313 -53 common/cmd_nand.c Bad usage of "nand" command
2314 53 common/cmd_nand.c correct usage of "nand" command
2315 -54 common/cmd_nand.c No boot device
2316 54 common/cmd_nand.c boot device found
2317 -55 common/cmd_nand.c Unknown Chip ID on boot device
2318 55 common/cmd_nand.c correct chip ID found, device available
2319 -56 common/cmd_nand.c Error reading Image Header on boot device
2320 56 common/cmd_nand.c reading Image Header from NAND device OK
2321 -57 common/cmd_nand.c Image header has bad magic number
2322 57 common/cmd_nand.c Image header has correct magic number
2323 -58 common/cmd_nand.c Error reading Image from NAND device
2324 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002325
Heiko Schocher633e03a2007-06-22 19:11:54 +02002326 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002327
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002328 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002329 -64 net/eth.c no Ethernet found.
2330 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002331
Heiko Schocher633e03a2007-06-22 19:11:54 +02002332 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002333 80 common/cmd_net.c before calling net_loop()
2334 -81 common/cmd_net.c some error in net_loop() occurred
2335 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002336 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2337 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002338 83 common/cmd_net.c running "source" command
2339 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002340 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002341
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002342FIT uImage format:
2343
2344 Arg Where When
2345 100 common/cmd_bootm.c Kernel FIT Image has correct format
2346 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2347 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2348 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2349 102 common/cmd_bootm.c Kernel unit name specified
2350 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002351 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002352 104 common/cmd_bootm.c Got kernel subimage node offset
2353 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2354 105 common/cmd_bootm.c Kernel subimage hash verification OK
2355 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2356 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002357 -106 common/cmd_bootm.c Kernel subimage has wrong type
2358 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002359 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2360 108 common/cmd_bootm.c Got kernel subimage data/size
2361 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2362 -109 common/cmd_bootm.c Can't get kernel subimage type
2363 -110 common/cmd_bootm.c Can't get kernel subimage comp
2364 -111 common/cmd_bootm.c Can't get kernel subimage os
2365 -112 common/cmd_bootm.c Can't get kernel subimage load address
2366 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2367
2368 120 common/image.c Start initial ramdisk verification
2369 -120 common/image.c Ramdisk FIT image has incorrect format
2370 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002371 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002372 -122 common/image.c Can't get configuration for ramdisk subimage
2373 123 common/image.c Ramdisk unit name specified
2374 -124 common/image.c Can't get ramdisk subimage node offset
2375 125 common/image.c Got ramdisk subimage node offset
2376 -125 common/image.c Ramdisk subimage hash verification failed
2377 126 common/image.c Ramdisk subimage hash verification OK
2378 -126 common/image.c Ramdisk subimage for unsupported architecture
2379 127 common/image.c Architecture check OK
2380 -127 common/image.c Can't get ramdisk subimage data/size
2381 128 common/image.c Got ramdisk subimage data/size
2382 129 common/image.c Can't get ramdisk load address
2383 -129 common/image.c Got ramdisk load address
2384
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002385 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002386 131 common/cmd_doc.c FIT image format OK
2387
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002388 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002389 141 common/cmd_ide.c FIT image format OK
2390
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002391 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002392 151 common/cmd_nand.c FIT image format OK
2393
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002394- Standalone program support:
2395 CONFIG_STANDALONE_LOAD_ADDR
2396
Wolfgang Denk23f78482011-10-09 21:06:34 +02002397 This option defines a board specific value for the
2398 address where standalone program gets loaded, thus
2399 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002400 settings.
2401
2402- Frame Buffer Address:
2403 CONFIG_FB_ADDR
2404
2405 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002406 address for frame buffer. This is typically the case
2407 when using a graphics controller has separate video
2408 memory. U-Boot will then place the frame buffer at
2409 the given address instead of dynamically reserving it
2410 in system RAM by calling lcd_setmem(), which grabs
2411 the memory for the frame buffer depending on the
2412 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002413
2414 Please see board_init_f function.
2415
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002416- Automatic software updates via TFTP server
2417 CONFIG_UPDATE_TFTP
2418 CONFIG_UPDATE_TFTP_CNT_MAX
2419 CONFIG_UPDATE_TFTP_MSEC_MAX
2420
2421 These options enable and control the auto-update feature;
2422 for a more detailed description refer to doc/README.update.
2423
2424- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02002425 CONFIG_MTD_UBI_WL_THRESHOLD
2426 This parameter defines the maximum difference between the highest
2427 erase counter value and the lowest erase counter value of eraseblocks
2428 of UBI devices. When this threshold is exceeded, UBI starts performing
2429 wear leveling by means of moving data from eraseblock with low erase
2430 counter to eraseblocks with high erase counter.
2431
2432 The default value should be OK for SLC NAND flashes, NOR flashes and
2433 other flashes which have eraseblock life-cycle 100000 or more.
2434 However, in case of MLC NAND flashes which typically have eraseblock
2435 life-cycle less than 10000, the threshold should be lessened (e.g.,
2436 to 128 or 256, although it does not have to be power of 2).
2437
2438 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002439
Heiko Schocherf5895d12014-06-24 10:10:04 +02002440 CONFIG_MTD_UBI_BEB_LIMIT
2441 This option specifies the maximum bad physical eraseblocks UBI
2442 expects on the MTD device (per 1024 eraseblocks). If the
2443 underlying flash does not admit of bad eraseblocks (e.g. NOR
2444 flash), this value is ignored.
2445
2446 NAND datasheets often specify the minimum and maximum NVM
2447 (Number of Valid Blocks) for the flashes' endurance lifetime.
2448 The maximum expected bad eraseblocks per 1024 eraseblocks
2449 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2450 which gives 20 for most NANDs (MaxNVB is basically the total
2451 count of eraseblocks on the chip).
2452
2453 To put it differently, if this value is 20, UBI will try to
2454 reserve about 1.9% of physical eraseblocks for bad blocks
2455 handling. And that will be 1.9% of eraseblocks on the entire
2456 NAND chip, not just the MTD partition UBI attaches. This means
2457 that if you have, say, a NAND flash chip admits maximum 40 bad
2458 eraseblocks, and it is split on two MTD partitions of the same
2459 size, UBI will reserve 40 eraseblocks when attaching a
2460 partition.
2461
2462 default: 20
2463
2464 CONFIG_MTD_UBI_FASTMAP
2465 Fastmap is a mechanism which allows attaching an UBI device
2466 in nearly constant time. Instead of scanning the whole MTD device it
2467 only has to locate a checkpoint (called fastmap) on the device.
2468 The on-flash fastmap contains all information needed to attach
2469 the device. Using fastmap makes only sense on large devices where
2470 attaching by scanning takes long. UBI will not automatically install
2471 a fastmap on old images, but you can set the UBI parameter
2472 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2473 that fastmap-enabled images are still usable with UBI implementations
2474 without fastmap support. On typical flash devices the whole fastmap
2475 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2476
2477 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2478 Set this parameter to enable fastmap automatically on images
2479 without a fastmap.
2480 default: 0
2481
Heiko Schocher94b66de2015-10-22 06:19:21 +02002482 CONFIG_MTD_UBI_FM_DEBUG
2483 Enable UBI fastmap debug
2484 default: 0
2485
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002486- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002487 CONFIG_SPL
2488 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002489
Tom Rini36853852012-02-14 07:29:40 +00002490 CONFIG_SPL_LDSCRIPT
2491 LDSCRIPT for linking the SPL binary.
2492
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002493 CONFIG_SPL_MAX_FOOTPRINT
2494 Maximum size in memory allocated to the SPL, BSS included.
2495 When defined, the linker checks that the actual memory
2496 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002497 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002498 must not be both defined at the same time.
2499
Tom Rini36853852012-02-14 07:29:40 +00002500 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002501 Maximum size of the SPL image (text, data, rodata, and
2502 linker lists sections), BSS excluded.
2503 When defined, the linker checks that the actual size does
2504 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002505
Wolfgang Denk825223d2011-09-11 21:24:09 +02002506 CONFIG_SPL_TEXT_BASE
2507 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002508
Scott Woodc4f0d002012-09-20 19:05:12 -05002509 CONFIG_SPL_RELOC_TEXT_BASE
2510 Address to relocate to. If unspecified, this is equal to
2511 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2512
Tom Rini36853852012-02-14 07:29:40 +00002513 CONFIG_SPL_BSS_START_ADDR
2514 Link address for the BSS within the SPL binary.
2515
2516 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002517 Maximum size in memory allocated to the SPL BSS.
2518 When defined, the linker checks that the actual memory used
2519 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002520 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002521 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002522
2523 CONFIG_SPL_STACK
2524 Adress of the start of the stack SPL will use
2525
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02002526 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2527 When defined, SPL will panic() if the image it has
2528 loaded does not have a signature.
2529 Defining this is useful when code which loads images
2530 in SPL cannot guarantee that absolutely all read errors
2531 will be caught.
2532 An example is the LPC32XX MLC NAND driver, which will
2533 consider that a completely unreadable NAND block is bad,
2534 and thus should be skipped silently.
2535
Scott Woodc4f0d002012-09-20 19:05:12 -05002536 CONFIG_SPL_RELOC_STACK
2537 Adress of the start of the stack SPL will use after
2538 relocation. If unspecified, this is equal to
2539 CONFIG_SPL_STACK.
2540
Tom Rini36853852012-02-14 07:29:40 +00002541 CONFIG_SYS_SPL_MALLOC_START
2542 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02002543 When this option is set the full malloc is used in SPL and
2544 it is set up by spl_init() and before that, the simple malloc()
2545 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00002546
2547 CONFIG_SYS_SPL_MALLOC_SIZE
2548 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002549
Tom Rinic2b76002014-03-28 12:03:39 -04002550 CONFIG_SPL_OS_BOOT
2551 Enable booting directly to an OS from SPL.
2552 See also: doc/README.falcon
2553
Tom Rinife3b0c72012-08-13 11:37:56 -07002554 CONFIG_SPL_DISPLAY_PRINT
2555 For ARM, enable an optional function to print more information
2556 about the running system.
2557
Scott Wood7c810902012-09-20 16:35:21 -05002558 CONFIG_SPL_INIT_MINIMAL
2559 Arch init code should be built for a very small image
2560
Paul Kocialkowski17675c82014-11-08 23:14:56 +01002561 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2562 Partition on the MMC to load U-Boot from when the MMC is being
2563 used in raw mode
2564
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002565 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2566 Sector to load kernel uImage from when MMC is being
2567 used in raw mode (for Falcon mode)
2568
2569 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2570 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2571 Sector and number of sectors to load kernel argument
2572 parameters from when MMC is being used in raw mode
2573 (for falcon mode)
2574
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01002575 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2576 Partition on the MMC to load U-Boot from when the MMC is being
2577 used in fs mode
2578
Guillaume GARDET5065b712014-10-15 17:53:13 +02002579 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2580 Filename to read to load U-Boot when reading from filesystem
2581
2582 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002583 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02002584 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002585
Guillaume GARDET5065b712014-10-15 17:53:13 +02002586 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002587 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02002588 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002589
Scott Wood2b36fbb2012-12-06 13:33:17 +00002590 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2591 Set this for NAND SPL on PPC mpc83xx targets, so that
2592 start.S waits for the rest of the SPL to load before
2593 continuing (the hardware starts execution after just
2594 loading the first page rather than the full 4K).
2595
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05302596 CONFIG_SPL_SKIP_RELOCATE
2597 Avoid SPL relocation
2598
Scott Woodc352a0c2012-09-20 19:09:07 -05002599 CONFIG_SPL_NAND_BASE
2600 Include nand_base.c in the SPL. Requires
2601 CONFIG_SPL_NAND_DRIVERS.
2602
2603 CONFIG_SPL_NAND_DRIVERS
2604 SPL uses normal NAND drivers, not minimal drivers.
2605
Jörg Krause6f8190f2018-01-14 19:26:38 +01002606 CONFIG_SPL_NAND_IDENT
2607 SPL uses the chip ID list to identify the NAND flash.
2608 Requires CONFIG_SPL_NAND_BASE.
2609
Scott Woodc352a0c2012-09-20 19:09:07 -05002610 CONFIG_SPL_NAND_ECC
2611 Include standard software ECC in the SPL
2612
Tom Rini36853852012-02-14 07:29:40 +00002613 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002614 Support for NAND boot using simple NAND drivers that
2615 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002616
Thomas Gleixner820d24d2016-07-12 20:28:12 +02002617 CONFIG_SPL_UBI
2618 Support for a lightweight UBI (fastmap) scanner and
2619 loader
2620
Heiko Schochercf000272014-10-31 08:31:00 +01002621 CONFIG_SPL_NAND_RAW_ONLY
2622 Support to boot only raw u-boot.bin images. Use this only
2623 if you need to save space.
2624
Ying Zhangdfb2b152013-08-16 15:16:12 +08002625 CONFIG_SPL_COMMON_INIT_DDR
2626 Set for common ddr init with serial presence detect in
2627 SPL binary.
2628
Tom Rini36853852012-02-14 07:29:40 +00002629 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2630 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2631 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2632 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2633 CONFIG_SYS_NAND_ECCBYTES
2634 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002635 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002636
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05302637 CONFIG_SPL_NAND_BOOT
2638 Add support NAND boot
2639
Tom Rini36853852012-02-14 07:29:40 +00002640 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002641 Location in NAND to read U-Boot from
2642
2643 CONFIG_SYS_NAND_U_BOOT_DST
2644 Location in memory to load U-Boot to
2645
2646 CONFIG_SYS_NAND_U_BOOT_SIZE
2647 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002648
2649 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002650 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002651
2652 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2653 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002654 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00002655
Pavel Machekde997252012-08-30 22:42:11 +02002656 CONFIG_SPL_RAM_DEVICE
2657 Support for running image already present in ram, in SPL binary
2658
Scott Woodeb7bd972012-12-06 13:33:16 +00002659 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002660 Image offset to which the SPL should be padded before appending
2661 the SPL payload. By default, this is defined as
2662 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2663 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2664 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002665
Scott Woodf147eb72012-09-21 16:27:32 -05002666 CONFIG_SPL_TARGET
2667 Final target image containing SPL and payload. Some SPLs
2668 use an arch-specific makefile fragment instead, for
2669 example if more than one image needs to be produced.
2670
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02002671 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00002672 Printing information about a FIT image adds quite a bit of
2673 code to SPL. So this is normally disabled in SPL. Use this
2674 option to re-enable it. This will affect the output of the
2675 bootm command when booting a FIT image.
2676
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002677- TPL framework
2678 CONFIG_TPL
2679 Enable building of TPL globally.
2680
2681 CONFIG_TPL_PAD_TO
2682 Image offset to which the TPL should be padded before appending
2683 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002684 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2685 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2686 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002687
wdenkc0aa5c52003-12-06 19:49:23 +00002688- Interrupt support (PPC):
2689
wdenk1ebf41e2004-01-02 14:00:00 +00002690 There are common interrupt_init() and timer_interrupt()
2691 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002692 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002693 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002694 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002695 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002696 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002697 specific handling. If board has watchdog / status_led
2698 / other_activity_monitor it works automatically from
2699 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002700
wdenkc6097192002-11-03 00:24:07 +00002701
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002702Board initialization settings:
2703------------------------------
2704
2705During Initialization u-boot calls a number of board specific functions
2706to allow the preparation of board specific prerequisites, e.g. pin setup
2707before drivers are initialized. To enable these callbacks the
2708following configuration macros have to be defined. Currently this is
2709architecture specific, so please check arch/your_architecture/lib/board.c
2710typically in board_init_f() and board_init_r().
2711
2712- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2713- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2714- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2715- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002716
wdenkc6097192002-11-03 00:24:07 +00002717Configuration Settings:
2718-----------------------
2719
York Sun6c480012014-02-26 17:03:19 -08002720- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2721 Optionally it can be defined to support 64-bit memory commands.
2722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002723- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002724 undefine this when you're short of memory.
2725
Peter Tyserdfb72b82009-01-27 18:03:12 -06002726- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2727 width of the commands listed in the 'help' command output.
2728
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002729- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002730 prompt for user input.
2731
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002732- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002734- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002736- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002737
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002738- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002739 the application (usually a Linux kernel) when it is
2740 booted
2741
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002742- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002743 List of legal baudrate settings for this board.
2744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002745- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002746 Begin and End addresses of the area used by the
2747 simple memory test.
2748
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002749- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002750 Scratch address used by the alternate memory test
2751 You only need to set this if address zero isn't writeable
2752
York Sun5d286cd2015-12-04 11:57:07 -08002753- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07002754 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08002755 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2756 is substracted from total RAM and won't be reported to OS.
2757 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07002758 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08002759 the RAM base is not zero, or RAM is divided into banks,
2760 this variable needs to be recalcuated to get the address.
2761
York Sun50739372015-12-07 11:05:29 -08002762- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002763 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002764 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002765 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002766 fixing up gd->ram_size the Linux kernel should gets passed
2767 the now "corrected" memory size and won't touch it either.
2768 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002769 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002770 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002771 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002772
2773 This option can be used as a workaround for the 440EPx/GRx
2774 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2775 be touched.
2776
2777 WARNING: Please make sure that this value is a multiple of
2778 the Linux page size (normally 4k). If this is not the case,
2779 then the end address of the Linux memory will be located at a
2780 non page size aligned address and this could cause major
2781 problems.
2782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002783- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002784 Enable temporary baudrate change while serial download
2785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002786- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002787 Physical start address of SDRAM. _Must_ be 0 here.
2788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002789- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002790 Physical start address of Flash memory.
2791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002792- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002793 Physical start address of boot monitor code (set by
2794 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002795 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002796 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002798- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002799 Size of memory reserved for monitor code, used to
2800 determine _at_compile_time_ (!) if the environment is
2801 embedded within the U-Boot image, or in a separate
2802 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002804- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002805 Size of DRAM reserved for malloc() use.
2806
Simon Glass863e4042014-07-10 22:23:28 -06002807- CONFIG_SYS_MALLOC_F_LEN
2808 Size of the malloc() pool for use before relocation. If
2809 this is defined, then a very simple malloc() implementation
2810 will become available before relocation. The address is just
2811 below the global data, and the stack is moved down to make
2812 space.
2813
2814 This feature allocates regions with increasing addresses
2815 within the region. calloc() is supported, but realloc()
2816 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002817 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06002818 U-Boot relocates itself.
2819
Simon Glass9fa901b2014-11-10 17:16:54 -07002820- CONFIG_SYS_MALLOC_SIMPLE
2821 Provides a simple and small malloc() and calloc() for those
2822 boards which do not use the full malloc in SPL (which is
2823 enabled with CONFIG_SYS_SPL_MALLOC_START).
2824
Thierry Redingc97d9742014-12-09 22:25:22 -07002825- CONFIG_SYS_NONCACHED_MEMORY:
2826 Size of non-cached memory area. This area of memory will be
2827 typically located right below the malloc() area and mapped
2828 uncached in the MMU. This is useful for drivers that would
2829 otherwise require a lot of explicit cache maintenance. For
2830 some drivers it's also impossible to properly maintain the
2831 cache. For example if the regions that need to be flushed
2832 are not a multiple of the cache-line size, *and* padding
2833 cannot be allocated between the regions to align them (i.e.
2834 if the HW requires a contiguous array of regions, and the
2835 size of each region is not cache-aligned), then a flush of
2836 one region may result in overwriting data that hardware has
2837 written to another region in the same cache-line. This can
2838 happen for example in network drivers where descriptors for
2839 buffers are typically smaller than the CPU cache-line (e.g.
2840 16 bytes vs. 32 or 64 bytes).
2841
2842 Non-cached memory is only supported on 32-bit ARM at present.
2843
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002844- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002845 Normally compressed uImages are limited to an
2846 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002847 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002848 to adjust this setting to your needs.
2849
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002850- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002851 Maximum size of memory mapped by the startup code of
2852 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002853 the Linux kernel (bd_info, boot arguments, FDT blob if
2854 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002855 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002856 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002857 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002858 variable "bootm_mapsize" will override the value of
2859 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2860 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002861
John Rigbyeea8e692010-10-13 13:57:35 -06002862- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2863 Enable initrd_high functionality. If defined then the
2864 initrd_high feature is enabled and the bootm ramdisk subcommand
2865 is enabled.
2866
2867- CONFIG_SYS_BOOT_GET_CMDLINE:
2868 Enables allocating and saving kernel cmdline in space between
2869 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2870
2871- CONFIG_SYS_BOOT_GET_KBD:
2872 Enables allocating and saving a kernel copy of the bd_info in
2873 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2874
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002875- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002876 Max number of Flash memory banks
2877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002878- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002879 Max number of sectors on a Flash chip
2880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002881- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002882 Timeout for Flash erase operations (in ms)
2883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002884- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002885 Timeout for Flash write operations (in ms)
2886
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002887- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002888 Timeout for Flash set sector lock bit operation (in ms)
2889
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002890- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002891 Timeout for Flash clear lock bits operation (in ms)
2892
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002893- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002894 If defined, hardware flash sectors protection is used
2895 instead of U-Boot software protection.
2896
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002897- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002898
2899 Enable TFTP transfers directly to flash memory;
2900 without this option such a download has to be
2901 performed in two steps: (1) download to RAM, and (2)
2902 copy from RAM to flash.
2903
2904 The two-step approach is usually more reliable, since
2905 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002906 the flash, but in some situations (when system RAM is
2907 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002908 downloaded image) this option may be very useful.
2909
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002910- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002911 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002912 common flash structure for storing flash geometry.
2913
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002914- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002915 This option also enables the building of the cfi_flash driver
2916 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002917
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002918- CONFIG_FLASH_CFI_MTD
2919 This option enables the building of the cfi_mtd driver
2920 in the drivers directory. The driver exports CFI flash
2921 to the MTD layer.
2922
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002923- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002924 Use buffered writes to flash.
2925
2926- CONFIG_FLASH_SPANSION_S29WS_N
2927 s29ws-n MirrorBit flash has non-standard addresses for buffered
2928 write commands.
2929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002930- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002931 If this option is defined, the common CFI flash doesn't
2932 print it's warning upon not recognized FLASH banks. This
2933 is useful, if some of the configured banks are only
2934 optionally available.
2935
Jerry Van Barenaae73572008-03-08 13:48:01 -05002936- CONFIG_FLASH_SHOW_PROGRESS
2937 If defined (must be an integer), print out countdown
2938 digits and dots. Recommended value: 45 (9..1) for 80
2939 column displays, 15 (3..1) for 40 column displays.
2940
Stefan Roesed20cba52013-04-04 15:53:14 +02002941- CONFIG_FLASH_VERIFY
2942 If defined, the content of the flash (destination) is compared
2943 against the source after the write operation. An error message
2944 will be printed when the contents are not identical.
2945 Please note that this option is useless in nearly all cases,
2946 since such flash programming errors usually are detected earlier
2947 while unprotecting/erasing/programming. Please only enable
2948 this option if you really know what you are doing.
2949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002950- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002951 Defines the number of Ethernet receive buffers. On some
2952 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002953 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2954 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002955 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002956 Defaults to 4 if not defined.
2957
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002958- CONFIG_ENV_MAX_ENTRIES
2959
Wolfgang Denk1136f692010-10-27 22:48:30 +02002960 Maximum number of entries in the hash table that is used
2961 internally to store the environment settings. The default
2962 setting is supposed to be generous and should work in most
2963 cases. This setting can be used to tune behaviour; see
2964 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002965
Joe Hershberger71497d02012-12-11 22:16:31 -06002966- CONFIG_ENV_FLAGS_LIST_DEFAULT
2967- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002968 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002969 calling env set. Variables can be restricted to only decimal,
2970 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2971 the variables can also be restricted to IP address or MAC address.
2972
2973 The format of the list is:
2974 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002975 access_attribute = [a|r|o|c]
2976 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002977 entry = variable_name[:attributes]
2978 list = entry[,list]
2979
2980 The type attributes are:
2981 s - String (default)
2982 d - Decimal
2983 x - Hexadecimal
2984 b - Boolean ([1yYtT|0nNfF])
2985 i - IP address
2986 m - MAC address
2987
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002988 The access attributes are:
2989 a - Any (default)
2990 r - Read-only
2991 o - Write-once
2992 c - Change-default
2993
Joe Hershberger71497d02012-12-11 22:16:31 -06002994 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2995 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002996 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002997
2998 - CONFIG_ENV_FLAGS_LIST_STATIC
2999 Define this to a list (string) to define validation that
3000 should be done if an entry is not found in the ".flags"
3001 environment variable. To override a setting in the static
3002 list, simply add an entry for the same variable name to the
3003 ".flags" variable.
3004
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003005 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3006 regular expression. This allows multiple variables to define the same
3007 flags without explicitly listing them for each variable.
3008
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003009- CONFIG_ENV_ACCESS_IGNORE_FORCE
3010 If defined, don't allow the -f switch to env set override variable
3011 access flags.
3012
wdenkc6097192002-11-03 00:24:07 +00003013The following definitions that deal with the placement and management
3014of environment data (variable area); in general, we support the
3015following configurations:
3016
Mike Frysinger63b8f122011-07-08 10:44:25 +00003017- CONFIG_BUILD_ENVCRC:
3018
3019 Builds up envcrc with the target environment so that external utils
3020 may easily extract it and embed it in final U-Boot images.
3021
wdenkc6097192002-11-03 00:24:07 +00003022BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003023in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003024console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003025U-Boot will hang.
3026
3027Please note that even with NVRAM we still use a copy of the
3028environment in RAM: we could work on NVRAM directly, but we want to
3029keep settings there always unmodified except somebody uses "saveenv"
3030to save the current settings.
3031
Liu Gang85bcd732012-03-08 00:33:20 +00003032BE CAREFUL! For some special cases, the local device can not use
3033"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003034environment stored in a remote NOR flash by SRIO or PCIE link,
3035but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003036
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003037- CONFIG_NAND_ENV_DST
3038
3039 Defines address in RAM to which the nand_spl code should copy the
3040 environment. If redundant environment is used, it will be copied to
3041 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3042
Bruce Adleredecc942007-11-02 13:15:42 -07003043Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003044has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06003045created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003046until then to read environment variables.
3047
wdenk8dba0502003-03-31 16:34:49 +00003048The environment is protected by a CRC32 checksum. Before the monitor
3049is relocated into RAM, as a result of a bad CRC you will be working
3050with the compiled-in default environment - *silently*!!! [This is
3051necessary, because the first environment variable we need is the
3052"baudrate" setting for the console - if we have a bad CRC, we don't
3053have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003054
3055Note: once the monitor has been relocated, then it will complain if
3056the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003057use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003059- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003060 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003062 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003063 also needs to be defined.
3064
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003065- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003066 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003067
Ron Madriddfa028a2009-02-18 14:30:44 -08003068- CONFIG_NS16550_MIN_FUNCTIONS:
3069 Define this if you desire to only have use of the NS16550_init
3070 and NS16550_putc functions for the serial driver located at
3071 drivers/serial/ns16550.c. This option is useful for saving
3072 space for already greatly restricted images, including but not
3073 limited to NAND_SPL configurations.
3074
Simon Glass28a9e332012-11-30 13:01:18 +00003075- CONFIG_DISPLAY_BOARDINFO
3076 Display information about the board that U-Boot is running on
3077 when U-Boot starts up. The board function checkboard() is called
3078 to do this.
3079
Simon Glasse8822012012-11-30 13:01:19 +00003080- CONFIG_DISPLAY_BOARDINFO_LATE
3081 Similar to the previous option, but display this information
3082 later, once stdio is running and output goes to the LCD, if
3083 present.
3084
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003085- CONFIG_BOARD_SIZE_LIMIT:
3086 Maximum size of the U-Boot image. When defined, the
3087 build system checks that the actual size does not
3088 exceed it.
3089
wdenkc6097192002-11-03 00:24:07 +00003090Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003091---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003094 Cache Line Size of the CPU.
3095
Timur Tabid8f341c2011-08-04 18:03:41 -05003096- CONFIG_SYS_CCSRBAR_DEFAULT:
3097 Default (power-on reset) physical address of CCSR on Freescale
3098 PowerPC SOCs.
3099
3100- CONFIG_SYS_CCSRBAR:
3101 Virtual address of CCSR. On a 32-bit build, this is typically
3102 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3103
Timur Tabid8f341c2011-08-04 18:03:41 -05003104- CONFIG_SYS_CCSRBAR_PHYS:
3105 Physical address of CCSR. CCSR can be relocated to a new
3106 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003107 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003108 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3109 is typically relocated on 36-bit builds. It is recommended
3110 that this macro be defined via the _HIGH and _LOW macros:
3111
3112 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3113 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3114
3115- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003116 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3117 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003118 used in assembly code, so it must not contain typecasts or
3119 integer size suffixes (e.g. "ULL").
3120
3121- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3122 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3123 used in assembly code, so it must not contain typecasts or
3124 integer size suffixes (e.g. "ULL").
3125
3126- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3127 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3128 forced to a value that ensures that CCSR is not relocated.
3129
wdenk1272e232002-11-10 22:06:23 +00003130- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003131 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003132
3133 the default drive number (default value 0)
3134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003135 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003136
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003137 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003138 (default value 1)
3139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003140 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003141
wdenk4a5c8a72003-03-06 00:02:04 +00003142 defines the offset of register from address. It
3143 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003144 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003146 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3147 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003148 default value.
wdenk1272e232002-11-10 22:06:23 +00003149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003150 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003151 fdc_hw_init() is called at the beginning of the FDC
3152 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003153 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00003154 initializations.
wdenk1272e232002-11-10 22:06:23 +00003155
Macpaul Lind1e49942011-04-11 20:45:32 +00003156- CONFIG_IDE_AHB:
3157 Most IDE controllers were designed to be connected with PCI
3158 interface. Only few of them were designed for AHB interface.
3159 When software is doing ATA command and data transfer to
3160 IDE devices through IDE-AHB controller, some additional
3161 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003162 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00003163
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003164- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003165 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02003166 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003167
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003168- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003169
wdenkeb20ad32003-09-05 23:19:14 +00003170 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003171 initial data and stack; please note that this must be
3172 writable memory that is working WITHOUT special
3173 initialization, i. e. you CANNOT use normal RAM which
3174 will become available only after programming the
3175 memory controller and running certain initialization
3176 sequences.
3177
3178 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02003179 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003181- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003182
3183 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003184 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3185 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003186 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003187 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06003188 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003189 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3190 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003191
3192 Note:
3193 On the MPC824X (or other systems that use the data
3194 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003195 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003196 point to an otherwise UNUSED address space between
3197 the top of RAM and the start of the PCI space.
3198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003199- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003201- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003202 SDRAM timing
3203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003204- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003205 periodic timer for refresh
3206
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003207- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3208 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3209 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3210 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003211 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3212
3213- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003214 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3215 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003216 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3217
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003218- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003219 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003220 Don't do any setup work, presumably because someone or
3221 something has already done it, and we don't need to do it
3222 a second time. Useful for platforms that are pre-booted
3223 by coreboot or similar.
3224
Gabor Juhosb4458732013-05-30 07:06:12 +00003225- CONFIG_PCI_INDIRECT_BRIDGE:
3226 Enable support for indirect PCI bridges.
3227
Kumar Gala8975d7a2010-12-30 12:09:53 -06003228- CONFIG_SYS_SRIO:
3229 Chip has SRIO or not
3230
3231- CONFIG_SRIO1:
3232 Board has SRIO 1 port available
3233
3234- CONFIG_SRIO2:
3235 Board has SRIO 2 port available
3236
Liu Gang27afb9c2013-05-07 16:30:46 +08003237- CONFIG_SRIO_PCIE_BOOT_MASTER
3238 Board can support master function for Boot from SRIO and PCIE
3239
Kumar Gala8975d7a2010-12-30 12:09:53 -06003240- CONFIG_SYS_SRIOn_MEM_VIRT:
3241 Virtual Address of SRIO port 'n' memory region
3242
3243- CONFIG_SYS_SRIOn_MEM_PHYS:
3244 Physical Address of SRIO port 'n' memory region
3245
3246- CONFIG_SYS_SRIOn_MEM_SIZE:
3247 Size of SRIO port 'n' memory region
3248
Fabio Estevamf17e8782013-04-11 09:35:34 +00003249- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3250 Defined to tell the NAND controller that the NAND chip is using
3251 a 16 bit bus.
3252 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003253 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003254 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003255 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003256
3257- CONFIG_SYS_NDFC_EBC0_CFG
3258 Sets the EBC0_CFG register for the NDFC. If not defined
3259 a default value will be used.
3260
Ben Warren45657152006-09-07 16:50:54 -04003261- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003262 Get DDR timing information from an I2C EEPROM. Common
3263 with pluggable memory modules such as SODIMMs
3264
Ben Warren45657152006-09-07 16:50:54 -04003265 SPD_EEPROM_ADDRESS
3266 I2C address of the SPD EEPROM
3267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003268- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003269 If SPD EEPROM is on an I2C bus other than the first
3270 one, specify here. Note that the value must resolve
3271 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003272
York Sune73cc042011-06-07 09:42:16 +08003273- CONFIG_SYS_DDR_RAW_TIMING
3274 Get DDR timing information from other than SPD. Common with
3275 soldered DDR chips onboard without SPD. DDR raw timing
3276 parameters are extracted from datasheet and hard-coded into
3277 header files or board specific files.
3278
York Sunbd495cf2011-09-16 13:21:35 -07003279- CONFIG_FSL_DDR_INTERACTIVE
3280 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3281
York Sun8ced0502015-01-06 13:18:55 -08003282- CONFIG_FSL_DDR_SYNC_REFRESH
3283 Enable sync of refresh for multiple controllers.
3284
York Sunb6a35f82015-03-19 09:30:28 -07003285- CONFIG_FSL_DDR_BIST
3286 Enable built-in memory test for Freescale DDR controllers.
3287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003288- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003289 Only for 83xx systems. If specified, then DDR should
3290 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003291
wdenk6203e402004-04-18 10:13:26 +00003292- CONFIG_RMII
3293 Enable RMII mode for all FECs.
3294 Note that this is a global option, we can't
3295 have one FEC in standard MII mode and another in RMII mode.
3296
wdenk20c98a62004-04-23 20:32:05 +00003297- CONFIG_CRC32_VERIFY
3298 Add a verify option to the crc32 command.
3299 The syntax is:
3300
3301 => crc32 -v <address> <count> <crc32>
3302
3303 Where address/count indicate a memory area
3304 and crc32 is the correct crc32 which the
3305 area should have.
3306
wdenk64519362004-07-11 17:40:54 +00003307- CONFIG_LOOPW
3308 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06003309 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00003310
stroesecc3af832004-12-16 18:46:55 +00003311- CONFIG_MX_CYCLIC
3312 Add the "mdc" and "mwc" memory commands. These are cyclic
3313 "md/mw" commands.
3314 Examples:
3315
wdenk07d7e6b2004-12-16 21:44:03 +00003316 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003317 This command will print 4 bytes (10,11,12,13) each 500 ms.
3318
wdenk07d7e6b2004-12-16 21:44:03 +00003319 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003320 This command will write 12345678 to address 100 all 10 ms.
3321
wdenk07d7e6b2004-12-16 21:44:03 +00003322 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06003323 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00003324
wdenk3d3d99f2005-04-04 12:44:11 +00003325- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chend7e6f922017-12-26 13:55:59 +08003326 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003327 low level initializations (like setting up the memory
3328 controller) are omitted and/or U-Boot does not
3329 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003330
Wolfgang Denk302141d2010-11-27 23:30:56 +01003331 Normally this variable MUST NOT be defined. The only
3332 exception is when U-Boot is loaded (to RAM) by some
3333 other boot loader or by a debugger which performs
3334 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003335
Simon Glass90844072016-05-05 07:28:06 -06003336- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3337 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09003338 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06003339 instruction cache) is still performed.
3340
Aneesh V552a3192011-07-13 05:11:07 +00003341- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003342 Modifies the behaviour of start.S when compiling a loader
3343 that is executed before the actual U-Boot. E.g. when
3344 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003345
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003346- CONFIG_TPL_BUILD
3347 Modifies the behaviour of start.S when compiling a loader
3348 that is executed after the SPL and before the actual U-Boot.
3349 It is loaded by the SPL.
3350
Ying Zhang0d4f5442013-05-20 14:07:23 +08003351- CONFIG_SYS_MPC85XX_NO_RESETVEC
3352 Only for 85xx systems. If this variable is specified, the section
3353 .resetvec is not kept and the section .bootpg is placed in the
3354 previous 4k of the .text section.
3355
Simon Glass17dabf02013-02-24 17:33:14 +00003356- CONFIG_ARCH_MAP_SYSMEM
3357 Generally U-Boot (and in particular the md command) uses
3358 effective address. It is therefore not necessary to regard
3359 U-Boot address as virtual addresses that need to be translated
3360 to physical addresses. However, sandbox requires this, since
3361 it maintains its own little RAM buffer which contains all
3362 addressable memory. This option causes some memory accesses
3363 to be mapped through map_sysmem() / unmap_sysmem().
3364
Simon Glassbfb59802013-02-14 04:18:54 +00003365- CONFIG_X86_RESET_VECTOR
3366 If defined, the x86 reset vector code is included. This is not
3367 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003368
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04003369- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3370 Option to disable subpage write in NAND driver
3371 driver that uses this:
3372 drivers/mtd/nand/davinci_nand.c
3373
Timur Tabi275f4bb2011-11-22 09:21:25 -06003374Freescale QE/FMAN Firmware Support:
3375-----------------------------------
3376
3377The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3378loading of "firmware", which is encoded in the QE firmware binary format.
3379This firmware often needs to be loaded during U-Boot booting, so macros
3380are used to identify the storage device (NOR flash, SPI, etc) and the address
3381within that device.
3382
Zhao Qiang83a90842014-03-21 16:21:44 +08003383- CONFIG_SYS_FMAN_FW_ADDR
3384 The address in the storage device where the FMAN microcode is located. The
3385 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3386 is also specified.
3387
3388- CONFIG_SYS_QE_FW_ADDR
3389 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06003390 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3391 is also specified.
3392
3393- CONFIG_SYS_QE_FMAN_FW_LENGTH
3394 The maximum possible size of the firmware. The firmware binary format
3395 has a field that specifies the actual size of the firmware, but it
3396 might not be possible to read any part of the firmware unless some
3397 local storage is allocated to hold the entire firmware first.
3398
3399- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3400 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3401 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3402 virtual address in NOR flash.
3403
3404- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3405 Specifies that QE/FMAN firmware is located in NAND flash.
3406 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3407
3408- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3409 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3410 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3411
Liu Gang1e084582012-03-08 00:33:18 +00003412- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3413 Specifies that QE/FMAN firmware is located in the remote (master)
3414 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003415 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3416 window->master inbound window->master LAW->the ucode address in
3417 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003418
J. German Rivera8ff14b72014-06-23 15:15:55 -07003419Freescale Layerscape Management Complex Firmware Support:
3420---------------------------------------------------------
3421The Freescale Layerscape Management Complex (MC) supports the loading of
3422"firmware".
3423This firmware often needs to be loaded during U-Boot booting, so macros
3424are used to identify the storage device (NOR flash, SPI, etc) and the address
3425within that device.
3426
3427- CONFIG_FSL_MC_ENET
3428 Enable the MC driver for Layerscape SoCs.
3429
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303430Freescale Layerscape Debug Server Support:
3431-------------------------------------------
3432The Freescale Layerscape Debug Server Support supports the loading of
3433"Debug Server firmware" and triggering SP boot-rom.
3434This firmware often needs to be loaded during U-Boot booting.
3435
York Sun928b6812015-12-07 11:08:58 -08003436- CONFIG_SYS_MC_RSV_MEM_ALIGN
3437 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05303438
Paul Kocialkowski7b917022015-07-26 18:48:15 +02003439Reproducible builds
3440-------------------
3441
3442In order to achieve reproducible builds, timestamps used in the U-Boot build
3443process have to be set to a fixed value.
3444
3445This is done using the SOURCE_DATE_EPOCH environment variable.
3446SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3447option for U-Boot or an environment variable in U-Boot.
3448
3449SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3450
wdenkc6097192002-11-03 00:24:07 +00003451Building the Software:
3452======================
3453
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003454Building U-Boot has been tested in several native build environments
3455and in many different cross environments. Of course we cannot support
3456all possibly existing versions of cross development tools in all
3457(potentially obsolete) versions. In case of tool chain problems we
3458recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3459which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003460
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003461If you are not using a native environment, it is assumed that you
3462have GNU cross compiling tools available in your path. In this case,
3463you must set the environment variable CROSS_COMPILE in your shell.
3464Note that no changes to the Makefile or any other source files are
3465necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003466
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003467 $ CROSS_COMPILE=ppc_4xx-
3468 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003469
Peter Tyserb06976d2009-03-13 18:54:51 -05003470Note: If you wish to generate Windows versions of the utilities in
3471 the tools directory you can use the MinGW toolchain
3472 (http://www.mingw.org). Set your HOST tools to the MinGW
3473 toolchain and execute 'make tools'. For example:
3474
3475 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3476
3477 Binaries such as tools/mkimage.exe will be created which can
3478 be executed on computers running Windows.
3479
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003480U-Boot is intended to be simple to build. After installing the
3481sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003482is done by typing:
3483
Holger Freyther7ba4e572014-08-04 09:26:05 +02003484 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003485
Holger Freyther7ba4e572014-08-04 09:26:05 +02003486where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003487rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003488
wdenk6c59edc2004-05-03 20:45:30 +00003489Note: for some board special configuration names may exist; check if
3490 additional information is available from the board vendor; for
3491 instance, the TQM823L systems are available without (standard)
3492 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003493 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003494
Holger Freyther7ba4e572014-08-04 09:26:05 +02003495 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003496 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003497
Holger Freyther7ba4e572014-08-04 09:26:05 +02003498 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00003499 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk6c59edc2004-05-03 20:45:30 +00003501 etc.
wdenkc6097192002-11-03 00:24:07 +00003502
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk6c59edc2004-05-03 20:45:30 +00003504Finally, type "make all", and you should get some working U-Boot
3505images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003506
wdenk6c59edc2004-05-03 20:45:30 +00003507- "u-boot.bin" is a raw binary image
3508- "u-boot" is an image in ELF binary format
3509- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003510
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003511By default the build is performed locally and the objects are saved
3512in the source directory. One of the two methods can be used to change
3513this behavior and build U-Boot to some external directory:
3514
35151. Add O= to the make command line invocations:
3516
3517 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003518 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003519 make O=/tmp/build all
3520
Timo Ketolac8c67602014-11-06 14:39:05 +020035212. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003522
Timo Ketolac8c67602014-11-06 14:39:05 +02003523 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003524 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02003525 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003526 make all
3527
Timo Ketolac8c67602014-11-06 14:39:05 +02003528Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003529variable.
3530
Daniel Schwierzeck88484422018-01-26 16:31:04 +01003531User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3532setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3533For example to treat all compiler warnings as errors:
3534
3535 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk6c59edc2004-05-03 20:45:30 +00003537Please be aware that the Makefiles assume you are using GNU make, so
3538for instance on NetBSD you might need to use "gmake" instead of
3539native "make".
wdenkc6097192002-11-03 00:24:07 +00003540
wdenkc6097192002-11-03 00:24:07 +00003541
wdenk6c59edc2004-05-03 20:45:30 +00003542If the system board that you have is not listed, then you will need
3543to port U-Boot to your hardware platform. To do this, follow these
3544steps:
wdenkc6097192002-11-03 00:24:07 +00003545
Phil Sutterc77b4882015-12-25 14:41:18 +010035461. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00003547 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01003548 the "Makefile" and a "<board>.c".
35492. Create a new configuration file "include/configs/<board>.h" for
3550 your board.
wdenk6c59edc2004-05-03 20:45:30 +000035513. If you're porting U-Boot to a new CPU, then also create a new
3552 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020035534. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000035545. Type "make", and you should get a working "u-boot.srec" file
3555 to be installed on your target system.
35566. Debug and solve any problems that might arise.
3557 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003558
wdenkc6097192002-11-03 00:24:07 +00003559
wdenk6c59edc2004-05-03 20:45:30 +00003560Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3561==============================================================
wdenkc6097192002-11-03 00:24:07 +00003562
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003563If you have modified U-Boot sources (for instance added a new board
3564or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003565provide feedback to the other developers. The feedback normally takes
3566the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003567official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003568
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003569But before you submit such a patch, please verify that your modifi-
3570cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003571the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06003572just run the buildman script (tools/buildman/buildman), which will
3573configure and build U-Boot for ALL supported system. Be warned, this
3574will take a while. Please see the buildman README, or run 'buildman -H'
3575for documentation.
wdenkc6097192002-11-03 00:24:07 +00003576
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003577
wdenk6c59edc2004-05-03 20:45:30 +00003578See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003579
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk6c59edc2004-05-03 20:45:30 +00003581Monitor Commands - Overview:
3582============================
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584go - start application at address 'addr'
3585run - run commands in an environment variable
3586bootm - boot application image from memory
3587bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003588bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003589tftpboot- boot image via network using TFTP protocol
3590 and env variables "ipaddr" and "serverip"
3591 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003592tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003593rarpboot- boot image via network using RARP/TFTP protocol
3594diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3595loads - load S-Record file over serial line
3596loadb - load binary file over serial line (kermit mode)
3597md - memory display
3598mm - memory modify (auto-incrementing)
3599nm - memory modify (constant address)
3600mw - memory write (fill)
3601cp - memory copy
3602cmp - memory compare
3603crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003604i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003605sspi - SPI utility commands
3606base - print or set address offset
3607printenv- print environment variables
3608setenv - set environment variables
3609saveenv - save environment variables to persistent storage
3610protect - enable or disable FLASH write protection
3611erase - erase FLASH memory
3612flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00003613nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00003614bdinfo - print Board Info structure
3615iminfo - print header information for application image
3616coninfo - print console devices and informations
3617ide - IDE sub-system
3618loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003619loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003620mtest - simple RAM test
3621icache - enable or disable instruction cache
3622dcache - enable or disable data cache
3623reset - Perform RESET of the CPU
3624echo - echo args to console
3625version - print monitor version
3626help - print online help
3627? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003628
wdenkc6097192002-11-03 00:24:07 +00003629
wdenk6c59edc2004-05-03 20:45:30 +00003630Monitor Commands - Detailed Description:
3631========================================
wdenkc6097192002-11-03 00:24:07 +00003632
wdenk6c59edc2004-05-03 20:45:30 +00003633TODO.
wdenkc6097192002-11-03 00:24:07 +00003634
wdenk6c59edc2004-05-03 20:45:30 +00003635For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003636
3637
wdenk6c59edc2004-05-03 20:45:30 +00003638Environment Variables:
3639======================
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk6c59edc2004-05-03 20:45:30 +00003641U-Boot supports user configuration using Environment Variables which
3642can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003643
wdenk6c59edc2004-05-03 20:45:30 +00003644Environment Variables are set using "setenv", printed using
3645"printenv", and saved to Flash using "saveenv". Using "setenv"
3646without a value can be used to delete a variable from the
3647environment. As long as you don't save the environment you are
3648working with an in-memory copy. In case the Flash area containing the
3649environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003650
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003651Some configuration options can be set using Environment Variables.
3652
3653List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003654
wdenk6c59edc2004-05-03 20:45:30 +00003655 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk6c59edc2004-05-03 20:45:30 +00003657 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk6c59edc2004-05-03 20:45:30 +00003659 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003660
wdenk6c59edc2004-05-03 20:45:30 +00003661 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003662
wdenk6c59edc2004-05-03 20:45:30 +00003663 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003664
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003665 bootm_low - Memory range available for image processing in the bootm
3666 command can be restricted. This variable is given as
3667 a hexadecimal number and defines lowest address allowed
3668 for use by the bootm command. See also "bootm_size"
3669 environment variable. Address defined by "bootm_low" is
3670 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003671 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3672 bootm_mapsize.
3673
Wolfgang Denk092ae952011-10-26 10:21:21 +00003674 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003675 This variable is given as a hexadecimal number and it
3676 defines the size of the memory region starting at base
3677 address bootm_low that is accessible by the Linux kernel
3678 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3679 as the default value if it is defined, and bootm_size is
3680 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003681
3682 bootm_size - Memory range available for image processing in the bootm
3683 command can be restricted. This variable is given as
3684 a hexadecimal number and defines the size of the region
3685 allowed for use by the bootm command. See also "bootm_low"
3686 environment variable.
3687
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003688 updatefile - Location of the software update file on a TFTP server, used
3689 by the automatic software update feature. Please refer to
3690 documentation in doc/README.update for more details.
3691
wdenk6c59edc2004-05-03 20:45:30 +00003692 autoload - if set to "no" (any string beginning with 'n'),
3693 "bootp" will just load perform a lookup of the
3694 configuration from the BOOTP server, but not try to
3695 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk6c59edc2004-05-03 20:45:30 +00003697 autostart - if set to "yes", an image loaded using the "bootp",
3698 "rarpboot", "tftpboot" or "diskboot" commands will
3699 be automatically started (by internally calling
3700 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003701
wdenk6c59edc2004-05-03 20:45:30 +00003702 If set to "no", a standalone image passed to the
3703 "bootm" command will be copied to the load address
3704 (and eventually uncompressed), but NOT be started.
3705 This can be used to load and uncompress arbitrary
3706 data.
wdenkc6097192002-11-03 00:24:07 +00003707
David A. Longd558a4e2011-07-09 16:40:19 -04003708 fdt_high - if set this restricts the maximum address that the
3709 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00003710 For example, if you have a system with 1 GB memory
3711 at physical address 0x10000000, while Linux kernel
3712 only recognizes the first 704 MB as low memory, you
3713 may need to set fdt_high as 0x3C000000 to have the
3714 device tree blob be copied to the maximum address
3715 of the 704 MB low memory, so that Linux kernel can
3716 access it during the boot procedure.
3717
David A. Longd558a4e2011-07-09 16:40:19 -04003718 If this is set to the special value 0xFFFFFFFF then
3719 the fdt will not be copied at all on boot. For this
3720 to work it must reside in writable memory, have
3721 sufficient padding on the end of it for u-boot to
3722 add the information it needs into it, and the memory
3723 must be accessible by the kernel.
3724
Simon Glassdc6fa642011-10-24 19:15:34 +00003725 fdtcontroladdr- if set this is the address of the control flattened
3726 device tree used by U-Boot when CONFIG_OF_CONTROL is
3727 defined.
3728
wdenk0e2bd9c2004-06-06 21:51:03 +00003729 i2cfast - (PPC405GP|PPC405EP only)
3730 if set to 'y' configures Linux I2C driver for fast
3731 mode (400kHZ). This environment variable is used in
3732 initialization code. So, for changes to be effective
3733 it must be saved and board must be reset.
3734
wdenk6c59edc2004-05-03 20:45:30 +00003735 initrd_high - restrict positioning of initrd images:
3736 If this variable is not set, initrd images will be
3737 copied to the highest possible address in RAM; this
3738 is usually what you want since it allows for
3739 maximum initrd size. If for some reason you want to
3740 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003741 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003742 variable to a value of "no" or "off" or "0".
3743 Alternatively, you can set it to a maximum upper
3744 address to use (U-Boot will still check that it
3745 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk6c59edc2004-05-03 20:45:30 +00003747 For instance, when you have a system with 16 MB
3748 RAM, and want to reserve 4 MB from use by Linux,
3749 you can do this by adding "mem=12M" to the value of
3750 the "bootargs" variable. However, now you must make
3751 sure that the initrd image is placed in the first
3752 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk6c59edc2004-05-03 20:45:30 +00003754 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk6c59edc2004-05-03 20:45:30 +00003756 If you set initrd_high to 0xFFFFFFFF, this is an
3757 indication to U-Boot that all addresses are legal
3758 for the Linux kernel, including addresses in flash
3759 memory. In this case U-Boot will NOT COPY the
3760 ramdisk at all. This may be useful to reduce the
3761 boot time on your system, but requires that this
3762 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003763
wdenk6c59edc2004-05-03 20:45:30 +00003764 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk6c59edc2004-05-03 20:45:30 +00003766 loadaddr - Default load address for commands like "bootp",
3767 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003770
wdenk6c59edc2004-05-03 20:45:30 +00003771 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003772
wdenk6c59edc2004-05-03 20:45:30 +00003773 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003774
wdenk6c59edc2004-05-03 20:45:30 +00003775 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk6c59edc2004-05-03 20:45:30 +00003777 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003778
Mike Frysingera23230c2011-10-02 10:01:27 +00003779 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003780
Mike Frysingera23230c2011-10-02 10:01:27 +00003781 ethact - controls which interface is currently active.
3782 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003783
Heiko Schocherc5e84052010-07-20 17:45:02 +02003784 => setenv ethact FEC
3785 => ping 192.168.0.1 # traffic sent on FEC
3786 => setenv ethact SCC
3787 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003788
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003789 ethrotate - When set to "no" U-Boot does not go through all
3790 available network interfaces.
3791 It just stays at the currently selected interface.
3792
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003793 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003794 either succeed or fail without retrying.
3795 When set to "once" the network operation will
3796 fail when all the available network interfaces
3797 are tried once without success.
3798 Useful on scripts which control the retry operation
3799 themselves.
wdenkc6097192002-11-03 00:24:07 +00003800
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003801 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003802
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003803 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07003804 changing the console to be empty. If "yes" it will be
3805 made silent. If "no" it will not be made silent. If
3806 unset, then it will be made silent if the U-Boot console
3807 is silent.
3808
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003809 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003810 UDP source port.
3811
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003812 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02003813 destination port instead of the Well Know Port 69.
3814
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003815 tftpblocksize - Block size to use for TFTP transfers; if not set,
3816 we use the TFTP server's default block size
3817
3818 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3819 seconds, minimum value is 1000 = 1 second). Defines
3820 when a packet is considered to be lost so it has to
3821 be retransmitted. The default is 5000 = 5 seconds.
3822 Lowering this value may make downloads succeed
3823 faster in networks with high packet loss rates or
3824 with unreliable TFTP servers.
3825
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02003826 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3827 unit, minimum value = 0). Defines how many timeouts
3828 can happen during a single file transfer before that
3829 transfer is aborted. The default is 10, and 0 means
3830 'no timeouts allowed'. Increasing this value may help
3831 downloads succeed with high packet loss rates, or with
3832 unreliable TFTP servers or client hardware.
3833
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003834 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003835 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003836 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003837
Alexandre Messier15971322016-02-01 17:08:57 -05003838 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3839 Unsigned value, in milliseconds. If not set, the period will
3840 be either the default (28000), or a value based on
3841 CONFIG_NET_RETRY_COUNT, if defined. This value has
3842 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3843
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003844The following image location variables contain the location of images
3845used in booting. The "Image" column gives the role of the image and is
3846not an environment variable name. The other columns are environment
3847variable names. "File Name" gives the name of the file on a TFTP
3848server, "RAM Address" gives the location in RAM the image will be
3849loaded to, and "Flash Location" gives the image's address in NOR
3850flash or offset in NAND flash.
3851
3852*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03003853boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003854boards use these variables for other purposes.
3855
Wolfgang Denk092ae952011-10-26 10:21:21 +00003856Image File Name RAM Address Flash Location
3857----- --------- ----------- --------------
3858u-boot u-boot u-boot_addr_r u-boot_addr
3859Linux kernel bootfile kernel_addr_r kernel_addr
3860device tree blob fdtfile fdt_addr_r fdt_addr
3861ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003862
wdenk6c59edc2004-05-03 20:45:30 +00003863The following environment variables may be used and automatically
3864updated by the network boot commands ("bootp" and "rarpboot"),
3865depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003866
wdenk6c59edc2004-05-03 20:45:30 +00003867 bootfile - see above
3868 dnsip - IP address of your Domain Name Server
3869 dnsip2 - IP address of your secondary Domain Name Server
3870 gatewayip - IP address of the Gateway (Router) to use
3871 hostname - Target hostname
3872 ipaddr - see above
3873 netmask - Subnet Mask
3874 rootpath - Pathname of the root filesystem on the NFS server
3875 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003876
wdenk145d2c12004-04-15 21:48:45 +00003877
wdenk6c59edc2004-05-03 20:45:30 +00003878There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003879
wdenk6c59edc2004-05-03 20:45:30 +00003880 serial# - contains hardware identification information such
3881 as type string and/or serial number
3882 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk6c59edc2004-05-03 20:45:30 +00003884These variables can be set only once (usually during manufacturing of
3885the board). U-Boot refuses to delete or overwrite these variables
3886once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003887
3888
wdenk6c59edc2004-05-03 20:45:30 +00003889Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk6c59edc2004-05-03 20:45:30 +00003891 ver - Contains the U-Boot version string as printed
3892 with the "version" command. This variable is
3893 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003894
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk6c59edc2004-05-03 20:45:30 +00003896Please note that changes to some configuration parameters may take
3897only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003898
stroeseb9c17c52003-04-04 15:53:41 +00003899
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003900Callback functions for environment variables:
3901---------------------------------------------
3902
3903For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003904when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003905be associated with arbitrary variables. On creation, overwrite, or
3906deletion, the callback will provide the opportunity for some side
3907effect to happen or for the change to be rejected.
3908
3909The callbacks are named and associated with a function using the
3910U_BOOT_ENV_CALLBACK macro in your board or driver code.
3911
3912These callbacks are associated with variables in one of two ways. The
3913static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3914in the board configuration to a string that defines a list of
3915associations. The list must be in the following format:
3916
3917 entry = variable_name[:callback_name]
3918 list = entry[,list]
3919
3920If the callback name is not specified, then the callback is deleted.
3921Spaces are also allowed anywhere in the list.
3922
3923Callbacks can also be associated by defining the ".callbacks" variable
3924with the same list format above. Any association in ".callbacks" will
3925override any association in the static list. You can define
3926CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003927".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003928
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003929If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3930regular expression. This allows multiple variables to be connected to
3931the same callback without explicitly listing them all out.
3932
Heinrich Schuchardtc141fa52018-07-29 11:08:14 +02003933The signature of the callback functions is:
3934
3935 int callback(const char *name, const char *value, enum env_op op, int flags)
3936
3937* name - changed environment variable
3938* value - new value of the environment variable
3939* op - operation (create, overwrite, or delete)
3940* flags - attributes of the environment variable change, see flags H_* in
3941 include/search.h
3942
3943The return value is 0 if the variable change is accepted and 1 otherwise.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06003944
wdenk6c59edc2004-05-03 20:45:30 +00003945Command Line Parsing:
3946=====================
stroeseb9c17c52003-04-04 15:53:41 +00003947
wdenk6c59edc2004-05-03 20:45:30 +00003948There are two different command line parsers available with U-Boot:
3949the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk6c59edc2004-05-03 20:45:30 +00003951Old, simple command line parser:
3952--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk6c59edc2004-05-03 20:45:30 +00003954- supports environment variables (through setenv / saveenv commands)
3955- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003956- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003957- special characters ('$', ';') can be escaped by prefixing with '\',
3958 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003959 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003960- You can also escape text by enclosing in single apostrophes, for example:
3961 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk6c59edc2004-05-03 20:45:30 +00003963Hush shell:
3964-----------
wdenkf4688a22003-05-28 08:06:31 +00003965
wdenk6c59edc2004-05-03 20:45:30 +00003966- similar to Bourne shell, with control structures like
3967 if...then...else...fi, for...do...done; while...do...done,
3968 until...do...done, ...
3969- supports environment ("global") variables (through setenv / saveenv
3970 commands) and local shell variables (through standard shell syntax
3971 "name=value"); only environment variables can be used with "run"
3972 command
wdenkf4688a22003-05-28 08:06:31 +00003973
wdenk6c59edc2004-05-03 20:45:30 +00003974General rules:
3975--------------
wdenkf4688a22003-05-28 08:06:31 +00003976
wdenk6c59edc2004-05-03 20:45:30 +00003977(1) If a command line (or an environment variable executed by a "run"
3978 command) contains several commands separated by semicolon, and
3979 one of these commands fails, then the remaining commands will be
3980 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003981
wdenk6c59edc2004-05-03 20:45:30 +00003982(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003983 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003984 command will cause "run" to terminate, i. e. the remaining
3985 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003986
wdenk6c59edc2004-05-03 20:45:30 +00003987Note for Redundant Ethernet Interfaces:
3988=======================================
wdenkf4688a22003-05-28 08:06:31 +00003989
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003990Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003991such configurations and is capable of automatic selection of a
3992"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003993
wdenk6c59edc2004-05-03 20:45:30 +00003994Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3995MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3996"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003997
wdenk6c59edc2004-05-03 20:45:30 +00003998If the network interface stores some valid MAC address (for instance
3999in SROM), this is used as default address if there is NO correspon-
4000ding setting in the environment; if the corresponding environment
4001variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004002
wdenk6c59edc2004-05-03 20:45:30 +00004003o If the SROM has a valid MAC address, and there is no address in the
4004 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004005
wdenk6c59edc2004-05-03 20:45:30 +00004006o If there is no valid address in the SROM, and a definition in the
4007 environment exists, then the value from the environment variable is
4008 used.
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk6c59edc2004-05-03 20:45:30 +00004010o If both the SROM and the environment contain a MAC address, and
4011 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk6c59edc2004-05-03 20:45:30 +00004013o If both the SROM and the environment contain a MAC address, and the
4014 addresses differ, the value from the environment is used and a
4015 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004016
wdenk6c59edc2004-05-03 20:45:30 +00004017o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004018 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4019 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004020
Ben Warren6db991a2010-04-26 11:11:46 -07004021If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004022will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004023may be skipped by setting the appropriate 'ethmacskip' environment variable.
4024The naming convention is as follows:
4025"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk6c59edc2004-05-03 20:45:30 +00004027Image Formats:
4028==============
wdenkc6097192002-11-03 00:24:07 +00004029
Marian Balakowicz18710b82008-03-12 12:13:13 +01004030U-Boot is capable of booting (and performing other auxiliary operations on)
4031images in two formats:
4032
4033New uImage format (FIT)
4034-----------------------
4035
4036Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4037to Flattened Device Tree). It allows the use of images with multiple
4038components (several kernels, ramdisks, etc.), with contents protected by
4039SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4040
4041
4042Old uImage format
4043-----------------
4044
4045Old image format is based on binary files which can be basically anything,
4046preceded by a special header; see the definitions in include/image.h for
4047details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004048
wdenk6c59edc2004-05-03 20:45:30 +00004049* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4050 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004051 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4052 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4053 INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004054* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004055 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03004056 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004057* Compression Type (uncompressed, gzip, bzip2)
4058* Load Address
4059* Entry Point
4060* Image Name
4061* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004062
wdenk6c59edc2004-05-03 20:45:30 +00004063The header is marked by a special Magic Number, and both the header
4064and the data portions of the image are secured against corruption by
4065CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004066
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk6c59edc2004-05-03 20:45:30 +00004068Linux Support:
4069==============
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk6c59edc2004-05-03 20:45:30 +00004071Although U-Boot should support any OS or standalone application
4072easily, the main focus has always been on Linux during the design of
4073U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk6c59edc2004-05-03 20:45:30 +00004075U-Boot includes many features that so far have been part of some
4076special "boot loader" code within the Linux kernel. Also, any
4077"initrd" images to be used are no longer part of one big Linux image;
4078instead, kernel and "initrd" are separate images. This implementation
4079serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk6c59edc2004-05-03 20:45:30 +00004081- the same features can be used for other OS or standalone
4082 applications (for instance: using compressed images to reduce the
4083 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk6c59edc2004-05-03 20:45:30 +00004085- it becomes much easier to port new Linux kernel versions because
4086 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004087
wdenk6c59edc2004-05-03 20:45:30 +00004088- the same Linux kernel image can now be used with different "initrd"
4089 images; of course this also means that different kernel images can
4090 be run with the same "initrd". This makes testing easier (you don't
4091 have to build a new "zImage.initrd" Linux image when you just
4092 change a file in your "initrd"). Also, a field-upgrade of the
4093 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004094
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk6c59edc2004-05-03 20:45:30 +00004096Linux HOWTO:
4097============
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk6c59edc2004-05-03 20:45:30 +00004099Porting Linux to U-Boot based systems:
4100---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004101
wdenk6c59edc2004-05-03 20:45:30 +00004102U-Boot cannot save you from doing all the necessary modifications to
4103configure the Linux device drivers for use with your target hardware
4104(no, we don't intend to provide a full virtual machine interface to
4105Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004106
Stefan Roese88fbf932010-04-15 16:07:28 +02004107But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004108
wdenk6c59edc2004-05-03 20:45:30 +00004109Just make sure your machine specific header file (for instance
4110include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004111Information structure as we define in include/asm-<arch>/u-boot.h,
4112and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004113as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004114
Simon Glassd097e592014-06-11 23:29:46 -06004115Note that U-Boot now has a driver model, a unified model for drivers.
4116If you are adding a new driver, plumb it into driver model. If there
4117is no uclass available, you are encouraged to create one. See
4118doc/driver-model.
4119
wdenkc6097192002-11-03 00:24:07 +00004120
wdenk6c59edc2004-05-03 20:45:30 +00004121Configuring the Linux kernel:
4122-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk6c59edc2004-05-03 20:45:30 +00004124No specific requirements for U-Boot. Make sure you have some root
4125device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004126
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk6c59edc2004-05-03 20:45:30 +00004128Building a Linux Image:
4129-----------------------
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4132not used. If you use recent kernel source, a new build target
4133"uImage" will exist which automatically builds an image usable by
4134U-Boot. Most older kernels also have support for a "pImage" target,
4135which was introduced for our predecessor project PPCBoot and uses a
4136100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138Example:
wdenkc6097192002-11-03 00:24:07 +00004139
Holger Freyther7ba4e572014-08-04 09:26:05 +02004140 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004141 make oldconfig
4142 make dep
4143 make uImage
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk6c59edc2004-05-03 20:45:30 +00004145The "uImage" build target uses a special tool (in 'tools/mkimage') to
4146encapsulate a compressed Linux kernel image with header information,
4147CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004148
wdenk6c59edc2004-05-03 20:45:30 +00004149* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004150
wdenk6c59edc2004-05-03 20:45:30 +00004151* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004152
wdenk6c59edc2004-05-03 20:45:30 +00004153 ${CROSS_COMPILE}-objcopy -O binary \
4154 -R .note -R .comment \
4155 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004158
wdenk6c59edc2004-05-03 20:45:30 +00004159 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004160
wdenk6c59edc2004-05-03 20:45:30 +00004161* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004162
wdenk6c59edc2004-05-03 20:45:30 +00004163 mkimage -A ppc -O linux -T kernel -C gzip \
4164 -a 0 -e 0 -n "Linux Kernel Image" \
4165 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004166
wdenkc6097192002-11-03 00:24:07 +00004167
wdenk6c59edc2004-05-03 20:45:30 +00004168The "mkimage" tool can also be used to create ramdisk images for use
4169with U-Boot, either separated from the Linux kernel image, or
4170combined into one file. "mkimage" encapsulates the images with a 64
4171byte header containing information about target architecture,
4172operating system, image type, compression method, entry points, time
4173stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk6c59edc2004-05-03 20:45:30 +00004175"mkimage" can be called in two ways: to verify existing images and
4176print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004177
wdenk6c59edc2004-05-03 20:45:30 +00004178In the first form (with "-l" option) mkimage lists the information
4179contained in the header of an existing U-Boot image; this includes
4180checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004181
wdenk6c59edc2004-05-03 20:45:30 +00004182 tools/mkimage -l image
4183 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004184
wdenk6c59edc2004-05-03 20:45:30 +00004185The second form (with "-d" option) is used to build a U-Boot image
4186from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004187
wdenk6c59edc2004-05-03 20:45:30 +00004188 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4189 -n name -d data_file image
4190 -A ==> set architecture to 'arch'
4191 -O ==> set operating system to 'os'
4192 -T ==> set image type to 'type'
4193 -C ==> set compression type 'comp'
4194 -a ==> set load address to 'addr' (hex)
4195 -e ==> set entry point to 'ep' (hex)
4196 -n ==> set image name to 'name'
4197 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004198
wdenkcd914452004-05-29 16:53:29 +00004199Right now, all Linux kernels for PowerPC systems use the same load
4200address (0x00000000), but the entry point address depends on the
4201kernel version:
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk6c59edc2004-05-03 20:45:30 +00004203- 2.2.x kernels have the entry point at 0x0000000C,
4204- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk6c59edc2004-05-03 20:45:30 +00004206So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004207
wdenk6c59edc2004-05-03 20:45:30 +00004208 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4209 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004210 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004211 > examples/uImage.TQM850L
4212 Image Name: 2.4.4 kernel for TQM850L
4213 Created: Wed Jul 19 02:34:59 2000
4214 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4215 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4216 Load Address: 0x00000000
4217 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk6c59edc2004-05-03 20:45:30 +00004219To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk6c59edc2004-05-03 20:45:30 +00004221 -> tools/mkimage -l examples/uImage.TQM850L
4222 Image Name: 2.4.4 kernel for TQM850L
4223 Created: Wed Jul 19 02:34:59 2000
4224 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4225 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4226 Load Address: 0x00000000
4227 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk6c59edc2004-05-03 20:45:30 +00004229NOTE: for embedded systems where boot time is critical you can trade
4230speed for memory and install an UNCOMPRESSED image instead: this
4231needs more space in Flash, but boots much faster since it does not
4232need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004233
Stefan Roese88fbf932010-04-15 16:07:28 +02004234 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004235 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4236 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004237 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004238 > examples/uImage.TQM850L-uncompressed
4239 Image Name: 2.4.4 kernel for TQM850L
4240 Created: Wed Jul 19 02:34:59 2000
4241 Image Type: PowerPC Linux Kernel Image (uncompressed)
4242 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4243 Load Address: 0x00000000
4244 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004245
wdenkc6097192002-11-03 00:24:07 +00004246
wdenk6c59edc2004-05-03 20:45:30 +00004247Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4248when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk6c59edc2004-05-03 20:45:30 +00004250 -> tools/mkimage -n 'Simple Ramdisk Image' \
4251 > -A ppc -O linux -T ramdisk -C gzip \
4252 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4253 Image Name: Simple Ramdisk Image
4254 Created: Wed Jan 12 14:01:50 2000
4255 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4256 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4257 Load Address: 0x00000000
4258 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004259
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004260The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4261option performs the converse operation of the mkimage's second form (the "-d"
4262option). Given an image built by mkimage, the dumpimage extracts a "data file"
4263from the image:
4264
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02004265 tools/dumpimage -i image -T type -p position data_file
4266 -i ==> extract from the 'image' a specific 'data_file'
4267 -T ==> set image type to 'type'
4268 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07004269
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271Installing a Linux Image:
4272-------------------------
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk6c59edc2004-05-03 20:45:30 +00004274To downloading a U-Boot image over the serial (console) interface,
4275you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk6c59edc2004-05-03 20:45:30 +00004277 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk6c59edc2004-05-03 20:45:30 +00004279The 'objcopy' does not understand the information in the U-Boot
4280image header, so the resulting S-Record file will be relative to
4281address 0x00000000. To load it to a given address, you need to
4282specify the target address as 'offset' parameter with the 'loads'
4283command.
wdenkc6097192002-11-03 00:24:07 +00004284
wdenk6c59edc2004-05-03 20:45:30 +00004285Example: install the image to address 0x40100000 (which on the
4286TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004287
wdenk6c59edc2004-05-03 20:45:30 +00004288 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk6c59edc2004-05-03 20:45:30 +00004290 .......... done
4291 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk6c59edc2004-05-03 20:45:30 +00004293 => loads 40100000
4294 ## Ready for S-Record download ...
4295 ~>examples/image.srec
4296 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4297 ...
4298 15989 15990 15991 15992
4299 [file transfer complete]
4300 [connected]
4301 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004302
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk6c59edc2004-05-03 20:45:30 +00004304You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004305this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004306corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk6c59edc2004-05-03 20:45:30 +00004308 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk6c59edc2004-05-03 20:45:30 +00004310 ## Checking Image at 40100000 ...
4311 Image Name: 2.2.13 for initrd on TQM850L
4312 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4313 Data Size: 335725 Bytes = 327 kB = 0 MB
4314 Load Address: 00000000
4315 Entry Point: 0000000c
4316 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004317
4318
wdenk6c59edc2004-05-03 20:45:30 +00004319Boot Linux:
4320-----------
wdenkc6097192002-11-03 00:24:07 +00004321
wdenk6c59edc2004-05-03 20:45:30 +00004322The "bootm" command is used to boot an application that is stored in
4323memory (RAM or Flash). In case of a Linux kernel image, the contents
4324of the "bootargs" environment variable is passed to the kernel as
4325parameters. You can check and modify this variable using the
4326"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004327
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk6c59edc2004-05-03 20:45:30 +00004329 => printenv bootargs
4330 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332 => 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 +00004333
wdenk6c59edc2004-05-03 20:45:30 +00004334 => printenv bootargs
4335 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 +00004336
wdenk6c59edc2004-05-03 20:45:30 +00004337 => bootm 40020000
4338 ## Booting Linux kernel at 40020000 ...
4339 Image Name: 2.2.13 for NFS on TQM850L
4340 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4341 Data Size: 381681 Bytes = 372 kB = 0 MB
4342 Load Address: 00000000
4343 Entry Point: 0000000c
4344 Verifying Checksum ... OK
4345 Uncompressing Kernel Image ... OK
4346 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
4347 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4348 time_init: decrementer frequency = 187500000/60
4349 Calibrating delay loop... 49.77 BogoMIPS
4350 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4351 ...
wdenkc6097192002-11-03 00:24:07 +00004352
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004353If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004354the memory addresses of both the kernel and the initrd image (PPBCOOT
4355format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004356
wdenk6c59edc2004-05-03 20:45:30 +00004357 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk6c59edc2004-05-03 20:45:30 +00004359 ## Checking Image at 40100000 ...
4360 Image Name: 2.2.13 for initrd on TQM850L
4361 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4362 Data Size: 335725 Bytes = 327 kB = 0 MB
4363 Load Address: 00000000
4364 Entry Point: 0000000c
4365 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367 ## Checking Image at 40200000 ...
4368 Image Name: Simple Ramdisk Image
4369 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4370 Data Size: 566530 Bytes = 553 kB = 0 MB
4371 Load Address: 00000000
4372 Entry Point: 00000000
4373 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk6c59edc2004-05-03 20:45:30 +00004375 => bootm 40100000 40200000
4376 ## Booting Linux kernel at 40100000 ...
4377 Image Name: 2.2.13 for initrd on TQM850L
4378 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4379 Data Size: 335725 Bytes = 327 kB = 0 MB
4380 Load Address: 00000000
4381 Entry Point: 0000000c
4382 Verifying Checksum ... OK
4383 Uncompressing Kernel Image ... OK
4384 ## Loading RAMDisk Image at 40200000 ...
4385 Image Name: Simple Ramdisk Image
4386 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4387 Data Size: 566530 Bytes = 553 kB = 0 MB
4388 Load Address: 00000000
4389 Entry Point: 00000000
4390 Verifying Checksum ... OK
4391 Loading Ramdisk ... OK
4392 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
4393 Boot arguments: root=/dev/ram
4394 time_init: decrementer frequency = 187500000/60
4395 Calibrating delay loop... 49.77 BogoMIPS
4396 ...
4397 RAMDISK: Compressed image found at block 0
4398 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk6c59edc2004-05-03 20:45:30 +00004400 bash#
wdenkc6097192002-11-03 00:24:07 +00004401
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004402Boot Linux and pass a flat device tree:
4403-----------
4404
4405First, U-Boot must be compiled with the appropriate defines. See the section
4406titled "Linux Kernel Interface" above for a more in depth explanation. The
4407following is an example of how to start a kernel and pass an updated
4408flat device tree:
4409
4410=> print oftaddr
4411oftaddr=0x300000
4412=> print oft
4413oft=oftrees/mpc8540ads.dtb
4414=> tftp $oftaddr $oft
4415Speed: 1000, full duplex
4416Using TSEC0 device
4417TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4418Filename 'oftrees/mpc8540ads.dtb'.
4419Load address: 0x300000
4420Loading: #
4421done
4422Bytes transferred = 4106 (100a hex)
4423=> tftp $loadaddr $bootfile
4424Speed: 1000, full duplex
4425Using TSEC0 device
4426TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4427Filename 'uImage'.
4428Load address: 0x200000
4429Loading:############
4430done
4431Bytes transferred = 1029407 (fb51f hex)
4432=> print loadaddr
4433loadaddr=200000
4434=> print oftaddr
4435oftaddr=0x300000
4436=> bootm $loadaddr - $oftaddr
4437## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004438 Image Name: Linux-2.6.17-dirty
4439 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4440 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004441 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004442 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004443 Verifying Checksum ... OK
4444 Uncompressing Kernel Image ... OK
4445Booting using flat device tree at 0x300000
4446Using MPC85xx ADS machine description
4447Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4448[snip]
4449
4450
wdenk6c59edc2004-05-03 20:45:30 +00004451More About U-Boot Image Types:
4452------------------------------
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk6c59edc2004-05-03 20:45:30 +00004454U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004455
wdenk6c59edc2004-05-03 20:45:30 +00004456 "Standalone Programs" are directly runnable in the environment
4457 provided by U-Boot; it is expected that (if they behave
4458 well) you can continue to work in U-Boot after return from
4459 the Standalone Program.
4460 "OS Kernel Images" are usually images of some Embedded OS which
4461 will take over control completely. Usually these programs
4462 will install their own set of exception handlers, device
4463 drivers, set up the MMU, etc. - this means, that you cannot
4464 expect to re-enter U-Boot except by resetting the CPU.
4465 "RAMDisk Images" are more or less just data blocks, and their
4466 parameters (address, size) are passed to an OS kernel that is
4467 being started.
4468 "Multi-File Images" contain several images, typically an OS
4469 (Linux) kernel image and one or more data images like
4470 RAMDisks. This construct is useful for instance when you want
4471 to boot over the network using BOOTP etc., where the boot
4472 server provides just a single image file, but you want to get
4473 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004474
wdenk6c59edc2004-05-03 20:45:30 +00004475 "Multi-File Images" start with a list of image sizes, each
4476 image size (in bytes) specified by an "uint32_t" in network
4477 byte order. This list is terminated by an "(uint32_t)0".
4478 Immediately after the terminating 0 follow the images, one by
4479 one, all aligned on "uint32_t" boundaries (size rounded up to
4480 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004481
wdenk6c59edc2004-05-03 20:45:30 +00004482 "Firmware Images" are binary images containing firmware (like
4483 U-Boot or FPGA images) which usually will be programmed to
4484 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004485
wdenk6c59edc2004-05-03 20:45:30 +00004486 "Script files" are command sequences that will be executed by
4487 U-Boot's command interpreter; this feature is especially
4488 useful when you configure U-Boot to use a real shell (hush)
4489 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004490
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004491Booting the Linux zImage:
4492-------------------------
4493
4494On some platforms, it's possible to boot Linux zImage. This is done
4495using the "bootz" command. The syntax of "bootz" command is the same
4496as the syntax of "bootm" command.
4497
Tom Rini45f46d12013-05-16 11:40:11 -04004498Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00004499kernel with raw initrd images. The syntax is slightly different, the
4500address of the initrd must be augmented by it's size, in the following
4501format: "<initrd addres>:<initrd size>".
4502
stroeseb9c17c52003-04-04 15:53:41 +00004503
wdenk6c59edc2004-05-03 20:45:30 +00004504Standalone HOWTO:
4505=================
stroeseb9c17c52003-04-04 15:53:41 +00004506
wdenk6c59edc2004-05-03 20:45:30 +00004507One of the features of U-Boot is that you can dynamically load and
4508run "standalone" applications, which can use some resources of
4509U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004512
wdenk6c59edc2004-05-03 20:45:30 +00004513"Hello World" Demo:
4514-------------------
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk6c59edc2004-05-03 20:45:30 +00004516'examples/hello_world.c' contains a small "Hello World" Demo
4517application; it is automatically compiled when you build U-Boot.
4518It's configured to run at address 0x00040004, so you can play with it
4519like that:
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk6c59edc2004-05-03 20:45:30 +00004521 => loads
4522 ## Ready for S-Record download ...
4523 ~>examples/hello_world.srec
4524 1 2 3 4 5 6 7 8 9 10 11 ...
4525 [file transfer complete]
4526 [connected]
4527 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529 => go 40004 Hello World! This is a test.
4530 ## Starting application at 0x00040004 ...
4531 Hello World
4532 argc = 7
4533 argv[0] = "40004"
4534 argv[1] = "Hello"
4535 argv[2] = "World!"
4536 argv[3] = "This"
4537 argv[4] = "is"
4538 argv[5] = "a"
4539 argv[6] = "test."
4540 argv[7] = "<NULL>"
4541 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk6c59edc2004-05-03 20:45:30 +00004545Another example, which demonstrates how to register a CPM interrupt
4546handler with the U-Boot code, can be found in 'examples/timer.c'.
4547Here, a CPM timer is set up to generate an interrupt every second.
4548The interrupt service routine is trivial, just printing a '.'
4549character, but this is just a demo program. The application can be
4550controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552 ? - print current values og the CPM Timer registers
4553 b - enable interrupts and start timer
4554 e - stop timer and disable interrupts
4555 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004556
wdenk6c59edc2004-05-03 20:45:30 +00004557 => loads
4558 ## Ready for S-Record download ...
4559 ~>examples/timer.srec
4560 1 2 3 4 5 6 7 8 9 10 11 ...
4561 [file transfer complete]
4562 [connected]
4563 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565 => go 40004
4566 ## Starting application at 0x00040004 ...
4567 TIMERS=0xfff00980
4568 Using timer 1
4569 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk6c59edc2004-05-03 20:45:30 +00004571Hit 'b':
4572 [q, b, e, ?] Set interval 1000000 us
4573 Enabling timer
4574Hit '?':
4575 [q, b, e, ?] ........
4576 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4577Hit '?':
4578 [q, b, e, ?] .
4579 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4580Hit '?':
4581 [q, b, e, ?] .
4582 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4583Hit '?':
4584 [q, b, e, ?] .
4585 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4586Hit 'e':
4587 [q, b, e, ?] ...Stopping timer
4588Hit 'q':
4589 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004590
wdenkc6097192002-11-03 00:24:07 +00004591
wdenk6c59edc2004-05-03 20:45:30 +00004592Minicom warning:
4593================
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk6c59edc2004-05-03 20:45:30 +00004595Over time, many people have reported problems when trying to use the
4596"minicom" terminal emulation program for serial download. I (wd)
4597consider minicom to be broken, and recommend not to use it. Under
4598Unix, I recommend to use C-Kermit for general purpose use (and
4599especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004600use "cu" for S-Record download ("loads" command). See
4601http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4602for help with kermit.
4603
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk6c59edc2004-05-03 20:45:30 +00004605Nevertheless, if you absolutely want to use it try adding this
4606configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk6c59edc2004-05-03 20:45:30 +00004608 Name Program Name U/D FullScr IO-Red. Multi
4609 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4610 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004611
wdenk8dba0502003-03-31 16:34:49 +00004612
wdenk6c59edc2004-05-03 20:45:30 +00004613NetBSD Notes:
4614=============
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk6c59edc2004-05-03 20:45:30 +00004616Starting at version 0.9.2, U-Boot supports NetBSD both as host
4617(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004618
wdenk6c59edc2004-05-03 20:45:30 +00004619Building requires a cross environment; it is known to work on
4620NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4621need gmake since the Makefiles are not compatible with BSD make).
4622Note that the cross-powerpc package does not install include files;
4623attempting to build U-Boot will fail because <machine/ansi.h> is
4624missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004625
wdenk6c59edc2004-05-03 20:45:30 +00004626 # cd /usr/pkg/cross/powerpc-netbsd/include
4627 # mkdir powerpc
4628 # ln -s powerpc machine
4629 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4630 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004631
wdenk6c59edc2004-05-03 20:45:30 +00004632Native builds *don't* work due to incompatibilities between native
4633and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635Booting assumes that (the first part of) the image booted is a
4636stage-2 loader which in turn loads and then invokes the kernel
4637proper. Loader sources will eventually appear in the NetBSD source
4638tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004639meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004640
wdenkc6097192002-11-03 00:24:07 +00004641
wdenk6c59edc2004-05-03 20:45:30 +00004642Implementation Internals:
4643=========================
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk6c59edc2004-05-03 20:45:30 +00004645The following is not intended to be a complete description of every
4646implementation detail. However, it should help to understand the
4647inner workings of U-Boot and make it easier to port it to custom
4648hardware.
wdenkc6097192002-11-03 00:24:07 +00004649
wdenkc6097192002-11-03 00:24:07 +00004650
wdenk6c59edc2004-05-03 20:45:30 +00004651Initial Stack, Global Data:
4652---------------------------
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654The implementation of U-Boot is complicated by the fact that U-Boot
4655starts running out of ROM (flash memory), usually without access to
4656system RAM (because the memory controller is not initialized yet).
4657This means that we don't have writable Data or BSS segments, and BSS
4658is not initialized as zero. To be able to get a C environment working
4659at all, we have to allocate at least a minimal stack. Implementation
4660options for this are defined and restricted by the CPU used: Some CPU
4661models provide on-chip memory (like the IMMR area on MPC8xx and
4662MPC826x processors), on others (parts of) the data cache can be
4663locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004664
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004665 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004666 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4669 From: "Chris Hallinan" <clh@net1plus.com>
4670 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4671 ...
wdenkc6097192002-11-03 00:24:07 +00004672
wdenk6c59edc2004-05-03 20:45:30 +00004673 Correct me if I'm wrong, folks, but the way I understand it
4674 is this: Using DCACHE as initial RAM for Stack, etc, does not
4675 require any physical RAM backing up the cache. The cleverness
4676 is that the cache is being used as a temporary supply of
4677 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004678 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004679 can see how this works by studying the cache architecture and
4680 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004681
wdenk6c59edc2004-05-03 20:45:30 +00004682 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4683 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004684 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004685 option should work for you. Using CS 4 should be fine if your
4686 board designers haven't used it for something that would
4687 cause you grief during the initial boot! It is frequently not
4688 used.
wdenkc6097192002-11-03 00:24:07 +00004689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004690 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004691 with your processor/board/system design. The default value
4692 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004693 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004694 than your SDRAM module. If you have a 64MB SDRAM module, set
4695 it above 400_0000. Just make sure your board has no resources
4696 that are supposed to respond to that address! That code in
4697 start.S has been around a while and should work as is when
4698 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700 -Chris Hallinan
4701 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004702
wdenk6c59edc2004-05-03 20:45:30 +00004703It is essential to remember this, since it has some impact on the C
4704code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004705
wdenk6c59edc2004-05-03 20:45:30 +00004706* Initialized global data (data segment) is read-only. Do not attempt
4707 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004708
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004709* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00004710 as zero data - BSS segment) at all - this is undefined, initiali-
4711 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713* Stack space is very limited. Avoid big data buffers or things like
4714 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004715
wdenk6c59edc2004-05-03 20:45:30 +00004716Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004717normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00004718turned out that the implementation of U-Boot can be greatly
4719simplified by making a global data structure (gd_t) available to all
4720functions. We could pass a pointer to this data as argument to _all_
4721functions, but this would bloat the code. Instead we use a feature of
4722the GCC compiler (Global Register Variables) to share the data: we
4723place a pointer (gd) to the global data into a register which we
4724reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk6c59edc2004-05-03 20:45:30 +00004726When choosing a register for such a purpose we are restricted by the
4727relevant (E)ABI specifications for the current architecture, and by
4728GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004729
wdenk6c59edc2004-05-03 20:45:30 +00004730For PowerPC, the following registers have specific use:
4731 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004732 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004733 R3-R4: parameter passing and return values
4734 R5-R10: parameter passing
4735 R13: small data area pointer
4736 R30: GOT pointer
4737 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004738
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004739 (U-Boot also uses R12 as internal GOT pointer. r12
4740 is a volatile register so r12 needs to be reset when
4741 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004742
Wolfgang Denk69c09642008-02-14 22:43:22 +01004743 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745 Note: on PPC, we could use a static initializer (since the
4746 address of the global data structure is known at compile time),
4747 but it turned out that reserving a register results in somewhat
4748 smaller code - although the code savings are not that big (on
4749 average for all boards 752 bytes for the whole U-Boot image,
4750 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk6c59edc2004-05-03 20:45:30 +00004752On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk6c59edc2004-05-03 20:45:30 +00004754 R0: function argument word/integer result
4755 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004756 R9: platform specific
4757 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00004758 R11: argument (frame) pointer
4759 R12: temporary workspace
4760 R13: stack pointer
4761 R14: link register
4762 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004763
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02004764 ==> U-Boot will use R9 to hold a pointer to the global data
4765
4766 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004767
Thomas Chou8fa38582010-05-21 11:08:03 +08004768On Nios II, the ABI is documented here:
4769 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4770
4771 ==> U-Boot will use gp to hold a pointer to the global data
4772
4773 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4774 to access small data sections, so gp is free.
4775
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004776On NDS32, the following registers are used:
4777
4778 R0-R1: argument/return
4779 R2-R5: argument
4780 R15: temporary register for assembler
4781 R16: trampoline register
4782 R28: frame pointer (FP)
4783 R29: global pointer (GP)
4784 R30: link register (LP)
4785 R31: stack pointer (SP)
4786 PC: program counter (PC)
4787
4788 ==> U-Boot will use R10 to hold a pointer to the global data
4789
Wolfgang Denk6405a152006-03-31 18:32:53 +02004790NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4791or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004792
Rick Chend7e6f922017-12-26 13:55:59 +08004793On RISC-V, the following registers are used:
4794
4795 x0: hard-wired zero (zero)
4796 x1: return address (ra)
4797 x2: stack pointer (sp)
4798 x3: global pointer (gp)
4799 x4: thread pointer (tp)
4800 x5: link register (t0)
4801 x8: frame pointer (fp)
4802 x10-x11: arguments/return values (a0-1)
4803 x12-x17: arguments (a2-7)
4804 x28-31: temporaries (t3-6)
4805 pc: program counter (pc)
4806
4807 ==> U-Boot will use gp to hold a pointer to the global data
4808
wdenk6c59edc2004-05-03 20:45:30 +00004809Memory Management:
4810------------------
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk6c59edc2004-05-03 20:45:30 +00004812U-Boot runs in system state and uses physical addresses, i.e. the
4813MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk6c59edc2004-05-03 20:45:30 +00004815The available memory is mapped to fixed addresses using the memory
4816controller. In this process, a contiguous block is formed for each
4817memory type (Flash, SDRAM, SRAM), even when it consists of several
4818physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820U-Boot is installed in the first 128 kB of the first Flash bank (on
4821TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4822booting and sizing and initializing DRAM, the code relocates itself
4823to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004824memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004825configuration setting]. Below that, a structure with global Board
4826Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk6c59edc2004-05-03 20:45:30 +00004828Additionally, some exception handler code is copied to the low 8 kB
4829of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk6c59edc2004-05-03 20:45:30 +00004831So a typical memory configuration with 16 MB of DRAM could look like
4832this:
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834 0x0000 0000 Exception Vector code
4835 :
4836 0x0000 1FFF
4837 0x0000 2000 Free for Application Use
4838 :
4839 :
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk6c59edc2004-05-03 20:45:30 +00004841 :
4842 :
4843 0x00FB FF20 Monitor Stack (Growing downward)
4844 0x00FB FFAC Board Info Data and permanent copy of global data
4845 0x00FC 0000 Malloc Arena
4846 :
4847 0x00FD FFFF
4848 0x00FE 0000 RAM Copy of Monitor Code
4849 ... eventually: LCD or video framebuffer
4850 ... eventually: pRAM (Protected RAM - unchanged by reset)
4851 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004852
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk6c59edc2004-05-03 20:45:30 +00004854System Initialization:
4855----------------------
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004858(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004859configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00004860To be able to re-map memory U-Boot then jumps to its link address.
4861To be able to implement the initialization code in C, a (small!)
4862initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02004863which provide such a feature like), or in a locked part of the data
4864cache. After that, U-Boot initializes the CPU core, the caches and
4865the SIU.
wdenkc6097192002-11-03 00:24:07 +00004866
wdenk6c59edc2004-05-03 20:45:30 +00004867Next, all (potentially) available memory banks are mapped using a
4868preliminary mapping. For example, we put them on 512 MB boundaries
4869(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4870on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4871programmed for SDRAM access. Using the temporary configuration, a
4872simple memory test is run that determines the size of the SDRAM
4873banks.
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875When there is more than one SDRAM bank, and the banks are of
4876different size, the largest is mapped first. For equal size, the first
4877bank (CS2#) is mapped first. The first mapping is always for address
48780x00000000, with any additional banks following immediately to create
4879contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881Then, the monitor installs itself at the upper end of the SDRAM area
4882and allocates memory for use by malloc() and for the global Board
4883Info data; also, the exception vector code is copied to the low RAM
4884pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886Only after this relocation will you have a "normal" C environment;
4887until that you are restricted in several ways, mostly because you are
4888running from ROM, and because the code will have to be relocated to a
4889new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004890
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892U-Boot Porting Guide:
4893----------------------
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4896list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004897
wdenkc6097192002-11-03 00:24:07 +00004898
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004899int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004900{
4901 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004902
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004903 signal(SIGALRM, no_more_time);
4904 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004907 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004908 return 0;
4909 }
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk6c59edc2004-05-03 20:45:30 +00004911 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004912
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004913 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004914
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004915 if (clueless)
4916 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918 while (learning) {
4919 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004920 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4921 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004922 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004923 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004924 }
wdenkc6097192002-11-03 00:24:07 +00004925
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004926 if (available_money > toLocalCurrency ($2500))
4927 Buy a BDI3000;
4928 else
wdenk6c59edc2004-05-03 20:45:30 +00004929 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004930
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004931 if (a similar board exists) { /* hopefully... */
4932 cp -a board/<similar> board/<myboard>
4933 cp include/configs/<similar>.h include/configs/<myboard>.h
4934 } else {
4935 Create your own board support subdirectory;
4936 Create your own board include/configs/<myboard>.h file;
4937 }
4938 Edit new board/<myboard> files
4939 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004940
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004941 while (!accepted) {
4942 while (!running) {
4943 do {
4944 Add / modify source code;
4945 } until (compiles);
4946 Debug;
4947 if (clueless)
4948 email("Hi, I am having problems...");
4949 }
4950 Send patch file to the U-Boot email list;
4951 if (reasonable critiques)
4952 Incorporate improvements from email list code review;
4953 else
4954 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004955 }
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957 return 0;
4958}
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960void no_more_time (int sig)
4961{
4962 hire_a_guru();
4963}
wdenkc6097192002-11-03 00:24:07 +00004964
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk6c59edc2004-05-03 20:45:30 +00004966Coding Standards:
4967-----------------
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02004970coding style; see the kernel coding style guide at
4971https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4972script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004973
4974Source files originating from a different project (for example the
4975MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004976reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02004977sources.
wdenkc6097192002-11-03 00:24:07 +00004978
Detlev Zundelaa63d482006-09-01 15:39:02 +02004979Please note that U-Boot is implemented in C (and to some small parts in
4980Assembler); no C++ is used, so please do not use C++ style comments (//)
4981in your code.
wdenkad276f22004-01-04 16:28:35 +00004982
wdenk6c59edc2004-05-03 20:45:30 +00004983Please also stick to the following formatting rules:
4984- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004985- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004986- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004987- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004988- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990Submissions which do not conform to the standards may be returned
4991with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004992
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk6c59edc2004-05-03 20:45:30 +00004994Submitting Patches:
4995-------------------
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997Since the number of patches for U-Boot is growing, we need to
4998establish some rules. Submissions which do not conform to these rules
4999may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005000
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005001Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005002
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005003Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08005004see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005005
wdenk6c59edc2004-05-03 20:45:30 +00005006When you send a patch, please include the following information with
5007it:
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009* For bug fixes: a description of the bug and how your patch fixes
5010 this bug. Please try to include a way of demonstrating that the
5011 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005012
wdenk6c59edc2004-05-03 20:45:30 +00005013* For new features: a description of the feature and your
5014 implementation.
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk6c59edc2004-05-03 20:45:30 +00005016* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005017
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005018* For major contributions, add a MAINTAINERS file with your
5019 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005020
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005021* When you add support for a new board, don't forget to add a
5022 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005023
wdenk6c59edc2004-05-03 20:45:30 +00005024* If your patch adds new configuration options, don't forget to
5025 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005026
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005027* The patch itself. If you are using git (which is *strongly*
5028 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005029 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005030 the U-Boot mailing list, you will avoid most of the common problems
5031 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005032
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005033 If you cannot use git, use "diff -purN OLD NEW". If your version of
5034 diff does not support these options, then get the latest version of
5035 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005036
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005037 The current directory when running this command shall be the parent
5038 directory of the U-Boot source tree (i. e. please make sure that
5039 your patch includes sufficient directory information for the
5040 affected files).
5041
5042 We prefer patches as plain text. MIME attachments are discouraged,
5043 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045* If one logical set of modifications affects or creates several
5046 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048* Changesets that contain different, unrelated modifications shall be
5049 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005050
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052Notes:
wdenkc6097192002-11-03 00:24:07 +00005053
Simon Glassdc27def2016-07-27 20:33:08 -06005054* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005055 source tree and make sure that no errors or warnings are reported
5056 for any of the boards.
5057
5058* Keep your modifications to the necessary minimum: A patch
5059 containing several unrelated changes or arbitrary reformats will be
5060 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062* If you modify existing code, make sure that your new code does not
5063 add to the memory footprint of the code ;-) Small is beautiful!
5064 When adding new features, these should compile conditionally only
5065 (using #ifdef), and the resulting code with the new feature
5066 disabled must not need more memory than the old code without your
5067 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005068
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005069* Remember that there is a size limit of 100 kB per message on the
5070 u-boot mailing list. Bigger patches will be moderated. If they are
5071 reasonable and not too big, they will be acknowledged. But patches
5072 bigger than the size limit should be avoided.