blob: 96ce6289ea9e92aec68fb62bd74b5345df986e76 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000143 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500144 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400145 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200146 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500147 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400149 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/api Machine/arch independent API for external apps
151/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800152/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500153/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500154/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500155/disk Code for disk drive partition handling
156/doc Documentation (don't expect too much)
157/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400158/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500159/examples Example code for standalone applications, etc.
160/fs Filesystem code (cramfs, ext2, jffs2, etc.)
161/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500162/lib Library routines generic to all architectures
163/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500164/net Networking code
165/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500166/scripts Various build scripts and Makefiles
167/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500168/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000169
wdenkc6097192002-11-03 00:24:07 +0000170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200185 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000186
Robert P. J. Day7207b362015-12-19 07:16:10 -0500187Previously, all configuration was done by hand, which involved creating
188symbolic links and editing configuration files manually. More recently,
189U-Boot has added the Kbuild infrastructure used by the Linux kernel,
190allowing you to use the "make menuconfig" command to configure your
191build.
wdenkc6097192002-11-03 00:24:07 +0000192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200198configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000199
200Example: For a TQM823L module type:
201
202 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200203 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000204
Robert P. J. Day7207b362015-12-19 07:16:10 -0500205Note: If you're looking for the default configuration file for a board
206you're sure used to be there but is now missing, check the file
207doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000208
Simon Glass75b3c3a2014-03-22 17:12:59 -0600209Sandbox Environment:
210--------------------
211
212U-Boot can be built natively to run on a Linux host using the 'sandbox'
213board. This allows feature development which is not board- or architecture-
214specific to be undertaken on a native platform. The sandbox is also used to
215run some of U-Boot's tests.
216
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530217See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600218
219
Simon Glassdb910352015-03-03 08:03:00 -0700220Board Initialisation Flow:
221--------------------------
222
223This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500224SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700225
Robert P. J. Day7207b362015-12-19 07:16:10 -0500226Note: "SPL" stands for "Secondary Program Loader," which is explained in
227more detail later in this file.
228
229At present, SPL mostly uses a separate code path, but the function names
230and roles of each function are the same. Some boards or architectures
231may not conform to this. At least most ARM boards which use
232CONFIG_SPL_FRAMEWORK conform to this.
233
234Execution typically starts with an architecture-specific (and possibly
235CPU-specific) start.S file, such as:
236
237 - arch/arm/cpu/armv7/start.S
238 - arch/powerpc/cpu/mpc83xx/start.S
239 - arch/mips/cpu/start.S
240
241and so on. From there, three functions are called; the purpose and
242limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700243
244lowlevel_init():
245 - purpose: essential init to permit execution to reach board_init_f()
246 - no global_data or BSS
247 - there is no stack (ARMv7 may have one but it will soon be removed)
248 - must not set up SDRAM or use console
249 - must only do the bare minimum to allow execution to continue to
250 board_init_f()
251 - this is almost never needed
252 - return normally from this function
253
254board_init_f():
255 - purpose: set up the machine ready for running board_init_r():
256 i.e. SDRAM and serial UART
257 - global_data is available
258 - stack is in SRAM
259 - BSS is not available, so you cannot use global/static variables,
260 only stack variables and global_data
261
262 Non-SPL-specific notes:
263 - dram_init() is called to set up DRAM. If already done in SPL this
264 can do nothing
265
266 SPL-specific notes:
267 - you can override the entire board_init_f() function with your own
268 version as needed.
269 - preloader_console_init() can be called here in extremis
270 - should set up SDRAM, and anything needed to make the UART work
271 - these is no need to clear BSS, it will be done by crt0.S
272 - must return normally from this function (don't call board_init_r()
273 directly)
274
275Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276this point the stack and global_data are relocated to below
277CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278memory.
279
280board_init_r():
281 - purpose: main execution, common code
282 - global_data is available
283 - SDRAM is available
284 - BSS is available, all static/global variables can be used
285 - execution eventually continues to main_loop()
286
287 Non-SPL-specific notes:
288 - U-Boot is relocated to the top of memory and is now running from
289 there.
290
291 SPL-specific notes:
292 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293 CONFIG_SPL_STACK_R_ADDR points into SDRAM
294 - preloader_console_init() can be called here - typically this is
295 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
296 spl_board_init() function containing this call
297 - loads U-Boot or (in falcon mode) Linux
298
299
300
wdenkc6097192002-11-03 00:24:07 +0000301Configuration Options:
302----------------------
303
304Configuration depends on the combination of board and CPU type; all
305such information is kept in a configuration file
306"include/configs/<board_name>.h".
307
308Example: For a TQM823L module, all configuration settings are in
309"include/configs/TQM823L.h".
310
311
wdenk7f6c2cb2002-11-10 22:06:23 +0000312Many of the options are named exactly as the corresponding Linux
313kernel configuration options. The intention is to make it easier to
314build a config tool - later.
315
316
wdenkc6097192002-11-03 00:24:07 +0000317The following options need to be configured:
318
Kim Phillips26281142007-08-10 13:28:25 -0500319- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000320
Kim Phillips26281142007-08-10 13:28:25 -0500321- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200322
323- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100324 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000325
Lei Wencf946c62011-02-09 18:06:58 +0530326- Marvell Family Member
327 CONFIG_SYS_MVFS - define it if you want to enable
328 multiple fs option at one time
329 for marvell soc family
330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Kumar Gala66412c62011-02-18 05:40:54 -0600359- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000360 CONFIG_SYS_PPC64
361
362 Specifies that the core is a 64-bit PowerPC implementation (implements
363 the "64" category of the Power ISA). This is necessary for ePAPR
364 compliance, among other possible reasons.
365
Kumar Gala66412c62011-02-18 05:40:54 -0600366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Scott Wood33eee332012-08-14 10:14:53 +0000377 CONFIG_SYS_FSL_ERRATUM_A004510
378
379 Enables a workaround for erratum A004510. If set,
380 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
381 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
382
383 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
384 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
385
386 Defines one or two SoC revisions (low 8 bits of SVR)
387 for which the A004510 workaround should be applied.
388
389 The rest of SVR is either not relevant to the decision
390 of whether the erratum is present (e.g. p2040 versus
391 p2041) or is implied by the build target, which controls
392 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
393
394 See Freescale App Note 4493 for more information about
395 this erratum.
396
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530397 CONFIG_A003399_NOR_WORKAROUND
398 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800399 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530400
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530401 CONFIG_A008044_WORKAROUND
402 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800403 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530404
Scott Wood33eee332012-08-14 10:14:53 +0000405 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
406
407 This is the value to write into CCSR offset 0x18600
408 according to the A004510 workaround.
409
Priyanka Jain64501c62013-07-02 09:21:04 +0530410 CONFIG_SYS_FSL_DSP_DDR_ADDR
411 This value denotes start offset of DDR memory which is
412 connected exclusively to the DSP cores.
413
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530414 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415 This value denotes start offset of M2 memory
416 which is directly connected to the DSP core.
417
Priyanka Jain64501c62013-07-02 09:21:04 +0530418 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
419 This value denotes start offset of M3 memory which is directly
420 connected to the DSP core.
421
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jainb1359912013-12-17 14:25:52 +0530425 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426 Single Source Clock is clocking mode present in some of FSL SoC's.
427 In this mode, a single differential clock is used to supply
428 clocks to the sysclock, ddrclock and usbclock.
429
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530430 CONFIG_SYS_CPC_REINIT_F
431 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800432 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530433
Tang Yuantianaade2002014-04-17 15:33:46 +0800434 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800435 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800436 supported, core will start to execute uboot when wakes up.
437
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000438- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700439 CONFIG_SYS_GENERIC_GLOBAL_DATA
440 Defines global data is initialized in generic board board_init_f().
441 If this macro is defined, global data is created and cleared in
442 generic board board_init_f(). Without this macro, architecture/board
443 should initialize global data before calling board_init_f().
444
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000445 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
446
447 Defines the endianess of the CPU. Implementation of those
448 values is arch specific.
449
York Sun5614e712013-09-30 09:22:09 -0700450 CONFIG_SYS_FSL_DDR
451 Freescale DDR driver in use. This type of DDR controller is
452 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
453 SoCs.
454
455 CONFIG_SYS_FSL_DDR_ADDR
456 Freescale DDR memory-mapped register base.
457
458 CONFIG_SYS_FSL_DDR_EMU
459 Specify emulator support for DDR. Some DDR features such as
460 deskew training are not available.
461
462 CONFIG_SYS_FSL_DDRC_GEN1
463 Freescale DDR1 controller.
464
465 CONFIG_SYS_FSL_DDRC_GEN2
466 Freescale DDR2 controller.
467
468 CONFIG_SYS_FSL_DDRC_GEN3
469 Freescale DDR3 controller.
470
York Sun34e026f2014-03-27 17:54:47 -0700471 CONFIG_SYS_FSL_DDRC_GEN4
472 Freescale DDR4 controller.
473
York Sun9ac4ffb2013-09-30 14:20:51 -0700474 CONFIG_SYS_FSL_DDRC_ARM_GEN3
475 Freescale DDR3 controller for ARM-based SoCs.
476
York Sun5614e712013-09-30 09:22:09 -0700477 CONFIG_SYS_FSL_DDR1
478 Board config to use DDR1. It can be enabled for SoCs with
479 Freescale DDR1 or DDR2 controllers, depending on the board
480 implemetation.
481
482 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400483 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700484 Freescale DDR2 or DDR3 controllers, depending on the board
485 implementation.
486
487 CONFIG_SYS_FSL_DDR3
488 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700489 Freescale DDR3 or DDR3L controllers.
490
491 CONFIG_SYS_FSL_DDR3L
492 Board config to use DDR3L. It can be enabled for SoCs with
493 DDR3L controllers.
494
495 CONFIG_SYS_FSL_DDR4
496 Board config to use DDR4. It can be enabled for SoCs with
497 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700498
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530499 CONFIG_SYS_FSL_IFC_BE
500 Defines the IFC controller register space as Big Endian
501
502 CONFIG_SYS_FSL_IFC_LE
503 Defines the IFC controller register space as Little Endian
504
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530505 CONFIG_SYS_FSL_IFC_CLK_DIV
506 Defines divider of platform clock(clock input to IFC controller).
507
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530508 CONFIG_SYS_FSL_LBC_CLK_DIV
509 Defines divider of platform clock(clock input to eLBC controller).
510
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530511 CONFIG_SYS_FSL_PBL_PBI
512 It enables addition of RCW (Power on reset configuration) in built image.
513 Please refer doc/README.pblimage for more details
514
515 CONFIG_SYS_FSL_PBL_RCW
516 It adds PBI(pre-boot instructions) commands in u-boot build image.
517 PBI commands can be used to configure SoC before it starts the execution.
518 Please refer doc/README.pblimage for more details
519
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530520 CONFIG_SPL_FSL_PBL
521 It adds a target to create boot binary having SPL binary in PBI format
522 concatenated with u-boot binary.
523
York Sun4e5b1bd2014-02-10 13:59:42 -0800524 CONFIG_SYS_FSL_DDR_BE
525 Defines the DDR controller register space as Big Endian
526
527 CONFIG_SYS_FSL_DDR_LE
528 Defines the DDR controller register space as Little Endian
529
York Sun6b9e3092014-02-10 13:59:43 -0800530 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
531 Physical address from the view of DDR controllers. It is the
532 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
533 it could be different for ARM SoCs.
534
York Sun6b1e1252014-02-10 13:59:44 -0800535 CONFIG_SYS_FSL_DDR_INTLV_256B
536 DDR controller interleaving on 256-byte. This is a special
537 interleaving mode, handled by Dickens for Freescale layerscape
538 SoCs with ARM core.
539
York Sun1d71efb2014-08-01 15:51:00 -0700540 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
541 Number of controllers used as main memory.
542
543 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
544 Number of controllers used for other than main memory.
545
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530546 CONFIG_SYS_FSL_HAS_DP_DDR
547 Defines the SoC has DP-DDR used for DPAA.
548
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530549 CONFIG_SYS_FSL_SEC_BE
550 Defines the SEC controller register space as Big Endian
551
552 CONFIG_SYS_FSL_SEC_LE
553 Defines the SEC controller register space as Little Endian
554
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Rieschb67d8812012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
York Sun207774b2015-03-20 19:28:08 -0700593 COUNTER_FREQUENCY
594 Generic timer clock source frequency.
595
596 COUNTER_FREQUENCY_REAL
597 Generic timer clock source frequency if the real clock is
598 different from COUNTER_FREQUENCY, and can only be determined
599 at run time.
600
Stephen Warren73c38932015-01-19 16:25:52 -0700601- Tegra SoC options:
602 CONFIG_TEGRA_SUPPORT_NON_SECURE
603
604 Support executing U-Boot in non-secure (NS) mode. Certain
605 impossible actions will be skipped if the CPU is in NS mode,
606 such as ARM architectural timer initialization.
607
wdenk5da627a2003-10-09 20:09:04 +0000608- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000609 CONFIG_CLOCKS_IN_MHZ
610
611 U-Boot stores all clock information in Hz
612 internally. For binary compatibility with older Linux
613 kernels (which expect the clocks passed in the
614 bd_info data to be in MHz) the environment variable
615 "clocks_in_mhz" can be defined so that U-Boot
616 converts clock data to MHZ before passing it to the
617 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000618 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100619 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000620 default environment.
621
wdenk5da627a2003-10-09 20:09:04 +0000622 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
623
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800624 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000625 expect it to be in bytes, others in MB.
626 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
627
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400628 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200629
630 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400631 passed using flattened device trees (based on open firmware
632 concepts).
633
634 CONFIG_OF_LIBFDT
635 * New libfdt-based support
636 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500637 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400638
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200639 OF_CPU - The proper name of the cpus node (only required for
640 MPC512X and MPC5xxx based boards).
641 OF_SOC - The proper name of the soc node (only required for
642 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200643 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600644 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200645
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200646 boards with QUICC Engines require OF_QE to set UCC MAC
647 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500648
Kumar Gala4e253132006-01-11 13:54:17 -0600649 CONFIG_OF_BOARD_SETUP
650
651 Board code has addition modification that it wants to make
652 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000653
Simon Glassc654b512014-10-23 18:58:54 -0600654 CONFIG_OF_SYSTEM_SETUP
655
656 Other code has addition modification that it wants to make
657 to the flat device tree before handing it off to the kernel.
658 This causes ft_system_setup() to be called before booting
659 the kernel.
660
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200661 CONFIG_OF_IDE_FIXUP
662
663 U-Boot can detect if an IDE device is present or not.
664 If not, and this new config option is activated, U-Boot
665 removes the ATA node from the DTS before booting Linux,
666 so the Linux IDE driver does not probe the device and
667 crash. This is needed for buggy hardware (uc101) where
668 no pull down resistor is connected to the signal IDE5V_DD7.
669
Igor Grinberg7eb29392011-07-14 05:45:07 +0000670 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
671
672 This setting is mandatory for all boards that have only one
673 machine type and must be used to specify the machine type
674 number as it appears in the ARM machine registry
675 (see http://www.arm.linux.org.uk/developer/machines/).
676 Only boards that have multiple machine types supported
677 in a single configuration file and the machine type is
678 runtime discoverable, do not have to use this setting.
679
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100680- vxWorks boot parameters:
681
682 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700683 environments variables: bootdev, bootfile, ipaddr, netmask,
684 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100685 It loads the vxWorks image pointed bootfile.
686
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100687 Note: If a "bootargs" environment is defined, it will overwride
688 the defaults discussed just above.
689
Aneesh V2c451f72011-06-16 23:30:47 +0000690- Cache Configuration:
691 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
692 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
693 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
694
Aneesh V93bc2192011-06-16 23:30:51 +0000695- Cache Configuration for ARM:
696 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
697 controller
698 CONFIG_SYS_PL310_BASE - Physical base address of PL310
699 controller register space
700
wdenk6705d812004-08-02 23:22:59 +0000701- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200702 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000703
704 Define this if you want support for Amba PrimeCell PL010 UARTs.
705
Andreas Engel48d01922008-09-08 14:30:53 +0200706 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000707
708 Define this if you want support for Amba PrimeCell PL011 UARTs.
709
710 CONFIG_PL011_CLOCK
711
712 If you have Amba PrimeCell PL011 UARTs, set this variable to
713 the clock speed of the UARTs.
714
715 CONFIG_PL01x_PORTS
716
717 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
718 define this to a list of base addresses for each (supported)
719 port. See e.g. include/configs/versatile.h
720
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400721 CONFIG_SERIAL_HW_FLOW_CONTROL
722
723 Define this variable to enable hw flow control in serial driver.
724 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000725
wdenkc6097192002-11-03 00:24:07 +0000726- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000727 Depending on board, define exactly one serial port
728 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
729 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
730 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000731
732 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
733 port routines must be defined elsewhere
734 (i.e. serial_init(), serial_getc(), ...)
735
wdenkc6097192002-11-03 00:24:07 +0000736- Console Baudrate:
737 CONFIG_BAUDRATE - in bps
738 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200739 CONFIG_SYS_BAUDRATE_TABLE, see below.
740 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000741
Heiko Schocherc92fac92009-01-30 12:55:38 +0100742- Console Rx buffer length
743 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
744 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100745 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100746 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
747 must be defined, to setup the maximum idle timeout for
748 the SMC.
749
wdenkc6097192002-11-03 00:24:07 +0000750- Autoboot Command:
751 CONFIG_BOOTCOMMAND
752 Only needed when CONFIG_BOOTDELAY is enabled;
753 define a command string that is automatically executed
754 when no character is read on the console interface
755 within "Boot Delay" after reset.
756
757 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000758 This can be used to pass arguments to the bootm
759 command. The value of CONFIG_BOOTARGS goes into the
760 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000761
762 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000763 The value of these goes into the environment as
764 "ramboot" and "nfsboot" respectively, and can be used
765 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200766 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000767
Heiko Schochereda0ba32013-11-04 14:04:59 +0100768- Bootcount:
769 CONFIG_BOOTCOUNT_LIMIT
770 Implements a mechanism for detecting a repeating reboot
771 cycle, see:
772 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
773
774 CONFIG_BOOTCOUNT_ENV
775 If no softreset save registers are found on the hardware
776 "bootcount" is stored in the environment. To prevent a
777 saveenv on all reboots, the environment variable
778 "upgrade_available" is used. If "upgrade_available" is
779 0, "bootcount" is always 0, if "upgrade_available" is
780 1 "bootcount" is incremented in the environment.
781 So the Userspace Applikation must set the "upgrade_available"
782 and "bootcount" variable to 0, if a boot was successfully.
783
wdenkc6097192002-11-03 00:24:07 +0000784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500818 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000819
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500820 The default command configuration includes all commands
821 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000822
Marek Vasutb401b732014-03-05 19:58:39 +0100823 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500825 CONFIG_CMD_BDI bdinfo
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400827 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500828 CONFIG_CMD_CACHE * icache, dcache
829 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500830 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500831 CONFIG_CMD_DHCP * DHCP support
832 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600833 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
834 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
835 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
836 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_DTT * Digital Therm and Thermostat
838 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500839 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500840 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanovaa9e6042016-04-16 17:55:03 +0300841 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500842 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600843 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600844 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500845 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500846 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000847 CONFIG_CMD_EXT2 * ext2 command support
848 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700849 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
850 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100851 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500852 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500853 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000854 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500855 CONFIG_CMD_FLASH flinfo, erase, protect
856 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200857 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500862 CONFIG_CMD_I2C * I2C serial bus support
863 CONFIG_CMD_IDE * IDE harddisk support
864 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000865 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200866 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -0600868 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500871 CONFIG_CMD_IRQ * irqinfo
872 CONFIG_CMD_ITEST Integer/string test of 2 values
873 CONFIG_CMD_JFFS2 * JFFS2 Support
874 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200875 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200880 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000884 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200885 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500886 CONFIG_CMD_MISC Misc functions like sleep etc
887 CONFIG_CMD_MMC * MMC memory mapped support
888 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200892 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600893 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000894 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500895 CONFIG_CMD_PCI * pciinfo
896 CONFIG_CMD_PCMCIA * PCMCIA support
897 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
898 host
899 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000900 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500901 CONFIG_CMD_REGINFO * Register dump
902 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000903 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500904 CONFIG_CMD_SAVES * save S record dump
Simon Glassc649e3c2016-05-01 11:36:02 -0600905 CONFIG_SCSI * SCSI Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500906 CONFIG_CMD_SDRAM * print SDRAM configuration information
907 (requires CONFIG_CMD_I2C)
908 CONFIG_CMD_SETGETDCR Support for DCR Register access
909 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700910 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200911 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400912 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800913 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200914 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000916 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000917 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000918 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
919 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500921 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000922 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200923 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +0200924 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000925
926 EXAMPLE: If you want all functions except of network
927 support you can write:
928
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500929 #include "config_cmd_all.h"
930 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000931
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400932 Other Commands:
933 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000934
935 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500936 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000937 what you (and your U-Boot users) are doing. Data
938 cache cannot be enabled on systems like the 8xx or
939 8260 (where accesses to the IMMR region must be
940 uncached), and it cannot be disabled on all other
941 systems where we (mis-) use the data cache to hold an
942 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000943
944
945 XXX - this list needs to get updated!
946
Simon Glass302a6482016-03-13 19:07:28 -0600947- Removal of commands
948 If no commands are needed to boot, you can disable
949 CONFIG_CMDLINE to remove them. In this case, the command line
950 will not be available, and when U-Boot wants to execute the
951 boot command (on start-up) it will call board_run_command()
952 instead. This can reduce image size significantly for very
953 simple boot procedures.
954
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000955- Regular expression support:
956 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200957 If this variable is defined, U-Boot is linked against
958 the SLRE (Super Light Regular Expression) library,
959 which adds regex support to some commands, as for
960 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000961
Simon Glass45ba8072011-10-15 05:48:20 +0000962- Device tree:
963 CONFIG_OF_CONTROL
964 If this variable is defined, U-Boot will use a device tree
965 to configure its devices, instead of relying on statically
966 compiled #defines in the board file. This option is
967 experimental and only available on a few boards. The device
968 tree is available in the global data as gd->fdt_blob.
969
Simon Glass2c0f79e2011-10-24 19:15:31 +0000970 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700971 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000972
973 CONFIG_OF_EMBED
974 If this variable is defined, U-Boot will embed a device tree
975 binary in its image. This device tree file should be in the
976 board directory and called <soc>-<board>.dts. The binary file
977 is then picked up in board_init_f() and made available through
978 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000979
Simon Glass2c0f79e2011-10-24 19:15:31 +0000980 CONFIG_OF_SEPARATE
981 If this variable is defined, U-Boot will build a device tree
982 binary. It will be called u-boot.dtb. Architecture-specific
983 code will locate it at run-time. Generally this works by:
984
985 cat u-boot.bin u-boot.dtb >image.bin
986
987 and in fact, U-Boot does this for you, creating a file called
988 u-boot-dtb.bin which is useful in the common case. You can
989 still use the individual files if you need something more
990 exotic.
991
Alex Deymo82f766d2017-04-02 01:25:20 -0700992 CONFIG_OF_BOARD
993 If this variable is defined, U-Boot will use the device tree
994 provided by the board at runtime instead of embedding one with
995 the image. Only boards defining board_fdt_blob_setup() support
996 this option (see include/fdtdec.h file).
997
wdenkc6097192002-11-03 00:24:07 +0000998- Watchdog:
999 CONFIG_WATCHDOG
1000 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001001 support for the SoC. There must be support in the SoC
1002 specific code for a watchdog. For the 8xx and 8260
1003 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1004 register. When supported for a specific SoC is
1005 available, then no further board specific code should
1006 be needed to use it.
1007
1008 CONFIG_HW_WATCHDOG
1009 When using a watchdog circuitry external to the used
1010 SoC, then define this variable and provide board
1011 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001012
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001013 CONFIG_AT91_HW_WDT_TIMEOUT
1014 specify the timeout in seconds. default 2 seconds.
1015
stroesec1551ea2003-04-04 15:53:41 +00001016- U-Boot Version:
1017 CONFIG_VERSION_VARIABLE
1018 If this variable is defined, an environment variable
1019 named "ver" is created by U-Boot showing the U-Boot
1020 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001021 Any change to this variable will be reverted at the
1022 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001023
wdenkc6097192002-11-03 00:24:07 +00001024- Real-Time Clock:
1025
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001027 has to be selected, too. Define exactly one of the
1028 following options:
1029
1030 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1031 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001032 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001033 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001034 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001035 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001036 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001037 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001038 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001039 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001040 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001041 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001042 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1043 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001044
wdenkb37c7e52003-06-30 16:24:52 +00001045 Note that if the RTC uses I2C, then the I2C interface
1046 must also be configured. See I2C Support, below.
1047
Peter Tysere92739d2008-12-17 16:36:21 -06001048- GPIO Support:
1049 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001050
Chris Packham5dec49c2010-12-19 10:12:13 +00001051 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1052 chip-ngpio pairs that tell the PCA953X driver the number of
1053 pins supported by a particular chip.
1054
Peter Tysere92739d2008-12-17 16:36:21 -06001055 Note that if the GPIO device uses I2C, then the I2C interface
1056 must also be configured. See I2C Support, below.
1057
Simon Glassaa532332014-06-11 23:29:41 -06001058- I/O tracing:
1059 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1060 accesses and can checksum them or write a list of them out
1061 to memory. See the 'iotrace' command for details. This is
1062 useful for testing device drivers since it can confirm that
1063 the driver behaves the same way before and after a code
1064 change. Currently this is supported on sandbox and arm. To
1065 add support for your architecture, add '#include <iotrace.h>'
1066 to the bottom of arch/<arch>/include/asm/io.h and test.
1067
1068 Example output from the 'iotrace stats' command is below.
1069 Note that if the trace buffer is exhausted, the checksum will
1070 still continue to operate.
1071
1072 iotrace is enabled
1073 Start: 10000000 (buffer start address)
1074 Size: 00010000 (buffer size)
1075 Offset: 00000120 (current buffer offset)
1076 Output: 10000120 (start + offset)
1077 Count: 00000018 (number of trace records)
1078 CRC32: 9526fb66 (CRC32 of all trace records)
1079
wdenkc6097192002-11-03 00:24:07 +00001080- Timestamp Support:
1081
wdenk43d96162003-03-06 00:02:04 +00001082 When CONFIG_TIMESTAMP is selected, the timestamp
1083 (date and time) of an image is printed by image
1084 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001085 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001086
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001087- Partition Labels (disklabels) Supported:
1088 Zero or more of the following:
1089 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1090 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1091 Intel architecture, USB sticks, etc.
1092 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1093 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1094 bootloader. Note 2TB partition limit; see
1095 disk/part_efi.c
1096 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001097
Wolfgang Denk218ca722008-03-26 10:40:12 +01001098 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001099 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001100 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001101
1102- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001103 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1104 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001105
wdenk4d13cba2004-03-14 14:09:05 +00001106 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1107 be performed by calling the function
1108 ide_set_reset(int reset)
1109 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001110
1111- ATAPI Support:
1112 CONFIG_ATAPI
1113
1114 Set this to enable ATAPI support.
1115
wdenkc40b2952004-03-13 23:29:43 +00001116- LBA48 Support
1117 CONFIG_LBA48
1118
1119 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001120 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001121 Whithout these , LBA48 support uses 32bit variables and will 'only'
1122 support disks up to 2.1TB.
1123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001124 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001125 When enabled, makes the IDE subsystem use 64bit sector addresses.
1126 Default is 32bit.
1127
wdenkc6097192002-11-03 00:24:07 +00001128- SCSI Support:
1129 At the moment only there is only support for the
1130 SYM53C8XX SCSI controller; define
1131 CONFIG_SCSI_SYM53C8XX to enable it.
1132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001133 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1134 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1135 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001136 maximum numbers of LUNs, SCSI ID's and target
1137 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001138 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001139
Wolfgang Denk93e14592013-10-04 17:43:24 +02001140 The environment variable 'scsidevs' is set to the number of
1141 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001142
wdenkc6097192002-11-03 00:24:07 +00001143- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001144 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001145 Support for Intel 8254x/8257x gigabit chips.
1146
1147 CONFIG_E1000_SPI
1148 Utility code for direct access to the SPI bus on Intel 8257x.
1149 This does not do anything useful unless you set at least one
1150 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1151
1152 CONFIG_E1000_SPI_GENERIC
1153 Allow generic access to the SPI bus on the Intel 8257x, for
1154 example with the "sspi" command.
1155
1156 CONFIG_CMD_E1000
1157 Management command for E1000 devices. When used on devices
1158 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001159
wdenkc6097192002-11-03 00:24:07 +00001160 CONFIG_EEPRO100
1161 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001162 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001163 write routine for first time initialisation.
1164
1165 CONFIG_TULIP
1166 Support for Digital 2114x chips.
1167 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1168 modem chip initialisation (KS8761/QS6611).
1169
1170 CONFIG_NATSEMI
1171 Support for National dp83815 chips.
1172
1173 CONFIG_NS8382X
1174 Support for National dp8382[01] gigabit chips.
1175
wdenk45219c42003-05-12 21:50:16 +00001176- NETWORK Support (other):
1177
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001178 CONFIG_DRIVER_AT91EMAC
1179 Support for AT91RM9200 EMAC.
1180
1181 CONFIG_RMII
1182 Define this to use reduced MII inteface
1183
1184 CONFIG_DRIVER_AT91EMAC_QUIET
1185 If this defined, the driver is quiet.
1186 The driver doen't show link status messages.
1187
Rob Herringefdd7312011-12-15 11:15:49 +00001188 CONFIG_CALXEDA_XGMAC
1189 Support for the Calxeda XGMAC device
1190
Ashok3bb46d22012-10-15 06:20:47 +00001191 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001192 Support for SMSC's LAN91C96 chips.
1193
wdenk45219c42003-05-12 21:50:16 +00001194 CONFIG_LAN91C96_USE_32_BIT
1195 Define this to enable 32 bit addressing
1196
Ashok3bb46d22012-10-15 06:20:47 +00001197 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001198 Support for SMSC's LAN91C111 chip
1199
1200 CONFIG_SMC91111_BASE
1201 Define this to hold the physical address
1202 of the device (I/O space)
1203
1204 CONFIG_SMC_USE_32_BIT
1205 Define this if data bus is 32 bits
1206
1207 CONFIG_SMC_USE_IOFUNCS
1208 Define this to use i/o functions instead of macros
1209 (some hardware wont work with macros)
1210
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001211 CONFIG_DRIVER_TI_EMAC
1212 Support for davinci emac
1213
1214 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1215 Define this if you have more then 3 PHYs.
1216
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001217 CONFIG_FTGMAC100
1218 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1219
1220 CONFIG_FTGMAC100_EGIGA
1221 Define this to use GE link update with gigabit PHY.
1222 Define this if FTGMAC100 is connected to gigabit PHY.
1223 If your system has 10/100 PHY only, it might not occur
1224 wrong behavior. Because PHY usually return timeout or
1225 useless data when polling gigabit status and gigabit
1226 control registers. This behavior won't affect the
1227 correctnessof 10/100 link speed update.
1228
Mike Rapoportc2fff332009-11-11 10:03:03 +02001229 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001230 Support for SMSC's LAN911x and LAN921x chips
1231
Mike Rapoportc2fff332009-11-11 10:03:03 +02001232 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001233 Define this to hold the physical address
1234 of the device (I/O space)
1235
Mike Rapoportc2fff332009-11-11 10:03:03 +02001236 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001237 Define this if data bus is 32 bits
1238
Mike Rapoportc2fff332009-11-11 10:03:03 +02001239 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001240 Define this if data bus is 16 bits. If your processor
1241 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001242 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001243
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001244 CONFIG_SH_ETHER
1245 Support for Renesas on-chip Ethernet controller
1246
1247 CONFIG_SH_ETHER_USE_PORT
1248 Define the number of ports to be used
1249
1250 CONFIG_SH_ETHER_PHY_ADDR
1251 Define the ETH PHY's address
1252
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001253 CONFIG_SH_ETHER_CACHE_WRITEBACK
1254 If this option is set, the driver enables cache flush.
1255
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001256- PWM Support:
1257 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001258 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001259
Vadim Bendebury5e124722011-10-17 08:36:14 +00001260- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001261 CONFIG_TPM
1262 Support TPM devices.
1263
Christophe Ricard0766ad22015-10-06 22:54:41 +02001264 CONFIG_TPM_TIS_INFINEON
1265 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001266 per system is supported at this time.
1267
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001268 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1269 Define the burst count bytes upper limit
1270
Christophe Ricard3aa74082016-01-21 23:27:13 +01001271 CONFIG_TPM_ST33ZP24
1272 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1273
1274 CONFIG_TPM_ST33ZP24_I2C
1275 Support for STMicroelectronics ST33ZP24 I2C devices.
1276 Requires TPM_ST33ZP24 and I2C.
1277
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001278 CONFIG_TPM_ST33ZP24_SPI
1279 Support for STMicroelectronics ST33ZP24 SPI devices.
1280 Requires TPM_ST33ZP24 and SPI.
1281
Dirk Eibachc01939c2013-06-26 15:55:15 +02001282 CONFIG_TPM_ATMEL_TWI
1283 Support for Atmel TWI TPM device. Requires I2C support.
1284
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001285 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001286 Support for generic parallel port TPM devices. Only one device
1287 per system is supported at this time.
1288
1289 CONFIG_TPM_TIS_BASE_ADDRESS
1290 Base address where the generic TPM device is mapped
1291 to. Contemporary x86 systems usually map it at
1292 0xfed40000.
1293
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001294 CONFIG_CMD_TPM
1295 Add tpm monitor functions.
1296 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1297 provides monitor access to authorized functions.
1298
1299 CONFIG_TPM
1300 Define this to enable the TPM support library which provides
1301 functional interfaces to some TPM commands.
1302 Requires support for a TPM device.
1303
1304 CONFIG_TPM_AUTH_SESSIONS
1305 Define this to enable authorized functions in the TPM library.
1306 Requires CONFIG_TPM and CONFIG_SHA1.
1307
wdenkc6097192002-11-03 00:24:07 +00001308- USB Support:
1309 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001310 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001311 CONFIG_USB_UHCI to enable it.
1312 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001313 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001314 storage devices.
1315 Note:
1316 Supported are USB Keyboards and USB Floppy drives
1317 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001318 MPC5200 USB requires additional defines:
1319 CONFIG_USB_CLOCK
1320 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001321 CONFIG_PSC3_USB
1322 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001323 CONFIG_USB_CONFIG
1324 for differential drivers: 0x00001000
1325 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001326 for differential drivers on PSC3: 0x00000100
1327 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001328 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001329 May be defined to allow interrupt polling
1330 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001331
Simon Glass9ab4ce22012-02-27 10:52:47 +00001332 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1333 txfilltuning field in the EHCI controller on reset.
1334
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001335 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1336 HW module registers.
1337
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001338- USB Device:
1339 Define the below if you wish to use the USB console.
1340 Once firmware is rebuilt from a serial console issue the
1341 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001342 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001343 it has found a new device. The environment variable usbtty
1344 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001345 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001346 Common Device Class Abstract Control Model serial device.
1347 If you select usbtty = gserial you should be able to enumerate
1348 a Linux host by
1349 # modprobe usbserial vendor=0xVendorID product=0xProductID
1350 else if using cdc_acm, simply setting the environment
1351 variable usbtty to be cdc_acm should suffice. The following
1352 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001353
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001354 CONFIG_USB_DEVICE
1355 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001356
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001357 CONFIG_USB_TTY
1358 Define this to have a tty type of device available to
1359 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001360
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301361 CONFIG_USBD_HS
1362 Define this to enable the high speed support for usb
1363 device and usbtty. If this feature is enabled, a routine
1364 int is_usbd_high_speed(void)
1365 also needs to be defined by the driver to dynamically poll
1366 whether the enumeration has succeded at high speed or full
1367 speed.
1368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001369 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001370 Define this if you want stdin, stdout &/or stderr to
1371 be set to usbtty.
1372
1373 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001374 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001375 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001376 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001377
Wolfgang Denk386eda02006-06-14 18:14:56 +02001378 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001379 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001380 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001381 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1382 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1383 should pretend to be a Linux device to it's target host.
1384
1385 CONFIG_USBD_MANUFACTURER
1386 Define this string as the name of your company for
1387 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001388
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001389 CONFIG_USBD_PRODUCT_NAME
1390 Define this string as the name of your product
1391 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1392
1393 CONFIG_USBD_VENDORID
1394 Define this as your assigned Vendor ID from the USB
1395 Implementors Forum. This *must* be a genuine Vendor ID
1396 to avoid polluting the USB namespace.
1397 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001398
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001399 CONFIG_USBD_PRODUCTID
1400 Define this as the unique Product ID
1401 for your device
1402 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001403
Igor Grinbergd70a5602011-12-12 12:08:35 +02001404- ULPI Layer Support:
1405 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1406 the generic ULPI layer. The generic layer accesses the ULPI PHY
1407 via the platform viewport, so you need both the genric layer and
1408 the viewport enabled. Currently only Chipidea/ARC based
1409 viewport is supported.
1410 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1411 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001412 If your ULPI phy needs a different reference clock than the
1413 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1414 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001415
1416- MMC Support:
1417 The MMC controller on the Intel PXA is supported. To
1418 enable this define CONFIG_MMC. The MMC can be
1419 accessed from the boot prompt by mapping the device
1420 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001421 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1422 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001423
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001424 CONFIG_SH_MMCIF
1425 Support for Renesas on-chip MMCIF controller
1426
1427 CONFIG_SH_MMCIF_ADDR
1428 Define the base address of MMCIF registers
1429
1430 CONFIG_SH_MMCIF_CLK
1431 Define the clock frequency for MMCIF
1432
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001433 CONFIG_SUPPORT_EMMC_BOOT
1434 Enable some additional features of the eMMC boot partitions.
1435
1436 CONFIG_SUPPORT_EMMC_RPMB
1437 Enable the commands for reading, writing and programming the
1438 key for the Replay Protection Memory Block partition in eMMC.
1439
Tom Rinib3ba6e92013-03-14 05:32:47 +00001440- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001441 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001442 This enables the USB portion of the DFU USB class
1443
1444 CONFIG_CMD_DFU
1445 This enables the command "dfu" which is used to have
1446 U-Boot create a DFU class device via USB. This command
1447 requires that the "dfu_alt_info" environment variable be
1448 set and define the alt settings to expose to the host.
1449
1450 CONFIG_DFU_MMC
1451 This enables support for exposing (e)MMC devices via DFU.
1452
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001453 CONFIG_DFU_NAND
1454 This enables support for exposing NAND devices via DFU.
1455
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301456 CONFIG_DFU_RAM
1457 This enables support for exposing RAM via DFU.
1458 Note: DFU spec refer to non-volatile memory usage, but
1459 allow usages beyond the scope of spec - here RAM usage,
1460 one that would help mostly the developer.
1461
Heiko Schochere7e75c72013-06-12 06:05:51 +02001462 CONFIG_SYS_DFU_DATA_BUF_SIZE
1463 Dfu transfer uses a buffer before writing data to the
1464 raw storage device. Make the size (in bytes) of this buffer
1465 configurable. The size of this buffer is also configurable
1466 through the "dfu_bufsiz" environment variable.
1467
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001468 CONFIG_SYS_DFU_MAX_FILE_SIZE
1469 When updating files rather than the raw storage device,
1470 we use a static buffer to copy the file into and then write
1471 the buffer once we've been given the whole file. Define
1472 this to the maximum filesize (in bytes) for the buffer.
1473 Default is 4 MiB if undefined.
1474
Heiko Schocher001a8312014-03-18 08:09:56 +01001475 DFU_DEFAULT_POLL_TIMEOUT
1476 Poll timeout [ms], is the timeout a device can send to the
1477 host. The host must wait for this timeout before sending
1478 a subsequent DFU_GET_STATUS request to the device.
1479
1480 DFU_MANIFEST_POLL_TIMEOUT
1481 Poll timeout [ms], which the device sends to the host when
1482 entering dfuMANIFEST state. Host waits this timeout, before
1483 sending again an USB request to the device.
1484
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001485- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001486 CONFIG_USB_FUNCTION_FASTBOOT
1487 This enables the USB part of the fastboot gadget
1488
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001489 CONFIG_CMD_FASTBOOT
1490 This enables the command "fastboot" which enables the Android
1491 fastboot mode for the platform's USB device. Fastboot is a USB
1492 protocol for downloading images, flashing and device control
1493 used on Android devices.
1494 See doc/README.android-fastboot for more information.
1495
1496 CONFIG_ANDROID_BOOT_IMAGE
1497 This enables support for booting images which use the Android
1498 image format header.
1499
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001500 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001501 The fastboot protocol requires a large memory buffer for
1502 downloads. Define this to the starting RAM address to use for
1503 downloaded images.
1504
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001505 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001506 The fastboot protocol requires a large memory buffer for
1507 downloads. This buffer should be as large as possible for a
1508 platform. Define this to the size available RAM for fastboot.
1509
Steve Raed1b5ed02014-08-26 11:47:28 -07001510 CONFIG_FASTBOOT_FLASH
1511 The fastboot protocol includes a "flash" command for writing
1512 the downloaded image to a non-volatile storage device. Define
1513 this to enable the "fastboot flash" command.
1514
1515 CONFIG_FASTBOOT_FLASH_MMC_DEV
1516 The fastboot "flash" command requires additional information
1517 regarding the non-volatile storage device. Define this to
1518 the eMMC device that fastboot should use to store the image.
1519
Steve Rae0ff7e582014-12-12 15:51:54 -08001520 CONFIG_FASTBOOT_GPT_NAME
1521 The fastboot "flash" command supports writing the downloaded
1522 image to the Protective MBR and the Primary GUID Partition
1523 Table. (Additionally, this downloaded image is post-processed
1524 to generate and write the Backup GUID Partition Table.)
1525 This occurs when the specified "partition name" on the
1526 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001527 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001528
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001529 CONFIG_FASTBOOT_MBR_NAME
1530 The fastboot "flash" command supports writing the downloaded
1531 image to DOS MBR.
1532 This occurs when the "partition name" specified on the
1533 "fastboot flash" command line matches this value.
1534 If not defined the default value "mbr" is used.
1535
wdenk6705d812004-08-02 23:22:59 +00001536- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001537 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001538 Define these for a default partition on a NAND device
1539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001540 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1541 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001542 Define these for a default partition on a NOR device
1543
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001544- FAT(File Allocation Table) filesystem write function support:
1545 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001546
1547 Define this to enable support for saving memory data as a
1548 file in FAT formatted partition.
1549
1550 This will also enable the command "fatwrite" enabling the
1551 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001552
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301553- FAT(File Allocation Table) filesystem cluster size:
1554 CONFIG_FS_FAT_MAX_CLUSTSIZE
1555
1556 Define the max cluster size for fat operations else
1557 a default value of 65536 will be defined.
1558
wdenkc6097192002-11-03 00:24:07 +00001559- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001560 See Kconfig help for available keyboard drivers.
1561
1562 CONFIG_KEYBOARD
1563
1564 Define this to enable a custom keyboard support.
1565 This simply calls drv_keyboard_init() which must be
1566 defined in your board-specific files. This option is deprecated
1567 and is only used by novena. For new boards, use driver model
1568 instead.
wdenkc6097192002-11-03 00:24:07 +00001569
1570- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001571 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001572 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001573 SOCs that have a DIU should define this macro to enable DIU
1574 support, and should also define these other macros:
1575
1576 CONFIG_SYS_DIU_ADDR
1577 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001578 CONFIG_CFB_CONSOLE
1579 CONFIG_VIDEO_SW_CURSOR
1580 CONFIG_VGA_AS_SINGLE_DEVICE
1581 CONFIG_VIDEO_LOGO
1582 CONFIG_VIDEO_BMP_LOGO
1583
Timur Tabiba8e76b2011-04-11 14:18:22 -05001584 The DIU driver will look for the 'video-mode' environment
1585 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001586 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001587 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001588
wdenkc6097192002-11-03 00:24:07 +00001589- LCD Support: CONFIG_LCD
1590
1591 Define this to enable LCD support (for output to LCD
1592 display); also select one of the supported displays
1593 by defining one of these:
1594
Stelian Pop39cf4802008-05-09 21:57:18 +02001595 CONFIG_ATMEL_LCD:
1596
1597 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1598
wdenkfd3103b2003-11-25 16:55:19 +00001599 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001600
wdenkfd3103b2003-11-25 16:55:19 +00001601 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001602
wdenkfd3103b2003-11-25 16:55:19 +00001603 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001604
wdenkfd3103b2003-11-25 16:55:19 +00001605 NEC NL6448BC20-08. 6.5", 640x480.
1606 Active, color, single scan.
1607
1608 CONFIG_NEC_NL6448BC33_54
1609
1610 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001611 Active, color, single scan.
1612
1613 CONFIG_SHARP_16x9
1614
1615 Sharp 320x240. Active, color, single scan.
1616 It isn't 16x9, and I am not sure what it is.
1617
1618 CONFIG_SHARP_LQ64D341
1619
1620 Sharp LQ64D341 display, 640x480.
1621 Active, color, single scan.
1622
1623 CONFIG_HLD1045
1624
1625 HLD1045 display, 640x480.
1626 Active, color, single scan.
1627
1628 CONFIG_OPTREX_BW
1629
1630 Optrex CBL50840-2 NF-FW 99 22 M5
1631 or
1632 Hitachi LMG6912RPFC-00T
1633 or
1634 Hitachi SP14Q002
1635
1636 320x240. Black & white.
1637
Simon Glass676d3192012-10-17 13:24:54 +00001638 CONFIG_LCD_ALIGNMENT
1639
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001640 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001641 defined then the LCD will be aligned to this value instead.
1642 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1643 here, since it is cheaper to change data cache settings on
1644 a per-section basis.
1645
1646
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001647 CONFIG_LCD_ROTATION
1648
1649 Sometimes, for example if the display is mounted in portrait
1650 mode or even if it's mounted landscape but rotated by 180degree,
1651 we need to rotate our content of the display relative to the
1652 framebuffer, so that user can read the messages which are
1653 printed out.
1654 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1655 initialized with a given rotation from "vl_rot" out of
1656 "vidinfo_t" which is provided by the board specific code.
1657 The value for vl_rot is coded as following (matching to
1658 fbcon=rotate:<n> linux-kernel commandline):
1659 0 = no rotation respectively 0 degree
1660 1 = 90 degree rotation
1661 2 = 180 degree rotation
1662 3 = 270 degree rotation
1663
1664 If CONFIG_LCD_ROTATION is not defined, the console will be
1665 initialized with 0degree rotation.
1666
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001667 CONFIG_LCD_BMP_RLE8
1668
1669 Support drawing of RLE8-compressed bitmaps on the LCD.
1670
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001671 CONFIG_I2C_EDID
1672
1673 Enables an 'i2c edid' command which can read EDID
1674 information over I2C from an attached LCD display.
1675
wdenk7152b1d2003-09-05 23:19:14 +00001676- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001677
wdenk8bde7f72003-06-27 21:31:46 +00001678 If this option is set, the environment is checked for
1679 a variable "splashimage". If found, the usual display
1680 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001681 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001682 specified in "splashimage" is loaded instead. The
1683 console is redirected to the "nulldev", too. This
1684 allows for a "silent" boot where a splash screen is
1685 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001686
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001687 CONFIG_SPLASHIMAGE_GUARD
1688
1689 If this option is set, then U-Boot will prevent the environment
1690 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001691 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001692 This option is useful for targets where, due to alignment
1693 restrictions, an improperly aligned BMP image will cause a data
1694 abort. If you think you will not have problems with unaligned
1695 accesses (for example because your toolchain prevents them)
1696 there is no need to set this option.
1697
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001698 CONFIG_SPLASH_SCREEN_ALIGN
1699
1700 If this option is set the splash image can be freely positioned
1701 on the screen. Environment variable "splashpos" specifies the
1702 position as "x,y". If a positive number is given it is used as
1703 number of pixel from left/top. If a negative number is given it
1704 is used as number of pixel from right/bottom. You can also
1705 specify 'm' for centering the image.
1706
1707 Example:
1708 setenv splashpos m,m
1709 => image at center of screen
1710
1711 setenv splashpos 30,20
1712 => image at x = 30 and y = 20
1713
1714 setenv splashpos -10,m
1715 => vertically centered image
1716 at x = dspWidth - bmpWidth - 9
1717
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001718- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1719
1720 If this option is set, additionally to standard BMP
1721 images, gzipped BMP images can be displayed via the
1722 splashscreen support or the bmp command.
1723
Anatolij Gustschind5011762010-03-15 14:50:25 +01001724- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1725
1726 If this option is set, 8-bit RLE compressed BMP images
1727 can be displayed via the splashscreen support or the
1728 bmp command.
1729
wdenkc29fdfc2003-08-29 20:57:53 +00001730- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001731 CONFIG_GZIP
1732
1733 Enabled by default to support gzip compressed images.
1734
wdenkc29fdfc2003-08-29 20:57:53 +00001735 CONFIG_BZIP2
1736
1737 If this option is set, support for bzip2 compressed
1738 images is included. If not, only uncompressed and gzip
1739 compressed images are supported.
1740
wdenk42d1f032003-10-15 23:53:47 +00001741 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001742 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001743 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001744
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001745 CONFIG_LZMA
1746
1747 If this option is set, support for lzma compressed
1748 images is included.
1749
1750 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1751 requires an amount of dynamic memory that is given by the
1752 formula:
1753
1754 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1755
1756 Where lc and lp stand for, respectively, Literal context bits
1757 and Literal pos bits.
1758
1759 This value is upper-bounded by 14MB in the worst case. Anyway,
1760 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1761 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1762 a very small buffer.
1763
1764 Use the lzmainfo tool to determinate the lc and lp values and
1765 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001766 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001767
Kees Cook8ef70472013-08-16 07:59:12 -07001768 CONFIG_LZO
1769
1770 If this option is set, support for LZO compressed images
1771 is included.
1772
wdenk17ea1172004-06-06 21:51:03 +00001773- MII/PHY support:
1774 CONFIG_PHY_ADDR
1775
1776 The address of PHY on MII bus.
1777
1778 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1779
1780 The clock frequency of the MII bus
1781
1782 CONFIG_PHY_GIGE
1783
1784 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001785 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001786
1787 CONFIG_PHY_RESET_DELAY
1788
1789 Some PHY like Intel LXT971A need extra delay after
1790 reset before any MII register access is possible.
1791 For such PHY, set this option to the usec delay
1792 required. (minimum 300usec for LXT971A)
1793
1794 CONFIG_PHY_CMD_DELAY (ppc4xx)
1795
1796 Some PHY like Intel LXT971A need extra delay after
1797 command issued before MII status register can be read
1798
wdenkc6097192002-11-03 00:24:07 +00001799- IP address:
1800 CONFIG_IPADDR
1801
1802 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001803 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001804 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001805 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001806
1807- Server IP address:
1808 CONFIG_SERVERIP
1809
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001810 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001811 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001812 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001813
Robin Getz97cfe862009-07-21 12:15:28 -04001814 CONFIG_KEEP_SERVERADDR
1815
1816 Keeps the server's MAC address, in the env 'serveraddr'
1817 for passing to bootargs (like Linux's netconsole option)
1818
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001819- Gateway IP address:
1820 CONFIG_GATEWAYIP
1821
1822 Defines a default value for the IP address of the
1823 default router where packets to other networks are
1824 sent to.
1825 (Environment variable "gatewayip")
1826
1827- Subnet mask:
1828 CONFIG_NETMASK
1829
1830 Defines a default value for the subnet mask (or
1831 routing prefix) which is used to determine if an IP
1832 address belongs to the local subnet or needs to be
1833 forwarded through a router.
1834 (Environment variable "netmask")
1835
David Updegraff53a5c422007-06-11 10:41:07 -05001836- Multicast TFTP Mode:
1837 CONFIG_MCAST_TFTP
1838
1839 Defines whether you want to support multicast TFTP as per
1840 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001841 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001842 driver in use must provide a function: mcast() to join/leave a
1843 multicast group.
1844
wdenkc6097192002-11-03 00:24:07 +00001845- BOOTP Recovery Mode:
1846 CONFIG_BOOTP_RANDOM_DELAY
1847
1848 If you have many targets in a network that try to
1849 boot using BOOTP, you may want to avoid that all
1850 systems send out BOOTP requests at precisely the same
1851 moment (which would happen for instance at recovery
1852 from a power failure, when all systems will try to
1853 boot, thus flooding the BOOTP server. Defining
1854 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1855 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001856 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001857
1858 1st BOOTP request: delay 0 ... 1 sec
1859 2nd BOOTP request: delay 0 ... 2 sec
1860 3rd BOOTP request: delay 0 ... 4 sec
1861 4th and following
1862 BOOTP requests: delay 0 ... 8 sec
1863
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001864 CONFIG_BOOTP_ID_CACHE_SIZE
1865
1866 BOOTP packets are uniquely identified using a 32-bit ID. The
1867 server will copy the ID from client requests to responses and
1868 U-Boot will use this to determine if it is the destination of
1869 an incoming response. Some servers will check that addresses
1870 aren't in use before handing them out (usually using an ARP
1871 ping) and therefore take up to a few hundred milliseconds to
1872 respond. Network congestion may also influence the time it
1873 takes for a response to make it back to the client. If that
1874 time is too long, U-Boot will retransmit requests. In order
1875 to allow earlier responses to still be accepted after these
1876 retransmissions, U-Boot's BOOTP client keeps a small cache of
1877 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1878 cache. The default is to keep IDs for up to four outstanding
1879 requests. Increasing this will allow U-Boot to accept offers
1880 from a BOOTP client in networks with unusually high latency.
1881
stroesefe389a82003-08-28 14:17:32 +00001882- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001883 You can fine tune the DHCP functionality by defining
1884 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001885
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001886 CONFIG_BOOTP_SUBNETMASK
1887 CONFIG_BOOTP_GATEWAY
1888 CONFIG_BOOTP_HOSTNAME
1889 CONFIG_BOOTP_NISDOMAIN
1890 CONFIG_BOOTP_BOOTPATH
1891 CONFIG_BOOTP_BOOTFILESIZE
1892 CONFIG_BOOTP_DNS
1893 CONFIG_BOOTP_DNS2
1894 CONFIG_BOOTP_SEND_HOSTNAME
1895 CONFIG_BOOTP_NTPSERVER
1896 CONFIG_BOOTP_TIMEOFFSET
1897 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001898 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001899
Wilson Callan5d110f02007-07-28 10:56:13 -04001900 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1901 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001902
Joe Hershberger2c00e092012-05-23 07:59:19 +00001903 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1904 after the configured retry count, the call will fail
1905 instead of starting over. This can be used to fail over
1906 to Link-local IP address configuration if the DHCP server
1907 is not available.
1908
stroesefe389a82003-08-28 14:17:32 +00001909 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1910 serverip from a DHCP server, it is possible that more
1911 than one DNS serverip is offered to the client.
1912 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1913 serverip will be stored in the additional environment
1914 variable "dnsip2". The first DNS serverip is always
1915 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001916 is defined.
stroesefe389a82003-08-28 14:17:32 +00001917
1918 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1919 to do a dynamic update of a DNS server. To do this, they
1920 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001921 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001922 of the "hostname" environment variable is passed as
1923 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001924
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001925 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1926
1927 A 32bit value in microseconds for a delay between
1928 receiving a "DHCP Offer" and sending the "DHCP Request".
1929 This fixes a problem with certain DHCP servers that don't
1930 respond 100% of the time to a "DHCP request". E.g. On an
1931 AT91RM9200 processor running at 180MHz, this delay needed
1932 to be *at least* 15,000 usec before a Windows Server 2003
1933 DHCP server would reply 100% of the time. I recommend at
1934 least 50,000 usec to be safe. The alternative is to hope
1935 that one of the retries will be successful but note that
1936 the DHCP timeout and retry process takes a longer than
1937 this delay.
1938
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001939 - Link-local IP address negotiation:
1940 Negotiate with other link-local clients on the local network
1941 for an address that doesn't require explicit configuration.
1942 This is especially useful if a DHCP server cannot be guaranteed
1943 to exist in all environments that the device must operate.
1944
1945 See doc/README.link-local for more information.
1946
wdenka3d991b2004-04-15 21:48:45 +00001947 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001948 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001949
1950 The device id used in CDP trigger frames.
1951
1952 CONFIG_CDP_DEVICE_ID_PREFIX
1953
1954 A two character string which is prefixed to the MAC address
1955 of the device.
1956
1957 CONFIG_CDP_PORT_ID
1958
1959 A printf format string which contains the ascii name of
1960 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001961 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001962
1963 CONFIG_CDP_CAPABILITIES
1964
1965 A 32bit integer which indicates the device capabilities;
1966 0x00000010 for a normal host which does not forwards.
1967
1968 CONFIG_CDP_VERSION
1969
1970 An ascii string containing the version of the software.
1971
1972 CONFIG_CDP_PLATFORM
1973
1974 An ascii string containing the name of the platform.
1975
1976 CONFIG_CDP_TRIGGER
1977
1978 A 32bit integer sent on the trigger.
1979
1980 CONFIG_CDP_POWER_CONSUMPTION
1981
1982 A 16bit integer containing the power consumption of the
1983 device in .1 of milliwatts.
1984
1985 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1986
1987 A byte containing the id of the VLAN.
1988
Uri Mashiach79267ed2017-01-19 10:51:05 +02001989- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001990
1991 Several configurations allow to display the current
1992 status using a LED. For instance, the LED will blink
1993 fast while running U-Boot code, stop blinking as
1994 soon as a reply to a BOOTP request was received, and
1995 start blinking slow once the Linux kernel is running
1996 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001997 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001998 feature in U-Boot.
1999
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002000 Additional options:
2001
Uri Mashiach79267ed2017-01-19 10:51:05 +02002002 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002003 The status LED can be connected to a GPIO pin.
2004 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02002005 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002006 to include the gpio_led driver in the U-Boot binary.
2007
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002008 CONFIG_GPIO_LED_INVERTED_TABLE
2009 Some GPIO connected LEDs may have inverted polarity in which
2010 case the GPIO high value corresponds to LED off state and
2011 GPIO low value corresponds to LED on state.
2012 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2013 with a list of GPIO LEDs that have inverted polarity.
2014
wdenkc6097192002-11-03 00:24:07 +00002015- CAN Support: CONFIG_CAN_DRIVER
2016
2017 Defining CONFIG_CAN_DRIVER enables CAN driver support
2018 on those systems that support this (optional)
2019 feature, like the TQM8xxL modules.
2020
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002021- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002022
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002023 This enable the NEW i2c subsystem, and will allow you to use
2024 i2c commands at the u-boot command line (as long as you set
2025 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2026 based realtime clock chips or other i2c devices. See
2027 common/cmd_i2c.c for a description of the command line
2028 interface.
2029
2030 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002031 - drivers/i2c/soft_i2c.c:
2032 - activate first bus with CONFIG_SYS_I2C_SOFT define
2033 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2034 for defining speed and slave address
2035 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2036 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2037 for defining speed and slave address
2038 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2039 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2040 for defining speed and slave address
2041 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2042 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2043 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002044
Heiko Schocher00f792e2012-10-24 13:48:22 +02002045 - drivers/i2c/fsl_i2c.c:
2046 - activate i2c driver with CONFIG_SYS_I2C_FSL
2047 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2048 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2049 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2050 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002051 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002052 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2053 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2054 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2055 second bus.
2056
Simon Glass1f2ba722012-10-30 07:28:53 +00002057 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002058 - activate this driver with CONFIG_SYS_I2C_TEGRA
2059 - This driver adds 4 i2c buses with a fix speed from
2060 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002061
Dirk Eibach880540d2013-04-25 02:40:01 +00002062 - drivers/i2c/ppc4xx_i2c.c
2063 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2064 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2065 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2066
tremfac96402013-09-21 18:13:35 +02002067 - drivers/i2c/i2c_mxc.c
2068 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002069 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2070 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2071 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2072 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002073 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2074 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2075 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2076 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2077 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2078 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002079 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2080 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002081 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002082 for speed, and 0 for slave.
2083
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002084 - drivers/i2c/rcar_i2c.c:
2085 - activate this driver with CONFIG_SYS_I2C_RCAR
2086 - This driver adds 4 i2c buses
2087
2088 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2089 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2090 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2091 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2092 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2093 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2094 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2095 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2096 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2097
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002098 - drivers/i2c/sh_i2c.c:
2099 - activate this driver with CONFIG_SYS_I2C_SH
2100 - This driver adds from 2 to 5 i2c buses
2101
2102 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2103 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2104 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2105 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2106 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2107 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2108 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2109 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2110 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2111 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002112 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002113
Heiko Schocher6789e842013-10-22 11:03:18 +02002114 - drivers/i2c/omap24xx_i2c.c
2115 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2116 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2117 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2118 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2119 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2120 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2121 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2122 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2123 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2124 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2125 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2126
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002127 - drivers/i2c/zynq_i2c.c
2128 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2129 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2130 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2131
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302132 - drivers/i2c/s3c24x0_i2c.c:
2133 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2134 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2135 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2136 with a fix speed from 100000 and the slave addr 0!
2137
Dirk Eibachb46226b2014-07-03 09:28:18 +02002138 - drivers/i2c/ihs_i2c.c
2139 - activate this driver with CONFIG_SYS_I2C_IHS
2140 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2141 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2142 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2143 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2144 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2145 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2146 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2147 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2148 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2149 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2150 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2151 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002152 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2153 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2154 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2155 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2156 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2157 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2158 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2159 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2160 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002161
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002162 additional defines:
2163
2164 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06002165 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002166
2167 CONFIG_SYS_I2C_DIRECT_BUS
2168 define this, if you don't use i2c muxes on your hardware.
2169 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2170 omit this define.
2171
2172 CONFIG_SYS_I2C_MAX_HOPS
2173 define how many muxes are maximal consecutively connected
2174 on one i2c bus. If you not use i2c muxes, omit this
2175 define.
2176
2177 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002178 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002179 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2180 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2181 CONFIG_SYS_NUM_I2C_BUSES = 9:
2182
2183 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2184 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2185 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2186 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2187 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2188 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2189 {1, {I2C_NULL_HOP}}, \
2190 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2191 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2192 }
2193
2194 which defines
2195 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002196 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2197 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2198 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2199 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2200 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002201 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002202 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2203 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002204
2205 If you do not have i2c muxes on your board, omit this define.
2206
Simon Glass69153982017-05-12 21:09:56 -06002207----under removal:
2208
2209- Legacy I2C Support: CONFIG_SOFT_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002210
2211 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2212 provides the following compelling advantages:
2213
2214 - more than one i2c adapter is usable
2215 - approved multibus support
2216 - better i2c mux support
2217
Simon Glass69153982017-05-12 21:09:56 -06002218 ** CONFIG_SOFT_I2C is now being removed **
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002219
Simon Glass69153982017-05-12 21:09:56 -06002220 With CONFIG_SOFT_I2C you will need to define
2221 CONFIG_SYS_I2C_SPEED to be the frequency (in Hz) at which you
2222 wish your i2c bus to run and CONFIG_SYS_I2C_SLAVE to be the
2223 address of this node (ie the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002224
Peter Tyser8d321b82010-04-12 22:28:21 -05002225 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002226 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002227 and so its address should therefore be cleared to 0 (See,
2228 eg, MPC823e User's Manual p.16-473). So, set
2229 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002230
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002231 When a board is reset during an i2c bus transfer
2232 chips might think that the current transfer is still
2233 in progress. Reset the slave devices by sending start
2234 commands until the slave device responds.
2235
wdenk945af8d2003-07-16 21:53:01 +00002236 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002237
Heiko Schocherea818db2013-01-29 08:53:15 +01002238 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002239 then the following macros need to be defined (examples are
2240 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002241
2242 I2C_INIT
2243
wdenkb37c7e52003-06-30 16:24:52 +00002244 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002245 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002246
wdenkba56f622004-02-06 23:19:44 +00002247 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002248
wdenkc6097192002-11-03 00:24:07 +00002249 I2C_PORT
2250
wdenk43d96162003-03-06 00:02:04 +00002251 (Only for MPC8260 CPU). The I/O port to use (the code
2252 assumes both bits are on the same port). Valid values
2253 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002254
2255 I2C_ACTIVE
2256
2257 The code necessary to make the I2C data line active
2258 (driven). If the data line is open collector, this
2259 define can be null.
2260
wdenkb37c7e52003-06-30 16:24:52 +00002261 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2262
wdenkc6097192002-11-03 00:24:07 +00002263 I2C_TRISTATE
2264
2265 The code necessary to make the I2C data line tri-stated
2266 (inactive). If the data line is open collector, this
2267 define can be null.
2268
wdenkb37c7e52003-06-30 16:24:52 +00002269 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2270
wdenkc6097192002-11-03 00:24:07 +00002271 I2C_READ
2272
York Sun472d5462013-04-01 11:29:11 -07002273 Code that returns true if the I2C data line is high,
2274 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002275
wdenkb37c7e52003-06-30 16:24:52 +00002276 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2277
wdenkc6097192002-11-03 00:24:07 +00002278 I2C_SDA(bit)
2279
York Sun472d5462013-04-01 11:29:11 -07002280 If <bit> is true, sets the I2C data line high. If it
2281 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002282
wdenkb37c7e52003-06-30 16:24:52 +00002283 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002284 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002285 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002286
wdenkc6097192002-11-03 00:24:07 +00002287 I2C_SCL(bit)
2288
York Sun472d5462013-04-01 11:29:11 -07002289 If <bit> is true, sets the I2C clock line high. If it
2290 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002291
wdenkb37c7e52003-06-30 16:24:52 +00002292 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002293 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002294 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002295
wdenkc6097192002-11-03 00:24:07 +00002296 I2C_DELAY
2297
2298 This delay is invoked four times per clock cycle so this
2299 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002300 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002301 like:
2302
wdenkb37c7e52003-06-30 16:24:52 +00002303 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002304
Mike Frysinger793b5722010-07-21 13:38:02 -04002305 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2306
2307 If your arch supports the generic GPIO framework (asm/gpio.h),
2308 then you may alternatively define the two GPIOs that are to be
2309 used as SCL / SDA. Any of the previous I2C_xxx macros will
2310 have GPIO-based defaults assigned to them as appropriate.
2311
2312 You should define these to the GPIO value as given directly to
2313 the generic GPIO functions.
2314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002315 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002316
wdenk8bde7f72003-06-27 21:31:46 +00002317 When a board is reset during an i2c bus transfer
2318 chips might think that the current transfer is still
2319 in progress. On some boards it is possible to access
2320 the i2c SCLK line directly, either by using the
2321 processor pin as a GPIO or by having a second pin
2322 connected to the bus. If this option is defined a
2323 custom i2c_init_board() routine in boards/xxx/board.c
2324 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002325
wdenk17ea1172004-06-06 21:51:03 +00002326 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2327
2328 This option enables configuration of bi_iic_fast[] flags
2329 in u-boot bd_info structure based on u-boot environment
2330 variable "i2cfast". (see also i2cfast)
2331
Ben Warrenbb99ad62006-09-07 16:50:54 -04002332 CONFIG_I2C_MULTI_BUS
2333
2334 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002335 must have a controller. At any point in time, only one bus is
2336 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002337 Note that bus numbering is zero-based.
2338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002339 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002340
2341 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002342 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002343 is set, specify a list of bus-device pairs. Otherwise, specify
2344 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002345
2346 e.g.
2347 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002348 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002349
2350 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2351
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002352 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002353 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002354
2355 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002357 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002358
2359 If defined, then this indicates the I2C bus number for DDR SPD.
2360 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2361
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002362 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002363
2364 If defined, then this indicates the I2C bus number for the RTC.
2365 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002367 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002368
2369 If defined, then this indicates the I2C bus number for the DTT.
2370 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2371
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002372 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002373
2374 If defined, specifies the I2C address of the DTT device.
2375 If not defined, then U-Boot uses predefined value for
2376 specified DTT device.
2377
Andrew Dyer2ac69852008-12-29 17:36:01 -06002378 CONFIG_SOFT_I2C_READ_REPEATED_START
2379
2380 defining this will force the i2c_read() function in
2381 the soft_i2c driver to perform an I2C repeated start
2382 between writing the address pointer and reading the
2383 data. If this define is omitted the default behaviour
2384 of doing a stop-start sequence will be used. Most I2C
2385 devices can use either method, but some require one or
2386 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002387
wdenkc6097192002-11-03 00:24:07 +00002388- SPI Support: CONFIG_SPI
2389
2390 Enables SPI driver (so far only tested with
2391 SPI EEPROM, also an instance works with Crystal A/D and
2392 D/As on the SACSng board)
2393
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002394 CONFIG_SH_SPI
2395
2396 Enables the driver for SPI controller on SuperH. Currently
2397 only SH7757 is supported.
2398
wdenkc6097192002-11-03 00:24:07 +00002399 CONFIG_SOFT_SPI
2400
wdenk43d96162003-03-06 00:02:04 +00002401 Enables a software (bit-bang) SPI driver rather than
2402 using hardware support. This is a general purpose
2403 driver that only requires three general I/O port pins
2404 (two outputs, one input) to function. If this is
2405 defined, the board configuration must define several
2406 SPI configuration items (port pins to use, etc). For
2407 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002408
Ben Warren04a9e112008-01-16 22:37:35 -05002409 CONFIG_HARD_SPI
2410
2411 Enables a hardware SPI driver for general-purpose reads
2412 and writes. As with CONFIG_SOFT_SPI, the board configuration
2413 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002414 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002415 example, see include/configs/mpc8349emds.h.
2416
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002417 CONFIG_MXC_SPI
2418
2419 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002420 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002421
Heiko Schocherf659b572014-07-14 10:22:11 +02002422 CONFIG_SYS_SPI_MXC_WAIT
2423 Timeout for waiting until spi transfer completed.
2424 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2425
Matthias Fuchs01335022007-12-27 17:12:34 +01002426- FPGA Support: CONFIG_FPGA
2427
2428 Enables FPGA subsystem.
2429
2430 CONFIG_FPGA_<vendor>
2431
2432 Enables support for specific chip vendors.
2433 (ALTERA, XILINX)
2434
2435 CONFIG_FPGA_<family>
2436
2437 Enables support for FPGA family.
2438 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2439
2440 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002441
wdenk43d96162003-03-06 00:02:04 +00002442 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002443
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302444 CONFIG_CMD_FPGA_LOADMK
2445
2446 Enable support for fpga loadmk command
2447
Michal Simek67193862014-05-02 13:43:39 +02002448 CONFIG_CMD_FPGA_LOADP
2449
2450 Enable support for fpga loadp command - load partial bitstream
2451
2452 CONFIG_CMD_FPGA_LOADBP
2453
2454 Enable support for fpga loadbp command - load partial bitstream
2455 (Xilinx only)
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002458
wdenk8bde7f72003-06-27 21:31:46 +00002459 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002462
wdenk43d96162003-03-06 00:02:04 +00002463 Enable checks on FPGA configuration interface busy
2464 status by the configuration function. This option
2465 will require a board or device specific function to
2466 be written.
wdenkc6097192002-11-03 00:24:07 +00002467
2468 CONFIG_FPGA_DELAY
2469
2470 If defined, a function that provides delays in the FPGA
2471 configuration driver.
2472
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002473 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002474 Allow Control-C to interrupt FPGA configuration
2475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002476 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002477
wdenk43d96162003-03-06 00:02:04 +00002478 Check for configuration errors during FPGA bitfile
2479 loading. For example, abort during Virtex II
2480 configuration if the INIT_B line goes low (which
2481 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002483 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002484
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002485 Maximum time to wait for the INIT_B line to de-assert
2486 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002487 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002488 ms.
wdenkc6097192002-11-03 00:24:07 +00002489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002491
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002492 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002493 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002495 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002496
wdenk43d96162003-03-06 00:02:04 +00002497 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002498 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002499
2500- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002501 CONFIG_BUILD_TARGET
2502
2503 Some SoCs need special image types (e.g. U-Boot binary
2504 with a special header) as build targets. By defining
2505 CONFIG_BUILD_TARGET in the SoC / board header, this
2506 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002507 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002508
wdenkc6097192002-11-03 00:24:07 +00002509 CONFIG_IDENT_STRING
2510
wdenk43d96162003-03-06 00:02:04 +00002511 If defined, this string will be added to the U-Boot
2512 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002513
2514- Vendor Parameter Protection:
2515
wdenk43d96162003-03-06 00:02:04 +00002516 U-Boot considers the values of the environment
2517 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002518 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002519 are set once by the board vendor / manufacturer, and
2520 protects these variables from casual modification by
2521 the user. Once set, these variables are read-only,
2522 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002523 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002524
2525 If CONFIG_ENV_OVERWRITE is #defined in your config
2526 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002527 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002528 these parameters.
2529
Joe Hershberger92ac5202015-05-04 14:55:14 -05002530 Alternatively, if you define _both_ an ethaddr in the
2531 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002532 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002533 which can be changed exactly ONCE by the user. [The
2534 serial# is unaffected by this, i. e. it remains
2535 read-only.]
2536
Joe Hershberger25980902012-12-11 22:16:31 -06002537 The same can be accomplished in a more flexible way
2538 for any variable by configuring the type of access
2539 to allow for those variables in the ".flags" variable
2540 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2541
wdenkc6097192002-11-03 00:24:07 +00002542- Protected RAM:
2543 CONFIG_PRAM
2544
2545 Define this variable to enable the reservation of
2546 "protected RAM", i. e. RAM which is not overwritten
2547 by U-Boot. Define CONFIG_PRAM to hold the number of
2548 kB you want to reserve for pRAM. You can overwrite
2549 this default value by defining an environment
2550 variable "pram" to the number of kB you want to
2551 reserve. Note that the board info structure will
2552 still show the full amount of RAM. If pRAM is
2553 reserved, a new environment variable "mem" will
2554 automatically be defined to hold the amount of
2555 remaining RAM in a form that can be passed as boot
2556 argument to Linux, for instance like that:
2557
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002558 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002559 saveenv
2560
2561 This way you can tell Linux not to use this memory,
2562 either, which results in a memory region that will
2563 not be affected by reboots.
2564
2565 *WARNING* If your board configuration uses automatic
2566 detection of the RAM size, you must make sure that
2567 this memory test is non-destructive. So far, the
2568 following board configurations are known to be
2569 "pRAM-clean":
2570
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002571 IVMS8, IVML24, SPD8xx, TQM8xxL,
2572 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002573 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002574
Gabe Black40fef042012-12-02 04:55:18 +00002575- Access to physical memory region (> 4GB)
2576 Some basic support is provided for operations on memory not
2577 normally accessible to U-Boot - e.g. some architectures
2578 support access to more than 4GB of memory on 32-bit
2579 machines using physical address extension or similar.
2580 Define CONFIG_PHYSMEM to access this basic support, which
2581 currently only supports clearing the memory.
2582
wdenkc6097192002-11-03 00:24:07 +00002583- Error Recovery:
2584 CONFIG_PANIC_HANG
2585
2586 Define this variable to stop the system in case of a
2587 fatal error, so that you have to reset it manually.
2588 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002589 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002590 automatically as fast as possible, but it may be
2591 useful during development since you can try to debug
2592 the conditions that lead to the situation.
2593
2594 CONFIG_NET_RETRY_COUNT
2595
wdenk43d96162003-03-06 00:02:04 +00002596 This variable defines the number of retries for
2597 network operations like ARP, RARP, TFTP, or BOOTP
2598 before giving up the operation. If not defined, a
2599 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002600
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002601 CONFIG_ARP_TIMEOUT
2602
2603 Timeout waiting for an ARP reply in milliseconds.
2604
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002605 CONFIG_NFS_TIMEOUT
2606
2607 Timeout in milliseconds used in NFS protocol.
2608 If you encounter "ERROR: Cannot umount" in nfs command,
2609 try longer timeout such as
2610 #define CONFIG_NFS_TIMEOUT 10000UL
2611
wdenkc6097192002-11-03 00:24:07 +00002612- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002613 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002614
2615 Enable auto completion of commands using TAB.
2616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002617 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002618
2619 This defines the secondary prompt string, which is
2620 printed when the command interpreter needs more input
2621 to complete a command. Usually "> ".
2622
2623 Note:
2624
wdenk8bde7f72003-06-27 21:31:46 +00002625 In the current implementation, the local variables
2626 space and global environment variables space are
2627 separated. Local variables are those you define by
2628 simply typing `name=value'. To access a local
2629 variable later on, you have write `$name' or
2630 `${name}'; to execute the contents of a variable
2631 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk43d96162003-03-06 00:02:04 +00002633 Global environment variables are those you use
2634 setenv/printenv to work with. To run a command stored
2635 in such a variable, you need to use the run command,
2636 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002637
2638 To store commands and special characters in a
2639 variable, please use double quotation marks
2640 surrounding the whole text of the variable, instead
2641 of the backslashes before semicolons and special
2642 symbols.
2643
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002644- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002645 CONFIG_CMDLINE_EDITING
2646
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002647 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002648 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002649
Marek Vasutf3b267b2016-01-27 04:47:55 +01002650- Command Line PS1/PS2 support:
2651 CONFIG_CMDLINE_PS_SUPPORT
2652
2653 Enable support for changing the command prompt string
2654 at run-time. Only static string is supported so far.
2655 The string is obtained from environment variables PS1
2656 and PS2.
2657
wdenka8c7c702003-12-06 19:49:23 +00002658- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002659 CONFIG_EXTRA_ENV_SETTINGS
2660
wdenk43d96162003-03-06 00:02:04 +00002661 Define this to contain any number of null terminated
2662 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002663 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002664
wdenk43d96162003-03-06 00:02:04 +00002665 For example, place something like this in your
2666 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002667
2668 #define CONFIG_EXTRA_ENV_SETTINGS \
2669 "myvar1=value1\0" \
2670 "myvar2=value2\0"
2671
wdenk43d96162003-03-06 00:02:04 +00002672 Warning: This method is based on knowledge about the
2673 internal format how the environment is stored by the
2674 U-Boot code. This is NOT an official, exported
2675 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002676 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002677 You better know what you are doing here.
2678
wdenk43d96162003-03-06 00:02:04 +00002679 Note: overly (ab)use of the default environment is
2680 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002681 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002682 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002683
Stephen Warren5e724ca2012-05-22 09:21:54 +00002684 CONFIG_ENV_VARS_UBOOT_CONFIG
2685
2686 Define this in order to add variables describing the
2687 U-Boot build configuration to the default environment.
2688 These will be named arch, cpu, board, vendor, and soc.
2689
2690 Enabling this option will cause the following to be defined:
2691
2692 - CONFIG_SYS_ARCH
2693 - CONFIG_SYS_CPU
2694 - CONFIG_SYS_BOARD
2695 - CONFIG_SYS_VENDOR
2696 - CONFIG_SYS_SOC
2697
Tom Rini7e27f892012-10-24 07:28:16 +00002698 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2699
2700 Define this in order to add variables describing certain
2701 run-time determined information about the hardware to the
2702 environment. These will be named board_name, board_rev.
2703
Simon Glass06fd8532012-11-30 13:01:17 +00002704 CONFIG_DELAY_ENVIRONMENT
2705
2706 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002707 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002708 that so that the environment is not available until
2709 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2710 this is instead controlled by the value of
2711 /config/load-environment.
2712
wdenka8c7c702003-12-06 19:49:23 +00002713- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002714 CONFIG_HAS_DATAFLASH
2715
wdenk8bde7f72003-06-27 21:31:46 +00002716 Defining this option enables DataFlash features and
2717 allows to read/write in Dataflash via the standard
2718 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002719
Eric Nelsonf61ec452012-01-31 10:52:08 -07002720- Serial Flash support
2721 CONFIG_CMD_SF
2722
2723 Defining this option enables SPI flash commands
2724 'sf probe/read/write/erase/update'.
2725
2726 Usage requires an initial 'probe' to define the serial
2727 flash parameters, followed by read/write/erase/update
2728 commands.
2729
2730 The following defaults may be provided by the platform
2731 to handle the common case when only a single serial
2732 flash is present on the system.
2733
2734 CONFIG_SF_DEFAULT_BUS Bus identifier
2735 CONFIG_SF_DEFAULT_CS Chip-select
2736 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2737 CONFIG_SF_DEFAULT_SPEED in Hz
2738
Simon Glass24007272012-10-08 13:16:02 +00002739 CONFIG_CMD_SF_TEST
2740
2741 Define this option to include a destructive SPI flash
2742 test ('sf test').
2743
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302744 CONFIG_SF_DUAL_FLASH Dual flash memories
2745
2746 Define this option to use dual flash support where two flash
2747 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002748 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302749
wdenk3f85ce22004-02-23 16:11:30 +00002750- SystemACE Support:
2751 CONFIG_SYSTEMACE
2752
2753 Adding this option adds support for Xilinx SystemACE
2754 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002755 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002757
2758 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002759 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002760
2761 When SystemACE support is added, the "ace" device type
2762 becomes available to the fat commands, i.e. fatls.
2763
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002764- TFTP Fixed UDP Port:
2765 CONFIG_TFTP_PORT
2766
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002767 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002768 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002769 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002770 number generator is used.
2771
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002772 Also, the environment variable tftpdstp is used to supply
2773 the TFTP UDP destination port value. If tftpdstp isn't
2774 defined, the normal port 69 is used.
2775
2776 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002777 blindly start the TFTP transfer using the pre-configured
2778 target IP address and UDP port. This has the effect of
2779 "punching through" the (Windows XP) firewall, allowing
2780 the remainder of the TFTP transfer to proceed normally.
2781 A better solution is to properly configure the firewall,
2782 but sometimes that is not allowed.
2783
Simon Glassbf36c5d2012-12-05 14:46:38 +00002784- Hashing support:
2785 CONFIG_CMD_HASH
2786
2787 This enables a generic 'hash' command which can produce
2788 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2789
2790 CONFIG_HASH_VERIFY
2791
2792 Enable the hash verify command (hash -v). This adds to code
2793 size a little.
2794
gaurav rana94e3c8c2015-02-20 12:51:46 +05302795 CONFIG_SHA1 - This option enables support of hashing using SHA1
2796 algorithm. The hash is calculated in software.
2797 CONFIG_SHA256 - This option enables support of hashing using
2798 SHA256 algorithm. The hash is calculated in software.
2799 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2800 for SHA1/SHA256 hashing.
2801 This affects the 'hash' command and also the
2802 hash_lookup_algo() function.
2803 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2804 hardware-acceleration for SHA1/SHA256 progressive hashing.
2805 Data can be streamed in a block at a time and the hashing
2806 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00002807
2808 Note: There is also a sha1sum command, which should perhaps
2809 be deprecated in favour of 'hash sha1'.
2810
Robert Winklera11f1872013-07-24 17:57:06 -07002811- Freescale i.MX specific commands:
2812 CONFIG_CMD_HDMIDETECT
2813 This enables 'hdmidet' command which returns true if an
2814 HDMI monitor is detected. This command is i.MX 6 specific.
2815
Heiko Schocher9e50c402014-01-25 07:27:13 +01002816- bootcount support:
2817 CONFIG_BOOTCOUNT_LIMIT
2818
2819 This enables the bootcounter support, see:
2820 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2821
2822 CONFIG_AT91SAM9XE
2823 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002824 CONFIG_SOC_DA8XX
2825 enable special bootcounter support on da850 based boards.
2826 CONFIG_BOOTCOUNT_RAM
2827 enable support for the bootcounter in RAM
2828 CONFIG_BOOTCOUNT_I2C
2829 enable support for the bootcounter on an i2c (like RTC) device.
2830 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2831 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2832 the bootcounter.
2833 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002834
wdenka8c7c702003-12-06 19:49:23 +00002835- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002836 CONFIG_SHOW_BOOT_PROGRESS
2837
wdenk43d96162003-03-06 00:02:04 +00002838 Defining this option allows to add some board-
2839 specific code (calling a user-provided function
2840 "show_boot_progress(int)") that enables you to show
2841 the system's boot progress on some display (for
2842 example, some LED's) on your board. At the moment,
2843 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002844
Simon Glass94fd1312012-09-28 08:56:37 +00002845
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002846Legacy uImage format:
2847
wdenkc6097192002-11-03 00:24:07 +00002848 Arg Where When
2849 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002850 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002851 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002852 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002853 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002854 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002855 4 common/cmd_bootm.c Image data has correct checksum
2856 -4 common/cmd_bootm.c Image is for unsupported architecture
2857 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002858 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002859 6 common/cmd_bootm.c Image Type check OK
2860 -6 common/cmd_bootm.c gunzip uncompression error
2861 -7 common/cmd_bootm.c Unimplemented compression type
2862 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002863 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002864 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002865
2866 9 common/image.c Start initial ramdisk verification
2867 -10 common/image.c Ramdisk header has bad magic number
2868 -11 common/image.c Ramdisk header has bad checksum
2869 10 common/image.c Ramdisk header is OK
2870 -12 common/image.c Ramdisk data has bad checksum
2871 11 common/image.c Ramdisk data has correct checksum
2872 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002873 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002874 13 common/image.c Start multifile image verification
2875 14 common/image.c No initial ramdisk, no multifile, continue.
2876
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002877 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002878
Stefan Roesea47a12b2010-04-15 16:07:28 +02002879 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002880 -31 post/post.c POST test failed, detected by post_output_backlog()
2881 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002882
Heiko Schocher566a4942007-06-22 19:11:54 +02002883 34 common/cmd_doc.c before loading a Image from a DOC device
2884 -35 common/cmd_doc.c Bad usage of "doc" command
2885 35 common/cmd_doc.c correct usage of "doc" command
2886 -36 common/cmd_doc.c No boot device
2887 36 common/cmd_doc.c correct boot device
2888 -37 common/cmd_doc.c Unknown Chip ID on boot device
2889 37 common/cmd_doc.c correct chip ID found, device available
2890 -38 common/cmd_doc.c Read Error on boot device
2891 38 common/cmd_doc.c reading Image header from DOC device OK
2892 -39 common/cmd_doc.c Image header has bad magic number
2893 39 common/cmd_doc.c Image header has correct magic number
2894 -40 common/cmd_doc.c Error reading Image from DOC device
2895 40 common/cmd_doc.c Image header has correct magic number
2896 41 common/cmd_ide.c before loading a Image from a IDE device
2897 -42 common/cmd_ide.c Bad usage of "ide" command
2898 42 common/cmd_ide.c correct usage of "ide" command
2899 -43 common/cmd_ide.c No boot device
2900 43 common/cmd_ide.c boot device found
2901 -44 common/cmd_ide.c Device not available
2902 44 common/cmd_ide.c Device available
2903 -45 common/cmd_ide.c wrong partition selected
2904 45 common/cmd_ide.c partition selected
2905 -46 common/cmd_ide.c Unknown partition table
2906 46 common/cmd_ide.c valid partition table found
2907 -47 common/cmd_ide.c Invalid partition type
2908 47 common/cmd_ide.c correct partition type
2909 -48 common/cmd_ide.c Error reading Image Header on boot device
2910 48 common/cmd_ide.c reading Image Header from IDE device OK
2911 -49 common/cmd_ide.c Image header has bad magic number
2912 49 common/cmd_ide.c Image header has correct magic number
2913 -50 common/cmd_ide.c Image header has bad checksum
2914 50 common/cmd_ide.c Image header has correct checksum
2915 -51 common/cmd_ide.c Error reading Image from IDE device
2916 51 common/cmd_ide.c reading Image from IDE device OK
2917 52 common/cmd_nand.c before loading a Image from a NAND device
2918 -53 common/cmd_nand.c Bad usage of "nand" command
2919 53 common/cmd_nand.c correct usage of "nand" command
2920 -54 common/cmd_nand.c No boot device
2921 54 common/cmd_nand.c boot device found
2922 -55 common/cmd_nand.c Unknown Chip ID on boot device
2923 55 common/cmd_nand.c correct chip ID found, device available
2924 -56 common/cmd_nand.c Error reading Image Header on boot device
2925 56 common/cmd_nand.c reading Image Header from NAND device OK
2926 -57 common/cmd_nand.c Image header has bad magic number
2927 57 common/cmd_nand.c Image header has correct magic number
2928 -58 common/cmd_nand.c Error reading Image from NAND device
2929 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002930
Heiko Schocher566a4942007-06-22 19:11:54 +02002931 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002932
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002933 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002934 -64 net/eth.c no Ethernet found.
2935 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002936
Heiko Schocher566a4942007-06-22 19:11:54 +02002937 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002938 80 common/cmd_net.c before calling net_loop()
2939 -81 common/cmd_net.c some error in net_loop() occurred
2940 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002941 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2942 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002943 83 common/cmd_net.c running "source" command
2944 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002945 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002946
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002947FIT uImage format:
2948
2949 Arg Where When
2950 100 common/cmd_bootm.c Kernel FIT Image has correct format
2951 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2952 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2953 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2954 102 common/cmd_bootm.c Kernel unit name specified
2955 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002956 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002957 104 common/cmd_bootm.c Got kernel subimage node offset
2958 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2959 105 common/cmd_bootm.c Kernel subimage hash verification OK
2960 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2961 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002962 -106 common/cmd_bootm.c Kernel subimage has wrong type
2963 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002964 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2965 108 common/cmd_bootm.c Got kernel subimage data/size
2966 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2967 -109 common/cmd_bootm.c Can't get kernel subimage type
2968 -110 common/cmd_bootm.c Can't get kernel subimage comp
2969 -111 common/cmd_bootm.c Can't get kernel subimage os
2970 -112 common/cmd_bootm.c Can't get kernel subimage load address
2971 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2972
2973 120 common/image.c Start initial ramdisk verification
2974 -120 common/image.c Ramdisk FIT image has incorrect format
2975 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002976 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002977 -122 common/image.c Can't get configuration for ramdisk subimage
2978 123 common/image.c Ramdisk unit name specified
2979 -124 common/image.c Can't get ramdisk subimage node offset
2980 125 common/image.c Got ramdisk subimage node offset
2981 -125 common/image.c Ramdisk subimage hash verification failed
2982 126 common/image.c Ramdisk subimage hash verification OK
2983 -126 common/image.c Ramdisk subimage for unsupported architecture
2984 127 common/image.c Architecture check OK
2985 -127 common/image.c Can't get ramdisk subimage data/size
2986 128 common/image.c Got ramdisk subimage data/size
2987 129 common/image.c Can't get ramdisk load address
2988 -129 common/image.c Got ramdisk load address
2989
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002990 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002991 131 common/cmd_doc.c FIT image format OK
2992
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002993 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002994 141 common/cmd_ide.c FIT image format OK
2995
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002996 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002997 151 common/cmd_nand.c FIT image format OK
2998
Heiko Schocher21d29f72014-05-28 11:33:33 +02002999- legacy image format:
3000 CONFIG_IMAGE_FORMAT_LEGACY
3001 enables the legacy image format support in U-Boot.
3002
3003 Default:
3004 enabled if CONFIG_FIT_SIGNATURE is not defined.
3005
3006 CONFIG_DISABLE_IMAGE_LEGACY
3007 disable the legacy image format
3008
3009 This define is introduced, as the legacy image format is
3010 enabled per default for backward compatibility.
3011
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003012- FIT image support:
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003013 CONFIG_FIT_DISABLE_SHA256
3014 Supporting SHA256 hashes has quite an impact on binary size.
3015 For constrained systems sha256 hash support can be disabled
3016 with this option.
3017
Simon Glass73223f02016-02-22 22:55:43 -07003018 TODO(sjg@chromium.org): Adjust this option to be positive,
3019 and move it to Kconfig
3020
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003021- Standalone program support:
3022 CONFIG_STANDALONE_LOAD_ADDR
3023
Wolfgang Denk6feff892011-10-09 21:06:34 +02003024 This option defines a board specific value for the
3025 address where standalone program gets loaded, thus
3026 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003027 settings.
3028
3029- Frame Buffer Address:
3030 CONFIG_FB_ADDR
3031
3032 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003033 address for frame buffer. This is typically the case
3034 when using a graphics controller has separate video
3035 memory. U-Boot will then place the frame buffer at
3036 the given address instead of dynamically reserving it
3037 in system RAM by calling lcd_setmem(), which grabs
3038 the memory for the frame buffer depending on the
3039 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003040
3041 Please see board_init_f function.
3042
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003043- Automatic software updates via TFTP server
3044 CONFIG_UPDATE_TFTP
3045 CONFIG_UPDATE_TFTP_CNT_MAX
3046 CONFIG_UPDATE_TFTP_MSEC_MAX
3047
3048 These options enable and control the auto-update feature;
3049 for a more detailed description refer to doc/README.update.
3050
3051- MTD Support (mtdparts command, UBI support)
3052 CONFIG_MTD_DEVICE
3053
3054 Adds the MTD device infrastructure from the Linux kernel.
3055 Needed for mtdparts command support.
3056
3057 CONFIG_MTD_PARTITIONS
3058
3059 Adds the MTD partitioning infrastructure from the Linux
3060 kernel. Needed for UBI support.
3061
Joe Hershberger70c219c2013-04-08 10:32:48 +00003062- UBI support
3063 CONFIG_CMD_UBI
3064
3065 Adds commands for interacting with MTD partitions formatted
3066 with the UBI flash translation layer
3067
3068 Requires also defining CONFIG_RBTREE
3069
Joe Hershberger147162d2013-04-08 10:32:49 +00003070 CONFIG_UBI_SILENCE_MSG
3071
3072 Make the verbose messages from UBI stop printing. This leaves
3073 warnings and errors enabled.
3074
Heiko Schocherff94bc42014-06-24 10:10:04 +02003075
3076 CONFIG_MTD_UBI_WL_THRESHOLD
3077 This parameter defines the maximum difference between the highest
3078 erase counter value and the lowest erase counter value of eraseblocks
3079 of UBI devices. When this threshold is exceeded, UBI starts performing
3080 wear leveling by means of moving data from eraseblock with low erase
3081 counter to eraseblocks with high erase counter.
3082
3083 The default value should be OK for SLC NAND flashes, NOR flashes and
3084 other flashes which have eraseblock life-cycle 100000 or more.
3085 However, in case of MLC NAND flashes which typically have eraseblock
3086 life-cycle less than 10000, the threshold should be lessened (e.g.,
3087 to 128 or 256, although it does not have to be power of 2).
3088
3089 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003090
Heiko Schocherff94bc42014-06-24 10:10:04 +02003091 CONFIG_MTD_UBI_BEB_LIMIT
3092 This option specifies the maximum bad physical eraseblocks UBI
3093 expects on the MTD device (per 1024 eraseblocks). If the
3094 underlying flash does not admit of bad eraseblocks (e.g. NOR
3095 flash), this value is ignored.
3096
3097 NAND datasheets often specify the minimum and maximum NVM
3098 (Number of Valid Blocks) for the flashes' endurance lifetime.
3099 The maximum expected bad eraseblocks per 1024 eraseblocks
3100 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3101 which gives 20 for most NANDs (MaxNVB is basically the total
3102 count of eraseblocks on the chip).
3103
3104 To put it differently, if this value is 20, UBI will try to
3105 reserve about 1.9% of physical eraseblocks for bad blocks
3106 handling. And that will be 1.9% of eraseblocks on the entire
3107 NAND chip, not just the MTD partition UBI attaches. This means
3108 that if you have, say, a NAND flash chip admits maximum 40 bad
3109 eraseblocks, and it is split on two MTD partitions of the same
3110 size, UBI will reserve 40 eraseblocks when attaching a
3111 partition.
3112
3113 default: 20
3114
3115 CONFIG_MTD_UBI_FASTMAP
3116 Fastmap is a mechanism which allows attaching an UBI device
3117 in nearly constant time. Instead of scanning the whole MTD device it
3118 only has to locate a checkpoint (called fastmap) on the device.
3119 The on-flash fastmap contains all information needed to attach
3120 the device. Using fastmap makes only sense on large devices where
3121 attaching by scanning takes long. UBI will not automatically install
3122 a fastmap on old images, but you can set the UBI parameter
3123 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3124 that fastmap-enabled images are still usable with UBI implementations
3125 without fastmap support. On typical flash devices the whole fastmap
3126 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3127
3128 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3129 Set this parameter to enable fastmap automatically on images
3130 without a fastmap.
3131 default: 0
3132
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003133 CONFIG_MTD_UBI_FM_DEBUG
3134 Enable UBI fastmap debug
3135 default: 0
3136
Joe Hershberger70c219c2013-04-08 10:32:48 +00003137- UBIFS support
3138 CONFIG_CMD_UBIFS
3139
3140 Adds commands for interacting with UBI volumes formatted as
3141 UBIFS. UBIFS is read-only in u-boot.
3142
3143 Requires UBI support as well as CONFIG_LZO
3144
Joe Hershberger147162d2013-04-08 10:32:49 +00003145 CONFIG_UBIFS_SILENCE_MSG
3146
3147 Make the verbose messages from UBIFS stop printing. This leaves
3148 warnings and errors enabled.
3149
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003150- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003151 CONFIG_SPL
3152 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003153
Tom Rini95579792012-02-14 07:29:40 +00003154 CONFIG_SPL_LDSCRIPT
3155 LDSCRIPT for linking the SPL binary.
3156
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003157 CONFIG_SPL_MAX_FOOTPRINT
3158 Maximum size in memory allocated to the SPL, BSS included.
3159 When defined, the linker checks that the actual memory
3160 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003161 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003162 must not be both defined at the same time.
3163
Tom Rini95579792012-02-14 07:29:40 +00003164 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003165 Maximum size of the SPL image (text, data, rodata, and
3166 linker lists sections), BSS excluded.
3167 When defined, the linker checks that the actual size does
3168 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003169
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003170 CONFIG_SPL_TEXT_BASE
3171 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003172
Scott Wood94a45bb2012-09-20 19:05:12 -05003173 CONFIG_SPL_RELOC_TEXT_BASE
3174 Address to relocate to. If unspecified, this is equal to
3175 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3176
Tom Rini95579792012-02-14 07:29:40 +00003177 CONFIG_SPL_BSS_START_ADDR
3178 Link address for the BSS within the SPL binary.
3179
3180 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003181 Maximum size in memory allocated to the SPL BSS.
3182 When defined, the linker checks that the actual memory used
3183 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003184 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003185 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003186
3187 CONFIG_SPL_STACK
3188 Adress of the start of the stack SPL will use
3189
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003190 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3191 When defined, SPL will panic() if the image it has
3192 loaded does not have a signature.
3193 Defining this is useful when code which loads images
3194 in SPL cannot guarantee that absolutely all read errors
3195 will be caught.
3196 An example is the LPC32XX MLC NAND driver, which will
3197 consider that a completely unreadable NAND block is bad,
3198 and thus should be skipped silently.
3199
Scott Wood94a45bb2012-09-20 19:05:12 -05003200 CONFIG_SPL_RELOC_STACK
3201 Adress of the start of the stack SPL will use after
3202 relocation. If unspecified, this is equal to
3203 CONFIG_SPL_STACK.
3204
Tom Rini95579792012-02-14 07:29:40 +00003205 CONFIG_SYS_SPL_MALLOC_START
3206 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003207 When this option is set the full malloc is used in SPL and
3208 it is set up by spl_init() and before that, the simple malloc()
3209 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003210
3211 CONFIG_SYS_SPL_MALLOC_SIZE
3212 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003213
Tom Rini47f7bca2012-08-13 12:03:19 -07003214 CONFIG_SPL_FRAMEWORK
3215 Enable the SPL framework under common/. This framework
3216 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3217 NAND loading of the Linux Kernel.
3218
Tom Rini9607faf2014-03-28 12:03:39 -04003219 CONFIG_SPL_OS_BOOT
3220 Enable booting directly to an OS from SPL.
3221 See also: doc/README.falcon
3222
Tom Rini861a86f2012-08-13 11:37:56 -07003223 CONFIG_SPL_DISPLAY_PRINT
3224 For ARM, enable an optional function to print more information
3225 about the running system.
3226
Scott Wood4b919722012-09-20 16:35:21 -05003227 CONFIG_SPL_INIT_MINIMAL
3228 Arch init code should be built for a very small image
3229
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003230 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3231 Partition on the MMC to load U-Boot from when the MMC is being
3232 used in raw mode
3233
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003234 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3235 Sector to load kernel uImage from when MMC is being
3236 used in raw mode (for Falcon mode)
3237
3238 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3239 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3240 Sector and number of sectors to load kernel argument
3241 parameters from when MMC is being used in raw mode
3242 (for falcon mode)
3243
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003244 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3245 Partition on the MMC to load U-Boot from when the MMC is being
3246 used in fs mode
3247
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003248 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3249 Filename to read to load U-Boot when reading from filesystem
3250
3251 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003252 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003253 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003254
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003255 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003256 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003257 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003258
Scott Wood06f60ae2012-12-06 13:33:17 +00003259 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3260 Set this for NAND SPL on PPC mpc83xx targets, so that
3261 start.S waits for the rest of the SPL to load before
3262 continuing (the hardware starts execution after just
3263 loading the first page rather than the full 4K).
3264
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303265 CONFIG_SPL_SKIP_RELOCATE
3266 Avoid SPL relocation
3267
Scott Wood6f2f01b2012-09-20 19:09:07 -05003268 CONFIG_SPL_NAND_BASE
3269 Include nand_base.c in the SPL. Requires
3270 CONFIG_SPL_NAND_DRIVERS.
3271
3272 CONFIG_SPL_NAND_DRIVERS
3273 SPL uses normal NAND drivers, not minimal drivers.
3274
3275 CONFIG_SPL_NAND_ECC
3276 Include standard software ECC in the SPL
3277
Tom Rini95579792012-02-14 07:29:40 +00003278 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003279 Support for NAND boot using simple NAND drivers that
3280 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003281
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02003282 CONFIG_SPL_UBI
3283 Support for a lightweight UBI (fastmap) scanner and
3284 loader
3285
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003286 CONFIG_SPL_NAND_RAW_ONLY
3287 Support to boot only raw u-boot.bin images. Use this only
3288 if you need to save space.
3289
Ying Zhang7c8eea52013-08-16 15:16:12 +08003290 CONFIG_SPL_COMMON_INIT_DDR
3291 Set for common ddr init with serial presence detect in
3292 SPL binary.
3293
Tom Rini95579792012-02-14 07:29:40 +00003294 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3295 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3296 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3297 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3298 CONFIG_SYS_NAND_ECCBYTES
3299 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003300 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003301
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303302 CONFIG_SPL_NAND_BOOT
3303 Add support NAND boot
3304
Tom Rini95579792012-02-14 07:29:40 +00003305 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003306 Location in NAND to read U-Boot from
3307
3308 CONFIG_SYS_NAND_U_BOOT_DST
3309 Location in memory to load U-Boot to
3310
3311 CONFIG_SYS_NAND_U_BOOT_SIZE
3312 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003313
3314 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003315 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003316
3317 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3318 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003319 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003320
3321 CONFIG_SPL_OMAP3_ID_NAND
3322 Support for an OMAP3-specific set of functions to return the
3323 ID and MFR of the first attached NAND chip, if present.
3324
Pavel Machekc57b9532012-08-30 22:42:11 +02003325 CONFIG_SPL_RAM_DEVICE
3326 Support for running image already present in ram, in SPL binary
3327
Scott Wood74752ba2012-12-06 13:33:16 +00003328 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003329 Image offset to which the SPL should be padded before appending
3330 the SPL payload. By default, this is defined as
3331 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3332 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3333 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003334
Scott Woodca2fca22012-09-21 16:27:32 -05003335 CONFIG_SPL_TARGET
3336 Final target image containing SPL and payload. Some SPLs
3337 use an arch-specific makefile fragment instead, for
3338 example if more than one image needs to be produced.
3339
Simon Glass87ebee32013-05-08 08:05:59 +00003340 CONFIG_FIT_SPL_PRINT
3341 Printing information about a FIT image adds quite a bit of
3342 code to SPL. So this is normally disabled in SPL. Use this
3343 option to re-enable it. This will affect the output of the
3344 bootm command when booting a FIT image.
3345
Ying Zhang3aa29de2013-08-16 15:16:15 +08003346- TPL framework
3347 CONFIG_TPL
3348 Enable building of TPL globally.
3349
3350 CONFIG_TPL_PAD_TO
3351 Image offset to which the TPL should be padded before appending
3352 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003353 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3354 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3355 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003356
wdenka8c7c702003-12-06 19:49:23 +00003357- Interrupt support (PPC):
3358
wdenkd4ca31c2004-01-02 14:00:00 +00003359 There are common interrupt_init() and timer_interrupt()
3360 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003361 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003362 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003363 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003364 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003365 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003366 specific handling. If board has watchdog / status_led
3367 / other_activity_monitor it works automatically from
3368 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003369
wdenkc6097192002-11-03 00:24:07 +00003370
Helmut Raiger9660e442011-10-20 04:19:47 +00003371Board initialization settings:
3372------------------------------
3373
3374During Initialization u-boot calls a number of board specific functions
3375to allow the preparation of board specific prerequisites, e.g. pin setup
3376before drivers are initialized. To enable these callbacks the
3377following configuration macros have to be defined. Currently this is
3378architecture specific, so please check arch/your_architecture/lib/board.c
3379typically in board_init_f() and board_init_r().
3380
3381- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3382- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3383- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3384- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003385
wdenkc6097192002-11-03 00:24:07 +00003386Configuration Settings:
3387-----------------------
3388
York Sun4d1fd7f2014-02-26 17:03:19 -08003389- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3390 Optionally it can be defined to support 64-bit memory commands.
3391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003393 undefine this when you're short of memory.
3394
Peter Tyser2fb26042009-01-27 18:03:12 -06003395- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3396 width of the commands listed in the 'help' command output.
3397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003398- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003399 prompt for user input.
3400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003401- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003403- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003405- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003406
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003407- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003408 the application (usually a Linux kernel) when it is
3409 booted
3410
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003411- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003412 List of legal baudrate settings for this board.
3413
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003414- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003415 Begin and End addresses of the area used by the
3416 simple memory test.
3417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003418- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003419 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003421- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003422 Scratch address used by the alternate memory test
3423 You only need to set this if address zero isn't writeable
3424
York Sune8149522015-12-04 11:57:07 -08003425- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003426 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003427 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3428 is substracted from total RAM and won't be reported to OS.
3429 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003430 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003431 the RAM base is not zero, or RAM is divided into banks,
3432 this variable needs to be recalcuated to get the address.
3433
York Sunaabd7dd2015-12-07 11:05:29 -08003434- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003435 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003436 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003437 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003438 fixing up gd->ram_size the Linux kernel should gets passed
3439 the now "corrected" memory size and won't touch it either.
3440 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003441 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003442 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003443 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003444
3445 This option can be used as a workaround for the 440EPx/GRx
3446 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3447 be touched.
3448
3449 WARNING: Please make sure that this value is a multiple of
3450 the Linux page size (normally 4k). If this is not the case,
3451 then the end address of the Linux memory will be located at a
3452 non page size aligned address and this could cause major
3453 problems.
3454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003456 Enable temporary baudrate change while serial download
3457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003458- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003459 Physical start address of SDRAM. _Must_ be 0 here.
3460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003461- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003462 Physical start address of Flash memory.
3463
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003464- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003465 Physical start address of boot monitor code (set by
3466 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003467 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003468 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003470- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003471 Size of memory reserved for monitor code, used to
3472 determine _at_compile_time_ (!) if the environment is
3473 embedded within the U-Boot image, or in a separate
3474 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003476- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003477 Size of DRAM reserved for malloc() use.
3478
Simon Glassd59476b2014-07-10 22:23:28 -06003479- CONFIG_SYS_MALLOC_F_LEN
3480 Size of the malloc() pool for use before relocation. If
3481 this is defined, then a very simple malloc() implementation
3482 will become available before relocation. The address is just
3483 below the global data, and the stack is moved down to make
3484 space.
3485
3486 This feature allocates regions with increasing addresses
3487 within the region. calloc() is supported, but realloc()
3488 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003489 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003490 U-Boot relocates itself.
3491
Simon Glass38687ae2014-11-10 17:16:54 -07003492- CONFIG_SYS_MALLOC_SIMPLE
3493 Provides a simple and small malloc() and calloc() for those
3494 boards which do not use the full malloc in SPL (which is
3495 enabled with CONFIG_SYS_SPL_MALLOC_START).
3496
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003497- CONFIG_SYS_NONCACHED_MEMORY:
3498 Size of non-cached memory area. This area of memory will be
3499 typically located right below the malloc() area and mapped
3500 uncached in the MMU. This is useful for drivers that would
3501 otherwise require a lot of explicit cache maintenance. For
3502 some drivers it's also impossible to properly maintain the
3503 cache. For example if the regions that need to be flushed
3504 are not a multiple of the cache-line size, *and* padding
3505 cannot be allocated between the regions to align them (i.e.
3506 if the HW requires a contiguous array of regions, and the
3507 size of each region is not cache-aligned), then a flush of
3508 one region may result in overwriting data that hardware has
3509 written to another region in the same cache-line. This can
3510 happen for example in network drivers where descriptors for
3511 buffers are typically smaller than the CPU cache-line (e.g.
3512 16 bytes vs. 32 or 64 bytes).
3513
3514 Non-cached memory is only supported on 32-bit ARM at present.
3515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003516- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003517 Normally compressed uImages are limited to an
3518 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003519 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003520 to adjust this setting to your needs.
3521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003522- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003523 Maximum size of memory mapped by the startup code of
3524 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003525 the Linux kernel (bd_info, boot arguments, FDT blob if
3526 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003527 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003528 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003529 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003530 variable "bootm_mapsize" will override the value of
3531 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3532 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003533
John Rigbyfca43cc2010-10-13 13:57:35 -06003534- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3535 Enable initrd_high functionality. If defined then the
3536 initrd_high feature is enabled and the bootm ramdisk subcommand
3537 is enabled.
3538
3539- CONFIG_SYS_BOOT_GET_CMDLINE:
3540 Enables allocating and saving kernel cmdline in space between
3541 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3542
3543- CONFIG_SYS_BOOT_GET_KBD:
3544 Enables allocating and saving a kernel copy of the bd_info in
3545 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003547- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003548 Max number of Flash memory banks
3549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003550- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003551 Max number of sectors on a Flash chip
3552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003553- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003554 Timeout for Flash erase operations (in ms)
3555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003557 Timeout for Flash write operations (in ms)
3558
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003559- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003560 Timeout for Flash set sector lock bit operation (in ms)
3561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003562- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003563 Timeout for Flash clear lock bits operation (in ms)
3564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003565- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003566 If defined, hardware flash sectors protection is used
3567 instead of U-Boot software protection.
3568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003569- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003570
3571 Enable TFTP transfers directly to flash memory;
3572 without this option such a download has to be
3573 performed in two steps: (1) download to RAM, and (2)
3574 copy from RAM to flash.
3575
3576 The two-step approach is usually more reliable, since
3577 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003578 the flash, but in some situations (when system RAM is
3579 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003580 downloaded image) this option may be very useful.
3581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003582- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003583 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003584 common flash structure for storing flash geometry.
3585
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003586- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003587 This option also enables the building of the cfi_flash driver
3588 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003589
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003590- CONFIG_FLASH_CFI_MTD
3591 This option enables the building of the cfi_mtd driver
3592 in the drivers directory. The driver exports CFI flash
3593 to the MTD layer.
3594
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003595- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003596 Use buffered writes to flash.
3597
3598- CONFIG_FLASH_SPANSION_S29WS_N
3599 s29ws-n MirrorBit flash has non-standard addresses for buffered
3600 write commands.
3601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003602- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003603 If this option is defined, the common CFI flash doesn't
3604 print it's warning upon not recognized FLASH banks. This
3605 is useful, if some of the configured banks are only
3606 optionally available.
3607
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003608- CONFIG_FLASH_SHOW_PROGRESS
3609 If defined (must be an integer), print out countdown
3610 digits and dots. Recommended value: 45 (9..1) for 80
3611 column displays, 15 (3..1) for 40 column displays.
3612
Stefan Roese352ef3f2013-04-04 15:53:14 +02003613- CONFIG_FLASH_VERIFY
3614 If defined, the content of the flash (destination) is compared
3615 against the source after the write operation. An error message
3616 will be printed when the contents are not identical.
3617 Please note that this option is useless in nearly all cases,
3618 since such flash programming errors usually are detected earlier
3619 while unprotecting/erasing/programming. Please only enable
3620 this option if you really know what you are doing.
3621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003622- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003623 Defines the number of Ethernet receive buffers. On some
3624 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003625 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3626 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003627 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003628 Defaults to 4 if not defined.
3629
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003630- CONFIG_ENV_MAX_ENTRIES
3631
Wolfgang Denk071bc922010-10-27 22:48:30 +02003632 Maximum number of entries in the hash table that is used
3633 internally to store the environment settings. The default
3634 setting is supposed to be generous and should work in most
3635 cases. This setting can be used to tune behaviour; see
3636 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003637
Joe Hershberger25980902012-12-11 22:16:31 -06003638- CONFIG_ENV_FLAGS_LIST_DEFAULT
3639- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003640 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003641 calling env set. Variables can be restricted to only decimal,
3642 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3643 the variables can also be restricted to IP address or MAC address.
3644
3645 The format of the list is:
3646 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003647 access_attribute = [a|r|o|c]
3648 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003649 entry = variable_name[:attributes]
3650 list = entry[,list]
3651
3652 The type attributes are:
3653 s - String (default)
3654 d - Decimal
3655 x - Hexadecimal
3656 b - Boolean ([1yYtT|0nNfF])
3657 i - IP address
3658 m - MAC address
3659
Joe Hershberger267541f2012-12-11 22:16:34 -06003660 The access attributes are:
3661 a - Any (default)
3662 r - Read-only
3663 o - Write-once
3664 c - Change-default
3665
Joe Hershberger25980902012-12-11 22:16:31 -06003666 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3667 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003668 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003669
3670 - CONFIG_ENV_FLAGS_LIST_STATIC
3671 Define this to a list (string) to define validation that
3672 should be done if an entry is not found in the ".flags"
3673 environment variable. To override a setting in the static
3674 list, simply add an entry for the same variable name to the
3675 ".flags" variable.
3676
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003677 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3678 regular expression. This allows multiple variables to define the same
3679 flags without explicitly listing them for each variable.
3680
Joe Hershberger267541f2012-12-11 22:16:34 -06003681- CONFIG_ENV_ACCESS_IGNORE_FORCE
3682 If defined, don't allow the -f switch to env set override variable
3683 access flags.
3684
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003685- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3686 This is set by OMAP boards for the max time that reset should
3687 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003688 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003689
Gabe Black0d296cc2014-10-15 04:38:30 -06003690- CONFIG_USE_STDINT
3691 If stdint.h is available with your toolchain you can define this
3692 option to enable it. You can provide option 'USE_STDINT=1' when
3693 building U-Boot to enable this.
3694
wdenkc6097192002-11-03 00:24:07 +00003695The following definitions that deal with the placement and management
3696of environment data (variable area); in general, we support the
3697following configurations:
3698
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003699- CONFIG_BUILD_ENVCRC:
3700
3701 Builds up envcrc with the target environment so that external utils
3702 may easily extract it and embed it in final U-Boot images.
3703
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003704- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003705
3706 Define this if the environment is in flash memory.
3707
3708 a) The environment occupies one whole flash sector, which is
3709 "embedded" in the text segment with the U-Boot code. This
3710 happens usually with "bottom boot sector" or "top boot
3711 sector" type flash chips, which have several smaller
3712 sectors at the start or the end. For instance, such a
3713 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3714 such a case you would place the environment in one of the
3715 4 kB sectors - with U-Boot code before and after it. With
3716 "top boot sector" type flash chips, you would put the
3717 environment in one of the last sectors, leaving a gap
3718 between U-Boot and the environment.
3719
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003720 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003721
3722 Offset of environment data (variable area) to the
3723 beginning of flash memory; for instance, with bottom boot
3724 type flash chips the second sector can be used: the offset
3725 for this sector is given here.
3726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003727 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003728
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003729 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003730
3731 This is just another way to specify the start address of
3732 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003733 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003734
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003735 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003736
3737 Size of the sector containing the environment.
3738
3739
3740 b) Sometimes flash chips have few, equal sized, BIG sectors.
3741 In such a case you don't want to spend a whole sector for
3742 the environment.
3743
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003744 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003745
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003746 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003747 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003748 of this flash sector for the environment. This saves
3749 memory for the RAM copy of the environment.
3750
3751 It may also save flash memory if you decide to use this
3752 when your environment is "embedded" within U-Boot code,
3753 since then the remainder of the flash sector could be used
3754 for U-Boot code. It should be pointed out that this is
3755 STRONGLY DISCOURAGED from a robustness point of view:
3756 updating the environment in flash makes it always
3757 necessary to erase the WHOLE sector. If something goes
3758 wrong before the contents has been restored from a copy in
3759 RAM, your target system will be dead.
3760
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003761 - CONFIG_ENV_ADDR_REDUND
3762 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk43d96162003-03-06 00:02:04 +00003764 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003765 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003766 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003767 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003768
3769BE CAREFUL! Any changes to the flash layout, and some changes to the
3770source code will make it necessary to adapt <board>/u-boot.lds*
3771accordingly!
3772
3773
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003774- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003775
3776 Define this if you have some non-volatile memory device
3777 (NVRAM, battery buffered SRAM) which you want to use for the
3778 environment.
3779
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003780 - CONFIG_ENV_ADDR:
3781 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003782
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003783 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003784 want to use for environment. It is assumed that this memory
3785 can just be read and written to, without any special
3786 provision.
3787
3788BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003789in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003790console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003791U-Boot will hang.
3792
3793Please note that even with NVRAM we still use a copy of the
3794environment in RAM: we could work on NVRAM directly, but we want to
3795keep settings there always unmodified except somebody uses "saveenv"
3796to save the current settings.
3797
3798
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003799- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003800
3801 Use this if you have an EEPROM or similar serial access
3802 device and a driver for it.
3803
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003804 - CONFIG_ENV_OFFSET:
3805 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003806
3807 These two #defines specify the offset and size of the
3808 environment area within the total memory of your EEPROM.
3809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003811 If defined, specified the chip address of the EEPROM device.
3812 The default address is zero.
3813
Christian Gmeiner189d2572015-02-11 15:19:31 +01003814 - CONFIG_SYS_I2C_EEPROM_BUS:
3815 If defined, specified the i2c bus of the EEPROM device.
3816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003817 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003818 If defined, the number of bits used to address bytes in a
3819 single page in the EEPROM device. A 64 byte page, for example
3820 would require six bits.
3821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003822 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003823 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003824 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003825
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003826 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003827 The length in bytes of the EEPROM memory array address. Note
3828 that this is NOT the chip address length!
3829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003830 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003831 EEPROM chips that implement "address overflow" are ones
3832 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3833 address and the extra bits end up in the "chip address" bit
3834 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3835 byte chips.
3836
3837 Note that we consider the length of the address field to
3838 still be one byte because the extra address bits are hidden
3839 in the chip address.
3840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003841 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003842 The size in bytes of the EEPROM device.
3843
Heiko Schocher548738b2010-01-07 08:55:40 +01003844 - CONFIG_ENV_EEPROM_IS_ON_I2C
3845 define this, if you have I2C and SPI activated, and your
3846 EEPROM, which holds the environment, is on the I2C bus.
3847
3848 - CONFIG_I2C_ENV_EEPROM_BUS
3849 if you have an Environment on an EEPROM reached over
3850 I2C muxes, you can define here, how to reach this
3851 EEPROM. For example:
3852
Heiko Schocherea818db2013-01-29 08:53:15 +01003853 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003854
3855 EEPROM which holds the environment, is reached over
3856 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003857
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003858- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003859
wdenkd4ca31c2004-01-02 14:00:00 +00003860 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003861 want to use for the environment.
3862
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003863 - CONFIG_ENV_OFFSET:
3864 - CONFIG_ENV_ADDR:
3865 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003866
3867 These three #defines specify the offset and size of the
3868 environment area within the total memory of your DataFlash placed
3869 at the specified address.
3870
Wu, Joshbd83b592014-07-01 19:30:13 +08003871- CONFIG_ENV_IS_IN_SPI_FLASH:
3872
3873 Define this if you have a SPI Flash memory device which you
3874 want to use for the environment.
3875
3876 - CONFIG_ENV_OFFSET:
3877 - CONFIG_ENV_SIZE:
3878
3879 These two #defines specify the offset and size of the
3880 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3881 aligned to an erase sector boundary.
3882
3883 - CONFIG_ENV_SECT_SIZE:
3884
3885 Define the SPI flash's sector size.
3886
3887 - CONFIG_ENV_OFFSET_REDUND (optional):
3888
3889 This setting describes a second storage area of CONFIG_ENV_SIZE
3890 size used to hold a redundant copy of the environment data, so
3891 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06003892 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Joshbd83b592014-07-01 19:30:13 +08003893 aligned to an erase sector boundary.
3894
3895 - CONFIG_ENV_SPI_BUS (optional):
3896 - CONFIG_ENV_SPI_CS (optional):
3897
3898 Define the SPI bus and chip select. If not defined they will be 0.
3899
3900 - CONFIG_ENV_SPI_MAX_HZ (optional):
3901
3902 Define the SPI max work clock. If not defined then use 1MHz.
3903
3904 - CONFIG_ENV_SPI_MODE (optional):
3905
3906 Define the SPI work mode. If not defined then use SPI_MODE_3.
3907
Liu Gang0a85a9e2012-03-08 00:33:20 +00003908- CONFIG_ENV_IS_IN_REMOTE:
3909
3910 Define this if you have a remote memory space which you
3911 want to use for the local device's environment.
3912
3913 - CONFIG_ENV_ADDR:
3914 - CONFIG_ENV_SIZE:
3915
3916 These two #defines specify the address and size of the
3917 environment area within the remote memory space. The
3918 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003919 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003920
3921BE CAREFUL! For some special cases, the local device can not use
3922"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003923environment stored in a remote NOR flash by SRIO or PCIE link,
3924but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003925
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003926- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003927
3928 Define this if you have a NAND device which you want to use
3929 for the environment.
3930
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003931 - CONFIG_ENV_OFFSET:
3932 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003933
3934 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003935 area within the first NAND device. CONFIG_ENV_OFFSET must be
3936 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003937
Scott Woodfdd813d2010-09-17 14:38:37 -05003938 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003939
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003940 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003941 size used to hold a redundant copy of the environment data, so
3942 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06003943 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003944 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003945
Scott Woodfdd813d2010-09-17 14:38:37 -05003946 - CONFIG_ENV_RANGE (optional):
3947
3948 Specifies the length of the region in which the environment
3949 can be written. This should be a multiple of the NAND device's
3950 block size. Specifying a range with more erase blocks than
3951 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3952 the range to be avoided.
3953
3954 - CONFIG_ENV_OFFSET_OOB (optional):
3955
3956 Enables support for dynamically retrieving the offset of the
3957 environment from block zero's out-of-band data. The
3958 "nand env.oob" command can be used to record this offset.
3959 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3960 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003961
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003962- CONFIG_NAND_ENV_DST
3963
3964 Defines address in RAM to which the nand_spl code should copy the
3965 environment. If redundant environment is used, it will be copied to
3966 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3967
Joe Hershberger2b744332013-04-08 10:32:51 +00003968- CONFIG_ENV_IS_IN_UBI:
3969
3970 Define this if you have an UBI volume that you want to use for the
3971 environment. This has the benefit of wear-leveling the environment
3972 accesses, which is important on NAND.
3973
3974 - CONFIG_ENV_UBI_PART:
3975
3976 Define this to a string that is the mtd partition containing the UBI.
3977
3978 - CONFIG_ENV_UBI_VOLUME:
3979
3980 Define this to the name of the volume that you want to store the
3981 environment in.
3982
Joe Hershberger785881f2013-04-08 10:32:52 +00003983 - CONFIG_ENV_UBI_VOLUME_REDUND:
3984
3985 Define this to the name of another volume to store a second copy of
3986 the environment in. This will enable redundant environments in UBI.
3987 It is assumed that both volumes are in the same MTD partition.
3988
Joe Hershberger2b744332013-04-08 10:32:51 +00003989 - CONFIG_UBI_SILENCE_MSG
3990 - CONFIG_UBIFS_SILENCE_MSG
3991
3992 You will probably want to define these to avoid a really noisy system
3993 when storing the env in UBI.
3994
Wu, Joshd1db76f2014-06-24 17:31:03 +08003995- CONFIG_ENV_IS_IN_FAT:
3996 Define this if you want to use the FAT file system for the environment.
3997
3998 - FAT_ENV_INTERFACE:
3999
4000 Define this to a string that is the name of the block device.
4001
Nicolae Rosia41987782016-11-21 17:33:58 +02004002 - FAT_ENV_DEVICE_AND_PART:
Wu, Joshd1db76f2014-06-24 17:31:03 +08004003
4004 Define this to a string to specify the partition of the device. It can
4005 be as following:
4006
4007 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4008 - "D:P": device D partition P. Error occurs if device D has no
4009 partition table.
4010 - "D:0": device D.
4011 - "D" or "D:": device D partition 1 if device D has partition
4012 table, or the whole device D if has no partition
4013 table.
4014 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004015 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004016 partition table then means device D.
4017
4018 - FAT_ENV_FILE:
4019
4020 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004021 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004022
4023 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004024 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004025
Stephen Warren06e4ae52013-06-11 15:14:00 -06004026- CONFIG_ENV_IS_IN_MMC:
4027
4028 Define this if you have an MMC device which you want to use for the
4029 environment.
4030
4031 - CONFIG_SYS_MMC_ENV_DEV:
4032
4033 Specifies which MMC device the environment is stored in.
4034
4035 - CONFIG_SYS_MMC_ENV_PART (optional):
4036
4037 Specifies which MMC partition the environment is stored in. If not
4038 set, defaults to partition 0, the user area. Common values might be
4039 1 (first MMC boot partition), 2 (second MMC boot partition).
4040
4041 - CONFIG_ENV_OFFSET:
4042 - CONFIG_ENV_SIZE:
4043
4044 These two #defines specify the offset and size of the environment
4045 area within the specified MMC device.
4046
Stephen Warren5c088ee2013-06-11 15:14:02 -06004047 If offset is positive (the usual case), it is treated as relative to
4048 the start of the MMC partition. If offset is negative, it is treated
4049 as relative to the end of the MMC partition. This can be useful if
4050 your board may be fitted with different MMC devices, which have
4051 different sizes for the MMC partitions, and you always want the
4052 environment placed at the very end of the partition, to leave the
4053 maximum possible space before it, to store other data.
4054
Stephen Warren06e4ae52013-06-11 15:14:00 -06004055 These two values are in units of bytes, but must be aligned to an
4056 MMC sector boundary.
4057
4058 - CONFIG_ENV_OFFSET_REDUND (optional):
4059
4060 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4061 hold a redundant copy of the environment data. This provides a
4062 valid backup copy in case the other copy is corrupted, e.g. due
4063 to a power failure during a "saveenv" operation.
4064
Stephen Warren5c088ee2013-06-11 15:14:02 -06004065 This value may also be positive or negative; this is handled in the
4066 same way as CONFIG_ENV_OFFSET.
4067
Stephen Warren06e4ae52013-06-11 15:14:00 -06004068 This value is also in units of bytes, but must also be aligned to
4069 an MMC sector boundary.
4070
4071 - CONFIG_ENV_SIZE_REDUND (optional):
4072
4073 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4074 set. If this value is set, it must be set to the same value as
4075 CONFIG_ENV_SIZE.
4076
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004077- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004078
4079 Defines offset to the initial SPI buffer area in DPRAM. The
4080 area is used at an early stage (ROM part) if the environment
4081 is configured to reside in the SPI EEPROM: We need a 520 byte
4082 scratch DPRAM area. It is used between the two initialization
4083 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4084 to be a good choice since it makes it far enough from the
4085 start of the data area as well as from the stack pointer.
4086
Bruce Adlere881cb52007-11-02 13:15:42 -07004087Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004088has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004089created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004090until then to read environment variables.
4091
wdenk85ec0bc2003-03-31 16:34:49 +00004092The environment is protected by a CRC32 checksum. Before the monitor
4093is relocated into RAM, as a result of a bad CRC you will be working
4094with the compiled-in default environment - *silently*!!! [This is
4095necessary, because the first environment variable we need is the
4096"baudrate" setting for the console - if we have a bad CRC, we don't
4097have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004098
4099Note: once the monitor has been relocated, then it will complain if
4100the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004101use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004103- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004104 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004106 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004107 also needs to be defined.
4108
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004109- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004110 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004111
Ron Madridf5675aa2009-02-18 14:30:44 -08004112- CONFIG_NS16550_MIN_FUNCTIONS:
4113 Define this if you desire to only have use of the NS16550_init
4114 and NS16550_putc functions for the serial driver located at
4115 drivers/serial/ns16550.c. This option is useful for saving
4116 space for already greatly restricted images, including but not
4117 limited to NAND_SPL configurations.
4118
Simon Glassb2b92f52012-11-30 13:01:18 +00004119- CONFIG_DISPLAY_BOARDINFO
4120 Display information about the board that U-Boot is running on
4121 when U-Boot starts up. The board function checkboard() is called
4122 to do this.
4123
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004124- CONFIG_DISPLAY_BOARDINFO_LATE
4125 Similar to the previous option, but display this information
4126 later, once stdio is running and output goes to the LCD, if
4127 present.
4128
Sascha Silbefeb85802013-08-11 16:40:43 +02004129- CONFIG_BOARD_SIZE_LIMIT:
4130 Maximum size of the U-Boot image. When defined, the
4131 build system checks that the actual size does not
4132 exceed it.
4133
wdenkc6097192002-11-03 00:24:07 +00004134Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004135---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004137- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004138 Cache Line Size of the CPU.
4139
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004140- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004141 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004142
wdenk42d1f032003-10-15 23:53:47 +00004143 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4144 and RPXsuper) to be able to adjust the position of
4145 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004146
Timur Tabie46fedf2011-08-04 18:03:41 -05004147- CONFIG_SYS_CCSRBAR_DEFAULT:
4148 Default (power-on reset) physical address of CCSR on Freescale
4149 PowerPC SOCs.
4150
4151- CONFIG_SYS_CCSRBAR:
4152 Virtual address of CCSR. On a 32-bit build, this is typically
4153 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4154
4155 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4156 for cross-platform code that uses that macro instead.
4157
4158- CONFIG_SYS_CCSRBAR_PHYS:
4159 Physical address of CCSR. CCSR can be relocated to a new
4160 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004161 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004162 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4163 is typically relocated on 36-bit builds. It is recommended
4164 that this macro be defined via the _HIGH and _LOW macros:
4165
4166 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4167 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4168
4169- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004170 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4171 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004172 used in assembly code, so it must not contain typecasts or
4173 integer size suffixes (e.g. "ULL").
4174
4175- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4176 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4177 used in assembly code, so it must not contain typecasts or
4178 integer size suffixes (e.g. "ULL").
4179
4180- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4181 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4182 forced to a value that ensures that CCSR is not relocated.
4183
wdenk7f6c2cb2002-11-10 22:06:23 +00004184- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004185 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004186
4187 the default drive number (default value 0)
4188
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004189 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004190
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004191 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004192 (default value 1)
4193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004194 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004195
wdenk43d96162003-03-06 00:02:04 +00004196 defines the offset of register from address. It
4197 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004198 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004200 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4201 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004202 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004204 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004205 fdc_hw_init() is called at the beginning of the FDC
4206 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004207 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004208 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004209
Macpaul Lin0abddf82011-04-11 20:45:32 +00004210- CONFIG_IDE_AHB:
4211 Most IDE controllers were designed to be connected with PCI
4212 interface. Only few of them were designed for AHB interface.
4213 When software is doing ATA command and data transfer to
4214 IDE devices through IDE-AHB controller, some additional
4215 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004216 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004218- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004219 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004220 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004222- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk7152b1d2003-09-05 23:19:14 +00004224 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004225 initial data and stack; please note that this must be
4226 writable memory that is working WITHOUT special
4227 initialization, i. e. you CANNOT use normal RAM which
4228 will become available only after programming the
4229 memory controller and running certain initialization
4230 sequences.
4231
4232 U-Boot uses the following memory types:
4233 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4234 - MPC824X: data cache
4235 - PPC4xx: data cache
4236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004237- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004238
4239 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004240 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4241 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004242 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004243 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06004244 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004245 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4246 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004247
4248 Note:
4249 On the MPC824X (or other systems that use the data
4250 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004251 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004252 point to an otherwise UNUSED address space between
4253 the top of RAM and the start of the PCI space.
4254
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004255- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004257- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004259- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004261- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004263- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004265- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004267- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004268 SDRAM timing
4269
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004270- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004271 periodic timer for refresh
4272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004273- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004275- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4276 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4277 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4278 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004279 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4280
4281- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004282 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4283 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004284 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004286- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4287 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004288 Machine Mode Register and Memory Periodic Timer
4289 Prescaler definitions (SDRAM timing)
4290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004291- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004292 enable I2C microcode relocation patch (MPC8xx);
4293 define relocation offset in DPRAM [DSP2]
4294
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004295- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004296 enable SMC microcode relocation patch (MPC8xx);
4297 define relocation offset in DPRAM [SMC1]
4298
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004299- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004300 enable SPI microcode relocation patch (MPC8xx);
4301 define relocation offset in DPRAM [SCC4]
4302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004303- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004304 Offset of the bootmode word in DPRAM used by post
4305 (Power On Self Tests). This definition overrides
4306 #define'd default value in commproc.h resp.
4307 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004309- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4310 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4311 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4312 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4313 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4314 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4315 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4316 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004317 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004318
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004319- CONFIG_PCI_DISABLE_PCIE:
4320 Disable PCI-Express on systems where it is supported but not
4321 required.
4322
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004323- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004324 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004325 Don't do any setup work, presumably because someone or
4326 something has already done it, and we don't need to do it
4327 a second time. Useful for platforms that are pre-booted
4328 by coreboot or similar.
4329
Gabor Juhos842033e2013-05-30 07:06:12 +00004330- CONFIG_PCI_INDIRECT_BRIDGE:
4331 Enable support for indirect PCI bridges.
4332
Kumar Galaa09b9b62010-12-30 12:09:53 -06004333- CONFIG_SYS_SRIO:
4334 Chip has SRIO or not
4335
4336- CONFIG_SRIO1:
4337 Board has SRIO 1 port available
4338
4339- CONFIG_SRIO2:
4340 Board has SRIO 2 port available
4341
Liu Gangc8b28152013-05-07 16:30:46 +08004342- CONFIG_SRIO_PCIE_BOOT_MASTER
4343 Board can support master function for Boot from SRIO and PCIE
4344
Kumar Galaa09b9b62010-12-30 12:09:53 -06004345- CONFIG_SYS_SRIOn_MEM_VIRT:
4346 Virtual Address of SRIO port 'n' memory region
4347
4348- CONFIG_SYS_SRIOn_MEM_PHYS:
4349 Physical Address of SRIO port 'n' memory region
4350
4351- CONFIG_SYS_SRIOn_MEM_SIZE:
4352 Size of SRIO port 'n' memory region
4353
Fabio Estevam66bd1842013-04-11 09:35:34 +00004354- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4355 Defined to tell the NAND controller that the NAND chip is using
4356 a 16 bit bus.
4357 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004358 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004359 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004360 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004361
4362- CONFIG_SYS_NDFC_EBC0_CFG
4363 Sets the EBC0_CFG register for the NDFC. If not defined
4364 a default value will be used.
4365
Ben Warrenbb99ad62006-09-07 16:50:54 -04004366- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004367 Get DDR timing information from an I2C EEPROM. Common
4368 with pluggable memory modules such as SODIMMs
4369
Ben Warrenbb99ad62006-09-07 16:50:54 -04004370 SPD_EEPROM_ADDRESS
4371 I2C address of the SPD EEPROM
4372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004373- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004374 If SPD EEPROM is on an I2C bus other than the first
4375 one, specify here. Note that the value must resolve
4376 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004377
York Sun1b3e3c42011-06-07 09:42:16 +08004378- CONFIG_SYS_DDR_RAW_TIMING
4379 Get DDR timing information from other than SPD. Common with
4380 soldered DDR chips onboard without SPD. DDR raw timing
4381 parameters are extracted from datasheet and hard-coded into
4382 header files or board specific files.
4383
York Sun6f5e1dc2011-09-16 13:21:35 -07004384- CONFIG_FSL_DDR_INTERACTIVE
4385 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4386
York Sune32d59a2015-01-06 13:18:55 -08004387- CONFIG_FSL_DDR_SYNC_REFRESH
4388 Enable sync of refresh for multiple controllers.
4389
York Sun4516ff82015-03-19 09:30:28 -07004390- CONFIG_FSL_DDR_BIST
4391 Enable built-in memory test for Freescale DDR controllers.
4392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004393- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004394 Only for 83xx systems. If specified, then DDR should
4395 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004396
wdenkc26e4542004-04-18 10:13:26 +00004397- CONFIG_ETHER_ON_FEC[12]
4398 Define to enable FEC[12] on a 8xx series processor.
4399
4400- CONFIG_FEC[12]_PHY
4401 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004402 to the given FEC; i. e.
4403 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004404 means that the PHY with address 4 is connected to FEC1
4405
4406 When set to -1, means to probe for first available.
4407
4408- CONFIG_FEC[12]_PHY_NORXERR
4409 The PHY does not have a RXERR line (RMII only).
4410 (so program the FEC to ignore it).
4411
4412- CONFIG_RMII
4413 Enable RMII mode for all FECs.
4414 Note that this is a global option, we can't
4415 have one FEC in standard MII mode and another in RMII mode.
4416
wdenk5cf91d62004-04-23 20:32:05 +00004417- CONFIG_CRC32_VERIFY
4418 Add a verify option to the crc32 command.
4419 The syntax is:
4420
4421 => crc32 -v <address> <count> <crc32>
4422
4423 Where address/count indicate a memory area
4424 and crc32 is the correct crc32 which the
4425 area should have.
4426
wdenk56523f12004-07-11 17:40:54 +00004427- CONFIG_LOOPW
4428 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004429 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004430
stroese7b466642004-12-16 18:46:55 +00004431- CONFIG_MX_CYCLIC
4432 Add the "mdc" and "mwc" memory commands. These are cyclic
4433 "md/mw" commands.
4434 Examples:
4435
wdenkefe2a4d2004-12-16 21:44:03 +00004436 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004437 This command will print 4 bytes (10,11,12,13) each 500 ms.
4438
wdenkefe2a4d2004-12-16 21:44:03 +00004439 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004440 This command will write 12345678 to address 100 all 10 ms.
4441
wdenkefe2a4d2004-12-16 21:44:03 +00004442 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004443 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004444
wdenk8aa1a2d2005-04-04 12:44:11 +00004445- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004446 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004447 low level initializations (like setting up the memory
4448 controller) are omitted and/or U-Boot does not
4449 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004450
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004451 Normally this variable MUST NOT be defined. The only
4452 exception is when U-Boot is loaded (to RAM) by some
4453 other boot loader or by a debugger which performs
4454 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004455
Simon Glassb5bd0982016-05-05 07:28:06 -06004456- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4457 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09004458 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06004459 instruction cache) is still performed.
4460
Aneesh V401bb302011-07-13 05:11:07 +00004461- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004462 Modifies the behaviour of start.S when compiling a loader
4463 that is executed before the actual U-Boot. E.g. when
4464 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004465
Ying Zhang3aa29de2013-08-16 15:16:15 +08004466- CONFIG_TPL_BUILD
4467 Modifies the behaviour of start.S when compiling a loader
4468 that is executed after the SPL and before the actual U-Boot.
4469 It is loaded by the SPL.
4470
Ying Zhang5df572f2013-05-20 14:07:23 +08004471- CONFIG_SYS_MPC85XX_NO_RESETVEC
4472 Only for 85xx systems. If this variable is specified, the section
4473 .resetvec is not kept and the section .bootpg is placed in the
4474 previous 4k of the .text section.
4475
Simon Glass4213fc22013-02-24 17:33:14 +00004476- CONFIG_ARCH_MAP_SYSMEM
4477 Generally U-Boot (and in particular the md command) uses
4478 effective address. It is therefore not necessary to regard
4479 U-Boot address as virtual addresses that need to be translated
4480 to physical addresses. However, sandbox requires this, since
4481 it maintains its own little RAM buffer which contains all
4482 addressable memory. This option causes some memory accesses
4483 to be mapped through map_sysmem() / unmap_sysmem().
4484
Simon Glass588a13f2013-02-14 04:18:54 +00004485- CONFIG_X86_RESET_VECTOR
4486 If defined, the x86 reset vector code is included. This is not
4487 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004488
Heiko Schocher16678eb2013-11-04 14:05:00 +01004489- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4490 Enables the RTC32K OSC on AM33xx based plattforms
4491
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004492- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4493 Option to disable subpage write in NAND driver
4494 driver that uses this:
4495 drivers/mtd/nand/davinci_nand.c
4496
Timur Tabif2717b42011-11-22 09:21:25 -06004497Freescale QE/FMAN Firmware Support:
4498-----------------------------------
4499
4500The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4501loading of "firmware", which is encoded in the QE firmware binary format.
4502This firmware often needs to be loaded during U-Boot booting, so macros
4503are used to identify the storage device (NOR flash, SPI, etc) and the address
4504within that device.
4505
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004506- CONFIG_SYS_FMAN_FW_ADDR
4507 The address in the storage device where the FMAN microcode is located. The
4508 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4509 is also specified.
4510
4511- CONFIG_SYS_QE_FW_ADDR
4512 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004513 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4514 is also specified.
4515
4516- CONFIG_SYS_QE_FMAN_FW_LENGTH
4517 The maximum possible size of the firmware. The firmware binary format
4518 has a field that specifies the actual size of the firmware, but it
4519 might not be possible to read any part of the firmware unless some
4520 local storage is allocated to hold the entire firmware first.
4521
4522- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4523 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4524 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4525 virtual address in NOR flash.
4526
4527- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4528 Specifies that QE/FMAN firmware is located in NAND flash.
4529 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4530
4531- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4532 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4533 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4534
Liu Gang292dc6c2012-03-08 00:33:18 +00004535- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4536 Specifies that QE/FMAN firmware is located in the remote (master)
4537 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004538 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4539 window->master inbound window->master LAW->the ucode address in
4540 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004541
J. German Riverab940ca62014-06-23 15:15:55 -07004542Freescale Layerscape Management Complex Firmware Support:
4543---------------------------------------------------------
4544The Freescale Layerscape Management Complex (MC) supports the loading of
4545"firmware".
4546This firmware often needs to be loaded during U-Boot booting, so macros
4547are used to identify the storage device (NOR flash, SPI, etc) and the address
4548within that device.
4549
4550- CONFIG_FSL_MC_ENET
4551 Enable the MC driver for Layerscape SoCs.
4552
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304553Freescale Layerscape Debug Server Support:
4554-------------------------------------------
4555The Freescale Layerscape Debug Server Support supports the loading of
4556"Debug Server firmware" and triggering SP boot-rom.
4557This firmware often needs to be loaded during U-Boot booting.
4558
York Sunc0492142015-12-07 11:08:58 -08004559- CONFIG_SYS_MC_RSV_MEM_ALIGN
4560 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304561
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02004562Reproducible builds
4563-------------------
4564
4565In order to achieve reproducible builds, timestamps used in the U-Boot build
4566process have to be set to a fixed value.
4567
4568This is done using the SOURCE_DATE_EPOCH environment variable.
4569SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4570option for U-Boot or an environment variable in U-Boot.
4571
4572SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4573
wdenkc6097192002-11-03 00:24:07 +00004574Building the Software:
4575======================
4576
Wolfgang Denk218ca722008-03-26 10:40:12 +01004577Building U-Boot has been tested in several native build environments
4578and in many different cross environments. Of course we cannot support
4579all possibly existing versions of cross development tools in all
4580(potentially obsolete) versions. In case of tool chain problems we
4581recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4582which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004583
Wolfgang Denk218ca722008-03-26 10:40:12 +01004584If you are not using a native environment, it is assumed that you
4585have GNU cross compiling tools available in your path. In this case,
4586you must set the environment variable CROSS_COMPILE in your shell.
4587Note that no changes to the Makefile or any other source files are
4588necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004589
Wolfgang Denk218ca722008-03-26 10:40:12 +01004590 $ CROSS_COMPILE=ppc_4xx-
4591 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004592
Peter Tyser2f8d3962009-03-13 18:54:51 -05004593Note: If you wish to generate Windows versions of the utilities in
4594 the tools directory you can use the MinGW toolchain
4595 (http://www.mingw.org). Set your HOST tools to the MinGW
4596 toolchain and execute 'make tools'. For example:
4597
4598 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4599
4600 Binaries such as tools/mkimage.exe will be created which can
4601 be executed on computers running Windows.
4602
Wolfgang Denk218ca722008-03-26 10:40:12 +01004603U-Boot is intended to be simple to build. After installing the
4604sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004605is done by typing:
4606
Holger Freytherab584d62014-08-04 09:26:05 +02004607 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004608
Holger Freytherab584d62014-08-04 09:26:05 +02004609where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004610rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612Note: for some board special configuration names may exist; check if
4613 additional information is available from the board vendor; for
4614 instance, the TQM823L systems are available without (standard)
4615 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004616 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004617
Holger Freytherab584d62014-08-04 09:26:05 +02004618 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004619 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004620
Holger Freytherab584d62014-08-04 09:26:05 +02004621 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00004622 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk2729af92004-05-03 20:45:30 +00004624 etc.
wdenkc6097192002-11-03 00:24:07 +00004625
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk2729af92004-05-03 20:45:30 +00004627Finally, type "make all", and you should get some working U-Boot
4628images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630- "u-boot.bin" is a raw binary image
4631- "u-boot" is an image in ELF binary format
4632- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004633
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004634By default the build is performed locally and the objects are saved
4635in the source directory. One of the two methods can be used to change
4636this behavior and build U-Boot to some external directory:
4637
46381. Add O= to the make command line invocations:
4639
4640 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004641 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004642 make O=/tmp/build all
4643
Timo Ketolaadbba992014-11-06 14:39:05 +020046442. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004645
Timo Ketolaadbba992014-11-06 14:39:05 +02004646 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004647 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004648 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004649 make all
4650
Timo Ketolaadbba992014-11-06 14:39:05 +02004651Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004652variable.
4653
wdenkc6097192002-11-03 00:24:07 +00004654
wdenk2729af92004-05-03 20:45:30 +00004655Please be aware that the Makefiles assume you are using GNU make, so
4656for instance on NetBSD you might need to use "gmake" instead of
4657native "make".
wdenkc6097192002-11-03 00:24:07 +00004658
wdenkc6097192002-11-03 00:24:07 +00004659
wdenk2729af92004-05-03 20:45:30 +00004660If the system board that you have is not listed, then you will need
4661to port U-Boot to your hardware platform. To do this, follow these
4662steps:
wdenkc6097192002-11-03 00:24:07 +00004663
Phil Sutter3c1496c2015-12-25 14:41:18 +010046641. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00004665 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01004666 the "Makefile" and a "<board>.c".
46672. Create a new configuration file "include/configs/<board>.h" for
4668 your board.
wdenk2729af92004-05-03 20:45:30 +000046693. If you're porting U-Boot to a new CPU, then also create a new
4670 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020046714. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000046725. Type "make", and you should get a working "u-boot.srec" file
4673 to be installed on your target system.
46746. Debug and solve any problems that might arise.
4675 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004676
wdenkc6097192002-11-03 00:24:07 +00004677
wdenk2729af92004-05-03 20:45:30 +00004678Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4679==============================================================
wdenkc6097192002-11-03 00:24:07 +00004680
Wolfgang Denk218ca722008-03-26 10:40:12 +01004681If you have modified U-Boot sources (for instance added a new board
4682or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004683provide feedback to the other developers. The feedback normally takes
4684the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004685official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004686
Wolfgang Denk218ca722008-03-26 10:40:12 +01004687But before you submit such a patch, please verify that your modifi-
4688cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004689the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06004690just run the buildman script (tools/buildman/buildman), which will
4691configure and build U-Boot for ALL supported system. Be warned, this
4692will take a while. Please see the buildman README, or run 'buildman -H'
4693for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004694
4695
wdenk2729af92004-05-03 20:45:30 +00004696See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004697
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk2729af92004-05-03 20:45:30 +00004699Monitor Commands - Overview:
4700============================
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702go - start application at address 'addr'
4703run - run commands in an environment variable
4704bootm - boot application image from memory
4705bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004706bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004707tftpboot- boot image via network using TFTP protocol
4708 and env variables "ipaddr" and "serverip"
4709 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004710tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004711rarpboot- boot image via network using RARP/TFTP protocol
4712diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4713loads - load S-Record file over serial line
4714loadb - load binary file over serial line (kermit mode)
4715md - memory display
4716mm - memory modify (auto-incrementing)
4717nm - memory modify (constant address)
4718mw - memory write (fill)
4719cp - memory copy
4720cmp - memory compare
4721crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004722i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004723sspi - SPI utility commands
4724base - print or set address offset
4725printenv- print environment variables
4726setenv - set environment variables
4727saveenv - save environment variables to persistent storage
4728protect - enable or disable FLASH write protection
4729erase - erase FLASH memory
4730flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004731nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004732bdinfo - print Board Info structure
4733iminfo - print header information for application image
4734coninfo - print console devices and informations
4735ide - IDE sub-system
4736loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004737loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004738mtest - simple RAM test
4739icache - enable or disable instruction cache
4740dcache - enable or disable data cache
4741reset - Perform RESET of the CPU
4742echo - echo args to console
4743version - print monitor version
4744help - print online help
4745? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004746
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748Monitor Commands - Detailed Description:
4749========================================
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751TODO.
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk2729af92004-05-03 20:45:30 +00004753For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004754
4755
wdenk2729af92004-05-03 20:45:30 +00004756Environment Variables:
4757======================
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk2729af92004-05-03 20:45:30 +00004759U-Boot supports user configuration using Environment Variables which
4760can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004761
wdenk2729af92004-05-03 20:45:30 +00004762Environment Variables are set using "setenv", printed using
4763"printenv", and saved to Flash using "saveenv". Using "setenv"
4764without a value can be used to delete a variable from the
4765environment. As long as you don't save the environment you are
4766working with an in-memory copy. In case the Flash area containing the
4767environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004768
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004769Some configuration options can be set using Environment Variables.
4770
4771List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004772
wdenk2729af92004-05-03 20:45:30 +00004773 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004774
wdenk2729af92004-05-03 20:45:30 +00004775 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk2729af92004-05-03 20:45:30 +00004777 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk2729af92004-05-03 20:45:30 +00004781 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004782
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004783 bootm_low - Memory range available for image processing in the bootm
4784 command can be restricted. This variable is given as
4785 a hexadecimal number and defines lowest address allowed
4786 for use by the bootm command. See also "bootm_size"
4787 environment variable. Address defined by "bootm_low" is
4788 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004789 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4790 bootm_mapsize.
4791
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004792 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004793 This variable is given as a hexadecimal number and it
4794 defines the size of the memory region starting at base
4795 address bootm_low that is accessible by the Linux kernel
4796 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4797 as the default value if it is defined, and bootm_size is
4798 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004799
4800 bootm_size - Memory range available for image processing in the bootm
4801 command can be restricted. This variable is given as
4802 a hexadecimal number and defines the size of the region
4803 allowed for use by the bootm command. See also "bootm_low"
4804 environment variable.
4805
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004806 updatefile - Location of the software update file on a TFTP server, used
4807 by the automatic software update feature. Please refer to
4808 documentation in doc/README.update for more details.
4809
wdenk2729af92004-05-03 20:45:30 +00004810 autoload - if set to "no" (any string beginning with 'n'),
4811 "bootp" will just load perform a lookup of the
4812 configuration from the BOOTP server, but not try to
4813 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk2729af92004-05-03 20:45:30 +00004815 autostart - if set to "yes", an image loaded using the "bootp",
4816 "rarpboot", "tftpboot" or "diskboot" commands will
4817 be automatically started (by internally calling
4818 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820 If set to "no", a standalone image passed to the
4821 "bootm" command will be copied to the load address
4822 (and eventually uncompressed), but NOT be started.
4823 This can be used to load and uncompress arbitrary
4824 data.
wdenkc6097192002-11-03 00:24:07 +00004825
David A. Longa28afca2011-07-09 16:40:19 -04004826 fdt_high - if set this restricts the maximum address that the
4827 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004828 For example, if you have a system with 1 GB memory
4829 at physical address 0x10000000, while Linux kernel
4830 only recognizes the first 704 MB as low memory, you
4831 may need to set fdt_high as 0x3C000000 to have the
4832 device tree blob be copied to the maximum address
4833 of the 704 MB low memory, so that Linux kernel can
4834 access it during the boot procedure.
4835
David A. Longa28afca2011-07-09 16:40:19 -04004836 If this is set to the special value 0xFFFFFFFF then
4837 the fdt will not be copied at all on boot. For this
4838 to work it must reside in writable memory, have
4839 sufficient padding on the end of it for u-boot to
4840 add the information it needs into it, and the memory
4841 must be accessible by the kernel.
4842
Simon Glasseea63e02011-10-24 19:15:34 +00004843 fdtcontroladdr- if set this is the address of the control flattened
4844 device tree used by U-Boot when CONFIG_OF_CONTROL is
4845 defined.
4846
wdenk17ea1172004-06-06 21:51:03 +00004847 i2cfast - (PPC405GP|PPC405EP only)
4848 if set to 'y' configures Linux I2C driver for fast
4849 mode (400kHZ). This environment variable is used in
4850 initialization code. So, for changes to be effective
4851 it must be saved and board must be reset.
4852
wdenk2729af92004-05-03 20:45:30 +00004853 initrd_high - restrict positioning of initrd images:
4854 If this variable is not set, initrd images will be
4855 copied to the highest possible address in RAM; this
4856 is usually what you want since it allows for
4857 maximum initrd size. If for some reason you want to
4858 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004859 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004860 variable to a value of "no" or "off" or "0".
4861 Alternatively, you can set it to a maximum upper
4862 address to use (U-Boot will still check that it
4863 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk2729af92004-05-03 20:45:30 +00004865 For instance, when you have a system with 16 MB
4866 RAM, and want to reserve 4 MB from use by Linux,
4867 you can do this by adding "mem=12M" to the value of
4868 the "bootargs" variable. However, now you must make
4869 sure that the initrd image is placed in the first
4870 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874 If you set initrd_high to 0xFFFFFFFF, this is an
4875 indication to U-Boot that all addresses are legal
4876 for the Linux kernel, including addresses in flash
4877 memory. In this case U-Boot will NOT COPY the
4878 ramdisk at all. This may be useful to reduce the
4879 boot time on your system, but requires that this
4880 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk2729af92004-05-03 20:45:30 +00004884 loadaddr - Default load address for commands like "bootp",
4885 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk2729af92004-05-03 20:45:30 +00004889 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk2729af92004-05-03 20:45:30 +00004895 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004896
Mike Frysingere2a53452011-10-02 10:01:27 +00004897 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004898
Mike Frysingere2a53452011-10-02 10:01:27 +00004899 ethact - controls which interface is currently active.
4900 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004901
Heiko Schocher48690d82010-07-20 17:45:02 +02004902 => setenv ethact FEC
4903 => ping 192.168.0.1 # traffic sent on FEC
4904 => setenv ethact SCC
4905 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004906
Matthias Fuchse1692572008-01-17 07:45:05 +01004907 ethrotate - When set to "no" U-Boot does not go through all
4908 available network interfaces.
4909 It just stays at the currently selected interface.
4910
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004911 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004912 either succeed or fail without retrying.
4913 When set to "once" the network operation will
4914 fail when all the available network interfaces
4915 are tried once without success.
4916 Useful on scripts which control the retry operation
4917 themselves.
wdenkc6097192002-11-03 00:24:07 +00004918
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004919 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004920
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004921 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07004922 changing the console to be empty. If "yes" it will be
4923 made silent. If "no" it will not be made silent. If
4924 unset, then it will be made silent if the U-Boot console
4925 is silent.
4926
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004927 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004928 UDP source port.
4929
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004930 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004931 destination port instead of the Well Know Port 69.
4932
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004933 tftpblocksize - Block size to use for TFTP transfers; if not set,
4934 we use the TFTP server's default block size
4935
4936 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4937 seconds, minimum value is 1000 = 1 second). Defines
4938 when a packet is considered to be lost so it has to
4939 be retransmitted. The default is 5000 = 5 seconds.
4940 Lowering this value may make downloads succeed
4941 faster in networks with high packet loss rates or
4942 with unreliable TFTP servers.
4943
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004944 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4945 unit, minimum value = 0). Defines how many timeouts
4946 can happen during a single file transfer before that
4947 transfer is aborted. The default is 10, and 0 means
4948 'no timeouts allowed'. Increasing this value may help
4949 downloads succeed with high packet loss rates, or with
4950 unreliable TFTP servers or client hardware.
4951
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004952 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004953 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004954 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004955
Alexandre Messier50768f52016-02-01 17:08:57 -05004956 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4957 Unsigned value, in milliseconds. If not set, the period will
4958 be either the default (28000), or a value based on
4959 CONFIG_NET_RETRY_COUNT, if defined. This value has
4960 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4961
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004962The following image location variables contain the location of images
4963used in booting. The "Image" column gives the role of the image and is
4964not an environment variable name. The other columns are environment
4965variable names. "File Name" gives the name of the file on a TFTP
4966server, "RAM Address" gives the location in RAM the image will be
4967loaded to, and "Flash Location" gives the image's address in NOR
4968flash or offset in NAND flash.
4969
4970*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004971boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004972boards use these variables for other purposes.
4973
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004974Image File Name RAM Address Flash Location
4975----- --------- ----------- --------------
4976u-boot u-boot u-boot_addr_r u-boot_addr
4977Linux kernel bootfile kernel_addr_r kernel_addr
4978device tree blob fdtfile fdt_addr_r fdt_addr
4979ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981The following environment variables may be used and automatically
4982updated by the network boot commands ("bootp" and "rarpboot"),
4983depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004984
wdenk2729af92004-05-03 20:45:30 +00004985 bootfile - see above
4986 dnsip - IP address of your Domain Name Server
4987 dnsip2 - IP address of your secondary Domain Name Server
4988 gatewayip - IP address of the Gateway (Router) to use
4989 hostname - Target hostname
4990 ipaddr - see above
4991 netmask - Subnet Mask
4992 rootpath - Pathname of the root filesystem on the NFS server
4993 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004994
wdenka3d991b2004-04-15 21:48:45 +00004995
wdenk2729af92004-05-03 20:45:30 +00004996There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004997
wdenk2729af92004-05-03 20:45:30 +00004998 serial# - contains hardware identification information such
4999 as type string and/or serial number
5000 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk2729af92004-05-03 20:45:30 +00005002These variables can be set only once (usually during manufacturing of
5003the board). U-Boot refuses to delete or overwrite these variables
5004once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005005
5006
wdenk2729af92004-05-03 20:45:30 +00005007Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk2729af92004-05-03 20:45:30 +00005009 ver - Contains the U-Boot version string as printed
5010 with the "version" command. This variable is
5011 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005012
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk2729af92004-05-03 20:45:30 +00005014Please note that changes to some configuration parameters may take
5015only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005016
stroesec1551ea2003-04-04 15:53:41 +00005017
Joe Hershberger170ab112012-12-11 22:16:24 -06005018Callback functions for environment variables:
5019---------------------------------------------
5020
5021For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005022when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005023be associated with arbitrary variables. On creation, overwrite, or
5024deletion, the callback will provide the opportunity for some side
5025effect to happen or for the change to be rejected.
5026
5027The callbacks are named and associated with a function using the
5028U_BOOT_ENV_CALLBACK macro in your board or driver code.
5029
5030These callbacks are associated with variables in one of two ways. The
5031static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5032in the board configuration to a string that defines a list of
5033associations. The list must be in the following format:
5034
5035 entry = variable_name[:callback_name]
5036 list = entry[,list]
5037
5038If the callback name is not specified, then the callback is deleted.
5039Spaces are also allowed anywhere in the list.
5040
5041Callbacks can also be associated by defining the ".callbacks" variable
5042with the same list format above. Any association in ".callbacks" will
5043override any association in the static list. You can define
5044CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005045".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005046
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005047If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5048regular expression. This allows multiple variables to be connected to
5049the same callback without explicitly listing them all out.
5050
Joe Hershberger170ab112012-12-11 22:16:24 -06005051
wdenk2729af92004-05-03 20:45:30 +00005052Command Line Parsing:
5053=====================
stroesec1551ea2003-04-04 15:53:41 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055There are two different command line parsers available with U-Boot:
5056the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005057
wdenk2729af92004-05-03 20:45:30 +00005058Old, simple command line parser:
5059--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061- supports environment variables (through setenv / saveenv commands)
5062- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005063- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005064- special characters ('$', ';') can be escaped by prefixing with '\',
5065 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005066 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005067- You can also escape text by enclosing in single apostrophes, for example:
5068 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk2729af92004-05-03 20:45:30 +00005070Hush shell:
5071-----------
wdenkf07771c2003-05-28 08:06:31 +00005072
wdenk2729af92004-05-03 20:45:30 +00005073- similar to Bourne shell, with control structures like
5074 if...then...else...fi, for...do...done; while...do...done,
5075 until...do...done, ...
5076- supports environment ("global") variables (through setenv / saveenv
5077 commands) and local shell variables (through standard shell syntax
5078 "name=value"); only environment variables can be used with "run"
5079 command
wdenkf07771c2003-05-28 08:06:31 +00005080
wdenk2729af92004-05-03 20:45:30 +00005081General rules:
5082--------------
wdenkf07771c2003-05-28 08:06:31 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084(1) If a command line (or an environment variable executed by a "run"
5085 command) contains several commands separated by semicolon, and
5086 one of these commands fails, then the remaining commands will be
5087 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005090 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005091 command will cause "run" to terminate, i. e. the remaining
5092 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005093
wdenk2729af92004-05-03 20:45:30 +00005094Note for Redundant Ethernet Interfaces:
5095=======================================
wdenkf07771c2003-05-28 08:06:31 +00005096
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005097Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005098such configurations and is capable of automatic selection of a
5099"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005100
wdenk2729af92004-05-03 20:45:30 +00005101Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5102MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5103"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005104
wdenk2729af92004-05-03 20:45:30 +00005105If the network interface stores some valid MAC address (for instance
5106in SROM), this is used as default address if there is NO correspon-
5107ding setting in the environment; if the corresponding environment
5108variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110o If the SROM has a valid MAC address, and there is no address in the
5111 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113o If there is no valid address in the SROM, and a definition in the
5114 environment exists, then the value from the environment variable is
5115 used.
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk2729af92004-05-03 20:45:30 +00005117o If both the SROM and the environment contain a MAC address, and
5118 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk2729af92004-05-03 20:45:30 +00005120o If both the SROM and the environment contain a MAC address, and the
5121 addresses differ, the value from the environment is used and a
5122 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk2729af92004-05-03 20:45:30 +00005124o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005125 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5126 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005127
Ben Warrenecee9322010-04-26 11:11:46 -07005128If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005129will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005130may be skipped by setting the appropriate 'ethmacskip' environment variable.
5131The naming convention is as follows:
5132"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk2729af92004-05-03 20:45:30 +00005134Image Formats:
5135==============
wdenkc6097192002-11-03 00:24:07 +00005136
Marian Balakowicz3310c542008-03-12 12:13:13 +01005137U-Boot is capable of booting (and performing other auxiliary operations on)
5138images in two formats:
5139
5140New uImage format (FIT)
5141-----------------------
5142
5143Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5144to Flattened Device Tree). It allows the use of images with multiple
5145components (several kernels, ramdisks, etc.), with contents protected by
5146SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5147
5148
5149Old uImage format
5150-----------------
5151
5152Old image format is based on binary files which can be basically anything,
5153preceded by a special header; see the definitions in include/image.h for
5154details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5157 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005158 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5159 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5160 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005161* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005162 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5163 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005164* Compression Type (uncompressed, gzip, bzip2)
5165* Load Address
5166* Entry Point
5167* Image Name
5168* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk2729af92004-05-03 20:45:30 +00005170The header is marked by a special Magic Number, and both the header
5171and the data portions of the image are secured against corruption by
5172CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005173
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175Linux Support:
5176==============
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178Although U-Boot should support any OS or standalone application
5179easily, the main focus has always been on Linux during the design of
5180U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182U-Boot includes many features that so far have been part of some
5183special "boot loader" code within the Linux kernel. Also, any
5184"initrd" images to be used are no longer part of one big Linux image;
5185instead, kernel and "initrd" are separate images. This implementation
5186serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk2729af92004-05-03 20:45:30 +00005188- the same features can be used for other OS or standalone
5189 applications (for instance: using compressed images to reduce the
5190 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192- it becomes much easier to port new Linux kernel versions because
5193 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195- the same Linux kernel image can now be used with different "initrd"
5196 images; of course this also means that different kernel images can
5197 be run with the same "initrd". This makes testing easier (you don't
5198 have to build a new "zImage.initrd" Linux image when you just
5199 change a file in your "initrd"). Also, a field-upgrade of the
5200 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005201
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk2729af92004-05-03 20:45:30 +00005203Linux HOWTO:
5204============
wdenkc6097192002-11-03 00:24:07 +00005205
wdenk2729af92004-05-03 20:45:30 +00005206Porting Linux to U-Boot based systems:
5207---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk2729af92004-05-03 20:45:30 +00005209U-Boot cannot save you from doing all the necessary modifications to
5210configure the Linux device drivers for use with your target hardware
5211(no, we don't intend to provide a full virtual machine interface to
5212Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005213
Stefan Roesea47a12b2010-04-15 16:07:28 +02005214But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk2729af92004-05-03 20:45:30 +00005216Just make sure your machine specific header file (for instance
5217include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005218Information structure as we define in include/asm-<arch>/u-boot.h,
5219and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005220as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005221
Simon Glass2eb31b12014-06-11 23:29:46 -06005222Note that U-Boot now has a driver model, a unified model for drivers.
5223If you are adding a new driver, plumb it into driver model. If there
5224is no uclass available, you are encouraged to create one. See
5225doc/driver-model.
5226
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk2729af92004-05-03 20:45:30 +00005228Configuring the Linux kernel:
5229-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231No specific requirements for U-Boot. Make sure you have some root
5232device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005233
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk2729af92004-05-03 20:45:30 +00005235Building a Linux Image:
5236-----------------------
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk2729af92004-05-03 20:45:30 +00005238With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5239not used. If you use recent kernel source, a new build target
5240"uImage" will exist which automatically builds an image usable by
5241U-Boot. Most older kernels also have support for a "pImage" target,
5242which was introduced for our predecessor project PPCBoot and uses a
5243100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk2729af92004-05-03 20:45:30 +00005245Example:
wdenkc6097192002-11-03 00:24:07 +00005246
Holger Freytherab584d62014-08-04 09:26:05 +02005247 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005248 make oldconfig
5249 make dep
5250 make uImage
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk2729af92004-05-03 20:45:30 +00005252The "uImage" build target uses a special tool (in 'tools/mkimage') to
5253encapsulate a compressed Linux kernel image with header information,
5254CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk2729af92004-05-03 20:45:30 +00005256* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk2729af92004-05-03 20:45:30 +00005260 ${CROSS_COMPILE}-objcopy -O binary \
5261 -R .note -R .comment \
5262 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005267
wdenk2729af92004-05-03 20:45:30 +00005268* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005269
wdenk2729af92004-05-03 20:45:30 +00005270 mkimage -A ppc -O linux -T kernel -C gzip \
5271 -a 0 -e 0 -n "Linux Kernel Image" \
5272 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005273
wdenk24ee89b2002-11-03 17:56:27 +00005274
wdenk2729af92004-05-03 20:45:30 +00005275The "mkimage" tool can also be used to create ramdisk images for use
5276with U-Boot, either separated from the Linux kernel image, or
5277combined into one file. "mkimage" encapsulates the images with a 64
5278byte header containing information about target architecture,
5279operating system, image type, compression method, entry points, time
5280stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005281
wdenk2729af92004-05-03 20:45:30 +00005282"mkimage" can be called in two ways: to verify existing images and
5283print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285In the first form (with "-l" option) mkimage lists the information
5286contained in the header of an existing U-Boot image; this includes
5287checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005288
wdenk2729af92004-05-03 20:45:30 +00005289 tools/mkimage -l image
5290 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005291
wdenk2729af92004-05-03 20:45:30 +00005292The second form (with "-d" option) is used to build a U-Boot image
5293from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005294
wdenk2729af92004-05-03 20:45:30 +00005295 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5296 -n name -d data_file image
5297 -A ==> set architecture to 'arch'
5298 -O ==> set operating system to 'os'
5299 -T ==> set image type to 'type'
5300 -C ==> set compression type 'comp'
5301 -a ==> set load address to 'addr' (hex)
5302 -e ==> set entry point to 'ep' (hex)
5303 -n ==> set image name to 'name'
5304 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005305
wdenk69459792004-05-29 16:53:29 +00005306Right now, all Linux kernels for PowerPC systems use the same load
5307address (0x00000000), but the entry point address depends on the
5308kernel version:
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk2729af92004-05-03 20:45:30 +00005310- 2.2.x kernels have the entry point at 0x0000000C,
5311- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk2729af92004-05-03 20:45:30 +00005315 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5316 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005317 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005318 > examples/uImage.TQM850L
5319 Image Name: 2.4.4 kernel for TQM850L
5320 Created: Wed Jul 19 02:34:59 2000
5321 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5322 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5323 Load Address: 0x00000000
5324 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk2729af92004-05-03 20:45:30 +00005326To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328 -> tools/mkimage -l examples/uImage.TQM850L
5329 Image Name: 2.4.4 kernel for TQM850L
5330 Created: Wed Jul 19 02:34:59 2000
5331 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5332 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5333 Load Address: 0x00000000
5334 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk2729af92004-05-03 20:45:30 +00005336NOTE: for embedded systems where boot time is critical you can trade
5337speed for memory and install an UNCOMPRESSED image instead: this
5338needs more space in Flash, but boots much faster since it does not
5339need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005340
Stefan Roesea47a12b2010-04-15 16:07:28 +02005341 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005342 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5343 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005344 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005345 > examples/uImage.TQM850L-uncompressed
5346 Image Name: 2.4.4 kernel for TQM850L
5347 Created: Wed Jul 19 02:34:59 2000
5348 Image Type: PowerPC Linux Kernel Image (uncompressed)
5349 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5350 Load Address: 0x00000000
5351 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005352
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk2729af92004-05-03 20:45:30 +00005354Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5355when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357 -> tools/mkimage -n 'Simple Ramdisk Image' \
5358 > -A ppc -O linux -T ramdisk -C gzip \
5359 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5360 Image Name: Simple Ramdisk Image
5361 Created: Wed Jan 12 14:01:50 2000
5362 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5363 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5364 Load Address: 0x00000000
5365 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005366
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005367The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5368option performs the converse operation of the mkimage's second form (the "-d"
5369option). Given an image built by mkimage, the dumpimage extracts a "data file"
5370from the image:
5371
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005372 tools/dumpimage -i image -T type -p position data_file
5373 -i ==> extract from the 'image' a specific 'data_file'
5374 -T ==> set image type to 'type'
5375 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005376
wdenkdb01a2e2004-04-15 23:14:49 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378Installing a Linux Image:
5379-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005380
wdenk2729af92004-05-03 20:45:30 +00005381To downloading a U-Boot image over the serial (console) interface,
5382you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005385
wdenk2729af92004-05-03 20:45:30 +00005386The 'objcopy' does not understand the information in the U-Boot
5387image header, so the resulting S-Record file will be relative to
5388address 0x00000000. To load it to a given address, you need to
5389specify the target address as 'offset' parameter with the 'loads'
5390command.
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392Example: install the image to address 0x40100000 (which on the
5393TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005396
wdenk2729af92004-05-03 20:45:30 +00005397 .......... done
5398 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk2729af92004-05-03 20:45:30 +00005400 => loads 40100000
5401 ## Ready for S-Record download ...
5402 ~>examples/image.srec
5403 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5404 ...
5405 15989 15990 15991 15992
5406 [file transfer complete]
5407 [connected]
5408 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005409
5410
wdenk2729af92004-05-03 20:45:30 +00005411You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005412this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005413corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk2729af92004-05-03 20:45:30 +00005415 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk2729af92004-05-03 20:45:30 +00005417 ## Checking Image at 40100000 ...
5418 Image Name: 2.2.13 for initrd on TQM850L
5419 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5420 Data Size: 335725 Bytes = 327 kB = 0 MB
5421 Load Address: 00000000
5422 Entry Point: 0000000c
5423 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005424
5425
wdenk2729af92004-05-03 20:45:30 +00005426Boot Linux:
5427-----------
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk2729af92004-05-03 20:45:30 +00005429The "bootm" command is used to boot an application that is stored in
5430memory (RAM or Flash). In case of a Linux kernel image, the contents
5431of the "bootargs" environment variable is passed to the kernel as
5432parameters. You can check and modify this variable using the
5433"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005434
5435
wdenk2729af92004-05-03 20:45:30 +00005436 => printenv bootargs
5437 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk2729af92004-05-03 20:45:30 +00005439 => 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 +00005440
wdenk2729af92004-05-03 20:45:30 +00005441 => printenv bootargs
5442 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 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444 => bootm 40020000
5445 ## Booting Linux kernel at 40020000 ...
5446 Image Name: 2.2.13 for NFS on TQM850L
5447 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5448 Data Size: 381681 Bytes = 372 kB = 0 MB
5449 Load Address: 00000000
5450 Entry Point: 0000000c
5451 Verifying Checksum ... OK
5452 Uncompressing Kernel Image ... OK
5453 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
5454 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5455 time_init: decrementer frequency = 187500000/60
5456 Calibrating delay loop... 49.77 BogoMIPS
5457 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5458 ...
wdenkc6097192002-11-03 00:24:07 +00005459
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005460If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005461the memory addresses of both the kernel and the initrd image (PPBCOOT
5462format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk2729af92004-05-03 20:45:30 +00005464 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005465
wdenk2729af92004-05-03 20:45:30 +00005466 ## Checking Image at 40100000 ...
5467 Image Name: 2.2.13 for initrd on TQM850L
5468 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5469 Data Size: 335725 Bytes = 327 kB = 0 MB
5470 Load Address: 00000000
5471 Entry Point: 0000000c
5472 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474 ## Checking Image at 40200000 ...
5475 Image Name: Simple Ramdisk Image
5476 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5477 Data Size: 566530 Bytes = 553 kB = 0 MB
5478 Load Address: 00000000
5479 Entry Point: 00000000
5480 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk2729af92004-05-03 20:45:30 +00005482 => bootm 40100000 40200000
5483 ## Booting Linux kernel at 40100000 ...
5484 Image Name: 2.2.13 for initrd on TQM850L
5485 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5486 Data Size: 335725 Bytes = 327 kB = 0 MB
5487 Load Address: 00000000
5488 Entry Point: 0000000c
5489 Verifying Checksum ... OK
5490 Uncompressing Kernel Image ... OK
5491 ## Loading RAMDisk Image at 40200000 ...
5492 Image Name: Simple Ramdisk Image
5493 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5494 Data Size: 566530 Bytes = 553 kB = 0 MB
5495 Load Address: 00000000
5496 Entry Point: 00000000
5497 Verifying Checksum ... OK
5498 Loading Ramdisk ... OK
5499 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
5500 Boot arguments: root=/dev/ram
5501 time_init: decrementer frequency = 187500000/60
5502 Calibrating delay loop... 49.77 BogoMIPS
5503 ...
5504 RAMDISK: Compressed image found at block 0
5505 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk2729af92004-05-03 20:45:30 +00005507 bash#
wdenkc6097192002-11-03 00:24:07 +00005508
Matthew McClintock02677682006-06-28 10:41:37 -05005509Boot Linux and pass a flat device tree:
5510-----------
5511
5512First, U-Boot must be compiled with the appropriate defines. See the section
5513titled "Linux Kernel Interface" above for a more in depth explanation. The
5514following is an example of how to start a kernel and pass an updated
5515flat device tree:
5516
5517=> print oftaddr
5518oftaddr=0x300000
5519=> print oft
5520oft=oftrees/mpc8540ads.dtb
5521=> tftp $oftaddr $oft
5522Speed: 1000, full duplex
5523Using TSEC0 device
5524TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5525Filename 'oftrees/mpc8540ads.dtb'.
5526Load address: 0x300000
5527Loading: #
5528done
5529Bytes transferred = 4106 (100a hex)
5530=> tftp $loadaddr $bootfile
5531Speed: 1000, full duplex
5532Using TSEC0 device
5533TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5534Filename 'uImage'.
5535Load address: 0x200000
5536Loading:############
5537done
5538Bytes transferred = 1029407 (fb51f hex)
5539=> print loadaddr
5540loadaddr=200000
5541=> print oftaddr
5542oftaddr=0x300000
5543=> bootm $loadaddr - $oftaddr
5544## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005545 Image Name: Linux-2.6.17-dirty
5546 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5547 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005548 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005549 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005550 Verifying Checksum ... OK
5551 Uncompressing Kernel Image ... OK
5552Booting using flat device tree at 0x300000
5553Using MPC85xx ADS machine description
5554Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5555[snip]
5556
5557
wdenk2729af92004-05-03 20:45:30 +00005558More About U-Boot Image Types:
5559------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005560
wdenk2729af92004-05-03 20:45:30 +00005561U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005562
wdenk2729af92004-05-03 20:45:30 +00005563 "Standalone Programs" are directly runnable in the environment
5564 provided by U-Boot; it is expected that (if they behave
5565 well) you can continue to work in U-Boot after return from
5566 the Standalone Program.
5567 "OS Kernel Images" are usually images of some Embedded OS which
5568 will take over control completely. Usually these programs
5569 will install their own set of exception handlers, device
5570 drivers, set up the MMU, etc. - this means, that you cannot
5571 expect to re-enter U-Boot except by resetting the CPU.
5572 "RAMDisk Images" are more or less just data blocks, and their
5573 parameters (address, size) are passed to an OS kernel that is
5574 being started.
5575 "Multi-File Images" contain several images, typically an OS
5576 (Linux) kernel image and one or more data images like
5577 RAMDisks. This construct is useful for instance when you want
5578 to boot over the network using BOOTP etc., where the boot
5579 server provides just a single image file, but you want to get
5580 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582 "Multi-File Images" start with a list of image sizes, each
5583 image size (in bytes) specified by an "uint32_t" in network
5584 byte order. This list is terminated by an "(uint32_t)0".
5585 Immediately after the terminating 0 follow the images, one by
5586 one, all aligned on "uint32_t" boundaries (size rounded up to
5587 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005588
wdenk2729af92004-05-03 20:45:30 +00005589 "Firmware Images" are binary images containing firmware (like
5590 U-Boot or FPGA images) which usually will be programmed to
5591 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005592
wdenk2729af92004-05-03 20:45:30 +00005593 "Script files" are command sequences that will be executed by
5594 U-Boot's command interpreter; this feature is especially
5595 useful when you configure U-Boot to use a real shell (hush)
5596 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005597
Marek Vasut44f074c2012-03-14 21:52:45 +00005598Booting the Linux zImage:
5599-------------------------
5600
5601On some platforms, it's possible to boot Linux zImage. This is done
5602using the "bootz" command. The syntax of "bootz" command is the same
5603as the syntax of "bootm" command.
5604
Tom Rini8ac28562013-05-16 11:40:11 -04005605Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005606kernel with raw initrd images. The syntax is slightly different, the
5607address of the initrd must be augmented by it's size, in the following
5608format: "<initrd addres>:<initrd size>".
5609
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611Standalone HOWTO:
5612=================
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk2729af92004-05-03 20:45:30 +00005614One of the features of U-Boot is that you can dynamically load and
5615run "standalone" applications, which can use some resources of
5616U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk2729af92004-05-03 20:45:30 +00005618Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620"Hello World" Demo:
5621-------------------
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk2729af92004-05-03 20:45:30 +00005623'examples/hello_world.c' contains a small "Hello World" Demo
5624application; it is automatically compiled when you build U-Boot.
5625It's configured to run at address 0x00040004, so you can play with it
5626like that:
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk2729af92004-05-03 20:45:30 +00005628 => loads
5629 ## Ready for S-Record download ...
5630 ~>examples/hello_world.srec
5631 1 2 3 4 5 6 7 8 9 10 11 ...
5632 [file transfer complete]
5633 [connected]
5634 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636 => go 40004 Hello World! This is a test.
5637 ## Starting application at 0x00040004 ...
5638 Hello World
5639 argc = 7
5640 argv[0] = "40004"
5641 argv[1] = "Hello"
5642 argv[2] = "World!"
5643 argv[3] = "This"
5644 argv[4] = "is"
5645 argv[5] = "a"
5646 argv[6] = "test."
5647 argv[7] = "<NULL>"
5648 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk2729af92004-05-03 20:45:30 +00005650 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652Another example, which demonstrates how to register a CPM interrupt
5653handler with the U-Boot code, can be found in 'examples/timer.c'.
5654Here, a CPM timer is set up to generate an interrupt every second.
5655The interrupt service routine is trivial, just printing a '.'
5656character, but this is just a demo program. The application can be
5657controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk2729af92004-05-03 20:45:30 +00005659 ? - print current values og the CPM Timer registers
5660 b - enable interrupts and start timer
5661 e - stop timer and disable interrupts
5662 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664 => loads
5665 ## Ready for S-Record download ...
5666 ~>examples/timer.srec
5667 1 2 3 4 5 6 7 8 9 10 11 ...
5668 [file transfer complete]
5669 [connected]
5670 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk2729af92004-05-03 20:45:30 +00005672 => go 40004
5673 ## Starting application at 0x00040004 ...
5674 TIMERS=0xfff00980
5675 Using timer 1
5676 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678Hit 'b':
5679 [q, b, e, ?] Set interval 1000000 us
5680 Enabling timer
5681Hit '?':
5682 [q, b, e, ?] ........
5683 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5684Hit '?':
5685 [q, b, e, ?] .
5686 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5687Hit '?':
5688 [q, b, e, ?] .
5689 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5690Hit '?':
5691 [q, b, e, ?] .
5692 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5693Hit 'e':
5694 [q, b, e, ?] ...Stopping timer
5695Hit 'q':
5696 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005697
5698
wdenk2729af92004-05-03 20:45:30 +00005699Minicom warning:
5700================
wdenk85ec0bc2003-03-31 16:34:49 +00005701
wdenk2729af92004-05-03 20:45:30 +00005702Over time, many people have reported problems when trying to use the
5703"minicom" terminal emulation program for serial download. I (wd)
5704consider minicom to be broken, and recommend not to use it. Under
5705Unix, I recommend to use C-Kermit for general purpose use (and
5706especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005707use "cu" for S-Record download ("loads" command). See
5708http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5709for help with kermit.
5710
wdenk85ec0bc2003-03-31 16:34:49 +00005711
wdenk2729af92004-05-03 20:45:30 +00005712Nevertheless, if you absolutely want to use it try adding this
5713configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005714
wdenk2729af92004-05-03 20:45:30 +00005715 Name Program Name U/D FullScr IO-Red. Multi
5716 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5717 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005718
5719
wdenk2729af92004-05-03 20:45:30 +00005720NetBSD Notes:
5721=============
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723Starting at version 0.9.2, U-Boot supports NetBSD both as host
5724(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005725
wdenk2729af92004-05-03 20:45:30 +00005726Building requires a cross environment; it is known to work on
5727NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5728need gmake since the Makefiles are not compatible with BSD make).
5729Note that the cross-powerpc package does not install include files;
5730attempting to build U-Boot will fail because <machine/ansi.h> is
5731missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733 # cd /usr/pkg/cross/powerpc-netbsd/include
5734 # mkdir powerpc
5735 # ln -s powerpc machine
5736 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5737 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739Native builds *don't* work due to incompatibilities between native
5740and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk2729af92004-05-03 20:45:30 +00005742Booting assumes that (the first part of) the image booted is a
5743stage-2 loader which in turn loads and then invokes the kernel
5744proper. Loader sources will eventually appear in the NetBSD source
5745tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005746meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005747
5748
wdenk2729af92004-05-03 20:45:30 +00005749Implementation Internals:
5750=========================
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752The following is not intended to be a complete description of every
5753implementation detail. However, it should help to understand the
5754inner workings of U-Boot and make it easier to port it to custom
5755hardware.
wdenkc6097192002-11-03 00:24:07 +00005756
5757
wdenk2729af92004-05-03 20:45:30 +00005758Initial Stack, Global Data:
5759---------------------------
wdenkc6097192002-11-03 00:24:07 +00005760
wdenk2729af92004-05-03 20:45:30 +00005761The implementation of U-Boot is complicated by the fact that U-Boot
5762starts running out of ROM (flash memory), usually without access to
5763system RAM (because the memory controller is not initialized yet).
5764This means that we don't have writable Data or BSS segments, and BSS
5765is not initialized as zero. To be able to get a C environment working
5766at all, we have to allocate at least a minimal stack. Implementation
5767options for this are defined and restricted by the CPU used: Some CPU
5768models provide on-chip memory (like the IMMR area on MPC8xx and
5769MPC826x processors), on others (parts of) the data cache can be
5770locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005771
Wolfgang Denk218ca722008-03-26 10:40:12 +01005772 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005773 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005774
wdenk2729af92004-05-03 20:45:30 +00005775 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5776 From: "Chris Hallinan" <clh@net1plus.com>
5777 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5778 ...
wdenk43d96162003-03-06 00:02:04 +00005779
wdenk2729af92004-05-03 20:45:30 +00005780 Correct me if I'm wrong, folks, but the way I understand it
5781 is this: Using DCACHE as initial RAM for Stack, etc, does not
5782 require any physical RAM backing up the cache. The cleverness
5783 is that the cache is being used as a temporary supply of
5784 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005785 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005786 can see how this works by studying the cache architecture and
5787 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005788
wdenk2729af92004-05-03 20:45:30 +00005789 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5790 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005791 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005792 option should work for you. Using CS 4 should be fine if your
5793 board designers haven't used it for something that would
5794 cause you grief during the initial boot! It is frequently not
5795 used.
wdenk43d96162003-03-06 00:02:04 +00005796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005797 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005798 with your processor/board/system design. The default value
5799 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005800 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005801 than your SDRAM module. If you have a 64MB SDRAM module, set
5802 it above 400_0000. Just make sure your board has no resources
5803 that are supposed to respond to that address! That code in
5804 start.S has been around a while and should work as is when
5805 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005806
wdenk2729af92004-05-03 20:45:30 +00005807 -Chris Hallinan
5808 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005809
wdenk2729af92004-05-03 20:45:30 +00005810It is essential to remember this, since it has some impact on the C
5811code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk2729af92004-05-03 20:45:30 +00005813* Initialized global data (data segment) is read-only. Do not attempt
5814 to write it.
wdenkc6097192002-11-03 00:24:07 +00005815
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005816* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00005817 as zero data - BSS segment) at all - this is undefined, initiali-
5818 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk2729af92004-05-03 20:45:30 +00005820* Stack space is very limited. Avoid big data buffers or things like
5821 that.
wdenkc6097192002-11-03 00:24:07 +00005822
wdenk2729af92004-05-03 20:45:30 +00005823Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005824normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00005825turned out that the implementation of U-Boot can be greatly
5826simplified by making a global data structure (gd_t) available to all
5827functions. We could pass a pointer to this data as argument to _all_
5828functions, but this would bloat the code. Instead we use a feature of
5829the GCC compiler (Global Register Variables) to share the data: we
5830place a pointer (gd) to the global data into a register which we
5831reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk2729af92004-05-03 20:45:30 +00005833When choosing a register for such a purpose we are restricted by the
5834relevant (E)ABI specifications for the current architecture, and by
5835GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005836
wdenk2729af92004-05-03 20:45:30 +00005837For PowerPC, the following registers have specific use:
5838 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005839 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005840 R3-R4: parameter passing and return values
5841 R5-R10: parameter passing
5842 R13: small data area pointer
5843 R30: GOT pointer
5844 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005845
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005846 (U-Boot also uses R12 as internal GOT pointer. r12
5847 is a volatile register so r12 needs to be reset when
5848 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005849
Wolfgang Denke7670f62008-02-14 22:43:22 +01005850 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk2729af92004-05-03 20:45:30 +00005852 Note: on PPC, we could use a static initializer (since the
5853 address of the global data structure is known at compile time),
5854 but it turned out that reserving a register results in somewhat
5855 smaller code - although the code savings are not that big (on
5856 average for all boards 752 bytes for the whole U-Boot image,
5857 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005858
wdenk2729af92004-05-03 20:45:30 +00005859On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk2729af92004-05-03 20:45:30 +00005861 R0: function argument word/integer result
5862 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005863 R9: platform specific
5864 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005865 R11: argument (frame) pointer
5866 R12: temporary workspace
5867 R13: stack pointer
5868 R14: link register
5869 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005870
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005871 ==> U-Boot will use R9 to hold a pointer to the global data
5872
5873 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005874
Thomas Chou0df01fd2010-05-21 11:08:03 +08005875On Nios II, the ABI is documented here:
5876 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5877
5878 ==> U-Boot will use gp to hold a pointer to the global data
5879
5880 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5881 to access small data sections, so gp is free.
5882
Macpaul Linafc1ce82011-10-19 20:41:11 +00005883On NDS32, the following registers are used:
5884
5885 R0-R1: argument/return
5886 R2-R5: argument
5887 R15: temporary register for assembler
5888 R16: trampoline register
5889 R28: frame pointer (FP)
5890 R29: global pointer (GP)
5891 R30: link register (LP)
5892 R31: stack pointer (SP)
5893 PC: program counter (PC)
5894
5895 ==> U-Boot will use R10 to hold a pointer to the global data
5896
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005897NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5898or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk2729af92004-05-03 20:45:30 +00005900Memory Management:
5901------------------
wdenkc6097192002-11-03 00:24:07 +00005902
wdenk2729af92004-05-03 20:45:30 +00005903U-Boot runs in system state and uses physical addresses, i.e. the
5904MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005905
wdenk2729af92004-05-03 20:45:30 +00005906The available memory is mapped to fixed addresses using the memory
5907controller. In this process, a contiguous block is formed for each
5908memory type (Flash, SDRAM, SRAM), even when it consists of several
5909physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk2729af92004-05-03 20:45:30 +00005911U-Boot is installed in the first 128 kB of the first Flash bank (on
5912TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5913booting and sizing and initializing DRAM, the code relocates itself
5914to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005915memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005916configuration setting]. Below that, a structure with global Board
5917Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk2729af92004-05-03 20:45:30 +00005919Additionally, some exception handler code is copied to the low 8 kB
5920of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk2729af92004-05-03 20:45:30 +00005922So a typical memory configuration with 16 MB of DRAM could look like
5923this:
wdenkc6097192002-11-03 00:24:07 +00005924
wdenk2729af92004-05-03 20:45:30 +00005925 0x0000 0000 Exception Vector code
5926 :
5927 0x0000 1FFF
5928 0x0000 2000 Free for Application Use
5929 :
5930 :
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk2729af92004-05-03 20:45:30 +00005932 :
5933 :
5934 0x00FB FF20 Monitor Stack (Growing downward)
5935 0x00FB FFAC Board Info Data and permanent copy of global data
5936 0x00FC 0000 Malloc Arena
5937 :
5938 0x00FD FFFF
5939 0x00FE 0000 RAM Copy of Monitor Code
5940 ... eventually: LCD or video framebuffer
5941 ... eventually: pRAM (Protected RAM - unchanged by reset)
5942 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005943
5944
wdenk2729af92004-05-03 20:45:30 +00005945System Initialization:
5946----------------------
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk2729af92004-05-03 20:45:30 +00005948In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005949(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005950configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005951To be able to re-map memory U-Boot then jumps to its link address.
5952To be able to implement the initialization code in C, a (small!)
5953initial stack is set up in the internal Dual Ported RAM (in case CPUs
5954which provide such a feature like MPC8xx or MPC8260), or in a locked
5955part of the data cache. After that, U-Boot initializes the CPU core,
5956the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005957
wdenk2729af92004-05-03 20:45:30 +00005958Next, all (potentially) available memory banks are mapped using a
5959preliminary mapping. For example, we put them on 512 MB boundaries
5960(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5961on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5962programmed for SDRAM access. Using the temporary configuration, a
5963simple memory test is run that determines the size of the SDRAM
5964banks.
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk2729af92004-05-03 20:45:30 +00005966When there is more than one SDRAM bank, and the banks are of
5967different size, the largest is mapped first. For equal size, the first
5968bank (CS2#) is mapped first. The first mapping is always for address
59690x00000000, with any additional banks following immediately to create
5970contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005971
wdenk2729af92004-05-03 20:45:30 +00005972Then, the monitor installs itself at the upper end of the SDRAM area
5973and allocates memory for use by malloc() and for the global Board
5974Info data; also, the exception vector code is copied to the low RAM
5975pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk2729af92004-05-03 20:45:30 +00005977Only after this relocation will you have a "normal" C environment;
5978until that you are restricted in several ways, mostly because you are
5979running from ROM, and because the code will have to be relocated to a
5980new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005981
5982
wdenk2729af92004-05-03 20:45:30 +00005983U-Boot Porting Guide:
5984----------------------
wdenkc6097192002-11-03 00:24:07 +00005985
wdenk2729af92004-05-03 20:45:30 +00005986[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5987list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005988
5989
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005990int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005991{
5992 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005993
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005994 signal(SIGALRM, no_more_time);
5995 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005996
wdenk2729af92004-05-03 20:45:30 +00005997 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005998 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005999 return 0;
6000 }
6001
wdenk2729af92004-05-03 20:45:30 +00006002 Download latest U-Boot source;
6003
Wolfgang Denk06682362008-12-30 22:56:11 +01006004 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006005
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006006 if (clueless)
6007 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk2729af92004-05-03 20:45:30 +00006009 while (learning) {
6010 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006011 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6012 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006013 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006014 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006015 }
wdenkc6097192002-11-03 00:24:07 +00006016
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006017 if (available_money > toLocalCurrency ($2500))
6018 Buy a BDI3000;
6019 else
wdenk2729af92004-05-03 20:45:30 +00006020 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006021
6022 if (a similar board exists) { /* hopefully... */
6023 cp -a board/<similar> board/<myboard>
6024 cp include/configs/<similar>.h include/configs/<myboard>.h
6025 } else {
6026 Create your own board support subdirectory;
6027 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006028 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006029 Edit new board/<myboard> files
6030 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006031
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006032 while (!accepted) {
6033 while (!running) {
6034 do {
6035 Add / modify source code;
6036 } until (compiles);
6037 Debug;
6038 if (clueless)
6039 email("Hi, I am having problems...");
6040 }
6041 Send patch file to the U-Boot email list;
6042 if (reasonable critiques)
6043 Incorporate improvements from email list code review;
6044 else
6045 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006046 }
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk2729af92004-05-03 20:45:30 +00006048 return 0;
6049}
6050
6051void no_more_time (int sig)
6052{
6053 hire_a_guru();
6054}
wdenkc6097192002-11-03 00:24:07 +00006055
6056
wdenk2729af92004-05-03 20:45:30 +00006057Coding Standards:
6058-----------------
wdenkc6097192002-11-03 00:24:07 +00006059
wdenk2729af92004-05-03 20:45:30 +00006060All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006061coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006062"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006063
Detlev Zundel2c051652006-09-01 15:39:02 +02006064Source files originating from a different project (for example the
6065MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006066reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006067sources.
6068
6069Please note that U-Boot is implemented in C (and to some small parts in
6070Assembler); no C++ is used, so please do not use C++ style comments (//)
6071in your code.
wdenk2729af92004-05-03 20:45:30 +00006072
6073Please also stick to the following formatting rules:
6074- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006075- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006076- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006077- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006078- do not add trailing empty lines to source files
6079
6080Submissions which do not conform to the standards may be returned
6081with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006082
6083
wdenk2729af92004-05-03 20:45:30 +00006084Submitting Patches:
6085-------------------
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk2729af92004-05-03 20:45:30 +00006087Since the number of patches for U-Boot is growing, we need to
6088establish some rules. Submissions which do not conform to these rules
6089may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006090
Magnus Lilja0d28f342008-08-06 19:32:33 +02006091Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006092
Wolfgang Denk06682362008-12-30 22:56:11 +01006093Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6094see http://lists.denx.de/mailman/listinfo/u-boot
6095
wdenk2729af92004-05-03 20:45:30 +00006096When you send a patch, please include the following information with
6097it:
wdenkc6097192002-11-03 00:24:07 +00006098
wdenk2729af92004-05-03 20:45:30 +00006099* For bug fixes: a description of the bug and how your patch fixes
6100 this bug. Please try to include a way of demonstrating that the
6101 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006102
wdenk2729af92004-05-03 20:45:30 +00006103* For new features: a description of the feature and your
6104 implementation.
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk2729af92004-05-03 20:45:30 +00006106* A CHANGELOG entry as plaintext (separate from the patch)
6107
Robert P. J. Day7207b362015-12-19 07:16:10 -05006108* For major contributions, add a MAINTAINERS file with your
6109 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006110
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006111* When you add support for a new board, don't forget to add a
6112 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006113
6114* If your patch adds new configuration options, don't forget to
6115 document these in the README file.
6116
Wolfgang Denk218ca722008-03-26 10:40:12 +01006117* The patch itself. If you are using git (which is *strongly*
6118 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006119 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006120 the U-Boot mailing list, you will avoid most of the common problems
6121 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006122
Wolfgang Denk218ca722008-03-26 10:40:12 +01006123 If you cannot use git, use "diff -purN OLD NEW". If your version of
6124 diff does not support these options, then get the latest version of
6125 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006126
Wolfgang Denk218ca722008-03-26 10:40:12 +01006127 The current directory when running this command shall be the parent
6128 directory of the U-Boot source tree (i. e. please make sure that
6129 your patch includes sufficient directory information for the
6130 affected files).
6131
6132 We prefer patches as plain text. MIME attachments are discouraged,
6133 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006134
6135* If one logical set of modifications affects or creates several
6136 files, all these changes shall be submitted in a SINGLE patch file.
6137
6138* Changesets that contain different, unrelated modifications shall be
6139 submitted as SEPARATE patches, one patch per changeset.
6140
6141
6142Notes:
6143
Simon Glass6de80f22016-07-27 20:33:08 -06006144* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00006145 source tree and make sure that no errors or warnings are reported
6146 for any of the boards.
6147
6148* Keep your modifications to the necessary minimum: A patch
6149 containing several unrelated changes or arbitrary reformats will be
6150 returned with a request to re-formatting / split it.
6151
6152* If you modify existing code, make sure that your new code does not
6153 add to the memory footprint of the code ;-) Small is beautiful!
6154 When adding new features, these should compile conditionally only
6155 (using #ifdef), and the resulting code with the new feature
6156 disabled must not need more memory than the old code without your
6157 modification.
wdenk90dc6702005-05-03 14:12:25 +00006158
Wolfgang Denk06682362008-12-30 22:56:11 +01006159* Remember that there is a size limit of 100 kB per message on the
6160 u-boot mailing list. Bigger patches will be moderated. If they are
6161 reasonable and not too big, they will be acknowledged. But patches
6162 bigger than the size limit should be avoided.