blob: b055ae7ef29c71ca65917f0f5858e58308fec419 [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 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000142 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400144 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200145 /powerpc Files generic to PowerPC architecture
Rick Chen3fafced2017-12-26 13:55:59 +0800146 /riscv Files generic to RISC-V 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
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700296 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
Ashish Kumar63b23162017-08-11 11:09:14 +0530316- ARM Platform Bus Type(CCI):
317 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
318 provides full cache coherency between two clusters of multi-core
319 CPUs and I/O coherency for devices and I/O masters
320
321 CONFIG_SYS_FSL_HAS_CCI400
322
323 Defined For SoC that has cache coherent interconnect
324 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000325
Ashish Kumarc055cee2017-08-18 10:54:36 +0530326 CONFIG_SYS_FSL_HAS_CCN504
327
328 Defined for SoC that has cache coherent interconnect CCN-504
329
wdenkc6097192002-11-03 00:24:07 +0000330The following options need to be configured:
331
Kim Phillips26281142007-08-10 13:28:25 -0500332- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000333
Kim Phillips26281142007-08-10 13:28:25 -0500334- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200335
Lei Wencf946c62011-02-09 18:06:58 +0530336- Marvell Family Member
337 CONFIG_SYS_MVFS - define it if you want to enable
338 multiple fs option at one time
339 for marvell soc family
340
Kumar Gala66412c62011-02-18 05:40:54 -0600341- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000342 CONFIG_SYS_PPC64
343
344 Specifies that the core is a 64-bit PowerPC implementation (implements
345 the "64" category of the Power ISA). This is necessary for ePAPR
346 compliance, among other possible reasons.
347
Kumar Gala66412c62011-02-18 05:40:54 -0600348 CONFIG_SYS_FSL_TBCLK_DIV
349
350 Defines the core time base clock divider ratio compared to the
351 system clock. On most PQ3 devices this is 8, on newer QorIQ
352 devices it can be 16 or 32. The ratio varies from SoC to Soc.
353
Kumar Gala8f290842011-05-20 00:39:21 -0500354 CONFIG_SYS_FSL_PCIE_COMPAT
355
356 Defines the string to utilize when trying to match PCIe device
357 tree nodes for the given platform.
358
Scott Wood33eee332012-08-14 10:14:53 +0000359 CONFIG_SYS_FSL_ERRATUM_A004510
360
361 Enables a workaround for erratum A004510. If set,
362 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
364
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
367
368 Defines one or two SoC revisions (low 8 bits of SVR)
369 for which the A004510 workaround should be applied.
370
371 The rest of SVR is either not relevant to the decision
372 of whether the erratum is present (e.g. p2040 versus
373 p2041) or is implied by the build target, which controls
374 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
375
376 See Freescale App Note 4493 for more information about
377 this erratum.
378
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530379 CONFIG_A003399_NOR_WORKAROUND
380 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800381 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530382
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530383 CONFIG_A008044_WORKAROUND
384 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800385 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530386
Scott Wood33eee332012-08-14 10:14:53 +0000387 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
388
389 This is the value to write into CCSR offset 0x18600
390 according to the A004510 workaround.
391
Priyanka Jain64501c62013-07-02 09:21:04 +0530392 CONFIG_SYS_FSL_DSP_DDR_ADDR
393 This value denotes start offset of DDR memory which is
394 connected exclusively to the DSP cores.
395
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530396 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397 This value denotes start offset of M2 memory
398 which is directly connected to the DSP core.
399
Priyanka Jain64501c62013-07-02 09:21:04 +0530400 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401 This value denotes start offset of M3 memory which is directly
402 connected to the DSP core.
403
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530404 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405 This value denotes start offset of DSP CCSR space.
406
Priyanka Jainb1359912013-12-17 14:25:52 +0530407 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408 Single Source Clock is clocking mode present in some of FSL SoC's.
409 In this mode, a single differential clock is used to supply
410 clocks to the sysclock, ddrclock and usbclock.
411
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530412 CONFIG_SYS_CPC_REINIT_F
413 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800414 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530415
Tang Yuantianaade2002014-04-17 15:33:46 +0800416 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800417 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800418 supported, core will start to execute uboot when wakes up.
419
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000420- Generic CPU options:
421 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
422
423 Defines the endianess of the CPU. Implementation of those
424 values is arch specific.
425
York Sun5614e712013-09-30 09:22:09 -0700426 CONFIG_SYS_FSL_DDR
427 Freescale DDR driver in use. This type of DDR controller is
428 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
429 SoCs.
430
431 CONFIG_SYS_FSL_DDR_ADDR
432 Freescale DDR memory-mapped register base.
433
434 CONFIG_SYS_FSL_DDR_EMU
435 Specify emulator support for DDR. Some DDR features such as
436 deskew training are not available.
437
438 CONFIG_SYS_FSL_DDRC_GEN1
439 Freescale DDR1 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN2
442 Freescale DDR2 controller.
443
444 CONFIG_SYS_FSL_DDRC_GEN3
445 Freescale DDR3 controller.
446
York Sun34e026f2014-03-27 17:54:47 -0700447 CONFIG_SYS_FSL_DDRC_GEN4
448 Freescale DDR4 controller.
449
York Sun9ac4ffb2013-09-30 14:20:51 -0700450 CONFIG_SYS_FSL_DDRC_ARM_GEN3
451 Freescale DDR3 controller for ARM-based SoCs.
452
York Sun5614e712013-09-30 09:22:09 -0700453 CONFIG_SYS_FSL_DDR1
454 Board config to use DDR1. It can be enabled for SoCs with
455 Freescale DDR1 or DDR2 controllers, depending on the board
456 implemetation.
457
458 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400459 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700460 Freescale DDR2 or DDR3 controllers, depending on the board
461 implementation.
462
463 CONFIG_SYS_FSL_DDR3
464 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700465 Freescale DDR3 or DDR3L controllers.
466
467 CONFIG_SYS_FSL_DDR3L
468 Board config to use DDR3L. It can be enabled for SoCs with
469 DDR3L controllers.
470
471 CONFIG_SYS_FSL_DDR4
472 Board config to use DDR4. It can be enabled for SoCs with
473 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700474
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
477
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
480
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530481 CONFIG_SYS_FSL_IFC_CLK_DIV
482 Defines divider of platform clock(clock input to IFC controller).
483
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530484 CONFIG_SYS_FSL_LBC_CLK_DIV
485 Defines divider of platform clock(clock input to eLBC controller).
486
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530487 CONFIG_SYS_FSL_PBL_PBI
488 It enables addition of RCW (Power on reset configuration) in built image.
489 Please refer doc/README.pblimage for more details
490
491 CONFIG_SYS_FSL_PBL_RCW
492 It adds PBI(pre-boot instructions) commands in u-boot build image.
493 PBI commands can be used to configure SoC before it starts the execution.
494 Please refer doc/README.pblimage for more details
495
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530496 CONFIG_SPL_FSL_PBL
497 It adds a target to create boot binary having SPL binary in PBI format
498 concatenated with u-boot binary.
499
York Sun4e5b1bd2014-02-10 13:59:42 -0800500 CONFIG_SYS_FSL_DDR_BE
501 Defines the DDR controller register space as Big Endian
502
503 CONFIG_SYS_FSL_DDR_LE
504 Defines the DDR controller register space as Little Endian
505
York Sun6b9e3092014-02-10 13:59:43 -0800506 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
507 Physical address from the view of DDR controllers. It is the
508 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
509 it could be different for ARM SoCs.
510
York Sun6b1e1252014-02-10 13:59:44 -0800511 CONFIG_SYS_FSL_DDR_INTLV_256B
512 DDR controller interleaving on 256-byte. This is a special
513 interleaving mode, handled by Dickens for Freescale layerscape
514 SoCs with ARM core.
515
York Sun1d71efb2014-08-01 15:51:00 -0700516 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
517 Number of controllers used as main memory.
518
519 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
520 Number of controllers used for other than main memory.
521
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530522 CONFIG_SYS_FSL_HAS_DP_DDR
523 Defines the SoC has DP-DDR used for DPAA.
524
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530525 CONFIG_SYS_FSL_SEC_BE
526 Defines the SEC controller register space as Big Endian
527
528 CONFIG_SYS_FSL_SEC_LE
529 Defines the SEC controller register space as Little Endian
530
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200531- MIPS CPU options:
532 CONFIG_SYS_INIT_SP_OFFSET
533
534 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
535 pointer. This is needed for the temporary stack before
536 relocation.
537
538 CONFIG_SYS_MIPS_CACHE_MODE
539
540 Cache operation mode for the MIPS CPU.
541 See also arch/mips/include/asm/mipsregs.h.
542 Possible values are:
543 CONF_CM_CACHABLE_NO_WA
544 CONF_CM_CACHABLE_WA
545 CONF_CM_UNCACHED
546 CONF_CM_CACHABLE_NONCOHERENT
547 CONF_CM_CACHABLE_CE
548 CONF_CM_CACHABLE_COW
549 CONF_CM_CACHABLE_CUW
550 CONF_CM_CACHABLE_ACCELERATED
551
552 CONFIG_SYS_XWAY_EBU_BOOTCFG
553
554 Special option for Lantiq XWAY SoCs for booting from NOR flash.
555 See also arch/mips/cpu/mips32/start.S.
556
557 CONFIG_XWAY_SWAP_BYTES
558
559 Enable compilation of tools/xway-swap-bytes needed for Lantiq
560 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
561 be swapped if a flash programmer is used.
562
Christian Rieschb67d8812012-02-02 00:44:39 +0000563- ARM options:
564 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
565
566 Select high exception vectors of the ARM core, e.g., do not
567 clear the V bit of the c1 register of CP15.
568
York Sun207774b2015-03-20 19:28:08 -0700569 COUNTER_FREQUENCY
570 Generic timer clock source frequency.
571
572 COUNTER_FREQUENCY_REAL
573 Generic timer clock source frequency if the real clock is
574 different from COUNTER_FREQUENCY, and can only be determined
575 at run time.
576
Stephen Warren73c38932015-01-19 16:25:52 -0700577- Tegra SoC options:
578 CONFIG_TEGRA_SUPPORT_NON_SECURE
579
580 Support executing U-Boot in non-secure (NS) mode. Certain
581 impossible actions will be skipped if the CPU is in NS mode,
582 such as ARM architectural timer initialization.
583
wdenk5da627a2003-10-09 20:09:04 +0000584- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000585 CONFIG_CLOCKS_IN_MHZ
586
587 U-Boot stores all clock information in Hz
588 internally. For binary compatibility with older Linux
589 kernels (which expect the clocks passed in the
590 bd_info data to be in MHz) the environment variable
591 "clocks_in_mhz" can be defined so that U-Boot
592 converts clock data to MHZ before passing it to the
593 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000594 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100595 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000596 default environment.
597
wdenk5da627a2003-10-09 20:09:04 +0000598 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
599
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800600 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000601 expect it to be in bytes, others in MB.
602 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
603
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400604 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200605
606 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400607 passed using flattened device trees (based on open firmware
608 concepts).
609
610 CONFIG_OF_LIBFDT
611 * New libfdt-based support
612 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500613 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400614
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200615 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600616 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200617
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200618 boards with QUICC Engines require OF_QE to set UCC MAC
619 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500620
Kumar Gala4e253132006-01-11 13:54:17 -0600621 CONFIG_OF_BOARD_SETUP
622
623 Board code has addition modification that it wants to make
624 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000625
Simon Glassc654b512014-10-23 18:58:54 -0600626 CONFIG_OF_SYSTEM_SETUP
627
628 Other code has addition modification that it wants to make
629 to the flat device tree before handing it off to the kernel.
630 This causes ft_system_setup() to be called before booting
631 the kernel.
632
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200633 CONFIG_OF_IDE_FIXUP
634
635 U-Boot can detect if an IDE device is present or not.
636 If not, and this new config option is activated, U-Boot
637 removes the ATA node from the DTS before booting Linux,
638 so the Linux IDE driver does not probe the device and
639 crash. This is needed for buggy hardware (uc101) where
640 no pull down resistor is connected to the signal IDE5V_DD7.
641
Igor Grinberg7eb29392011-07-14 05:45:07 +0000642 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
643
644 This setting is mandatory for all boards that have only one
645 machine type and must be used to specify the machine type
646 number as it appears in the ARM machine registry
647 (see http://www.arm.linux.org.uk/developer/machines/).
648 Only boards that have multiple machine types supported
649 in a single configuration file and the machine type is
650 runtime discoverable, do not have to use this setting.
651
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100652- vxWorks boot parameters:
653
654 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700655 environments variables: bootdev, bootfile, ipaddr, netmask,
656 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100657 It loads the vxWorks image pointed bootfile.
658
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100659 Note: If a "bootargs" environment is defined, it will overwride
660 the defaults discussed just above.
661
Aneesh V2c451f72011-06-16 23:30:47 +0000662- Cache Configuration:
663 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
664 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
665 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
666
Aneesh V93bc2192011-06-16 23:30:51 +0000667- Cache Configuration for ARM:
668 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
669 controller
670 CONFIG_SYS_PL310_BASE - Physical base address of PL310
671 controller register space
672
wdenk6705d812004-08-02 23:22:59 +0000673- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200674 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000675
676 Define this if you want support for Amba PrimeCell PL010 UARTs.
677
Andreas Engel48d01922008-09-08 14:30:53 +0200678 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000679
680 Define this if you want support for Amba PrimeCell PL011 UARTs.
681
682 CONFIG_PL011_CLOCK
683
684 If you have Amba PrimeCell PL011 UARTs, set this variable to
685 the clock speed of the UARTs.
686
687 CONFIG_PL01x_PORTS
688
689 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
690 define this to a list of base addresses for each (supported)
691 port. See e.g. include/configs/versatile.h
692
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400693 CONFIG_SERIAL_HW_FLOW_CONTROL
694
695 Define this variable to enable hw flow control in serial driver.
696 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000697
wdenkc6097192002-11-03 00:24:07 +0000698- Console Baudrate:
699 CONFIG_BAUDRATE - in bps
700 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200701 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000702
wdenkc6097192002-11-03 00:24:07 +0000703- Autoboot Command:
704 CONFIG_BOOTCOMMAND
705 Only needed when CONFIG_BOOTDELAY is enabled;
706 define a command string that is automatically executed
707 when no character is read on the console interface
708 within "Boot Delay" after reset.
709
wdenkc6097192002-11-03 00:24:07 +0000710 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000711 The value of these goes into the environment as
712 "ramboot" and "nfsboot" respectively, and can be used
713 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200714 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000715
Heiko Schochereda0ba32013-11-04 14:04:59 +0100716- Bootcount:
717 CONFIG_BOOTCOUNT_LIMIT
718 Implements a mechanism for detecting a repeating reboot
719 cycle, see:
720 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
721
722 CONFIG_BOOTCOUNT_ENV
723 If no softreset save registers are found on the hardware
724 "bootcount" is stored in the environment. To prevent a
725 saveenv on all reboots, the environment variable
726 "upgrade_available" is used. If "upgrade_available" is
727 0, "bootcount" is always 0, if "upgrade_available" is
728 1 "bootcount" is incremented in the environment.
729 So the Userspace Applikation must set the "upgrade_available"
730 and "bootcount" variable to 0, if a boot was successfully.
731
wdenkc6097192002-11-03 00:24:07 +0000732- Pre-Boot Commands:
733 CONFIG_PREBOOT
734
735 When this option is #defined, the existence of the
736 environment variable "preboot" will be checked
737 immediately before starting the CONFIG_BOOTDELAY
738 countdown and/or running the auto-boot command resp.
739 entering interactive mode.
740
741 This feature is especially useful when "preboot" is
742 automatically generated or modified. For an example
743 see the LWMON board specific code: here "preboot" is
744 modified when the user holds down a certain
745 combination of keys on the (special) keyboard when
746 booting the systems
747
748- Serial Download Echo Mode:
749 CONFIG_LOADS_ECHO
750 If defined to 1, all characters received during a
751 serial download (using the "loads" command) are
752 echoed back. This might be needed by some terminal
753 emulations (like "cu"), but may as well just take
754 time on others. This setting #define's the initial
755 value of the "loads_echo" environment variable.
756
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500757- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000758 CONFIG_KGDB_BAUDRATE
759 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200760 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000761
Simon Glass302a6482016-03-13 19:07:28 -0600762- Removal of commands
763 If no commands are needed to boot, you can disable
764 CONFIG_CMDLINE to remove them. In this case, the command line
765 will not be available, and when U-Boot wants to execute the
766 boot command (on start-up) it will call board_run_command()
767 instead. This can reduce image size significantly for very
768 simple boot procedures.
769
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000770- Regular expression support:
771 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200772 If this variable is defined, U-Boot is linked against
773 the SLRE (Super Light Regular Expression) library,
774 which adds regex support to some commands, as for
775 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000776
Simon Glass45ba8072011-10-15 05:48:20 +0000777- Device tree:
778 CONFIG_OF_CONTROL
779 If this variable is defined, U-Boot will use a device tree
780 to configure its devices, instead of relying on statically
781 compiled #defines in the board file. This option is
782 experimental and only available on a few boards. The device
783 tree is available in the global data as gd->fdt_blob.
784
Simon Glass2c0f79e2011-10-24 19:15:31 +0000785 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700786 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000787
788 CONFIG_OF_EMBED
789 If this variable is defined, U-Boot will embed a device tree
790 binary in its image. This device tree file should be in the
791 board directory and called <soc>-<board>.dts. The binary file
792 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900793 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000794
Simon Glass2c0f79e2011-10-24 19:15:31 +0000795 CONFIG_OF_SEPARATE
796 If this variable is defined, U-Boot will build a device tree
797 binary. It will be called u-boot.dtb. Architecture-specific
798 code will locate it at run-time. Generally this works by:
799
800 cat u-boot.bin u-boot.dtb >image.bin
801
802 and in fact, U-Boot does this for you, creating a file called
803 u-boot-dtb.bin which is useful in the common case. You can
804 still use the individual files if you need something more
805 exotic.
806
Alex Deymo82f766d2017-04-02 01:25:20 -0700807 CONFIG_OF_BOARD
808 If this variable is defined, U-Boot will use the device tree
809 provided by the board at runtime instead of embedding one with
810 the image. Only boards defining board_fdt_blob_setup() support
811 this option (see include/fdtdec.h file).
812
wdenkc6097192002-11-03 00:24:07 +0000813- Watchdog:
814 CONFIG_WATCHDOG
815 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000816 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200817 specific code for a watchdog. For the 8xx
818 CPUs, the SIU Watchdog feature is enabled in the SYPCR
819 register. When supported for a specific SoC is
820 available, then no further board specific code should
821 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000822
823 CONFIG_HW_WATCHDOG
824 When using a watchdog circuitry external to the used
825 SoC, then define this variable and provide board
826 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000827
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100828 CONFIG_AT91_HW_WDT_TIMEOUT
829 specify the timeout in seconds. default 2 seconds.
830
stroesec1551ea2003-04-04 15:53:41 +0000831- U-Boot Version:
832 CONFIG_VERSION_VARIABLE
833 If this variable is defined, an environment variable
834 named "ver" is created by U-Boot showing the U-Boot
835 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200836 Any change to this variable will be reverted at the
837 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000838
wdenkc6097192002-11-03 00:24:07 +0000839- Real-Time Clock:
840
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000842 has to be selected, too. Define exactly one of the
843 following options:
844
wdenkc6097192002-11-03 00:24:07 +0000845 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000846 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000847 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000848 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000849 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000850 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200851 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000852 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100853 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000854 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200855 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200856 CONFIG_SYS_RV3029_TCR - enable trickle charger on
857 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000858
wdenkb37c7e52003-06-30 16:24:52 +0000859 Note that if the RTC uses I2C, then the I2C interface
860 must also be configured. See I2C Support, below.
861
Peter Tysere92739d2008-12-17 16:36:21 -0600862- GPIO Support:
863 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600864
Chris Packham5dec49c2010-12-19 10:12:13 +0000865 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
866 chip-ngpio pairs that tell the PCA953X driver the number of
867 pins supported by a particular chip.
868
Peter Tysere92739d2008-12-17 16:36:21 -0600869 Note that if the GPIO device uses I2C, then the I2C interface
870 must also be configured. See I2C Support, below.
871
Simon Glassaa532332014-06-11 23:29:41 -0600872- I/O tracing:
873 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
874 accesses and can checksum them or write a list of them out
875 to memory. See the 'iotrace' command for details. This is
876 useful for testing device drivers since it can confirm that
877 the driver behaves the same way before and after a code
878 change. Currently this is supported on sandbox and arm. To
879 add support for your architecture, add '#include <iotrace.h>'
880 to the bottom of arch/<arch>/include/asm/io.h and test.
881
882 Example output from the 'iotrace stats' command is below.
883 Note that if the trace buffer is exhausted, the checksum will
884 still continue to operate.
885
886 iotrace is enabled
887 Start: 10000000 (buffer start address)
888 Size: 00010000 (buffer size)
889 Offset: 00000120 (current buffer offset)
890 Output: 10000120 (start + offset)
891 Count: 00000018 (number of trace records)
892 CRC32: 9526fb66 (CRC32 of all trace records)
893
wdenkc6097192002-11-03 00:24:07 +0000894- Timestamp Support:
895
wdenk43d96162003-03-06 00:02:04 +0000896 When CONFIG_TIMESTAMP is selected, the timestamp
897 (date and time) of an image is printed by image
898 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500899 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000900
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000901- Partition Labels (disklabels) Supported:
902 Zero or more of the following:
903 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000904 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
905 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
906 bootloader. Note 2TB partition limit; see
907 disk/part_efi.c
908 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000909
Simon Glassfc843a02017-05-17 03:25:30 -0600910 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -0600911 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000912 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000913
914- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000915 CONFIG_IDE_RESET_ROUTINE - this is defined in several
916 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000917
wdenk4d13cba2004-03-14 14:09:05 +0000918 CONFIG_IDE_RESET - is this is defined, IDE Reset will
919 be performed by calling the function
920 ide_set_reset(int reset)
921 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000922
923- ATAPI Support:
924 CONFIG_ATAPI
925
926 Set this to enable ATAPI support.
927
wdenkc40b2952004-03-13 23:29:43 +0000928- LBA48 Support
929 CONFIG_LBA48
930
931 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100932 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000933 Whithout these , LBA48 support uses 32bit variables and will 'only'
934 support disks up to 2.1TB.
935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200936 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000937 When enabled, makes the IDE subsystem use 64bit sector addresses.
938 Default is 32bit.
939
wdenkc6097192002-11-03 00:24:07 +0000940- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200941 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
942 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
943 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000944 maximum numbers of LUNs, SCSI ID's and target
945 devices.
wdenkc6097192002-11-03 00:24:07 +0000946
Wolfgang Denk93e14592013-10-04 17:43:24 +0200947 The environment variable 'scsidevs' is set to the number of
948 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000949
wdenkc6097192002-11-03 00:24:07 +0000950- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000951 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000952 Support for Intel 8254x/8257x gigabit chips.
953
954 CONFIG_E1000_SPI
955 Utility code for direct access to the SPI bus on Intel 8257x.
956 This does not do anything useful unless you set at least one
957 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
958
959 CONFIG_E1000_SPI_GENERIC
960 Allow generic access to the SPI bus on the Intel 8257x, for
961 example with the "sspi" command.
962
wdenkc6097192002-11-03 00:24:07 +0000963 CONFIG_EEPRO100
964 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200965 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000966 write routine for first time initialisation.
967
968 CONFIG_TULIP
969 Support for Digital 2114x chips.
970 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
971 modem chip initialisation (KS8761/QS6611).
972
973 CONFIG_NATSEMI
974 Support for National dp83815 chips.
975
976 CONFIG_NS8382X
977 Support for National dp8382[01] gigabit chips.
978
wdenk45219c42003-05-12 21:50:16 +0000979- NETWORK Support (other):
980
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100981 CONFIG_DRIVER_AT91EMAC
982 Support for AT91RM9200 EMAC.
983
984 CONFIG_RMII
985 Define this to use reduced MII inteface
986
987 CONFIG_DRIVER_AT91EMAC_QUIET
988 If this defined, the driver is quiet.
989 The driver doen't show link status messages.
990
Rob Herringefdd7312011-12-15 11:15:49 +0000991 CONFIG_CALXEDA_XGMAC
992 Support for the Calxeda XGMAC device
993
Ashok3bb46d22012-10-15 06:20:47 +0000994 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000995 Support for SMSC's LAN91C96 chips.
996
wdenk45219c42003-05-12 21:50:16 +0000997 CONFIG_LAN91C96_USE_32_BIT
998 Define this to enable 32 bit addressing
999
Ashok3bb46d22012-10-15 06:20:47 +00001000 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001001 Support for SMSC's LAN91C111 chip
1002
1003 CONFIG_SMC91111_BASE
1004 Define this to hold the physical address
1005 of the device (I/O space)
1006
1007 CONFIG_SMC_USE_32_BIT
1008 Define this if data bus is 32 bits
1009
1010 CONFIG_SMC_USE_IOFUNCS
1011 Define this to use i/o functions instead of macros
1012 (some hardware wont work with macros)
1013
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001014 CONFIG_DRIVER_TI_EMAC
1015 Support for davinci emac
1016
1017 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1018 Define this if you have more then 3 PHYs.
1019
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001020 CONFIG_FTGMAC100
1021 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1022
1023 CONFIG_FTGMAC100_EGIGA
1024 Define this to use GE link update with gigabit PHY.
1025 Define this if FTGMAC100 is connected to gigabit PHY.
1026 If your system has 10/100 PHY only, it might not occur
1027 wrong behavior. Because PHY usually return timeout or
1028 useless data when polling gigabit status and gigabit
1029 control registers. This behavior won't affect the
1030 correctnessof 10/100 link speed update.
1031
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001032 CONFIG_SH_ETHER
1033 Support for Renesas on-chip Ethernet controller
1034
1035 CONFIG_SH_ETHER_USE_PORT
1036 Define the number of ports to be used
1037
1038 CONFIG_SH_ETHER_PHY_ADDR
1039 Define the ETH PHY's address
1040
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001041 CONFIG_SH_ETHER_CACHE_WRITEBACK
1042 If this option is set, the driver enables cache flush.
1043
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001044- PWM Support:
1045 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001046 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001047
Vadim Bendebury5e124722011-10-17 08:36:14 +00001048- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001049 CONFIG_TPM
1050 Support TPM devices.
1051
Christophe Ricard0766ad22015-10-06 22:54:41 +02001052 CONFIG_TPM_TIS_INFINEON
1053 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001054 per system is supported at this time.
1055
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001056 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1057 Define the burst count bytes upper limit
1058
Christophe Ricard3aa74082016-01-21 23:27:13 +01001059 CONFIG_TPM_ST33ZP24
1060 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1061
1062 CONFIG_TPM_ST33ZP24_I2C
1063 Support for STMicroelectronics ST33ZP24 I2C devices.
1064 Requires TPM_ST33ZP24 and I2C.
1065
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001066 CONFIG_TPM_ST33ZP24_SPI
1067 Support for STMicroelectronics ST33ZP24 SPI devices.
1068 Requires TPM_ST33ZP24 and SPI.
1069
Dirk Eibachc01939c2013-06-26 15:55:15 +02001070 CONFIG_TPM_ATMEL_TWI
1071 Support for Atmel TWI TPM device. Requires I2C support.
1072
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001073 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001074 Support for generic parallel port TPM devices. Only one device
1075 per system is supported at this time.
1076
1077 CONFIG_TPM_TIS_BASE_ADDRESS
1078 Base address where the generic TPM device is mapped
1079 to. Contemporary x86 systems usually map it at
1080 0xfed40000.
1081
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001082 CONFIG_TPM
1083 Define this to enable the TPM support library which provides
1084 functional interfaces to some TPM commands.
1085 Requires support for a TPM device.
1086
1087 CONFIG_TPM_AUTH_SESSIONS
1088 Define this to enable authorized functions in the TPM library.
1089 Requires CONFIG_TPM and CONFIG_SHA1.
1090
wdenkc6097192002-11-03 00:24:07 +00001091- USB Support:
1092 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001093 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001094 CONFIG_USB_UHCI to enable it.
1095 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001096 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001097 storage devices.
1098 Note:
1099 Supported are USB Keyboards and USB Floppy drives
1100 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001101
Simon Glass9ab4ce22012-02-27 10:52:47 +00001102 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1103 txfilltuning field in the EHCI controller on reset.
1104
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001105 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1106 HW module registers.
1107
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001108- USB Device:
1109 Define the below if you wish to use the USB console.
1110 Once firmware is rebuilt from a serial console issue the
1111 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001112 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001113 it has found a new device. The environment variable usbtty
1114 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001115 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001116 Common Device Class Abstract Control Model serial device.
1117 If you select usbtty = gserial you should be able to enumerate
1118 a Linux host by
1119 # modprobe usbserial vendor=0xVendorID product=0xProductID
1120 else if using cdc_acm, simply setting the environment
1121 variable usbtty to be cdc_acm should suffice. The following
1122 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001123
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001124 CONFIG_USB_DEVICE
1125 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001126
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001127 CONFIG_USB_TTY
1128 Define this to have a tty type of device available to
1129 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001130
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301131 CONFIG_USBD_HS
1132 Define this to enable the high speed support for usb
1133 device and usbtty. If this feature is enabled, a routine
1134 int is_usbd_high_speed(void)
1135 also needs to be defined by the driver to dynamically poll
1136 whether the enumeration has succeded at high speed or full
1137 speed.
1138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001139 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001140 Define this if you want stdin, stdout &/or stderr to
1141 be set to usbtty.
1142
Wolfgang Denk386eda02006-06-14 18:14:56 +02001143 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001144 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001145 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001146 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1147 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1148 should pretend to be a Linux device to it's target host.
1149
1150 CONFIG_USBD_MANUFACTURER
1151 Define this string as the name of your company for
1152 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001153
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001154 CONFIG_USBD_PRODUCT_NAME
1155 Define this string as the name of your product
1156 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1157
1158 CONFIG_USBD_VENDORID
1159 Define this as your assigned Vendor ID from the USB
1160 Implementors Forum. This *must* be a genuine Vendor ID
1161 to avoid polluting the USB namespace.
1162 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001163
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164 CONFIG_USBD_PRODUCTID
1165 Define this as the unique Product ID
1166 for your device
1167 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001168
Igor Grinbergd70a5602011-12-12 12:08:35 +02001169- ULPI Layer Support:
1170 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1171 the generic ULPI layer. The generic layer accesses the ULPI PHY
1172 via the platform viewport, so you need both the genric layer and
1173 the viewport enabled. Currently only Chipidea/ARC based
1174 viewport is supported.
1175 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1176 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001177 If your ULPI phy needs a different reference clock than the
1178 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1179 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001180
1181- MMC Support:
1182 The MMC controller on the Intel PXA is supported. To
1183 enable this define CONFIG_MMC. The MMC can be
1184 accessed from the boot prompt by mapping the device
1185 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001186 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1187 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001188
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001189 CONFIG_SH_MMCIF
1190 Support for Renesas on-chip MMCIF controller
1191
1192 CONFIG_SH_MMCIF_ADDR
1193 Define the base address of MMCIF registers
1194
1195 CONFIG_SH_MMCIF_CLK
1196 Define the clock frequency for MMCIF
1197
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001198 CONFIG_SUPPORT_EMMC_BOOT
1199 Enable some additional features of the eMMC boot partitions.
1200
1201 CONFIG_SUPPORT_EMMC_RPMB
1202 Enable the commands for reading, writing and programming the
1203 key for the Replay Protection Memory Block partition in eMMC.
1204
Tom Rinib3ba6e92013-03-14 05:32:47 +00001205- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001206 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001207 This enables the USB portion of the DFU USB class
1208
Tom Rinib3ba6e92013-03-14 05:32:47 +00001209 CONFIG_DFU_MMC
1210 This enables support for exposing (e)MMC devices via DFU.
1211
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001212 CONFIG_DFU_NAND
1213 This enables support for exposing NAND devices via DFU.
1214
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301215 CONFIG_DFU_RAM
1216 This enables support for exposing RAM via DFU.
1217 Note: DFU spec refer to non-volatile memory usage, but
1218 allow usages beyond the scope of spec - here RAM usage,
1219 one that would help mostly the developer.
1220
Heiko Schochere7e75c72013-06-12 06:05:51 +02001221 CONFIG_SYS_DFU_DATA_BUF_SIZE
1222 Dfu transfer uses a buffer before writing data to the
1223 raw storage device. Make the size (in bytes) of this buffer
1224 configurable. The size of this buffer is also configurable
1225 through the "dfu_bufsiz" environment variable.
1226
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001227 CONFIG_SYS_DFU_MAX_FILE_SIZE
1228 When updating files rather than the raw storage device,
1229 we use a static buffer to copy the file into and then write
1230 the buffer once we've been given the whole file. Define
1231 this to the maximum filesize (in bytes) for the buffer.
1232 Default is 4 MiB if undefined.
1233
Heiko Schocher001a8312014-03-18 08:09:56 +01001234 DFU_DEFAULT_POLL_TIMEOUT
1235 Poll timeout [ms], is the timeout a device can send to the
1236 host. The host must wait for this timeout before sending
1237 a subsequent DFU_GET_STATUS request to the device.
1238
1239 DFU_MANIFEST_POLL_TIMEOUT
1240 Poll timeout [ms], which the device sends to the host when
1241 entering dfuMANIFEST state. Host waits this timeout, before
1242 sending again an USB request to the device.
1243
wdenk6705d812004-08-02 23:22:59 +00001244- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001245 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001246 Define these for a default partition on a NAND device
1247
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001248 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1249 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001250 Define these for a default partition on a NOR device
1251
wdenkc6097192002-11-03 00:24:07 +00001252- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001253 See Kconfig help for available keyboard drivers.
1254
1255 CONFIG_KEYBOARD
1256
1257 Define this to enable a custom keyboard support.
1258 This simply calls drv_keyboard_init() which must be
1259 defined in your board-specific files. This option is deprecated
1260 and is only used by novena. For new boards, use driver model
1261 instead.
wdenkc6097192002-11-03 00:24:07 +00001262
1263- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001264 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001265 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001266 SOCs that have a DIU should define this macro to enable DIU
1267 support, and should also define these other macros:
1268
1269 CONFIG_SYS_DIU_ADDR
1270 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001271 CONFIG_CFB_CONSOLE
1272 CONFIG_VIDEO_SW_CURSOR
1273 CONFIG_VGA_AS_SINGLE_DEVICE
1274 CONFIG_VIDEO_LOGO
1275 CONFIG_VIDEO_BMP_LOGO
1276
Timur Tabiba8e76b2011-04-11 14:18:22 -05001277 The DIU driver will look for the 'video-mode' environment
1278 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001279 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001280 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001281
wdenkc6097192002-11-03 00:24:07 +00001282- LCD Support: CONFIG_LCD
1283
1284 Define this to enable LCD support (for output to LCD
1285 display); also select one of the supported displays
1286 by defining one of these:
1287
Stelian Pop39cf4802008-05-09 21:57:18 +02001288 CONFIG_ATMEL_LCD:
1289
1290 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1291
wdenkfd3103b2003-11-25 16:55:19 +00001292 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001293
wdenkfd3103b2003-11-25 16:55:19 +00001294 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001295
wdenkfd3103b2003-11-25 16:55:19 +00001296 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001297
wdenkfd3103b2003-11-25 16:55:19 +00001298 NEC NL6448BC20-08. 6.5", 640x480.
1299 Active, color, single scan.
1300
1301 CONFIG_NEC_NL6448BC33_54
1302
1303 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001304 Active, color, single scan.
1305
1306 CONFIG_SHARP_16x9
1307
1308 Sharp 320x240. Active, color, single scan.
1309 It isn't 16x9, and I am not sure what it is.
1310
1311 CONFIG_SHARP_LQ64D341
1312
1313 Sharp LQ64D341 display, 640x480.
1314 Active, color, single scan.
1315
1316 CONFIG_HLD1045
1317
1318 HLD1045 display, 640x480.
1319 Active, color, single scan.
1320
1321 CONFIG_OPTREX_BW
1322
1323 Optrex CBL50840-2 NF-FW 99 22 M5
1324 or
1325 Hitachi LMG6912RPFC-00T
1326 or
1327 Hitachi SP14Q002
1328
1329 320x240. Black & white.
1330
Simon Glass676d3192012-10-17 13:24:54 +00001331 CONFIG_LCD_ALIGNMENT
1332
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001333 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001334 defined then the LCD will be aligned to this value instead.
1335 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1336 here, since it is cheaper to change data cache settings on
1337 a per-section basis.
1338
1339
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001340 CONFIG_LCD_ROTATION
1341
1342 Sometimes, for example if the display is mounted in portrait
1343 mode or even if it's mounted landscape but rotated by 180degree,
1344 we need to rotate our content of the display relative to the
1345 framebuffer, so that user can read the messages which are
1346 printed out.
1347 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1348 initialized with a given rotation from "vl_rot" out of
1349 "vidinfo_t" which is provided by the board specific code.
1350 The value for vl_rot is coded as following (matching to
1351 fbcon=rotate:<n> linux-kernel commandline):
1352 0 = no rotation respectively 0 degree
1353 1 = 90 degree rotation
1354 2 = 180 degree rotation
1355 3 = 270 degree rotation
1356
1357 If CONFIG_LCD_ROTATION is not defined, the console will be
1358 initialized with 0degree rotation.
1359
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001360 CONFIG_LCD_BMP_RLE8
1361
1362 Support drawing of RLE8-compressed bitmaps on the LCD.
1363
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001364 CONFIG_I2C_EDID
1365
1366 Enables an 'i2c edid' command which can read EDID
1367 information over I2C from an attached LCD display.
1368
wdenk7152b1d2003-09-05 23:19:14 +00001369- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001370
wdenk8bde7f72003-06-27 21:31:46 +00001371 If this option is set, the environment is checked for
1372 a variable "splashimage". If found, the usual display
1373 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001374 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001375 specified in "splashimage" is loaded instead. The
1376 console is redirected to the "nulldev", too. This
1377 allows for a "silent" boot where a splash screen is
1378 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001379
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001380 CONFIG_SPLASHIMAGE_GUARD
1381
1382 If this option is set, then U-Boot will prevent the environment
1383 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001384 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001385 This option is useful for targets where, due to alignment
1386 restrictions, an improperly aligned BMP image will cause a data
1387 abort. If you think you will not have problems with unaligned
1388 accesses (for example because your toolchain prevents them)
1389 there is no need to set this option.
1390
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001391 CONFIG_SPLASH_SCREEN_ALIGN
1392
1393 If this option is set the splash image can be freely positioned
1394 on the screen. Environment variable "splashpos" specifies the
1395 position as "x,y". If a positive number is given it is used as
1396 number of pixel from left/top. If a negative number is given it
1397 is used as number of pixel from right/bottom. You can also
1398 specify 'm' for centering the image.
1399
1400 Example:
1401 setenv splashpos m,m
1402 => image at center of screen
1403
1404 setenv splashpos 30,20
1405 => image at x = 30 and y = 20
1406
1407 setenv splashpos -10,m
1408 => vertically centered image
1409 at x = dspWidth - bmpWidth - 9
1410
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001411- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1412
1413 If this option is set, additionally to standard BMP
1414 images, gzipped BMP images can be displayed via the
1415 splashscreen support or the bmp command.
1416
Anatolij Gustschind5011762010-03-15 14:50:25 +01001417- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1418
1419 If this option is set, 8-bit RLE compressed BMP images
1420 can be displayed via the splashscreen support or the
1421 bmp command.
1422
wdenkc29fdfc2003-08-29 20:57:53 +00001423- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001424 CONFIG_GZIP
1425
1426 Enabled by default to support gzip compressed images.
1427
wdenkc29fdfc2003-08-29 20:57:53 +00001428 CONFIG_BZIP2
1429
1430 If this option is set, support for bzip2 compressed
1431 images is included. If not, only uncompressed and gzip
1432 compressed images are supported.
1433
wdenk42d1f032003-10-15 23:53:47 +00001434 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001435 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001436 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001437
wdenk17ea1172004-06-06 21:51:03 +00001438- MII/PHY support:
1439 CONFIG_PHY_ADDR
1440
1441 The address of PHY on MII bus.
1442
1443 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1444
1445 The clock frequency of the MII bus
1446
wdenk17ea1172004-06-06 21:51:03 +00001447 CONFIG_PHY_RESET_DELAY
1448
1449 Some PHY like Intel LXT971A need extra delay after
1450 reset before any MII register access is possible.
1451 For such PHY, set this option to the usec delay
1452 required. (minimum 300usec for LXT971A)
1453
1454 CONFIG_PHY_CMD_DELAY (ppc4xx)
1455
1456 Some PHY like Intel LXT971A need extra delay after
1457 command issued before MII status register can be read
1458
wdenkc6097192002-11-03 00:24:07 +00001459- IP address:
1460 CONFIG_IPADDR
1461
1462 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001463 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001464 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001465 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001466
1467- Server IP address:
1468 CONFIG_SERVERIP
1469
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001470 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001471 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001472 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001473
Robin Getz97cfe862009-07-21 12:15:28 -04001474 CONFIG_KEEP_SERVERADDR
1475
1476 Keeps the server's MAC address, in the env 'serveraddr'
1477 for passing to bootargs (like Linux's netconsole option)
1478
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001479- Gateway IP address:
1480 CONFIG_GATEWAYIP
1481
1482 Defines a default value for the IP address of the
1483 default router where packets to other networks are
1484 sent to.
1485 (Environment variable "gatewayip")
1486
1487- Subnet mask:
1488 CONFIG_NETMASK
1489
1490 Defines a default value for the subnet mask (or
1491 routing prefix) which is used to determine if an IP
1492 address belongs to the local subnet or needs to be
1493 forwarded through a router.
1494 (Environment variable "netmask")
1495
David Updegraff53a5c422007-06-11 10:41:07 -05001496- Multicast TFTP Mode:
1497 CONFIG_MCAST_TFTP
1498
1499 Defines whether you want to support multicast TFTP as per
1500 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001501 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001502 driver in use must provide a function: mcast() to join/leave a
1503 multicast group.
1504
wdenkc6097192002-11-03 00:24:07 +00001505- BOOTP Recovery Mode:
1506 CONFIG_BOOTP_RANDOM_DELAY
1507
1508 If you have many targets in a network that try to
1509 boot using BOOTP, you may want to avoid that all
1510 systems send out BOOTP requests at precisely the same
1511 moment (which would happen for instance at recovery
1512 from a power failure, when all systems will try to
1513 boot, thus flooding the BOOTP server. Defining
1514 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1515 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001516 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001517
1518 1st BOOTP request: delay 0 ... 1 sec
1519 2nd BOOTP request: delay 0 ... 2 sec
1520 3rd BOOTP request: delay 0 ... 4 sec
1521 4th and following
1522 BOOTP requests: delay 0 ... 8 sec
1523
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001524 CONFIG_BOOTP_ID_CACHE_SIZE
1525
1526 BOOTP packets are uniquely identified using a 32-bit ID. The
1527 server will copy the ID from client requests to responses and
1528 U-Boot will use this to determine if it is the destination of
1529 an incoming response. Some servers will check that addresses
1530 aren't in use before handing them out (usually using an ARP
1531 ping) and therefore take up to a few hundred milliseconds to
1532 respond. Network congestion may also influence the time it
1533 takes for a response to make it back to the client. If that
1534 time is too long, U-Boot will retransmit requests. In order
1535 to allow earlier responses to still be accepted after these
1536 retransmissions, U-Boot's BOOTP client keeps a small cache of
1537 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1538 cache. The default is to keep IDs for up to four outstanding
1539 requests. Increasing this will allow U-Boot to accept offers
1540 from a BOOTP client in networks with unusually high latency.
1541
stroesefe389a82003-08-28 14:17:32 +00001542- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001543 You can fine tune the DHCP functionality by defining
1544 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001545
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001546 CONFIG_BOOTP_SUBNETMASK
1547 CONFIG_BOOTP_GATEWAY
1548 CONFIG_BOOTP_HOSTNAME
1549 CONFIG_BOOTP_NISDOMAIN
1550 CONFIG_BOOTP_BOOTPATH
1551 CONFIG_BOOTP_BOOTFILESIZE
1552 CONFIG_BOOTP_DNS
1553 CONFIG_BOOTP_DNS2
1554 CONFIG_BOOTP_SEND_HOSTNAME
1555 CONFIG_BOOTP_NTPSERVER
1556 CONFIG_BOOTP_TIMEOFFSET
1557 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001558 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001559
Wilson Callan5d110f02007-07-28 10:56:13 -04001560 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1561 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001562
Joe Hershberger2c00e092012-05-23 07:59:19 +00001563 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1564 after the configured retry count, the call will fail
1565 instead of starting over. This can be used to fail over
1566 to Link-local IP address configuration if the DHCP server
1567 is not available.
1568
stroesefe389a82003-08-28 14:17:32 +00001569 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1570 serverip from a DHCP server, it is possible that more
1571 than one DNS serverip is offered to the client.
1572 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1573 serverip will be stored in the additional environment
1574 variable "dnsip2". The first DNS serverip is always
1575 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001576 is defined.
stroesefe389a82003-08-28 14:17:32 +00001577
1578 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1579 to do a dynamic update of a DNS server. To do this, they
1580 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001581 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001582 of the "hostname" environment variable is passed as
1583 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001584
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001585 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1586
1587 A 32bit value in microseconds for a delay between
1588 receiving a "DHCP Offer" and sending the "DHCP Request".
1589 This fixes a problem with certain DHCP servers that don't
1590 respond 100% of the time to a "DHCP request". E.g. On an
1591 AT91RM9200 processor running at 180MHz, this delay needed
1592 to be *at least* 15,000 usec before a Windows Server 2003
1593 DHCP server would reply 100% of the time. I recommend at
1594 least 50,000 usec to be safe. The alternative is to hope
1595 that one of the retries will be successful but note that
1596 the DHCP timeout and retry process takes a longer than
1597 this delay.
1598
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001599 - Link-local IP address negotiation:
1600 Negotiate with other link-local clients on the local network
1601 for an address that doesn't require explicit configuration.
1602 This is especially useful if a DHCP server cannot be guaranteed
1603 to exist in all environments that the device must operate.
1604
1605 See doc/README.link-local for more information.
1606
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301607 - MAC address from environment variables
1608
1609 FDT_SEQ_MACADDR_FROM_ENV
1610
1611 Fix-up device tree with MAC addresses fetched sequentially from
1612 environment variables. This config work on assumption that
1613 non-usable ethernet node of device-tree are either not present
1614 or their status has been marked as "disabled".
1615
wdenka3d991b2004-04-15 21:48:45 +00001616 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001617 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001618
1619 The device id used in CDP trigger frames.
1620
1621 CONFIG_CDP_DEVICE_ID_PREFIX
1622
1623 A two character string which is prefixed to the MAC address
1624 of the device.
1625
1626 CONFIG_CDP_PORT_ID
1627
1628 A printf format string which contains the ascii name of
1629 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001630 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001631
1632 CONFIG_CDP_CAPABILITIES
1633
1634 A 32bit integer which indicates the device capabilities;
1635 0x00000010 for a normal host which does not forwards.
1636
1637 CONFIG_CDP_VERSION
1638
1639 An ascii string containing the version of the software.
1640
1641 CONFIG_CDP_PLATFORM
1642
1643 An ascii string containing the name of the platform.
1644
1645 CONFIG_CDP_TRIGGER
1646
1647 A 32bit integer sent on the trigger.
1648
1649 CONFIG_CDP_POWER_CONSUMPTION
1650
1651 A 16bit integer containing the power consumption of the
1652 device in .1 of milliwatts.
1653
1654 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1655
1656 A byte containing the id of the VLAN.
1657
Uri Mashiach79267ed2017-01-19 10:51:05 +02001658- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001659
1660 Several configurations allow to display the current
1661 status using a LED. For instance, the LED will blink
1662 fast while running U-Boot code, stop blinking as
1663 soon as a reply to a BOOTP request was received, and
1664 start blinking slow once the Linux kernel is running
1665 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001666 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001667 feature in U-Boot.
1668
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001669 Additional options:
1670
Uri Mashiach79267ed2017-01-19 10:51:05 +02001671 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001672 The status LED can be connected to a GPIO pin.
1673 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001674 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001675 to include the gpio_led driver in the U-Boot binary.
1676
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001677 CONFIG_GPIO_LED_INVERTED_TABLE
1678 Some GPIO connected LEDs may have inverted polarity in which
1679 case the GPIO high value corresponds to LED off state and
1680 GPIO low value corresponds to LED on state.
1681 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1682 with a list of GPIO LEDs that have inverted polarity.
1683
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001684- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001685
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001686 This enable the NEW i2c subsystem, and will allow you to use
1687 i2c commands at the u-boot command line (as long as you set
1688 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1689 based realtime clock chips or other i2c devices. See
1690 common/cmd_i2c.c for a description of the command line
1691 interface.
1692
1693 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001694 - drivers/i2c/soft_i2c.c:
1695 - activate first bus with CONFIG_SYS_I2C_SOFT define
1696 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1697 for defining speed and slave address
1698 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1699 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1700 for defining speed and slave address
1701 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1702 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1703 for defining speed and slave address
1704 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1705 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1706 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001707
Heiko Schocher00f792e2012-10-24 13:48:22 +02001708 - drivers/i2c/fsl_i2c.c:
1709 - activate i2c driver with CONFIG_SYS_I2C_FSL
1710 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1711 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1712 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1713 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001714 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001715 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1716 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1717 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1718 second bus.
1719
Simon Glass1f2ba722012-10-30 07:28:53 +00001720 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001721 - activate this driver with CONFIG_SYS_I2C_TEGRA
1722 - This driver adds 4 i2c buses with a fix speed from
1723 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001724
Dirk Eibach880540d2013-04-25 02:40:01 +00001725 - drivers/i2c/ppc4xx_i2c.c
1726 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1727 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1728 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1729
tremfac96402013-09-21 18:13:35 +02001730 - drivers/i2c/i2c_mxc.c
1731 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001732 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1733 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1734 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1735 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001736 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1737 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1738 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1739 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1740 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1741 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001742 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1743 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001744 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001745 for speed, and 0 for slave.
1746
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001747 - drivers/i2c/rcar_i2c.c:
1748 - activate this driver with CONFIG_SYS_I2C_RCAR
1749 - This driver adds 4 i2c buses
1750
1751 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1752 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1753 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1754 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1755 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1756 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1757 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1758 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1759 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1760
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001761 - drivers/i2c/sh_i2c.c:
1762 - activate this driver with CONFIG_SYS_I2C_SH
1763 - This driver adds from 2 to 5 i2c buses
1764
1765 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1766 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1767 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1768 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1769 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1770 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1771 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1772 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1773 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1774 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001775 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001776
Heiko Schocher6789e842013-10-22 11:03:18 +02001777 - drivers/i2c/omap24xx_i2c.c
1778 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1779 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1780 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1781 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1782 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1783 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1784 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1785 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1786 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1787 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1788 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1789
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001790 - drivers/i2c/zynq_i2c.c
1791 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1792 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1793 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1794
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301795 - drivers/i2c/s3c24x0_i2c.c:
1796 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1797 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1798 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1799 with a fix speed from 100000 and the slave addr 0!
1800
Dirk Eibachb46226b2014-07-03 09:28:18 +02001801 - drivers/i2c/ihs_i2c.c
1802 - activate this driver with CONFIG_SYS_I2C_IHS
1803 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1804 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1805 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1806 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1807 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1808 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1809 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1810 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1811 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1812 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1813 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1814 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001815 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1816 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1817 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1818 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1819 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1820 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1821 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1822 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1823 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001824
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001825 additional defines:
1826
1827 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001828 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001829
1830 CONFIG_SYS_I2C_DIRECT_BUS
1831 define this, if you don't use i2c muxes on your hardware.
1832 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1833 omit this define.
1834
1835 CONFIG_SYS_I2C_MAX_HOPS
1836 define how many muxes are maximal consecutively connected
1837 on one i2c bus. If you not use i2c muxes, omit this
1838 define.
1839
1840 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001841 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001842 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1843 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1844 CONFIG_SYS_NUM_I2C_BUSES = 9:
1845
1846 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1847 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1848 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1849 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1850 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1851 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1852 {1, {I2C_NULL_HOP}}, \
1853 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1854 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1855 }
1856
1857 which defines
1858 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001859 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1860 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1861 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1862 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1863 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001864 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001865 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1866 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001867
1868 If you do not have i2c muxes on your board, omit this define.
1869
Simon Glassce3b5d62017-05-12 21:10:00 -06001870- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001871 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001872 then the following macros need to be defined (examples are
1873 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001874
1875 I2C_INIT
1876
wdenkb37c7e52003-06-30 16:24:52 +00001877 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001878 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001879
wdenkba56f622004-02-06 23:19:44 +00001880 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001881
wdenkc6097192002-11-03 00:24:07 +00001882 I2C_ACTIVE
1883
1884 The code necessary to make the I2C data line active
1885 (driven). If the data line is open collector, this
1886 define can be null.
1887
wdenkb37c7e52003-06-30 16:24:52 +00001888 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1889
wdenkc6097192002-11-03 00:24:07 +00001890 I2C_TRISTATE
1891
1892 The code necessary to make the I2C data line tri-stated
1893 (inactive). If the data line is open collector, this
1894 define can be null.
1895
wdenkb37c7e52003-06-30 16:24:52 +00001896 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1897
wdenkc6097192002-11-03 00:24:07 +00001898 I2C_READ
1899
York Sun472d5462013-04-01 11:29:11 -07001900 Code that returns true if the I2C data line is high,
1901 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001902
wdenkb37c7e52003-06-30 16:24:52 +00001903 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1904
wdenkc6097192002-11-03 00:24:07 +00001905 I2C_SDA(bit)
1906
York Sun472d5462013-04-01 11:29:11 -07001907 If <bit> is true, sets the I2C data line high. If it
1908 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001909
wdenkb37c7e52003-06-30 16:24:52 +00001910 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001911 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001912 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001913
wdenkc6097192002-11-03 00:24:07 +00001914 I2C_SCL(bit)
1915
York Sun472d5462013-04-01 11:29:11 -07001916 If <bit> is true, sets the I2C clock line high. If it
1917 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001918
wdenkb37c7e52003-06-30 16:24:52 +00001919 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001920 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001921 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001922
wdenkc6097192002-11-03 00:24:07 +00001923 I2C_DELAY
1924
1925 This delay is invoked four times per clock cycle so this
1926 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001927 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001928 like:
1929
wdenkb37c7e52003-06-30 16:24:52 +00001930 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001931
Mike Frysinger793b5722010-07-21 13:38:02 -04001932 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1933
1934 If your arch supports the generic GPIO framework (asm/gpio.h),
1935 then you may alternatively define the two GPIOs that are to be
1936 used as SCL / SDA. Any of the previous I2C_xxx macros will
1937 have GPIO-based defaults assigned to them as appropriate.
1938
1939 You should define these to the GPIO value as given directly to
1940 the generic GPIO functions.
1941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001942 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001943
wdenk8bde7f72003-06-27 21:31:46 +00001944 When a board is reset during an i2c bus transfer
1945 chips might think that the current transfer is still
1946 in progress. On some boards it is possible to access
1947 the i2c SCLK line directly, either by using the
1948 processor pin as a GPIO or by having a second pin
1949 connected to the bus. If this option is defined a
1950 custom i2c_init_board() routine in boards/xxx/board.c
1951 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001952
Ben Warrenbb99ad62006-09-07 16:50:54 -04001953 CONFIG_I2C_MULTI_BUS
1954
1955 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001956 must have a controller. At any point in time, only one bus is
1957 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001958 Note that bus numbering is zero-based.
1959
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001960 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001961
1962 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001963 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001964 is set, specify a list of bus-device pairs. Otherwise, specify
1965 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001966
1967 e.g.
1968 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001969 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001970
1971 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1972
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001973 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001974 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001975
1976 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001978 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001979
1980 If defined, then this indicates the I2C bus number for DDR SPD.
1981 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001983 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001984
1985 If defined, then this indicates the I2C bus number for the RTC.
1986 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1987
Andrew Dyer2ac69852008-12-29 17:36:01 -06001988 CONFIG_SOFT_I2C_READ_REPEATED_START
1989
1990 defining this will force the i2c_read() function in
1991 the soft_i2c driver to perform an I2C repeated start
1992 between writing the address pointer and reading the
1993 data. If this define is omitted the default behaviour
1994 of doing a stop-start sequence will be used. Most I2C
1995 devices can use either method, but some require one or
1996 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001997
wdenkc6097192002-11-03 00:24:07 +00001998- SPI Support: CONFIG_SPI
1999
2000 Enables SPI driver (so far only tested with
2001 SPI EEPROM, also an instance works with Crystal A/D and
2002 D/As on the SACSng board)
2003
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002004 CONFIG_SH_SPI
2005
2006 Enables the driver for SPI controller on SuperH. Currently
2007 only SH7757 is supported.
2008
wdenkc6097192002-11-03 00:24:07 +00002009 CONFIG_SOFT_SPI
2010
wdenk43d96162003-03-06 00:02:04 +00002011 Enables a software (bit-bang) SPI driver rather than
2012 using hardware support. This is a general purpose
2013 driver that only requires three general I/O port pins
2014 (two outputs, one input) to function. If this is
2015 defined, the board configuration must define several
2016 SPI configuration items (port pins to use, etc). For
2017 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002018
Ben Warren04a9e112008-01-16 22:37:35 -05002019 CONFIG_HARD_SPI
2020
2021 Enables a hardware SPI driver for general-purpose reads
2022 and writes. As with CONFIG_SOFT_SPI, the board configuration
2023 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002024 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002025 example, see include/configs/mpc8349emds.h.
2026
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002027 CONFIG_MXC_SPI
2028
2029 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002030 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002031
Heiko Schocherf659b572014-07-14 10:22:11 +02002032 CONFIG_SYS_SPI_MXC_WAIT
2033 Timeout for waiting until spi transfer completed.
2034 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2035
Matthias Fuchs01335022007-12-27 17:12:34 +01002036- FPGA Support: CONFIG_FPGA
2037
2038 Enables FPGA subsystem.
2039
2040 CONFIG_FPGA_<vendor>
2041
2042 Enables support for specific chip vendors.
2043 (ALTERA, XILINX)
2044
2045 CONFIG_FPGA_<family>
2046
2047 Enables support for FPGA family.
2048 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2049
2050 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002051
wdenk43d96162003-03-06 00:02:04 +00002052 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002053
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002054 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002055
wdenk8bde7f72003-06-27 21:31:46 +00002056 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002057
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002058 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002059
wdenk43d96162003-03-06 00:02:04 +00002060 Enable checks on FPGA configuration interface busy
2061 status by the configuration function. This option
2062 will require a board or device specific function to
2063 be written.
wdenkc6097192002-11-03 00:24:07 +00002064
2065 CONFIG_FPGA_DELAY
2066
2067 If defined, a function that provides delays in the FPGA
2068 configuration driver.
2069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002070 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002071 Allow Control-C to interrupt FPGA configuration
2072
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002073 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002074
wdenk43d96162003-03-06 00:02:04 +00002075 Check for configuration errors during FPGA bitfile
2076 loading. For example, abort during Virtex II
2077 configuration if the INIT_B line goes low (which
2078 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002080 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002081
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002082 Maximum time to wait for the INIT_B line to de-assert
2083 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002084 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002085 ms.
wdenkc6097192002-11-03 00:24:07 +00002086
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002087 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002088
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002089 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002090 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002092 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002093
wdenk43d96162003-03-06 00:02:04 +00002094 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002095 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002096
2097- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002098 CONFIG_BUILD_TARGET
2099
2100 Some SoCs need special image types (e.g. U-Boot binary
2101 with a special header) as build targets. By defining
2102 CONFIG_BUILD_TARGET in the SoC / board header, this
2103 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002104 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002105
wdenkc6097192002-11-03 00:24:07 +00002106 CONFIG_IDENT_STRING
2107
wdenk43d96162003-03-06 00:02:04 +00002108 If defined, this string will be added to the U-Boot
2109 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002110
2111- Vendor Parameter Protection:
2112
wdenk43d96162003-03-06 00:02:04 +00002113 U-Boot considers the values of the environment
2114 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002115 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002116 are set once by the board vendor / manufacturer, and
2117 protects these variables from casual modification by
2118 the user. Once set, these variables are read-only,
2119 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002120 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002121
2122 If CONFIG_ENV_OVERWRITE is #defined in your config
2123 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002124 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002125 these parameters.
2126
Joe Hershberger92ac5202015-05-04 14:55:14 -05002127 Alternatively, if you define _both_ an ethaddr in the
2128 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002129 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002130 which can be changed exactly ONCE by the user. [The
2131 serial# is unaffected by this, i. e. it remains
2132 read-only.]
2133
Joe Hershberger25980902012-12-11 22:16:31 -06002134 The same can be accomplished in a more flexible way
2135 for any variable by configuring the type of access
2136 to allow for those variables in the ".flags" variable
2137 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2138
wdenkc6097192002-11-03 00:24:07 +00002139- Protected RAM:
2140 CONFIG_PRAM
2141
2142 Define this variable to enable the reservation of
2143 "protected RAM", i. e. RAM which is not overwritten
2144 by U-Boot. Define CONFIG_PRAM to hold the number of
2145 kB you want to reserve for pRAM. You can overwrite
2146 this default value by defining an environment
2147 variable "pram" to the number of kB you want to
2148 reserve. Note that the board info structure will
2149 still show the full amount of RAM. If pRAM is
2150 reserved, a new environment variable "mem" will
2151 automatically be defined to hold the amount of
2152 remaining RAM in a form that can be passed as boot
2153 argument to Linux, for instance like that:
2154
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002155 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002156 saveenv
2157
2158 This way you can tell Linux not to use this memory,
2159 either, which results in a memory region that will
2160 not be affected by reboots.
2161
2162 *WARNING* If your board configuration uses automatic
2163 detection of the RAM size, you must make sure that
2164 this memory test is non-destructive. So far, the
2165 following board configurations are known to be
2166 "pRAM-clean":
2167
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002168 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002169 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002170 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002171
Gabe Black40fef042012-12-02 04:55:18 +00002172- Access to physical memory region (> 4GB)
2173 Some basic support is provided for operations on memory not
2174 normally accessible to U-Boot - e.g. some architectures
2175 support access to more than 4GB of memory on 32-bit
2176 machines using physical address extension or similar.
2177 Define CONFIG_PHYSMEM to access this basic support, which
2178 currently only supports clearing the memory.
2179
wdenkc6097192002-11-03 00:24:07 +00002180- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002181 CONFIG_NET_RETRY_COUNT
2182
wdenk43d96162003-03-06 00:02:04 +00002183 This variable defines the number of retries for
2184 network operations like ARP, RARP, TFTP, or BOOTP
2185 before giving up the operation. If not defined, a
2186 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002187
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002188 CONFIG_ARP_TIMEOUT
2189
2190 Timeout waiting for an ARP reply in milliseconds.
2191
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002192 CONFIG_NFS_TIMEOUT
2193
2194 Timeout in milliseconds used in NFS protocol.
2195 If you encounter "ERROR: Cannot umount" in nfs command,
2196 try longer timeout such as
2197 #define CONFIG_NFS_TIMEOUT 10000UL
2198
wdenkc6097192002-11-03 00:24:07 +00002199- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002200 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002201
2202 Enable auto completion of commands using TAB.
2203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002204 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002205
2206 This defines the secondary prompt string, which is
2207 printed when the command interpreter needs more input
2208 to complete a command. Usually "> ".
2209
2210 Note:
2211
wdenk8bde7f72003-06-27 21:31:46 +00002212 In the current implementation, the local variables
2213 space and global environment variables space are
2214 separated. Local variables are those you define by
2215 simply typing `name=value'. To access a local
2216 variable later on, you have write `$name' or
2217 `${name}'; to execute the contents of a variable
2218 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002219
wdenk43d96162003-03-06 00:02:04 +00002220 Global environment variables are those you use
2221 setenv/printenv to work with. To run a command stored
2222 in such a variable, you need to use the run command,
2223 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002224
2225 To store commands and special characters in a
2226 variable, please use double quotation marks
2227 surrounding the whole text of the variable, instead
2228 of the backslashes before semicolons and special
2229 symbols.
2230
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002231- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002232 CONFIG_CMDLINE_EDITING
2233
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002234 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002235 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002236
Marek Vasutf3b267b2016-01-27 04:47:55 +01002237- Command Line PS1/PS2 support:
2238 CONFIG_CMDLINE_PS_SUPPORT
2239
2240 Enable support for changing the command prompt string
2241 at run-time. Only static string is supported so far.
2242 The string is obtained from environment variables PS1
2243 and PS2.
2244
wdenka8c7c702003-12-06 19:49:23 +00002245- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002246 CONFIG_EXTRA_ENV_SETTINGS
2247
wdenk43d96162003-03-06 00:02:04 +00002248 Define this to contain any number of null terminated
2249 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002250 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002251
wdenk43d96162003-03-06 00:02:04 +00002252 For example, place something like this in your
2253 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002254
2255 #define CONFIG_EXTRA_ENV_SETTINGS \
2256 "myvar1=value1\0" \
2257 "myvar2=value2\0"
2258
wdenk43d96162003-03-06 00:02:04 +00002259 Warning: This method is based on knowledge about the
2260 internal format how the environment is stored by the
2261 U-Boot code. This is NOT an official, exported
2262 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002263 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002264 You better know what you are doing here.
2265
wdenk43d96162003-03-06 00:02:04 +00002266 Note: overly (ab)use of the default environment is
2267 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002268 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002269 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002270
Stephen Warren5e724ca2012-05-22 09:21:54 +00002271 CONFIG_ENV_VARS_UBOOT_CONFIG
2272
2273 Define this in order to add variables describing the
2274 U-Boot build configuration to the default environment.
2275 These will be named arch, cpu, board, vendor, and soc.
2276
2277 Enabling this option will cause the following to be defined:
2278
2279 - CONFIG_SYS_ARCH
2280 - CONFIG_SYS_CPU
2281 - CONFIG_SYS_BOARD
2282 - CONFIG_SYS_VENDOR
2283 - CONFIG_SYS_SOC
2284
Tom Rini7e27f892012-10-24 07:28:16 +00002285 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2286
2287 Define this in order to add variables describing certain
2288 run-time determined information about the hardware to the
2289 environment. These will be named board_name, board_rev.
2290
Simon Glass06fd8532012-11-30 13:01:17 +00002291 CONFIG_DELAY_ENVIRONMENT
2292
2293 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002294 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002295 that so that the environment is not available until
2296 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2297 this is instead controlled by the value of
2298 /config/load-environment.
2299
Eric Nelsonf61ec452012-01-31 10:52:08 -07002300- Serial Flash support
Simon Glass00fd59d2017-08-04 16:35:06 -06002301 Usage requires an initial 'sf probe' to define the serial
Eric Nelsonf61ec452012-01-31 10:52:08 -07002302 flash parameters, followed by read/write/erase/update
2303 commands.
2304
2305 The following defaults may be provided by the platform
2306 to handle the common case when only a single serial
2307 flash is present on the system.
2308
2309 CONFIG_SF_DEFAULT_BUS Bus identifier
2310 CONFIG_SF_DEFAULT_CS Chip-select
2311 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2312 CONFIG_SF_DEFAULT_SPEED in Hz
2313
wdenk3f85ce22004-02-23 16:11:30 +00002314 CONFIG_SYSTEMACE
2315
2316 Adding this option adds support for Xilinx SystemACE
2317 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002318 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002320
2321 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002323
2324 When SystemACE support is added, the "ace" device type
2325 becomes available to the fat commands, i.e. fatls.
2326
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002327- TFTP Fixed UDP Port:
2328 CONFIG_TFTP_PORT
2329
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002330 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002331 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002332 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002333 number generator is used.
2334
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002335 Also, the environment variable tftpdstp is used to supply
2336 the TFTP UDP destination port value. If tftpdstp isn't
2337 defined, the normal port 69 is used.
2338
2339 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002340 blindly start the TFTP transfer using the pre-configured
2341 target IP address and UDP port. This has the effect of
2342 "punching through" the (Windows XP) firewall, allowing
2343 the remainder of the TFTP transfer to proceed normally.
2344 A better solution is to properly configure the firewall,
2345 but sometimes that is not allowed.
2346
Heiko Schocher9e50c402014-01-25 07:27:13 +01002347- bootcount support:
2348 CONFIG_BOOTCOUNT_LIMIT
2349
2350 This enables the bootcounter support, see:
2351 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2352
2353 CONFIG_AT91SAM9XE
2354 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher9e50c402014-01-25 07:27:13 +01002355 CONFIG_SOC_DA8XX
2356 enable special bootcounter support on da850 based boards.
2357 CONFIG_BOOTCOUNT_RAM
2358 enable support for the bootcounter in RAM
2359 CONFIG_BOOTCOUNT_I2C
2360 enable support for the bootcounter on an i2c (like RTC) device.
2361 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2362 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2363 the bootcounter.
2364 CONFIG_BOOTCOUNT_ALEN = address len
Ian Rayf31dac42017-11-08 15:35:13 +00002365 CONFIG_BOOTCOUNT_EXT
2366 enable support for the bootcounter in EXT filesystem
2367 CONFIG_SYS_BOOTCOUNT_ADDR = RAM address used for read
2368 and write.
2369 CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE = interface
2370 CONFIG_SYS_BOOTCOUNT_EXT_DEVPART = device and part
2371 CONFIG_SYS_BOOTCOUNT_EXT_NAME = filename
Simon Glass19c402a2013-06-13 15:10:02 -07002372
wdenka8c7c702003-12-06 19:49:23 +00002373- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002374 CONFIG_SHOW_BOOT_PROGRESS
2375
wdenk43d96162003-03-06 00:02:04 +00002376 Defining this option allows to add some board-
2377 specific code (calling a user-provided function
2378 "show_boot_progress(int)") that enables you to show
2379 the system's boot progress on some display (for
2380 example, some LED's) on your board. At the moment,
2381 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002382
Simon Glass94fd1312012-09-28 08:56:37 +00002383
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002384Legacy uImage format:
2385
wdenkc6097192002-11-03 00:24:07 +00002386 Arg Where When
2387 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002388 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002389 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002390 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002391 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002392 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002393 4 common/cmd_bootm.c Image data has correct checksum
2394 -4 common/cmd_bootm.c Image is for unsupported architecture
2395 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002396 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002397 6 common/cmd_bootm.c Image Type check OK
2398 -6 common/cmd_bootm.c gunzip uncompression error
2399 -7 common/cmd_bootm.c Unimplemented compression type
2400 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002401 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002402 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002403
2404 9 common/image.c Start initial ramdisk verification
2405 -10 common/image.c Ramdisk header has bad magic number
2406 -11 common/image.c Ramdisk header has bad checksum
2407 10 common/image.c Ramdisk header is OK
2408 -12 common/image.c Ramdisk data has bad checksum
2409 11 common/image.c Ramdisk data has correct checksum
2410 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002411 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002412 13 common/image.c Start multifile image verification
2413 14 common/image.c No initial ramdisk, no multifile, continue.
2414
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002415 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002416
Stefan Roesea47a12b2010-04-15 16:07:28 +02002417 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002418 -31 post/post.c POST test failed, detected by post_output_backlog()
2419 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002420
Heiko Schocher566a4942007-06-22 19:11:54 +02002421 34 common/cmd_doc.c before loading a Image from a DOC device
2422 -35 common/cmd_doc.c Bad usage of "doc" command
2423 35 common/cmd_doc.c correct usage of "doc" command
2424 -36 common/cmd_doc.c No boot device
2425 36 common/cmd_doc.c correct boot device
2426 -37 common/cmd_doc.c Unknown Chip ID on boot device
2427 37 common/cmd_doc.c correct chip ID found, device available
2428 -38 common/cmd_doc.c Read Error on boot device
2429 38 common/cmd_doc.c reading Image header from DOC device OK
2430 -39 common/cmd_doc.c Image header has bad magic number
2431 39 common/cmd_doc.c Image header has correct magic number
2432 -40 common/cmd_doc.c Error reading Image from DOC device
2433 40 common/cmd_doc.c Image header has correct magic number
2434 41 common/cmd_ide.c before loading a Image from a IDE device
2435 -42 common/cmd_ide.c Bad usage of "ide" command
2436 42 common/cmd_ide.c correct usage of "ide" command
2437 -43 common/cmd_ide.c No boot device
2438 43 common/cmd_ide.c boot device found
2439 -44 common/cmd_ide.c Device not available
2440 44 common/cmd_ide.c Device available
2441 -45 common/cmd_ide.c wrong partition selected
2442 45 common/cmd_ide.c partition selected
2443 -46 common/cmd_ide.c Unknown partition table
2444 46 common/cmd_ide.c valid partition table found
2445 -47 common/cmd_ide.c Invalid partition type
2446 47 common/cmd_ide.c correct partition type
2447 -48 common/cmd_ide.c Error reading Image Header on boot device
2448 48 common/cmd_ide.c reading Image Header from IDE device OK
2449 -49 common/cmd_ide.c Image header has bad magic number
2450 49 common/cmd_ide.c Image header has correct magic number
2451 -50 common/cmd_ide.c Image header has bad checksum
2452 50 common/cmd_ide.c Image header has correct checksum
2453 -51 common/cmd_ide.c Error reading Image from IDE device
2454 51 common/cmd_ide.c reading Image from IDE device OK
2455 52 common/cmd_nand.c before loading a Image from a NAND device
2456 -53 common/cmd_nand.c Bad usage of "nand" command
2457 53 common/cmd_nand.c correct usage of "nand" command
2458 -54 common/cmd_nand.c No boot device
2459 54 common/cmd_nand.c boot device found
2460 -55 common/cmd_nand.c Unknown Chip ID on boot device
2461 55 common/cmd_nand.c correct chip ID found, device available
2462 -56 common/cmd_nand.c Error reading Image Header on boot device
2463 56 common/cmd_nand.c reading Image Header from NAND device OK
2464 -57 common/cmd_nand.c Image header has bad magic number
2465 57 common/cmd_nand.c Image header has correct magic number
2466 -58 common/cmd_nand.c Error reading Image from NAND device
2467 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002468
Heiko Schocher566a4942007-06-22 19:11:54 +02002469 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002470
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002471 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002472 -64 net/eth.c no Ethernet found.
2473 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002474
Heiko Schocher566a4942007-06-22 19:11:54 +02002475 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002476 80 common/cmd_net.c before calling net_loop()
2477 -81 common/cmd_net.c some error in net_loop() occurred
2478 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002479 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2480 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002481 83 common/cmd_net.c running "source" command
2482 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002483 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002484
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002485FIT uImage format:
2486
2487 Arg Where When
2488 100 common/cmd_bootm.c Kernel FIT Image has correct format
2489 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2490 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2491 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2492 102 common/cmd_bootm.c Kernel unit name specified
2493 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002494 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002495 104 common/cmd_bootm.c Got kernel subimage node offset
2496 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2497 105 common/cmd_bootm.c Kernel subimage hash verification OK
2498 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2499 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002500 -106 common/cmd_bootm.c Kernel subimage has wrong type
2501 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002502 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2503 108 common/cmd_bootm.c Got kernel subimage data/size
2504 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2505 -109 common/cmd_bootm.c Can't get kernel subimage type
2506 -110 common/cmd_bootm.c Can't get kernel subimage comp
2507 -111 common/cmd_bootm.c Can't get kernel subimage os
2508 -112 common/cmd_bootm.c Can't get kernel subimage load address
2509 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2510
2511 120 common/image.c Start initial ramdisk verification
2512 -120 common/image.c Ramdisk FIT image has incorrect format
2513 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002514 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002515 -122 common/image.c Can't get configuration for ramdisk subimage
2516 123 common/image.c Ramdisk unit name specified
2517 -124 common/image.c Can't get ramdisk subimage node offset
2518 125 common/image.c Got ramdisk subimage node offset
2519 -125 common/image.c Ramdisk subimage hash verification failed
2520 126 common/image.c Ramdisk subimage hash verification OK
2521 -126 common/image.c Ramdisk subimage for unsupported architecture
2522 127 common/image.c Architecture check OK
2523 -127 common/image.c Can't get ramdisk subimage data/size
2524 128 common/image.c Got ramdisk subimage data/size
2525 129 common/image.c Can't get ramdisk load address
2526 -129 common/image.c Got ramdisk load address
2527
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002528 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002529 131 common/cmd_doc.c FIT image format OK
2530
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002531 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002532 141 common/cmd_ide.c FIT image format OK
2533
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002534 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002535 151 common/cmd_nand.c FIT image format OK
2536
Heiko Schocher21d29f72014-05-28 11:33:33 +02002537- legacy image format:
2538 CONFIG_IMAGE_FORMAT_LEGACY
2539 enables the legacy image format support in U-Boot.
2540
2541 Default:
2542 enabled if CONFIG_FIT_SIGNATURE is not defined.
2543
2544 CONFIG_DISABLE_IMAGE_LEGACY
2545 disable the legacy image format
2546
2547 This define is introduced, as the legacy image format is
2548 enabled per default for backward compatibility.
2549
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002550- Standalone program support:
2551 CONFIG_STANDALONE_LOAD_ADDR
2552
Wolfgang Denk6feff892011-10-09 21:06:34 +02002553 This option defines a board specific value for the
2554 address where standalone program gets loaded, thus
2555 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002556 settings.
2557
2558- Frame Buffer Address:
2559 CONFIG_FB_ADDR
2560
2561 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002562 address for frame buffer. This is typically the case
2563 when using a graphics controller has separate video
2564 memory. U-Boot will then place the frame buffer at
2565 the given address instead of dynamically reserving it
2566 in system RAM by calling lcd_setmem(), which grabs
2567 the memory for the frame buffer depending on the
2568 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002569
2570 Please see board_init_f function.
2571
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002572- Automatic software updates via TFTP server
2573 CONFIG_UPDATE_TFTP
2574 CONFIG_UPDATE_TFTP_CNT_MAX
2575 CONFIG_UPDATE_TFTP_MSEC_MAX
2576
2577 These options enable and control the auto-update feature;
2578 for a more detailed description refer to doc/README.update.
2579
2580- MTD Support (mtdparts command, UBI support)
2581 CONFIG_MTD_DEVICE
2582
2583 Adds the MTD device infrastructure from the Linux kernel.
2584 Needed for mtdparts command support.
2585
2586 CONFIG_MTD_PARTITIONS
2587
2588 Adds the MTD partitioning infrastructure from the Linux
2589 kernel. Needed for UBI support.
2590
Joe Hershberger70c219c2013-04-08 10:32:48 +00002591- UBI support
Joe Hershberger147162d2013-04-08 10:32:49 +00002592 CONFIG_UBI_SILENCE_MSG
2593
2594 Make the verbose messages from UBI stop printing. This leaves
2595 warnings and errors enabled.
2596
Heiko Schocherff94bc42014-06-24 10:10:04 +02002597
2598 CONFIG_MTD_UBI_WL_THRESHOLD
2599 This parameter defines the maximum difference between the highest
2600 erase counter value and the lowest erase counter value of eraseblocks
2601 of UBI devices. When this threshold is exceeded, UBI starts performing
2602 wear leveling by means of moving data from eraseblock with low erase
2603 counter to eraseblocks with high erase counter.
2604
2605 The default value should be OK for SLC NAND flashes, NOR flashes and
2606 other flashes which have eraseblock life-cycle 100000 or more.
2607 However, in case of MLC NAND flashes which typically have eraseblock
2608 life-cycle less than 10000, the threshold should be lessened (e.g.,
2609 to 128 or 256, although it does not have to be power of 2).
2610
2611 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002612
Heiko Schocherff94bc42014-06-24 10:10:04 +02002613 CONFIG_MTD_UBI_BEB_LIMIT
2614 This option specifies the maximum bad physical eraseblocks UBI
2615 expects on the MTD device (per 1024 eraseblocks). If the
2616 underlying flash does not admit of bad eraseblocks (e.g. NOR
2617 flash), this value is ignored.
2618
2619 NAND datasheets often specify the minimum and maximum NVM
2620 (Number of Valid Blocks) for the flashes' endurance lifetime.
2621 The maximum expected bad eraseblocks per 1024 eraseblocks
2622 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2623 which gives 20 for most NANDs (MaxNVB is basically the total
2624 count of eraseblocks on the chip).
2625
2626 To put it differently, if this value is 20, UBI will try to
2627 reserve about 1.9% of physical eraseblocks for bad blocks
2628 handling. And that will be 1.9% of eraseblocks on the entire
2629 NAND chip, not just the MTD partition UBI attaches. This means
2630 that if you have, say, a NAND flash chip admits maximum 40 bad
2631 eraseblocks, and it is split on two MTD partitions of the same
2632 size, UBI will reserve 40 eraseblocks when attaching a
2633 partition.
2634
2635 default: 20
2636
2637 CONFIG_MTD_UBI_FASTMAP
2638 Fastmap is a mechanism which allows attaching an UBI device
2639 in nearly constant time. Instead of scanning the whole MTD device it
2640 only has to locate a checkpoint (called fastmap) on the device.
2641 The on-flash fastmap contains all information needed to attach
2642 the device. Using fastmap makes only sense on large devices where
2643 attaching by scanning takes long. UBI will not automatically install
2644 a fastmap on old images, but you can set the UBI parameter
2645 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2646 that fastmap-enabled images are still usable with UBI implementations
2647 without fastmap support. On typical flash devices the whole fastmap
2648 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2649
2650 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2651 Set this parameter to enable fastmap automatically on images
2652 without a fastmap.
2653 default: 0
2654
Heiko Schocher0195a7b2015-10-22 06:19:21 +02002655 CONFIG_MTD_UBI_FM_DEBUG
2656 Enable UBI fastmap debug
2657 default: 0
2658
Joe Hershberger70c219c2013-04-08 10:32:48 +00002659- UBIFS support
Joe Hershberger147162d2013-04-08 10:32:49 +00002660 CONFIG_UBIFS_SILENCE_MSG
2661
2662 Make the verbose messages from UBIFS stop printing. This leaves
2663 warnings and errors enabled.
2664
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002665- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002666 CONFIG_SPL
2667 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002668
Tom Rini95579792012-02-14 07:29:40 +00002669 CONFIG_SPL_LDSCRIPT
2670 LDSCRIPT for linking the SPL binary.
2671
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002672 CONFIG_SPL_MAX_FOOTPRINT
2673 Maximum size in memory allocated to the SPL, BSS included.
2674 When defined, the linker checks that the actual memory
2675 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002676 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002677 must not be both defined at the same time.
2678
Tom Rini95579792012-02-14 07:29:40 +00002679 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002680 Maximum size of the SPL image (text, data, rodata, and
2681 linker lists sections), BSS excluded.
2682 When defined, the linker checks that the actual size does
2683 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002684
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002685 CONFIG_SPL_TEXT_BASE
2686 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002687
Scott Wood94a45bb2012-09-20 19:05:12 -05002688 CONFIG_SPL_RELOC_TEXT_BASE
2689 Address to relocate to. If unspecified, this is equal to
2690 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2691
Tom Rini95579792012-02-14 07:29:40 +00002692 CONFIG_SPL_BSS_START_ADDR
2693 Link address for the BSS within the SPL binary.
2694
2695 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002696 Maximum size in memory allocated to the SPL BSS.
2697 When defined, the linker checks that the actual memory used
2698 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002699 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002700 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002701
2702 CONFIG_SPL_STACK
2703 Adress of the start of the stack SPL will use
2704
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02002705 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2706 When defined, SPL will panic() if the image it has
2707 loaded does not have a signature.
2708 Defining this is useful when code which loads images
2709 in SPL cannot guarantee that absolutely all read errors
2710 will be caught.
2711 An example is the LPC32XX MLC NAND driver, which will
2712 consider that a completely unreadable NAND block is bad,
2713 and thus should be skipped silently.
2714
Scott Wood94a45bb2012-09-20 19:05:12 -05002715 CONFIG_SPL_RELOC_STACK
2716 Adress of the start of the stack SPL will use after
2717 relocation. If unspecified, this is equal to
2718 CONFIG_SPL_STACK.
2719
Tom Rini95579792012-02-14 07:29:40 +00002720 CONFIG_SYS_SPL_MALLOC_START
2721 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02002722 When this option is set the full malloc is used in SPL and
2723 it is set up by spl_init() and before that, the simple malloc()
2724 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00002725
2726 CONFIG_SYS_SPL_MALLOC_SIZE
2727 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002728
Tom Rini47f7bca2012-08-13 12:03:19 -07002729 CONFIG_SPL_FRAMEWORK
2730 Enable the SPL framework under common/. This framework
2731 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2732 NAND loading of the Linux Kernel.
2733
Tom Rini9607faf2014-03-28 12:03:39 -04002734 CONFIG_SPL_OS_BOOT
2735 Enable booting directly to an OS from SPL.
2736 See also: doc/README.falcon
2737
Tom Rini861a86f2012-08-13 11:37:56 -07002738 CONFIG_SPL_DISPLAY_PRINT
2739 For ARM, enable an optional function to print more information
2740 about the running system.
2741
Scott Wood4b919722012-09-20 16:35:21 -05002742 CONFIG_SPL_INIT_MINIMAL
2743 Arch init code should be built for a very small image
2744
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01002745 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2746 Partition on the MMC to load U-Boot from when the MMC is being
2747 used in raw mode
2748
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002749 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2750 Sector to load kernel uImage from when MMC is being
2751 used in raw mode (for Falcon mode)
2752
2753 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2754 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2755 Sector and number of sectors to load kernel argument
2756 parameters from when MMC is being used in raw mode
2757 (for falcon mode)
2758
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01002759 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2760 Partition on the MMC to load U-Boot from when the MMC is being
2761 used in fs mode
2762
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002763 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2764 Filename to read to load U-Boot when reading from filesystem
2765
2766 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002767 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002768 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002769
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002770 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002771 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02002772 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002773
Scott Wood06f60ae2012-12-06 13:33:17 +00002774 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2775 Set this for NAND SPL on PPC mpc83xx targets, so that
2776 start.S waits for the rest of the SPL to load before
2777 continuing (the hardware starts execution after just
2778 loading the first page rather than the full 4K).
2779
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05302780 CONFIG_SPL_SKIP_RELOCATE
2781 Avoid SPL relocation
2782
Scott Wood6f2f01b2012-09-20 19:09:07 -05002783 CONFIG_SPL_NAND_BASE
2784 Include nand_base.c in the SPL. Requires
2785 CONFIG_SPL_NAND_DRIVERS.
2786
2787 CONFIG_SPL_NAND_DRIVERS
2788 SPL uses normal NAND drivers, not minimal drivers.
2789
2790 CONFIG_SPL_NAND_ECC
2791 Include standard software ECC in the SPL
2792
Tom Rini95579792012-02-14 07:29:40 +00002793 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002794 Support for NAND boot using simple NAND drivers that
2795 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002796
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02002797 CONFIG_SPL_UBI
2798 Support for a lightweight UBI (fastmap) scanner and
2799 loader
2800
Heiko Schocher0c3117b2014-10-31 08:31:00 +01002801 CONFIG_SPL_NAND_RAW_ONLY
2802 Support to boot only raw u-boot.bin images. Use this only
2803 if you need to save space.
2804
Ying Zhang7c8eea52013-08-16 15:16:12 +08002805 CONFIG_SPL_COMMON_INIT_DDR
2806 Set for common ddr init with serial presence detect in
2807 SPL binary.
2808
Tom Rini95579792012-02-14 07:29:40 +00002809 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2810 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2811 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2812 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2813 CONFIG_SYS_NAND_ECCBYTES
2814 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002815 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002816
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05302817 CONFIG_SPL_NAND_BOOT
2818 Add support NAND boot
2819
Tom Rini95579792012-02-14 07:29:40 +00002820 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002821 Location in NAND to read U-Boot from
2822
2823 CONFIG_SYS_NAND_U_BOOT_DST
2824 Location in memory to load U-Boot to
2825
2826 CONFIG_SYS_NAND_U_BOOT_SIZE
2827 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002828
2829 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002830 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002831
2832 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2833 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002834 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00002835
Pavel Machekc57b9532012-08-30 22:42:11 +02002836 CONFIG_SPL_RAM_DEVICE
2837 Support for running image already present in ram, in SPL binary
2838
Scott Wood74752ba2012-12-06 13:33:16 +00002839 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002840 Image offset to which the SPL should be padded before appending
2841 the SPL payload. By default, this is defined as
2842 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2843 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2844 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002845
Scott Woodca2fca22012-09-21 16:27:32 -05002846 CONFIG_SPL_TARGET
2847 Final target image containing SPL and payload. Some SPLs
2848 use an arch-specific makefile fragment instead, for
2849 example if more than one image needs to be produced.
2850
Simon Glass87ebee32013-05-08 08:05:59 +00002851 CONFIG_FIT_SPL_PRINT
2852 Printing information about a FIT image adds quite a bit of
2853 code to SPL. So this is normally disabled in SPL. Use this
2854 option to re-enable it. This will affect the output of the
2855 bootm command when booting a FIT image.
2856
Ying Zhang3aa29de2013-08-16 15:16:15 +08002857- TPL framework
2858 CONFIG_TPL
2859 Enable building of TPL globally.
2860
2861 CONFIG_TPL_PAD_TO
2862 Image offset to which the TPL should be padded before appending
2863 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02002864 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2865 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2866 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002867
wdenka8c7c702003-12-06 19:49:23 +00002868- Interrupt support (PPC):
2869
wdenkd4ca31c2004-01-02 14:00:00 +00002870 There are common interrupt_init() and timer_interrupt()
2871 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002872 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002873 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002874 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002875 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002876 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002877 specific handling. If board has watchdog / status_led
2878 / other_activity_monitor it works automatically from
2879 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002880
wdenkc6097192002-11-03 00:24:07 +00002881
Helmut Raiger9660e442011-10-20 04:19:47 +00002882Board initialization settings:
2883------------------------------
2884
2885During Initialization u-boot calls a number of board specific functions
2886to allow the preparation of board specific prerequisites, e.g. pin setup
2887before drivers are initialized. To enable these callbacks the
2888following configuration macros have to be defined. Currently this is
2889architecture specific, so please check arch/your_architecture/lib/board.c
2890typically in board_init_f() and board_init_r().
2891
2892- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2893- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2894- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2895- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002896
wdenkc6097192002-11-03 00:24:07 +00002897Configuration Settings:
2898-----------------------
2899
York Sun4d1fd7f2014-02-26 17:03:19 -08002900- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2901 Optionally it can be defined to support 64-bit memory commands.
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002904 undefine this when you're short of memory.
2905
Peter Tyser2fb26042009-01-27 18:03:12 -06002906- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2907 width of the commands listed in the 'help' command output.
2908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002910 prompt for user input.
2911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002912- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002914- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002916- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002918- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002919 the application (usually a Linux kernel) when it is
2920 booted
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002923 List of legal baudrate settings for this board.
2924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002925- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002926 Begin and End addresses of the area used by the
2927 simple memory test.
2928
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002929- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002930 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002932- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002933 Scratch address used by the alternate memory test
2934 You only need to set this if address zero isn't writeable
2935
York Sune8149522015-12-04 11:57:07 -08002936- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07002937 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08002938 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2939 is substracted from total RAM and won't be reported to OS.
2940 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07002941 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08002942 the RAM base is not zero, or RAM is divided into banks,
2943 this variable needs to be recalcuated to get the address.
2944
York Sunaabd7dd2015-12-07 11:05:29 -08002945- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002946 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002947 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002948 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002949 fixing up gd->ram_size the Linux kernel should gets passed
2950 the now "corrected" memory size and won't touch it either.
2951 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002952 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002953 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002954 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002955
2956 This option can be used as a workaround for the 440EPx/GRx
2957 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2958 be touched.
2959
2960 WARNING: Please make sure that this value is a multiple of
2961 the Linux page size (normally 4k). If this is not the case,
2962 then the end address of the Linux memory will be located at a
2963 non page size aligned address and this could cause major
2964 problems.
2965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002966- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002967 Enable temporary baudrate change while serial download
2968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002969- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002970 Physical start address of SDRAM. _Must_ be 0 here.
2971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002973 Physical start address of Flash memory.
2974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002975- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002976 Physical start address of boot monitor code (set by
2977 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002978 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002979 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002981- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002982 Size of memory reserved for monitor code, used to
2983 determine _at_compile_time_ (!) if the environment is
2984 embedded within the U-Boot image, or in a separate
2985 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002987- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002988 Size of DRAM reserved for malloc() use.
2989
Simon Glassd59476b2014-07-10 22:23:28 -06002990- CONFIG_SYS_MALLOC_F_LEN
2991 Size of the malloc() pool for use before relocation. If
2992 this is defined, then a very simple malloc() implementation
2993 will become available before relocation. The address is just
2994 below the global data, and the stack is moved down to make
2995 space.
2996
2997 This feature allocates regions with increasing addresses
2998 within the region. calloc() is supported, but realloc()
2999 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003000 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003001 U-Boot relocates itself.
3002
Simon Glass38687ae2014-11-10 17:16:54 -07003003- CONFIG_SYS_MALLOC_SIMPLE
3004 Provides a simple and small malloc() and calloc() for those
3005 boards which do not use the full malloc in SPL (which is
3006 enabled with CONFIG_SYS_SPL_MALLOC_START).
3007
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003008- CONFIG_SYS_NONCACHED_MEMORY:
3009 Size of non-cached memory area. This area of memory will be
3010 typically located right below the malloc() area and mapped
3011 uncached in the MMU. This is useful for drivers that would
3012 otherwise require a lot of explicit cache maintenance. For
3013 some drivers it's also impossible to properly maintain the
3014 cache. For example if the regions that need to be flushed
3015 are not a multiple of the cache-line size, *and* padding
3016 cannot be allocated between the regions to align them (i.e.
3017 if the HW requires a contiguous array of regions, and the
3018 size of each region is not cache-aligned), then a flush of
3019 one region may result in overwriting data that hardware has
3020 written to another region in the same cache-line. This can
3021 happen for example in network drivers where descriptors for
3022 buffers are typically smaller than the CPU cache-line (e.g.
3023 16 bytes vs. 32 or 64 bytes).
3024
3025 Non-cached memory is only supported on 32-bit ARM at present.
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003028 Normally compressed uImages are limited to an
3029 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003030 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003031 to adjust this setting to your needs.
3032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003033- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003034 Maximum size of memory mapped by the startup code of
3035 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003036 the Linux kernel (bd_info, boot arguments, FDT blob if
3037 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003038 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003039 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003040 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003041 variable "bootm_mapsize" will override the value of
3042 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3043 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003044
John Rigbyfca43cc2010-10-13 13:57:35 -06003045- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3046 Enable initrd_high functionality. If defined then the
3047 initrd_high feature is enabled and the bootm ramdisk subcommand
3048 is enabled.
3049
3050- CONFIG_SYS_BOOT_GET_CMDLINE:
3051 Enables allocating and saving kernel cmdline in space between
3052 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3053
3054- CONFIG_SYS_BOOT_GET_KBD:
3055 Enables allocating and saving a kernel copy of the bd_info in
3056 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3057
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003058- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003059 Max number of Flash memory banks
3060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003061- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003062 Max number of sectors on a Flash chip
3063
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003064- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003065 Timeout for Flash erase operations (in ms)
3066
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003067- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003068 Timeout for Flash write operations (in ms)
3069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003070- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003071 Timeout for Flash set sector lock bit operation (in ms)
3072
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003073- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003074 Timeout for Flash clear lock bits operation (in ms)
3075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003076- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003077 If defined, hardware flash sectors protection is used
3078 instead of U-Boot software protection.
3079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003080- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003081
3082 Enable TFTP transfers directly to flash memory;
3083 without this option such a download has to be
3084 performed in two steps: (1) download to RAM, and (2)
3085 copy from RAM to flash.
3086
3087 The two-step approach is usually more reliable, since
3088 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003089 the flash, but in some situations (when system RAM is
3090 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003091 downloaded image) this option may be very useful.
3092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003093- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003094 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003095 common flash structure for storing flash geometry.
3096
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003097- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003098 This option also enables the building of the cfi_flash driver
3099 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003100
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003101- CONFIG_FLASH_CFI_MTD
3102 This option enables the building of the cfi_mtd driver
3103 in the drivers directory. The driver exports CFI flash
3104 to the MTD layer.
3105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003106- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003107 Use buffered writes to flash.
3108
3109- CONFIG_FLASH_SPANSION_S29WS_N
3110 s29ws-n MirrorBit flash has non-standard addresses for buffered
3111 write commands.
3112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003113- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003114 If this option is defined, the common CFI flash doesn't
3115 print it's warning upon not recognized FLASH banks. This
3116 is useful, if some of the configured banks are only
3117 optionally available.
3118
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003119- CONFIG_FLASH_SHOW_PROGRESS
3120 If defined (must be an integer), print out countdown
3121 digits and dots. Recommended value: 45 (9..1) for 80
3122 column displays, 15 (3..1) for 40 column displays.
3123
Stefan Roese352ef3f2013-04-04 15:53:14 +02003124- CONFIG_FLASH_VERIFY
3125 If defined, the content of the flash (destination) is compared
3126 against the source after the write operation. An error message
3127 will be printed when the contents are not identical.
3128 Please note that this option is useless in nearly all cases,
3129 since such flash programming errors usually are detected earlier
3130 while unprotecting/erasing/programming. Please only enable
3131 this option if you really know what you are doing.
3132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003133- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003134 Defines the number of Ethernet receive buffers. On some
3135 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003136 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3137 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003138 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003139 Defaults to 4 if not defined.
3140
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003141- CONFIG_ENV_MAX_ENTRIES
3142
Wolfgang Denk071bc922010-10-27 22:48:30 +02003143 Maximum number of entries in the hash table that is used
3144 internally to store the environment settings. The default
3145 setting is supposed to be generous and should work in most
3146 cases. This setting can be used to tune behaviour; see
3147 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003148
Joe Hershberger25980902012-12-11 22:16:31 -06003149- CONFIG_ENV_FLAGS_LIST_DEFAULT
3150- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003151 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003152 calling env set. Variables can be restricted to only decimal,
3153 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3154 the variables can also be restricted to IP address or MAC address.
3155
3156 The format of the list is:
3157 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003158 access_attribute = [a|r|o|c]
3159 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003160 entry = variable_name[:attributes]
3161 list = entry[,list]
3162
3163 The type attributes are:
3164 s - String (default)
3165 d - Decimal
3166 x - Hexadecimal
3167 b - Boolean ([1yYtT|0nNfF])
3168 i - IP address
3169 m - MAC address
3170
Joe Hershberger267541f2012-12-11 22:16:34 -06003171 The access attributes are:
3172 a - Any (default)
3173 r - Read-only
3174 o - Write-once
3175 c - Change-default
3176
Joe Hershberger25980902012-12-11 22:16:31 -06003177 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3178 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003179 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003180
3181 - CONFIG_ENV_FLAGS_LIST_STATIC
3182 Define this to a list (string) to define validation that
3183 should be done if an entry is not found in the ".flags"
3184 environment variable. To override a setting in the static
3185 list, simply add an entry for the same variable name to the
3186 ".flags" variable.
3187
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003188 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3189 regular expression. This allows multiple variables to define the same
3190 flags without explicitly listing them for each variable.
3191
Joe Hershberger267541f2012-12-11 22:16:34 -06003192- CONFIG_ENV_ACCESS_IGNORE_FORCE
3193 If defined, don't allow the -f switch to env set override variable
3194 access flags.
3195
Gabe Black0d296cc2014-10-15 04:38:30 -06003196- CONFIG_USE_STDINT
3197 If stdint.h is available with your toolchain you can define this
3198 option to enable it. You can provide option 'USE_STDINT=1' when
3199 building U-Boot to enable this.
3200
wdenkc6097192002-11-03 00:24:07 +00003201The following definitions that deal with the placement and management
3202of environment data (variable area); in general, we support the
3203following configurations:
3204
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003205- CONFIG_BUILD_ENVCRC:
3206
3207 Builds up envcrc with the target environment so that external utils
3208 may easily extract it and embed it in final U-Boot images.
3209
wdenkc6097192002-11-03 00:24:07 +00003210BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003211in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003212console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003213U-Boot will hang.
3214
3215Please note that even with NVRAM we still use a copy of the
3216environment in RAM: we could work on NVRAM directly, but we want to
3217keep settings there always unmodified except somebody uses "saveenv"
3218to save the current settings.
3219
Liu Gang0a85a9e2012-03-08 00:33:20 +00003220BE CAREFUL! For some special cases, the local device can not use
3221"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003222environment stored in a remote NOR flash by SRIO or PCIE link,
3223but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003224
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003225- CONFIG_NAND_ENV_DST
3226
3227 Defines address in RAM to which the nand_spl code should copy the
3228 environment. If redundant environment is used, it will be copied to
3229 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3230
Bruce Adlere881cb52007-11-02 13:15:42 -07003231Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003232has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06003233created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00003234until then to read environment variables.
3235
wdenk85ec0bc2003-03-31 16:34:49 +00003236The environment is protected by a CRC32 checksum. Before the monitor
3237is relocated into RAM, as a result of a bad CRC you will be working
3238with the compiled-in default environment - *silently*!!! [This is
3239necessary, because the first environment variable we need is the
3240"baudrate" setting for the console - if we have a bad CRC, we don't
3241have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003242
3243Note: once the monitor has been relocated, then it will complain if
3244the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003245use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003247- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003248 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003250 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003251 also needs to be defined.
3252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003253- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003254 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003255
Ron Madridf5675aa2009-02-18 14:30:44 -08003256- CONFIG_NS16550_MIN_FUNCTIONS:
3257 Define this if you desire to only have use of the NS16550_init
3258 and NS16550_putc functions for the serial driver located at
3259 drivers/serial/ns16550.c. This option is useful for saving
3260 space for already greatly restricted images, including but not
3261 limited to NAND_SPL configurations.
3262
Simon Glassb2b92f52012-11-30 13:01:18 +00003263- CONFIG_DISPLAY_BOARDINFO
3264 Display information about the board that U-Boot is running on
3265 when U-Boot starts up. The board function checkboard() is called
3266 to do this.
3267
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003268- CONFIG_DISPLAY_BOARDINFO_LATE
3269 Similar to the previous option, but display this information
3270 later, once stdio is running and output goes to the LCD, if
3271 present.
3272
Sascha Silbefeb85802013-08-11 16:40:43 +02003273- CONFIG_BOARD_SIZE_LIMIT:
3274 Maximum size of the U-Boot image. When defined, the
3275 build system checks that the actual size does not
3276 exceed it.
3277
wdenkc6097192002-11-03 00:24:07 +00003278Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003279---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003281- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003282 Cache Line Size of the CPU.
3283
Timur Tabie46fedf2011-08-04 18:03:41 -05003284- CONFIG_SYS_CCSRBAR_DEFAULT:
3285 Default (power-on reset) physical address of CCSR on Freescale
3286 PowerPC SOCs.
3287
3288- CONFIG_SYS_CCSRBAR:
3289 Virtual address of CCSR. On a 32-bit build, this is typically
3290 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3291
Timur Tabie46fedf2011-08-04 18:03:41 -05003292- CONFIG_SYS_CCSRBAR_PHYS:
3293 Physical address of CCSR. CCSR can be relocated to a new
3294 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003295 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003296 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3297 is typically relocated on 36-bit builds. It is recommended
3298 that this macro be defined via the _HIGH and _LOW macros:
3299
3300 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3301 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3302
3303- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003304 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3305 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003306 used in assembly code, so it must not contain typecasts or
3307 integer size suffixes (e.g. "ULL").
3308
3309- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3310 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3311 used in assembly code, so it must not contain typecasts or
3312 integer size suffixes (e.g. "ULL").
3313
3314- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3315 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3316 forced to a value that ensures that CCSR is not relocated.
3317
wdenk7f6c2cb2002-11-10 22:06:23 +00003318- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003319 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003320
3321 the default drive number (default value 0)
3322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003323 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003324
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003325 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003326 (default value 1)
3327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003328 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003329
wdenk43d96162003-03-06 00:02:04 +00003330 defines the offset of register from address. It
3331 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003332 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003334 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3335 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003336 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003338 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003339 fdc_hw_init() is called at the beginning of the FDC
3340 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003341 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00003342 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003343
Macpaul Lin0abddf82011-04-11 20:45:32 +00003344- CONFIG_IDE_AHB:
3345 Most IDE controllers were designed to be connected with PCI
3346 interface. Only few of them were designed for AHB interface.
3347 When software is doing ATA command and data transfer to
3348 IDE devices through IDE-AHB controller, some additional
3349 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003350 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00003351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003352- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003353 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02003354 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003356- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk7152b1d2003-09-05 23:19:14 +00003358 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003359 initial data and stack; please note that this must be
3360 writable memory that is working WITHOUT special
3361 initialization, i. e. you CANNOT use normal RAM which
3362 will become available only after programming the
3363 memory controller and running certain initialization
3364 sequences.
3365
3366 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02003367 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00003368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003369- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003370
3371 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003372 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3373 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003374 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003375 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06003376 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003377 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3378 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003379
3380 Note:
3381 On the MPC824X (or other systems that use the data
3382 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003383 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003384 point to an otherwise UNUSED address space between
3385 the top of RAM and the start of the PCI space.
3386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003387- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003389- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003390 SDRAM timing
3391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003393 periodic timer for refresh
3394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003395- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3396 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3397 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3398 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003399 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3400
3401- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003402 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3403 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003404 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3405
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003406- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003407 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003408 Don't do any setup work, presumably because someone or
3409 something has already done it, and we don't need to do it
3410 a second time. Useful for platforms that are pre-booted
3411 by coreboot or similar.
3412
Gabor Juhos842033e2013-05-30 07:06:12 +00003413- CONFIG_PCI_INDIRECT_BRIDGE:
3414 Enable support for indirect PCI bridges.
3415
Kumar Galaa09b9b62010-12-30 12:09:53 -06003416- CONFIG_SYS_SRIO:
3417 Chip has SRIO or not
3418
3419- CONFIG_SRIO1:
3420 Board has SRIO 1 port available
3421
3422- CONFIG_SRIO2:
3423 Board has SRIO 2 port available
3424
Liu Gangc8b28152013-05-07 16:30:46 +08003425- CONFIG_SRIO_PCIE_BOOT_MASTER
3426 Board can support master function for Boot from SRIO and PCIE
3427
Kumar Galaa09b9b62010-12-30 12:09:53 -06003428- CONFIG_SYS_SRIOn_MEM_VIRT:
3429 Virtual Address of SRIO port 'n' memory region
3430
3431- CONFIG_SYS_SRIOn_MEM_PHYS:
3432 Physical Address of SRIO port 'n' memory region
3433
3434- CONFIG_SYS_SRIOn_MEM_SIZE:
3435 Size of SRIO port 'n' memory region
3436
Fabio Estevam66bd1842013-04-11 09:35:34 +00003437- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3438 Defined to tell the NAND controller that the NAND chip is using
3439 a 16 bit bus.
3440 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003441 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003442 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003443 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003444
3445- CONFIG_SYS_NDFC_EBC0_CFG
3446 Sets the EBC0_CFG register for the NDFC. If not defined
3447 a default value will be used.
3448
Ben Warrenbb99ad62006-09-07 16:50:54 -04003449- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003450 Get DDR timing information from an I2C EEPROM. Common
3451 with pluggable memory modules such as SODIMMs
3452
Ben Warrenbb99ad62006-09-07 16:50:54 -04003453 SPD_EEPROM_ADDRESS
3454 I2C address of the SPD EEPROM
3455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003456- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003457 If SPD EEPROM is on an I2C bus other than the first
3458 one, specify here. Note that the value must resolve
3459 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003460
York Sun1b3e3c42011-06-07 09:42:16 +08003461- CONFIG_SYS_DDR_RAW_TIMING
3462 Get DDR timing information from other than SPD. Common with
3463 soldered DDR chips onboard without SPD. DDR raw timing
3464 parameters are extracted from datasheet and hard-coded into
3465 header files or board specific files.
3466
York Sun6f5e1dc2011-09-16 13:21:35 -07003467- CONFIG_FSL_DDR_INTERACTIVE
3468 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3469
York Sune32d59a2015-01-06 13:18:55 -08003470- CONFIG_FSL_DDR_SYNC_REFRESH
3471 Enable sync of refresh for multiple controllers.
3472
York Sun4516ff82015-03-19 09:30:28 -07003473- CONFIG_FSL_DDR_BIST
3474 Enable built-in memory test for Freescale DDR controllers.
3475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003476- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003477 Only for 83xx systems. If specified, then DDR should
3478 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003479
wdenkc26e4542004-04-18 10:13:26 +00003480- CONFIG_RMII
3481 Enable RMII mode for all FECs.
3482 Note that this is a global option, we can't
3483 have one FEC in standard MII mode and another in RMII mode.
3484
wdenk5cf91d62004-04-23 20:32:05 +00003485- CONFIG_CRC32_VERIFY
3486 Add a verify option to the crc32 command.
3487 The syntax is:
3488
3489 => crc32 -v <address> <count> <crc32>
3490
3491 Where address/count indicate a memory area
3492 and crc32 is the correct crc32 which the
3493 area should have.
3494
wdenk56523f12004-07-11 17:40:54 +00003495- CONFIG_LOOPW
3496 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06003497 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00003498
stroese7b466642004-12-16 18:46:55 +00003499- CONFIG_MX_CYCLIC
3500 Add the "mdc" and "mwc" memory commands. These are cyclic
3501 "md/mw" commands.
3502 Examples:
3503
wdenkefe2a4d2004-12-16 21:44:03 +00003504 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003505 This command will print 4 bytes (10,11,12,13) each 500 ms.
3506
wdenkefe2a4d2004-12-16 21:44:03 +00003507 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003508 This command will write 12345678 to address 100 all 10 ms.
3509
wdenkefe2a4d2004-12-16 21:44:03 +00003510 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06003511 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00003512
wdenk8aa1a2d2005-04-04 12:44:11 +00003513- CONFIG_SKIP_LOWLEVEL_INIT
Rick Chen3fafced2017-12-26 13:55:59 +08003514 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003515 low level initializations (like setting up the memory
3516 controller) are omitted and/or U-Boot does not
3517 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003518
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003519 Normally this variable MUST NOT be defined. The only
3520 exception is when U-Boot is loaded (to RAM) by some
3521 other boot loader or by a debugger which performs
3522 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003523
Simon Glassb5bd0982016-05-05 07:28:06 -06003524- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3525 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09003526 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06003527 instruction cache) is still performed.
3528
Aneesh V401bb302011-07-13 05:11:07 +00003529- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003530 Modifies the behaviour of start.S when compiling a loader
3531 that is executed before the actual U-Boot. E.g. when
3532 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003533
Ying Zhang3aa29de2013-08-16 15:16:15 +08003534- CONFIG_TPL_BUILD
3535 Modifies the behaviour of start.S when compiling a loader
3536 that is executed after the SPL and before the actual U-Boot.
3537 It is loaded by the SPL.
3538
Ying Zhang5df572f2013-05-20 14:07:23 +08003539- CONFIG_SYS_MPC85XX_NO_RESETVEC
3540 Only for 85xx systems. If this variable is specified, the section
3541 .resetvec is not kept and the section .bootpg is placed in the
3542 previous 4k of the .text section.
3543
Simon Glass4213fc22013-02-24 17:33:14 +00003544- CONFIG_ARCH_MAP_SYSMEM
3545 Generally U-Boot (and in particular the md command) uses
3546 effective address. It is therefore not necessary to regard
3547 U-Boot address as virtual addresses that need to be translated
3548 to physical addresses. However, sandbox requires this, since
3549 it maintains its own little RAM buffer which contains all
3550 addressable memory. This option causes some memory accesses
3551 to be mapped through map_sysmem() / unmap_sysmem().
3552
Simon Glass588a13f2013-02-14 04:18:54 +00003553- CONFIG_X86_RESET_VECTOR
3554 If defined, the x86 reset vector code is included. This is not
3555 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003556
Heiko Schocher16678eb2013-11-04 14:05:00 +01003557- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3558 Enables the RTC32K OSC on AM33xx based plattforms
3559
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04003560- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3561 Option to disable subpage write in NAND driver
3562 driver that uses this:
3563 drivers/mtd/nand/davinci_nand.c
3564
Timur Tabif2717b42011-11-22 09:21:25 -06003565Freescale QE/FMAN Firmware Support:
3566-----------------------------------
3567
3568The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3569loading of "firmware", which is encoded in the QE firmware binary format.
3570This firmware often needs to be loaded during U-Boot booting, so macros
3571are used to identify the storage device (NOR flash, SPI, etc) and the address
3572within that device.
3573
Zhao Qiangdcf1d772014-03-21 16:21:44 +08003574- CONFIG_SYS_FMAN_FW_ADDR
3575 The address in the storage device where the FMAN microcode is located. The
3576 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3577 is also specified.
3578
3579- CONFIG_SYS_QE_FW_ADDR
3580 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06003581 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3582 is also specified.
3583
3584- CONFIG_SYS_QE_FMAN_FW_LENGTH
3585 The maximum possible size of the firmware. The firmware binary format
3586 has a field that specifies the actual size of the firmware, but it
3587 might not be possible to read any part of the firmware unless some
3588 local storage is allocated to hold the entire firmware first.
3589
3590- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3591 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3592 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3593 virtual address in NOR flash.
3594
3595- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3596 Specifies that QE/FMAN firmware is located in NAND flash.
3597 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3598
3599- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3600 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3601 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3602
Liu Gang292dc6c2012-03-08 00:33:18 +00003603- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3604 Specifies that QE/FMAN firmware is located in the remote (master)
3605 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003606 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3607 window->master inbound window->master LAW->the ucode address in
3608 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003609
J. German Riverab940ca62014-06-23 15:15:55 -07003610Freescale Layerscape Management Complex Firmware Support:
3611---------------------------------------------------------
3612The Freescale Layerscape Management Complex (MC) supports the loading of
3613"firmware".
3614This firmware often needs to be loaded during U-Boot booting, so macros
3615are used to identify the storage device (NOR flash, SPI, etc) and the address
3616within that device.
3617
3618- CONFIG_FSL_MC_ENET
3619 Enable the MC driver for Layerscape SoCs.
3620
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303621Freescale Layerscape Debug Server Support:
3622-------------------------------------------
3623The Freescale Layerscape Debug Server Support supports the loading of
3624"Debug Server firmware" and triggering SP boot-rom.
3625This firmware often needs to be loaded during U-Boot booting.
3626
York Sunc0492142015-12-07 11:08:58 -08003627- CONFIG_SYS_MC_RSV_MEM_ALIGN
3628 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05303629
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02003630Reproducible builds
3631-------------------
3632
3633In order to achieve reproducible builds, timestamps used in the U-Boot build
3634process have to be set to a fixed value.
3635
3636This is done using the SOURCE_DATE_EPOCH environment variable.
3637SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3638option for U-Boot or an environment variable in U-Boot.
3639
3640SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3641
wdenkc6097192002-11-03 00:24:07 +00003642Building the Software:
3643======================
3644
Wolfgang Denk218ca722008-03-26 10:40:12 +01003645Building U-Boot has been tested in several native build environments
3646and in many different cross environments. Of course we cannot support
3647all possibly existing versions of cross development tools in all
3648(potentially obsolete) versions. In case of tool chain problems we
3649recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3650which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003651
Wolfgang Denk218ca722008-03-26 10:40:12 +01003652If you are not using a native environment, it is assumed that you
3653have GNU cross compiling tools available in your path. In this case,
3654you must set the environment variable CROSS_COMPILE in your shell.
3655Note that no changes to the Makefile or any other source files are
3656necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003657
Wolfgang Denk218ca722008-03-26 10:40:12 +01003658 $ CROSS_COMPILE=ppc_4xx-
3659 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003660
Peter Tyser2f8d3962009-03-13 18:54:51 -05003661Note: If you wish to generate Windows versions of the utilities in
3662 the tools directory you can use the MinGW toolchain
3663 (http://www.mingw.org). Set your HOST tools to the MinGW
3664 toolchain and execute 'make tools'. For example:
3665
3666 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3667
3668 Binaries such as tools/mkimage.exe will be created which can
3669 be executed on computers running Windows.
3670
Wolfgang Denk218ca722008-03-26 10:40:12 +01003671U-Boot is intended to be simple to build. After installing the
3672sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003673is done by typing:
3674
Holger Freytherab584d62014-08-04 09:26:05 +02003675 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00003676
Holger Freytherab584d62014-08-04 09:26:05 +02003677where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003678rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003679
wdenk2729af92004-05-03 20:45:30 +00003680Note: for some board special configuration names may exist; check if
3681 additional information is available from the board vendor; for
3682 instance, the TQM823L systems are available without (standard)
3683 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003684 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003685
Holger Freytherab584d62014-08-04 09:26:05 +02003686 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00003687 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003688
Holger Freytherab584d62014-08-04 09:26:05 +02003689 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00003690 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692 etc.
wdenkc6097192002-11-03 00:24:07 +00003693
wdenkc6097192002-11-03 00:24:07 +00003694
wdenk2729af92004-05-03 20:45:30 +00003695Finally, type "make all", and you should get some working U-Boot
3696images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698- "u-boot.bin" is a raw binary image
3699- "u-boot" is an image in ELF binary format
3700- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003701
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003702By default the build is performed locally and the objects are saved
3703in the source directory. One of the two methods can be used to change
3704this behavior and build U-Boot to some external directory:
3705
37061. Add O= to the make command line invocations:
3707
3708 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003709 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003710 make O=/tmp/build all
3711
Timo Ketolaadbba992014-11-06 14:39:05 +020037122. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003713
Timo Ketolaadbba992014-11-06 14:39:05 +02003714 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003715 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02003716 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003717 make all
3718
Timo Ketolaadbba992014-11-06 14:39:05 +02003719Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003720variable.
3721
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01003722User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3723setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3724For example to treat all compiler warnings as errors:
3725
3726 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728Please be aware that the Makefiles assume you are using GNU make, so
3729for instance on NetBSD you might need to use "gmake" instead of
3730native "make".
wdenkc6097192002-11-03 00:24:07 +00003731
wdenkc6097192002-11-03 00:24:07 +00003732
wdenk2729af92004-05-03 20:45:30 +00003733If the system board that you have is not listed, then you will need
3734to port U-Boot to your hardware platform. To do this, follow these
3735steps:
wdenkc6097192002-11-03 00:24:07 +00003736
Phil Sutter3c1496c2015-12-25 14:41:18 +010037371. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00003738 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01003739 the "Makefile" and a "<board>.c".
37402. Create a new configuration file "include/configs/<board>.h" for
3741 your board.
wdenk2729af92004-05-03 20:45:30 +000037423. If you're porting U-Boot to a new CPU, then also create a new
3743 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020037444. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000037455. Type "make", and you should get a working "u-boot.srec" file
3746 to be installed on your target system.
37476. Debug and solve any problems that might arise.
3748 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003749
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3752==============================================================
wdenkc6097192002-11-03 00:24:07 +00003753
Wolfgang Denk218ca722008-03-26 10:40:12 +01003754If you have modified U-Boot sources (for instance added a new board
3755or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003756provide feedback to the other developers. The feedback normally takes
3757the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003758official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003759
Wolfgang Denk218ca722008-03-26 10:40:12 +01003760But before you submit such a patch, please verify that your modifi-
3761cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003762the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06003763just run the buildman script (tools/buildman/buildman), which will
3764configure and build U-Boot for ALL supported system. Be warned, this
3765will take a while. Please see the buildman README, or run 'buildman -H'
3766for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003767
3768
wdenk2729af92004-05-03 20:45:30 +00003769See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003770
wdenkc6097192002-11-03 00:24:07 +00003771
wdenk2729af92004-05-03 20:45:30 +00003772Monitor Commands - Overview:
3773============================
wdenkc6097192002-11-03 00:24:07 +00003774
wdenk2729af92004-05-03 20:45:30 +00003775go - start application at address 'addr'
3776run - run commands in an environment variable
3777bootm - boot application image from memory
3778bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003779bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003780tftpboot- boot image via network using TFTP protocol
3781 and env variables "ipaddr" and "serverip"
3782 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003783tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003784rarpboot- boot image via network using RARP/TFTP protocol
3785diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3786loads - load S-Record file over serial line
3787loadb - load binary file over serial line (kermit mode)
3788md - memory display
3789mm - memory modify (auto-incrementing)
3790nm - memory modify (constant address)
3791mw - memory write (fill)
3792cp - memory copy
3793cmp - memory compare
3794crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003795i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003796sspi - SPI utility commands
3797base - print or set address offset
3798printenv- print environment variables
3799setenv - set environment variables
3800saveenv - save environment variables to persistent storage
3801protect - enable or disable FLASH write protection
3802erase - erase FLASH memory
3803flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003804nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003805bdinfo - print Board Info structure
3806iminfo - print header information for application image
3807coninfo - print console devices and informations
3808ide - IDE sub-system
3809loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003810loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003811mtest - simple RAM test
3812icache - enable or disable instruction cache
3813dcache - enable or disable data cache
3814reset - Perform RESET of the CPU
3815echo - echo args to console
3816version - print monitor version
3817help - print online help
3818? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003819
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821Monitor Commands - Detailed Description:
3822========================================
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824TODO.
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003827
3828
wdenk2729af92004-05-03 20:45:30 +00003829Environment Variables:
3830======================
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk2729af92004-05-03 20:45:30 +00003832U-Boot supports user configuration using Environment Variables which
3833can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk2729af92004-05-03 20:45:30 +00003835Environment Variables are set using "setenv", printed using
3836"printenv", and saved to Flash using "saveenv". Using "setenv"
3837without a value can be used to delete a variable from the
3838environment. As long as you don't save the environment you are
3839working with an in-memory copy. In case the Flash area containing the
3840environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003841
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003842Some configuration options can be set using Environment Variables.
3843
3844List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk2729af92004-05-03 20:45:30 +00003846 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003851
wdenk2729af92004-05-03 20:45:30 +00003852 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003853
wdenk2729af92004-05-03 20:45:30 +00003854 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003855
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003856 bootm_low - Memory range available for image processing in the bootm
3857 command can be restricted. This variable is given as
3858 a hexadecimal number and defines lowest address allowed
3859 for use by the bootm command. See also "bootm_size"
3860 environment variable. Address defined by "bootm_low" is
3861 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003862 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3863 bootm_mapsize.
3864
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003865 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003866 This variable is given as a hexadecimal number and it
3867 defines the size of the memory region starting at base
3868 address bootm_low that is accessible by the Linux kernel
3869 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3870 as the default value if it is defined, and bootm_size is
3871 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003872
3873 bootm_size - Memory range available for image processing in the bootm
3874 command can be restricted. This variable is given as
3875 a hexadecimal number and defines the size of the region
3876 allowed for use by the bootm command. See also "bootm_low"
3877 environment variable.
3878
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003879 updatefile - Location of the software update file on a TFTP server, used
3880 by the automatic software update feature. Please refer to
3881 documentation in doc/README.update for more details.
3882
wdenk2729af92004-05-03 20:45:30 +00003883 autoload - if set to "no" (any string beginning with 'n'),
3884 "bootp" will just load perform a lookup of the
3885 configuration from the BOOTP server, but not try to
3886 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk2729af92004-05-03 20:45:30 +00003888 autostart - if set to "yes", an image loaded using the "bootp",
3889 "rarpboot", "tftpboot" or "diskboot" commands will
3890 be automatically started (by internally calling
3891 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 If set to "no", a standalone image passed to the
3894 "bootm" command will be copied to the load address
3895 (and eventually uncompressed), but NOT be started.
3896 This can be used to load and uncompress arbitrary
3897 data.
wdenkc6097192002-11-03 00:24:07 +00003898
David A. Longa28afca2011-07-09 16:40:19 -04003899 fdt_high - if set this restricts the maximum address that the
3900 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003901 For example, if you have a system with 1 GB memory
3902 at physical address 0x10000000, while Linux kernel
3903 only recognizes the first 704 MB as low memory, you
3904 may need to set fdt_high as 0x3C000000 to have the
3905 device tree blob be copied to the maximum address
3906 of the 704 MB low memory, so that Linux kernel can
3907 access it during the boot procedure.
3908
David A. Longa28afca2011-07-09 16:40:19 -04003909 If this is set to the special value 0xFFFFFFFF then
3910 the fdt will not be copied at all on boot. For this
3911 to work it must reside in writable memory, have
3912 sufficient padding on the end of it for u-boot to
3913 add the information it needs into it, and the memory
3914 must be accessible by the kernel.
3915
Simon Glasseea63e02011-10-24 19:15:34 +00003916 fdtcontroladdr- if set this is the address of the control flattened
3917 device tree used by U-Boot when CONFIG_OF_CONTROL is
3918 defined.
3919
wdenk17ea1172004-06-06 21:51:03 +00003920 i2cfast - (PPC405GP|PPC405EP only)
3921 if set to 'y' configures Linux I2C driver for fast
3922 mode (400kHZ). This environment variable is used in
3923 initialization code. So, for changes to be effective
3924 it must be saved and board must be reset.
3925
wdenk2729af92004-05-03 20:45:30 +00003926 initrd_high - restrict positioning of initrd images:
3927 If this variable is not set, initrd images will be
3928 copied to the highest possible address in RAM; this
3929 is usually what you want since it allows for
3930 maximum initrd size. If for some reason you want to
3931 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003932 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003933 variable to a value of "no" or "off" or "0".
3934 Alternatively, you can set it to a maximum upper
3935 address to use (U-Boot will still check that it
3936 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003937
wdenk2729af92004-05-03 20:45:30 +00003938 For instance, when you have a system with 16 MB
3939 RAM, and want to reserve 4 MB from use by Linux,
3940 you can do this by adding "mem=12M" to the value of
3941 the "bootargs" variable. However, now you must make
3942 sure that the initrd image is placed in the first
3943 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947 If you set initrd_high to 0xFFFFFFFF, this is an
3948 indication to U-Boot that all addresses are legal
3949 for the Linux kernel, including addresses in flash
3950 memory. In this case U-Boot will NOT COPY the
3951 ramdisk at all. This may be useful to reduce the
3952 boot time on your system, but requires that this
3953 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957 loadaddr - Default load address for commands like "bootp",
3958 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003961
wdenk2729af92004-05-03 20:45:30 +00003962 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003963
wdenk2729af92004-05-03 20:45:30 +00003964 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk2729af92004-05-03 20:45:30 +00003968 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003969
Mike Frysingere2a53452011-10-02 10:01:27 +00003970 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003971
Mike Frysingere2a53452011-10-02 10:01:27 +00003972 ethact - controls which interface is currently active.
3973 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003974
Heiko Schocher48690d82010-07-20 17:45:02 +02003975 => setenv ethact FEC
3976 => ping 192.168.0.1 # traffic sent on FEC
3977 => setenv ethact SCC
3978 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003979
Matthias Fuchse1692572008-01-17 07:45:05 +01003980 ethrotate - When set to "no" U-Boot does not go through all
3981 available network interfaces.
3982 It just stays at the currently selected interface.
3983
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003984 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003985 either succeed or fail without retrying.
3986 When set to "once" the network operation will
3987 fail when all the available network interfaces
3988 are tried once without success.
3989 Useful on scripts which control the retry operation
3990 themselves.
wdenkc6097192002-11-03 00:24:07 +00003991
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003992 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003993
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003994 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07003995 changing the console to be empty. If "yes" it will be
3996 made silent. If "no" it will not be made silent. If
3997 unset, then it will be made silent if the U-Boot console
3998 is silent.
3999
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004000 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004001 UDP source port.
4002
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004003 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004004 destination port instead of the Well Know Port 69.
4005
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004006 tftpblocksize - Block size to use for TFTP transfers; if not set,
4007 we use the TFTP server's default block size
4008
4009 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4010 seconds, minimum value is 1000 = 1 second). Defines
4011 when a packet is considered to be lost so it has to
4012 be retransmitted. The default is 5000 = 5 seconds.
4013 Lowering this value may make downloads succeed
4014 faster in networks with high packet loss rates or
4015 with unreliable TFTP servers.
4016
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02004017 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4018 unit, minimum value = 0). Defines how many timeouts
4019 can happen during a single file transfer before that
4020 transfer is aborted. The default is 10, and 0 means
4021 'no timeouts allowed'. Increasing this value may help
4022 downloads succeed with high packet loss rates, or with
4023 unreliable TFTP servers or client hardware.
4024
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004025 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004026 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004027 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004028
Alexandre Messier50768f52016-02-01 17:08:57 -05004029 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4030 Unsigned value, in milliseconds. If not set, the period will
4031 be either the default (28000), or a value based on
4032 CONFIG_NET_RETRY_COUNT, if defined. This value has
4033 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4034
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004035The following image location variables contain the location of images
4036used in booting. The "Image" column gives the role of the image and is
4037not an environment variable name. The other columns are environment
4038variable names. "File Name" gives the name of the file on a TFTP
4039server, "RAM Address" gives the location in RAM the image will be
4040loaded to, and "Flash Location" gives the image's address in NOR
4041flash or offset in NAND flash.
4042
4043*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03004044boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004045boards use these variables for other purposes.
4046
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004047Image File Name RAM Address Flash Location
4048----- --------- ----------- --------------
4049u-boot u-boot u-boot_addr_r u-boot_addr
4050Linux kernel bootfile kernel_addr_r kernel_addr
4051device tree blob fdtfile fdt_addr_r fdt_addr
4052ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004053
wdenk2729af92004-05-03 20:45:30 +00004054The following environment variables may be used and automatically
4055updated by the network boot commands ("bootp" and "rarpboot"),
4056depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058 bootfile - see above
4059 dnsip - IP address of your Domain Name Server
4060 dnsip2 - IP address of your secondary Domain Name Server
4061 gatewayip - IP address of the Gateway (Router) to use
4062 hostname - Target hostname
4063 ipaddr - see above
4064 netmask - Subnet Mask
4065 rootpath - Pathname of the root filesystem on the NFS server
4066 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004067
wdenka3d991b2004-04-15 21:48:45 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 serial# - contains hardware identification information such
4072 as type string and/or serial number
4073 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk2729af92004-05-03 20:45:30 +00004075These variables can be set only once (usually during manufacturing of
4076the board). U-Boot refuses to delete or overwrite these variables
4077once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004078
4079
wdenk2729af92004-05-03 20:45:30 +00004080Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk2729af92004-05-03 20:45:30 +00004082 ver - Contains the U-Boot version string as printed
4083 with the "version" command. This variable is
4084 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004085
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087Please note that changes to some configuration parameters may take
4088only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004089
stroesec1551ea2003-04-04 15:53:41 +00004090
Joe Hershberger170ab112012-12-11 22:16:24 -06004091Callback functions for environment variables:
4092---------------------------------------------
4093
4094For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004095when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06004096be associated with arbitrary variables. On creation, overwrite, or
4097deletion, the callback will provide the opportunity for some side
4098effect to happen or for the change to be rejected.
4099
4100The callbacks are named and associated with a function using the
4101U_BOOT_ENV_CALLBACK macro in your board or driver code.
4102
4103These callbacks are associated with variables in one of two ways. The
4104static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4105in the board configuration to a string that defines a list of
4106associations. The list must be in the following format:
4107
4108 entry = variable_name[:callback_name]
4109 list = entry[,list]
4110
4111If the callback name is not specified, then the callback is deleted.
4112Spaces are also allowed anywhere in the list.
4113
4114Callbacks can also be associated by defining the ".callbacks" variable
4115with the same list format above. Any association in ".callbacks" will
4116override any association in the static list. You can define
4117CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004118".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06004119
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004120If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4121regular expression. This allows multiple variables to be connected to
4122the same callback without explicitly listing them all out.
4123
Joe Hershberger170ab112012-12-11 22:16:24 -06004124
wdenk2729af92004-05-03 20:45:30 +00004125Command Line Parsing:
4126=====================
stroesec1551ea2003-04-04 15:53:41 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128There are two different command line parsers available with U-Boot:
4129the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131Old, simple command line parser:
4132--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134- supports environment variables (through setenv / saveenv commands)
4135- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004136- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004137- special characters ('$', ';') can be escaped by prefixing with '\',
4138 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004139 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004140- You can also escape text by enclosing in single apostrophes, for example:
4141 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143Hush shell:
4144-----------
wdenkf07771c2003-05-28 08:06:31 +00004145
wdenk2729af92004-05-03 20:45:30 +00004146- similar to Bourne shell, with control structures like
4147 if...then...else...fi, for...do...done; while...do...done,
4148 until...do...done, ...
4149- supports environment ("global") variables (through setenv / saveenv
4150 commands) and local shell variables (through standard shell syntax
4151 "name=value"); only environment variables can be used with "run"
4152 command
wdenkf07771c2003-05-28 08:06:31 +00004153
wdenk2729af92004-05-03 20:45:30 +00004154General rules:
4155--------------
wdenkf07771c2003-05-28 08:06:31 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157(1) If a command line (or an environment variable executed by a "run"
4158 command) contains several commands separated by semicolon, and
4159 one of these commands fails, then the remaining commands will be
4160 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004163 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004164 command will cause "run" to terminate, i. e. the remaining
4165 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004166
wdenk2729af92004-05-03 20:45:30 +00004167Note for Redundant Ethernet Interfaces:
4168=======================================
wdenkf07771c2003-05-28 08:06:31 +00004169
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004170Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004171such configurations and is capable of automatic selection of a
4172"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4175MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4176"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004177
wdenk2729af92004-05-03 20:45:30 +00004178If the network interface stores some valid MAC address (for instance
4179in SROM), this is used as default address if there is NO correspon-
4180ding setting in the environment; if the corresponding environment
4181variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004182
wdenk2729af92004-05-03 20:45:30 +00004183o If the SROM has a valid MAC address, and there is no address in the
4184 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk2729af92004-05-03 20:45:30 +00004186o If there is no valid address in the SROM, and a definition in the
4187 environment exists, then the value from the environment variable is
4188 used.
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190o If both the SROM and the environment contain a MAC address, and
4191 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193o If both the SROM and the environment contain a MAC address, and the
4194 addresses differ, the value from the environment is used and a
4195 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05004198 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4199 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004200
Ben Warrenecee9322010-04-26 11:11:46 -07004201If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004202will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004203may be skipped by setting the appropriate 'ethmacskip' environment variable.
4204The naming convention is as follows:
4205"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk2729af92004-05-03 20:45:30 +00004207Image Formats:
4208==============
wdenkc6097192002-11-03 00:24:07 +00004209
Marian Balakowicz3310c542008-03-12 12:13:13 +01004210U-Boot is capable of booting (and performing other auxiliary operations on)
4211images in two formats:
4212
4213New uImage format (FIT)
4214-----------------------
4215
4216Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4217to Flattened Device Tree). It allows the use of images with multiple
4218components (several kernels, ramdisks, etc.), with contents protected by
4219SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4220
4221
4222Old uImage format
4223-----------------
4224
4225Old image format is based on binary files which can be basically anything,
4226preceded by a special header; see the definitions in include/image.h for
4227details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4230 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004231 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4232 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4233 INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004234* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004235 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03004236 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004237* Compression Type (uncompressed, gzip, bzip2)
4238* Load Address
4239* Entry Point
4240* Image Name
4241* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243The header is marked by a special Magic Number, and both the header
4244and the data portions of the image are secured against corruption by
4245CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004246
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248Linux Support:
4249==============
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk2729af92004-05-03 20:45:30 +00004251Although U-Boot should support any OS or standalone application
4252easily, the main focus has always been on Linux during the design of
4253U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk2729af92004-05-03 20:45:30 +00004255U-Boot includes many features that so far have been part of some
4256special "boot loader" code within the Linux kernel. Also, any
4257"initrd" images to be used are no longer part of one big Linux image;
4258instead, kernel and "initrd" are separate images. This implementation
4259serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261- the same features can be used for other OS or standalone
4262 applications (for instance: using compressed images to reduce the
4263 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265- it becomes much easier to port new Linux kernel versions because
4266 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004267
wdenk2729af92004-05-03 20:45:30 +00004268- the same Linux kernel image can now be used with different "initrd"
4269 images; of course this also means that different kernel images can
4270 be run with the same "initrd". This makes testing easier (you don't
4271 have to build a new "zImage.initrd" Linux image when you just
4272 change a file in your "initrd"). Also, a field-upgrade of the
4273 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004274
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276Linux HOWTO:
4277============
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279Porting Linux to U-Boot based systems:
4280---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk2729af92004-05-03 20:45:30 +00004282U-Boot cannot save you from doing all the necessary modifications to
4283configure the Linux device drivers for use with your target hardware
4284(no, we don't intend to provide a full virtual machine interface to
4285Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004286
Stefan Roesea47a12b2010-04-15 16:07:28 +02004287But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk2729af92004-05-03 20:45:30 +00004289Just make sure your machine specific header file (for instance
4290include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004291Information structure as we define in include/asm-<arch>/u-boot.h,
4292and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004293as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004294
Simon Glass2eb31b12014-06-11 23:29:46 -06004295Note that U-Boot now has a driver model, a unified model for drivers.
4296If you are adding a new driver, plumb it into driver model. If there
4297is no uclass available, you are encouraged to create one. See
4298doc/driver-model.
4299
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301Configuring the Linux kernel:
4302-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304No specific requirements for U-Boot. Make sure you have some root
4305device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004306
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk2729af92004-05-03 20:45:30 +00004308Building a Linux Image:
4309-----------------------
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4312not used. If you use recent kernel source, a new build target
4313"uImage" will exist which automatically builds an image usable by
4314U-Boot. Most older kernels also have support for a "pImage" target,
4315which was introduced for our predecessor project PPCBoot and uses a
4316100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004317
wdenk2729af92004-05-03 20:45:30 +00004318Example:
wdenkc6097192002-11-03 00:24:07 +00004319
Holger Freytherab584d62014-08-04 09:26:05 +02004320 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004321 make oldconfig
4322 make dep
4323 make uImage
wdenkc6097192002-11-03 00:24:07 +00004324
wdenk2729af92004-05-03 20:45:30 +00004325The "uImage" build target uses a special tool (in 'tools/mkimage') to
4326encapsulate a compressed Linux kernel image with header information,
4327CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk2729af92004-05-03 20:45:30 +00004329* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333 ${CROSS_COMPILE}-objcopy -O binary \
4334 -R .note -R .comment \
4335 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004340
wdenk2729af92004-05-03 20:45:30 +00004341* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343 mkimage -A ppc -O linux -T kernel -C gzip \
4344 -a 0 -e 0 -n "Linux Kernel Image" \
4345 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004346
wdenk24ee89b2002-11-03 17:56:27 +00004347
wdenk2729af92004-05-03 20:45:30 +00004348The "mkimage" tool can also be used to create ramdisk images for use
4349with U-Boot, either separated from the Linux kernel image, or
4350combined into one file. "mkimage" encapsulates the images with a 64
4351byte header containing information about target architecture,
4352operating system, image type, compression method, entry points, time
4353stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355"mkimage" can be called in two ways: to verify existing images and
4356print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358In the first form (with "-l" option) mkimage lists the information
4359contained in the header of an existing U-Boot image; this includes
4360checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004361
wdenk2729af92004-05-03 20:45:30 +00004362 tools/mkimage -l image
4363 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365The second form (with "-d" option) is used to build a U-Boot image
4366from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004367
wdenk2729af92004-05-03 20:45:30 +00004368 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4369 -n name -d data_file image
4370 -A ==> set architecture to 'arch'
4371 -O ==> set operating system to 'os'
4372 -T ==> set image type to 'type'
4373 -C ==> set compression type 'comp'
4374 -a ==> set load address to 'addr' (hex)
4375 -e ==> set entry point to 'ep' (hex)
4376 -n ==> set image name to 'name'
4377 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004378
wdenk69459792004-05-29 16:53:29 +00004379Right now, all Linux kernels for PowerPC systems use the same load
4380address (0x00000000), but the entry point address depends on the
4381kernel version:
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383- 2.2.x kernels have the entry point at 0x0000000C,
4384- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4389 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004390 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004391 > examples/uImage.TQM850L
4392 Image Name: 2.4.4 kernel for TQM850L
4393 Created: Wed Jul 19 02:34:59 2000
4394 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4395 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4396 Load Address: 0x00000000
4397 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk2729af92004-05-03 20:45:30 +00004399To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004400
wdenk2729af92004-05-03 20:45:30 +00004401 -> tools/mkimage -l examples/uImage.TQM850L
4402 Image Name: 2.4.4 kernel for TQM850L
4403 Created: Wed Jul 19 02:34:59 2000
4404 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4405 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4406 Load Address: 0x00000000
4407 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004408
wdenk2729af92004-05-03 20:45:30 +00004409NOTE: for embedded systems where boot time is critical you can trade
4410speed for memory and install an UNCOMPRESSED image instead: this
4411needs more space in Flash, but boots much faster since it does not
4412need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004413
Stefan Roesea47a12b2010-04-15 16:07:28 +02004414 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004415 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4416 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004417 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004418 > examples/uImage.TQM850L-uncompressed
4419 Image Name: 2.4.4 kernel for TQM850L
4420 Created: Wed Jul 19 02:34:59 2000
4421 Image Type: PowerPC Linux Kernel Image (uncompressed)
4422 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4423 Load Address: 0x00000000
4424 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004425
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk2729af92004-05-03 20:45:30 +00004427Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4428when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004429
wdenk2729af92004-05-03 20:45:30 +00004430 -> tools/mkimage -n 'Simple Ramdisk Image' \
4431 > -A ppc -O linux -T ramdisk -C gzip \
4432 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4433 Image Name: Simple Ramdisk Image
4434 Created: Wed Jan 12 14:01:50 2000
4435 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4436 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4437 Load Address: 0x00000000
4438 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004439
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004440The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4441option performs the converse operation of the mkimage's second form (the "-d"
4442option). Given an image built by mkimage, the dumpimage extracts a "data file"
4443from the image:
4444
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02004445 tools/dumpimage -i image -T type -p position data_file
4446 -i ==> extract from the 'image' a specific 'data_file'
4447 -T ==> set image type to 'type'
4448 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07004449
wdenkdb01a2e2004-04-15 23:14:49 +00004450
wdenk2729af92004-05-03 20:45:30 +00004451Installing a Linux Image:
4452-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004453
wdenk2729af92004-05-03 20:45:30 +00004454To downloading a U-Boot image over the serial (console) interface,
4455you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004456
wdenk2729af92004-05-03 20:45:30 +00004457 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459The 'objcopy' does not understand the information in the U-Boot
4460image header, so the resulting S-Record file will be relative to
4461address 0x00000000. To load it to a given address, you need to
4462specify the target address as 'offset' parameter with the 'loads'
4463command.
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk2729af92004-05-03 20:45:30 +00004465Example: install the image to address 0x40100000 (which on the
4466TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004469
wdenk2729af92004-05-03 20:45:30 +00004470 .......... done
4471 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk2729af92004-05-03 20:45:30 +00004473 => loads 40100000
4474 ## Ready for S-Record download ...
4475 ~>examples/image.srec
4476 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4477 ...
4478 15989 15990 15991 15992
4479 [file transfer complete]
4480 [connected]
4481 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004482
4483
wdenk2729af92004-05-03 20:45:30 +00004484You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004485this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004486corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004489
wdenk2729af92004-05-03 20:45:30 +00004490 ## Checking Image at 40100000 ...
4491 Image Name: 2.2.13 for initrd on TQM850L
4492 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4493 Data Size: 335725 Bytes = 327 kB = 0 MB
4494 Load Address: 00000000
4495 Entry Point: 0000000c
4496 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004497
4498
wdenk2729af92004-05-03 20:45:30 +00004499Boot Linux:
4500-----------
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk2729af92004-05-03 20:45:30 +00004502The "bootm" command is used to boot an application that is stored in
4503memory (RAM or Flash). In case of a Linux kernel image, the contents
4504of the "bootargs" environment variable is passed to the kernel as
4505parameters. You can check and modify this variable using the
4506"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004507
4508
wdenk2729af92004-05-03 20:45:30 +00004509 => printenv bootargs
4510 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004511
wdenk2729af92004-05-03 20:45:30 +00004512 => 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 +00004513
wdenk2729af92004-05-03 20:45:30 +00004514 => printenv bootargs
4515 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 +00004516
wdenk2729af92004-05-03 20:45:30 +00004517 => bootm 40020000
4518 ## Booting Linux kernel at 40020000 ...
4519 Image Name: 2.2.13 for NFS on TQM850L
4520 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4521 Data Size: 381681 Bytes = 372 kB = 0 MB
4522 Load Address: 00000000
4523 Entry Point: 0000000c
4524 Verifying Checksum ... OK
4525 Uncompressing Kernel Image ... OK
4526 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
4527 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4528 time_init: decrementer frequency = 187500000/60
4529 Calibrating delay loop... 49.77 BogoMIPS
4530 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4531 ...
wdenkc6097192002-11-03 00:24:07 +00004532
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004533If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004534the memory addresses of both the kernel and the initrd image (PPBCOOT
4535format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk2729af92004-05-03 20:45:30 +00004537 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539 ## Checking Image at 40100000 ...
4540 Image Name: 2.2.13 for initrd on TQM850L
4541 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4542 Data Size: 335725 Bytes = 327 kB = 0 MB
4543 Load Address: 00000000
4544 Entry Point: 0000000c
4545 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547 ## Checking Image at 40200000 ...
4548 Image Name: Simple Ramdisk Image
4549 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4550 Data Size: 566530 Bytes = 553 kB = 0 MB
4551 Load Address: 00000000
4552 Entry Point: 00000000
4553 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555 => bootm 40100000 40200000
4556 ## Booting Linux kernel at 40100000 ...
4557 Image Name: 2.2.13 for initrd on TQM850L
4558 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4559 Data Size: 335725 Bytes = 327 kB = 0 MB
4560 Load Address: 00000000
4561 Entry Point: 0000000c
4562 Verifying Checksum ... OK
4563 Uncompressing Kernel Image ... OK
4564 ## Loading RAMDisk Image at 40200000 ...
4565 Image Name: Simple Ramdisk Image
4566 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4567 Data Size: 566530 Bytes = 553 kB = 0 MB
4568 Load Address: 00000000
4569 Entry Point: 00000000
4570 Verifying Checksum ... OK
4571 Loading Ramdisk ... OK
4572 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
4573 Boot arguments: root=/dev/ram
4574 time_init: decrementer frequency = 187500000/60
4575 Calibrating delay loop... 49.77 BogoMIPS
4576 ...
4577 RAMDISK: Compressed image found at block 0
4578 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580 bash#
wdenkc6097192002-11-03 00:24:07 +00004581
Matthew McClintock02677682006-06-28 10:41:37 -05004582Boot Linux and pass a flat device tree:
4583-----------
4584
4585First, U-Boot must be compiled with the appropriate defines. See the section
4586titled "Linux Kernel Interface" above for a more in depth explanation. The
4587following is an example of how to start a kernel and pass an updated
4588flat device tree:
4589
4590=> print oftaddr
4591oftaddr=0x300000
4592=> print oft
4593oft=oftrees/mpc8540ads.dtb
4594=> tftp $oftaddr $oft
4595Speed: 1000, full duplex
4596Using TSEC0 device
4597TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4598Filename 'oftrees/mpc8540ads.dtb'.
4599Load address: 0x300000
4600Loading: #
4601done
4602Bytes transferred = 4106 (100a hex)
4603=> tftp $loadaddr $bootfile
4604Speed: 1000, full duplex
4605Using TSEC0 device
4606TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4607Filename 'uImage'.
4608Load address: 0x200000
4609Loading:############
4610done
4611Bytes transferred = 1029407 (fb51f hex)
4612=> print loadaddr
4613loadaddr=200000
4614=> print oftaddr
4615oftaddr=0x300000
4616=> bootm $loadaddr - $oftaddr
4617## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004618 Image Name: Linux-2.6.17-dirty
4619 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4620 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004621 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004622 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004623 Verifying Checksum ... OK
4624 Uncompressing Kernel Image ... OK
4625Booting using flat device tree at 0x300000
4626Using MPC85xx ADS machine description
4627Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4628[snip]
4629
4630
wdenk2729af92004-05-03 20:45:30 +00004631More About U-Boot Image Types:
4632------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004633
wdenk2729af92004-05-03 20:45:30 +00004634U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636 "Standalone Programs" are directly runnable in the environment
4637 provided by U-Boot; it is expected that (if they behave
4638 well) you can continue to work in U-Boot after return from
4639 the Standalone Program.
4640 "OS Kernel Images" are usually images of some Embedded OS which
4641 will take over control completely. Usually these programs
4642 will install their own set of exception handlers, device
4643 drivers, set up the MMU, etc. - this means, that you cannot
4644 expect to re-enter U-Boot except by resetting the CPU.
4645 "RAMDisk Images" are more or less just data blocks, and their
4646 parameters (address, size) are passed to an OS kernel that is
4647 being started.
4648 "Multi-File Images" contain several images, typically an OS
4649 (Linux) kernel image and one or more data images like
4650 RAMDisks. This construct is useful for instance when you want
4651 to boot over the network using BOOTP etc., where the boot
4652 server provides just a single image file, but you want to get
4653 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004654
wdenk2729af92004-05-03 20:45:30 +00004655 "Multi-File Images" start with a list of image sizes, each
4656 image size (in bytes) specified by an "uint32_t" in network
4657 byte order. This list is terminated by an "(uint32_t)0".
4658 Immediately after the terminating 0 follow the images, one by
4659 one, all aligned on "uint32_t" boundaries (size rounded up to
4660 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004661
wdenk2729af92004-05-03 20:45:30 +00004662 "Firmware Images" are binary images containing firmware (like
4663 U-Boot or FPGA images) which usually will be programmed to
4664 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004665
wdenk2729af92004-05-03 20:45:30 +00004666 "Script files" are command sequences that will be executed by
4667 U-Boot's command interpreter; this feature is especially
4668 useful when you configure U-Boot to use a real shell (hush)
4669 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004670
Marek Vasut44f074c2012-03-14 21:52:45 +00004671Booting the Linux zImage:
4672-------------------------
4673
4674On some platforms, it's possible to boot Linux zImage. This is done
4675using the "bootz" command. The syntax of "bootz" command is the same
4676as the syntax of "bootm" command.
4677
Tom Rini8ac28562013-05-16 11:40:11 -04004678Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00004679kernel with raw initrd images. The syntax is slightly different, the
4680address of the initrd must be augmented by it's size, in the following
4681format: "<initrd addres>:<initrd size>".
4682
wdenkc6097192002-11-03 00:24:07 +00004683
wdenk2729af92004-05-03 20:45:30 +00004684Standalone HOWTO:
4685=================
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk2729af92004-05-03 20:45:30 +00004687One of the features of U-Boot is that you can dynamically load and
4688run "standalone" applications, which can use some resources of
4689U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk2729af92004-05-03 20:45:30 +00004691Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk2729af92004-05-03 20:45:30 +00004693"Hello World" Demo:
4694-------------------
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk2729af92004-05-03 20:45:30 +00004696'examples/hello_world.c' contains a small "Hello World" Demo
4697application; it is automatically compiled when you build U-Boot.
4698It's configured to run at address 0x00040004, so you can play with it
4699like that:
wdenkc6097192002-11-03 00:24:07 +00004700
wdenk2729af92004-05-03 20:45:30 +00004701 => loads
4702 ## Ready for S-Record download ...
4703 ~>examples/hello_world.srec
4704 1 2 3 4 5 6 7 8 9 10 11 ...
4705 [file transfer complete]
4706 [connected]
4707 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk2729af92004-05-03 20:45:30 +00004709 => go 40004 Hello World! This is a test.
4710 ## Starting application at 0x00040004 ...
4711 Hello World
4712 argc = 7
4713 argv[0] = "40004"
4714 argv[1] = "Hello"
4715 argv[2] = "World!"
4716 argv[3] = "This"
4717 argv[4] = "is"
4718 argv[5] = "a"
4719 argv[6] = "test."
4720 argv[7] = "<NULL>"
4721 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004722
wdenk2729af92004-05-03 20:45:30 +00004723 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk2729af92004-05-03 20:45:30 +00004725Another example, which demonstrates how to register a CPM interrupt
4726handler with the U-Boot code, can be found in 'examples/timer.c'.
4727Here, a CPM timer is set up to generate an interrupt every second.
4728The interrupt service routine is trivial, just printing a '.'
4729character, but this is just a demo program. The application can be
4730controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732 ? - print current values og the CPM Timer registers
4733 b - enable interrupts and start timer
4734 e - stop timer and disable interrupts
4735 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004736
wdenk2729af92004-05-03 20:45:30 +00004737 => loads
4738 ## Ready for S-Record download ...
4739 ~>examples/timer.srec
4740 1 2 3 4 5 6 7 8 9 10 11 ...
4741 [file transfer complete]
4742 [connected]
4743 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk2729af92004-05-03 20:45:30 +00004745 => go 40004
4746 ## Starting application at 0x00040004 ...
4747 TIMERS=0xfff00980
4748 Using timer 1
4749 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751Hit 'b':
4752 [q, b, e, ?] Set interval 1000000 us
4753 Enabling timer
4754Hit '?':
4755 [q, b, e, ?] ........
4756 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4757Hit '?':
4758 [q, b, e, ?] .
4759 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4760Hit '?':
4761 [q, b, e, ?] .
4762 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4763Hit '?':
4764 [q, b, e, ?] .
4765 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4766Hit 'e':
4767 [q, b, e, ?] ...Stopping timer
4768Hit 'q':
4769 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004770
4771
wdenk2729af92004-05-03 20:45:30 +00004772Minicom warning:
4773================
wdenk85ec0bc2003-03-31 16:34:49 +00004774
wdenk2729af92004-05-03 20:45:30 +00004775Over time, many people have reported problems when trying to use the
4776"minicom" terminal emulation program for serial download. I (wd)
4777consider minicom to be broken, and recommend not to use it. Under
4778Unix, I recommend to use C-Kermit for general purpose use (and
4779especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004780use "cu" for S-Record download ("loads" command). See
4781http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4782for help with kermit.
4783
wdenk85ec0bc2003-03-31 16:34:49 +00004784
wdenk2729af92004-05-03 20:45:30 +00004785Nevertheless, if you absolutely want to use it try adding this
4786configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004787
wdenk2729af92004-05-03 20:45:30 +00004788 Name Program Name U/D FullScr IO-Red. Multi
4789 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4790 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004791
4792
wdenk2729af92004-05-03 20:45:30 +00004793NetBSD Notes:
4794=============
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk2729af92004-05-03 20:45:30 +00004796Starting at version 0.9.2, U-Boot supports NetBSD both as host
4797(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004798
wdenk2729af92004-05-03 20:45:30 +00004799Building requires a cross environment; it is known to work on
4800NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4801need gmake since the Makefiles are not compatible with BSD make).
4802Note that the cross-powerpc package does not install include files;
4803attempting to build U-Boot will fail because <machine/ansi.h> is
4804missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk2729af92004-05-03 20:45:30 +00004806 # cd /usr/pkg/cross/powerpc-netbsd/include
4807 # mkdir powerpc
4808 # ln -s powerpc machine
4809 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4810 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk2729af92004-05-03 20:45:30 +00004812Native builds *don't* work due to incompatibilities between native
4813and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk2729af92004-05-03 20:45:30 +00004815Booting assumes that (the first part of) the image booted is a
4816stage-2 loader which in turn loads and then invokes the kernel
4817proper. Loader sources will eventually appear in the NetBSD source
4818tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004819meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004820
4821
wdenk2729af92004-05-03 20:45:30 +00004822Implementation Internals:
4823=========================
wdenkc6097192002-11-03 00:24:07 +00004824
wdenk2729af92004-05-03 20:45:30 +00004825The following is not intended to be a complete description of every
4826implementation detail. However, it should help to understand the
4827inner workings of U-Boot and make it easier to port it to custom
4828hardware.
wdenkc6097192002-11-03 00:24:07 +00004829
4830
wdenk2729af92004-05-03 20:45:30 +00004831Initial Stack, Global Data:
4832---------------------------
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834The implementation of U-Boot is complicated by the fact that U-Boot
4835starts running out of ROM (flash memory), usually without access to
4836system RAM (because the memory controller is not initialized yet).
4837This means that we don't have writable Data or BSS segments, and BSS
4838is not initialized as zero. To be able to get a C environment working
4839at all, we have to allocate at least a minimal stack. Implementation
4840options for this are defined and restricted by the CPU used: Some CPU
4841models provide on-chip memory (like the IMMR area on MPC8xx and
4842MPC826x processors), on others (parts of) the data cache can be
4843locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004844
Wolfgang Denk218ca722008-03-26 10:40:12 +01004845 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004846 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4849 From: "Chris Hallinan" <clh@net1plus.com>
4850 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4851 ...
wdenk43d96162003-03-06 00:02:04 +00004852
wdenk2729af92004-05-03 20:45:30 +00004853 Correct me if I'm wrong, folks, but the way I understand it
4854 is this: Using DCACHE as initial RAM for Stack, etc, does not
4855 require any physical RAM backing up the cache. The cleverness
4856 is that the cache is being used as a temporary supply of
4857 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004858 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004859 can see how this works by studying the cache architecture and
4860 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4863 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004864 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004865 option should work for you. Using CS 4 should be fine if your
4866 board designers haven't used it for something that would
4867 cause you grief during the initial boot! It is frequently not
4868 used.
wdenk43d96162003-03-06 00:02:04 +00004869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004870 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004871 with your processor/board/system design. The default value
4872 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004873 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004874 than your SDRAM module. If you have a 64MB SDRAM module, set
4875 it above 400_0000. Just make sure your board has no resources
4876 that are supposed to respond to that address! That code in
4877 start.S has been around a while and should work as is when
4878 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004879
wdenk2729af92004-05-03 20:45:30 +00004880 -Chris Hallinan
4881 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004882
wdenk2729af92004-05-03 20:45:30 +00004883It is essential to remember this, since it has some impact on the C
4884code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk2729af92004-05-03 20:45:30 +00004886* Initialized global data (data segment) is read-only. Do not attempt
4887 to write it.
wdenkc6097192002-11-03 00:24:07 +00004888
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004889* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00004890 as zero data - BSS segment) at all - this is undefined, initiali-
4891 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893* Stack space is very limited. Avoid big data buffers or things like
4894 that.
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk2729af92004-05-03 20:45:30 +00004896Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004897normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00004898turned out that the implementation of U-Boot can be greatly
4899simplified by making a global data structure (gd_t) available to all
4900functions. We could pass a pointer to this data as argument to _all_
4901functions, but this would bloat the code. Instead we use a feature of
4902the GCC compiler (Global Register Variables) to share the data: we
4903place a pointer (gd) to the global data into a register which we
4904reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906When choosing a register for such a purpose we are restricted by the
4907relevant (E)ABI specifications for the current architecture, and by
4908GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk2729af92004-05-03 20:45:30 +00004910For PowerPC, the following registers have specific use:
4911 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004912 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004913 R3-R4: parameter passing and return values
4914 R5-R10: parameter passing
4915 R13: small data area pointer
4916 R30: GOT pointer
4917 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004918
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004919 (U-Boot also uses R12 as internal GOT pointer. r12
4920 is a volatile register so r12 needs to be reset when
4921 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004922
Wolfgang Denke7670f62008-02-14 22:43:22 +01004923 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk2729af92004-05-03 20:45:30 +00004925 Note: on PPC, we could use a static initializer (since the
4926 address of the global data structure is known at compile time),
4927 but it turned out that reserving a register results in somewhat
4928 smaller code - although the code savings are not that big (on
4929 average for all boards 752 bytes for the whole U-Boot image,
4930 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004931
wdenk2729af92004-05-03 20:45:30 +00004932On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934 R0: function argument word/integer result
4935 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004936 R9: platform specific
4937 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00004938 R11: argument (frame) pointer
4939 R12: temporary workspace
4940 R13: stack pointer
4941 R14: link register
4942 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004943
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02004944 ==> U-Boot will use R9 to hold a pointer to the global data
4945
4946 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00004947
Thomas Chou0df01fd2010-05-21 11:08:03 +08004948On Nios II, the ABI is documented here:
4949 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4950
4951 ==> U-Boot will use gp to hold a pointer to the global data
4952
4953 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4954 to access small data sections, so gp is free.
4955
Macpaul Linafc1ce82011-10-19 20:41:11 +00004956On NDS32, the following registers are used:
4957
4958 R0-R1: argument/return
4959 R2-R5: argument
4960 R15: temporary register for assembler
4961 R16: trampoline register
4962 R28: frame pointer (FP)
4963 R29: global pointer (GP)
4964 R30: link register (LP)
4965 R31: stack pointer (SP)
4966 PC: program counter (PC)
4967
4968 ==> U-Boot will use R10 to hold a pointer to the global data
4969
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004970NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4971or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004972
Rick Chen3fafced2017-12-26 13:55:59 +08004973On RISC-V, the following registers are used:
4974
4975 x0: hard-wired zero (zero)
4976 x1: return address (ra)
4977 x2: stack pointer (sp)
4978 x3: global pointer (gp)
4979 x4: thread pointer (tp)
4980 x5: link register (t0)
4981 x8: frame pointer (fp)
4982 x10-x11: arguments/return values (a0-1)
4983 x12-x17: arguments (a2-7)
4984 x28-31: temporaries (t3-6)
4985 pc: program counter (pc)
4986
4987 ==> U-Boot will use gp to hold a pointer to the global data
4988
wdenk2729af92004-05-03 20:45:30 +00004989Memory Management:
4990------------------
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992U-Boot runs in system state and uses physical addresses, i.e. the
4993MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk2729af92004-05-03 20:45:30 +00004995The available memory is mapped to fixed addresses using the memory
4996controller. In this process, a contiguous block is formed for each
4997memory type (Flash, SDRAM, SRAM), even when it consists of several
4998physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004999
wdenk2729af92004-05-03 20:45:30 +00005000U-Boot is installed in the first 128 kB of the first Flash bank (on
5001TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5002booting and sizing and initializing DRAM, the code relocates itself
5003to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005004memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005005configuration setting]. Below that, a structure with global Board
5006Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008Additionally, some exception handler code is copied to the low 8 kB
5009of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011So a typical memory configuration with 16 MB of DRAM could look like
5012this:
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk2729af92004-05-03 20:45:30 +00005014 0x0000 0000 Exception Vector code
5015 :
5016 0x0000 1FFF
5017 0x0000 2000 Free for Application Use
5018 :
5019 :
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk2729af92004-05-03 20:45:30 +00005021 :
5022 :
5023 0x00FB FF20 Monitor Stack (Growing downward)
5024 0x00FB FFAC Board Info Data and permanent copy of global data
5025 0x00FC 0000 Malloc Arena
5026 :
5027 0x00FD FFFF
5028 0x00FE 0000 RAM Copy of Monitor Code
5029 ... eventually: LCD or video framebuffer
5030 ... eventually: pRAM (Protected RAM - unchanged by reset)
5031 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005032
5033
wdenk2729af92004-05-03 20:45:30 +00005034System Initialization:
5035----------------------
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk2729af92004-05-03 20:45:30 +00005037In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005038(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005039configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00005040To be able to re-map memory U-Boot then jumps to its link address.
5041To be able to implement the initialization code in C, a (small!)
5042initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02005043which provide such a feature like), or in a locked part of the data
5044cache. After that, U-Boot initializes the CPU core, the caches and
5045the SIU.
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047Next, all (potentially) available memory banks are mapped using a
5048preliminary mapping. For example, we put them on 512 MB boundaries
5049(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5050on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5051programmed for SDRAM access. Using the temporary configuration, a
5052simple memory test is run that determines the size of the SDRAM
5053banks.
wdenkc6097192002-11-03 00:24:07 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055When there is more than one SDRAM bank, and the banks are of
5056different size, the largest is mapped first. For equal size, the first
5057bank (CS2#) is mapped first. The first mapping is always for address
50580x00000000, with any additional banks following immediately to create
5059contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061Then, the monitor installs itself at the upper end of the SDRAM area
5062and allocates memory for use by malloc() and for the global Board
5063Info data; also, the exception vector code is copied to the low RAM
5064pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk2729af92004-05-03 20:45:30 +00005066Only after this relocation will you have a "normal" C environment;
5067until that you are restricted in several ways, mostly because you are
5068running from ROM, and because the code will have to be relocated to a
5069new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005070
5071
wdenk2729af92004-05-03 20:45:30 +00005072U-Boot Porting Guide:
5073----------------------
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk2729af92004-05-03 20:45:30 +00005075[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5076list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005077
5078
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005079int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005080{
5081 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005082
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005083 signal(SIGALRM, no_more_time);
5084 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005085
wdenk2729af92004-05-03 20:45:30 +00005086 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005087 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005088 return 0;
5089 }
5090
wdenk2729af92004-05-03 20:45:30 +00005091 Download latest U-Boot source;
5092
Wolfgang Denk06682362008-12-30 22:56:11 +01005093 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005094
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005095 if (clueless)
5096 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098 while (learning) {
5099 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005100 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5101 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005102 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005103 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005104 }
wdenkc6097192002-11-03 00:24:07 +00005105
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005106 if (available_money > toLocalCurrency ($2500))
5107 Buy a BDI3000;
5108 else
wdenk2729af92004-05-03 20:45:30 +00005109 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005110
5111 if (a similar board exists) { /* hopefully... */
5112 cp -a board/<similar> board/<myboard>
5113 cp include/configs/<similar>.h include/configs/<myboard>.h
5114 } else {
5115 Create your own board support subdirectory;
5116 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005117 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005118 Edit new board/<myboard> files
5119 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005120
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005121 while (!accepted) {
5122 while (!running) {
5123 do {
5124 Add / modify source code;
5125 } until (compiles);
5126 Debug;
5127 if (clueless)
5128 email("Hi, I am having problems...");
5129 }
5130 Send patch file to the U-Boot email list;
5131 if (reasonable critiques)
5132 Incorporate improvements from email list code review;
5133 else
5134 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005135 }
wdenkc6097192002-11-03 00:24:07 +00005136
wdenk2729af92004-05-03 20:45:30 +00005137 return 0;
5138}
5139
5140void no_more_time (int sig)
5141{
5142 hire_a_guru();
5143}
wdenkc6097192002-11-03 00:24:07 +00005144
5145
wdenk2729af92004-05-03 20:45:30 +00005146Coding Standards:
5147-----------------
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02005150coding style; see the kernel coding style guide at
5151https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
5152script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005153
Detlev Zundel2c051652006-09-01 15:39:02 +02005154Source files originating from a different project (for example the
5155MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005156reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02005157sources.
5158
5159Please note that U-Boot is implemented in C (and to some small parts in
5160Assembler); no C++ is used, so please do not use C++ style comments (//)
5161in your code.
wdenk2729af92004-05-03 20:45:30 +00005162
5163Please also stick to the following formatting rules:
5164- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005165- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005166- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005167- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005168- do not add trailing empty lines to source files
5169
5170Submissions which do not conform to the standards may be returned
5171with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005172
5173
wdenk2729af92004-05-03 20:45:30 +00005174Submitting Patches:
5175-------------------
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177Since the number of patches for U-Boot is growing, we need to
5178establish some rules. Submissions which do not conform to these rules
5179may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005180
Magnus Lilja0d28f342008-08-06 19:32:33 +02005181Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005182
Wolfgang Denk06682362008-12-30 22:56:11 +01005183Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08005184see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01005185
wdenk2729af92004-05-03 20:45:30 +00005186When you send a patch, please include the following information with
5187it:
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk2729af92004-05-03 20:45:30 +00005189* For bug fixes: a description of the bug and how your patch fixes
5190 this bug. Please try to include a way of demonstrating that the
5191 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk2729af92004-05-03 20:45:30 +00005193* For new features: a description of the feature and your
5194 implementation.
wdenkc6097192002-11-03 00:24:07 +00005195
wdenk2729af92004-05-03 20:45:30 +00005196* A CHANGELOG entry as plaintext (separate from the patch)
5197
Robert P. J. Day7207b362015-12-19 07:16:10 -05005198* For major contributions, add a MAINTAINERS file with your
5199 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00005200
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005201* When you add support for a new board, don't forget to add a
5202 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005203
5204* If your patch adds new configuration options, don't forget to
5205 document these in the README file.
5206
Wolfgang Denk218ca722008-03-26 10:40:12 +01005207* The patch itself. If you are using git (which is *strongly*
5208 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005209 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005210 the U-Boot mailing list, you will avoid most of the common problems
5211 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005212
Wolfgang Denk218ca722008-03-26 10:40:12 +01005213 If you cannot use git, use "diff -purN OLD NEW". If your version of
5214 diff does not support these options, then get the latest version of
5215 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005216
Wolfgang Denk218ca722008-03-26 10:40:12 +01005217 The current directory when running this command shall be the parent
5218 directory of the U-Boot source tree (i. e. please make sure that
5219 your patch includes sufficient directory information for the
5220 affected files).
5221
5222 We prefer patches as plain text. MIME attachments are discouraged,
5223 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005224
5225* If one logical set of modifications affects or creates several
5226 files, all these changes shall be submitted in a SINGLE patch file.
5227
5228* Changesets that contain different, unrelated modifications shall be
5229 submitted as SEPARATE patches, one patch per changeset.
5230
5231
5232Notes:
5233
Simon Glass6de80f22016-07-27 20:33:08 -06005234* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00005235 source tree and make sure that no errors or warnings are reported
5236 for any of the boards.
5237
5238* Keep your modifications to the necessary minimum: A patch
5239 containing several unrelated changes or arbitrary reformats will be
5240 returned with a request to re-formatting / split it.
5241
5242* If you modify existing code, make sure that your new code does not
5243 add to the memory footprint of the code ;-) Small is beautiful!
5244 When adding new features, these should compile conditionally only
5245 (using #ifdef), and the resulting code with the new feature
5246 disabled must not need more memory than the old code without your
5247 modification.
wdenk90dc6702005-05-03 14:12:25 +00005248
Wolfgang Denk06682362008-12-30 22:56:11 +01005249* Remember that there is a size limit of 100 kB per message on the
5250 u-boot mailing list. Bigger patches will be moderated. If they are
5251 reasonable and not too big, they will be acknowledged. But patches
5252 bigger than the size limit should be avoided.