blob: 256d6ecc65a09c008bdd8a431fbec1aea37e7ac5 [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
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
255configurations available; just type "make <board_name>_config".
256
257Example: For a TQM823L module type:
258
259 cd u-boot
260 make TQM823L_config
261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000263e.g. "make cogent_mpc8xx_config". And also configure the cogent
264directory according to the instructions in cogent/README.
265
266
Simon Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
275See board/sandbox/sandbox/README.sandbox for more details.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk7f6c2cb2002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Gala66412c62011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala8f290842011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood33eee332012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood33eee332012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jain64501c62013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jain64501c62013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jainb1359912013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantianaade2002014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sun5614e712013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun34e026f2014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun9ac4ffb2013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sun5614e712013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700505
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun4e5b1bd2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun6b9e3092014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sun6b1e1252014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100541- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200542 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100543
544 Defines the Monahans run mode to oscillator
545 ratio. Valid values are 8, 16, 24, 31. The core
546 frequency is this value multiplied by 13 MHz.
547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200548 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200549
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100550 Defines the Monahans turbo mode to oscillator
551 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200552 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200554
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Rieschb67d8812012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
Aneesh V5356f542012-03-08 07:20:19 +0000593 CONFIG_SYS_THUMB_BUILD
594
595 Use this flag to build U-Boot using the Thumb instruction
596 set for ARM architectures. Thumb instruction set provides
597 better code density. For ARM architectures that support
598 Thumb2 this flag will result in Thumb2 code generated by
599 GCC.
600
Stephen Warrenc5d47522013-03-04 13:29:40 +0000601 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000602 CONFIG_ARM_ERRATA_742230
603 CONFIG_ARM_ERRATA_743622
604 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500605 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500606 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000607
608 If set, the workarounds for these ARM errata are applied early
609 during U-Boot startup. Note that these options force the
610 workarounds to be applied; no CPU-type/version detection
611 exists, unlike the similar options in the Linux kernel. Do not
612 set these options unless they apply!
613
Stephen Warren795659d2013-03-27 17:06:41 +0000614- CPU timer options:
615 CONFIG_SYS_HZ
616
617 The frequency of the timer returned by get_timer().
618 get_timer() must operate in milliseconds and this CONFIG
619 option must be set to 1000.
620
wdenk5da627a2003-10-09 20:09:04 +0000621- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000622 CONFIG_CLOCKS_IN_MHZ
623
624 U-Boot stores all clock information in Hz
625 internally. For binary compatibility with older Linux
626 kernels (which expect the clocks passed in the
627 bd_info data to be in MHz) the environment variable
628 "clocks_in_mhz" can be defined so that U-Boot
629 converts clock data to MHZ before passing it to the
630 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000631 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100632 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000633 default environment.
634
wdenk5da627a2003-10-09 20:09:04 +0000635 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
636
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200637 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000638 expect it to be in bytes, others in MB.
639 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
640
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400641 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200642
643 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400644 passed using flattened device trees (based on open firmware
645 concepts).
646
647 CONFIG_OF_LIBFDT
648 * New libfdt-based support
649 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500650 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400651
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200652 OF_CPU - The proper name of the cpus node (only required for
653 MPC512X and MPC5xxx based boards).
654 OF_SOC - The proper name of the soc node (only required for
655 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200656 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600657 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200658
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200659 boards with QUICC Engines require OF_QE to set UCC MAC
660 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500661
Kumar Gala4e253132006-01-11 13:54:17 -0600662 CONFIG_OF_BOARD_SETUP
663
664 Board code has addition modification that it wants to make
665 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000666
Matthew McClintock02677682006-06-28 10:41:37 -0500667 CONFIG_OF_BOOT_CPU
668
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200669 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500670 param header, the default value is zero if undefined.
671
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200672 CONFIG_OF_IDE_FIXUP
673
674 U-Boot can detect if an IDE device is present or not.
675 If not, and this new config option is activated, U-Boot
676 removes the ATA node from the DTS before booting Linux,
677 so the Linux IDE driver does not probe the device and
678 crash. This is needed for buggy hardware (uc101) where
679 no pull down resistor is connected to the signal IDE5V_DD7.
680
Igor Grinberg7eb29392011-07-14 05:45:07 +0000681 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
682
683 This setting is mandatory for all boards that have only one
684 machine type and must be used to specify the machine type
685 number as it appears in the ARM machine registry
686 (see http://www.arm.linux.org.uk/developer/machines/).
687 Only boards that have multiple machine types supported
688 in a single configuration file and the machine type is
689 runtime discoverable, do not have to use this setting.
690
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100691- vxWorks boot parameters:
692
693 bootvx constructs a valid bootline using the following
694 environments variables: bootfile, ipaddr, serverip, hostname.
695 It loads the vxWorks image pointed bootfile.
696
697 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
698 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
699 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
700 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
701
702 CONFIG_SYS_VXWORKS_ADD_PARAMS
703
704 Add it at the end of the bootline. E.g "u=username pw=secret"
705
706 Note: If a "bootargs" environment is defined, it will overwride
707 the defaults discussed just above.
708
Aneesh V2c451f72011-06-16 23:30:47 +0000709- Cache Configuration:
710 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
711 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
712 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
713
Aneesh V93bc2192011-06-16 23:30:51 +0000714- Cache Configuration for ARM:
715 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
716 controller
717 CONFIG_SYS_PL310_BASE - Physical base address of PL310
718 controller register space
719
wdenk6705d812004-08-02 23:22:59 +0000720- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200721 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000722
723 Define this if you want support for Amba PrimeCell PL010 UARTs.
724
Andreas Engel48d01922008-09-08 14:30:53 +0200725 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000726
727 Define this if you want support for Amba PrimeCell PL011 UARTs.
728
729 CONFIG_PL011_CLOCK
730
731 If you have Amba PrimeCell PL011 UARTs, set this variable to
732 the clock speed of the UARTs.
733
734 CONFIG_PL01x_PORTS
735
736 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
737 define this to a list of base addresses for each (supported)
738 port. See e.g. include/configs/versatile.h
739
John Rigby910f1ae2011-04-19 10:42:39 +0000740 CONFIG_PL011_SERIAL_RLCR
741
742 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743 have separate receive and transmit line control registers. Set
744 this variable to initialize the extra register.
745
746 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747
748 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749 boot loader that has already initialized the UART. Define this
750 variable to flush the UART at init time.
751
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400752 CONFIG_SERIAL_HW_FLOW_CONTROL
753
754 Define this variable to enable hw flow control in serial driver.
755 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000756
wdenkc6097192002-11-03 00:24:07 +0000757- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000758 Depending on board, define exactly one serial port
759 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000762
763 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764 port routines must be defined elsewhere
765 (i.e. serial_init(), serial_getc(), ...)
766
767 CONFIG_CFB_CONSOLE
768 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000769 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000770 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
771 (default big endian)
772 VIDEO_HW_RECTFILL graphic chip supports
773 rectangle fill
774 (cf. smiLynxEM)
775 VIDEO_HW_BITBLT graphic chip supports
776 bit-blit (cf. smiLynxEM)
777 VIDEO_VISIBLE_COLS visible pixel columns
778 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000779 VIDEO_VISIBLE_ROWS visible pixel rows
780 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_DATA_FORMAT graphic data format
782 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000783 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000784 VIDEO_KBD_INIT_FCT keyboard int fct
785 (i.e. i8042_kbd_init())
786 VIDEO_TSTC_FCT test char fct
787 (i.e. i8042_tstc)
788 VIDEO_GETC_FCT get char fct
789 (i.e. i8042_getc)
790 CONFIG_CONSOLE_CURSOR cursor drawing on/off
791 (requires blink timer
792 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000794 CONFIG_CONSOLE_TIME display time/date info in
795 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500796 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000797 CONFIG_VIDEO_LOGO display Linux logo in
798 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000799 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
800 linux_logo.h for logo.
801 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200803 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000804 the logo
805
Pali Rohár33a35bb2012-10-19 13:30:09 +0000806 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
807 a limited number of ANSI escape sequences (cursor control,
808 erase functions and limited graphics rendition control).
809
wdenk43d96162003-03-06 00:02:04 +0000810 When CONFIG_CFB_CONSOLE is defined, video console is
811 default i/o. Serial console can be forced with
812 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000813
wdenkd4ca31c2004-01-02 14:00:00 +0000814 When CONFIG_SILENT_CONSOLE is defined, all console
815 messages (by U-Boot and Linux!) can be silenced with
816 the "silent" environment variable. See
817 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000818
Heiko Schocher45ae2542013-10-22 11:06:06 +0200819 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
820 is 0x00.
821 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
822 is 0xa0.
823
wdenkc6097192002-11-03 00:24:07 +0000824- Console Baudrate:
825 CONFIG_BAUDRATE - in bps
826 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200827 CONFIG_SYS_BAUDRATE_TABLE, see below.
828 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000829
Heiko Schocherc92fac92009-01-30 12:55:38 +0100830- Console Rx buffer length
831 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100833 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100834 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835 must be defined, to setup the maximum idle timeout for
836 the SMC.
837
Graeme Russ9558b482011-09-01 00:48:27 +0000838- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200839 Prior to the console being initialised (i.e. serial UART
840 initialised etc) all console output is silently discarded.
841 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
842 buffer any console messages prior to the console being
843 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
844 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
845 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200846 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200847 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000848
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200849 'Sane' compilers will generate smaller code if
850 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000851
Sonny Rao046a37b2011-11-02 09:52:08 +0000852- Safe printf() functions
853 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854 the printf() functions. These are defined in
855 include/vsprintf.h and include snprintf(), vsnprintf() and
856 so on. Code size increase is approximately 300-500 bytes.
857 If this option is not given then these functions will
858 silently discard their buffer size argument - this means
859 you are not getting any overflow checking in this case.
860
wdenkc6097192002-11-03 00:24:07 +0000861- Boot Delay: CONFIG_BOOTDELAY - in seconds
862 Delay before automatically booting the default image;
863 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000864 set to -2 to autoboot with no delay and not check for abort
865 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000866
867 See doc/README.autoboot for these options that
868 work with CONFIG_BOOTDELAY. None are required.
869 CONFIG_BOOT_RETRY_TIME
870 CONFIG_BOOT_RETRY_MIN
871 CONFIG_AUTOBOOT_KEYED
872 CONFIG_AUTOBOOT_PROMPT
873 CONFIG_AUTOBOOT_DELAY_STR
874 CONFIG_AUTOBOOT_STOP_STR
875 CONFIG_AUTOBOOT_DELAY_STR2
876 CONFIG_AUTOBOOT_STOP_STR2
877 CONFIG_ZERO_BOOTDELAY_CHECK
878 CONFIG_RESET_TO_RETRY
879
880- Autoboot Command:
881 CONFIG_BOOTCOMMAND
882 Only needed when CONFIG_BOOTDELAY is enabled;
883 define a command string that is automatically executed
884 when no character is read on the console interface
885 within "Boot Delay" after reset.
886
887 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000888 This can be used to pass arguments to the bootm
889 command. The value of CONFIG_BOOTARGS goes into the
890 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000891
892 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000893 The value of these goes into the environment as
894 "ramboot" and "nfsboot" respectively, and can be used
895 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200896 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000897
Heiko Schochereda0ba32013-11-04 14:04:59 +0100898- Bootcount:
899 CONFIG_BOOTCOUNT_LIMIT
900 Implements a mechanism for detecting a repeating reboot
901 cycle, see:
902 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903
904 CONFIG_BOOTCOUNT_ENV
905 If no softreset save registers are found on the hardware
906 "bootcount" is stored in the environment. To prevent a
907 saveenv on all reboots, the environment variable
908 "upgrade_available" is used. If "upgrade_available" is
909 0, "bootcount" is always 0, if "upgrade_available" is
910 1 "bootcount" is incremented in the environment.
911 So the Userspace Applikation must set the "upgrade_available"
912 and "bootcount" variable to 0, if a boot was successfully.
913
wdenkc6097192002-11-03 00:24:07 +0000914- Pre-Boot Commands:
915 CONFIG_PREBOOT
916
917 When this option is #defined, the existence of the
918 environment variable "preboot" will be checked
919 immediately before starting the CONFIG_BOOTDELAY
920 countdown and/or running the auto-boot command resp.
921 entering interactive mode.
922
923 This feature is especially useful when "preboot" is
924 automatically generated or modified. For an example
925 see the LWMON board specific code: here "preboot" is
926 modified when the user holds down a certain
927 combination of keys on the (special) keyboard when
928 booting the systems
929
930- Serial Download Echo Mode:
931 CONFIG_LOADS_ECHO
932 If defined to 1, all characters received during a
933 serial download (using the "loads" command) are
934 echoed back. This might be needed by some terminal
935 emulations (like "cu"), but may as well just take
936 time on others. This setting #define's the initial
937 value of the "loads_echo" environment variable.
938
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500939- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000940 CONFIG_KGDB_BAUDRATE
941 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000943
944- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 Monitor commands can be included or excluded
946 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000947 <config_cmd_all.h> and #undef'ing unwanted
948 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500949 and augmenting with additional #define's
950 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000951
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952 The default command configuration includes all commands
953 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000954
Marek Vasutb401b732014-03-05 19:58:39 +0100955 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500956 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500957 CONFIG_CMD_BDI bdinfo
958 CONFIG_CMD_BEDBUG * Include BedBug Debugger
959 CONFIG_CMD_BMP * BMP support
960 CONFIG_CMD_BSP * Board specific commands
961 CONFIG_CMD_BOOTD bootd
962 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800963 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500964 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500965 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500966 CONFIG_CMD_DATE * support for RTC, date/time...
967 CONFIG_CMD_DHCP * DHCP support
968 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600969 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
970 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
971 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
972 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500973 CONFIG_CMD_DTT * Digital Therm and Thermostat
974 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500975 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500976 CONFIG_CMD_EEPROM * EEPROM read/write support
977 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600978 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600979 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500980 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500981 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000982 CONFIG_CMD_EXT2 * ext2 command support
983 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700984 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
985 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500986 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500987 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000988 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 CONFIG_CMD_FLASH flinfo, erase, protect
990 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200991 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000992 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500993 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000994 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000995 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
997 CONFIG_CMD_I2C * I2C serial bus support
998 CONFIG_CMD_IDE * IDE harddisk support
999 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001000 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001001 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001003 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001004 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001005 CONFIG_CMD_IRQ * irqinfo
1006 CONFIG_CMD_ITEST Integer/string test of 2 values
1007 CONFIG_CMD_JFFS2 * JFFS2 Support
1008 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001009 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001010 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1011 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001012 CONFIG_CMD_LOADB loadb
1013 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001014 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001015 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001016 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001017 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001018 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001019 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001020 CONFIG_CMD_MISC Misc functions like sleep etc
1021 CONFIG_CMD_MMC * MMC memory mapped support
1022 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001023 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001024 CONFIG_CMD_NAND * NAND support
1025 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001026 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001027 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001028 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001029 CONFIG_CMD_PCI * pciinfo
1030 CONFIG_CMD_PCMCIA * PCMCIA support
1031 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1032 host
1033 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001034 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001035 CONFIG_CMD_REGINFO * Register dump
1036 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001037 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001038 CONFIG_CMD_SAVES * save S record dump
1039 CONFIG_CMD_SCSI * SCSI Support
1040 CONFIG_CMD_SDRAM * print SDRAM configuration information
1041 (requires CONFIG_CMD_I2C)
1042 CONFIG_CMD_SETGETDCR Support for DCR Register access
1043 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001044 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001045 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001046 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001047 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001048 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001049 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001050 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001051 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001052 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1053 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001054 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001055 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001056 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001057 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001058 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001059
1060 EXAMPLE: If you want all functions except of network
1061 support you can write:
1062
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001063 #include "config_cmd_all.h"
1064 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001065
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001066 Other Commands:
1067 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001068
1069 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001070 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001071 what you (and your U-Boot users) are doing. Data
1072 cache cannot be enabled on systems like the 8xx or
1073 8260 (where accesses to the IMMR region must be
1074 uncached), and it cannot be disabled on all other
1075 systems where we (mis-) use the data cache to hold an
1076 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001077
1078
1079 XXX - this list needs to get updated!
1080
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001081- Regular expression support:
1082 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001083 If this variable is defined, U-Boot is linked against
1084 the SLRE (Super Light Regular Expression) library,
1085 which adds regex support to some commands, as for
1086 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001087
Simon Glass45ba8072011-10-15 05:48:20 +00001088- Device tree:
1089 CONFIG_OF_CONTROL
1090 If this variable is defined, U-Boot will use a device tree
1091 to configure its devices, instead of relying on statically
1092 compiled #defines in the board file. This option is
1093 experimental and only available on a few boards. The device
1094 tree is available in the global data as gd->fdt_blob.
1095
Simon Glass2c0f79e2011-10-24 19:15:31 +00001096 U-Boot needs to get its device tree from somewhere. This can
1097 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001098
1099 CONFIG_OF_EMBED
1100 If this variable is defined, U-Boot will embed a device tree
1101 binary in its image. This device tree file should be in the
1102 board directory and called <soc>-<board>.dts. The binary file
1103 is then picked up in board_init_f() and made available through
1104 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001105
Simon Glass2c0f79e2011-10-24 19:15:31 +00001106 CONFIG_OF_SEPARATE
1107 If this variable is defined, U-Boot will build a device tree
1108 binary. It will be called u-boot.dtb. Architecture-specific
1109 code will locate it at run-time. Generally this works by:
1110
1111 cat u-boot.bin u-boot.dtb >image.bin
1112
1113 and in fact, U-Boot does this for you, creating a file called
1114 u-boot-dtb.bin which is useful in the common case. You can
1115 still use the individual files if you need something more
1116 exotic.
1117
wdenkc6097192002-11-03 00:24:07 +00001118- Watchdog:
1119 CONFIG_WATCHDOG
1120 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001121 support for the SoC. There must be support in the SoC
1122 specific code for a watchdog. For the 8xx and 8260
1123 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1124 register. When supported for a specific SoC is
1125 available, then no further board specific code should
1126 be needed to use it.
1127
1128 CONFIG_HW_WATCHDOG
1129 When using a watchdog circuitry external to the used
1130 SoC, then define this variable and provide board
1131 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001132
stroesec1551ea2003-04-04 15:53:41 +00001133- U-Boot Version:
1134 CONFIG_VERSION_VARIABLE
1135 If this variable is defined, an environment variable
1136 named "ver" is created by U-Boot showing the U-Boot
1137 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001138 Any change to this variable will be reverted at the
1139 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001140
wdenkc6097192002-11-03 00:24:07 +00001141- Real-Time Clock:
1142
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001143 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001144 has to be selected, too. Define exactly one of the
1145 following options:
1146
1147 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1148 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001149 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001150 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001151 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001152 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001153 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001154 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001155 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001156 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001157 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001158 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1159 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001160
wdenkb37c7e52003-06-30 16:24:52 +00001161 Note that if the RTC uses I2C, then the I2C interface
1162 must also be configured. See I2C Support, below.
1163
Peter Tysere92739d2008-12-17 16:36:21 -06001164- GPIO Support:
1165 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001166
Chris Packham5dec49c2010-12-19 10:12:13 +00001167 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1168 chip-ngpio pairs that tell the PCA953X driver the number of
1169 pins supported by a particular chip.
1170
Peter Tysere92739d2008-12-17 16:36:21 -06001171 Note that if the GPIO device uses I2C, then the I2C interface
1172 must also be configured. See I2C Support, below.
1173
wdenkc6097192002-11-03 00:24:07 +00001174- Timestamp Support:
1175
wdenk43d96162003-03-06 00:02:04 +00001176 When CONFIG_TIMESTAMP is selected, the timestamp
1177 (date and time) of an image is printed by image
1178 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001179 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001180
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001181- Partition Labels (disklabels) Supported:
1182 Zero or more of the following:
1183 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1184 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1185 Intel architecture, USB sticks, etc.
1186 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1187 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1188 bootloader. Note 2TB partition limit; see
1189 disk/part_efi.c
1190 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001191
Wolfgang Denk218ca722008-03-26 10:40:12 +01001192 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1193 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001194 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001195
1196- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001197 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1198 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001199
wdenk4d13cba2004-03-14 14:09:05 +00001200 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1201 be performed by calling the function
1202 ide_set_reset(int reset)
1203 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001204
1205- ATAPI Support:
1206 CONFIG_ATAPI
1207
1208 Set this to enable ATAPI support.
1209
wdenkc40b2952004-03-13 23:29:43 +00001210- LBA48 Support
1211 CONFIG_LBA48
1212
1213 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001214 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001215 Whithout these , LBA48 support uses 32bit variables and will 'only'
1216 support disks up to 2.1TB.
1217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001218 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001219 When enabled, makes the IDE subsystem use 64bit sector addresses.
1220 Default is 32bit.
1221
wdenkc6097192002-11-03 00:24:07 +00001222- SCSI Support:
1223 At the moment only there is only support for the
1224 SYM53C8XX SCSI controller; define
1225 CONFIG_SCSI_SYM53C8XX to enable it.
1226
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001227 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1228 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1229 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001230 maximum numbers of LUNs, SCSI ID's and target
1231 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001232 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001233
Wolfgang Denk93e14592013-10-04 17:43:24 +02001234 The environment variable 'scsidevs' is set to the number of
1235 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001236
wdenkc6097192002-11-03 00:24:07 +00001237- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001238 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001239 Support for Intel 8254x/8257x gigabit chips.
1240
1241 CONFIG_E1000_SPI
1242 Utility code for direct access to the SPI bus on Intel 8257x.
1243 This does not do anything useful unless you set at least one
1244 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1245
1246 CONFIG_E1000_SPI_GENERIC
1247 Allow generic access to the SPI bus on the Intel 8257x, for
1248 example with the "sspi" command.
1249
1250 CONFIG_CMD_E1000
1251 Management command for E1000 devices. When used on devices
1252 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001253
Andre Schwarzac3315c2008-03-06 16:45:44 +01001254 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001255 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001256
wdenkc6097192002-11-03 00:24:07 +00001257 CONFIG_EEPRO100
1258 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001259 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001260 write routine for first time initialisation.
1261
1262 CONFIG_TULIP
1263 Support for Digital 2114x chips.
1264 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1265 modem chip initialisation (KS8761/QS6611).
1266
1267 CONFIG_NATSEMI
1268 Support for National dp83815 chips.
1269
1270 CONFIG_NS8382X
1271 Support for National dp8382[01] gigabit chips.
1272
wdenk45219c42003-05-12 21:50:16 +00001273- NETWORK Support (other):
1274
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001275 CONFIG_DRIVER_AT91EMAC
1276 Support for AT91RM9200 EMAC.
1277
1278 CONFIG_RMII
1279 Define this to use reduced MII inteface
1280
1281 CONFIG_DRIVER_AT91EMAC_QUIET
1282 If this defined, the driver is quiet.
1283 The driver doen't show link status messages.
1284
Rob Herringefdd7312011-12-15 11:15:49 +00001285 CONFIG_CALXEDA_XGMAC
1286 Support for the Calxeda XGMAC device
1287
Ashok3bb46d22012-10-15 06:20:47 +00001288 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001289 Support for SMSC's LAN91C96 chips.
1290
1291 CONFIG_LAN91C96_BASE
1292 Define this to hold the physical address
1293 of the LAN91C96's I/O space
1294
1295 CONFIG_LAN91C96_USE_32_BIT
1296 Define this to enable 32 bit addressing
1297
Ashok3bb46d22012-10-15 06:20:47 +00001298 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001299 Support for SMSC's LAN91C111 chip
1300
1301 CONFIG_SMC91111_BASE
1302 Define this to hold the physical address
1303 of the device (I/O space)
1304
1305 CONFIG_SMC_USE_32_BIT
1306 Define this if data bus is 32 bits
1307
1308 CONFIG_SMC_USE_IOFUNCS
1309 Define this to use i/o functions instead of macros
1310 (some hardware wont work with macros)
1311
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001312 CONFIG_DRIVER_TI_EMAC
1313 Support for davinci emac
1314
1315 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1316 Define this if you have more then 3 PHYs.
1317
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001318 CONFIG_FTGMAC100
1319 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1320
1321 CONFIG_FTGMAC100_EGIGA
1322 Define this to use GE link update with gigabit PHY.
1323 Define this if FTGMAC100 is connected to gigabit PHY.
1324 If your system has 10/100 PHY only, it might not occur
1325 wrong behavior. Because PHY usually return timeout or
1326 useless data when polling gigabit status and gigabit
1327 control registers. This behavior won't affect the
1328 correctnessof 10/100 link speed update.
1329
Mike Rapoportc2fff332009-11-11 10:03:03 +02001330 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001331 Support for SMSC's LAN911x and LAN921x chips
1332
Mike Rapoportc2fff332009-11-11 10:03:03 +02001333 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001334 Define this to hold the physical address
1335 of the device (I/O space)
1336
Mike Rapoportc2fff332009-11-11 10:03:03 +02001337 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001338 Define this if data bus is 32 bits
1339
Mike Rapoportc2fff332009-11-11 10:03:03 +02001340 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001341 Define this if data bus is 16 bits. If your processor
1342 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001343 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001344
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001345 CONFIG_SH_ETHER
1346 Support for Renesas on-chip Ethernet controller
1347
1348 CONFIG_SH_ETHER_USE_PORT
1349 Define the number of ports to be used
1350
1351 CONFIG_SH_ETHER_PHY_ADDR
1352 Define the ETH PHY's address
1353
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001354 CONFIG_SH_ETHER_CACHE_WRITEBACK
1355 If this option is set, the driver enables cache flush.
1356
Vadim Bendebury5e124722011-10-17 08:36:14 +00001357- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001358 CONFIG_TPM
1359 Support TPM devices.
1360
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001361 CONFIG_TPM_TIS_I2C
1362 Support for i2c bus TPM devices. Only one device
1363 per system is supported at this time.
1364
1365 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1366 Define the the i2c bus number for the TPM device
1367
1368 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1369 Define the TPM's address on the i2c bus
1370
1371 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1372 Define the burst count bytes upper limit
1373
Dirk Eibachc01939c2013-06-26 15:55:15 +02001374 CONFIG_TPM_ATMEL_TWI
1375 Support for Atmel TWI TPM device. Requires I2C support.
1376
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001377 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001378 Support for generic parallel port TPM devices. Only one device
1379 per system is supported at this time.
1380
1381 CONFIG_TPM_TIS_BASE_ADDRESS
1382 Base address where the generic TPM device is mapped
1383 to. Contemporary x86 systems usually map it at
1384 0xfed40000.
1385
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001386 CONFIG_CMD_TPM
1387 Add tpm monitor functions.
1388 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1389 provides monitor access to authorized functions.
1390
1391 CONFIG_TPM
1392 Define this to enable the TPM support library which provides
1393 functional interfaces to some TPM commands.
1394 Requires support for a TPM device.
1395
1396 CONFIG_TPM_AUTH_SESSIONS
1397 Define this to enable authorized functions in the TPM library.
1398 Requires CONFIG_TPM and CONFIG_SHA1.
1399
wdenkc6097192002-11-03 00:24:07 +00001400- USB Support:
1401 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001402 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001403 CONFIG_USB_UHCI to enable it.
1404 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001405 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001406 storage devices.
1407 Note:
1408 Supported are USB Keyboards and USB Floppy drives
1409 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001410 MPC5200 USB requires additional defines:
1411 CONFIG_USB_CLOCK
1412 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001413 CONFIG_PSC3_USB
1414 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001415 CONFIG_USB_CONFIG
1416 for differential drivers: 0x00001000
1417 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001418 for differential drivers on PSC3: 0x00000100
1419 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001420 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001421 May be defined to allow interrupt polling
1422 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001423
Simon Glass9ab4ce22012-02-27 10:52:47 +00001424 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1425 txfilltuning field in the EHCI controller on reset.
1426
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001427 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1428 interval for usb hub power-on delay.(minimum 100msec)
1429
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001430- USB Device:
1431 Define the below if you wish to use the USB console.
1432 Once firmware is rebuilt from a serial console issue the
1433 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001434 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001435 it has found a new device. The environment variable usbtty
1436 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001437 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001438 Common Device Class Abstract Control Model serial device.
1439 If you select usbtty = gserial you should be able to enumerate
1440 a Linux host by
1441 # modprobe usbserial vendor=0xVendorID product=0xProductID
1442 else if using cdc_acm, simply setting the environment
1443 variable usbtty to be cdc_acm should suffice. The following
1444 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001445
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001446 CONFIG_USB_DEVICE
1447 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001448
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001449 CONFIG_USB_TTY
1450 Define this to have a tty type of device available to
1451 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001452
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301453 CONFIG_USBD_HS
1454 Define this to enable the high speed support for usb
1455 device and usbtty. If this feature is enabled, a routine
1456 int is_usbd_high_speed(void)
1457 also needs to be defined by the driver to dynamically poll
1458 whether the enumeration has succeded at high speed or full
1459 speed.
1460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001461 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001462 Define this if you want stdin, stdout &/or stderr to
1463 be set to usbtty.
1464
1465 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001466 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001467 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001468 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001470 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001471 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001472 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001473
Wolfgang Denk386eda02006-06-14 18:14:56 +02001474 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001475 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001476 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001477 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1478 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1479 should pretend to be a Linux device to it's target host.
1480
1481 CONFIG_USBD_MANUFACTURER
1482 Define this string as the name of your company for
1483 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001484
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001485 CONFIG_USBD_PRODUCT_NAME
1486 Define this string as the name of your product
1487 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1488
1489 CONFIG_USBD_VENDORID
1490 Define this as your assigned Vendor ID from the USB
1491 Implementors Forum. This *must* be a genuine Vendor ID
1492 to avoid polluting the USB namespace.
1493 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001494
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001495 CONFIG_USBD_PRODUCTID
1496 Define this as the unique Product ID
1497 for your device
1498 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001499
Igor Grinbergd70a5602011-12-12 12:08:35 +02001500- ULPI Layer Support:
1501 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1502 the generic ULPI layer. The generic layer accesses the ULPI PHY
1503 via the platform viewport, so you need both the genric layer and
1504 the viewport enabled. Currently only Chipidea/ARC based
1505 viewport is supported.
1506 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1507 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001508 If your ULPI phy needs a different reference clock than the
1509 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1510 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001511
1512- MMC Support:
1513 The MMC controller on the Intel PXA is supported. To
1514 enable this define CONFIG_MMC. The MMC can be
1515 accessed from the boot prompt by mapping the device
1516 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001517 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1518 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001519
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001520 CONFIG_SH_MMCIF
1521 Support for Renesas on-chip MMCIF controller
1522
1523 CONFIG_SH_MMCIF_ADDR
1524 Define the base address of MMCIF registers
1525
1526 CONFIG_SH_MMCIF_CLK
1527 Define the clock frequency for MMCIF
1528
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001529 CONFIG_GENERIC_MMC
1530 Enable the generic MMC driver
1531
1532 CONFIG_SUPPORT_EMMC_BOOT
1533 Enable some additional features of the eMMC boot partitions.
1534
1535 CONFIG_SUPPORT_EMMC_RPMB
1536 Enable the commands for reading, writing and programming the
1537 key for the Replay Protection Memory Block partition in eMMC.
1538
Tom Rinib3ba6e92013-03-14 05:32:47 +00001539- USB Device Firmware Update (DFU) class support:
1540 CONFIG_DFU_FUNCTION
1541 This enables the USB portion of the DFU USB class
1542
1543 CONFIG_CMD_DFU
1544 This enables the command "dfu" which is used to have
1545 U-Boot create a DFU class device via USB. This command
1546 requires that the "dfu_alt_info" environment variable be
1547 set and define the alt settings to expose to the host.
1548
1549 CONFIG_DFU_MMC
1550 This enables support for exposing (e)MMC devices via DFU.
1551
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001552 CONFIG_DFU_NAND
1553 This enables support for exposing NAND devices via DFU.
1554
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301555 CONFIG_DFU_RAM
1556 This enables support for exposing RAM via DFU.
1557 Note: DFU spec refer to non-volatile memory usage, but
1558 allow usages beyond the scope of spec - here RAM usage,
1559 one that would help mostly the developer.
1560
Heiko Schochere7e75c72013-06-12 06:05:51 +02001561 CONFIG_SYS_DFU_DATA_BUF_SIZE
1562 Dfu transfer uses a buffer before writing data to the
1563 raw storage device. Make the size (in bytes) of this buffer
1564 configurable. The size of this buffer is also configurable
1565 through the "dfu_bufsiz" environment variable.
1566
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001567 CONFIG_SYS_DFU_MAX_FILE_SIZE
1568 When updating files rather than the raw storage device,
1569 we use a static buffer to copy the file into and then write
1570 the buffer once we've been given the whole file. Define
1571 this to the maximum filesize (in bytes) for the buffer.
1572 Default is 4 MiB if undefined.
1573
Heiko Schocher001a8312014-03-18 08:09:56 +01001574 DFU_DEFAULT_POLL_TIMEOUT
1575 Poll timeout [ms], is the timeout a device can send to the
1576 host. The host must wait for this timeout before sending
1577 a subsequent DFU_GET_STATUS request to the device.
1578
1579 DFU_MANIFEST_POLL_TIMEOUT
1580 Poll timeout [ms], which the device sends to the host when
1581 entering dfuMANIFEST state. Host waits this timeout, before
1582 sending again an USB request to the device.
1583
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001584- USB Device Android Fastboot support:
1585 CONFIG_CMD_FASTBOOT
1586 This enables the command "fastboot" which enables the Android
1587 fastboot mode for the platform's USB device. Fastboot is a USB
1588 protocol for downloading images, flashing and device control
1589 used on Android devices.
1590 See doc/README.android-fastboot for more information.
1591
1592 CONFIG_ANDROID_BOOT_IMAGE
1593 This enables support for booting images which use the Android
1594 image format header.
1595
1596 CONFIG_USB_FASTBOOT_BUF_ADDR
1597 The fastboot protocol requires a large memory buffer for
1598 downloads. Define this to the starting RAM address to use for
1599 downloaded images.
1600
1601 CONFIG_USB_FASTBOOT_BUF_SIZE
1602 The fastboot protocol requires a large memory buffer for
1603 downloads. This buffer should be as large as possible for a
1604 platform. Define this to the size available RAM for fastboot.
1605
wdenk6705d812004-08-02 23:22:59 +00001606- Journaling Flash filesystem support:
1607 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1608 CONFIG_JFFS2_NAND_DEV
1609 Define these for a default partition on a NAND device
1610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001611 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1612 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001613 Define these for a default partition on a NOR device
1614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001615 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001616 Define this to create an own partition. You have to provide a
1617 function struct part_info* jffs2_part_info(int part_num)
1618
1619 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001620 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001621 to disable the command chpart. This is the default when you
1622 have not defined a custom partition
1623
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001624- FAT(File Allocation Table) filesystem write function support:
1625 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001626
1627 Define this to enable support for saving memory data as a
1628 file in FAT formatted partition.
1629
1630 This will also enable the command "fatwrite" enabling the
1631 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001632
Gabe Black84cd9322012-10-12 14:26:11 +00001633CBFS (Coreboot Filesystem) support
1634 CONFIG_CMD_CBFS
1635
1636 Define this to enable support for reading from a Coreboot
1637 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1638 and cbfsload.
1639
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301640- FAT(File Allocation Table) filesystem cluster size:
1641 CONFIG_FS_FAT_MAX_CLUSTSIZE
1642
1643 Define the max cluster size for fat operations else
1644 a default value of 65536 will be defined.
1645
wdenkc6097192002-11-03 00:24:07 +00001646- Keyboard Support:
1647 CONFIG_ISA_KEYBOARD
1648
1649 Define this to enable standard (PC-Style) keyboard
1650 support
1651
1652 CONFIG_I8042_KBD
1653 Standard PC keyboard driver with US (is default) and
1654 GERMAN key layout (switch via environment 'keymap=de') support.
1655 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1656 for cfb_console. Supports cursor blinking.
1657
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001658 CONFIG_CROS_EC_KEYB
1659 Enables a Chrome OS keyboard using the CROS_EC interface.
1660 This uses CROS_EC to communicate with a second microcontroller
1661 which provides key scans on request.
1662
wdenkc6097192002-11-03 00:24:07 +00001663- Video support:
1664 CONFIG_VIDEO
1665
1666 Define this to enable video support (for output to
1667 video).
1668
1669 CONFIG_VIDEO_CT69000
1670
1671 Enable Chips & Technologies 69000 Video chip
1672
1673 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001674 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001675 video output is selected via environment 'videoout'
1676 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1677 assumed.
wdenkc6097192002-11-03 00:24:07 +00001678
wdenkb79a11c2004-03-25 15:14:43 +00001679 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001680 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001681 are possible:
1682 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001683 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001684
1685 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1686 -------------+---------------------------------------------
1687 8 bits | 0x301* 0x303 0x305 0x161 0x307
1688 15 bits | 0x310 0x313 0x316 0x162 0x319
1689 16 bits | 0x311 0x314 0x317 0x163 0x31A
1690 24 bits | 0x312 0x315 0x318 ? 0x31B
1691 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001692 (i.e. setenv videomode 317; saveenv; reset;)
1693
wdenkb79a11c2004-03-25 15:14:43 +00001694 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001695 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001696
1697
stroesec1551ea2003-04-04 15:53:41 +00001698 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001699 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001700 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1701 or CONFIG_VIDEO_SED13806_16BPP
1702
Timur Tabi7d3053f2011-02-15 17:09:19 -06001703 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001704 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001705 SOCs that have a DIU should define this macro to enable DIU
1706 support, and should also define these other macros:
1707
1708 CONFIG_SYS_DIU_ADDR
1709 CONFIG_VIDEO
1710 CONFIG_CMD_BMP
1711 CONFIG_CFB_CONSOLE
1712 CONFIG_VIDEO_SW_CURSOR
1713 CONFIG_VGA_AS_SINGLE_DEVICE
1714 CONFIG_VIDEO_LOGO
1715 CONFIG_VIDEO_BMP_LOGO
1716
Timur Tabiba8e76b2011-04-11 14:18:22 -05001717 The DIU driver will look for the 'video-mode' environment
1718 variable, and if defined, enable the DIU as a console during
1719 boot. See the documentation file README.video for a
1720 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001721
Simon Glass058d59b2012-12-03 13:59:47 +00001722 CONFIG_VIDEO_VGA
1723
1724 Enable the VGA video / BIOS for x86. The alternative if you
1725 are using coreboot is to use the coreboot frame buffer
1726 driver.
1727
1728
wdenk682011f2003-06-03 23:54:09 +00001729- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001730 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001731
wdenk8bde7f72003-06-27 21:31:46 +00001732 Define this to enable a custom keyboard support.
1733 This simply calls drv_keyboard_init() which must be
1734 defined in your board-specific files.
1735 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001736
wdenkc6097192002-11-03 00:24:07 +00001737- LCD Support: CONFIG_LCD
1738
1739 Define this to enable LCD support (for output to LCD
1740 display); also select one of the supported displays
1741 by defining one of these:
1742
Stelian Pop39cf4802008-05-09 21:57:18 +02001743 CONFIG_ATMEL_LCD:
1744
1745 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1746
wdenkfd3103b2003-11-25 16:55:19 +00001747 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001748
wdenkfd3103b2003-11-25 16:55:19 +00001749 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001750
wdenkfd3103b2003-11-25 16:55:19 +00001751 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001752
wdenkfd3103b2003-11-25 16:55:19 +00001753 NEC NL6448BC20-08. 6.5", 640x480.
1754 Active, color, single scan.
1755
1756 CONFIG_NEC_NL6448BC33_54
1757
1758 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001759 Active, color, single scan.
1760
1761 CONFIG_SHARP_16x9
1762
1763 Sharp 320x240. Active, color, single scan.
1764 It isn't 16x9, and I am not sure what it is.
1765
1766 CONFIG_SHARP_LQ64D341
1767
1768 Sharp LQ64D341 display, 640x480.
1769 Active, color, single scan.
1770
1771 CONFIG_HLD1045
1772
1773 HLD1045 display, 640x480.
1774 Active, color, single scan.
1775
1776 CONFIG_OPTREX_BW
1777
1778 Optrex CBL50840-2 NF-FW 99 22 M5
1779 or
1780 Hitachi LMG6912RPFC-00T
1781 or
1782 Hitachi SP14Q002
1783
1784 320x240. Black & white.
1785
1786 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001787 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001788
Simon Glass676d3192012-10-17 13:24:54 +00001789 CONFIG_LCD_ALIGNMENT
1790
1791 Normally the LCD is page-aligned (tyically 4KB). If this is
1792 defined then the LCD will be aligned to this value instead.
1793 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1794 here, since it is cheaper to change data cache settings on
1795 a per-section basis.
1796
Simon Glass0d89efe2012-10-17 13:24:59 +00001797 CONFIG_CONSOLE_SCROLL_LINES
1798
1799 When the console need to be scrolled, this is the number of
1800 lines to scroll by. It defaults to 1. Increasing this makes
1801 the console jump but can help speed up operation when scrolling
1802 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001803
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001804 CONFIG_LCD_BMP_RLE8
1805
1806 Support drawing of RLE8-compressed bitmaps on the LCD.
1807
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001808 CONFIG_I2C_EDID
1809
1810 Enables an 'i2c edid' command which can read EDID
1811 information over I2C from an attached LCD display.
1812
wdenk7152b1d2003-09-05 23:19:14 +00001813- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001814
wdenk8bde7f72003-06-27 21:31:46 +00001815 If this option is set, the environment is checked for
1816 a variable "splashimage". If found, the usual display
1817 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001818 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001819 specified in "splashimage" is loaded instead. The
1820 console is redirected to the "nulldev", too. This
1821 allows for a "silent" boot where a splash screen is
1822 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001823
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001824 CONFIG_SPLASHIMAGE_GUARD
1825
1826 If this option is set, then U-Boot will prevent the environment
1827 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001828 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001829 This option is useful for targets where, due to alignment
1830 restrictions, an improperly aligned BMP image will cause a data
1831 abort. If you think you will not have problems with unaligned
1832 accesses (for example because your toolchain prevents them)
1833 there is no need to set this option.
1834
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001835 CONFIG_SPLASH_SCREEN_ALIGN
1836
1837 If this option is set the splash image can be freely positioned
1838 on the screen. Environment variable "splashpos" specifies the
1839 position as "x,y". If a positive number is given it is used as
1840 number of pixel from left/top. If a negative number is given it
1841 is used as number of pixel from right/bottom. You can also
1842 specify 'm' for centering the image.
1843
1844 Example:
1845 setenv splashpos m,m
1846 => image at center of screen
1847
1848 setenv splashpos 30,20
1849 => image at x = 30 and y = 20
1850
1851 setenv splashpos -10,m
1852 => vertically centered image
1853 at x = dspWidth - bmpWidth - 9
1854
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001855- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1856
1857 If this option is set, additionally to standard BMP
1858 images, gzipped BMP images can be displayed via the
1859 splashscreen support or the bmp command.
1860
Anatolij Gustschind5011762010-03-15 14:50:25 +01001861- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1862
1863 If this option is set, 8-bit RLE compressed BMP images
1864 can be displayed via the splashscreen support or the
1865 bmp command.
1866
Lei Wenf2b96df2012-09-28 04:26:47 +00001867- Do compresssing for memory range:
1868 CONFIG_CMD_ZIP
1869
1870 If this option is set, it would use zlib deflate method
1871 to compress the specified memory at its best effort.
1872
wdenkc29fdfc2003-08-29 20:57:53 +00001873- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001874 CONFIG_GZIP
1875
1876 Enabled by default to support gzip compressed images.
1877
wdenkc29fdfc2003-08-29 20:57:53 +00001878 CONFIG_BZIP2
1879
1880 If this option is set, support for bzip2 compressed
1881 images is included. If not, only uncompressed and gzip
1882 compressed images are supported.
1883
wdenk42d1f032003-10-15 23:53:47 +00001884 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001885 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001886 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001887
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001888 CONFIG_LZMA
1889
1890 If this option is set, support for lzma compressed
1891 images is included.
1892
1893 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1894 requires an amount of dynamic memory that is given by the
1895 formula:
1896
1897 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1898
1899 Where lc and lp stand for, respectively, Literal context bits
1900 and Literal pos bits.
1901
1902 This value is upper-bounded by 14MB in the worst case. Anyway,
1903 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1904 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1905 a very small buffer.
1906
1907 Use the lzmainfo tool to determinate the lc and lp values and
1908 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001909 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001910
Kees Cook8ef70472013-08-16 07:59:12 -07001911 CONFIG_LZO
1912
1913 If this option is set, support for LZO compressed images
1914 is included.
1915
wdenk17ea1172004-06-06 21:51:03 +00001916- MII/PHY support:
1917 CONFIG_PHY_ADDR
1918
1919 The address of PHY on MII bus.
1920
1921 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1922
1923 The clock frequency of the MII bus
1924
1925 CONFIG_PHY_GIGE
1926
1927 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001928 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001929
1930 CONFIG_PHY_RESET_DELAY
1931
1932 Some PHY like Intel LXT971A need extra delay after
1933 reset before any MII register access is possible.
1934 For such PHY, set this option to the usec delay
1935 required. (minimum 300usec for LXT971A)
1936
1937 CONFIG_PHY_CMD_DELAY (ppc4xx)
1938
1939 Some PHY like Intel LXT971A need extra delay after
1940 command issued before MII status register can be read
1941
wdenkc6097192002-11-03 00:24:07 +00001942- Ethernet address:
1943 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001944 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001945 CONFIG_ETH2ADDR
1946 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001947 CONFIG_ETH4ADDR
1948 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001949
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001950 Define a default value for Ethernet address to use
1951 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001952 is not determined automatically.
1953
1954- IP address:
1955 CONFIG_IPADDR
1956
1957 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001958 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001959 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001960 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001961
1962- Server IP address:
1963 CONFIG_SERVERIP
1964
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001965 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001966 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001967 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001968
Robin Getz97cfe862009-07-21 12:15:28 -04001969 CONFIG_KEEP_SERVERADDR
1970
1971 Keeps the server's MAC address, in the env 'serveraddr'
1972 for passing to bootargs (like Linux's netconsole option)
1973
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001974- Gateway IP address:
1975 CONFIG_GATEWAYIP
1976
1977 Defines a default value for the IP address of the
1978 default router where packets to other networks are
1979 sent to.
1980 (Environment variable "gatewayip")
1981
1982- Subnet mask:
1983 CONFIG_NETMASK
1984
1985 Defines a default value for the subnet mask (or
1986 routing prefix) which is used to determine if an IP
1987 address belongs to the local subnet or needs to be
1988 forwarded through a router.
1989 (Environment variable "netmask")
1990
David Updegraff53a5c422007-06-11 10:41:07 -05001991- Multicast TFTP Mode:
1992 CONFIG_MCAST_TFTP
1993
1994 Defines whether you want to support multicast TFTP as per
1995 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001996 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001997 driver in use must provide a function: mcast() to join/leave a
1998 multicast group.
1999
wdenkc6097192002-11-03 00:24:07 +00002000- BOOTP Recovery Mode:
2001 CONFIG_BOOTP_RANDOM_DELAY
2002
2003 If you have many targets in a network that try to
2004 boot using BOOTP, you may want to avoid that all
2005 systems send out BOOTP requests at precisely the same
2006 moment (which would happen for instance at recovery
2007 from a power failure, when all systems will try to
2008 boot, thus flooding the BOOTP server. Defining
2009 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2010 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002011 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002012
2013 1st BOOTP request: delay 0 ... 1 sec
2014 2nd BOOTP request: delay 0 ... 2 sec
2015 3rd BOOTP request: delay 0 ... 4 sec
2016 4th and following
2017 BOOTP requests: delay 0 ... 8 sec
2018
stroesefe389a82003-08-28 14:17:32 +00002019- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002020 You can fine tune the DHCP functionality by defining
2021 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002022
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002023 CONFIG_BOOTP_SUBNETMASK
2024 CONFIG_BOOTP_GATEWAY
2025 CONFIG_BOOTP_HOSTNAME
2026 CONFIG_BOOTP_NISDOMAIN
2027 CONFIG_BOOTP_BOOTPATH
2028 CONFIG_BOOTP_BOOTFILESIZE
2029 CONFIG_BOOTP_DNS
2030 CONFIG_BOOTP_DNS2
2031 CONFIG_BOOTP_SEND_HOSTNAME
2032 CONFIG_BOOTP_NTPSERVER
2033 CONFIG_BOOTP_TIMEOFFSET
2034 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002035 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002036
Wilson Callan5d110f02007-07-28 10:56:13 -04002037 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2038 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002039
Joe Hershberger2c00e092012-05-23 07:59:19 +00002040 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2041 after the configured retry count, the call will fail
2042 instead of starting over. This can be used to fail over
2043 to Link-local IP address configuration if the DHCP server
2044 is not available.
2045
stroesefe389a82003-08-28 14:17:32 +00002046 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2047 serverip from a DHCP server, it is possible that more
2048 than one DNS serverip is offered to the client.
2049 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2050 serverip will be stored in the additional environment
2051 variable "dnsip2". The first DNS serverip is always
2052 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002053 is defined.
stroesefe389a82003-08-28 14:17:32 +00002054
2055 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2056 to do a dynamic update of a DNS server. To do this, they
2057 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002058 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002059 of the "hostname" environment variable is passed as
2060 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002061
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002062 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2063
2064 A 32bit value in microseconds for a delay between
2065 receiving a "DHCP Offer" and sending the "DHCP Request".
2066 This fixes a problem with certain DHCP servers that don't
2067 respond 100% of the time to a "DHCP request". E.g. On an
2068 AT91RM9200 processor running at 180MHz, this delay needed
2069 to be *at least* 15,000 usec before a Windows Server 2003
2070 DHCP server would reply 100% of the time. I recommend at
2071 least 50,000 usec to be safe. The alternative is to hope
2072 that one of the retries will be successful but note that
2073 the DHCP timeout and retry process takes a longer than
2074 this delay.
2075
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002076 - Link-local IP address negotiation:
2077 Negotiate with other link-local clients on the local network
2078 for an address that doesn't require explicit configuration.
2079 This is especially useful if a DHCP server cannot be guaranteed
2080 to exist in all environments that the device must operate.
2081
2082 See doc/README.link-local for more information.
2083
wdenka3d991b2004-04-15 21:48:45 +00002084 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002085 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002086
2087 The device id used in CDP trigger frames.
2088
2089 CONFIG_CDP_DEVICE_ID_PREFIX
2090
2091 A two character string which is prefixed to the MAC address
2092 of the device.
2093
2094 CONFIG_CDP_PORT_ID
2095
2096 A printf format string which contains the ascii name of
2097 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002098 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002099
2100 CONFIG_CDP_CAPABILITIES
2101
2102 A 32bit integer which indicates the device capabilities;
2103 0x00000010 for a normal host which does not forwards.
2104
2105 CONFIG_CDP_VERSION
2106
2107 An ascii string containing the version of the software.
2108
2109 CONFIG_CDP_PLATFORM
2110
2111 An ascii string containing the name of the platform.
2112
2113 CONFIG_CDP_TRIGGER
2114
2115 A 32bit integer sent on the trigger.
2116
2117 CONFIG_CDP_POWER_CONSUMPTION
2118
2119 A 16bit integer containing the power consumption of the
2120 device in .1 of milliwatts.
2121
2122 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2123
2124 A byte containing the id of the VLAN.
2125
wdenkc6097192002-11-03 00:24:07 +00002126- Status LED: CONFIG_STATUS_LED
2127
2128 Several configurations allow to display the current
2129 status using a LED. For instance, the LED will blink
2130 fast while running U-Boot code, stop blinking as
2131 soon as a reply to a BOOTP request was received, and
2132 start blinking slow once the Linux kernel is running
2133 (supported by a status LED driver in the Linux
2134 kernel). Defining CONFIG_STATUS_LED enables this
2135 feature in U-Boot.
2136
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002137 Additional options:
2138
2139 CONFIG_GPIO_LED
2140 The status LED can be connected to a GPIO pin.
2141 In such cases, the gpio_led driver can be used as a
2142 status LED backend implementation. Define CONFIG_GPIO_LED
2143 to include the gpio_led driver in the U-Boot binary.
2144
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002145 CONFIG_GPIO_LED_INVERTED_TABLE
2146 Some GPIO connected LEDs may have inverted polarity in which
2147 case the GPIO high value corresponds to LED off state and
2148 GPIO low value corresponds to LED on state.
2149 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2150 with a list of GPIO LEDs that have inverted polarity.
2151
wdenkc6097192002-11-03 00:24:07 +00002152- CAN Support: CONFIG_CAN_DRIVER
2153
2154 Defining CONFIG_CAN_DRIVER enables CAN driver support
2155 on those systems that support this (optional)
2156 feature, like the TQM8xxL modules.
2157
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002158- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002159
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002160 This enable the NEW i2c subsystem, and will allow you to use
2161 i2c commands at the u-boot command line (as long as you set
2162 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2163 based realtime clock chips or other i2c devices. See
2164 common/cmd_i2c.c for a description of the command line
2165 interface.
2166
2167 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002168 - drivers/i2c/soft_i2c.c:
2169 - activate first bus with CONFIG_SYS_I2C_SOFT define
2170 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2171 for defining speed and slave address
2172 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2173 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2174 for defining speed and slave address
2175 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2176 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2177 for defining speed and slave address
2178 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2179 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2180 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002181
Heiko Schocher00f792e2012-10-24 13:48:22 +02002182 - drivers/i2c/fsl_i2c.c:
2183 - activate i2c driver with CONFIG_SYS_I2C_FSL
2184 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2185 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2186 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2187 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002188 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002189 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2190 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2191 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2192 second bus.
2193
Simon Glass1f2ba722012-10-30 07:28:53 +00002194 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002195 - activate this driver with CONFIG_SYS_I2C_TEGRA
2196 - This driver adds 4 i2c buses with a fix speed from
2197 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002198
Dirk Eibach880540d2013-04-25 02:40:01 +00002199 - drivers/i2c/ppc4xx_i2c.c
2200 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2201 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2202 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2203
tremfac96402013-09-21 18:13:35 +02002204 - drivers/i2c/i2c_mxc.c
2205 - activate this driver with CONFIG_SYS_I2C_MXC
2206 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2207 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2208 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2209 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2210 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2211 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2212 If thoses defines are not set, default value is 100000
2213 for speed, and 0 for slave.
2214
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002215 - drivers/i2c/rcar_i2c.c:
2216 - activate this driver with CONFIG_SYS_I2C_RCAR
2217 - This driver adds 4 i2c buses
2218
2219 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2220 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2221 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2222 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2223 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2224 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2225 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2226 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2227 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2228
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002229 - drivers/i2c/sh_i2c.c:
2230 - activate this driver with CONFIG_SYS_I2C_SH
2231 - This driver adds from 2 to 5 i2c buses
2232
2233 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2234 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2235 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2236 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2237 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2238 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2239 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2240 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2241 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2242 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2243 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2244 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2245 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2246
Heiko Schocher6789e842013-10-22 11:03:18 +02002247 - drivers/i2c/omap24xx_i2c.c
2248 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2249 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2250 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2251 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2252 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2253 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2254 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2255 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2256 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2257 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2258 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2259
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002260 - drivers/i2c/zynq_i2c.c
2261 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2262 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2263 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2264
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302265 - drivers/i2c/s3c24x0_i2c.c:
2266 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2267 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2268 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2269 with a fix speed from 100000 and the slave addr 0!
2270
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002271 additional defines:
2272
2273 CONFIG_SYS_NUM_I2C_BUSES
2274 Hold the number of i2c busses you want to use. If you
2275 don't use/have i2c muxes on your i2c bus, this
2276 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2277 omit this define.
2278
2279 CONFIG_SYS_I2C_DIRECT_BUS
2280 define this, if you don't use i2c muxes on your hardware.
2281 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2282 omit this define.
2283
2284 CONFIG_SYS_I2C_MAX_HOPS
2285 define how many muxes are maximal consecutively connected
2286 on one i2c bus. If you not use i2c muxes, omit this
2287 define.
2288
2289 CONFIG_SYS_I2C_BUSES
2290 hold a list of busses you want to use, only used if
2291 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2292 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2293 CONFIG_SYS_NUM_I2C_BUSES = 9:
2294
2295 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2296 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2297 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2298 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2299 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2300 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2301 {1, {I2C_NULL_HOP}}, \
2302 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2303 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2304 }
2305
2306 which defines
2307 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002308 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2309 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2310 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2311 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2312 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002313 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002314 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2315 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002316
2317 If you do not have i2c muxes on your board, omit this define.
2318
Heiko Schocherea818db2013-01-29 08:53:15 +01002319- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002320
2321 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2322 provides the following compelling advantages:
2323
2324 - more than one i2c adapter is usable
2325 - approved multibus support
2326 - better i2c mux support
2327
2328 ** Please consider updating your I2C driver now. **
2329
Heiko Schocherea818db2013-01-29 08:53:15 +01002330 These enable legacy I2C serial bus commands. Defining
2331 CONFIG_HARD_I2C will include the appropriate I2C driver
2332 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002333
wdenk945af8d2003-07-16 21:53:01 +00002334 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002335 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002336 CONFIG_COMMANDS) and communicate with i2c based realtime
2337 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002338 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002339
Ben Warrenbb99ad62006-09-07 16:50:54 -04002340 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002341
wdenk945af8d2003-07-16 21:53:01 +00002342 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002343 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002345 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002346 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002347 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002348 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002349
Peter Tyser8d321b82010-04-12 22:28:21 -05002350 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002351 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002352 and so its address should therefore be cleared to 0 (See,
2353 eg, MPC823e User's Manual p.16-473). So, set
2354 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002355
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002356 CONFIG_SYS_I2C_INIT_MPC5XXX
2357
2358 When a board is reset during an i2c bus transfer
2359 chips might think that the current transfer is still
2360 in progress. Reset the slave devices by sending start
2361 commands until the slave device responds.
2362
wdenk945af8d2003-07-16 21:53:01 +00002363 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002364
Heiko Schocherea818db2013-01-29 08:53:15 +01002365 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002366 then the following macros need to be defined (examples are
2367 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002368
2369 I2C_INIT
2370
wdenkb37c7e52003-06-30 16:24:52 +00002371 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002372 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002373
wdenkba56f622004-02-06 23:19:44 +00002374 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002375
wdenkc6097192002-11-03 00:24:07 +00002376 I2C_PORT
2377
wdenk43d96162003-03-06 00:02:04 +00002378 (Only for MPC8260 CPU). The I/O port to use (the code
2379 assumes both bits are on the same port). Valid values
2380 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002381
2382 I2C_ACTIVE
2383
2384 The code necessary to make the I2C data line active
2385 (driven). If the data line is open collector, this
2386 define can be null.
2387
wdenkb37c7e52003-06-30 16:24:52 +00002388 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2389
wdenkc6097192002-11-03 00:24:07 +00002390 I2C_TRISTATE
2391
2392 The code necessary to make the I2C data line tri-stated
2393 (inactive). If the data line is open collector, this
2394 define can be null.
2395
wdenkb37c7e52003-06-30 16:24:52 +00002396 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2397
wdenkc6097192002-11-03 00:24:07 +00002398 I2C_READ
2399
York Sun472d5462013-04-01 11:29:11 -07002400 Code that returns true if the I2C data line is high,
2401 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002402
wdenkb37c7e52003-06-30 16:24:52 +00002403 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2404
wdenkc6097192002-11-03 00:24:07 +00002405 I2C_SDA(bit)
2406
York Sun472d5462013-04-01 11:29:11 -07002407 If <bit> is true, sets the I2C data line high. If it
2408 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002409
wdenkb37c7e52003-06-30 16:24:52 +00002410 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002411 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002412 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002413
wdenkc6097192002-11-03 00:24:07 +00002414 I2C_SCL(bit)
2415
York Sun472d5462013-04-01 11:29:11 -07002416 If <bit> is true, sets the I2C clock line high. If it
2417 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002418
wdenkb37c7e52003-06-30 16:24:52 +00002419 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002420 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002421 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002422
wdenkc6097192002-11-03 00:24:07 +00002423 I2C_DELAY
2424
2425 This delay is invoked four times per clock cycle so this
2426 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002427 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002428 like:
2429
wdenkb37c7e52003-06-30 16:24:52 +00002430 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002431
Mike Frysinger793b5722010-07-21 13:38:02 -04002432 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2433
2434 If your arch supports the generic GPIO framework (asm/gpio.h),
2435 then you may alternatively define the two GPIOs that are to be
2436 used as SCL / SDA. Any of the previous I2C_xxx macros will
2437 have GPIO-based defaults assigned to them as appropriate.
2438
2439 You should define these to the GPIO value as given directly to
2440 the generic GPIO functions.
2441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002442 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002443
wdenk8bde7f72003-06-27 21:31:46 +00002444 When a board is reset during an i2c bus transfer
2445 chips might think that the current transfer is still
2446 in progress. On some boards it is possible to access
2447 the i2c SCLK line directly, either by using the
2448 processor pin as a GPIO or by having a second pin
2449 connected to the bus. If this option is defined a
2450 custom i2c_init_board() routine in boards/xxx/board.c
2451 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002452
Richard Retanubun26a33502010-04-12 15:08:17 -04002453 CONFIG_SYS_I2C_BOARD_LATE_INIT
2454
2455 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2456 defined a custom i2c_board_late_init() routine in
2457 boards/xxx/board.c is run AFTER the operations in i2c_init()
2458 is completed. This callpoint can be used to unreset i2c bus
2459 using CPU i2c controller register accesses for CPUs whose i2c
2460 controller provide such a method. It is called at the end of
2461 i2c_init() to allow i2c_init operations to setup the i2c bus
2462 controller on the CPU (e.g. setting bus speed & slave address).
2463
wdenk17ea1172004-06-06 21:51:03 +00002464 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2465
2466 This option enables configuration of bi_iic_fast[] flags
2467 in u-boot bd_info structure based on u-boot environment
2468 variable "i2cfast". (see also i2cfast)
2469
Ben Warrenbb99ad62006-09-07 16:50:54 -04002470 CONFIG_I2C_MULTI_BUS
2471
2472 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002473 must have a controller. At any point in time, only one bus is
2474 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002475 Note that bus numbering is zero-based.
2476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002477 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002478
2479 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002480 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002481 is set, specify a list of bus-device pairs. Otherwise, specify
2482 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002483
2484 e.g.
2485 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002486 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002487
2488 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2489
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002490 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002491 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002492
2493 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002495 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002496
2497 If defined, then this indicates the I2C bus number for DDR SPD.
2498 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002501
2502 If defined, then this indicates the I2C bus number for the RTC.
2503 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002505 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002506
2507 If defined, then this indicates the I2C bus number for the DTT.
2508 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002510 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002511
2512 If defined, specifies the I2C address of the DTT device.
2513 If not defined, then U-Boot uses predefined value for
2514 specified DTT device.
2515
Andrew Dyer2ac69852008-12-29 17:36:01 -06002516 CONFIG_SOFT_I2C_READ_REPEATED_START
2517
2518 defining this will force the i2c_read() function in
2519 the soft_i2c driver to perform an I2C repeated start
2520 between writing the address pointer and reading the
2521 data. If this define is omitted the default behaviour
2522 of doing a stop-start sequence will be used. Most I2C
2523 devices can use either method, but some require one or
2524 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002525
wdenkc6097192002-11-03 00:24:07 +00002526- SPI Support: CONFIG_SPI
2527
2528 Enables SPI driver (so far only tested with
2529 SPI EEPROM, also an instance works with Crystal A/D and
2530 D/As on the SACSng board)
2531
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002532 CONFIG_SH_SPI
2533
2534 Enables the driver for SPI controller on SuperH. Currently
2535 only SH7757 is supported.
2536
wdenkc6097192002-11-03 00:24:07 +00002537 CONFIG_SPI_X
2538
2539 Enables extended (16-bit) SPI EEPROM addressing.
2540 (symmetrical to CONFIG_I2C_X)
2541
2542 CONFIG_SOFT_SPI
2543
wdenk43d96162003-03-06 00:02:04 +00002544 Enables a software (bit-bang) SPI driver rather than
2545 using hardware support. This is a general purpose
2546 driver that only requires three general I/O port pins
2547 (two outputs, one input) to function. If this is
2548 defined, the board configuration must define several
2549 SPI configuration items (port pins to use, etc). For
2550 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002551
Ben Warren04a9e112008-01-16 22:37:35 -05002552 CONFIG_HARD_SPI
2553
2554 Enables a hardware SPI driver for general-purpose reads
2555 and writes. As with CONFIG_SOFT_SPI, the board configuration
2556 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002557 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002558 example, see include/configs/mpc8349emds.h.
2559
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002560 CONFIG_MXC_SPI
2561
2562 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002563 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002564
Matthias Fuchs01335022007-12-27 17:12:34 +01002565- FPGA Support: CONFIG_FPGA
2566
2567 Enables FPGA subsystem.
2568
2569 CONFIG_FPGA_<vendor>
2570
2571 Enables support for specific chip vendors.
2572 (ALTERA, XILINX)
2573
2574 CONFIG_FPGA_<family>
2575
2576 Enables support for FPGA family.
2577 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2578
2579 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002580
wdenk43d96162003-03-06 00:02:04 +00002581 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002582
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302583 CONFIG_CMD_FPGA_LOADMK
2584
2585 Enable support for fpga loadmk command
2586
Michal Simek67193862014-05-02 13:43:39 +02002587 CONFIG_CMD_FPGA_LOADP
2588
2589 Enable support for fpga loadp command - load partial bitstream
2590
2591 CONFIG_CMD_FPGA_LOADBP
2592
2593 Enable support for fpga loadbp command - load partial bitstream
2594 (Xilinx only)
2595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002597
wdenk8bde7f72003-06-27 21:31:46 +00002598 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002601
wdenk43d96162003-03-06 00:02:04 +00002602 Enable checks on FPGA configuration interface busy
2603 status by the configuration function. This option
2604 will require a board or device specific function to
2605 be written.
wdenkc6097192002-11-03 00:24:07 +00002606
2607 CONFIG_FPGA_DELAY
2608
2609 If defined, a function that provides delays in the FPGA
2610 configuration driver.
2611
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002612 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002613 Allow Control-C to interrupt FPGA configuration
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002616
wdenk43d96162003-03-06 00:02:04 +00002617 Check for configuration errors during FPGA bitfile
2618 loading. For example, abort during Virtex II
2619 configuration if the INIT_B line goes low (which
2620 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002622 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002623
wdenk43d96162003-03-06 00:02:04 +00002624 Maximum time to wait for the INIT_B line to deassert
2625 after PROB_B has been deasserted during a Virtex II
2626 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002627 ms.
wdenkc6097192002-11-03 00:24:07 +00002628
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002629 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002630
wdenk43d96162003-03-06 00:02:04 +00002631 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002632 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002634 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002635
wdenk43d96162003-03-06 00:02:04 +00002636 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002637 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002638
2639- Configuration Management:
2640 CONFIG_IDENT_STRING
2641
wdenk43d96162003-03-06 00:02:04 +00002642 If defined, this string will be added to the U-Boot
2643 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002644
2645- Vendor Parameter Protection:
2646
wdenk43d96162003-03-06 00:02:04 +00002647 U-Boot considers the values of the environment
2648 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002649 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002650 are set once by the board vendor / manufacturer, and
2651 protects these variables from casual modification by
2652 the user. Once set, these variables are read-only,
2653 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002654 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002655
2656 If CONFIG_ENV_OVERWRITE is #defined in your config
2657 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002658 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002659 these parameters.
2660
2661 Alternatively, if you #define _both_ CONFIG_ETHADDR
2662 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002663 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002664 which can be changed exactly ONCE by the user. [The
2665 serial# is unaffected by this, i. e. it remains
2666 read-only.]
2667
Joe Hershberger25980902012-12-11 22:16:31 -06002668 The same can be accomplished in a more flexible way
2669 for any variable by configuring the type of access
2670 to allow for those variables in the ".flags" variable
2671 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2672
wdenkc6097192002-11-03 00:24:07 +00002673- Protected RAM:
2674 CONFIG_PRAM
2675
2676 Define this variable to enable the reservation of
2677 "protected RAM", i. e. RAM which is not overwritten
2678 by U-Boot. Define CONFIG_PRAM to hold the number of
2679 kB you want to reserve for pRAM. You can overwrite
2680 this default value by defining an environment
2681 variable "pram" to the number of kB you want to
2682 reserve. Note that the board info structure will
2683 still show the full amount of RAM. If pRAM is
2684 reserved, a new environment variable "mem" will
2685 automatically be defined to hold the amount of
2686 remaining RAM in a form that can be passed as boot
2687 argument to Linux, for instance like that:
2688
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002689 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002690 saveenv
2691
2692 This way you can tell Linux not to use this memory,
2693 either, which results in a memory region that will
2694 not be affected by reboots.
2695
2696 *WARNING* If your board configuration uses automatic
2697 detection of the RAM size, you must make sure that
2698 this memory test is non-destructive. So far, the
2699 following board configurations are known to be
2700 "pRAM-clean":
2701
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002702 IVMS8, IVML24, SPD8xx, TQM8xxL,
2703 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002704 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002705
Gabe Black40fef042012-12-02 04:55:18 +00002706- Access to physical memory region (> 4GB)
2707 Some basic support is provided for operations on memory not
2708 normally accessible to U-Boot - e.g. some architectures
2709 support access to more than 4GB of memory on 32-bit
2710 machines using physical address extension or similar.
2711 Define CONFIG_PHYSMEM to access this basic support, which
2712 currently only supports clearing the memory.
2713
wdenkc6097192002-11-03 00:24:07 +00002714- Error Recovery:
2715 CONFIG_PANIC_HANG
2716
2717 Define this variable to stop the system in case of a
2718 fatal error, so that you have to reset it manually.
2719 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002720 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002721 automatically as fast as possible, but it may be
2722 useful during development since you can try to debug
2723 the conditions that lead to the situation.
2724
2725 CONFIG_NET_RETRY_COUNT
2726
wdenk43d96162003-03-06 00:02:04 +00002727 This variable defines the number of retries for
2728 network operations like ARP, RARP, TFTP, or BOOTP
2729 before giving up the operation. If not defined, a
2730 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002731
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002732 CONFIG_ARP_TIMEOUT
2733
2734 Timeout waiting for an ARP reply in milliseconds.
2735
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002736 CONFIG_NFS_TIMEOUT
2737
2738 Timeout in milliseconds used in NFS protocol.
2739 If you encounter "ERROR: Cannot umount" in nfs command,
2740 try longer timeout such as
2741 #define CONFIG_NFS_TIMEOUT 10000UL
2742
wdenkc6097192002-11-03 00:24:07 +00002743- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002744 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002745
2746 Enable auto completion of commands using TAB.
2747
Wolfgang Denka9398e02006-11-27 15:32:42 +01002748 Note that this feature has NOT been implemented yet
2749 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002750
2751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002752 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002753
2754 Define this variable to enable the "hush" shell (from
2755 Busybox) as command line interpreter, thus enabling
2756 powerful command line syntax like
2757 if...then...else...fi conditionals or `&&' and '||'
2758 constructs ("shell scripts").
2759
2760 If undefined, you get the old, much simpler behaviour
2761 with a somewhat smaller memory footprint.
2762
2763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002764 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002765
2766 This defines the secondary prompt string, which is
2767 printed when the command interpreter needs more input
2768 to complete a command. Usually "> ".
2769
2770 Note:
2771
wdenk8bde7f72003-06-27 21:31:46 +00002772 In the current implementation, the local variables
2773 space and global environment variables space are
2774 separated. Local variables are those you define by
2775 simply typing `name=value'. To access a local
2776 variable later on, you have write `$name' or
2777 `${name}'; to execute the contents of a variable
2778 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002779
wdenk43d96162003-03-06 00:02:04 +00002780 Global environment variables are those you use
2781 setenv/printenv to work with. To run a command stored
2782 in such a variable, you need to use the run command,
2783 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002784
2785 To store commands and special characters in a
2786 variable, please use double quotation marks
2787 surrounding the whole text of the variable, instead
2788 of the backslashes before semicolons and special
2789 symbols.
2790
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002791- Commandline Editing and History:
2792 CONFIG_CMDLINE_EDITING
2793
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002794 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002795 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002796
wdenka8c7c702003-12-06 19:49:23 +00002797- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002798 CONFIG_EXTRA_ENV_SETTINGS
2799
wdenk43d96162003-03-06 00:02:04 +00002800 Define this to contain any number of null terminated
2801 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002802 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002803
wdenk43d96162003-03-06 00:02:04 +00002804 For example, place something like this in your
2805 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002806
2807 #define CONFIG_EXTRA_ENV_SETTINGS \
2808 "myvar1=value1\0" \
2809 "myvar2=value2\0"
2810
wdenk43d96162003-03-06 00:02:04 +00002811 Warning: This method is based on knowledge about the
2812 internal format how the environment is stored by the
2813 U-Boot code. This is NOT an official, exported
2814 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002815 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002816 You better know what you are doing here.
2817
wdenk43d96162003-03-06 00:02:04 +00002818 Note: overly (ab)use of the default environment is
2819 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002820 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002821 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002822
Stephen Warren5e724ca2012-05-22 09:21:54 +00002823 CONFIG_ENV_VARS_UBOOT_CONFIG
2824
2825 Define this in order to add variables describing the
2826 U-Boot build configuration to the default environment.
2827 These will be named arch, cpu, board, vendor, and soc.
2828
2829 Enabling this option will cause the following to be defined:
2830
2831 - CONFIG_SYS_ARCH
2832 - CONFIG_SYS_CPU
2833 - CONFIG_SYS_BOARD
2834 - CONFIG_SYS_VENDOR
2835 - CONFIG_SYS_SOC
2836
Tom Rini7e27f892012-10-24 07:28:16 +00002837 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2838
2839 Define this in order to add variables describing certain
2840 run-time determined information about the hardware to the
2841 environment. These will be named board_name, board_rev.
2842
Simon Glass06fd8532012-11-30 13:01:17 +00002843 CONFIG_DELAY_ENVIRONMENT
2844
2845 Normally the environment is loaded when the board is
2846 intialised so that it is available to U-Boot. This inhibits
2847 that so that the environment is not available until
2848 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2849 this is instead controlled by the value of
2850 /config/load-environment.
2851
wdenka8c7c702003-12-06 19:49:23 +00002852- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002853 CONFIG_HAS_DATAFLASH
2854
wdenk8bde7f72003-06-27 21:31:46 +00002855 Defining this option enables DataFlash features and
2856 allows to read/write in Dataflash via the standard
2857 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002858
Eric Nelsonf61ec452012-01-31 10:52:08 -07002859- Serial Flash support
2860 CONFIG_CMD_SF
2861
2862 Defining this option enables SPI flash commands
2863 'sf probe/read/write/erase/update'.
2864
2865 Usage requires an initial 'probe' to define the serial
2866 flash parameters, followed by read/write/erase/update
2867 commands.
2868
2869 The following defaults may be provided by the platform
2870 to handle the common case when only a single serial
2871 flash is present on the system.
2872
2873 CONFIG_SF_DEFAULT_BUS Bus identifier
2874 CONFIG_SF_DEFAULT_CS Chip-select
2875 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2876 CONFIG_SF_DEFAULT_SPEED in Hz
2877
Simon Glass24007272012-10-08 13:16:02 +00002878 CONFIG_CMD_SF_TEST
2879
2880 Define this option to include a destructive SPI flash
2881 test ('sf test').
2882
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302883 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2884
2885 Define this option to use the Bank addr/Extended addr
2886 support on SPI flashes which has size > 16Mbytes.
2887
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302888 CONFIG_SF_DUAL_FLASH Dual flash memories
2889
2890 Define this option to use dual flash support where two flash
2891 memories can be connected with a given cs line.
2892 currently Xilinx Zynq qspi support these type of connections.
2893
wdenk3f85ce22004-02-23 16:11:30 +00002894- SystemACE Support:
2895 CONFIG_SYSTEMACE
2896
2897 Adding this option adds support for Xilinx SystemACE
2898 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002899 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002900 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002901
2902 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002904
2905 When SystemACE support is added, the "ace" device type
2906 becomes available to the fat commands, i.e. fatls.
2907
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002908- TFTP Fixed UDP Port:
2909 CONFIG_TFTP_PORT
2910
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002911 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002912 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002913 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002914 number generator is used.
2915
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002916 Also, the environment variable tftpdstp is used to supply
2917 the TFTP UDP destination port value. If tftpdstp isn't
2918 defined, the normal port 69 is used.
2919
2920 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002921 blindly start the TFTP transfer using the pre-configured
2922 target IP address and UDP port. This has the effect of
2923 "punching through" the (Windows XP) firewall, allowing
2924 the remainder of the TFTP transfer to proceed normally.
2925 A better solution is to properly configure the firewall,
2926 but sometimes that is not allowed.
2927
Simon Glassbf36c5d2012-12-05 14:46:38 +00002928- Hashing support:
2929 CONFIG_CMD_HASH
2930
2931 This enables a generic 'hash' command which can produce
2932 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2933
2934 CONFIG_HASH_VERIFY
2935
2936 Enable the hash verify command (hash -v). This adds to code
2937 size a little.
2938
2939 CONFIG_SHA1 - support SHA1 hashing
2940 CONFIG_SHA256 - support SHA256 hashing
2941
2942 Note: There is also a sha1sum command, which should perhaps
2943 be deprecated in favour of 'hash sha1'.
2944
Robert Winklera11f1872013-07-24 17:57:06 -07002945- Freescale i.MX specific commands:
2946 CONFIG_CMD_HDMIDETECT
2947 This enables 'hdmidet' command which returns true if an
2948 HDMI monitor is detected. This command is i.MX 6 specific.
2949
2950 CONFIG_CMD_BMODE
2951 This enables the 'bmode' (bootmode) command for forcing
2952 a boot from specific media.
2953
2954 This is useful for forcing the ROM's usb downloader to
2955 activate upon a watchdog reset which is nice when iterating
2956 on U-Boot. Using the reset button or running bmode normal
2957 will set it back to normal. This command currently
2958 supports i.MX53 and i.MX6.
2959
Simon Glass19c402a2013-06-13 15:10:02 -07002960- Signing support:
2961 CONFIG_RSA
2962
2963 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01002964 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07002965
2966 The signing part is build into mkimage regardless of this
2967 option.
2968
Heiko Schocher9e50c402014-01-25 07:27:13 +01002969- bootcount support:
2970 CONFIG_BOOTCOUNT_LIMIT
2971
2972 This enables the bootcounter support, see:
2973 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2974
2975 CONFIG_AT91SAM9XE
2976 enable special bootcounter support on at91sam9xe based boards.
2977 CONFIG_BLACKFIN
2978 enable special bootcounter support on blackfin based boards.
2979 CONFIG_SOC_DA8XX
2980 enable special bootcounter support on da850 based boards.
2981 CONFIG_BOOTCOUNT_RAM
2982 enable support for the bootcounter in RAM
2983 CONFIG_BOOTCOUNT_I2C
2984 enable support for the bootcounter on an i2c (like RTC) device.
2985 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2986 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2987 the bootcounter.
2988 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002989
wdenka8c7c702003-12-06 19:49:23 +00002990- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002991 CONFIG_SHOW_BOOT_PROGRESS
2992
wdenk43d96162003-03-06 00:02:04 +00002993 Defining this option allows to add some board-
2994 specific code (calling a user-provided function
2995 "show_boot_progress(int)") that enables you to show
2996 the system's boot progress on some display (for
2997 example, some LED's) on your board. At the moment,
2998 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002999
Simon Glass3a608ca2012-02-13 13:51:19 +00003000- Detailed boot stage timing
3001 CONFIG_BOOTSTAGE
3002 Define this option to get detailed timing of each stage
3003 of the boot process.
3004
3005 CONFIG_BOOTSTAGE_USER_COUNT
3006 This is the number of available user bootstage records.
3007 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3008 a new ID will be allocated from this stash. If you exceed
3009 the limit, recording will stop.
3010
3011 CONFIG_BOOTSTAGE_REPORT
3012 Define this to print a report before boot, similar to this:
3013
3014 Timer summary in microseconds:
3015 Mark Elapsed Stage
3016 0 0 reset
3017 3,575,678 3,575,678 board_init_f start
3018 3,575,695 17 arch_cpu_init A9
3019 3,575,777 82 arch_cpu_init done
3020 3,659,598 83,821 board_init_r start
3021 3,910,375 250,777 main_loop
3022 29,916,167 26,005,792 bootm_start
3023 30,361,327 445,160 start_kernel
3024
Simon Glass2eba38c2012-09-28 08:56:39 +00003025 CONFIG_CMD_BOOTSTAGE
3026 Add a 'bootstage' command which supports printing a report
3027 and un/stashing of bootstage data.
3028
Simon Glass94fd1312012-09-28 08:56:37 +00003029 CONFIG_BOOTSTAGE_FDT
3030 Stash the bootstage information in the FDT. A root 'bootstage'
3031 node is created with each bootstage id as a child. Each child
3032 has a 'name' property and either 'mark' containing the
3033 mark time in microsecond, or 'accum' containing the
3034 accumulated time for that bootstage id in microseconds.
3035 For example:
3036
3037 bootstage {
3038 154 {
3039 name = "board_init_f";
3040 mark = <3575678>;
3041 };
3042 170 {
3043 name = "lcd";
3044 accum = <33482>;
3045 };
3046 };
3047
3048 Code in the Linux kernel can find this in /proc/devicetree.
3049
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003050Legacy uImage format:
3051
wdenkc6097192002-11-03 00:24:07 +00003052 Arg Where When
3053 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003054 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003055 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003056 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003057 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003058 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003059 4 common/cmd_bootm.c Image data has correct checksum
3060 -4 common/cmd_bootm.c Image is for unsupported architecture
3061 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003062 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003063 6 common/cmd_bootm.c Image Type check OK
3064 -6 common/cmd_bootm.c gunzip uncompression error
3065 -7 common/cmd_bootm.c Unimplemented compression type
3066 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003067 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003068 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003069
3070 9 common/image.c Start initial ramdisk verification
3071 -10 common/image.c Ramdisk header has bad magic number
3072 -11 common/image.c Ramdisk header has bad checksum
3073 10 common/image.c Ramdisk header is OK
3074 -12 common/image.c Ramdisk data has bad checksum
3075 11 common/image.c Ramdisk data has correct checksum
3076 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003077 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003078 13 common/image.c Start multifile image verification
3079 14 common/image.c No initial ramdisk, no multifile, continue.
3080
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003081 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003082
Stefan Roesea47a12b2010-04-15 16:07:28 +02003083 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003084 -31 post/post.c POST test failed, detected by post_output_backlog()
3085 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003086
Heiko Schocher566a4942007-06-22 19:11:54 +02003087 34 common/cmd_doc.c before loading a Image from a DOC device
3088 -35 common/cmd_doc.c Bad usage of "doc" command
3089 35 common/cmd_doc.c correct usage of "doc" command
3090 -36 common/cmd_doc.c No boot device
3091 36 common/cmd_doc.c correct boot device
3092 -37 common/cmd_doc.c Unknown Chip ID on boot device
3093 37 common/cmd_doc.c correct chip ID found, device available
3094 -38 common/cmd_doc.c Read Error on boot device
3095 38 common/cmd_doc.c reading Image header from DOC device OK
3096 -39 common/cmd_doc.c Image header has bad magic number
3097 39 common/cmd_doc.c Image header has correct magic number
3098 -40 common/cmd_doc.c Error reading Image from DOC device
3099 40 common/cmd_doc.c Image header has correct magic number
3100 41 common/cmd_ide.c before loading a Image from a IDE device
3101 -42 common/cmd_ide.c Bad usage of "ide" command
3102 42 common/cmd_ide.c correct usage of "ide" command
3103 -43 common/cmd_ide.c No boot device
3104 43 common/cmd_ide.c boot device found
3105 -44 common/cmd_ide.c Device not available
3106 44 common/cmd_ide.c Device available
3107 -45 common/cmd_ide.c wrong partition selected
3108 45 common/cmd_ide.c partition selected
3109 -46 common/cmd_ide.c Unknown partition table
3110 46 common/cmd_ide.c valid partition table found
3111 -47 common/cmd_ide.c Invalid partition type
3112 47 common/cmd_ide.c correct partition type
3113 -48 common/cmd_ide.c Error reading Image Header on boot device
3114 48 common/cmd_ide.c reading Image Header from IDE device OK
3115 -49 common/cmd_ide.c Image header has bad magic number
3116 49 common/cmd_ide.c Image header has correct magic number
3117 -50 common/cmd_ide.c Image header has bad checksum
3118 50 common/cmd_ide.c Image header has correct checksum
3119 -51 common/cmd_ide.c Error reading Image from IDE device
3120 51 common/cmd_ide.c reading Image from IDE device OK
3121 52 common/cmd_nand.c before loading a Image from a NAND device
3122 -53 common/cmd_nand.c Bad usage of "nand" command
3123 53 common/cmd_nand.c correct usage of "nand" command
3124 -54 common/cmd_nand.c No boot device
3125 54 common/cmd_nand.c boot device found
3126 -55 common/cmd_nand.c Unknown Chip ID on boot device
3127 55 common/cmd_nand.c correct chip ID found, device available
3128 -56 common/cmd_nand.c Error reading Image Header on boot device
3129 56 common/cmd_nand.c reading Image Header from NAND device OK
3130 -57 common/cmd_nand.c Image header has bad magic number
3131 57 common/cmd_nand.c Image header has correct magic number
3132 -58 common/cmd_nand.c Error reading Image from NAND device
3133 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003134
Heiko Schocher566a4942007-06-22 19:11:54 +02003135 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003136
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003137 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003138 -64 net/eth.c no Ethernet found.
3139 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003140
Heiko Schocher566a4942007-06-22 19:11:54 +02003141 -80 common/cmd_net.c usage wrong
3142 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003143 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003144 81 common/cmd_net.c NetLoop() back without error
3145 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3146 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003147 83 common/cmd_net.c running "source" command
3148 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003149 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003150
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003151FIT uImage format:
3152
3153 Arg Where When
3154 100 common/cmd_bootm.c Kernel FIT Image has correct format
3155 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3156 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3157 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3158 102 common/cmd_bootm.c Kernel unit name specified
3159 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003160 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003161 104 common/cmd_bootm.c Got kernel subimage node offset
3162 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3163 105 common/cmd_bootm.c Kernel subimage hash verification OK
3164 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3165 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003166 -106 common/cmd_bootm.c Kernel subimage has wrong type
3167 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003168 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3169 108 common/cmd_bootm.c Got kernel subimage data/size
3170 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3171 -109 common/cmd_bootm.c Can't get kernel subimage type
3172 -110 common/cmd_bootm.c Can't get kernel subimage comp
3173 -111 common/cmd_bootm.c Can't get kernel subimage os
3174 -112 common/cmd_bootm.c Can't get kernel subimage load address
3175 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3176
3177 120 common/image.c Start initial ramdisk verification
3178 -120 common/image.c Ramdisk FIT image has incorrect format
3179 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003180 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003181 -122 common/image.c Can't get configuration for ramdisk subimage
3182 123 common/image.c Ramdisk unit name specified
3183 -124 common/image.c Can't get ramdisk subimage node offset
3184 125 common/image.c Got ramdisk subimage node offset
3185 -125 common/image.c Ramdisk subimage hash verification failed
3186 126 common/image.c Ramdisk subimage hash verification OK
3187 -126 common/image.c Ramdisk subimage for unsupported architecture
3188 127 common/image.c Architecture check OK
3189 -127 common/image.c Can't get ramdisk subimage data/size
3190 128 common/image.c Got ramdisk subimage data/size
3191 129 common/image.c Can't get ramdisk load address
3192 -129 common/image.c Got ramdisk load address
3193
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003194 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003195 131 common/cmd_doc.c FIT image format OK
3196
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003197 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003198 141 common/cmd_ide.c FIT image format OK
3199
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003200 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003201 151 common/cmd_nand.c FIT image format OK
3202
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003203- FIT image support:
3204 CONFIG_FIT
3205 Enable support for the FIT uImage format.
3206
3207 CONFIG_FIT_BEST_MATCH
3208 When no configuration is explicitly selected, default to the
3209 one whose fdt's compatibility field best matches that of
3210 U-Boot itself. A match is considered "best" if it matches the
3211 most specific compatibility entry of U-Boot's fdt's root node.
3212 The order of entries in the configuration's fdt is ignored.
3213
Simon Glass3e569a62013-06-13 15:10:00 -07003214 CONFIG_FIT_SIGNATURE
3215 This option enables signature verification of FIT uImages,
3216 using a hash signed and verified using RSA. See
3217 doc/uImage.FIT/signature.txt for more details.
3218
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003219- Standalone program support:
3220 CONFIG_STANDALONE_LOAD_ADDR
3221
Wolfgang Denk6feff892011-10-09 21:06:34 +02003222 This option defines a board specific value for the
3223 address where standalone program gets loaded, thus
3224 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003225 settings.
3226
3227- Frame Buffer Address:
3228 CONFIG_FB_ADDR
3229
3230 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003231 address for frame buffer. This is typically the case
3232 when using a graphics controller has separate video
3233 memory. U-Boot will then place the frame buffer at
3234 the given address instead of dynamically reserving it
3235 in system RAM by calling lcd_setmem(), which grabs
3236 the memory for the frame buffer depending on the
3237 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003238
3239 Please see board_init_f function.
3240
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003241- Automatic software updates via TFTP server
3242 CONFIG_UPDATE_TFTP
3243 CONFIG_UPDATE_TFTP_CNT_MAX
3244 CONFIG_UPDATE_TFTP_MSEC_MAX
3245
3246 These options enable and control the auto-update feature;
3247 for a more detailed description refer to doc/README.update.
3248
3249- MTD Support (mtdparts command, UBI support)
3250 CONFIG_MTD_DEVICE
3251
3252 Adds the MTD device infrastructure from the Linux kernel.
3253 Needed for mtdparts command support.
3254
3255 CONFIG_MTD_PARTITIONS
3256
3257 Adds the MTD partitioning infrastructure from the Linux
3258 kernel. Needed for UBI support.
3259
Joe Hershberger70c219c2013-04-08 10:32:48 +00003260- UBI support
3261 CONFIG_CMD_UBI
3262
3263 Adds commands for interacting with MTD partitions formatted
3264 with the UBI flash translation layer
3265
3266 Requires also defining CONFIG_RBTREE
3267
Joe Hershberger147162d2013-04-08 10:32:49 +00003268 CONFIG_UBI_SILENCE_MSG
3269
3270 Make the verbose messages from UBI stop printing. This leaves
3271 warnings and errors enabled.
3272
Joe Hershberger70c219c2013-04-08 10:32:48 +00003273- UBIFS support
3274 CONFIG_CMD_UBIFS
3275
3276 Adds commands for interacting with UBI volumes formatted as
3277 UBIFS. UBIFS is read-only in u-boot.
3278
3279 Requires UBI support as well as CONFIG_LZO
3280
Joe Hershberger147162d2013-04-08 10:32:49 +00003281 CONFIG_UBIFS_SILENCE_MSG
3282
3283 Make the verbose messages from UBIFS stop printing. This leaves
3284 warnings and errors enabled.
3285
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003286- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003287 CONFIG_SPL
3288 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003289
Tom Rini95579792012-02-14 07:29:40 +00003290 CONFIG_SPL_LDSCRIPT
3291 LDSCRIPT for linking the SPL binary.
3292
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003293 CONFIG_SPL_MAX_FOOTPRINT
3294 Maximum size in memory allocated to the SPL, BSS included.
3295 When defined, the linker checks that the actual memory
3296 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003297 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003298 must not be both defined at the same time.
3299
Tom Rini95579792012-02-14 07:29:40 +00003300 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003301 Maximum size of the SPL image (text, data, rodata, and
3302 linker lists sections), BSS excluded.
3303 When defined, the linker checks that the actual size does
3304 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003305
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003306 CONFIG_SPL_TEXT_BASE
3307 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003308
Scott Wood94a45bb2012-09-20 19:05:12 -05003309 CONFIG_SPL_RELOC_TEXT_BASE
3310 Address to relocate to. If unspecified, this is equal to
3311 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3312
Tom Rini95579792012-02-14 07:29:40 +00003313 CONFIG_SPL_BSS_START_ADDR
3314 Link address for the BSS within the SPL binary.
3315
3316 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003317 Maximum size in memory allocated to the SPL BSS.
3318 When defined, the linker checks that the actual memory used
3319 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003320 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003321 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003322
3323 CONFIG_SPL_STACK
3324 Adress of the start of the stack SPL will use
3325
Scott Wood94a45bb2012-09-20 19:05:12 -05003326 CONFIG_SPL_RELOC_STACK
3327 Adress of the start of the stack SPL will use after
3328 relocation. If unspecified, this is equal to
3329 CONFIG_SPL_STACK.
3330
Tom Rini95579792012-02-14 07:29:40 +00003331 CONFIG_SYS_SPL_MALLOC_START
3332 Starting address of the malloc pool used in SPL.
3333
3334 CONFIG_SYS_SPL_MALLOC_SIZE
3335 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003336
Tom Rini47f7bca2012-08-13 12:03:19 -07003337 CONFIG_SPL_FRAMEWORK
3338 Enable the SPL framework under common/. This framework
3339 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3340 NAND loading of the Linux Kernel.
3341
Tom Rini9607faf2014-03-28 12:03:39 -04003342 CONFIG_SPL_OS_BOOT
3343 Enable booting directly to an OS from SPL.
3344 See also: doc/README.falcon
3345
Tom Rini861a86f2012-08-13 11:37:56 -07003346 CONFIG_SPL_DISPLAY_PRINT
3347 For ARM, enable an optional function to print more information
3348 about the running system.
3349
Scott Wood4b919722012-09-20 16:35:21 -05003350 CONFIG_SPL_INIT_MINIMAL
3351 Arch init code should be built for a very small image
3352
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003353 CONFIG_SPL_LIBCOMMON_SUPPORT
3354 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003355
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003356 CONFIG_SPL_LIBDISK_SUPPORT
3357 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003358
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003359 CONFIG_SPL_I2C_SUPPORT
3360 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003361
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003362 CONFIG_SPL_GPIO_SUPPORT
3363 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003364
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003365 CONFIG_SPL_MMC_SUPPORT
3366 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003367
Tom Rini95579792012-02-14 07:29:40 +00003368 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3369 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3370 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3371 Address, size and partition on the MMC to load U-Boot from
3372 when the MMC is being used in raw mode.
3373
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003374 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3375 Sector to load kernel uImage from when MMC is being
3376 used in raw mode (for Falcon mode)
3377
3378 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3379 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3380 Sector and number of sectors to load kernel argument
3381 parameters from when MMC is being used in raw mode
3382 (for falcon mode)
3383
Tom Rini95579792012-02-14 07:29:40 +00003384 CONFIG_SPL_FAT_SUPPORT
3385 Support for fs/fat/libfat.o in SPL binary
3386
3387 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3388 Filename to read to load U-Boot when reading from FAT
3389
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003390 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3391 Filename to read to load kernel uImage when reading
3392 from FAT (for Falcon mode)
3393
3394 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3395 Filename to read to load kernel argument parameters
3396 when reading from FAT (for Falcon mode)
3397
Scott Wood06f60ae2012-12-06 13:33:17 +00003398 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3399 Set this for NAND SPL on PPC mpc83xx targets, so that
3400 start.S waits for the rest of the SPL to load before
3401 continuing (the hardware starts execution after just
3402 loading the first page rather than the full 4K).
3403
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303404 CONFIG_SPL_SKIP_RELOCATE
3405 Avoid SPL relocation
3406
Scott Wood6f2f01b2012-09-20 19:09:07 -05003407 CONFIG_SPL_NAND_BASE
3408 Include nand_base.c in the SPL. Requires
3409 CONFIG_SPL_NAND_DRIVERS.
3410
3411 CONFIG_SPL_NAND_DRIVERS
3412 SPL uses normal NAND drivers, not minimal drivers.
3413
3414 CONFIG_SPL_NAND_ECC
3415 Include standard software ECC in the SPL
3416
Tom Rini95579792012-02-14 07:29:40 +00003417 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003418 Support for NAND boot using simple NAND drivers that
3419 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003420
Tom Rini6dd3b562014-03-28 12:03:36 -04003421 CONFIG_SPL_MTD_SUPPORT
3422 Support for the MTD subsystem within SPL. Useful for
3423 environment on NAND support within SPL.
3424
Ying Zhangbb0dc102013-08-16 15:16:11 +08003425 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3426 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003427 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003428
Ying Zhang7c8eea52013-08-16 15:16:12 +08003429 CONFIG_SPL_COMMON_INIT_DDR
3430 Set for common ddr init with serial presence detect in
3431 SPL binary.
3432
Tom Rini95579792012-02-14 07:29:40 +00003433 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3434 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3435 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3436 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3437 CONFIG_SYS_NAND_ECCBYTES
3438 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003439 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003440
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303441 CONFIG_SPL_NAND_BOOT
3442 Add support NAND boot
3443
Tom Rini95579792012-02-14 07:29:40 +00003444 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003445 Location in NAND to read U-Boot from
3446
3447 CONFIG_SYS_NAND_U_BOOT_DST
3448 Location in memory to load U-Boot to
3449
3450 CONFIG_SYS_NAND_U_BOOT_SIZE
3451 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003452
3453 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003454 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003455
3456 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3457 Define this if you need to first read the OOB and then the
3458 data. This is used for example on davinci plattforms.
3459
3460 CONFIG_SPL_OMAP3_ID_NAND
3461 Support for an OMAP3-specific set of functions to return the
3462 ID and MFR of the first attached NAND chip, if present.
3463
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003464 CONFIG_SPL_SERIAL_SUPPORT
3465 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003466
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003467 CONFIG_SPL_SPI_FLASH_SUPPORT
3468 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003469
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003470 CONFIG_SPL_SPI_SUPPORT
3471 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003472
Pavel Machekc57b9532012-08-30 22:42:11 +02003473 CONFIG_SPL_RAM_DEVICE
3474 Support for running image already present in ram, in SPL binary
3475
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003476 CONFIG_SPL_LIBGENERIC_SUPPORT
3477 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003478
Ying Zhangba1bee42013-05-20 14:07:25 +08003479 CONFIG_SPL_ENV_SUPPORT
3480 Support for the environment operating in SPL binary
3481
3482 CONFIG_SPL_NET_SUPPORT
3483 Support for the net/libnet.o in SPL binary.
3484 It conflicts with SPL env from storage medium specified by
3485 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3486
Scott Wood74752ba2012-12-06 13:33:16 +00003487 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003488 Image offset to which the SPL should be padded before appending
3489 the SPL payload. By default, this is defined as
3490 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3491 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3492 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003493
Scott Woodca2fca22012-09-21 16:27:32 -05003494 CONFIG_SPL_TARGET
3495 Final target image containing SPL and payload. Some SPLs
3496 use an arch-specific makefile fragment instead, for
3497 example if more than one image needs to be produced.
3498
Simon Glass87ebee32013-05-08 08:05:59 +00003499 CONFIG_FIT_SPL_PRINT
3500 Printing information about a FIT image adds quite a bit of
3501 code to SPL. So this is normally disabled in SPL. Use this
3502 option to re-enable it. This will affect the output of the
3503 bootm command when booting a FIT image.
3504
Ying Zhang3aa29de2013-08-16 15:16:15 +08003505- TPL framework
3506 CONFIG_TPL
3507 Enable building of TPL globally.
3508
3509 CONFIG_TPL_PAD_TO
3510 Image offset to which the TPL should be padded before appending
3511 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003512 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3513 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3514 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003515
wdenkc6097192002-11-03 00:24:07 +00003516Modem Support:
3517--------------
3518
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003519[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003520
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003521- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003522 CONFIG_MODEM_SUPPORT
3523
3524- RTS/CTS Flow control enable:
3525 CONFIG_HWFLOW
3526
3527- Modem debug support:
3528 CONFIG_MODEM_SUPPORT_DEBUG
3529
wdenk43d96162003-03-06 00:02:04 +00003530 Enables debugging stuff (char screen[1024], dbg())
3531 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003532
wdenka8c7c702003-12-06 19:49:23 +00003533- Interrupt support (PPC):
3534
wdenkd4ca31c2004-01-02 14:00:00 +00003535 There are common interrupt_init() and timer_interrupt()
3536 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003537 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003538 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003539 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003540 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003541 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003542 specific handling. If board has watchdog / status_led
3543 / other_activity_monitor it works automatically from
3544 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003545
wdenkc6097192002-11-03 00:24:07 +00003546- General:
3547
wdenk43d96162003-03-06 00:02:04 +00003548 In the target system modem support is enabled when a
3549 specific key (key combination) is pressed during
3550 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003551 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003552 board_init(). Currently key_pressed() is a dummy
3553 function, returning 1 and thus enabling modem
3554 initialization.
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk43d96162003-03-06 00:02:04 +00003556 If there are no modem init strings in the
3557 environment, U-Boot proceed to autoboot; the
3558 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003559 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003560
3561 See also: doc/README.Modem
3562
Helmut Raiger9660e442011-10-20 04:19:47 +00003563Board initialization settings:
3564------------------------------
3565
3566During Initialization u-boot calls a number of board specific functions
3567to allow the preparation of board specific prerequisites, e.g. pin setup
3568before drivers are initialized. To enable these callbacks the
3569following configuration macros have to be defined. Currently this is
3570architecture specific, so please check arch/your_architecture/lib/board.c
3571typically in board_init_f() and board_init_r().
3572
3573- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3574- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3575- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3576- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003577
wdenkc6097192002-11-03 00:24:07 +00003578Configuration Settings:
3579-----------------------
3580
York Sun4d1fd7f2014-02-26 17:03:19 -08003581- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3582 Optionally it can be defined to support 64-bit memory commands.
3583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003584- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003585 undefine this when you're short of memory.
3586
Peter Tyser2fb26042009-01-27 18:03:12 -06003587- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3588 width of the commands listed in the 'help' command output.
3589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003590- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003591 prompt for user input.
3592
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003593- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003594
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003595- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003597- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003599- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003600 the application (usually a Linux kernel) when it is
3601 booted
3602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003603- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003604 List of legal baudrate settings for this board.
3605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003606- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003607 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003609- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003610 If the board specific function
3611 extern int overwrite_console (void);
3612 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003613 serial port, else the settings in the environment are used.
3614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003615- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003616 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003618- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003619 Enable overwrite of previous console environment settings.
3620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003621- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003622 Begin and End addresses of the area used by the
3623 simple memory test.
3624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003625- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003626 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003628- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003629 Scratch address used by the alternate memory test
3630 You only need to set this if address zero isn't writeable
3631
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003632- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3633 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003634 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003635 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003636 fixing up gd->ram_size the Linux kernel should gets passed
3637 the now "corrected" memory size and won't touch it either.
3638 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003639 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003640 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003641 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003642
3643 This option can be used as a workaround for the 440EPx/GRx
3644 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3645 be touched.
3646
3647 WARNING: Please make sure that this value is a multiple of
3648 the Linux page size (normally 4k). If this is not the case,
3649 then the end address of the Linux memory will be located at a
3650 non page size aligned address and this could cause major
3651 problems.
3652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003653- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003654 Enable temporary baudrate change while serial download
3655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003656- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003657 Physical start address of SDRAM. _Must_ be 0 here.
3658
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003659- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003660 Physical start address of Motherboard I/O (if using a
3661 Cogent motherboard)
3662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003663- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003664 Physical start address of Flash memory.
3665
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003666- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003667 Physical start address of boot monitor code (set by
3668 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003669 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003670 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003672- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003673 Size of memory reserved for monitor code, used to
3674 determine _at_compile_time_ (!) if the environment is
3675 embedded within the U-Boot image, or in a separate
3676 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003678- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003679 Size of DRAM reserved for malloc() use.
3680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003681- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003682 Normally compressed uImages are limited to an
3683 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003684 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003685 to adjust this setting to your needs.
3686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003687- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003688 Maximum size of memory mapped by the startup code of
3689 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003690 the Linux kernel (bd_info, boot arguments, FDT blob if
3691 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003692 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003693 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003694 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003695 variable "bootm_mapsize" will override the value of
3696 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3697 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003698
John Rigbyfca43cc2010-10-13 13:57:35 -06003699- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3700 Enable initrd_high functionality. If defined then the
3701 initrd_high feature is enabled and the bootm ramdisk subcommand
3702 is enabled.
3703
3704- CONFIG_SYS_BOOT_GET_CMDLINE:
3705 Enables allocating and saving kernel cmdline in space between
3706 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3707
3708- CONFIG_SYS_BOOT_GET_KBD:
3709 Enables allocating and saving a kernel copy of the bd_info in
3710 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003712- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003713 Max number of Flash memory banks
3714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003715- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003716 Max number of sectors on a Flash chip
3717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003718- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003719 Timeout for Flash erase operations (in ms)
3720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003721- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003722 Timeout for Flash write operations (in ms)
3723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003724- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003725 Timeout for Flash set sector lock bit operation (in ms)
3726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003727- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003728 Timeout for Flash clear lock bits operation (in ms)
3729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003730- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003731 If defined, hardware flash sectors protection is used
3732 instead of U-Boot software protection.
3733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003734- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003735
3736 Enable TFTP transfers directly to flash memory;
3737 without this option such a download has to be
3738 performed in two steps: (1) download to RAM, and (2)
3739 copy from RAM to flash.
3740
3741 The two-step approach is usually more reliable, since
3742 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003743 the flash, but in some situations (when system RAM is
3744 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003745 downloaded image) this option may be very useful.
3746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003747- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003748 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003749 common flash structure for storing flash geometry.
3750
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003751- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003752 This option also enables the building of the cfi_flash driver
3753 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003754
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003755- CONFIG_FLASH_CFI_MTD
3756 This option enables the building of the cfi_mtd driver
3757 in the drivers directory. The driver exports CFI flash
3758 to the MTD layer.
3759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003760- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003761 Use buffered writes to flash.
3762
3763- CONFIG_FLASH_SPANSION_S29WS_N
3764 s29ws-n MirrorBit flash has non-standard addresses for buffered
3765 write commands.
3766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003767- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003768 If this option is defined, the common CFI flash doesn't
3769 print it's warning upon not recognized FLASH banks. This
3770 is useful, if some of the configured banks are only
3771 optionally available.
3772
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003773- CONFIG_FLASH_SHOW_PROGRESS
3774 If defined (must be an integer), print out countdown
3775 digits and dots. Recommended value: 45 (9..1) for 80
3776 column displays, 15 (3..1) for 40 column displays.
3777
Stefan Roese352ef3f2013-04-04 15:53:14 +02003778- CONFIG_FLASH_VERIFY
3779 If defined, the content of the flash (destination) is compared
3780 against the source after the write operation. An error message
3781 will be printed when the contents are not identical.
3782 Please note that this option is useless in nearly all cases,
3783 since such flash programming errors usually are detected earlier
3784 while unprotecting/erasing/programming. Please only enable
3785 this option if you really know what you are doing.
3786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003787- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003788 Defines the number of Ethernet receive buffers. On some
3789 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003790 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3791 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003792 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003793 Defaults to 4 if not defined.
3794
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003795- CONFIG_ENV_MAX_ENTRIES
3796
Wolfgang Denk071bc922010-10-27 22:48:30 +02003797 Maximum number of entries in the hash table that is used
3798 internally to store the environment settings. The default
3799 setting is supposed to be generous and should work in most
3800 cases. This setting can be used to tune behaviour; see
3801 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003802
Joe Hershberger25980902012-12-11 22:16:31 -06003803- CONFIG_ENV_FLAGS_LIST_DEFAULT
3804- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003805 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003806 calling env set. Variables can be restricted to only decimal,
3807 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3808 the variables can also be restricted to IP address or MAC address.
3809
3810 The format of the list is:
3811 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003812 access_atribute = [a|r|o|c]
3813 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003814 entry = variable_name[:attributes]
3815 list = entry[,list]
3816
3817 The type attributes are:
3818 s - String (default)
3819 d - Decimal
3820 x - Hexadecimal
3821 b - Boolean ([1yYtT|0nNfF])
3822 i - IP address
3823 m - MAC address
3824
Joe Hershberger267541f2012-12-11 22:16:34 -06003825 The access attributes are:
3826 a - Any (default)
3827 r - Read-only
3828 o - Write-once
3829 c - Change-default
3830
Joe Hershberger25980902012-12-11 22:16:31 -06003831 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3832 Define this to a list (string) to define the ".flags"
3833 envirnoment variable in the default or embedded environment.
3834
3835 - CONFIG_ENV_FLAGS_LIST_STATIC
3836 Define this to a list (string) to define validation that
3837 should be done if an entry is not found in the ".flags"
3838 environment variable. To override a setting in the static
3839 list, simply add an entry for the same variable name to the
3840 ".flags" variable.
3841
Joe Hershberger267541f2012-12-11 22:16:34 -06003842- CONFIG_ENV_ACCESS_IGNORE_FORCE
3843 If defined, don't allow the -f switch to env set override variable
3844 access flags.
3845
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003846- CONFIG_SYS_GENERIC_BOARD
3847 This selects the architecture-generic board system instead of the
3848 architecture-specific board files. It is intended to move boards
3849 to this new framework over time. Defining this will disable the
3850 arch/foo/lib/board.c file and use common/board_f.c and
3851 common/board_r.c instead. To use this option your architecture
3852 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3853 its config.mk file). If you find problems enabling this option on
3854 your board please report the problem and send patches!
3855
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003856- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3857 This is set by OMAP boards for the max time that reset should
3858 be asserted. See doc/README.omap-reset-time for details on how
3859 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003860
wdenkc6097192002-11-03 00:24:07 +00003861The following definitions that deal with the placement and management
3862of environment data (variable area); in general, we support the
3863following configurations:
3864
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003865- CONFIG_BUILD_ENVCRC:
3866
3867 Builds up envcrc with the target environment so that external utils
3868 may easily extract it and embed it in final U-Boot images.
3869
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003870- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003871
3872 Define this if the environment is in flash memory.
3873
3874 a) The environment occupies one whole flash sector, which is
3875 "embedded" in the text segment with the U-Boot code. This
3876 happens usually with "bottom boot sector" or "top boot
3877 sector" type flash chips, which have several smaller
3878 sectors at the start or the end. For instance, such a
3879 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3880 such a case you would place the environment in one of the
3881 4 kB sectors - with U-Boot code before and after it. With
3882 "top boot sector" type flash chips, you would put the
3883 environment in one of the last sectors, leaving a gap
3884 between U-Boot and the environment.
3885
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003886 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003887
3888 Offset of environment data (variable area) to the
3889 beginning of flash memory; for instance, with bottom boot
3890 type flash chips the second sector can be used: the offset
3891 for this sector is given here.
3892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003893 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003894
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003895 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003896
3897 This is just another way to specify the start address of
3898 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003899 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003900
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003901 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003902
3903 Size of the sector containing the environment.
3904
3905
3906 b) Sometimes flash chips have few, equal sized, BIG sectors.
3907 In such a case you don't want to spend a whole sector for
3908 the environment.
3909
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003910 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003911
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003912 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003913 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003914 of this flash sector for the environment. This saves
3915 memory for the RAM copy of the environment.
3916
3917 It may also save flash memory if you decide to use this
3918 when your environment is "embedded" within U-Boot code,
3919 since then the remainder of the flash sector could be used
3920 for U-Boot code. It should be pointed out that this is
3921 STRONGLY DISCOURAGED from a robustness point of view:
3922 updating the environment in flash makes it always
3923 necessary to erase the WHOLE sector. If something goes
3924 wrong before the contents has been restored from a copy in
3925 RAM, your target system will be dead.
3926
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003927 - CONFIG_ENV_ADDR_REDUND
3928 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk43d96162003-03-06 00:02:04 +00003930 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003931 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003932 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003933 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003934
3935BE CAREFUL! Any changes to the flash layout, and some changes to the
3936source code will make it necessary to adapt <board>/u-boot.lds*
3937accordingly!
3938
3939
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003940- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003941
3942 Define this if you have some non-volatile memory device
3943 (NVRAM, battery buffered SRAM) which you want to use for the
3944 environment.
3945
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003946 - CONFIG_ENV_ADDR:
3947 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003948
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003949 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003950 want to use for environment. It is assumed that this memory
3951 can just be read and written to, without any special
3952 provision.
3953
3954BE CAREFUL! The first access to the environment happens quite early
3955in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003956console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003957U-Boot will hang.
3958
3959Please note that even with NVRAM we still use a copy of the
3960environment in RAM: we could work on NVRAM directly, but we want to
3961keep settings there always unmodified except somebody uses "saveenv"
3962to save the current settings.
3963
3964
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003965- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003966
3967 Use this if you have an EEPROM or similar serial access
3968 device and a driver for it.
3969
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003970 - CONFIG_ENV_OFFSET:
3971 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003972
3973 These two #defines specify the offset and size of the
3974 environment area within the total memory of your EEPROM.
3975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003976 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003977 If defined, specified the chip address of the EEPROM device.
3978 The default address is zero.
3979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003980 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003981 If defined, the number of bits used to address bytes in a
3982 single page in the EEPROM device. A 64 byte page, for example
3983 would require six bits.
3984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003985 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003986 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003987 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003989 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003990 The length in bytes of the EEPROM memory array address. Note
3991 that this is NOT the chip address length!
3992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003993 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003994 EEPROM chips that implement "address overflow" are ones
3995 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3996 address and the extra bits end up in the "chip address" bit
3997 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3998 byte chips.
3999
4000 Note that we consider the length of the address field to
4001 still be one byte because the extra address bits are hidden
4002 in the chip address.
4003
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004004 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004005 The size in bytes of the EEPROM device.
4006
Heiko Schocher548738b2010-01-07 08:55:40 +01004007 - CONFIG_ENV_EEPROM_IS_ON_I2C
4008 define this, if you have I2C and SPI activated, and your
4009 EEPROM, which holds the environment, is on the I2C bus.
4010
4011 - CONFIG_I2C_ENV_EEPROM_BUS
4012 if you have an Environment on an EEPROM reached over
4013 I2C muxes, you can define here, how to reach this
4014 EEPROM. For example:
4015
Heiko Schocherea818db2013-01-29 08:53:15 +01004016 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004017
4018 EEPROM which holds the environment, is reached over
4019 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004020
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004021- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004022
wdenkd4ca31c2004-01-02 14:00:00 +00004023 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004024 want to use for the environment.
4025
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004026 - CONFIG_ENV_OFFSET:
4027 - CONFIG_ENV_ADDR:
4028 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004029
4030 These three #defines specify the offset and size of the
4031 environment area within the total memory of your DataFlash placed
4032 at the specified address.
4033
Liu Gang0a85a9e2012-03-08 00:33:20 +00004034- CONFIG_ENV_IS_IN_REMOTE:
4035
4036 Define this if you have a remote memory space which you
4037 want to use for the local device's environment.
4038
4039 - CONFIG_ENV_ADDR:
4040 - CONFIG_ENV_SIZE:
4041
4042 These two #defines specify the address and size of the
4043 environment area within the remote memory space. The
4044 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004045 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004046
4047BE CAREFUL! For some special cases, the local device can not use
4048"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004049environment stored in a remote NOR flash by SRIO or PCIE link,
4050but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004051
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004052- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004053
4054 Define this if you have a NAND device which you want to use
4055 for the environment.
4056
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004057 - CONFIG_ENV_OFFSET:
4058 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004059
4060 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004061 area within the first NAND device. CONFIG_ENV_OFFSET must be
4062 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004063
Scott Woodfdd813d2010-09-17 14:38:37 -05004064 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004065
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004066 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004067 size used to hold a redundant copy of the environment data, so
4068 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004069 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004070 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004071
Scott Woodfdd813d2010-09-17 14:38:37 -05004072 - CONFIG_ENV_RANGE (optional):
4073
4074 Specifies the length of the region in which the environment
4075 can be written. This should be a multiple of the NAND device's
4076 block size. Specifying a range with more erase blocks than
4077 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4078 the range to be avoided.
4079
4080 - CONFIG_ENV_OFFSET_OOB (optional):
4081
4082 Enables support for dynamically retrieving the offset of the
4083 environment from block zero's out-of-band data. The
4084 "nand env.oob" command can be used to record this offset.
4085 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4086 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004087
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004088- CONFIG_NAND_ENV_DST
4089
4090 Defines address in RAM to which the nand_spl code should copy the
4091 environment. If redundant environment is used, it will be copied to
4092 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4093
Joe Hershberger2b744332013-04-08 10:32:51 +00004094- CONFIG_ENV_IS_IN_UBI:
4095
4096 Define this if you have an UBI volume that you want to use for the
4097 environment. This has the benefit of wear-leveling the environment
4098 accesses, which is important on NAND.
4099
4100 - CONFIG_ENV_UBI_PART:
4101
4102 Define this to a string that is the mtd partition containing the UBI.
4103
4104 - CONFIG_ENV_UBI_VOLUME:
4105
4106 Define this to the name of the volume that you want to store the
4107 environment in.
4108
Joe Hershberger785881f2013-04-08 10:32:52 +00004109 - CONFIG_ENV_UBI_VOLUME_REDUND:
4110
4111 Define this to the name of another volume to store a second copy of
4112 the environment in. This will enable redundant environments in UBI.
4113 It is assumed that both volumes are in the same MTD partition.
4114
Joe Hershberger2b744332013-04-08 10:32:51 +00004115 - CONFIG_UBI_SILENCE_MSG
4116 - CONFIG_UBIFS_SILENCE_MSG
4117
4118 You will probably want to define these to avoid a really noisy system
4119 when storing the env in UBI.
4120
Stephen Warren06e4ae52013-06-11 15:14:00 -06004121- CONFIG_ENV_IS_IN_MMC:
4122
4123 Define this if you have an MMC device which you want to use for the
4124 environment.
4125
4126 - CONFIG_SYS_MMC_ENV_DEV:
4127
4128 Specifies which MMC device the environment is stored in.
4129
4130 - CONFIG_SYS_MMC_ENV_PART (optional):
4131
4132 Specifies which MMC partition the environment is stored in. If not
4133 set, defaults to partition 0, the user area. Common values might be
4134 1 (first MMC boot partition), 2 (second MMC boot partition).
4135
4136 - CONFIG_ENV_OFFSET:
4137 - CONFIG_ENV_SIZE:
4138
4139 These two #defines specify the offset and size of the environment
4140 area within the specified MMC device.
4141
Stephen Warren5c088ee2013-06-11 15:14:02 -06004142 If offset is positive (the usual case), it is treated as relative to
4143 the start of the MMC partition. If offset is negative, it is treated
4144 as relative to the end of the MMC partition. This can be useful if
4145 your board may be fitted with different MMC devices, which have
4146 different sizes for the MMC partitions, and you always want the
4147 environment placed at the very end of the partition, to leave the
4148 maximum possible space before it, to store other data.
4149
Stephen Warren06e4ae52013-06-11 15:14:00 -06004150 These two values are in units of bytes, but must be aligned to an
4151 MMC sector boundary.
4152
4153 - CONFIG_ENV_OFFSET_REDUND (optional):
4154
4155 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4156 hold a redundant copy of the environment data. This provides a
4157 valid backup copy in case the other copy is corrupted, e.g. due
4158 to a power failure during a "saveenv" operation.
4159
Stephen Warren5c088ee2013-06-11 15:14:02 -06004160 This value may also be positive or negative; this is handled in the
4161 same way as CONFIG_ENV_OFFSET.
4162
Stephen Warren06e4ae52013-06-11 15:14:00 -06004163 This value is also in units of bytes, but must also be aligned to
4164 an MMC sector boundary.
4165
4166 - CONFIG_ENV_SIZE_REDUND (optional):
4167
4168 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4169 set. If this value is set, it must be set to the same value as
4170 CONFIG_ENV_SIZE.
4171
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004172- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004173
4174 Defines offset to the initial SPI buffer area in DPRAM. The
4175 area is used at an early stage (ROM part) if the environment
4176 is configured to reside in the SPI EEPROM: We need a 520 byte
4177 scratch DPRAM area. It is used between the two initialization
4178 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4179 to be a good choice since it makes it far enough from the
4180 start of the data area as well as from the stack pointer.
4181
Bruce Adlere881cb52007-11-02 13:15:42 -07004182Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004183has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004184created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004185until then to read environment variables.
4186
wdenk85ec0bc2003-03-31 16:34:49 +00004187The environment is protected by a CRC32 checksum. Before the monitor
4188is relocated into RAM, as a result of a bad CRC you will be working
4189with the compiled-in default environment - *silently*!!! [This is
4190necessary, because the first environment variable we need is the
4191"baudrate" setting for the console - if we have a bad CRC, we don't
4192have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004193
4194Note: once the monitor has been relocated, then it will complain if
4195the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004196use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004197
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004198- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004199 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004201 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004202 also needs to be defined.
4203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004204- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004205 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004206
Ron Madridf5675aa2009-02-18 14:30:44 -08004207- CONFIG_NS16550_MIN_FUNCTIONS:
4208 Define this if you desire to only have use of the NS16550_init
4209 and NS16550_putc functions for the serial driver located at
4210 drivers/serial/ns16550.c. This option is useful for saving
4211 space for already greatly restricted images, including but not
4212 limited to NAND_SPL configurations.
4213
Simon Glassb2b92f52012-11-30 13:01:18 +00004214- CONFIG_DISPLAY_BOARDINFO
4215 Display information about the board that U-Boot is running on
4216 when U-Boot starts up. The board function checkboard() is called
4217 to do this.
4218
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004219- CONFIG_DISPLAY_BOARDINFO_LATE
4220 Similar to the previous option, but display this information
4221 later, once stdio is running and output goes to the LCD, if
4222 present.
4223
wdenkc6097192002-11-03 00:24:07 +00004224Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004225---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004226
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004227- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004228 Cache Line Size of the CPU.
4229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004230- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004231 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004232
wdenk42d1f032003-10-15 23:53:47 +00004233 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4234 and RPXsuper) to be able to adjust the position of
4235 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004236
Timur Tabie46fedf2011-08-04 18:03:41 -05004237- CONFIG_SYS_CCSRBAR_DEFAULT:
4238 Default (power-on reset) physical address of CCSR on Freescale
4239 PowerPC SOCs.
4240
4241- CONFIG_SYS_CCSRBAR:
4242 Virtual address of CCSR. On a 32-bit build, this is typically
4243 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4244
4245 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4246 for cross-platform code that uses that macro instead.
4247
4248- CONFIG_SYS_CCSRBAR_PHYS:
4249 Physical address of CCSR. CCSR can be relocated to a new
4250 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004251 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004252 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4253 is typically relocated on 36-bit builds. It is recommended
4254 that this macro be defined via the _HIGH and _LOW macros:
4255
4256 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4257 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4258
4259- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004260 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4261 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004262 used in assembly code, so it must not contain typecasts or
4263 integer size suffixes (e.g. "ULL").
4264
4265- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4266 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4267 used in assembly code, so it must not contain typecasts or
4268 integer size suffixes (e.g. "ULL").
4269
4270- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4271 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4272 forced to a value that ensures that CCSR is not relocated.
4273
wdenk7f6c2cb2002-11-10 22:06:23 +00004274- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004275 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004276
4277 the default drive number (default value 0)
4278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004279 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004280
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004281 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004282 (default value 1)
4283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004284 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004285
wdenk43d96162003-03-06 00:02:04 +00004286 defines the offset of register from address. It
4287 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004288 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004290 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4291 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004292 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004294 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004295 fdc_hw_init() is called at the beginning of the FDC
4296 setup. fdc_hw_init() must be provided by the board
4297 source code. It is used to make hardware dependant
4298 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004299
Macpaul Lin0abddf82011-04-11 20:45:32 +00004300- CONFIG_IDE_AHB:
4301 Most IDE controllers were designed to be connected with PCI
4302 interface. Only few of them were designed for AHB interface.
4303 When software is doing ATA command and data transfer to
4304 IDE devices through IDE-AHB controller, some additional
4305 registers accessing to these kind of IDE-AHB controller
4306 is requierd.
4307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004308- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004309 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004310 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004312- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk7152b1d2003-09-05 23:19:14 +00004314 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004315 initial data and stack; please note that this must be
4316 writable memory that is working WITHOUT special
4317 initialization, i. e. you CANNOT use normal RAM which
4318 will become available only after programming the
4319 memory controller and running certain initialization
4320 sequences.
4321
4322 U-Boot uses the following memory types:
4323 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4324 - MPC824X: data cache
4325 - PPC4xx: data cache
4326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004327- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004328
4329 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004330 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4331 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004332 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004333 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004334 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4335 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4336 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004337
4338 Note:
4339 On the MPC824X (or other systems that use the data
4340 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004341 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004342 point to an otherwise UNUSED address space between
4343 the top of RAM and the start of the PCI space.
4344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004345- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004347- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004349- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004351- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004353- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004355- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004357- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004358 SDRAM timing
4359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004360- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004361 periodic timer for refresh
4362
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004363- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004364
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004365- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4366 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4367 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4368 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004369 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4370
4371- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004372 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4373 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004374 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4375
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004376- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4377 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004378 Machine Mode Register and Memory Periodic Timer
4379 Prescaler definitions (SDRAM timing)
4380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004381- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004382 enable I2C microcode relocation patch (MPC8xx);
4383 define relocation offset in DPRAM [DSP2]
4384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004385- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004386 enable SMC microcode relocation patch (MPC8xx);
4387 define relocation offset in DPRAM [SMC1]
4388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004389- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004390 enable SPI microcode relocation patch (MPC8xx);
4391 define relocation offset in DPRAM [SCC4]
4392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004393- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004394 Use OSCM clock mode on MBX8xx board. Be careful,
4395 wrong setting might damage your board. Read
4396 doc/README.MBX before setting this variable!
4397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004398- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004399 Offset of the bootmode word in DPRAM used by post
4400 (Power On Self Tests). This definition overrides
4401 #define'd default value in commproc.h resp.
4402 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004404- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4405 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4406 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4407 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4408 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4409 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4410 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4411 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004412 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004413
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004414- CONFIG_PCI_DISABLE_PCIE:
4415 Disable PCI-Express on systems where it is supported but not
4416 required.
4417
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004418- CONFIG_PCI_ENUM_ONLY
4419 Only scan through and get the devices on the busses.
4420 Don't do any setup work, presumably because someone or
4421 something has already done it, and we don't need to do it
4422 a second time. Useful for platforms that are pre-booted
4423 by coreboot or similar.
4424
Gabor Juhos842033e2013-05-30 07:06:12 +00004425- CONFIG_PCI_INDIRECT_BRIDGE:
4426 Enable support for indirect PCI bridges.
4427
Kumar Galaa09b9b62010-12-30 12:09:53 -06004428- CONFIG_SYS_SRIO:
4429 Chip has SRIO or not
4430
4431- CONFIG_SRIO1:
4432 Board has SRIO 1 port available
4433
4434- CONFIG_SRIO2:
4435 Board has SRIO 2 port available
4436
Liu Gangc8b28152013-05-07 16:30:46 +08004437- CONFIG_SRIO_PCIE_BOOT_MASTER
4438 Board can support master function for Boot from SRIO and PCIE
4439
Kumar Galaa09b9b62010-12-30 12:09:53 -06004440- CONFIG_SYS_SRIOn_MEM_VIRT:
4441 Virtual Address of SRIO port 'n' memory region
4442
4443- CONFIG_SYS_SRIOn_MEM_PHYS:
4444 Physical Address of SRIO port 'n' memory region
4445
4446- CONFIG_SYS_SRIOn_MEM_SIZE:
4447 Size of SRIO port 'n' memory region
4448
Fabio Estevam66bd1842013-04-11 09:35:34 +00004449- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4450 Defined to tell the NAND controller that the NAND chip is using
4451 a 16 bit bus.
4452 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004453 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004454 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004455 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004456
4457- CONFIG_SYS_NDFC_EBC0_CFG
4458 Sets the EBC0_CFG register for the NDFC. If not defined
4459 a default value will be used.
4460
Ben Warrenbb99ad62006-09-07 16:50:54 -04004461- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004462 Get DDR timing information from an I2C EEPROM. Common
4463 with pluggable memory modules such as SODIMMs
4464
Ben Warrenbb99ad62006-09-07 16:50:54 -04004465 SPD_EEPROM_ADDRESS
4466 I2C address of the SPD EEPROM
4467
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004468- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004469 If SPD EEPROM is on an I2C bus other than the first
4470 one, specify here. Note that the value must resolve
4471 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004472
York Sun1b3e3c42011-06-07 09:42:16 +08004473- CONFIG_SYS_DDR_RAW_TIMING
4474 Get DDR timing information from other than SPD. Common with
4475 soldered DDR chips onboard without SPD. DDR raw timing
4476 parameters are extracted from datasheet and hard-coded into
4477 header files or board specific files.
4478
York Sun6f5e1dc2011-09-16 13:21:35 -07004479- CONFIG_FSL_DDR_INTERACTIVE
4480 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004482- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004483 Only for 83xx systems. If specified, then DDR should
4484 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004485
wdenkc26e4542004-04-18 10:13:26 +00004486- CONFIG_ETHER_ON_FEC[12]
4487 Define to enable FEC[12] on a 8xx series processor.
4488
4489- CONFIG_FEC[12]_PHY
4490 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004491 to the given FEC; i. e.
4492 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004493 means that the PHY with address 4 is connected to FEC1
4494
4495 When set to -1, means to probe for first available.
4496
4497- CONFIG_FEC[12]_PHY_NORXERR
4498 The PHY does not have a RXERR line (RMII only).
4499 (so program the FEC to ignore it).
4500
4501- CONFIG_RMII
4502 Enable RMII mode for all FECs.
4503 Note that this is a global option, we can't
4504 have one FEC in standard MII mode and another in RMII mode.
4505
wdenk5cf91d62004-04-23 20:32:05 +00004506- CONFIG_CRC32_VERIFY
4507 Add a verify option to the crc32 command.
4508 The syntax is:
4509
4510 => crc32 -v <address> <count> <crc32>
4511
4512 Where address/count indicate a memory area
4513 and crc32 is the correct crc32 which the
4514 area should have.
4515
wdenk56523f12004-07-11 17:40:54 +00004516- CONFIG_LOOPW
4517 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004518 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004519
stroese7b466642004-12-16 18:46:55 +00004520- CONFIG_MX_CYCLIC
4521 Add the "mdc" and "mwc" memory commands. These are cyclic
4522 "md/mw" commands.
4523 Examples:
4524
wdenkefe2a4d2004-12-16 21:44:03 +00004525 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004526 This command will print 4 bytes (10,11,12,13) each 500 ms.
4527
wdenkefe2a4d2004-12-16 21:44:03 +00004528 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004529 This command will write 12345678 to address 100 all 10 ms.
4530
wdenkefe2a4d2004-12-16 21:44:03 +00004531 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004532 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004533
wdenk8aa1a2d2005-04-04 12:44:11 +00004534- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004535 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004536 low level initializations (like setting up the memory
4537 controller) are omitted and/or U-Boot does not
4538 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004539
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004540 Normally this variable MUST NOT be defined. The only
4541 exception is when U-Boot is loaded (to RAM) by some
4542 other boot loader or by a debugger which performs
4543 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004544
Aneesh V401bb302011-07-13 05:11:07 +00004545- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004546 Modifies the behaviour of start.S when compiling a loader
4547 that is executed before the actual U-Boot. E.g. when
4548 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004549
Ying Zhang3aa29de2013-08-16 15:16:15 +08004550- CONFIG_TPL_BUILD
4551 Modifies the behaviour of start.S when compiling a loader
4552 that is executed after the SPL and before the actual U-Boot.
4553 It is loaded by the SPL.
4554
Ying Zhang5df572f2013-05-20 14:07:23 +08004555- CONFIG_SYS_MPC85XX_NO_RESETVEC
4556 Only for 85xx systems. If this variable is specified, the section
4557 .resetvec is not kept and the section .bootpg is placed in the
4558 previous 4k of the .text section.
4559
Simon Glass4213fc22013-02-24 17:33:14 +00004560- CONFIG_ARCH_MAP_SYSMEM
4561 Generally U-Boot (and in particular the md command) uses
4562 effective address. It is therefore not necessary to regard
4563 U-Boot address as virtual addresses that need to be translated
4564 to physical addresses. However, sandbox requires this, since
4565 it maintains its own little RAM buffer which contains all
4566 addressable memory. This option causes some memory accesses
4567 to be mapped through map_sysmem() / unmap_sysmem().
4568
Matthias Weisserd8834a12011-03-10 21:36:32 +00004569- CONFIG_USE_ARCH_MEMCPY
4570 CONFIG_USE_ARCH_MEMSET
4571 If these options are used a optimized version of memcpy/memset will
4572 be used if available. These functions may be faster under some
4573 conditions but may increase the binary size.
4574
Simon Glass588a13f2013-02-14 04:18:54 +00004575- CONFIG_X86_RESET_VECTOR
4576 If defined, the x86 reset vector code is included. This is not
4577 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004578
Mark Jacksonfc337052013-03-04 01:27:20 +00004579- CONFIG_SYS_MPUCLK
4580 Defines the MPU clock speed (in MHz).
4581
4582 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004583
Heiko Schocher16678eb2013-11-04 14:05:00 +01004584- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4585 Enables the RTC32K OSC on AM33xx based plattforms
4586
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004587- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4588 Option to disable subpage write in NAND driver
4589 driver that uses this:
4590 drivers/mtd/nand/davinci_nand.c
4591
Timur Tabif2717b42011-11-22 09:21:25 -06004592Freescale QE/FMAN Firmware Support:
4593-----------------------------------
4594
4595The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4596loading of "firmware", which is encoded in the QE firmware binary format.
4597This firmware often needs to be loaded during U-Boot booting, so macros
4598are used to identify the storage device (NOR flash, SPI, etc) and the address
4599within that device.
4600
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004601- CONFIG_SYS_FMAN_FW_ADDR
4602 The address in the storage device where the FMAN microcode is located. The
4603 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4604 is also specified.
4605
4606- CONFIG_SYS_QE_FW_ADDR
4607 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004608 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4609 is also specified.
4610
4611- CONFIG_SYS_QE_FMAN_FW_LENGTH
4612 The maximum possible size of the firmware. The firmware binary format
4613 has a field that specifies the actual size of the firmware, but it
4614 might not be possible to read any part of the firmware unless some
4615 local storage is allocated to hold the entire firmware first.
4616
4617- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4618 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4619 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4620 virtual address in NOR flash.
4621
4622- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4623 Specifies that QE/FMAN firmware is located in NAND flash.
4624 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4625
4626- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4627 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4628 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4629
4630- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4631 Specifies that QE/FMAN firmware is located on the primary SPI
4632 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4633
Liu Gang292dc6c2012-03-08 00:33:18 +00004634- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4635 Specifies that QE/FMAN firmware is located in the remote (master)
4636 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004637 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4638 window->master inbound window->master LAW->the ucode address in
4639 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004640
wdenkc6097192002-11-03 00:24:07 +00004641Building the Software:
4642======================
4643
Wolfgang Denk218ca722008-03-26 10:40:12 +01004644Building U-Boot has been tested in several native build environments
4645and in many different cross environments. Of course we cannot support
4646all possibly existing versions of cross development tools in all
4647(potentially obsolete) versions. In case of tool chain problems we
4648recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4649which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004650
Wolfgang Denk218ca722008-03-26 10:40:12 +01004651If you are not using a native environment, it is assumed that you
4652have GNU cross compiling tools available in your path. In this case,
4653you must set the environment variable CROSS_COMPILE in your shell.
4654Note that no changes to the Makefile or any other source files are
4655necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004656
Wolfgang Denk218ca722008-03-26 10:40:12 +01004657 $ CROSS_COMPILE=ppc_4xx-
4658 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004659
Peter Tyser2f8d3962009-03-13 18:54:51 -05004660Note: If you wish to generate Windows versions of the utilities in
4661 the tools directory you can use the MinGW toolchain
4662 (http://www.mingw.org). Set your HOST tools to the MinGW
4663 toolchain and execute 'make tools'. For example:
4664
4665 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4666
4667 Binaries such as tools/mkimage.exe will be created which can
4668 be executed on computers running Windows.
4669
Wolfgang Denk218ca722008-03-26 10:40:12 +01004670U-Boot is intended to be simple to build. After installing the
4671sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004672is done by typing:
4673
4674 make NAME_config
4675
Wolfgang Denk218ca722008-03-26 10:40:12 +01004676where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004677rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004678
wdenk2729af92004-05-03 20:45:30 +00004679Note: for some board special configuration names may exist; check if
4680 additional information is available from the board vendor; for
4681 instance, the TQM823L systems are available without (standard)
4682 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004683 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk2729af92004-05-03 20:45:30 +00004685 make TQM823L_config
4686 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk2729af92004-05-03 20:45:30 +00004688 make TQM823L_LCD_config
4689 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk2729af92004-05-03 20:45:30 +00004691 etc.
wdenkc6097192002-11-03 00:24:07 +00004692
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694Finally, type "make all", and you should get some working U-Boot
4695images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004696
wdenk2729af92004-05-03 20:45:30 +00004697- "u-boot.bin" is a raw binary image
4698- "u-boot" is an image in ELF binary format
4699- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004700
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004701By default the build is performed locally and the objects are saved
4702in the source directory. One of the two methods can be used to change
4703this behavior and build U-Boot to some external directory:
4704
47051. Add O= to the make command line invocations:
4706
4707 make O=/tmp/build distclean
4708 make O=/tmp/build NAME_config
4709 make O=/tmp/build all
4710
47112. Set environment variable BUILD_DIR to point to the desired location:
4712
4713 export BUILD_DIR=/tmp/build
4714 make distclean
4715 make NAME_config
4716 make all
4717
4718Note that the command line "O=" setting overrides the BUILD_DIR environment
4719variable.
4720
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722Please be aware that the Makefiles assume you are using GNU make, so
4723for instance on NetBSD you might need to use "gmake" instead of
4724native "make".
wdenkc6097192002-11-03 00:24:07 +00004725
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk2729af92004-05-03 20:45:30 +00004727If the system board that you have is not listed, then you will need
4728to port U-Boot to your hardware platform. To do this, follow these
4729steps:
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk2729af92004-05-03 20:45:30 +000047311. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004732 "boards.cfg" file, using the existing entries as examples.
4733 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000047342. Create a new directory to hold your board specific code. Add any
4735 files you need. In your board directory, you will need at least
4736 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
47373. Create a new configuration file "include/configs/<board>.h" for
4738 your board
47393. If you're porting U-Boot to a new CPU, then also create a new
4740 directory to hold your CPU specific code. Add any files you need.
47414. Run "make <board>_config" with your new name.
47425. Type "make", and you should get a working "u-boot.srec" file
4743 to be installed on your target system.
47446. Debug and solve any problems that might arise.
4745 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004746
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4749==============================================================
wdenkc6097192002-11-03 00:24:07 +00004750
Wolfgang Denk218ca722008-03-26 10:40:12 +01004751If you have modified U-Boot sources (for instance added a new board
4752or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004753provide feedback to the other developers. The feedback normally takes
4754the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004755official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004756
Wolfgang Denk218ca722008-03-26 10:40:12 +01004757But before you submit such a patch, please verify that your modifi-
4758cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004759the supported boards compile WITHOUT ANY compiler warnings. To do so,
4760just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004761for ALL supported system. Be warned, this will take a while. You can
4762select which (cross) compiler to use by passing a `CROSS_COMPILE'
4763environment variable to the script, i. e. to use the ELDK cross tools
4764you can type
wdenkc6097192002-11-03 00:24:07 +00004765
wdenk2729af92004-05-03 20:45:30 +00004766 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004767
wdenk2729af92004-05-03 20:45:30 +00004768or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk2729af92004-05-03 20:45:30 +00004770 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004771
Wolfgang Denk218ca722008-03-26 10:40:12 +01004772When using the MAKEALL script, the default behaviour is to build
4773U-Boot in the source directory. This location can be changed by
4774setting the BUILD_DIR environment variable. Also, for each target
4775built, the MAKEALL script saves two log files (<target>.ERR and
4776<target>.MAKEALL) in the <source dir>/LOG directory. This default
4777location can be changed by setting the MAKEALL_LOGDIR environment
4778variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004779
4780 export BUILD_DIR=/tmp/build
4781 export MAKEALL_LOGDIR=/tmp/log
4782 CROSS_COMPILE=ppc_8xx- MAKEALL
4783
Wolfgang Denk218ca722008-03-26 10:40:12 +01004784With the above settings build objects are saved in the /tmp/build,
4785log files are saved in the /tmp/log and the source tree remains clean
4786during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004787
4788
wdenk2729af92004-05-03 20:45:30 +00004789See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004790
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792Monitor Commands - Overview:
4793============================
wdenkc6097192002-11-03 00:24:07 +00004794
wdenk2729af92004-05-03 20:45:30 +00004795go - start application at address 'addr'
4796run - run commands in an environment variable
4797bootm - boot application image from memory
4798bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004799bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004800tftpboot- boot image via network using TFTP protocol
4801 and env variables "ipaddr" and "serverip"
4802 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004803tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004804rarpboot- boot image via network using RARP/TFTP protocol
4805diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4806loads - load S-Record file over serial line
4807loadb - load binary file over serial line (kermit mode)
4808md - memory display
4809mm - memory modify (auto-incrementing)
4810nm - memory modify (constant address)
4811mw - memory write (fill)
4812cp - memory copy
4813cmp - memory compare
4814crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004815i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004816sspi - SPI utility commands
4817base - print or set address offset
4818printenv- print environment variables
4819setenv - set environment variables
4820saveenv - save environment variables to persistent storage
4821protect - enable or disable FLASH write protection
4822erase - erase FLASH memory
4823flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004824nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004825bdinfo - print Board Info structure
4826iminfo - print header information for application image
4827coninfo - print console devices and informations
4828ide - IDE sub-system
4829loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004830loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004831mtest - simple RAM test
4832icache - enable or disable instruction cache
4833dcache - enable or disable data cache
4834reset - Perform RESET of the CPU
4835echo - echo args to console
4836version - print monitor version
4837help - print online help
4838? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004839
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841Monitor Commands - Detailed Description:
4842========================================
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844TODO.
wdenkc6097192002-11-03 00:24:07 +00004845
wdenk2729af92004-05-03 20:45:30 +00004846For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004847
4848
wdenk2729af92004-05-03 20:45:30 +00004849Environment Variables:
4850======================
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852U-Boot supports user configuration using Environment Variables which
4853can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk2729af92004-05-03 20:45:30 +00004855Environment Variables are set using "setenv", printed using
4856"printenv", and saved to Flash using "saveenv". Using "setenv"
4857without a value can be used to delete a variable from the
4858environment. As long as you don't save the environment you are
4859working with an in-memory copy. In case the Flash area containing the
4860environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004861
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004862Some configuration options can be set using Environment Variables.
4863
4864List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk2729af92004-05-03 20:45:30 +00004868 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk2729af92004-05-03 20:45:30 +00004870 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004875
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004876 bootm_low - Memory range available for image processing in the bootm
4877 command can be restricted. This variable is given as
4878 a hexadecimal number and defines lowest address allowed
4879 for use by the bootm command. See also "bootm_size"
4880 environment variable. Address defined by "bootm_low" is
4881 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004882 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4883 bootm_mapsize.
4884
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004885 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004886 This variable is given as a hexadecimal number and it
4887 defines the size of the memory region starting at base
4888 address bootm_low that is accessible by the Linux kernel
4889 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4890 as the default value if it is defined, and bootm_size is
4891 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004892
4893 bootm_size - Memory range available for image processing in the bootm
4894 command can be restricted. This variable is given as
4895 a hexadecimal number and defines the size of the region
4896 allowed for use by the bootm command. See also "bootm_low"
4897 environment variable.
4898
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004899 updatefile - Location of the software update file on a TFTP server, used
4900 by the automatic software update feature. Please refer to
4901 documentation in doc/README.update for more details.
4902
wdenk2729af92004-05-03 20:45:30 +00004903 autoload - if set to "no" (any string beginning with 'n'),
4904 "bootp" will just load perform a lookup of the
4905 configuration from the BOOTP server, but not try to
4906 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk2729af92004-05-03 20:45:30 +00004908 autostart - if set to "yes", an image loaded using the "bootp",
4909 "rarpboot", "tftpboot" or "diskboot" commands will
4910 be automatically started (by internally calling
4911 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913 If set to "no", a standalone image passed to the
4914 "bootm" command will be copied to the load address
4915 (and eventually uncompressed), but NOT be started.
4916 This can be used to load and uncompress arbitrary
4917 data.
wdenkc6097192002-11-03 00:24:07 +00004918
David A. Longa28afca2011-07-09 16:40:19 -04004919 fdt_high - if set this restricts the maximum address that the
4920 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004921 For example, if you have a system with 1 GB memory
4922 at physical address 0x10000000, while Linux kernel
4923 only recognizes the first 704 MB as low memory, you
4924 may need to set fdt_high as 0x3C000000 to have the
4925 device tree blob be copied to the maximum address
4926 of the 704 MB low memory, so that Linux kernel can
4927 access it during the boot procedure.
4928
David A. Longa28afca2011-07-09 16:40:19 -04004929 If this is set to the special value 0xFFFFFFFF then
4930 the fdt will not be copied at all on boot. For this
4931 to work it must reside in writable memory, have
4932 sufficient padding on the end of it for u-boot to
4933 add the information it needs into it, and the memory
4934 must be accessible by the kernel.
4935
Simon Glasseea63e02011-10-24 19:15:34 +00004936 fdtcontroladdr- if set this is the address of the control flattened
4937 device tree used by U-Boot when CONFIG_OF_CONTROL is
4938 defined.
4939
wdenk17ea1172004-06-06 21:51:03 +00004940 i2cfast - (PPC405GP|PPC405EP only)
4941 if set to 'y' configures Linux I2C driver for fast
4942 mode (400kHZ). This environment variable is used in
4943 initialization code. So, for changes to be effective
4944 it must be saved and board must be reset.
4945
wdenk2729af92004-05-03 20:45:30 +00004946 initrd_high - restrict positioning of initrd images:
4947 If this variable is not set, initrd images will be
4948 copied to the highest possible address in RAM; this
4949 is usually what you want since it allows for
4950 maximum initrd size. If for some reason you want to
4951 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004952 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004953 variable to a value of "no" or "off" or "0".
4954 Alternatively, you can set it to a maximum upper
4955 address to use (U-Boot will still check that it
4956 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk2729af92004-05-03 20:45:30 +00004958 For instance, when you have a system with 16 MB
4959 RAM, and want to reserve 4 MB from use by Linux,
4960 you can do this by adding "mem=12M" to the value of
4961 the "bootargs" variable. However, now you must make
4962 sure that the initrd image is placed in the first
4963 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk2729af92004-05-03 20:45:30 +00004965 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004966
wdenk2729af92004-05-03 20:45:30 +00004967 If you set initrd_high to 0xFFFFFFFF, this is an
4968 indication to U-Boot that all addresses are legal
4969 for the Linux kernel, including addresses in flash
4970 memory. In this case U-Boot will NOT COPY the
4971 ramdisk at all. This may be useful to reduce the
4972 boot time on your system, but requires that this
4973 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk2729af92004-05-03 20:45:30 +00004977 loadaddr - Default load address for commands like "bootp",
4978 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk2729af92004-05-03 20:45:30 +00004980 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004981
wdenk2729af92004-05-03 20:45:30 +00004982 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004989
Mike Frysingere2a53452011-10-02 10:01:27 +00004990 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004991
Mike Frysingere2a53452011-10-02 10:01:27 +00004992 ethact - controls which interface is currently active.
4993 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004994
Heiko Schocher48690d82010-07-20 17:45:02 +02004995 => setenv ethact FEC
4996 => ping 192.168.0.1 # traffic sent on FEC
4997 => setenv ethact SCC
4998 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004999
Matthias Fuchse1692572008-01-17 07:45:05 +01005000 ethrotate - When set to "no" U-Boot does not go through all
5001 available network interfaces.
5002 It just stays at the currently selected interface.
5003
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005004 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005005 either succeed or fail without retrying.
5006 When set to "once" the network operation will
5007 fail when all the available network interfaces
5008 are tried once without success.
5009 Useful on scripts which control the retry operation
5010 themselves.
wdenkc6097192002-11-03 00:24:07 +00005011
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005012 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005013
Simon Glass8d51aac2013-07-16 20:10:00 -07005014 silent_linux - If set then linux will be told to boot silently, by
5015 changing the console to be empty. If "yes" it will be
5016 made silent. If "no" it will not be made silent. If
5017 unset, then it will be made silent if the U-Boot console
5018 is silent.
5019
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005020 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005021 UDP source port.
5022
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005023 tftpdstport - If this is set, the value is used for TFTP's UDP
5024 destination port instead of the Well Know Port 69.
5025
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005026 tftpblocksize - Block size to use for TFTP transfers; if not set,
5027 we use the TFTP server's default block size
5028
5029 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5030 seconds, minimum value is 1000 = 1 second). Defines
5031 when a packet is considered to be lost so it has to
5032 be retransmitted. The default is 5000 = 5 seconds.
5033 Lowering this value may make downloads succeed
5034 faster in networks with high packet loss rates or
5035 with unreliable TFTP servers.
5036
5037 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005038 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005039 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005040
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005041The following image location variables contain the location of images
5042used in booting. The "Image" column gives the role of the image and is
5043not an environment variable name. The other columns are environment
5044variable names. "File Name" gives the name of the file on a TFTP
5045server, "RAM Address" gives the location in RAM the image will be
5046loaded to, and "Flash Location" gives the image's address in NOR
5047flash or offset in NAND flash.
5048
5049*Note* - these variables don't have to be defined for all boards, some
5050boards currenlty use other variables for these purposes, and some
5051boards use these variables for other purposes.
5052
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005053Image File Name RAM Address Flash Location
5054----- --------- ----------- --------------
5055u-boot u-boot u-boot_addr_r u-boot_addr
5056Linux kernel bootfile kernel_addr_r kernel_addr
5057device tree blob fdtfile fdt_addr_r fdt_addr
5058ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005059
wdenk2729af92004-05-03 20:45:30 +00005060The following environment variables may be used and automatically
5061updated by the network boot commands ("bootp" and "rarpboot"),
5062depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005063
wdenk2729af92004-05-03 20:45:30 +00005064 bootfile - see above
5065 dnsip - IP address of your Domain Name Server
5066 dnsip2 - IP address of your secondary Domain Name Server
5067 gatewayip - IP address of the Gateway (Router) to use
5068 hostname - Target hostname
5069 ipaddr - see above
5070 netmask - Subnet Mask
5071 rootpath - Pathname of the root filesystem on the NFS server
5072 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005073
wdenka3d991b2004-04-15 21:48:45 +00005074
wdenk2729af92004-05-03 20:45:30 +00005075There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077 serial# - contains hardware identification information such
5078 as type string and/or serial number
5079 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk2729af92004-05-03 20:45:30 +00005081These variables can be set only once (usually during manufacturing of
5082the board). U-Boot refuses to delete or overwrite these variables
5083once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005084
5085
wdenk2729af92004-05-03 20:45:30 +00005086Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk2729af92004-05-03 20:45:30 +00005088 ver - Contains the U-Boot version string as printed
5089 with the "version" command. This variable is
5090 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005091
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093Please note that changes to some configuration parameters may take
5094only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005095
stroesec1551ea2003-04-04 15:53:41 +00005096
Joe Hershberger170ab112012-12-11 22:16:24 -06005097Callback functions for environment variables:
5098---------------------------------------------
5099
5100For some environment variables, the behavior of u-boot needs to change
5101when their values are changed. This functionailty allows functions to
5102be associated with arbitrary variables. On creation, overwrite, or
5103deletion, the callback will provide the opportunity for some side
5104effect to happen or for the change to be rejected.
5105
5106The callbacks are named and associated with a function using the
5107U_BOOT_ENV_CALLBACK macro in your board or driver code.
5108
5109These callbacks are associated with variables in one of two ways. The
5110static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5111in the board configuration to a string that defines a list of
5112associations. The list must be in the following format:
5113
5114 entry = variable_name[:callback_name]
5115 list = entry[,list]
5116
5117If the callback name is not specified, then the callback is deleted.
5118Spaces are also allowed anywhere in the list.
5119
5120Callbacks can also be associated by defining the ".callbacks" variable
5121with the same list format above. Any association in ".callbacks" will
5122override any association in the static list. You can define
5123CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5124".callbacks" envirnoment variable in the default or embedded environment.
5125
5126
wdenk2729af92004-05-03 20:45:30 +00005127Command Line Parsing:
5128=====================
stroesec1551ea2003-04-04 15:53:41 +00005129
wdenk2729af92004-05-03 20:45:30 +00005130There are two different command line parsers available with U-Boot:
5131the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005132
wdenk2729af92004-05-03 20:45:30 +00005133Old, simple command line parser:
5134--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk2729af92004-05-03 20:45:30 +00005136- supports environment variables (through setenv / saveenv commands)
5137- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005138- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005139- special characters ('$', ';') can be escaped by prefixing with '\',
5140 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005141 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005142- You can also escape text by enclosing in single apostrophes, for example:
5143 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145Hush shell:
5146-----------
wdenkf07771c2003-05-28 08:06:31 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148- similar to Bourne shell, with control structures like
5149 if...then...else...fi, for...do...done; while...do...done,
5150 until...do...done, ...
5151- supports environment ("global") variables (through setenv / saveenv
5152 commands) and local shell variables (through standard shell syntax
5153 "name=value"); only environment variables can be used with "run"
5154 command
wdenkf07771c2003-05-28 08:06:31 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156General rules:
5157--------------
wdenkf07771c2003-05-28 08:06:31 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159(1) If a command line (or an environment variable executed by a "run"
5160 command) contains several commands separated by semicolon, and
5161 one of these commands fails, then the remaining commands will be
5162 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005165 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005166 command will cause "run" to terminate, i. e. the remaining
5167 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005168
wdenk2729af92004-05-03 20:45:30 +00005169Note for Redundant Ethernet Interfaces:
5170=======================================
wdenkf07771c2003-05-28 08:06:31 +00005171
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005172Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005173such configurations and is capable of automatic selection of a
5174"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5177MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5178"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005179
wdenk2729af92004-05-03 20:45:30 +00005180If the network interface stores some valid MAC address (for instance
5181in SROM), this is used as default address if there is NO correspon-
5182ding setting in the environment; if the corresponding environment
5183variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185o If the SROM has a valid MAC address, and there is no address in the
5186 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk2729af92004-05-03 20:45:30 +00005188o If there is no valid address in the SROM, and a definition in the
5189 environment exists, then the value from the environment variable is
5190 used.
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192o If both the SROM and the environment contain a MAC address, and
5193 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195o If both the SROM and the environment contain a MAC address, and the
5196 addresses differ, the value from the environment is used and a
5197 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005198
wdenk2729af92004-05-03 20:45:30 +00005199o If neither SROM nor the environment contain a MAC address, an error
5200 is raised.
wdenkc6097192002-11-03 00:24:07 +00005201
Ben Warrenecee9322010-04-26 11:11:46 -07005202If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005203will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005204may be skipped by setting the appropriate 'ethmacskip' environment variable.
5205The naming convention is as follows:
5206"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk2729af92004-05-03 20:45:30 +00005208Image Formats:
5209==============
wdenkc6097192002-11-03 00:24:07 +00005210
Marian Balakowicz3310c542008-03-12 12:13:13 +01005211U-Boot is capable of booting (and performing other auxiliary operations on)
5212images in two formats:
5213
5214New uImage format (FIT)
5215-----------------------
5216
5217Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5218to Flattened Device Tree). It allows the use of images with multiple
5219components (several kernels, ramdisks, etc.), with contents protected by
5220SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5221
5222
5223Old uImage format
5224-----------------
5225
5226Old image format is based on binary files which can be basically anything,
5227preceded by a special header; see the definitions in include/image.h for
5228details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5231 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005232 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5233 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5234 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005235* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005236 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5237 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005238* Compression Type (uncompressed, gzip, bzip2)
5239* Load Address
5240* Entry Point
5241* Image Name
5242* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244The header is marked by a special Magic Number, and both the header
5245and the data portions of the image are secured against corruption by
5246CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005247
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk2729af92004-05-03 20:45:30 +00005249Linux Support:
5250==============
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk2729af92004-05-03 20:45:30 +00005252Although U-Boot should support any OS or standalone application
5253easily, the main focus has always been on Linux during the design of
5254U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk2729af92004-05-03 20:45:30 +00005256U-Boot includes many features that so far have been part of some
5257special "boot loader" code within the Linux kernel. Also, any
5258"initrd" images to be used are no longer part of one big Linux image;
5259instead, kernel and "initrd" are separate images. This implementation
5260serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262- the same features can be used for other OS or standalone
5263 applications (for instance: using compressed images to reduce the
5264 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266- it becomes much easier to port new Linux kernel versions because
5267 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269- the same Linux kernel image can now be used with different "initrd"
5270 images; of course this also means that different kernel images can
5271 be run with the same "initrd". This makes testing easier (you don't
5272 have to build a new "zImage.initrd" Linux image when you just
5273 change a file in your "initrd"). Also, a field-upgrade of the
5274 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk2729af92004-05-03 20:45:30 +00005277Linux HOWTO:
5278============
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk2729af92004-05-03 20:45:30 +00005280Porting Linux to U-Boot based systems:
5281---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk2729af92004-05-03 20:45:30 +00005283U-Boot cannot save you from doing all the necessary modifications to
5284configure the Linux device drivers for use with your target hardware
5285(no, we don't intend to provide a full virtual machine interface to
5286Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005287
Stefan Roesea47a12b2010-04-15 16:07:28 +02005288But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005289
wdenk2729af92004-05-03 20:45:30 +00005290Just make sure your machine specific header file (for instance
5291include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005292Information structure as we define in include/asm-<arch>/u-boot.h,
5293and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005294as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005295
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297Configuring the Linux kernel:
5298-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300No specific requirements for U-Boot. Make sure you have some root
5301device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005302
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk2729af92004-05-03 20:45:30 +00005304Building a Linux Image:
5305-----------------------
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk2729af92004-05-03 20:45:30 +00005307With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5308not used. If you use recent kernel source, a new build target
5309"uImage" will exist which automatically builds an image usable by
5310U-Boot. Most older kernels also have support for a "pImage" target,
5311which was introduced for our predecessor project PPCBoot and uses a
5312100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314Example:
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk2729af92004-05-03 20:45:30 +00005316 make TQM850L_config
5317 make oldconfig
5318 make dep
5319 make uImage
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk2729af92004-05-03 20:45:30 +00005321The "uImage" build target uses a special tool (in 'tools/mkimage') to
5322encapsulate a compressed Linux kernel image with header information,
5323CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk2729af92004-05-03 20:45:30 +00005325* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk2729af92004-05-03 20:45:30 +00005327* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005328
wdenk2729af92004-05-03 20:45:30 +00005329 ${CROSS_COMPILE}-objcopy -O binary \
5330 -R .note -R .comment \
5331 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk2729af92004-05-03 20:45:30 +00005333* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk2729af92004-05-03 20:45:30 +00005335 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk2729af92004-05-03 20:45:30 +00005337* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005338
wdenk2729af92004-05-03 20:45:30 +00005339 mkimage -A ppc -O linux -T kernel -C gzip \
5340 -a 0 -e 0 -n "Linux Kernel Image" \
5341 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005342
wdenk24ee89b2002-11-03 17:56:27 +00005343
wdenk2729af92004-05-03 20:45:30 +00005344The "mkimage" tool can also be used to create ramdisk images for use
5345with U-Boot, either separated from the Linux kernel image, or
5346combined into one file. "mkimage" encapsulates the images with a 64
5347byte header containing information about target architecture,
5348operating system, image type, compression method, entry points, time
5349stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351"mkimage" can be called in two ways: to verify existing images and
5352print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005353
wdenk2729af92004-05-03 20:45:30 +00005354In the first form (with "-l" option) mkimage lists the information
5355contained in the header of an existing U-Boot image; this includes
5356checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005357
wdenk2729af92004-05-03 20:45:30 +00005358 tools/mkimage -l image
5359 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005360
wdenk2729af92004-05-03 20:45:30 +00005361The second form (with "-d" option) is used to build a U-Boot image
5362from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5365 -n name -d data_file image
5366 -A ==> set architecture to 'arch'
5367 -O ==> set operating system to 'os'
5368 -T ==> set image type to 'type'
5369 -C ==> set compression type 'comp'
5370 -a ==> set load address to 'addr' (hex)
5371 -e ==> set entry point to 'ep' (hex)
5372 -n ==> set image name to 'name'
5373 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005374
wdenk69459792004-05-29 16:53:29 +00005375Right now, all Linux kernels for PowerPC systems use the same load
5376address (0x00000000), but the entry point address depends on the
5377kernel version:
wdenkc6097192002-11-03 00:24:07 +00005378
wdenk2729af92004-05-03 20:45:30 +00005379- 2.2.x kernels have the entry point at 0x0000000C,
5380- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk2729af92004-05-03 20:45:30 +00005382So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5385 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005386 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005387 > examples/uImage.TQM850L
5388 Image Name: 2.4.4 kernel for TQM850L
5389 Created: Wed Jul 19 02:34:59 2000
5390 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5391 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5392 Load Address: 0x00000000
5393 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005396
wdenk2729af92004-05-03 20:45:30 +00005397 -> tools/mkimage -l examples/uImage.TQM850L
5398 Image Name: 2.4.4 kernel for TQM850L
5399 Created: Wed Jul 19 02:34:59 2000
5400 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5401 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5402 Load Address: 0x00000000
5403 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk2729af92004-05-03 20:45:30 +00005405NOTE: for embedded systems where boot time is critical you can trade
5406speed for memory and install an UNCOMPRESSED image instead: this
5407needs more space in Flash, but boots much faster since it does not
5408need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005409
Stefan Roesea47a12b2010-04-15 16:07:28 +02005410 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005411 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5412 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005413 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005414 > examples/uImage.TQM850L-uncompressed
5415 Image Name: 2.4.4 kernel for TQM850L
5416 Created: Wed Jul 19 02:34:59 2000
5417 Image Type: PowerPC Linux Kernel Image (uncompressed)
5418 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5419 Load Address: 0x00000000
5420 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005421
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5424when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005425
wdenk2729af92004-05-03 20:45:30 +00005426 -> tools/mkimage -n 'Simple Ramdisk Image' \
5427 > -A ppc -O linux -T ramdisk -C gzip \
5428 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5429 Image Name: Simple Ramdisk Image
5430 Created: Wed Jan 12 14:01:50 2000
5431 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5432 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5433 Load Address: 0x00000000
5434 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005435
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005436The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5437option performs the converse operation of the mkimage's second form (the "-d"
5438option). Given an image built by mkimage, the dumpimage extracts a "data file"
5439from the image:
5440
5441 tools/dumpimage -i image -p position data_file
5442 -i ==> extract from the 'image' a specific 'data_file', \
5443 indexed by 'position'
5444
wdenkdb01a2e2004-04-15 23:14:49 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446Installing a Linux Image:
5447-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005448
wdenk2729af92004-05-03 20:45:30 +00005449To downloading a U-Boot image over the serial (console) interface,
5450you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005451
wdenk2729af92004-05-03 20:45:30 +00005452 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005453
wdenk2729af92004-05-03 20:45:30 +00005454The 'objcopy' does not understand the information in the U-Boot
5455image header, so the resulting S-Record file will be relative to
5456address 0x00000000. To load it to a given address, you need to
5457specify the target address as 'offset' parameter with the 'loads'
5458command.
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk2729af92004-05-03 20:45:30 +00005460Example: install the image to address 0x40100000 (which on the
5461TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005462
wdenk2729af92004-05-03 20:45:30 +00005463 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk2729af92004-05-03 20:45:30 +00005465 .......... done
5466 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk2729af92004-05-03 20:45:30 +00005468 => loads 40100000
5469 ## Ready for S-Record download ...
5470 ~>examples/image.srec
5471 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5472 ...
5473 15989 15990 15991 15992
5474 [file transfer complete]
5475 [connected]
5476 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005477
5478
wdenk2729af92004-05-03 20:45:30 +00005479You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005480this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005481corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005482
wdenk2729af92004-05-03 20:45:30 +00005483 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk2729af92004-05-03 20:45:30 +00005485 ## Checking Image at 40100000 ...
5486 Image Name: 2.2.13 for initrd on TQM850L
5487 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5488 Data Size: 335725 Bytes = 327 kB = 0 MB
5489 Load Address: 00000000
5490 Entry Point: 0000000c
5491 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005492
5493
wdenk2729af92004-05-03 20:45:30 +00005494Boot Linux:
5495-----------
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk2729af92004-05-03 20:45:30 +00005497The "bootm" command is used to boot an application that is stored in
5498memory (RAM or Flash). In case of a Linux kernel image, the contents
5499of the "bootargs" environment variable is passed to the kernel as
5500parameters. You can check and modify this variable using the
5501"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005502
5503
wdenk2729af92004-05-03 20:45:30 +00005504 => printenv bootargs
5505 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk2729af92004-05-03 20:45:30 +00005507 => 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 +00005508
wdenk2729af92004-05-03 20:45:30 +00005509 => printenv bootargs
5510 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 +00005511
wdenk2729af92004-05-03 20:45:30 +00005512 => bootm 40020000
5513 ## Booting Linux kernel at 40020000 ...
5514 Image Name: 2.2.13 for NFS on TQM850L
5515 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5516 Data Size: 381681 Bytes = 372 kB = 0 MB
5517 Load Address: 00000000
5518 Entry Point: 0000000c
5519 Verifying Checksum ... OK
5520 Uncompressing Kernel Image ... OK
5521 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
5522 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5523 time_init: decrementer frequency = 187500000/60
5524 Calibrating delay loop... 49.77 BogoMIPS
5525 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5526 ...
wdenkc6097192002-11-03 00:24:07 +00005527
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005528If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005529the memory addresses of both the kernel and the initrd image (PPBCOOT
5530format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk2729af92004-05-03 20:45:30 +00005532 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk2729af92004-05-03 20:45:30 +00005534 ## Checking Image at 40100000 ...
5535 Image Name: 2.2.13 for initrd on TQM850L
5536 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5537 Data Size: 335725 Bytes = 327 kB = 0 MB
5538 Load Address: 00000000
5539 Entry Point: 0000000c
5540 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005541
wdenk2729af92004-05-03 20:45:30 +00005542 ## Checking Image at 40200000 ...
5543 Image Name: Simple Ramdisk Image
5544 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5545 Data Size: 566530 Bytes = 553 kB = 0 MB
5546 Load Address: 00000000
5547 Entry Point: 00000000
5548 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550 => bootm 40100000 40200000
5551 ## Booting Linux kernel at 40100000 ...
5552 Image Name: 2.2.13 for initrd on TQM850L
5553 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5554 Data Size: 335725 Bytes = 327 kB = 0 MB
5555 Load Address: 00000000
5556 Entry Point: 0000000c
5557 Verifying Checksum ... OK
5558 Uncompressing Kernel Image ... OK
5559 ## Loading RAMDisk Image at 40200000 ...
5560 Image Name: Simple Ramdisk Image
5561 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5562 Data Size: 566530 Bytes = 553 kB = 0 MB
5563 Load Address: 00000000
5564 Entry Point: 00000000
5565 Verifying Checksum ... OK
5566 Loading Ramdisk ... OK
5567 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
5568 Boot arguments: root=/dev/ram
5569 time_init: decrementer frequency = 187500000/60
5570 Calibrating delay loop... 49.77 BogoMIPS
5571 ...
5572 RAMDISK: Compressed image found at block 0
5573 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk2729af92004-05-03 20:45:30 +00005575 bash#
wdenkc6097192002-11-03 00:24:07 +00005576
Matthew McClintock02677682006-06-28 10:41:37 -05005577Boot Linux and pass a flat device tree:
5578-----------
5579
5580First, U-Boot must be compiled with the appropriate defines. See the section
5581titled "Linux Kernel Interface" above for a more in depth explanation. The
5582following is an example of how to start a kernel and pass an updated
5583flat device tree:
5584
5585=> print oftaddr
5586oftaddr=0x300000
5587=> print oft
5588oft=oftrees/mpc8540ads.dtb
5589=> tftp $oftaddr $oft
5590Speed: 1000, full duplex
5591Using TSEC0 device
5592TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5593Filename 'oftrees/mpc8540ads.dtb'.
5594Load address: 0x300000
5595Loading: #
5596done
5597Bytes transferred = 4106 (100a hex)
5598=> tftp $loadaddr $bootfile
5599Speed: 1000, full duplex
5600Using TSEC0 device
5601TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5602Filename 'uImage'.
5603Load address: 0x200000
5604Loading:############
5605done
5606Bytes transferred = 1029407 (fb51f hex)
5607=> print loadaddr
5608loadaddr=200000
5609=> print oftaddr
5610oftaddr=0x300000
5611=> bootm $loadaddr - $oftaddr
5612## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005613 Image Name: Linux-2.6.17-dirty
5614 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5615 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005616 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005617 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005618 Verifying Checksum ... OK
5619 Uncompressing Kernel Image ... OK
5620Booting using flat device tree at 0x300000
5621Using MPC85xx ADS machine description
5622Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5623[snip]
5624
5625
wdenk2729af92004-05-03 20:45:30 +00005626More About U-Boot Image Types:
5627------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005628
wdenk2729af92004-05-03 20:45:30 +00005629U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631 "Standalone Programs" are directly runnable in the environment
5632 provided by U-Boot; it is expected that (if they behave
5633 well) you can continue to work in U-Boot after return from
5634 the Standalone Program.
5635 "OS Kernel Images" are usually images of some Embedded OS which
5636 will take over control completely. Usually these programs
5637 will install their own set of exception handlers, device
5638 drivers, set up the MMU, etc. - this means, that you cannot
5639 expect to re-enter U-Boot except by resetting the CPU.
5640 "RAMDisk Images" are more or less just data blocks, and their
5641 parameters (address, size) are passed to an OS kernel that is
5642 being started.
5643 "Multi-File Images" contain several images, typically an OS
5644 (Linux) kernel image and one or more data images like
5645 RAMDisks. This construct is useful for instance when you want
5646 to boot over the network using BOOTP etc., where the boot
5647 server provides just a single image file, but you want to get
5648 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005649
wdenk2729af92004-05-03 20:45:30 +00005650 "Multi-File Images" start with a list of image sizes, each
5651 image size (in bytes) specified by an "uint32_t" in network
5652 byte order. This list is terminated by an "(uint32_t)0".
5653 Immediately after the terminating 0 follow the images, one by
5654 one, all aligned on "uint32_t" boundaries (size rounded up to
5655 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005656
wdenk2729af92004-05-03 20:45:30 +00005657 "Firmware Images" are binary images containing firmware (like
5658 U-Boot or FPGA images) which usually will be programmed to
5659 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005660
wdenk2729af92004-05-03 20:45:30 +00005661 "Script files" are command sequences that will be executed by
5662 U-Boot's command interpreter; this feature is especially
5663 useful when you configure U-Boot to use a real shell (hush)
5664 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005665
Marek Vasut44f074c2012-03-14 21:52:45 +00005666Booting the Linux zImage:
5667-------------------------
5668
5669On some platforms, it's possible to boot Linux zImage. This is done
5670using the "bootz" command. The syntax of "bootz" command is the same
5671as the syntax of "bootm" command.
5672
Tom Rini8ac28562013-05-16 11:40:11 -04005673Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005674kernel with raw initrd images. The syntax is slightly different, the
5675address of the initrd must be augmented by it's size, in the following
5676format: "<initrd addres>:<initrd size>".
5677
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk2729af92004-05-03 20:45:30 +00005679Standalone HOWTO:
5680=================
wdenkc6097192002-11-03 00:24:07 +00005681
wdenk2729af92004-05-03 20:45:30 +00005682One of the features of U-Boot is that you can dynamically load and
5683run "standalone" applications, which can use some resources of
5684U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk2729af92004-05-03 20:45:30 +00005688"Hello World" Demo:
5689-------------------
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk2729af92004-05-03 20:45:30 +00005691'examples/hello_world.c' contains a small "Hello World" Demo
5692application; it is automatically compiled when you build U-Boot.
5693It's configured to run at address 0x00040004, so you can play with it
5694like that:
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk2729af92004-05-03 20:45:30 +00005696 => loads
5697 ## Ready for S-Record download ...
5698 ~>examples/hello_world.srec
5699 1 2 3 4 5 6 7 8 9 10 11 ...
5700 [file transfer complete]
5701 [connected]
5702 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005703
wdenk2729af92004-05-03 20:45:30 +00005704 => go 40004 Hello World! This is a test.
5705 ## Starting application at 0x00040004 ...
5706 Hello World
5707 argc = 7
5708 argv[0] = "40004"
5709 argv[1] = "Hello"
5710 argv[2] = "World!"
5711 argv[3] = "This"
5712 argv[4] = "is"
5713 argv[5] = "a"
5714 argv[6] = "test."
5715 argv[7] = "<NULL>"
5716 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005717
wdenk2729af92004-05-03 20:45:30 +00005718 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005719
wdenk2729af92004-05-03 20:45:30 +00005720Another example, which demonstrates how to register a CPM interrupt
5721handler with the U-Boot code, can be found in 'examples/timer.c'.
5722Here, a CPM timer is set up to generate an interrupt every second.
5723The interrupt service routine is trivial, just printing a '.'
5724character, but this is just a demo program. The application can be
5725controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk2729af92004-05-03 20:45:30 +00005727 ? - print current values og the CPM Timer registers
5728 b - enable interrupts and start timer
5729 e - stop timer and disable interrupts
5730 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk2729af92004-05-03 20:45:30 +00005732 => loads
5733 ## Ready for S-Record download ...
5734 ~>examples/timer.srec
5735 1 2 3 4 5 6 7 8 9 10 11 ...
5736 [file transfer complete]
5737 [connected]
5738 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740 => go 40004
5741 ## Starting application at 0x00040004 ...
5742 TIMERS=0xfff00980
5743 Using timer 1
5744 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk2729af92004-05-03 20:45:30 +00005746Hit 'b':
5747 [q, b, e, ?] Set interval 1000000 us
5748 Enabling timer
5749Hit '?':
5750 [q, b, e, ?] ........
5751 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5752Hit '?':
5753 [q, b, e, ?] .
5754 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5755Hit '?':
5756 [q, b, e, ?] .
5757 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5758Hit '?':
5759 [q, b, e, ?] .
5760 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5761Hit 'e':
5762 [q, b, e, ?] ...Stopping timer
5763Hit 'q':
5764 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005765
5766
wdenk2729af92004-05-03 20:45:30 +00005767Minicom warning:
5768================
wdenk85ec0bc2003-03-31 16:34:49 +00005769
wdenk2729af92004-05-03 20:45:30 +00005770Over time, many people have reported problems when trying to use the
5771"minicom" terminal emulation program for serial download. I (wd)
5772consider minicom to be broken, and recommend not to use it. Under
5773Unix, I recommend to use C-Kermit for general purpose use (and
5774especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005775use "cu" for S-Record download ("loads" command). See
5776http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5777for help with kermit.
5778
wdenk85ec0bc2003-03-31 16:34:49 +00005779
wdenk2729af92004-05-03 20:45:30 +00005780Nevertheless, if you absolutely want to use it try adding this
5781configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005782
wdenk2729af92004-05-03 20:45:30 +00005783 Name Program Name U/D FullScr IO-Red. Multi
5784 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5785 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005786
5787
wdenk2729af92004-05-03 20:45:30 +00005788NetBSD Notes:
5789=============
wdenkc6097192002-11-03 00:24:07 +00005790
wdenk2729af92004-05-03 20:45:30 +00005791Starting at version 0.9.2, U-Boot supports NetBSD both as host
5792(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk2729af92004-05-03 20:45:30 +00005794Building requires a cross environment; it is known to work on
5795NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5796need gmake since the Makefiles are not compatible with BSD make).
5797Note that the cross-powerpc package does not install include files;
5798attempting to build U-Boot will fail because <machine/ansi.h> is
5799missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk2729af92004-05-03 20:45:30 +00005801 # cd /usr/pkg/cross/powerpc-netbsd/include
5802 # mkdir powerpc
5803 # ln -s powerpc machine
5804 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5805 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk2729af92004-05-03 20:45:30 +00005807Native builds *don't* work due to incompatibilities between native
5808and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005809
wdenk2729af92004-05-03 20:45:30 +00005810Booting assumes that (the first part of) the image booted is a
5811stage-2 loader which in turn loads and then invokes the kernel
5812proper. Loader sources will eventually appear in the NetBSD source
5813tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005814meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005815
5816
wdenk2729af92004-05-03 20:45:30 +00005817Implementation Internals:
5818=========================
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk2729af92004-05-03 20:45:30 +00005820The following is not intended to be a complete description of every
5821implementation detail. However, it should help to understand the
5822inner workings of U-Boot and make it easier to port it to custom
5823hardware.
wdenkc6097192002-11-03 00:24:07 +00005824
5825
wdenk2729af92004-05-03 20:45:30 +00005826Initial Stack, Global Data:
5827---------------------------
wdenkc6097192002-11-03 00:24:07 +00005828
wdenk2729af92004-05-03 20:45:30 +00005829The implementation of U-Boot is complicated by the fact that U-Boot
5830starts running out of ROM (flash memory), usually without access to
5831system RAM (because the memory controller is not initialized yet).
5832This means that we don't have writable Data or BSS segments, and BSS
5833is not initialized as zero. To be able to get a C environment working
5834at all, we have to allocate at least a minimal stack. Implementation
5835options for this are defined and restricted by the CPU used: Some CPU
5836models provide on-chip memory (like the IMMR area on MPC8xx and
5837MPC826x processors), on others (parts of) the data cache can be
5838locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005839
Wolfgang Denk218ca722008-03-26 10:40:12 +01005840 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005841 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005842
wdenk2729af92004-05-03 20:45:30 +00005843 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5844 From: "Chris Hallinan" <clh@net1plus.com>
5845 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5846 ...
wdenk43d96162003-03-06 00:02:04 +00005847
wdenk2729af92004-05-03 20:45:30 +00005848 Correct me if I'm wrong, folks, but the way I understand it
5849 is this: Using DCACHE as initial RAM for Stack, etc, does not
5850 require any physical RAM backing up the cache. The cleverness
5851 is that the cache is being used as a temporary supply of
5852 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005853 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005854 can see how this works by studying the cache architecture and
5855 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005856
wdenk2729af92004-05-03 20:45:30 +00005857 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5858 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005859 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005860 option should work for you. Using CS 4 should be fine if your
5861 board designers haven't used it for something that would
5862 cause you grief during the initial boot! It is frequently not
5863 used.
wdenk43d96162003-03-06 00:02:04 +00005864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005865 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005866 with your processor/board/system design. The default value
5867 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005868 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005869 than your SDRAM module. If you have a 64MB SDRAM module, set
5870 it above 400_0000. Just make sure your board has no resources
5871 that are supposed to respond to that address! That code in
5872 start.S has been around a while and should work as is when
5873 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005874
wdenk2729af92004-05-03 20:45:30 +00005875 -Chris Hallinan
5876 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005877
wdenk2729af92004-05-03 20:45:30 +00005878It is essential to remember this, since it has some impact on the C
5879code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk2729af92004-05-03 20:45:30 +00005881* Initialized global data (data segment) is read-only. Do not attempt
5882 to write it.
wdenkc6097192002-11-03 00:24:07 +00005883
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005884* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005885 as zero data - BSS segment) at all - this is undefined, initiali-
5886 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888* Stack space is very limited. Avoid big data buffers or things like
5889 that.
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk2729af92004-05-03 20:45:30 +00005891Having only the stack as writable memory limits means we cannot use
5892normal global data to share information beween the code. But it
5893turned out that the implementation of U-Boot can be greatly
5894simplified by making a global data structure (gd_t) available to all
5895functions. We could pass a pointer to this data as argument to _all_
5896functions, but this would bloat the code. Instead we use a feature of
5897the GCC compiler (Global Register Variables) to share the data: we
5898place a pointer (gd) to the global data into a register which we
5899reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005900
wdenk2729af92004-05-03 20:45:30 +00005901When choosing a register for such a purpose we are restricted by the
5902relevant (E)ABI specifications for the current architecture, and by
5903GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk2729af92004-05-03 20:45:30 +00005905For PowerPC, the following registers have specific use:
5906 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005907 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005908 R3-R4: parameter passing and return values
5909 R5-R10: parameter passing
5910 R13: small data area pointer
5911 R30: GOT pointer
5912 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005913
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005914 (U-Boot also uses R12 as internal GOT pointer. r12
5915 is a volatile register so r12 needs to be reset when
5916 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005917
Wolfgang Denke7670f62008-02-14 22:43:22 +01005918 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005919
wdenk2729af92004-05-03 20:45:30 +00005920 Note: on PPC, we could use a static initializer (since the
5921 address of the global data structure is known at compile time),
5922 but it turned out that reserving a register results in somewhat
5923 smaller code - although the code savings are not that big (on
5924 average for all boards 752 bytes for the whole U-Boot image,
5925 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005926
Robin Getzc4db3352009-08-17 15:23:02 +00005927On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005928 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5929
Robin Getzc4db3352009-08-17 15:23:02 +00005930 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005931
wdenk2729af92004-05-03 20:45:30 +00005932On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk2729af92004-05-03 20:45:30 +00005934 R0: function argument word/integer result
5935 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005936 R9: platform specific
5937 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005938 R11: argument (frame) pointer
5939 R12: temporary workspace
5940 R13: stack pointer
5941 R14: link register
5942 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005943
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005944 ==> U-Boot will use R9 to hold a pointer to the global data
5945
5946 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005947
Thomas Chou0df01fd2010-05-21 11:08:03 +08005948On Nios II, the ABI is documented here:
5949 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5950
5951 ==> U-Boot will use gp to hold a pointer to the global data
5952
5953 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5954 to access small data sections, so gp is free.
5955
Macpaul Linafc1ce82011-10-19 20:41:11 +00005956On NDS32, the following registers are used:
5957
5958 R0-R1: argument/return
5959 R2-R5: argument
5960 R15: temporary register for assembler
5961 R16: trampoline register
5962 R28: frame pointer (FP)
5963 R29: global pointer (GP)
5964 R30: link register (LP)
5965 R31: stack pointer (SP)
5966 PC: program counter (PC)
5967
5968 ==> U-Boot will use R10 to hold a pointer to the global data
5969
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005970NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5971or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005972
wdenk2729af92004-05-03 20:45:30 +00005973Memory Management:
5974------------------
wdenkc6097192002-11-03 00:24:07 +00005975
wdenk2729af92004-05-03 20:45:30 +00005976U-Boot runs in system state and uses physical addresses, i.e. the
5977MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk2729af92004-05-03 20:45:30 +00005979The available memory is mapped to fixed addresses using the memory
5980controller. In this process, a contiguous block is formed for each
5981memory type (Flash, SDRAM, SRAM), even when it consists of several
5982physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005983
wdenk2729af92004-05-03 20:45:30 +00005984U-Boot is installed in the first 128 kB of the first Flash bank (on
5985TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5986booting and sizing and initializing DRAM, the code relocates itself
5987to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005988memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005989configuration setting]. Below that, a structure with global Board
5990Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005991
wdenk2729af92004-05-03 20:45:30 +00005992Additionally, some exception handler code is copied to the low 8 kB
5993of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005994
wdenk2729af92004-05-03 20:45:30 +00005995So a typical memory configuration with 16 MB of DRAM could look like
5996this:
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk2729af92004-05-03 20:45:30 +00005998 0x0000 0000 Exception Vector code
5999 :
6000 0x0000 1FFF
6001 0x0000 2000 Free for Application Use
6002 :
6003 :
wdenkc6097192002-11-03 00:24:07 +00006004
wdenk2729af92004-05-03 20:45:30 +00006005 :
6006 :
6007 0x00FB FF20 Monitor Stack (Growing downward)
6008 0x00FB FFAC Board Info Data and permanent copy of global data
6009 0x00FC 0000 Malloc Arena
6010 :
6011 0x00FD FFFF
6012 0x00FE 0000 RAM Copy of Monitor Code
6013 ... eventually: LCD or video framebuffer
6014 ... eventually: pRAM (Protected RAM - unchanged by reset)
6015 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006016
6017
wdenk2729af92004-05-03 20:45:30 +00006018System Initialization:
6019----------------------
wdenkc6097192002-11-03 00:24:07 +00006020
wdenk2729af92004-05-03 20:45:30 +00006021In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006022(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00006023configuration for CS0# this is a mirror of the onboard Flash memory.
6024To be able to re-map memory U-Boot then jumps to its link address.
6025To be able to implement the initialization code in C, a (small!)
6026initial stack is set up in the internal Dual Ported RAM (in case CPUs
6027which provide such a feature like MPC8xx or MPC8260), or in a locked
6028part of the data cache. After that, U-Boot initializes the CPU core,
6029the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006030
wdenk2729af92004-05-03 20:45:30 +00006031Next, all (potentially) available memory banks are mapped using a
6032preliminary mapping. For example, we put them on 512 MB boundaries
6033(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6034on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6035programmed for SDRAM access. Using the temporary configuration, a
6036simple memory test is run that determines the size of the SDRAM
6037banks.
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk2729af92004-05-03 20:45:30 +00006039When there is more than one SDRAM bank, and the banks are of
6040different size, the largest is mapped first. For equal size, the first
6041bank (CS2#) is mapped first. The first mapping is always for address
60420x00000000, with any additional banks following immediately to create
6043contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006044
wdenk2729af92004-05-03 20:45:30 +00006045Then, the monitor installs itself at the upper end of the SDRAM area
6046and allocates memory for use by malloc() and for the global Board
6047Info data; also, the exception vector code is copied to the low RAM
6048pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk2729af92004-05-03 20:45:30 +00006050Only after this relocation will you have a "normal" C environment;
6051until that you are restricted in several ways, mostly because you are
6052running from ROM, and because the code will have to be relocated to a
6053new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006054
6055
wdenk2729af92004-05-03 20:45:30 +00006056U-Boot Porting Guide:
6057----------------------
wdenkc6097192002-11-03 00:24:07 +00006058
wdenk2729af92004-05-03 20:45:30 +00006059[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6060list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006061
6062
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006063int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006064{
6065 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006066
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006067 signal(SIGALRM, no_more_time);
6068 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006069
wdenk2729af92004-05-03 20:45:30 +00006070 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006071 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006072 return 0;
6073 }
6074
wdenk2729af92004-05-03 20:45:30 +00006075 Download latest U-Boot source;
6076
Wolfgang Denk06682362008-12-30 22:56:11 +01006077 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006078
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006079 if (clueless)
6080 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006081
wdenk2729af92004-05-03 20:45:30 +00006082 while (learning) {
6083 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006084 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6085 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006086 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006087 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006088 }
wdenkc6097192002-11-03 00:24:07 +00006089
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006090 if (available_money > toLocalCurrency ($2500))
6091 Buy a BDI3000;
6092 else
wdenk2729af92004-05-03 20:45:30 +00006093 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006094
6095 if (a similar board exists) { /* hopefully... */
6096 cp -a board/<similar> board/<myboard>
6097 cp include/configs/<similar>.h include/configs/<myboard>.h
6098 } else {
6099 Create your own board support subdirectory;
6100 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006101 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006102 Edit new board/<myboard> files
6103 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006104
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006105 while (!accepted) {
6106 while (!running) {
6107 do {
6108 Add / modify source code;
6109 } until (compiles);
6110 Debug;
6111 if (clueless)
6112 email("Hi, I am having problems...");
6113 }
6114 Send patch file to the U-Boot email list;
6115 if (reasonable critiques)
6116 Incorporate improvements from email list code review;
6117 else
6118 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006119 }
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk2729af92004-05-03 20:45:30 +00006121 return 0;
6122}
6123
6124void no_more_time (int sig)
6125{
6126 hire_a_guru();
6127}
wdenkc6097192002-11-03 00:24:07 +00006128
6129
wdenk2729af92004-05-03 20:45:30 +00006130Coding Standards:
6131-----------------
wdenkc6097192002-11-03 00:24:07 +00006132
wdenk2729af92004-05-03 20:45:30 +00006133All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006134coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006135"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006136
Detlev Zundel2c051652006-09-01 15:39:02 +02006137Source files originating from a different project (for example the
6138MTD subsystem) are generally exempt from these guidelines and are not
6139reformated to ease subsequent migration to newer versions of those
6140sources.
6141
6142Please note that U-Boot is implemented in C (and to some small parts in
6143Assembler); no C++ is used, so please do not use C++ style comments (//)
6144in your code.
wdenk2729af92004-05-03 20:45:30 +00006145
6146Please also stick to the following formatting rules:
6147- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006148- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006149- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006150- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006151- do not add trailing empty lines to source files
6152
6153Submissions which do not conform to the standards may be returned
6154with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006155
6156
wdenk2729af92004-05-03 20:45:30 +00006157Submitting Patches:
6158-------------------
wdenkc6097192002-11-03 00:24:07 +00006159
wdenk2729af92004-05-03 20:45:30 +00006160Since the number of patches for U-Boot is growing, we need to
6161establish some rules. Submissions which do not conform to these rules
6162may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006163
Magnus Lilja0d28f342008-08-06 19:32:33 +02006164Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006165
Wolfgang Denk06682362008-12-30 22:56:11 +01006166Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6167see http://lists.denx.de/mailman/listinfo/u-boot
6168
wdenk2729af92004-05-03 20:45:30 +00006169When you send a patch, please include the following information with
6170it:
wdenkc6097192002-11-03 00:24:07 +00006171
wdenk2729af92004-05-03 20:45:30 +00006172* For bug fixes: a description of the bug and how your patch fixes
6173 this bug. Please try to include a way of demonstrating that the
6174 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006175
wdenk2729af92004-05-03 20:45:30 +00006176* For new features: a description of the feature and your
6177 implementation.
wdenkc6097192002-11-03 00:24:07 +00006178
wdenk2729af92004-05-03 20:45:30 +00006179* A CHANGELOG entry as plaintext (separate from the patch)
6180
6181* For major contributions, your entry to the CREDITS file
6182
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006183* When you add support for a new board, don't forget to add a
6184 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006185
6186* If your patch adds new configuration options, don't forget to
6187 document these in the README file.
6188
Wolfgang Denk218ca722008-03-26 10:40:12 +01006189* The patch itself. If you are using git (which is *strongly*
6190 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006191 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006192 the U-Boot mailing list, you will avoid most of the common problems
6193 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006194
Wolfgang Denk218ca722008-03-26 10:40:12 +01006195 If you cannot use git, use "diff -purN OLD NEW". If your version of
6196 diff does not support these options, then get the latest version of
6197 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006198
Wolfgang Denk218ca722008-03-26 10:40:12 +01006199 The current directory when running this command shall be the parent
6200 directory of the U-Boot source tree (i. e. please make sure that
6201 your patch includes sufficient directory information for the
6202 affected files).
6203
6204 We prefer patches as plain text. MIME attachments are discouraged,
6205 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006206
6207* If one logical set of modifications affects or creates several
6208 files, all these changes shall be submitted in a SINGLE patch file.
6209
6210* Changesets that contain different, unrelated modifications shall be
6211 submitted as SEPARATE patches, one patch per changeset.
6212
6213
6214Notes:
6215
6216* Before sending the patch, run the MAKEALL script on your patched
6217 source tree and make sure that no errors or warnings are reported
6218 for any of the boards.
6219
6220* Keep your modifications to the necessary minimum: A patch
6221 containing several unrelated changes or arbitrary reformats will be
6222 returned with a request to re-formatting / split it.
6223
6224* If you modify existing code, make sure that your new code does not
6225 add to the memory footprint of the code ;-) Small is beautiful!
6226 When adding new features, these should compile conditionally only
6227 (using #ifdef), and the resulting code with the new feature
6228 disabled must not need more memory than the old code without your
6229 modification.
wdenk90dc6702005-05-03 14:12:25 +00006230
Wolfgang Denk06682362008-12-30 22:56:11 +01006231* Remember that there is a size limit of 100 kB per message on the
6232 u-boot mailing list. Bigger patches will be moderated. If they are
6233 reasonable and not too big, they will be acknowledged. But patches
6234 bigger than the size limit should be avoided.