blob: d9a64ea62e22287a70a09fa0c6a00d08b5220c2f [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-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 Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
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 Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-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-VILLARD03836942008-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
Holger Freyther7ba4e572014-08-04 09:26:05 +0200255configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000256
257Example: For a TQM823L module type:
258
259 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-08-04 09:26:05 +0200263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000264directory according to the instructions in cogent/README.
265
266
Simon Glass53552c92014-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
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600276
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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wen20014762011-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)
wdenk9b7f3842003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Kushwahaa6a30622012-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 Wood80806962012-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 Kushwahad324f472013-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 Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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 Yuantiana7364af2014-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 Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun021d2022014-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 Schwierzeckd8a49ca2012-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 Sunf0626592013-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 Sun2896cb72014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun461c9392013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sunf0626592013-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 Sun2896cb72014-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 Sunf0626592013-09-30 09:22:09 -0700505
Prabhakar Kushwaha62908c22014-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 Kushwaha950f2f72014-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 Kushwaha2c27f122014-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 Sun29647ab2014-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 Sun3a0916d2014-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 Sunc459ae62014-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
York Sun79a779b2014-08-01 15:51:00 -0700541 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
542 Number of controllers used as main memory.
543
544 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
545 Number of controllers used for other than main memory.
546
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530547 CONFIG_SYS_FSL_SEC_BE
548 Defines the SEC controller register space as Big Endian
549
550 CONFIG_SYS_FSL_SEC_LE
551 Defines the SEC controller register space as Little Endian
552
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100553- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200554 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100555
556 Defines the Monahans run mode to oscillator
557 ratio. Valid values are 8, 16, 24, 31. The core
558 frequency is this value multiplied by 13 MHz.
559
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200560 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200561
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100562 Defines the Monahans turbo mode to oscillator
563 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200564 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100565 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200566
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200567- MIPS CPU options:
568 CONFIG_SYS_INIT_SP_OFFSET
569
570 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
571 pointer. This is needed for the temporary stack before
572 relocation.
573
574 CONFIG_SYS_MIPS_CACHE_MODE
575
576 Cache operation mode for the MIPS CPU.
577 See also arch/mips/include/asm/mipsregs.h.
578 Possible values are:
579 CONF_CM_CACHABLE_NO_WA
580 CONF_CM_CACHABLE_WA
581 CONF_CM_UNCACHED
582 CONF_CM_CACHABLE_NONCOHERENT
583 CONF_CM_CACHABLE_CE
584 CONF_CM_CACHABLE_COW
585 CONF_CM_CACHABLE_CUW
586 CONF_CM_CACHABLE_ACCELERATED
587
588 CONFIG_SYS_XWAY_EBU_BOOTCFG
589
590 Special option for Lantiq XWAY SoCs for booting from NOR flash.
591 See also arch/mips/cpu/mips32/start.S.
592
593 CONFIG_XWAY_SWAP_BYTES
594
595 Enable compilation of tools/xway-swap-bytes needed for Lantiq
596 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
597 be swapped if a flash programmer is used.
598
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000599- ARM options:
600 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
601
602 Select high exception vectors of the ARM core, e.g., do not
603 clear the V bit of the c1 register of CP15.
604
Aneesh Vb8e40802012-03-08 07:20:19 +0000605 CONFIG_SYS_THUMB_BUILD
606
607 Use this flag to build U-Boot using the Thumb instruction
608 set for ARM architectures. Thumb instruction set provides
609 better code density. For ARM architectures that support
610 Thumb2 this flag will result in Thumb2 code generated by
611 GCC.
612
Stephen Warrenc63c3502013-03-04 13:29:40 +0000613 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000614 CONFIG_ARM_ERRATA_742230
615 CONFIG_ARM_ERRATA_743622
616 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500617 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500618 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000619
620 If set, the workarounds for these ARM errata are applied early
621 during U-Boot startup. Note that these options force the
622 workarounds to be applied; no CPU-type/version detection
623 exists, unlike the similar options in the Linux kernel. Do not
624 set these options unless they apply!
625
Stephen Warren445d56c2013-03-27 17:06:41 +0000626- CPU timer options:
627 CONFIG_SYS_HZ
628
629 The frequency of the timer returned by get_timer().
630 get_timer() must operate in milliseconds and this CONFIG
631 option must be set to 1000.
632
wdenk9b7f3842003-10-09 20:09:04 +0000633- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000634 CONFIG_CLOCKS_IN_MHZ
635
636 U-Boot stores all clock information in Hz
637 internally. For binary compatibility with older Linux
638 kernels (which expect the clocks passed in the
639 bd_info data to be in MHz) the environment variable
640 "clocks_in_mhz" can be defined so that U-Boot
641 converts clock data to MHZ before passing it to the
642 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000643 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100644 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000645 default environment.
646
wdenk9b7f3842003-10-09 20:09:04 +0000647 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
648
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200649 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000650 expect it to be in bytes, others in MB.
651 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
652
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400653 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200654
655 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400656 passed using flattened device trees (based on open firmware
657 concepts).
658
659 CONFIG_OF_LIBFDT
660 * New libfdt-based support
661 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500662 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400663
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200664 OF_CPU - The proper name of the cpus node (only required for
665 MPC512X and MPC5xxx based boards).
666 OF_SOC - The proper name of the soc node (only required for
667 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200668 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600669 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200670
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200671 boards with QUICC Engines require OF_QE to set UCC MAC
672 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500673
Kumar Gala1e26aa52006-01-11 13:54:17 -0600674 CONFIG_OF_BOARD_SETUP
675
676 Board code has addition modification that it wants to make
677 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000678
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500679 CONFIG_OF_BOOT_CPU
680
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200681 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500682 param header, the default value is zero if undefined.
683
Heiko Schocherffb293a2009-09-23 07:56:08 +0200684 CONFIG_OF_IDE_FIXUP
685
686 U-Boot can detect if an IDE device is present or not.
687 If not, and this new config option is activated, U-Boot
688 removes the ATA node from the DTS before booting Linux,
689 so the Linux IDE driver does not probe the device and
690 crash. This is needed for buggy hardware (uc101) where
691 no pull down resistor is connected to the signal IDE5V_DD7.
692
Igor Grinberg06890672011-07-14 05:45:07 +0000693 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
694
695 This setting is mandatory for all boards that have only one
696 machine type and must be used to specify the machine type
697 number as it appears in the ARM machine registry
698 (see http://www.arm.linux.org.uk/developer/machines/).
699 Only boards that have multiple machine types supported
700 in a single configuration file and the machine type is
701 runtime discoverable, do not have to use this setting.
702
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100703- vxWorks boot parameters:
704
705 bootvx constructs a valid bootline using the following
706 environments variables: bootfile, ipaddr, serverip, hostname.
707 It loads the vxWorks image pointed bootfile.
708
709 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
710 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
711 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
712 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
713
714 CONFIG_SYS_VXWORKS_ADD_PARAMS
715
716 Add it at the end of the bootline. E.g "u=username pw=secret"
717
718 Note: If a "bootargs" environment is defined, it will overwride
719 the defaults discussed just above.
720
Aneesh V960f5c02011-06-16 23:30:47 +0000721- Cache Configuration:
722 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
723 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
724 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
725
Aneesh V686a0752011-06-16 23:30:51 +0000726- Cache Configuration for ARM:
727 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
728 controller
729 CONFIG_SYS_PL310_BASE - Physical base address of PL310
730 controller register space
731
wdenkda04a8b2004-08-02 23:22:59 +0000732- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200733 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000734
735 Define this if you want support for Amba PrimeCell PL010 UARTs.
736
Andreas Engel0813b122008-09-08 14:30:53 +0200737 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000738
739 Define this if you want support for Amba PrimeCell PL011 UARTs.
740
741 CONFIG_PL011_CLOCK
742
743 If you have Amba PrimeCell PL011 UARTs, set this variable to
744 the clock speed of the UARTs.
745
746 CONFIG_PL01x_PORTS
747
748 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
749 define this to a list of base addresses for each (supported)
750 port. See e.g. include/configs/versatile.h
751
John Rigby34e21ee2011-04-19 10:42:39 +0000752 CONFIG_PL011_SERIAL_RLCR
753
754 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
755 have separate receive and transmit line control registers. Set
756 this variable to initialize the extra register.
757
758 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
759
760 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
761 boot loader that has already initialized the UART. Define this
762 variable to flush the UART at init time.
763
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400764 CONFIG_SERIAL_HW_FLOW_CONTROL
765
766 Define this variable to enable hw flow control in serial driver.
767 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000768
wdenkc6097192002-11-03 00:24:07 +0000769- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000770 Depending on board, define exactly one serial port
771 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
772 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
773 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000774
775 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
776 port routines must be defined elsewhere
777 (i.e. serial_init(), serial_getc(), ...)
778
779 CONFIG_CFB_CONSOLE
780 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000781 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000782 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
783 (default big endian)
784 VIDEO_HW_RECTFILL graphic chip supports
785 rectangle fill
786 (cf. smiLynxEM)
787 VIDEO_HW_BITBLT graphic chip supports
788 bit-blit (cf. smiLynxEM)
789 VIDEO_VISIBLE_COLS visible pixel columns
790 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000791 VIDEO_VISIBLE_ROWS visible pixel rows
792 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000793 VIDEO_DATA_FORMAT graphic data format
794 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000795 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000796 VIDEO_KBD_INIT_FCT keyboard int fct
797 (i.e. i8042_kbd_init())
798 VIDEO_TSTC_FCT test char fct
799 (i.e. i8042_tstc)
800 VIDEO_GETC_FCT get char fct
801 (i.e. i8042_getc)
802 CONFIG_CONSOLE_CURSOR cursor drawing on/off
803 (requires blink timer
804 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200805 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000806 CONFIG_CONSOLE_TIME display time/date info in
807 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500808 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000809 CONFIG_VIDEO_LOGO display Linux logo in
810 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000811 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
812 linux_logo.h for logo.
813 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000814 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200815 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000816 the logo
817
Pali Rohár4a57da32012-10-19 13:30:09 +0000818 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
819 a limited number of ANSI escape sequences (cursor control,
820 erase functions and limited graphics rendition control).
821
wdenk4a5c8a72003-03-06 00:02:04 +0000822 When CONFIG_CFB_CONSOLE is defined, video console is
823 default i/o. Serial console can be forced with
824 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000825
wdenk1ebf41e2004-01-02 14:00:00 +0000826 When CONFIG_SILENT_CONSOLE is defined, all console
827 messages (by U-Boot and Linux!) can be silenced with
828 the "silent" environment variable. See
829 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000830
Heiko Schocher62759562013-10-22 11:06:06 +0200831 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
832 is 0x00.
833 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
834 is 0xa0.
835
wdenkc6097192002-11-03 00:24:07 +0000836- Console Baudrate:
837 CONFIG_BAUDRATE - in bps
838 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200839 CONFIG_SYS_BAUDRATE_TABLE, see below.
840 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000841
Heiko Schocher327480a2009-01-30 12:55:38 +0100842- Console Rx buffer length
843 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
844 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100845 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100846 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
847 must be defined, to setup the maximum idle timeout for
848 the SMC.
849
Graeme Russ3c28f482011-09-01 00:48:27 +0000850- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200851 Prior to the console being initialised (i.e. serial UART
852 initialised etc) all console output is silently discarded.
853 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
854 buffer any console messages prior to the console being
855 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
856 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
857 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200858 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200859 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000860
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200861 'Sane' compilers will generate smaller code if
862 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000863
Sonny Raocd55bde2011-11-02 09:52:08 +0000864- Safe printf() functions
865 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
866 the printf() functions. These are defined in
867 include/vsprintf.h and include snprintf(), vsnprintf() and
868 so on. Code size increase is approximately 300-500 bytes.
869 If this option is not given then these functions will
870 silently discard their buffer size argument - this means
871 you are not getting any overflow checking in this case.
872
wdenkc6097192002-11-03 00:24:07 +0000873- Boot Delay: CONFIG_BOOTDELAY - in seconds
874 Delay before automatically booting the default image;
875 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000876 set to -2 to autoboot with no delay and not check for abort
877 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000878
879 See doc/README.autoboot for these options that
880 work with CONFIG_BOOTDELAY. None are required.
881 CONFIG_BOOT_RETRY_TIME
882 CONFIG_BOOT_RETRY_MIN
883 CONFIG_AUTOBOOT_KEYED
884 CONFIG_AUTOBOOT_PROMPT
885 CONFIG_AUTOBOOT_DELAY_STR
886 CONFIG_AUTOBOOT_STOP_STR
887 CONFIG_AUTOBOOT_DELAY_STR2
888 CONFIG_AUTOBOOT_STOP_STR2
889 CONFIG_ZERO_BOOTDELAY_CHECK
890 CONFIG_RESET_TO_RETRY
891
892- Autoboot Command:
893 CONFIG_BOOTCOMMAND
894 Only needed when CONFIG_BOOTDELAY is enabled;
895 define a command string that is automatically executed
896 when no character is read on the console interface
897 within "Boot Delay" after reset.
898
899 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000900 This can be used to pass arguments to the bootm
901 command. The value of CONFIG_BOOTARGS goes into the
902 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000903
904 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000905 The value of these goes into the environment as
906 "ramboot" and "nfsboot" respectively, and can be used
907 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200908 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000909
Heiko Schocher040c5c32013-11-04 14:04:59 +0100910- Bootcount:
911 CONFIG_BOOTCOUNT_LIMIT
912 Implements a mechanism for detecting a repeating reboot
913 cycle, see:
914 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
915
916 CONFIG_BOOTCOUNT_ENV
917 If no softreset save registers are found on the hardware
918 "bootcount" is stored in the environment. To prevent a
919 saveenv on all reboots, the environment variable
920 "upgrade_available" is used. If "upgrade_available" is
921 0, "bootcount" is always 0, if "upgrade_available" is
922 1 "bootcount" is incremented in the environment.
923 So the Userspace Applikation must set the "upgrade_available"
924 and "bootcount" variable to 0, if a boot was successfully.
925
wdenkc6097192002-11-03 00:24:07 +0000926- Pre-Boot Commands:
927 CONFIG_PREBOOT
928
929 When this option is #defined, the existence of the
930 environment variable "preboot" will be checked
931 immediately before starting the CONFIG_BOOTDELAY
932 countdown and/or running the auto-boot command resp.
933 entering interactive mode.
934
935 This feature is especially useful when "preboot" is
936 automatically generated or modified. For an example
937 see the LWMON board specific code: here "preboot" is
938 modified when the user holds down a certain
939 combination of keys on the (special) keyboard when
940 booting the systems
941
942- Serial Download Echo Mode:
943 CONFIG_LOADS_ECHO
944 If defined to 1, all characters received during a
945 serial download (using the "loads" command) are
946 echoed back. This might be needed by some terminal
947 emulations (like "cu"), but may as well just take
948 time on others. This setting #define's the initial
949 value of the "loads_echo" environment variable.
950
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500951- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000952 CONFIG_KGDB_BAUDRATE
953 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200954 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000955
956- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500957 Monitor commands can be included or excluded
958 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000959 <config_cmd_all.h> and #undef'ing unwanted
960 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500961 and augmenting with additional #define's
962 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000963
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500964 The default command configuration includes all commands
965 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000966
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100967 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500968 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500969 CONFIG_CMD_BDI bdinfo
970 CONFIG_CMD_BEDBUG * Include BedBug Debugger
971 CONFIG_CMD_BMP * BMP support
972 CONFIG_CMD_BSP * Board specific commands
973 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400974 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500975 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800976 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500977 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500978 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500979 CONFIG_CMD_DATE * support for RTC, date/time...
980 CONFIG_CMD_DHCP * DHCP support
981 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600982 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
983 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
984 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
985 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500986 CONFIG_CMD_DTT * Digital Therm and Thermostat
987 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500988 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 CONFIG_CMD_EEPROM * EEPROM read/write support
990 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600991 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600992 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500993 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500994 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000995 CONFIG_CMD_EXT2 * ext2 command support
996 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700997 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
998 that work for multiple fs types
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500999 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001000 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001001 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001002 CONFIG_CMD_FLASH flinfo, erase, protect
1003 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001004 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001005 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001006 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001007 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001008 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001009 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1010 CONFIG_CMD_I2C * I2C serial bus support
1011 CONFIG_CMD_IDE * IDE harddisk support
1012 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001013 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001014 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001015 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001016 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001017 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001018 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001019 CONFIG_CMD_IRQ * irqinfo
1020 CONFIG_CMD_ITEST Integer/string test of 2 values
1021 CONFIG_CMD_JFFS2 * JFFS2 Support
1022 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001023 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001024 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1025 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001026 CONFIG_CMD_LOADB loadb
1027 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001028 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001029 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001030 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001031 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001032 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001033 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001034 CONFIG_CMD_MISC Misc functions like sleep etc
1035 CONFIG_CMD_MMC * MMC memory mapped support
1036 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001037 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001038 CONFIG_CMD_NAND * NAND support
1039 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001040 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001041 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001042 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001043 CONFIG_CMD_PCI * pciinfo
1044 CONFIG_CMD_PCMCIA * PCMCIA support
1045 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1046 host
1047 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001048 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001049 CONFIG_CMD_REGINFO * Register dump
1050 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001051 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001052 CONFIG_CMD_SAVES * save S record dump
1053 CONFIG_CMD_SCSI * SCSI Support
1054 CONFIG_CMD_SDRAM * print SDRAM configuration information
1055 (requires CONFIG_CMD_I2C)
1056 CONFIG_CMD_SETGETDCR Support for DCR Register access
1057 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001058 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001059 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001060 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001061 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001062 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001063 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001064 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001065 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001066 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1067 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001068 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001070 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001071 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001072 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001073
1074 EXAMPLE: If you want all functions except of network
1075 support you can write:
1076
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001077 #include "config_cmd_all.h"
1078 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001079
Gerald Van Barend6abef42007-03-31 12:23:51 -04001080 Other Commands:
1081 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001082
1083 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001084 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001085 what you (and your U-Boot users) are doing. Data
1086 cache cannot be enabled on systems like the 8xx or
1087 8260 (where accesses to the IMMR region must be
1088 uncached), and it cannot be disabled on all other
1089 systems where we (mis-) use the data cache to hold an
1090 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001091
1092
1093 XXX - this list needs to get updated!
1094
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001095- Regular expression support:
1096 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001097 If this variable is defined, U-Boot is linked against
1098 the SLRE (Super Light Regular Expression) library,
1099 which adds regex support to some commands, as for
1100 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001101
Simon Glass3d686442011-10-15 05:48:20 +00001102- Device tree:
1103 CONFIG_OF_CONTROL
1104 If this variable is defined, U-Boot will use a device tree
1105 to configure its devices, instead of relying on statically
1106 compiled #defines in the board file. This option is
1107 experimental and only available on a few boards. The device
1108 tree is available in the global data as gd->fdt_blob.
1109
Simon Glass5cb34db2011-10-24 19:15:31 +00001110 U-Boot needs to get its device tree from somewhere. This can
1111 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001112
1113 CONFIG_OF_EMBED
1114 If this variable is defined, U-Boot will embed a device tree
1115 binary in its image. This device tree file should be in the
1116 board directory and called <soc>-<board>.dts. The binary file
1117 is then picked up in board_init_f() and made available through
1118 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001119
Simon Glass5cb34db2011-10-24 19:15:31 +00001120 CONFIG_OF_SEPARATE
1121 If this variable is defined, U-Boot will build a device tree
1122 binary. It will be called u-boot.dtb. Architecture-specific
1123 code will locate it at run-time. Generally this works by:
1124
1125 cat u-boot.bin u-boot.dtb >image.bin
1126
1127 and in fact, U-Boot does this for you, creating a file called
1128 u-boot-dtb.bin which is useful in the common case. You can
1129 still use the individual files if you need something more
1130 exotic.
1131
wdenkc6097192002-11-03 00:24:07 +00001132- Watchdog:
1133 CONFIG_WATCHDOG
1134 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001135 support for the SoC. There must be support in the SoC
1136 specific code for a watchdog. For the 8xx and 8260
1137 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1138 register. When supported for a specific SoC is
1139 available, then no further board specific code should
1140 be needed to use it.
1141
1142 CONFIG_HW_WATCHDOG
1143 When using a watchdog circuitry external to the used
1144 SoC, then define this variable and provide board
1145 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001146
stroeseb9c17c52003-04-04 15:53:41 +00001147- U-Boot Version:
1148 CONFIG_VERSION_VARIABLE
1149 If this variable is defined, an environment variable
1150 named "ver" is created by U-Boot showing the U-Boot
1151 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001152 Any change to this variable will be reverted at the
1153 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001154
wdenkc6097192002-11-03 00:24:07 +00001155- Real-Time Clock:
1156
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001157 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001158 has to be selected, too. Define exactly one of the
1159 following options:
1160
1161 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1162 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001163 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001164 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001165 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001166 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001167 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001168 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001169 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001170 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001171 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001172 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001173 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1174 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001175
wdenkb9bbd242003-06-30 16:24:52 +00001176 Note that if the RTC uses I2C, then the I2C interface
1177 must also be configured. See I2C Support, below.
1178
Peter Tyser9902e422008-12-17 16:36:21 -06001179- GPIO Support:
1180 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001181
Chris Packham9b383202010-12-19 10:12:13 +00001182 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1183 chip-ngpio pairs that tell the PCA953X driver the number of
1184 pins supported by a particular chip.
1185
Peter Tyser9902e422008-12-17 16:36:21 -06001186 Note that if the GPIO device uses I2C, then the I2C interface
1187 must also be configured. See I2C Support, below.
1188
Simon Glass4dc47ca2014-06-11 23:29:41 -06001189- I/O tracing:
1190 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1191 accesses and can checksum them or write a list of them out
1192 to memory. See the 'iotrace' command for details. This is
1193 useful for testing device drivers since it can confirm that
1194 the driver behaves the same way before and after a code
1195 change. Currently this is supported on sandbox and arm. To
1196 add support for your architecture, add '#include <iotrace.h>'
1197 to the bottom of arch/<arch>/include/asm/io.h and test.
1198
1199 Example output from the 'iotrace stats' command is below.
1200 Note that if the trace buffer is exhausted, the checksum will
1201 still continue to operate.
1202
1203 iotrace is enabled
1204 Start: 10000000 (buffer start address)
1205 Size: 00010000 (buffer size)
1206 Offset: 00000120 (current buffer offset)
1207 Output: 10000120 (start + offset)
1208 Count: 00000018 (number of trace records)
1209 CRC32: 9526fb66 (CRC32 of all trace records)
1210
wdenkc6097192002-11-03 00:24:07 +00001211- Timestamp Support:
1212
wdenk4a5c8a72003-03-06 00:02:04 +00001213 When CONFIG_TIMESTAMP is selected, the timestamp
1214 (date and time) of an image is printed by image
1215 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001216 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001217
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001218- Partition Labels (disklabels) Supported:
1219 Zero or more of the following:
1220 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1221 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1222 Intel architecture, USB sticks, etc.
1223 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1224 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1225 bootloader. Note 2TB partition limit; see
1226 disk/part_efi.c
1227 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001228
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001229 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1230 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001231 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001232
1233- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001234 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1235 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001236
wdenk369d43d2004-03-14 14:09:05 +00001237 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1238 be performed by calling the function
1239 ide_set_reset(int reset)
1240 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001241
1242- ATAPI Support:
1243 CONFIG_ATAPI
1244
1245 Set this to enable ATAPI support.
1246
wdenkf602aa02004-03-13 23:29:43 +00001247- LBA48 Support
1248 CONFIG_LBA48
1249
1250 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001251 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001252 Whithout these , LBA48 support uses 32bit variables and will 'only'
1253 support disks up to 2.1TB.
1254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001255 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001256 When enabled, makes the IDE subsystem use 64bit sector addresses.
1257 Default is 32bit.
1258
wdenkc6097192002-11-03 00:24:07 +00001259- SCSI Support:
1260 At the moment only there is only support for the
1261 SYM53C8XX SCSI controller; define
1262 CONFIG_SCSI_SYM53C8XX to enable it.
1263
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001264 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1265 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1266 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001267 maximum numbers of LUNs, SCSI ID's and target
1268 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001269 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001270
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001271 The environment variable 'scsidevs' is set to the number of
1272 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001273
wdenkc6097192002-11-03 00:24:07 +00001274- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001275 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001276 Support for Intel 8254x/8257x gigabit chips.
1277
1278 CONFIG_E1000_SPI
1279 Utility code for direct access to the SPI bus on Intel 8257x.
1280 This does not do anything useful unless you set at least one
1281 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1282
1283 CONFIG_E1000_SPI_GENERIC
1284 Allow generic access to the SPI bus on the Intel 8257x, for
1285 example with the "sspi" command.
1286
1287 CONFIG_CMD_E1000
1288 Management command for E1000 devices. When used on devices
1289 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001290
Andre Schwarz68c2a302008-03-06 16:45:44 +01001291 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001292 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001293
wdenkc6097192002-11-03 00:24:07 +00001294 CONFIG_EEPRO100
1295 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001296 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001297 write routine for first time initialisation.
1298
1299 CONFIG_TULIP
1300 Support for Digital 2114x chips.
1301 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1302 modem chip initialisation (KS8761/QS6611).
1303
1304 CONFIG_NATSEMI
1305 Support for National dp83815 chips.
1306
1307 CONFIG_NS8382X
1308 Support for National dp8382[01] gigabit chips.
1309
wdenkaa603362003-05-12 21:50:16 +00001310- NETWORK Support (other):
1311
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001312 CONFIG_DRIVER_AT91EMAC
1313 Support for AT91RM9200 EMAC.
1314
1315 CONFIG_RMII
1316 Define this to use reduced MII inteface
1317
1318 CONFIG_DRIVER_AT91EMAC_QUIET
1319 If this defined, the driver is quiet.
1320 The driver doen't show link status messages.
1321
Rob Herringc9830dc2011-12-15 11:15:49 +00001322 CONFIG_CALXEDA_XGMAC
1323 Support for the Calxeda XGMAC device
1324
Ashok93fb8722012-10-15 06:20:47 +00001325 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001326 Support for SMSC's LAN91C96 chips.
1327
1328 CONFIG_LAN91C96_BASE
1329 Define this to hold the physical address
1330 of the LAN91C96's I/O space
1331
1332 CONFIG_LAN91C96_USE_32_BIT
1333 Define this to enable 32 bit addressing
1334
Ashok93fb8722012-10-15 06:20:47 +00001335 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001336 Support for SMSC's LAN91C111 chip
1337
1338 CONFIG_SMC91111_BASE
1339 Define this to hold the physical address
1340 of the device (I/O space)
1341
1342 CONFIG_SMC_USE_32_BIT
1343 Define this if data bus is 32 bits
1344
1345 CONFIG_SMC_USE_IOFUNCS
1346 Define this to use i/o functions instead of macros
1347 (some hardware wont work with macros)
1348
Heiko Schocher7d037f72011-11-15 10:00:04 -05001349 CONFIG_DRIVER_TI_EMAC
1350 Support for davinci emac
1351
1352 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1353 Define this if you have more then 3 PHYs.
1354
Macpaul Lin199c6252010-12-21 16:59:46 +08001355 CONFIG_FTGMAC100
1356 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1357
1358 CONFIG_FTGMAC100_EGIGA
1359 Define this to use GE link update with gigabit PHY.
1360 Define this if FTGMAC100 is connected to gigabit PHY.
1361 If your system has 10/100 PHY only, it might not occur
1362 wrong behavior. Because PHY usually return timeout or
1363 useless data when polling gigabit status and gigabit
1364 control registers. This behavior won't affect the
1365 correctnessof 10/100 link speed update.
1366
Mike Rapoportf4761af2009-11-11 10:03:03 +02001367 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001368 Support for SMSC's LAN911x and LAN921x chips
1369
Mike Rapoportf4761af2009-11-11 10:03:03 +02001370 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001371 Define this to hold the physical address
1372 of the device (I/O space)
1373
Mike Rapoportf4761af2009-11-11 10:03:03 +02001374 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001375 Define this if data bus is 32 bits
1376
Mike Rapoportf4761af2009-11-11 10:03:03 +02001377 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001378 Define this if data bus is 16 bits. If your processor
1379 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001380 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001381
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001382 CONFIG_SH_ETHER
1383 Support for Renesas on-chip Ethernet controller
1384
1385 CONFIG_SH_ETHER_USE_PORT
1386 Define the number of ports to be used
1387
1388 CONFIG_SH_ETHER_PHY_ADDR
1389 Define the ETH PHY's address
1390
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001391 CONFIG_SH_ETHER_CACHE_WRITEBACK
1392 If this option is set, the driver enables cache flush.
1393
Heiko Schocher2b387762014-07-18 06:07:19 +02001394- PWM Support:
1395 CONFIG_PWM_IMX
1396 Support for PWM modul on the imx6.
1397
Vadim Bendeburydac69642011-10-17 08:36:14 +00001398- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001399 CONFIG_TPM
1400 Support TPM devices.
1401
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001402 CONFIG_TPM_TIS_I2C
1403 Support for i2c bus TPM devices. Only one device
1404 per system is supported at this time.
1405
1406 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1407 Define the the i2c bus number for the TPM device
1408
1409 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1410 Define the TPM's address on the i2c bus
1411
1412 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1413 Define the burst count bytes upper limit
1414
Dirk Eibach20489092013-06-26 15:55:15 +02001415 CONFIG_TPM_ATMEL_TWI
1416 Support for Atmel TWI TPM device. Requires I2C support.
1417
Che-liang Chiouacea5702013-04-12 11:04:34 +00001418 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001419 Support for generic parallel port TPM devices. Only one device
1420 per system is supported at this time.
1421
1422 CONFIG_TPM_TIS_BASE_ADDRESS
1423 Base address where the generic TPM device is mapped
1424 to. Contemporary x86 systems usually map it at
1425 0xfed40000.
1426
Reinhard Pfau4fece432013-06-26 15:55:13 +02001427 CONFIG_CMD_TPM
1428 Add tpm monitor functions.
1429 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1430 provides monitor access to authorized functions.
1431
1432 CONFIG_TPM
1433 Define this to enable the TPM support library which provides
1434 functional interfaces to some TPM commands.
1435 Requires support for a TPM device.
1436
1437 CONFIG_TPM_AUTH_SESSIONS
1438 Define this to enable authorized functions in the TPM library.
1439 Requires CONFIG_TPM and CONFIG_SHA1.
1440
wdenkc6097192002-11-03 00:24:07 +00001441- USB Support:
1442 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001443 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001444 CONFIG_USB_UHCI to enable it.
1445 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001446 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001447 storage devices.
1448 Note:
1449 Supported are USB Keyboards and USB Floppy drives
1450 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001451 MPC5200 USB requires additional defines:
1452 CONFIG_USB_CLOCK
1453 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001454 CONFIG_PSC3_USB
1455 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001456 CONFIG_USB_CONFIG
1457 for differential drivers: 0x00001000
1458 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001459 for differential drivers on PSC3: 0x00000100
1460 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001461 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001462 May be defined to allow interrupt polling
1463 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001464
Simon Glass5978cdb2012-02-27 10:52:47 +00001465 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1466 txfilltuning field in the EHCI controller on reset.
1467
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001468 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1469 HW module registers.
1470
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001471- USB Device:
1472 Define the below if you wish to use the USB console.
1473 Once firmware is rebuilt from a serial console issue the
1474 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001475 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001476 it has found a new device. The environment variable usbtty
1477 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001478 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001479 Common Device Class Abstract Control Model serial device.
1480 If you select usbtty = gserial you should be able to enumerate
1481 a Linux host by
1482 # modprobe usbserial vendor=0xVendorID product=0xProductID
1483 else if using cdc_acm, simply setting the environment
1484 variable usbtty to be cdc_acm should suffice. The following
1485 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001486
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001487 CONFIG_USB_DEVICE
1488 Define this to build a UDC device
1489
1490 CONFIG_USB_TTY
1491 Define this to have a tty type of device available to
1492 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001493
Vipin KUMARbdb17702012-03-26 15:38:06 +05301494 CONFIG_USBD_HS
1495 Define this to enable the high speed support for usb
1496 device and usbtty. If this feature is enabled, a routine
1497 int is_usbd_high_speed(void)
1498 also needs to be defined by the driver to dynamically poll
1499 whether the enumeration has succeded at high speed or full
1500 speed.
1501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001502 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001503 Define this if you want stdin, stdout &/or stderr to
1504 be set to usbtty.
1505
1506 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001507 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001508 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001509 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001510
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001511 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001512 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001513 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001514
Wolfgang Denke2601822006-06-14 18:14:56 +02001515 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001516 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001517 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001518 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1519 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1520 should pretend to be a Linux device to it's target host.
1521
1522 CONFIG_USBD_MANUFACTURER
1523 Define this string as the name of your company for
1524 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001525
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001526 CONFIG_USBD_PRODUCT_NAME
1527 Define this string as the name of your product
1528 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001529
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001530 CONFIG_USBD_VENDORID
1531 Define this as your assigned Vendor ID from the USB
1532 Implementors Forum. This *must* be a genuine Vendor ID
1533 to avoid polluting the USB namespace.
1534 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001535
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001536 CONFIG_USBD_PRODUCTID
1537 Define this as the unique Product ID
1538 for your device
1539 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001540
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001541- ULPI Layer Support:
1542 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1543 the generic ULPI layer. The generic layer accesses the ULPI PHY
1544 via the platform viewport, so you need both the genric layer and
1545 the viewport enabled. Currently only Chipidea/ARC based
1546 viewport is supported.
1547 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1548 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001549 If your ULPI phy needs a different reference clock than the
1550 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1551 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001552
wdenk7a428cc2003-06-15 22:40:42 +00001553- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001554 The MMC controller on the Intel PXA is supported. To
1555 enable this define CONFIG_MMC. The MMC can be
1556 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001557 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001558 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1559 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001560
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001561 CONFIG_SH_MMCIF
1562 Support for Renesas on-chip MMCIF controller
1563
1564 CONFIG_SH_MMCIF_ADDR
1565 Define the base address of MMCIF registers
1566
1567 CONFIG_SH_MMCIF_CLK
1568 Define the clock frequency for MMCIF
1569
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001570 CONFIG_GENERIC_MMC
1571 Enable the generic MMC driver
1572
1573 CONFIG_SUPPORT_EMMC_BOOT
1574 Enable some additional features of the eMMC boot partitions.
1575
1576 CONFIG_SUPPORT_EMMC_RPMB
1577 Enable the commands for reading, writing and programming the
1578 key for the Replay Protection Memory Block partition in eMMC.
1579
Tom Rini58a8d322013-03-14 05:32:47 +00001580- USB Device Firmware Update (DFU) class support:
1581 CONFIG_DFU_FUNCTION
1582 This enables the USB portion of the DFU USB class
1583
1584 CONFIG_CMD_DFU
1585 This enables the command "dfu" which is used to have
1586 U-Boot create a DFU class device via USB. This command
1587 requires that the "dfu_alt_info" environment variable be
1588 set and define the alt settings to expose to the host.
1589
1590 CONFIG_DFU_MMC
1591 This enables support for exposing (e)MMC devices via DFU.
1592
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001593 CONFIG_DFU_NAND
1594 This enables support for exposing NAND devices via DFU.
1595
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301596 CONFIG_DFU_RAM
1597 This enables support for exposing RAM via DFU.
1598 Note: DFU spec refer to non-volatile memory usage, but
1599 allow usages beyond the scope of spec - here RAM usage,
1600 one that would help mostly the developer.
1601
Heiko Schochera2f831e2013-06-12 06:05:51 +02001602 CONFIG_SYS_DFU_DATA_BUF_SIZE
1603 Dfu transfer uses a buffer before writing data to the
1604 raw storage device. Make the size (in bytes) of this buffer
1605 configurable. The size of this buffer is also configurable
1606 through the "dfu_bufsiz" environment variable.
1607
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001608 CONFIG_SYS_DFU_MAX_FILE_SIZE
1609 When updating files rather than the raw storage device,
1610 we use a static buffer to copy the file into and then write
1611 the buffer once we've been given the whole file. Define
1612 this to the maximum filesize (in bytes) for the buffer.
1613 Default is 4 MiB if undefined.
1614
Heiko Schochere1ba1512014-03-18 08:09:56 +01001615 DFU_DEFAULT_POLL_TIMEOUT
1616 Poll timeout [ms], is the timeout a device can send to the
1617 host. The host must wait for this timeout before sending
1618 a subsequent DFU_GET_STATUS request to the device.
1619
1620 DFU_MANIFEST_POLL_TIMEOUT
1621 Poll timeout [ms], which the device sends to the host when
1622 entering dfuMANIFEST state. Host waits this timeout, before
1623 sending again an USB request to the device.
1624
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001625- USB Device Android Fastboot support:
1626 CONFIG_CMD_FASTBOOT
1627 This enables the command "fastboot" which enables the Android
1628 fastboot mode for the platform's USB device. Fastboot is a USB
1629 protocol for downloading images, flashing and device control
1630 used on Android devices.
1631 See doc/README.android-fastboot for more information.
1632
1633 CONFIG_ANDROID_BOOT_IMAGE
1634 This enables support for booting images which use the Android
1635 image format header.
1636
1637 CONFIG_USB_FASTBOOT_BUF_ADDR
1638 The fastboot protocol requires a large memory buffer for
1639 downloads. Define this to the starting RAM address to use for
1640 downloaded images.
1641
1642 CONFIG_USB_FASTBOOT_BUF_SIZE
1643 The fastboot protocol requires a large memory buffer for
1644 downloads. This buffer should be as large as possible for a
1645 platform. Define this to the size available RAM for fastboot.
1646
Steve Raebfb9ba42014-08-26 11:47:28 -07001647 CONFIG_FASTBOOT_FLASH
1648 The fastboot protocol includes a "flash" command for writing
1649 the downloaded image to a non-volatile storage device. Define
1650 this to enable the "fastboot flash" command.
1651
1652 CONFIG_FASTBOOT_FLASH_MMC_DEV
1653 The fastboot "flash" command requires additional information
1654 regarding the non-volatile storage device. Define this to
1655 the eMMC device that fastboot should use to store the image.
1656
wdenkda04a8b2004-08-02 23:22:59 +00001657- Journaling Flash filesystem support:
1658 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1659 CONFIG_JFFS2_NAND_DEV
1660 Define these for a default partition on a NAND device
1661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001662 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1663 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001664 Define these for a default partition on a NOR device
1665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001666 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001667 Define this to create an own partition. You have to provide a
1668 function struct part_info* jffs2_part_info(int part_num)
1669
1670 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001671 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001672 to disable the command chpart. This is the default when you
1673 have not defined a custom partition
1674
Donggeun Kim8f814002011-10-24 21:15:28 +00001675- FAT(File Allocation Table) filesystem write function support:
1676 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001677
1678 Define this to enable support for saving memory data as a
1679 file in FAT formatted partition.
1680
1681 This will also enable the command "fatwrite" enabling the
1682 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001683
Gabe Black7f8574c2012-10-12 14:26:11 +00001684CBFS (Coreboot Filesystem) support
1685 CONFIG_CMD_CBFS
1686
1687 Define this to enable support for reading from a Coreboot
1688 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1689 and cbfsload.
1690
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301691- FAT(File Allocation Table) filesystem cluster size:
1692 CONFIG_FS_FAT_MAX_CLUSTSIZE
1693
1694 Define the max cluster size for fat operations else
1695 a default value of 65536 will be defined.
1696
wdenkc6097192002-11-03 00:24:07 +00001697- Keyboard Support:
1698 CONFIG_ISA_KEYBOARD
1699
1700 Define this to enable standard (PC-Style) keyboard
1701 support
1702
1703 CONFIG_I8042_KBD
1704 Standard PC keyboard driver with US (is default) and
1705 GERMAN key layout (switch via environment 'keymap=de') support.
1706 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1707 for cfb_console. Supports cursor blinking.
1708
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001709 CONFIG_CROS_EC_KEYB
1710 Enables a Chrome OS keyboard using the CROS_EC interface.
1711 This uses CROS_EC to communicate with a second microcontroller
1712 which provides key scans on request.
1713
wdenkc6097192002-11-03 00:24:07 +00001714- Video support:
1715 CONFIG_VIDEO
1716
1717 Define this to enable video support (for output to
1718 video).
1719
1720 CONFIG_VIDEO_CT69000
1721
1722 Enable Chips & Technologies 69000 Video chip
1723
1724 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001725 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001726 video output is selected via environment 'videoout'
1727 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1728 assumed.
wdenkc6097192002-11-03 00:24:07 +00001729
wdenkd3602132004-03-25 15:14:43 +00001730 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001731 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001732 are possible:
1733 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001734 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001735
1736 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1737 -------------+---------------------------------------------
1738 8 bits | 0x301* 0x303 0x305 0x161 0x307
1739 15 bits | 0x310 0x313 0x316 0x162 0x319
1740 16 bits | 0x311 0x314 0x317 0x163 0x31A
1741 24 bits | 0x312 0x315 0x318 ? 0x31B
1742 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001743 (i.e. setenv videomode 317; saveenv; reset;)
1744
wdenkd3602132004-03-25 15:14:43 +00001745 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001746 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001747
1748
stroeseb9c17c52003-04-04 15:53:41 +00001749 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001750 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001751 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1752 or CONFIG_VIDEO_SED13806_16BPP
1753
Timur Tabi020edd22011-02-15 17:09:19 -06001754 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001755 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001756 SOCs that have a DIU should define this macro to enable DIU
1757 support, and should also define these other macros:
1758
1759 CONFIG_SYS_DIU_ADDR
1760 CONFIG_VIDEO
1761 CONFIG_CMD_BMP
1762 CONFIG_CFB_CONSOLE
1763 CONFIG_VIDEO_SW_CURSOR
1764 CONFIG_VGA_AS_SINGLE_DEVICE
1765 CONFIG_VIDEO_LOGO
1766 CONFIG_VIDEO_BMP_LOGO
1767
Timur Tabi32f709e2011-04-11 14:18:22 -05001768 The DIU driver will look for the 'video-mode' environment
1769 variable, and if defined, enable the DIU as a console during
1770 boot. See the documentation file README.video for a
1771 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001772
Simon Glass54df8ce2012-12-03 13:59:47 +00001773 CONFIG_VIDEO_VGA
1774
1775 Enable the VGA video / BIOS for x86. The alternative if you
1776 are using coreboot is to use the coreboot frame buffer
1777 driver.
1778
1779
wdenk4e112c12003-06-03 23:54:09 +00001780- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001781 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001782
wdenk57b2d802003-06-27 21:31:46 +00001783 Define this to enable a custom keyboard support.
1784 This simply calls drv_keyboard_init() which must be
1785 defined in your board-specific files.
1786 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001787
wdenkc6097192002-11-03 00:24:07 +00001788- LCD Support: CONFIG_LCD
1789
1790 Define this to enable LCD support (for output to LCD
1791 display); also select one of the supported displays
1792 by defining one of these:
1793
Stelian Popf6f86652008-05-09 21:57:18 +02001794 CONFIG_ATMEL_LCD:
1795
1796 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1797
wdenkc0d54ae2003-11-25 16:55:19 +00001798 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001799
wdenkc0d54ae2003-11-25 16:55:19 +00001800 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001801
wdenkc0d54ae2003-11-25 16:55:19 +00001802 CONFIG_NEC_NL6448BC20
1803
1804 NEC NL6448BC20-08. 6.5", 640x480.
1805 Active, color, single scan.
1806
1807 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkc0d54ae2003-11-25 16:55:19 +00001809 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001810 Active, color, single scan.
1811
1812 CONFIG_SHARP_16x9
1813
1814 Sharp 320x240. Active, color, single scan.
1815 It isn't 16x9, and I am not sure what it is.
1816
1817 CONFIG_SHARP_LQ64D341
1818
1819 Sharp LQ64D341 display, 640x480.
1820 Active, color, single scan.
1821
1822 CONFIG_HLD1045
1823
1824 HLD1045 display, 640x480.
1825 Active, color, single scan.
1826
1827 CONFIG_OPTREX_BW
1828
1829 Optrex CBL50840-2 NF-FW 99 22 M5
1830 or
1831 Hitachi LMG6912RPFC-00T
1832 or
1833 Hitachi SP14Q002
1834
1835 320x240. Black & white.
1836
1837 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001838 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001839
Simon Glass599a4df2012-10-17 13:24:54 +00001840 CONFIG_LCD_ALIGNMENT
1841
1842 Normally the LCD is page-aligned (tyically 4KB). If this is
1843 defined then the LCD will be aligned to this value instead.
1844 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1845 here, since it is cheaper to change data cache settings on
1846 a per-section basis.
1847
Simon Glassaf3e2802012-10-17 13:24:59 +00001848 CONFIG_CONSOLE_SCROLL_LINES
1849
1850 When the console need to be scrolled, this is the number of
1851 lines to scroll by. It defaults to 1. Increasing this makes
1852 the console jump but can help speed up operation when scrolling
1853 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001854
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001855 CONFIG_LCD_BMP_RLE8
1856
1857 Support drawing of RLE8-compressed bitmaps on the LCD.
1858
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001859 CONFIG_I2C_EDID
1860
1861 Enables an 'i2c edid' command which can read EDID
1862 information over I2C from an attached LCD display.
1863
wdenkeb20ad32003-09-05 23:19:14 +00001864- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001865
wdenk57b2d802003-06-27 21:31:46 +00001866 If this option is set, the environment is checked for
1867 a variable "splashimage". If found, the usual display
1868 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001869 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001870 specified in "splashimage" is loaded instead. The
1871 console is redirected to the "nulldev", too. This
1872 allows for a "silent" boot where a splash screen is
1873 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001874
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001875 CONFIG_SPLASHIMAGE_GUARD
1876
1877 If this option is set, then U-Boot will prevent the environment
1878 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001879 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001880 This option is useful for targets where, due to alignment
1881 restrictions, an improperly aligned BMP image will cause a data
1882 abort. If you think you will not have problems with unaligned
1883 accesses (for example because your toolchain prevents them)
1884 there is no need to set this option.
1885
Matthias Weisser53884182009-07-09 16:07:30 +02001886 CONFIG_SPLASH_SCREEN_ALIGN
1887
1888 If this option is set the splash image can be freely positioned
1889 on the screen. Environment variable "splashpos" specifies the
1890 position as "x,y". If a positive number is given it is used as
1891 number of pixel from left/top. If a negative number is given it
1892 is used as number of pixel from right/bottom. You can also
1893 specify 'm' for centering the image.
1894
1895 Example:
1896 setenv splashpos m,m
1897 => image at center of screen
1898
1899 setenv splashpos 30,20
1900 => image at x = 30 and y = 20
1901
1902 setenv splashpos -10,m
1903 => vertically centered image
1904 at x = dspWidth - bmpWidth - 9
1905
Stefan Roesed9d97742005-09-22 09:04:17 +02001906- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1907
1908 If this option is set, additionally to standard BMP
1909 images, gzipped BMP images can be displayed via the
1910 splashscreen support or the bmp command.
1911
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001912- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1913
1914 If this option is set, 8-bit RLE compressed BMP images
1915 can be displayed via the splashscreen support or the
1916 bmp command.
1917
Lei Wene4e248d2012-09-28 04:26:47 +00001918- Do compresssing for memory range:
1919 CONFIG_CMD_ZIP
1920
1921 If this option is set, it would use zlib deflate method
1922 to compress the specified memory at its best effort.
1923
wdenk710e3502003-08-29 20:57:53 +00001924- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001925 CONFIG_GZIP
1926
1927 Enabled by default to support gzip compressed images.
1928
wdenk710e3502003-08-29 20:57:53 +00001929 CONFIG_BZIP2
1930
1931 If this option is set, support for bzip2 compressed
1932 images is included. If not, only uncompressed and gzip
1933 compressed images are supported.
1934
wdenk9c53f402003-10-15 23:53:47 +00001935 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001936 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001937 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001938
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001939 CONFIG_LZMA
1940
1941 If this option is set, support for lzma compressed
1942 images is included.
1943
1944 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1945 requires an amount of dynamic memory that is given by the
1946 formula:
1947
1948 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1949
1950 Where lc and lp stand for, respectively, Literal context bits
1951 and Literal pos bits.
1952
1953 This value is upper-bounded by 14MB in the worst case. Anyway,
1954 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1955 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1956 a very small buffer.
1957
1958 Use the lzmainfo tool to determinate the lc and lp values and
1959 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001960 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001961
Kees Cook5b06e642013-08-16 07:59:12 -07001962 CONFIG_LZO
1963
1964 If this option is set, support for LZO compressed images
1965 is included.
1966
wdenk0e2bd9c2004-06-06 21:51:03 +00001967- MII/PHY support:
1968 CONFIG_PHY_ADDR
1969
1970 The address of PHY on MII bus.
1971
1972 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1973
1974 The clock frequency of the MII bus
1975
1976 CONFIG_PHY_GIGE
1977
1978 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001979 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001980
1981 CONFIG_PHY_RESET_DELAY
1982
1983 Some PHY like Intel LXT971A need extra delay after
1984 reset before any MII register access is possible.
1985 For such PHY, set this option to the usec delay
1986 required. (minimum 300usec for LXT971A)
1987
1988 CONFIG_PHY_CMD_DELAY (ppc4xx)
1989
1990 Some PHY like Intel LXT971A need extra delay after
1991 command issued before MII status register can be read
1992
wdenkc6097192002-11-03 00:24:07 +00001993- Ethernet address:
1994 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001995 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001996 CONFIG_ETH2ADDR
1997 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001998 CONFIG_ETH4ADDR
1999 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002000
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002001 Define a default value for Ethernet address to use
2002 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002003 is not determined automatically.
2004
2005- IP address:
2006 CONFIG_IPADDR
2007
2008 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002009 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002010 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002011 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002012
2013- Server IP address:
2014 CONFIG_SERVERIP
2015
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002016 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002017 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002018 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002019
Robin Getz470a6d42009-07-21 12:15:28 -04002020 CONFIG_KEEP_SERVERADDR
2021
2022 Keeps the server's MAC address, in the env 'serveraddr'
2023 for passing to bootargs (like Linux's netconsole option)
2024
Wolfgang Denk26da2992011-10-26 10:21:22 +00002025- Gateway IP address:
2026 CONFIG_GATEWAYIP
2027
2028 Defines a default value for the IP address of the
2029 default router where packets to other networks are
2030 sent to.
2031 (Environment variable "gatewayip")
2032
2033- Subnet mask:
2034 CONFIG_NETMASK
2035
2036 Defines a default value for the subnet mask (or
2037 routing prefix) which is used to determine if an IP
2038 address belongs to the local subnet or needs to be
2039 forwarded through a router.
2040 (Environment variable "netmask")
2041
David Updegraff7280da72007-06-11 10:41:07 -05002042- Multicast TFTP Mode:
2043 CONFIG_MCAST_TFTP
2044
2045 Defines whether you want to support multicast TFTP as per
2046 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002047 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002048 driver in use must provide a function: mcast() to join/leave a
2049 multicast group.
2050
wdenkc6097192002-11-03 00:24:07 +00002051- BOOTP Recovery Mode:
2052 CONFIG_BOOTP_RANDOM_DELAY
2053
2054 If you have many targets in a network that try to
2055 boot using BOOTP, you may want to avoid that all
2056 systems send out BOOTP requests at precisely the same
2057 moment (which would happen for instance at recovery
2058 from a power failure, when all systems will try to
2059 boot, thus flooding the BOOTP server. Defining
2060 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2061 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002062 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002063
2064 1st BOOTP request: delay 0 ... 1 sec
2065 2nd BOOTP request: delay 0 ... 2 sec
2066 3rd BOOTP request: delay 0 ... 4 sec
2067 4th and following
2068 BOOTP requests: delay 0 ... 8 sec
2069
Thierry Reding8977cda2014-08-19 10:21:24 +02002070 CONFIG_BOOTP_ID_CACHE_SIZE
2071
2072 BOOTP packets are uniquely identified using a 32-bit ID. The
2073 server will copy the ID from client requests to responses and
2074 U-Boot will use this to determine if it is the destination of
2075 an incoming response. Some servers will check that addresses
2076 aren't in use before handing them out (usually using an ARP
2077 ping) and therefore take up to a few hundred milliseconds to
2078 respond. Network congestion may also influence the time it
2079 takes for a response to make it back to the client. If that
2080 time is too long, U-Boot will retransmit requests. In order
2081 to allow earlier responses to still be accepted after these
2082 retransmissions, U-Boot's BOOTP client keeps a small cache of
2083 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2084 cache. The default is to keep IDs for up to four outstanding
2085 requests. Increasing this will allow U-Boot to accept offers
2086 from a BOOTP client in networks with unusually high latency.
2087
stroesee0aadfb2003-08-28 14:17:32 +00002088- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002089 You can fine tune the DHCP functionality by defining
2090 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002091
Jon Loeliger5336a762007-07-09 22:08:34 -05002092 CONFIG_BOOTP_SUBNETMASK
2093 CONFIG_BOOTP_GATEWAY
2094 CONFIG_BOOTP_HOSTNAME
2095 CONFIG_BOOTP_NISDOMAIN
2096 CONFIG_BOOTP_BOOTPATH
2097 CONFIG_BOOTP_BOOTFILESIZE
2098 CONFIG_BOOTP_DNS
2099 CONFIG_BOOTP_DNS2
2100 CONFIG_BOOTP_SEND_HOSTNAME
2101 CONFIG_BOOTP_NTPSERVER
2102 CONFIG_BOOTP_TIMEOFFSET
2103 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002104 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002105
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002106 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2107 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002108
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002109 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2110 after the configured retry count, the call will fail
2111 instead of starting over. This can be used to fail over
2112 to Link-local IP address configuration if the DHCP server
2113 is not available.
2114
stroesee0aadfb2003-08-28 14:17:32 +00002115 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2116 serverip from a DHCP server, it is possible that more
2117 than one DNS serverip is offered to the client.
2118 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2119 serverip will be stored in the additional environment
2120 variable "dnsip2". The first DNS serverip is always
2121 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002122 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002123
2124 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2125 to do a dynamic update of a DNS server. To do this, they
2126 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002127 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002128 of the "hostname" environment variable is passed as
2129 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002130
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002131 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2132
2133 A 32bit value in microseconds for a delay between
2134 receiving a "DHCP Offer" and sending the "DHCP Request".
2135 This fixes a problem with certain DHCP servers that don't
2136 respond 100% of the time to a "DHCP request". E.g. On an
2137 AT91RM9200 processor running at 180MHz, this delay needed
2138 to be *at least* 15,000 usec before a Windows Server 2003
2139 DHCP server would reply 100% of the time. I recommend at
2140 least 50,000 usec to be safe. The alternative is to hope
2141 that one of the retries will be successful but note that
2142 the DHCP timeout and retry process takes a longer than
2143 this delay.
2144
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002145 - Link-local IP address negotiation:
2146 Negotiate with other link-local clients on the local network
2147 for an address that doesn't require explicit configuration.
2148 This is especially useful if a DHCP server cannot be guaranteed
2149 to exist in all environments that the device must operate.
2150
2151 See doc/README.link-local for more information.
2152
wdenk145d2c12004-04-15 21:48:45 +00002153 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002154 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002155
2156 The device id used in CDP trigger frames.
2157
2158 CONFIG_CDP_DEVICE_ID_PREFIX
2159
2160 A two character string which is prefixed to the MAC address
2161 of the device.
2162
2163 CONFIG_CDP_PORT_ID
2164
2165 A printf format string which contains the ascii name of
2166 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002167 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002168
2169 CONFIG_CDP_CAPABILITIES
2170
2171 A 32bit integer which indicates the device capabilities;
2172 0x00000010 for a normal host which does not forwards.
2173
2174 CONFIG_CDP_VERSION
2175
2176 An ascii string containing the version of the software.
2177
2178 CONFIG_CDP_PLATFORM
2179
2180 An ascii string containing the name of the platform.
2181
2182 CONFIG_CDP_TRIGGER
2183
2184 A 32bit integer sent on the trigger.
2185
2186 CONFIG_CDP_POWER_CONSUMPTION
2187
2188 A 16bit integer containing the power consumption of the
2189 device in .1 of milliwatts.
2190
2191 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2192
2193 A byte containing the id of the VLAN.
2194
wdenkc6097192002-11-03 00:24:07 +00002195- Status LED: CONFIG_STATUS_LED
2196
2197 Several configurations allow to display the current
2198 status using a LED. For instance, the LED will blink
2199 fast while running U-Boot code, stop blinking as
2200 soon as a reply to a BOOTP request was received, and
2201 start blinking slow once the Linux kernel is running
2202 (supported by a status LED driver in the Linux
2203 kernel). Defining CONFIG_STATUS_LED enables this
2204 feature in U-Boot.
2205
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002206 Additional options:
2207
2208 CONFIG_GPIO_LED
2209 The status LED can be connected to a GPIO pin.
2210 In such cases, the gpio_led driver can be used as a
2211 status LED backend implementation. Define CONFIG_GPIO_LED
2212 to include the gpio_led driver in the U-Boot binary.
2213
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002214 CONFIG_GPIO_LED_INVERTED_TABLE
2215 Some GPIO connected LEDs may have inverted polarity in which
2216 case the GPIO high value corresponds to LED off state and
2217 GPIO low value corresponds to LED on state.
2218 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2219 with a list of GPIO LEDs that have inverted polarity.
2220
wdenkc6097192002-11-03 00:24:07 +00002221- CAN Support: CONFIG_CAN_DRIVER
2222
2223 Defining CONFIG_CAN_DRIVER enables CAN driver support
2224 on those systems that support this (optional)
2225 feature, like the TQM8xxL modules.
2226
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002227- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002228
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002229 This enable the NEW i2c subsystem, and will allow you to use
2230 i2c commands at the u-boot command line (as long as you set
2231 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2232 based realtime clock chips or other i2c devices. See
2233 common/cmd_i2c.c for a description of the command line
2234 interface.
2235
2236 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002237 - drivers/i2c/soft_i2c.c:
2238 - activate first bus with CONFIG_SYS_I2C_SOFT define
2239 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2240 for defining speed and slave address
2241 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2242 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2243 for defining speed and slave address
2244 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2245 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2246 for defining speed and slave address
2247 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2248 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2249 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002250
Heiko Schocherf2850742012-10-24 13:48:22 +02002251 - drivers/i2c/fsl_i2c.c:
2252 - activate i2c driver with CONFIG_SYS_I2C_FSL
2253 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2254 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2255 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2256 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002257 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002258 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2259 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2260 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2261 second bus.
2262
Simon Glass026fefb2012-10-30 07:28:53 +00002263 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002264 - activate this driver with CONFIG_SYS_I2C_TEGRA
2265 - This driver adds 4 i2c buses with a fix speed from
2266 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002267
Dirk Eibach42b204f2013-04-25 02:40:01 +00002268 - drivers/i2c/ppc4xx_i2c.c
2269 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2270 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2271 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2272
trema49f40a2013-09-21 18:13:35 +02002273 - drivers/i2c/i2c_mxc.c
2274 - activate this driver with CONFIG_SYS_I2C_MXC
2275 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2276 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2277 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2278 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2279 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2280 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2281 If thoses defines are not set, default value is 100000
2282 for speed, and 0 for slave.
2283
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002284 - drivers/i2c/rcar_i2c.c:
2285 - activate this driver with CONFIG_SYS_I2C_RCAR
2286 - This driver adds 4 i2c buses
2287
2288 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2289 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2290 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2291 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2292 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2293 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2294 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2295 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2296 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2297
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002298 - drivers/i2c/sh_i2c.c:
2299 - activate this driver with CONFIG_SYS_I2C_SH
2300 - This driver adds from 2 to 5 i2c buses
2301
2302 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2303 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2304 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2305 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2306 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2307 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2308 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2309 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2310 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2311 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2312 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2313 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2314 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2315
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002316 - drivers/i2c/omap24xx_i2c.c
2317 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2318 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2319 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2320 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2321 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2322 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2323 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2324 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2325 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2326 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2327 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2328
Heiko Schocher465819a2013-11-08 07:30:53 +01002329 - drivers/i2c/zynq_i2c.c
2330 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2331 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2332 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2333
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302334 - drivers/i2c/s3c24x0_i2c.c:
2335 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2336 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2337 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2338 with a fix speed from 100000 and the slave addr 0!
2339
Dirk Eibachb9577432014-07-03 09:28:18 +02002340 - drivers/i2c/ihs_i2c.c
2341 - activate this driver with CONFIG_SYS_I2C_IHS
2342 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2343 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2344 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2345 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2346 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2347 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2348 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2349 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2350 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2351 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2352 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2353 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2354
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002355 additional defines:
2356
2357 CONFIG_SYS_NUM_I2C_BUSES
2358 Hold the number of i2c busses you want to use. If you
2359 don't use/have i2c muxes on your i2c bus, this
2360 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2361 omit this define.
2362
2363 CONFIG_SYS_I2C_DIRECT_BUS
2364 define this, if you don't use i2c muxes on your hardware.
2365 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2366 omit this define.
2367
2368 CONFIG_SYS_I2C_MAX_HOPS
2369 define how many muxes are maximal consecutively connected
2370 on one i2c bus. If you not use i2c muxes, omit this
2371 define.
2372
2373 CONFIG_SYS_I2C_BUSES
2374 hold a list of busses you want to use, only used if
2375 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2376 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2377 CONFIG_SYS_NUM_I2C_BUSES = 9:
2378
2379 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2380 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2381 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2382 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2383 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2384 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2385 {1, {I2C_NULL_HOP}}, \
2386 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2387 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2388 }
2389
2390 which defines
2391 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002392 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2393 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2394 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2395 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2396 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002397 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002398 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2399 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002400
2401 If you do not have i2c muxes on your board, omit this define.
2402
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002403- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002404
2405 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2406 provides the following compelling advantages:
2407
2408 - more than one i2c adapter is usable
2409 - approved multibus support
2410 - better i2c mux support
2411
2412 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002413
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002414 These enable legacy I2C serial bus commands. Defining
2415 CONFIG_HARD_I2C will include the appropriate I2C driver
2416 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002417
wdenk21136db2003-07-16 21:53:01 +00002418 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002419 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002420 CONFIG_COMMANDS) and communicate with i2c based realtime
2421 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002422 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002423
Ben Warren45657152006-09-07 16:50:54 -04002424 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002425
wdenk21136db2003-07-16 21:53:01 +00002426 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002427 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002428
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002429 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002430 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002431 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002432 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002433
Peter Tysere4d1abc2010-04-12 22:28:21 -05002434 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002435 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002436 and so its address should therefore be cleared to 0 (See,
2437 eg, MPC823e User's Manual p.16-473). So, set
2438 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002439
Eric Millbrandt12990a42009-09-03 08:09:44 -05002440 CONFIG_SYS_I2C_INIT_MPC5XXX
2441
2442 When a board is reset during an i2c bus transfer
2443 chips might think that the current transfer is still
2444 in progress. Reset the slave devices by sending start
2445 commands until the slave device responds.
2446
wdenk21136db2003-07-16 21:53:01 +00002447 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002448
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002449 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002450 then the following macros need to be defined (examples are
2451 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002452
2453 I2C_INIT
2454
wdenkb9bbd242003-06-30 16:24:52 +00002455 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002456 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002457
wdenk544e9732004-02-06 23:19:44 +00002458 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002459
wdenkc6097192002-11-03 00:24:07 +00002460 I2C_PORT
2461
wdenk4a5c8a72003-03-06 00:02:04 +00002462 (Only for MPC8260 CPU). The I/O port to use (the code
2463 assumes both bits are on the same port). Valid values
2464 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002465
2466 I2C_ACTIVE
2467
2468 The code necessary to make the I2C data line active
2469 (driven). If the data line is open collector, this
2470 define can be null.
2471
wdenkb9bbd242003-06-30 16:24:52 +00002472 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2473
wdenkc6097192002-11-03 00:24:07 +00002474 I2C_TRISTATE
2475
2476 The code necessary to make the I2C data line tri-stated
2477 (inactive). If the data line is open collector, this
2478 define can be null.
2479
wdenkb9bbd242003-06-30 16:24:52 +00002480 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2481
wdenkc6097192002-11-03 00:24:07 +00002482 I2C_READ
2483
York Sun4a598092013-04-01 11:29:11 -07002484 Code that returns true if the I2C data line is high,
2485 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002486
wdenkb9bbd242003-06-30 16:24:52 +00002487 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2488
wdenkc6097192002-11-03 00:24:07 +00002489 I2C_SDA(bit)
2490
York Sun4a598092013-04-01 11:29:11 -07002491 If <bit> is true, sets the I2C data line high. If it
2492 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002493
wdenkb9bbd242003-06-30 16:24:52 +00002494 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002495 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002496 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002497
wdenkc6097192002-11-03 00:24:07 +00002498 I2C_SCL(bit)
2499
York Sun4a598092013-04-01 11:29:11 -07002500 If <bit> is true, sets the I2C clock line high. If it
2501 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002502
wdenkb9bbd242003-06-30 16:24:52 +00002503 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002504 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002505 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002506
wdenkc6097192002-11-03 00:24:07 +00002507 I2C_DELAY
2508
2509 This delay is invoked four times per clock cycle so this
2510 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002511 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002512 like:
2513
wdenkb9bbd242003-06-30 16:24:52 +00002514 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002515
Mike Frysingeree12d542010-07-21 13:38:02 -04002516 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2517
2518 If your arch supports the generic GPIO framework (asm/gpio.h),
2519 then you may alternatively define the two GPIOs that are to be
2520 used as SCL / SDA. Any of the previous I2C_xxx macros will
2521 have GPIO-based defaults assigned to them as appropriate.
2522
2523 You should define these to the GPIO value as given directly to
2524 the generic GPIO functions.
2525
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002526 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002527
wdenk57b2d802003-06-27 21:31:46 +00002528 When a board is reset during an i2c bus transfer
2529 chips might think that the current transfer is still
2530 in progress. On some boards it is possible to access
2531 the i2c SCLK line directly, either by using the
2532 processor pin as a GPIO or by having a second pin
2533 connected to the bus. If this option is defined a
2534 custom i2c_init_board() routine in boards/xxx/board.c
2535 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002536
Richard Retanubundf0149c2010-04-12 15:08:17 -04002537 CONFIG_SYS_I2C_BOARD_LATE_INIT
2538
2539 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2540 defined a custom i2c_board_late_init() routine in
2541 boards/xxx/board.c is run AFTER the operations in i2c_init()
2542 is completed. This callpoint can be used to unreset i2c bus
2543 using CPU i2c controller register accesses for CPUs whose i2c
2544 controller provide such a method. It is called at the end of
2545 i2c_init() to allow i2c_init operations to setup the i2c bus
2546 controller on the CPU (e.g. setting bus speed & slave address).
2547
wdenk0e2bd9c2004-06-06 21:51:03 +00002548 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2549
2550 This option enables configuration of bi_iic_fast[] flags
2551 in u-boot bd_info structure based on u-boot environment
2552 variable "i2cfast". (see also i2cfast)
2553
Ben Warren45657152006-09-07 16:50:54 -04002554 CONFIG_I2C_MULTI_BUS
2555
2556 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002557 must have a controller. At any point in time, only one bus is
2558 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002559 Note that bus numbering is zero-based.
2560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002561 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002562
2563 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002564 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002565 is set, specify a list of bus-device pairs. Otherwise, specify
2566 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002567
2568 e.g.
2569 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002570 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002571
2572 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2573
Wolfgang Denk092ae952011-10-26 10:21:21 +00002574 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002575 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002576
2577 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2578
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002579 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002580
2581 If defined, then this indicates the I2C bus number for DDR SPD.
2582 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002584 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002585
2586 If defined, then this indicates the I2C bus number for the RTC.
2587 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002589 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002590
2591 If defined, then this indicates the I2C bus number for the DTT.
2592 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002594 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002595
2596 If defined, specifies the I2C address of the DTT device.
2597 If not defined, then U-Boot uses predefined value for
2598 specified DTT device.
2599
Andrew Dyer58c41f92008-12-29 17:36:01 -06002600 CONFIG_SOFT_I2C_READ_REPEATED_START
2601
2602 defining this will force the i2c_read() function in
2603 the soft_i2c driver to perform an I2C repeated start
2604 between writing the address pointer and reading the
2605 data. If this define is omitted the default behaviour
2606 of doing a stop-start sequence will be used. Most I2C
2607 devices can use either method, but some require one or
2608 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002609
wdenkc6097192002-11-03 00:24:07 +00002610- SPI Support: CONFIG_SPI
2611
2612 Enables SPI driver (so far only tested with
2613 SPI EEPROM, also an instance works with Crystal A/D and
2614 D/As on the SACSng board)
2615
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002616 CONFIG_SH_SPI
2617
2618 Enables the driver for SPI controller on SuperH. Currently
2619 only SH7757 is supported.
2620
wdenkc6097192002-11-03 00:24:07 +00002621 CONFIG_SPI_X
2622
2623 Enables extended (16-bit) SPI EEPROM addressing.
2624 (symmetrical to CONFIG_I2C_X)
2625
2626 CONFIG_SOFT_SPI
2627
wdenk4a5c8a72003-03-06 00:02:04 +00002628 Enables a software (bit-bang) SPI driver rather than
2629 using hardware support. This is a general purpose
2630 driver that only requires three general I/O port pins
2631 (two outputs, one input) to function. If this is
2632 defined, the board configuration must define several
2633 SPI configuration items (port pins to use, etc). For
2634 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002635
Ben Warren7efe9272008-01-16 22:37:35 -05002636 CONFIG_HARD_SPI
2637
2638 Enables a hardware SPI driver for general-purpose reads
2639 and writes. As with CONFIG_SOFT_SPI, the board configuration
2640 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002641 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002642 example, see include/configs/mpc8349emds.h.
2643
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002644 CONFIG_MXC_SPI
2645
2646 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002647 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002648
Heiko Schocherb77c8882014-07-14 10:22:11 +02002649 CONFIG_SYS_SPI_MXC_WAIT
2650 Timeout for waiting until spi transfer completed.
2651 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2652
Matthias Fuchsa4400872007-12-27 17:12:34 +01002653- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002654
Matthias Fuchsa4400872007-12-27 17:12:34 +01002655 Enables FPGA subsystem.
2656
2657 CONFIG_FPGA_<vendor>
2658
2659 Enables support for specific chip vendors.
2660 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002661
Matthias Fuchsa4400872007-12-27 17:12:34 +01002662 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002663
Matthias Fuchsa4400872007-12-27 17:12:34 +01002664 Enables support for FPGA family.
2665 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2666
2667 CONFIG_FPGA_COUNT
2668
2669 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002670
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302671 CONFIG_CMD_FPGA_LOADMK
2672
2673 Enable support for fpga loadmk command
2674
Michal Simek64c70982014-05-02 13:43:39 +02002675 CONFIG_CMD_FPGA_LOADP
2676
2677 Enable support for fpga loadp command - load partial bitstream
2678
2679 CONFIG_CMD_FPGA_LOADBP
2680
2681 Enable support for fpga loadbp command - load partial bitstream
2682 (Xilinx only)
2683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002684 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002685
wdenk57b2d802003-06-27 21:31:46 +00002686 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002687
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002688 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002689
wdenk4a5c8a72003-03-06 00:02:04 +00002690 Enable checks on FPGA configuration interface busy
2691 status by the configuration function. This option
2692 will require a board or device specific function to
2693 be written.
wdenkc6097192002-11-03 00:24:07 +00002694
2695 CONFIG_FPGA_DELAY
2696
2697 If defined, a function that provides delays in the FPGA
2698 configuration driver.
2699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002700 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002701 Allow Control-C to interrupt FPGA configuration
2702
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002703 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002704
wdenk4a5c8a72003-03-06 00:02:04 +00002705 Check for configuration errors during FPGA bitfile
2706 loading. For example, abort during Virtex II
2707 configuration if the INIT_B line goes low (which
2708 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002710 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk4a5c8a72003-03-06 00:02:04 +00002712 Maximum time to wait for the INIT_B line to deassert
2713 after PROB_B has been deasserted during a Virtex II
2714 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002715 ms.
wdenkc6097192002-11-03 00:24:07 +00002716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002717 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002718
wdenk4a5c8a72003-03-06 00:02:04 +00002719 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002720 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002722 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002723
wdenk4a5c8a72003-03-06 00:02:04 +00002724 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002725 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002726
2727- Configuration Management:
2728 CONFIG_IDENT_STRING
2729
wdenk4a5c8a72003-03-06 00:02:04 +00002730 If defined, this string will be added to the U-Boot
2731 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002732
2733- Vendor Parameter Protection:
2734
wdenk4a5c8a72003-03-06 00:02:04 +00002735 U-Boot considers the values of the environment
2736 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002737 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002738 are set once by the board vendor / manufacturer, and
2739 protects these variables from casual modification by
2740 the user. Once set, these variables are read-only,
2741 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002742 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002743
2744 If CONFIG_ENV_OVERWRITE is #defined in your config
2745 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002746 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002747 these parameters.
2748
2749 Alternatively, if you #define _both_ CONFIG_ETHADDR
2750 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002751 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002752 which can be changed exactly ONCE by the user. [The
2753 serial# is unaffected by this, i. e. it remains
2754 read-only.]
2755
Joe Hershberger71497d02012-12-11 22:16:31 -06002756 The same can be accomplished in a more flexible way
2757 for any variable by configuring the type of access
2758 to allow for those variables in the ".flags" variable
2759 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2760
wdenkc6097192002-11-03 00:24:07 +00002761- Protected RAM:
2762 CONFIG_PRAM
2763
2764 Define this variable to enable the reservation of
2765 "protected RAM", i. e. RAM which is not overwritten
2766 by U-Boot. Define CONFIG_PRAM to hold the number of
2767 kB you want to reserve for pRAM. You can overwrite
2768 this default value by defining an environment
2769 variable "pram" to the number of kB you want to
2770 reserve. Note that the board info structure will
2771 still show the full amount of RAM. If pRAM is
2772 reserved, a new environment variable "mem" will
2773 automatically be defined to hold the amount of
2774 remaining RAM in a form that can be passed as boot
2775 argument to Linux, for instance like that:
2776
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002777 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002778 saveenv
2779
2780 This way you can tell Linux not to use this memory,
2781 either, which results in a memory region that will
2782 not be affected by reboots.
2783
2784 *WARNING* If your board configuration uses automatic
2785 detection of the RAM size, you must make sure that
2786 this memory test is non-destructive. So far, the
2787 following board configurations are known to be
2788 "pRAM-clean":
2789
Wolfgang Denk90326762012-10-24 02:36:15 +00002790 IVMS8, IVML24, SPD8xx, TQM8xxL,
2791 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002792 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002793
Gabe Blacka2f3a932012-12-02 04:55:18 +00002794- Access to physical memory region (> 4GB)
2795 Some basic support is provided for operations on memory not
2796 normally accessible to U-Boot - e.g. some architectures
2797 support access to more than 4GB of memory on 32-bit
2798 machines using physical address extension or similar.
2799 Define CONFIG_PHYSMEM to access this basic support, which
2800 currently only supports clearing the memory.
2801
wdenkc6097192002-11-03 00:24:07 +00002802- Error Recovery:
2803 CONFIG_PANIC_HANG
2804
2805 Define this variable to stop the system in case of a
2806 fatal error, so that you have to reset it manually.
2807 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002808 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002809 automatically as fast as possible, but it may be
2810 useful during development since you can try to debug
2811 the conditions that lead to the situation.
2812
2813 CONFIG_NET_RETRY_COUNT
2814
wdenk4a5c8a72003-03-06 00:02:04 +00002815 This variable defines the number of retries for
2816 network operations like ARP, RARP, TFTP, or BOOTP
2817 before giving up the operation. If not defined, a
2818 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002819
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002820 CONFIG_ARP_TIMEOUT
2821
2822 Timeout waiting for an ARP reply in milliseconds.
2823
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002824 CONFIG_NFS_TIMEOUT
2825
2826 Timeout in milliseconds used in NFS protocol.
2827 If you encounter "ERROR: Cannot umount" in nfs command,
2828 try longer timeout such as
2829 #define CONFIG_NFS_TIMEOUT 10000UL
2830
wdenkc6097192002-11-03 00:24:07 +00002831- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002832 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002833
2834 Enable auto completion of commands using TAB.
2835
Wolfgang Denk018147d2006-11-27 15:32:42 +01002836 Note that this feature has NOT been implemented yet
2837 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002838
2839
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002840 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002841
2842 Define this variable to enable the "hush" shell (from
2843 Busybox) as command line interpreter, thus enabling
2844 powerful command line syntax like
2845 if...then...else...fi conditionals or `&&' and '||'
2846 constructs ("shell scripts").
2847
2848 If undefined, you get the old, much simpler behaviour
2849 with a somewhat smaller memory footprint.
2850
2851
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002852 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002853
2854 This defines the secondary prompt string, which is
2855 printed when the command interpreter needs more input
2856 to complete a command. Usually "> ".
2857
2858 Note:
2859
wdenk57b2d802003-06-27 21:31:46 +00002860 In the current implementation, the local variables
2861 space and global environment variables space are
2862 separated. Local variables are those you define by
2863 simply typing `name=value'. To access a local
2864 variable later on, you have write `$name' or
2865 `${name}'; to execute the contents of a variable
2866 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002867
wdenk4a5c8a72003-03-06 00:02:04 +00002868 Global environment variables are those you use
2869 setenv/printenv to work with. To run a command stored
2870 in such a variable, you need to use the run command,
2871 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002872
2873 To store commands and special characters in a
2874 variable, please use double quotation marks
2875 surrounding the whole text of the variable, instead
2876 of the backslashes before semicolons and special
2877 symbols.
2878
Wolfgang Denk2039a072006-07-21 11:35:21 +02002879- Commandline Editing and History:
2880 CONFIG_CMDLINE_EDITING
2881
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002882 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002883 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002884
wdenkc0aa5c52003-12-06 19:49:23 +00002885- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002886 CONFIG_EXTRA_ENV_SETTINGS
2887
wdenk4a5c8a72003-03-06 00:02:04 +00002888 Define this to contain any number of null terminated
2889 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002890 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002891
wdenk4a5c8a72003-03-06 00:02:04 +00002892 For example, place something like this in your
2893 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002894
2895 #define CONFIG_EXTRA_ENV_SETTINGS \
2896 "myvar1=value1\0" \
2897 "myvar2=value2\0"
2898
wdenk4a5c8a72003-03-06 00:02:04 +00002899 Warning: This method is based on knowledge about the
2900 internal format how the environment is stored by the
2901 U-Boot code. This is NOT an official, exported
2902 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002903 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002904 You better know what you are doing here.
2905
wdenk4a5c8a72003-03-06 00:02:04 +00002906 Note: overly (ab)use of the default environment is
2907 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002908 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002909 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002910
Stephen Warren1465d5f2012-05-22 09:21:54 +00002911 CONFIG_ENV_VARS_UBOOT_CONFIG
2912
2913 Define this in order to add variables describing the
2914 U-Boot build configuration to the default environment.
2915 These will be named arch, cpu, board, vendor, and soc.
2916
2917 Enabling this option will cause the following to be defined:
2918
2919 - CONFIG_SYS_ARCH
2920 - CONFIG_SYS_CPU
2921 - CONFIG_SYS_BOARD
2922 - CONFIG_SYS_VENDOR
2923 - CONFIG_SYS_SOC
2924
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002925 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2926
2927 Define this in order to add variables describing certain
2928 run-time determined information about the hardware to the
2929 environment. These will be named board_name, board_rev.
2930
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002931 CONFIG_DELAY_ENVIRONMENT
2932
2933 Normally the environment is loaded when the board is
2934 intialised so that it is available to U-Boot. This inhibits
2935 that so that the environment is not available until
2936 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2937 this is instead controlled by the value of
2938 /config/load-environment.
2939
wdenkc0aa5c52003-12-06 19:49:23 +00002940- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002941 CONFIG_HAS_DATAFLASH
2942
wdenk57b2d802003-06-27 21:31:46 +00002943 Defining this option enables DataFlash features and
2944 allows to read/write in Dataflash via the standard
2945 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002946
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002947- Serial Flash support
2948 CONFIG_CMD_SF
2949
2950 Defining this option enables SPI flash commands
2951 'sf probe/read/write/erase/update'.
2952
2953 Usage requires an initial 'probe' to define the serial
2954 flash parameters, followed by read/write/erase/update
2955 commands.
2956
2957 The following defaults may be provided by the platform
2958 to handle the common case when only a single serial
2959 flash is present on the system.
2960
2961 CONFIG_SF_DEFAULT_BUS Bus identifier
2962 CONFIG_SF_DEFAULT_CS Chip-select
2963 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2964 CONFIG_SF_DEFAULT_SPEED in Hz
2965
Simon Glass4b5545e2012-10-08 13:16:02 +00002966 CONFIG_CMD_SF_TEST
2967
2968 Define this option to include a destructive SPI flash
2969 test ('sf test').
2970
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302971 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2972
2973 Define this option to use the Bank addr/Extended addr
2974 support on SPI flashes which has size > 16Mbytes.
2975
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302976 CONFIG_SF_DUAL_FLASH Dual flash memories
2977
2978 Define this option to use dual flash support where two flash
2979 memories can be connected with a given cs line.
2980 currently Xilinx Zynq qspi support these type of connections.
2981
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02002982 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2983 enable the W#/Vpp signal to disable writing to the status
2984 register on ST MICRON flashes like the N25Q128.
2985 The status register write enable/disable bit, combined with
2986 the W#/VPP signal provides hardware data protection for the
2987 device as follows: When the enable/disable bit is set to 1,
2988 and the W#/VPP signal is driven LOW, the status register
2989 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2990 operation will not execute. The only way to exit this
2991 hardware-protected mode is to drive W#/VPP HIGH.
2992
wdenkef893942004-02-23 16:11:30 +00002993- SystemACE Support:
2994 CONFIG_SYSTEMACE
2995
2996 Adding this option adds support for Xilinx SystemACE
2997 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002998 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002999 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003000
3001 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003002 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003003
3004 When SystemACE support is added, the "ace" device type
3005 becomes available to the fat commands, i.e. fatls.
3006
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003007- TFTP Fixed UDP Port:
3008 CONFIG_TFTP_PORT
3009
Wolfgang Denk227b5192005-09-24 23:25:46 +02003010 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003011 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003012 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003013 number generator is used.
3014
Wolfgang Denk227b5192005-09-24 23:25:46 +02003015 Also, the environment variable tftpdstp is used to supply
3016 the TFTP UDP destination port value. If tftpdstp isn't
3017 defined, the normal port 69 is used.
3018
3019 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003020 blindly start the TFTP transfer using the pre-configured
3021 target IP address and UDP port. This has the effect of
3022 "punching through" the (Windows XP) firewall, allowing
3023 the remainder of the TFTP transfer to proceed normally.
3024 A better solution is to properly configure the firewall,
3025 but sometimes that is not allowed.
3026
Simon Glass058bb8d2012-12-05 14:46:38 +00003027- Hashing support:
3028 CONFIG_CMD_HASH
3029
3030 This enables a generic 'hash' command which can produce
3031 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3032
3033 CONFIG_HASH_VERIFY
3034
3035 Enable the hash verify command (hash -v). This adds to code
3036 size a little.
3037
3038 CONFIG_SHA1 - support SHA1 hashing
3039 CONFIG_SHA256 - support SHA256 hashing
3040
3041 Note: There is also a sha1sum command, which should perhaps
3042 be deprecated in favour of 'hash sha1'.
3043
Robert Winkler765ccf42013-07-24 17:57:06 -07003044- Freescale i.MX specific commands:
3045 CONFIG_CMD_HDMIDETECT
3046 This enables 'hdmidet' command which returns true if an
3047 HDMI monitor is detected. This command is i.MX 6 specific.
3048
3049 CONFIG_CMD_BMODE
3050 This enables the 'bmode' (bootmode) command for forcing
3051 a boot from specific media.
3052
3053 This is useful for forcing the ROM's usb downloader to
3054 activate upon a watchdog reset which is nice when iterating
3055 on U-Boot. Using the reset button or running bmode normal
3056 will set it back to normal. This command currently
3057 supports i.MX53 and i.MX6.
3058
Simon Glass35191a32013-06-13 15:10:02 -07003059- Signing support:
3060 CONFIG_RSA
3061
3062 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003063 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003064
3065 The signing part is build into mkimage regardless of this
3066 option.
3067
Heiko Schocher443ca402014-01-25 07:27:13 +01003068- bootcount support:
3069 CONFIG_BOOTCOUNT_LIMIT
3070
3071 This enables the bootcounter support, see:
3072 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3073
3074 CONFIG_AT91SAM9XE
3075 enable special bootcounter support on at91sam9xe based boards.
3076 CONFIG_BLACKFIN
3077 enable special bootcounter support on blackfin based boards.
3078 CONFIG_SOC_DA8XX
3079 enable special bootcounter support on da850 based boards.
3080 CONFIG_BOOTCOUNT_RAM
3081 enable support for the bootcounter in RAM
3082 CONFIG_BOOTCOUNT_I2C
3083 enable support for the bootcounter on an i2c (like RTC) device.
3084 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3085 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3086 the bootcounter.
3087 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003088
wdenkc0aa5c52003-12-06 19:49:23 +00003089- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003090 CONFIG_SHOW_BOOT_PROGRESS
3091
wdenk4a5c8a72003-03-06 00:02:04 +00003092 Defining this option allows to add some board-
3093 specific code (calling a user-provided function
3094 "show_boot_progress(int)") that enables you to show
3095 the system's boot progress on some display (for
3096 example, some LED's) on your board. At the moment,
3097 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003098
Simon Glass31a870e2012-02-13 13:51:19 +00003099- Detailed boot stage timing
3100 CONFIG_BOOTSTAGE
3101 Define this option to get detailed timing of each stage
3102 of the boot process.
3103
3104 CONFIG_BOOTSTAGE_USER_COUNT
3105 This is the number of available user bootstage records.
3106 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3107 a new ID will be allocated from this stash. If you exceed
3108 the limit, recording will stop.
3109
3110 CONFIG_BOOTSTAGE_REPORT
3111 Define this to print a report before boot, similar to this:
3112
3113 Timer summary in microseconds:
3114 Mark Elapsed Stage
3115 0 0 reset
3116 3,575,678 3,575,678 board_init_f start
3117 3,575,695 17 arch_cpu_init A9
3118 3,575,777 82 arch_cpu_init done
3119 3,659,598 83,821 board_init_r start
3120 3,910,375 250,777 main_loop
3121 29,916,167 26,005,792 bootm_start
3122 30,361,327 445,160 start_kernel
3123
Simon Glass4afd88e2012-09-28 08:56:39 +00003124 CONFIG_CMD_BOOTSTAGE
3125 Add a 'bootstage' command which supports printing a report
3126 and un/stashing of bootstage data.
3127
Simon Glass0fa36a42012-09-28 08:56:37 +00003128 CONFIG_BOOTSTAGE_FDT
3129 Stash the bootstage information in the FDT. A root 'bootstage'
3130 node is created with each bootstage id as a child. Each child
3131 has a 'name' property and either 'mark' containing the
3132 mark time in microsecond, or 'accum' containing the
3133 accumulated time for that bootstage id in microseconds.
3134 For example:
3135
3136 bootstage {
3137 154 {
3138 name = "board_init_f";
3139 mark = <3575678>;
3140 };
3141 170 {
3142 name = "lcd";
3143 accum = <33482>;
3144 };
3145 };
3146
3147 Code in the Linux kernel can find this in /proc/devicetree.
3148
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003149Legacy uImage format:
3150
wdenkc6097192002-11-03 00:24:07 +00003151 Arg Where When
3152 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003153 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003154 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003155 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003156 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003157 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003158 4 common/cmd_bootm.c Image data has correct checksum
3159 -4 common/cmd_bootm.c Image is for unsupported architecture
3160 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003161 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003162 6 common/cmd_bootm.c Image Type check OK
3163 -6 common/cmd_bootm.c gunzip uncompression error
3164 -7 common/cmd_bootm.c Unimplemented compression type
3165 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003166 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003167 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003168
3169 9 common/image.c Start initial ramdisk verification
3170 -10 common/image.c Ramdisk header has bad magic number
3171 -11 common/image.c Ramdisk header has bad checksum
3172 10 common/image.c Ramdisk header is OK
3173 -12 common/image.c Ramdisk data has bad checksum
3174 11 common/image.c Ramdisk data has correct checksum
3175 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003176 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003177 13 common/image.c Start multifile image verification
3178 14 common/image.c No initial ramdisk, no multifile, continue.
3179
Wolfgang Denk092ae952011-10-26 10:21:21 +00003180 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003181
Stefan Roese88fbf932010-04-15 16:07:28 +02003182 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003183 -31 post/post.c POST test failed, detected by post_output_backlog()
3184 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003185
Heiko Schocher633e03a2007-06-22 19:11:54 +02003186 34 common/cmd_doc.c before loading a Image from a DOC device
3187 -35 common/cmd_doc.c Bad usage of "doc" command
3188 35 common/cmd_doc.c correct usage of "doc" command
3189 -36 common/cmd_doc.c No boot device
3190 36 common/cmd_doc.c correct boot device
3191 -37 common/cmd_doc.c Unknown Chip ID on boot device
3192 37 common/cmd_doc.c correct chip ID found, device available
3193 -38 common/cmd_doc.c Read Error on boot device
3194 38 common/cmd_doc.c reading Image header from DOC device OK
3195 -39 common/cmd_doc.c Image header has bad magic number
3196 39 common/cmd_doc.c Image header has correct magic number
3197 -40 common/cmd_doc.c Error reading Image from DOC device
3198 40 common/cmd_doc.c Image header has correct magic number
3199 41 common/cmd_ide.c before loading a Image from a IDE device
3200 -42 common/cmd_ide.c Bad usage of "ide" command
3201 42 common/cmd_ide.c correct usage of "ide" command
3202 -43 common/cmd_ide.c No boot device
3203 43 common/cmd_ide.c boot device found
3204 -44 common/cmd_ide.c Device not available
3205 44 common/cmd_ide.c Device available
3206 -45 common/cmd_ide.c wrong partition selected
3207 45 common/cmd_ide.c partition selected
3208 -46 common/cmd_ide.c Unknown partition table
3209 46 common/cmd_ide.c valid partition table found
3210 -47 common/cmd_ide.c Invalid partition type
3211 47 common/cmd_ide.c correct partition type
3212 -48 common/cmd_ide.c Error reading Image Header on boot device
3213 48 common/cmd_ide.c reading Image Header from IDE device OK
3214 -49 common/cmd_ide.c Image header has bad magic number
3215 49 common/cmd_ide.c Image header has correct magic number
3216 -50 common/cmd_ide.c Image header has bad checksum
3217 50 common/cmd_ide.c Image header has correct checksum
3218 -51 common/cmd_ide.c Error reading Image from IDE device
3219 51 common/cmd_ide.c reading Image from IDE device OK
3220 52 common/cmd_nand.c before loading a Image from a NAND device
3221 -53 common/cmd_nand.c Bad usage of "nand" command
3222 53 common/cmd_nand.c correct usage of "nand" command
3223 -54 common/cmd_nand.c No boot device
3224 54 common/cmd_nand.c boot device found
3225 -55 common/cmd_nand.c Unknown Chip ID on boot device
3226 55 common/cmd_nand.c correct chip ID found, device available
3227 -56 common/cmd_nand.c Error reading Image Header on boot device
3228 56 common/cmd_nand.c reading Image Header from NAND device OK
3229 -57 common/cmd_nand.c Image header has bad magic number
3230 57 common/cmd_nand.c Image header has correct magic number
3231 -58 common/cmd_nand.c Error reading Image from NAND device
3232 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003233
Heiko Schocher633e03a2007-06-22 19:11:54 +02003234 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003235
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003236 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003237 -64 net/eth.c no Ethernet found.
3238 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003239
Heiko Schocher633e03a2007-06-22 19:11:54 +02003240 -80 common/cmd_net.c usage wrong
3241 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003242 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003243 81 common/cmd_net.c NetLoop() back without error
3244 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3245 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003246 83 common/cmd_net.c running "source" command
3247 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003248 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003249
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003250FIT uImage format:
3251
3252 Arg Where When
3253 100 common/cmd_bootm.c Kernel FIT Image has correct format
3254 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3255 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3256 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3257 102 common/cmd_bootm.c Kernel unit name specified
3258 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003259 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003260 104 common/cmd_bootm.c Got kernel subimage node offset
3261 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3262 105 common/cmd_bootm.c Kernel subimage hash verification OK
3263 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3264 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003265 -106 common/cmd_bootm.c Kernel subimage has wrong type
3266 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003267 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3268 108 common/cmd_bootm.c Got kernel subimage data/size
3269 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3270 -109 common/cmd_bootm.c Can't get kernel subimage type
3271 -110 common/cmd_bootm.c Can't get kernel subimage comp
3272 -111 common/cmd_bootm.c Can't get kernel subimage os
3273 -112 common/cmd_bootm.c Can't get kernel subimage load address
3274 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3275
3276 120 common/image.c Start initial ramdisk verification
3277 -120 common/image.c Ramdisk FIT image has incorrect format
3278 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003279 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003280 -122 common/image.c Can't get configuration for ramdisk subimage
3281 123 common/image.c Ramdisk unit name specified
3282 -124 common/image.c Can't get ramdisk subimage node offset
3283 125 common/image.c Got ramdisk subimage node offset
3284 -125 common/image.c Ramdisk subimage hash verification failed
3285 126 common/image.c Ramdisk subimage hash verification OK
3286 -126 common/image.c Ramdisk subimage for unsupported architecture
3287 127 common/image.c Architecture check OK
3288 -127 common/image.c Can't get ramdisk subimage data/size
3289 128 common/image.c Got ramdisk subimage data/size
3290 129 common/image.c Can't get ramdisk load address
3291 -129 common/image.c Got ramdisk load address
3292
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003293 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003294 131 common/cmd_doc.c FIT image format OK
3295
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003296 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003297 141 common/cmd_ide.c FIT image format OK
3298
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003299 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003300 151 common/cmd_nand.c FIT image format OK
3301
Heiko Schocher515eb122014-05-28 11:33:33 +02003302- legacy image format:
3303 CONFIG_IMAGE_FORMAT_LEGACY
3304 enables the legacy image format support in U-Boot.
3305
3306 Default:
3307 enabled if CONFIG_FIT_SIGNATURE is not defined.
3308
3309 CONFIG_DISABLE_IMAGE_LEGACY
3310 disable the legacy image format
3311
3312 This define is introduced, as the legacy image format is
3313 enabled per default for backward compatibility.
3314
Gabe Blackd572e162012-10-25 16:31:10 +00003315- FIT image support:
3316 CONFIG_FIT
3317 Enable support for the FIT uImage format.
3318
3319 CONFIG_FIT_BEST_MATCH
3320 When no configuration is explicitly selected, default to the
3321 one whose fdt's compatibility field best matches that of
3322 U-Boot itself. A match is considered "best" if it matches the
3323 most specific compatibility entry of U-Boot's fdt's root node.
3324 The order of entries in the configuration's fdt is ignored.
3325
Simon Glass58fe7e52013-06-13 15:10:00 -07003326 CONFIG_FIT_SIGNATURE
3327 This option enables signature verification of FIT uImages,
3328 using a hash signed and verified using RSA. See
3329 doc/uImage.FIT/signature.txt for more details.
3330
Heiko Schocher515eb122014-05-28 11:33:33 +02003331 WARNING: When relying on signed FIT images with required
3332 signature check the legacy image format is default
3333 disabled. If a board need legacy image format support
3334 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3335
Dirk Eibach88919ca2014-07-03 09:28:26 +02003336 CONFIG_FIT_DISABLE_SHA256
3337 Supporting SHA256 hashes has quite an impact on binary size.
3338 For constrained systems sha256 hash support can be disabled
3339 with this option.
3340
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003341- Standalone program support:
3342 CONFIG_STANDALONE_LOAD_ADDR
3343
Wolfgang Denk23f78482011-10-09 21:06:34 +02003344 This option defines a board specific value for the
3345 address where standalone program gets loaded, thus
3346 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003347 settings.
3348
3349- Frame Buffer Address:
3350 CONFIG_FB_ADDR
3351
3352 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003353 address for frame buffer. This is typically the case
3354 when using a graphics controller has separate video
3355 memory. U-Boot will then place the frame buffer at
3356 the given address instead of dynamically reserving it
3357 in system RAM by calling lcd_setmem(), which grabs
3358 the memory for the frame buffer depending on the
3359 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003360
3361 Please see board_init_f function.
3362
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003363- Automatic software updates via TFTP server
3364 CONFIG_UPDATE_TFTP
3365 CONFIG_UPDATE_TFTP_CNT_MAX
3366 CONFIG_UPDATE_TFTP_MSEC_MAX
3367
3368 These options enable and control the auto-update feature;
3369 for a more detailed description refer to doc/README.update.
3370
3371- MTD Support (mtdparts command, UBI support)
3372 CONFIG_MTD_DEVICE
3373
3374 Adds the MTD device infrastructure from the Linux kernel.
3375 Needed for mtdparts command support.
3376
3377 CONFIG_MTD_PARTITIONS
3378
3379 Adds the MTD partitioning infrastructure from the Linux
3380 kernel. Needed for UBI support.
3381
Heiko Schocherf5895d12014-06-24 10:10:04 +02003382 CONFIG_MTD_NAND_VERIFY_WRITE
3383 verify if the written data is correct reread.
3384
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003385- UBI support
3386 CONFIG_CMD_UBI
3387
3388 Adds commands for interacting with MTD partitions formatted
3389 with the UBI flash translation layer
3390
3391 Requires also defining CONFIG_RBTREE
3392
Joe Hershberger47550fc2013-04-08 10:32:49 +00003393 CONFIG_UBI_SILENCE_MSG
3394
3395 Make the verbose messages from UBI stop printing. This leaves
3396 warnings and errors enabled.
3397
Heiko Schocherf5895d12014-06-24 10:10:04 +02003398
3399 CONFIG_MTD_UBI_WL_THRESHOLD
3400 This parameter defines the maximum difference between the highest
3401 erase counter value and the lowest erase counter value of eraseblocks
3402 of UBI devices. When this threshold is exceeded, UBI starts performing
3403 wear leveling by means of moving data from eraseblock with low erase
3404 counter to eraseblocks with high erase counter.
3405
3406 The default value should be OK for SLC NAND flashes, NOR flashes and
3407 other flashes which have eraseblock life-cycle 100000 or more.
3408 However, in case of MLC NAND flashes which typically have eraseblock
3409 life-cycle less than 10000, the threshold should be lessened (e.g.,
3410 to 128 or 256, although it does not have to be power of 2).
3411
3412 default: 4096
3413
3414 CONFIG_MTD_UBI_BEB_LIMIT
3415 This option specifies the maximum bad physical eraseblocks UBI
3416 expects on the MTD device (per 1024 eraseblocks). If the
3417 underlying flash does not admit of bad eraseblocks (e.g. NOR
3418 flash), this value is ignored.
3419
3420 NAND datasheets often specify the minimum and maximum NVM
3421 (Number of Valid Blocks) for the flashes' endurance lifetime.
3422 The maximum expected bad eraseblocks per 1024 eraseblocks
3423 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3424 which gives 20 for most NANDs (MaxNVB is basically the total
3425 count of eraseblocks on the chip).
3426
3427 To put it differently, if this value is 20, UBI will try to
3428 reserve about 1.9% of physical eraseblocks for bad blocks
3429 handling. And that will be 1.9% of eraseblocks on the entire
3430 NAND chip, not just the MTD partition UBI attaches. This means
3431 that if you have, say, a NAND flash chip admits maximum 40 bad
3432 eraseblocks, and it is split on two MTD partitions of the same
3433 size, UBI will reserve 40 eraseblocks when attaching a
3434 partition.
3435
3436 default: 20
3437
3438 CONFIG_MTD_UBI_FASTMAP
3439 Fastmap is a mechanism which allows attaching an UBI device
3440 in nearly constant time. Instead of scanning the whole MTD device it
3441 only has to locate a checkpoint (called fastmap) on the device.
3442 The on-flash fastmap contains all information needed to attach
3443 the device. Using fastmap makes only sense on large devices where
3444 attaching by scanning takes long. UBI will not automatically install
3445 a fastmap on old images, but you can set the UBI parameter
3446 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3447 that fastmap-enabled images are still usable with UBI implementations
3448 without fastmap support. On typical flash devices the whole fastmap
3449 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3450
3451 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3452 Set this parameter to enable fastmap automatically on images
3453 without a fastmap.
3454 default: 0
3455
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003456- UBIFS support
3457 CONFIG_CMD_UBIFS
3458
3459 Adds commands for interacting with UBI volumes formatted as
3460 UBIFS. UBIFS is read-only in u-boot.
3461
3462 Requires UBI support as well as CONFIG_LZO
3463
Joe Hershberger47550fc2013-04-08 10:32:49 +00003464 CONFIG_UBIFS_SILENCE_MSG
3465
3466 Make the verbose messages from UBIFS stop printing. This leaves
3467 warnings and errors enabled.
3468
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003469- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003470 CONFIG_SPL
3471 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003472
Tom Rini36853852012-02-14 07:29:40 +00003473 CONFIG_SPL_LDSCRIPT
3474 LDSCRIPT for linking the SPL binary.
3475
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003476 CONFIG_SPL_MAX_FOOTPRINT
3477 Maximum size in memory allocated to the SPL, BSS included.
3478 When defined, the linker checks that the actual memory
3479 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003480 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003481 must not be both defined at the same time.
3482
Tom Rini36853852012-02-14 07:29:40 +00003483 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003484 Maximum size of the SPL image (text, data, rodata, and
3485 linker lists sections), BSS excluded.
3486 When defined, the linker checks that the actual size does
3487 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003488
Wolfgang Denk825223d2011-09-11 21:24:09 +02003489 CONFIG_SPL_TEXT_BASE
3490 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003491
Scott Woodc4f0d002012-09-20 19:05:12 -05003492 CONFIG_SPL_RELOC_TEXT_BASE
3493 Address to relocate to. If unspecified, this is equal to
3494 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3495
Tom Rini36853852012-02-14 07:29:40 +00003496 CONFIG_SPL_BSS_START_ADDR
3497 Link address for the BSS within the SPL binary.
3498
3499 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003500 Maximum size in memory allocated to the SPL BSS.
3501 When defined, the linker checks that the actual memory used
3502 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003503 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003504 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003505
3506 CONFIG_SPL_STACK
3507 Adress of the start of the stack SPL will use
3508
Scott Woodc4f0d002012-09-20 19:05:12 -05003509 CONFIG_SPL_RELOC_STACK
3510 Adress of the start of the stack SPL will use after
3511 relocation. If unspecified, this is equal to
3512 CONFIG_SPL_STACK.
3513
Tom Rini36853852012-02-14 07:29:40 +00003514 CONFIG_SYS_SPL_MALLOC_START
3515 Starting address of the malloc pool used in SPL.
3516
3517 CONFIG_SYS_SPL_MALLOC_SIZE
3518 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003519
Tom Rini28591df2012-08-13 12:03:19 -07003520 CONFIG_SPL_FRAMEWORK
3521 Enable the SPL framework under common/. This framework
3522 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3523 NAND loading of the Linux Kernel.
3524
Tom Rinic2b76002014-03-28 12:03:39 -04003525 CONFIG_SPL_OS_BOOT
3526 Enable booting directly to an OS from SPL.
3527 See also: doc/README.falcon
3528
Tom Rinife3b0c72012-08-13 11:37:56 -07003529 CONFIG_SPL_DISPLAY_PRINT
3530 For ARM, enable an optional function to print more information
3531 about the running system.
3532
Scott Wood7c810902012-09-20 16:35:21 -05003533 CONFIG_SPL_INIT_MINIMAL
3534 Arch init code should be built for a very small image
3535
Wolfgang Denk825223d2011-09-11 21:24:09 +02003536 CONFIG_SPL_LIBCOMMON_SUPPORT
3537 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003538
Wolfgang Denk825223d2011-09-11 21:24:09 +02003539 CONFIG_SPL_LIBDISK_SUPPORT
3540 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003541
Wolfgang Denk825223d2011-09-11 21:24:09 +02003542 CONFIG_SPL_I2C_SUPPORT
3543 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003544
Wolfgang Denk825223d2011-09-11 21:24:09 +02003545 CONFIG_SPL_GPIO_SUPPORT
3546 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003547
Wolfgang Denk825223d2011-09-11 21:24:09 +02003548 CONFIG_SPL_MMC_SUPPORT
3549 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003550
Tom Rini36853852012-02-14 07:29:40 +00003551 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3552 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3553 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3554 Address, size and partition on the MMC to load U-Boot from
3555 when the MMC is being used in raw mode.
3556
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003557 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3558 Sector to load kernel uImage from when MMC is being
3559 used in raw mode (for Falcon mode)
3560
3561 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3562 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3563 Sector and number of sectors to load kernel argument
3564 parameters from when MMC is being used in raw mode
3565 (for falcon mode)
3566
Tom Rini36853852012-02-14 07:29:40 +00003567 CONFIG_SPL_FAT_SUPPORT
3568 Support for fs/fat/libfat.o in SPL binary
3569
3570 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3571 Filename to read to load U-Boot when reading from FAT
3572
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003573 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3574 Filename to read to load kernel uImage when reading
3575 from FAT (for Falcon mode)
3576
3577 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3578 Filename to read to load kernel argument parameters
3579 when reading from FAT (for Falcon mode)
3580
Scott Wood2b36fbb2012-12-06 13:33:17 +00003581 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3582 Set this for NAND SPL on PPC mpc83xx targets, so that
3583 start.S waits for the rest of the SPL to load before
3584 continuing (the hardware starts execution after just
3585 loading the first page rather than the full 4K).
3586
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303587 CONFIG_SPL_SKIP_RELOCATE
3588 Avoid SPL relocation
3589
Scott Woodc352a0c2012-09-20 19:09:07 -05003590 CONFIG_SPL_NAND_BASE
3591 Include nand_base.c in the SPL. Requires
3592 CONFIG_SPL_NAND_DRIVERS.
3593
3594 CONFIG_SPL_NAND_DRIVERS
3595 SPL uses normal NAND drivers, not minimal drivers.
3596
3597 CONFIG_SPL_NAND_ECC
3598 Include standard software ECC in the SPL
3599
Tom Rini36853852012-02-14 07:29:40 +00003600 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003601 Support for NAND boot using simple NAND drivers that
3602 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003603
Tom Rini543c9f12014-03-28 12:03:36 -04003604 CONFIG_SPL_MTD_SUPPORT
3605 Support for the MTD subsystem within SPL. Useful for
3606 environment on NAND support within SPL.
3607
Ying Zhang9ff70262013-08-16 15:16:11 +08003608 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3609 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003610 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003611
Ying Zhangdfb2b152013-08-16 15:16:12 +08003612 CONFIG_SPL_COMMON_INIT_DDR
3613 Set for common ddr init with serial presence detect in
3614 SPL binary.
3615
Tom Rini36853852012-02-14 07:29:40 +00003616 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3617 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3618 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3619 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3620 CONFIG_SYS_NAND_ECCBYTES
3621 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003622 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003623
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303624 CONFIG_SPL_NAND_BOOT
3625 Add support NAND boot
3626
Tom Rini36853852012-02-14 07:29:40 +00003627 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003628 Location in NAND to read U-Boot from
3629
3630 CONFIG_SYS_NAND_U_BOOT_DST
3631 Location in memory to load U-Boot to
3632
3633 CONFIG_SYS_NAND_U_BOOT_SIZE
3634 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003635
3636 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003637 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003638
3639 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3640 Define this if you need to first read the OOB and then the
3641 data. This is used for example on davinci plattforms.
3642
3643 CONFIG_SPL_OMAP3_ID_NAND
3644 Support for an OMAP3-specific set of functions to return the
3645 ID and MFR of the first attached NAND chip, if present.
3646
Wolfgang Denk825223d2011-09-11 21:24:09 +02003647 CONFIG_SPL_SERIAL_SUPPORT
3648 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003649
Wolfgang Denk825223d2011-09-11 21:24:09 +02003650 CONFIG_SPL_SPI_FLASH_SUPPORT
3651 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003652
Wolfgang Denk825223d2011-09-11 21:24:09 +02003653 CONFIG_SPL_SPI_SUPPORT
3654 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003655
Pavel Machekde997252012-08-30 22:42:11 +02003656 CONFIG_SPL_RAM_DEVICE
3657 Support for running image already present in ram, in SPL binary
3658
Wolfgang Denk825223d2011-09-11 21:24:09 +02003659 CONFIG_SPL_LIBGENERIC_SUPPORT
3660 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003661
Ying Zhang602f7d32013-05-20 14:07:25 +08003662 CONFIG_SPL_ENV_SUPPORT
3663 Support for the environment operating in SPL binary
3664
3665 CONFIG_SPL_NET_SUPPORT
3666 Support for the net/libnet.o in SPL binary.
3667 It conflicts with SPL env from storage medium specified by
3668 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3669
Scott Woodeb7bd972012-12-06 13:33:16 +00003670 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003671 Image offset to which the SPL should be padded before appending
3672 the SPL payload. By default, this is defined as
3673 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3674 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3675 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003676
Scott Woodf147eb72012-09-21 16:27:32 -05003677 CONFIG_SPL_TARGET
3678 Final target image containing SPL and payload. Some SPLs
3679 use an arch-specific makefile fragment instead, for
3680 example if more than one image needs to be produced.
3681
Simon Glass82d94532013-05-08 08:05:59 +00003682 CONFIG_FIT_SPL_PRINT
3683 Printing information about a FIT image adds quite a bit of
3684 code to SPL. So this is normally disabled in SPL. Use this
3685 option to re-enable it. This will affect the output of the
3686 bootm command when booting a FIT image.
3687
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003688- TPL framework
3689 CONFIG_TPL
3690 Enable building of TPL globally.
3691
3692 CONFIG_TPL_PAD_TO
3693 Image offset to which the TPL should be padded before appending
3694 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003695 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3696 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3697 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003698
wdenkc6097192002-11-03 00:24:07 +00003699Modem Support:
3700--------------
3701
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003702[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003703
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003704- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003705 CONFIG_MODEM_SUPPORT
3706
3707- RTS/CTS Flow control enable:
3708 CONFIG_HWFLOW
3709
3710- Modem debug support:
3711 CONFIG_MODEM_SUPPORT_DEBUG
3712
wdenk4a5c8a72003-03-06 00:02:04 +00003713 Enables debugging stuff (char screen[1024], dbg())
3714 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003715
wdenkc0aa5c52003-12-06 19:49:23 +00003716- Interrupt support (PPC):
3717
wdenk1ebf41e2004-01-02 14:00:00 +00003718 There are common interrupt_init() and timer_interrupt()
3719 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003720 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003721 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003722 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003723 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003724 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003725 specific handling. If board has watchdog / status_led
3726 / other_activity_monitor it works automatically from
3727 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003728
wdenkc6097192002-11-03 00:24:07 +00003729- General:
3730
wdenk4a5c8a72003-03-06 00:02:04 +00003731 In the target system modem support is enabled when a
3732 specific key (key combination) is pressed during
3733 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003734 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003735 board_init(). Currently key_pressed() is a dummy
3736 function, returning 1 and thus enabling modem
3737 initialization.
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk4a5c8a72003-03-06 00:02:04 +00003739 If there are no modem init strings in the
3740 environment, U-Boot proceed to autoboot; the
3741 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003742 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003743
3744 See also: doc/README.Modem
3745
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003746Board initialization settings:
3747------------------------------
3748
3749During Initialization u-boot calls a number of board specific functions
3750to allow the preparation of board specific prerequisites, e.g. pin setup
3751before drivers are initialized. To enable these callbacks the
3752following configuration macros have to be defined. Currently this is
3753architecture specific, so please check arch/your_architecture/lib/board.c
3754typically in board_init_f() and board_init_r().
3755
3756- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3757- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3758- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3759- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003760
wdenkc6097192002-11-03 00:24:07 +00003761Configuration Settings:
3762-----------------------
3763
York Sun6c480012014-02-26 17:03:19 -08003764- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3765 Optionally it can be defined to support 64-bit memory commands.
3766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003768 undefine this when you're short of memory.
3769
Peter Tyserdfb72b82009-01-27 18:03:12 -06003770- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3771 width of the commands listed in the 'help' command output.
3772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003773- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003774 prompt for user input.
3775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003777
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003778- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003779
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003780- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003781
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003782- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003783 the application (usually a Linux kernel) when it is
3784 booted
3785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003786- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003787 List of legal baudrate settings for this board.
3788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003789- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003790 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003792- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003793 If the board specific function
3794 extern int overwrite_console (void);
3795 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003796 serial port, else the settings in the environment are used.
3797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003798- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003799 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003800
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003801- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003802 Enable overwrite of previous console environment settings.
3803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003804- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003805 Begin and End addresses of the area used by the
3806 simple memory test.
3807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003808- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003809 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003811- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003812 Scratch address used by the alternate memory test
3813 You only need to set this if address zero isn't writeable
3814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003815- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3816 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003817 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003818 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003819 fixing up gd->ram_size the Linux kernel should gets passed
3820 the now "corrected" memory size and won't touch it either.
3821 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003822 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003823 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003824 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003825
3826 This option can be used as a workaround for the 440EPx/GRx
3827 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3828 be touched.
3829
3830 WARNING: Please make sure that this value is a multiple of
3831 the Linux page size (normally 4k). If this is not the case,
3832 then the end address of the Linux memory will be located at a
3833 non page size aligned address and this could cause major
3834 problems.
3835
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003836- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003837 Enable temporary baudrate change while serial download
3838
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003839- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003840 Physical start address of SDRAM. _Must_ be 0 here.
3841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003842- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003843 Physical start address of Motherboard I/O (if using a
3844 Cogent motherboard)
3845
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003846- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003847 Physical start address of Flash memory.
3848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003850 Physical start address of boot monitor code (set by
3851 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003852 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003853 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003854
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003855- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003856 Size of memory reserved for monitor code, used to
3857 determine _at_compile_time_ (!) if the environment is
3858 embedded within the U-Boot image, or in a separate
3859 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003860
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003861- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003862 Size of DRAM reserved for malloc() use.
3863
Simon Glass863e4042014-07-10 22:23:28 -06003864- CONFIG_SYS_MALLOC_F_LEN
3865 Size of the malloc() pool for use before relocation. If
3866 this is defined, then a very simple malloc() implementation
3867 will become available before relocation. The address is just
3868 below the global data, and the stack is moved down to make
3869 space.
3870
3871 This feature allocates regions with increasing addresses
3872 within the region. calloc() is supported, but realloc()
3873 is not available. free() is supported but does nothing.
3874 The memory will be freed (or in fact just forgotton) when
3875 U-Boot relocates itself.
3876
Simon Glasse997f752014-09-15 06:33:18 -06003877 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003878 at present but is fairly easy to enable for other archs.
3879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003880- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003881 Normally compressed uImages are limited to an
3882 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003883 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003884 to adjust this setting to your needs.
3885
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003886- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003887 Maximum size of memory mapped by the startup code of
3888 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003889 the Linux kernel (bd_info, boot arguments, FDT blob if
3890 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003891 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003892 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003893 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003894 variable "bootm_mapsize" will override the value of
3895 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3896 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003897
John Rigbyeea8e692010-10-13 13:57:35 -06003898- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3899 Enable initrd_high functionality. If defined then the
3900 initrd_high feature is enabled and the bootm ramdisk subcommand
3901 is enabled.
3902
3903- CONFIG_SYS_BOOT_GET_CMDLINE:
3904 Enables allocating and saving kernel cmdline in space between
3905 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3906
3907- CONFIG_SYS_BOOT_GET_KBD:
3908 Enables allocating and saving a kernel copy of the bd_info in
3909 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003911- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003912 Max number of Flash memory banks
3913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003914- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003915 Max number of sectors on a Flash chip
3916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003917- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003918 Timeout for Flash erase operations (in ms)
3919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003920- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003921 Timeout for Flash write operations (in ms)
3922
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003923- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003924 Timeout for Flash set sector lock bit operation (in ms)
3925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003926- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003927 Timeout for Flash clear lock bits operation (in ms)
3928
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003930 If defined, hardware flash sectors protection is used
3931 instead of U-Boot software protection.
3932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003933- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003934
3935 Enable TFTP transfers directly to flash memory;
3936 without this option such a download has to be
3937 performed in two steps: (1) download to RAM, and (2)
3938 copy from RAM to flash.
3939
3940 The two-step approach is usually more reliable, since
3941 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003942 the flash, but in some situations (when system RAM is
3943 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003944 downloaded image) this option may be very useful.
3945
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003946- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003947 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003948 common flash structure for storing flash geometry.
3949
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003950- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003951 This option also enables the building of the cfi_flash driver
3952 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003953
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003954- CONFIG_FLASH_CFI_MTD
3955 This option enables the building of the cfi_mtd driver
3956 in the drivers directory. The driver exports CFI flash
3957 to the MTD layer.
3958
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003959- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003960 Use buffered writes to flash.
3961
3962- CONFIG_FLASH_SPANSION_S29WS_N
3963 s29ws-n MirrorBit flash has non-standard addresses for buffered
3964 write commands.
3965
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003966- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003967 If this option is defined, the common CFI flash doesn't
3968 print it's warning upon not recognized FLASH banks. This
3969 is useful, if some of the configured banks are only
3970 optionally available.
3971
Jerry Van Barenaae73572008-03-08 13:48:01 -05003972- CONFIG_FLASH_SHOW_PROGRESS
3973 If defined (must be an integer), print out countdown
3974 digits and dots. Recommended value: 45 (9..1) for 80
3975 column displays, 15 (3..1) for 40 column displays.
3976
Stefan Roesed20cba52013-04-04 15:53:14 +02003977- CONFIG_FLASH_VERIFY
3978 If defined, the content of the flash (destination) is compared
3979 against the source after the write operation. An error message
3980 will be printed when the contents are not identical.
3981 Please note that this option is useless in nearly all cases,
3982 since such flash programming errors usually are detected earlier
3983 while unprotecting/erasing/programming. Please only enable
3984 this option if you really know what you are doing.
3985
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003986- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003987 Defines the number of Ethernet receive buffers. On some
3988 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003989 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3990 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003991 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003992 Defaults to 4 if not defined.
3993
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003994- CONFIG_ENV_MAX_ENTRIES
3995
Wolfgang Denk1136f692010-10-27 22:48:30 +02003996 Maximum number of entries in the hash table that is used
3997 internally to store the environment settings. The default
3998 setting is supposed to be generous and should work in most
3999 cases. This setting can be used to tune behaviour; see
4000 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004001
Joe Hershberger71497d02012-12-11 22:16:31 -06004002- CONFIG_ENV_FLAGS_LIST_DEFAULT
4003- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004004 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004005 calling env set. Variables can be restricted to only decimal,
4006 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4007 the variables can also be restricted to IP address or MAC address.
4008
4009 The format of the list is:
4010 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004011 access_atribute = [a|r|o|c]
4012 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004013 entry = variable_name[:attributes]
4014 list = entry[,list]
4015
4016 The type attributes are:
4017 s - String (default)
4018 d - Decimal
4019 x - Hexadecimal
4020 b - Boolean ([1yYtT|0nNfF])
4021 i - IP address
4022 m - MAC address
4023
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004024 The access attributes are:
4025 a - Any (default)
4026 r - Read-only
4027 o - Write-once
4028 c - Change-default
4029
Joe Hershberger71497d02012-12-11 22:16:31 -06004030 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4031 Define this to a list (string) to define the ".flags"
4032 envirnoment variable in the default or embedded environment.
4033
4034 - CONFIG_ENV_FLAGS_LIST_STATIC
4035 Define this to a list (string) to define validation that
4036 should be done if an entry is not found in the ".flags"
4037 environment variable. To override a setting in the static
4038 list, simply add an entry for the same variable name to the
4039 ".flags" variable.
4040
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004041- CONFIG_ENV_ACCESS_IGNORE_FORCE
4042 If defined, don't allow the -f switch to env set override variable
4043 access flags.
4044
Simon Glass66828322013-03-08 13:45:27 +00004045- CONFIG_SYS_GENERIC_BOARD
4046 This selects the architecture-generic board system instead of the
4047 architecture-specific board files. It is intended to move boards
4048 to this new framework over time. Defining this will disable the
4049 arch/foo/lib/board.c file and use common/board_f.c and
4050 common/board_r.c instead. To use this option your architecture
4051 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4052 its config.mk file). If you find problems enabling this option on
4053 your board please report the problem and send patches!
4054
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004055- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4056 This is set by OMAP boards for the max time that reset should
4057 be asserted. See doc/README.omap-reset-time for details on how
4058 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004059
wdenkc6097192002-11-03 00:24:07 +00004060The following definitions that deal with the placement and management
4061of environment data (variable area); in general, we support the
4062following configurations:
4063
Mike Frysinger63b8f122011-07-08 10:44:25 +00004064- CONFIG_BUILD_ENVCRC:
4065
4066 Builds up envcrc with the target environment so that external utils
4067 may easily extract it and embed it in final U-Boot images.
4068
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004069- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004070
4071 Define this if the environment is in flash memory.
4072
4073 a) The environment occupies one whole flash sector, which is
4074 "embedded" in the text segment with the U-Boot code. This
4075 happens usually with "bottom boot sector" or "top boot
4076 sector" type flash chips, which have several smaller
4077 sectors at the start or the end. For instance, such a
4078 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4079 such a case you would place the environment in one of the
4080 4 kB sectors - with U-Boot code before and after it. With
4081 "top boot sector" type flash chips, you would put the
4082 environment in one of the last sectors, leaving a gap
4083 between U-Boot and the environment.
4084
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004085 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004086
4087 Offset of environment data (variable area) to the
4088 beginning of flash memory; for instance, with bottom boot
4089 type flash chips the second sector can be used: the offset
4090 for this sector is given here.
4091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004092 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004093
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004094 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004095
4096 This is just another way to specify the start address of
4097 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004098 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004099
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004100 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004101
4102 Size of the sector containing the environment.
4103
4104
4105 b) Sometimes flash chips have few, equal sized, BIG sectors.
4106 In such a case you don't want to spend a whole sector for
4107 the environment.
4108
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004109 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004110
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004111 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004112 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004113 of this flash sector for the environment. This saves
4114 memory for the RAM copy of the environment.
4115
4116 It may also save flash memory if you decide to use this
4117 when your environment is "embedded" within U-Boot code,
4118 since then the remainder of the flash sector could be used
4119 for U-Boot code. It should be pointed out that this is
4120 STRONGLY DISCOURAGED from a robustness point of view:
4121 updating the environment in flash makes it always
4122 necessary to erase the WHOLE sector. If something goes
4123 wrong before the contents has been restored from a copy in
4124 RAM, your target system will be dead.
4125
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004126 - CONFIG_ENV_ADDR_REDUND
4127 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk4a5c8a72003-03-06 00:02:04 +00004129 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004130 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004131 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004132 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004133
4134BE CAREFUL! Any changes to the flash layout, and some changes to the
4135source code will make it necessary to adapt <board>/u-boot.lds*
4136accordingly!
4137
4138
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004139- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004140
4141 Define this if you have some non-volatile memory device
4142 (NVRAM, battery buffered SRAM) which you want to use for the
4143 environment.
4144
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004145 - CONFIG_ENV_ADDR:
4146 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004147
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004148 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004149 want to use for environment. It is assumed that this memory
4150 can just be read and written to, without any special
4151 provision.
4152
4153BE CAREFUL! The first access to the environment happens quite early
4154in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004155console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004156U-Boot will hang.
4157
4158Please note that even with NVRAM we still use a copy of the
4159environment in RAM: we could work on NVRAM directly, but we want to
4160keep settings there always unmodified except somebody uses "saveenv"
4161to save the current settings.
4162
4163
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004164- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004165
4166 Use this if you have an EEPROM or similar serial access
4167 device and a driver for it.
4168
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004169 - CONFIG_ENV_OFFSET:
4170 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004171
4172 These two #defines specify the offset and size of the
4173 environment area within the total memory of your EEPROM.
4174
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004175 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004176 If defined, specified the chip address of the EEPROM device.
4177 The default address is zero.
4178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004179 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004180 If defined, the number of bits used to address bytes in a
4181 single page in the EEPROM device. A 64 byte page, for example
4182 would require six bits.
4183
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004184 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004185 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004186 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004188 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004189 The length in bytes of the EEPROM memory array address. Note
4190 that this is NOT the chip address length!
4191
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004192 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004193 EEPROM chips that implement "address overflow" are ones
4194 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4195 address and the extra bits end up in the "chip address" bit
4196 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4197 byte chips.
4198
4199 Note that we consider the length of the address field to
4200 still be one byte because the extra address bits are hidden
4201 in the chip address.
4202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004203 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004204 The size in bytes of the EEPROM device.
4205
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004206 - CONFIG_ENV_EEPROM_IS_ON_I2C
4207 define this, if you have I2C and SPI activated, and your
4208 EEPROM, which holds the environment, is on the I2C bus.
4209
4210 - CONFIG_I2C_ENV_EEPROM_BUS
4211 if you have an Environment on an EEPROM reached over
4212 I2C muxes, you can define here, how to reach this
4213 EEPROM. For example:
4214
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004215 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004216
4217 EEPROM which holds the environment, is reached over
4218 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004219
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004220- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004221
wdenk1ebf41e2004-01-02 14:00:00 +00004222 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004223 want to use for the environment.
4224
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004225 - CONFIG_ENV_OFFSET:
4226 - CONFIG_ENV_ADDR:
4227 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004228
4229 These three #defines specify the offset and size of the
4230 environment area within the total memory of your DataFlash placed
4231 at the specified address.
4232
Wu, Josh76db7bf2014-07-01 19:30:13 +08004233- CONFIG_ENV_IS_IN_SPI_FLASH:
4234
4235 Define this if you have a SPI Flash memory device which you
4236 want to use for the environment.
4237
4238 - CONFIG_ENV_OFFSET:
4239 - CONFIG_ENV_SIZE:
4240
4241 These two #defines specify the offset and size of the
4242 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4243 aligned to an erase sector boundary.
4244
4245 - CONFIG_ENV_SECT_SIZE:
4246
4247 Define the SPI flash's sector size.
4248
4249 - CONFIG_ENV_OFFSET_REDUND (optional):
4250
4251 This setting describes a second storage area of CONFIG_ENV_SIZE
4252 size used to hold a redundant copy of the environment data, so
4253 that there is a valid backup copy in case there is a power failure
4254 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4255 aligned to an erase sector boundary.
4256
4257 - CONFIG_ENV_SPI_BUS (optional):
4258 - CONFIG_ENV_SPI_CS (optional):
4259
4260 Define the SPI bus and chip select. If not defined they will be 0.
4261
4262 - CONFIG_ENV_SPI_MAX_HZ (optional):
4263
4264 Define the SPI max work clock. If not defined then use 1MHz.
4265
4266 - CONFIG_ENV_SPI_MODE (optional):
4267
4268 Define the SPI work mode. If not defined then use SPI_MODE_3.
4269
Liu Gang85bcd732012-03-08 00:33:20 +00004270- CONFIG_ENV_IS_IN_REMOTE:
4271
4272 Define this if you have a remote memory space which you
4273 want to use for the local device's environment.
4274
4275 - CONFIG_ENV_ADDR:
4276 - CONFIG_ENV_SIZE:
4277
4278 These two #defines specify the address and size of the
4279 environment area within the remote memory space. The
4280 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004281 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004282
4283BE CAREFUL! For some special cases, the local device can not use
4284"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004285environment stored in a remote NOR flash by SRIO or PCIE link,
4286but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004287
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004288- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004289
4290 Define this if you have a NAND device which you want to use
4291 for the environment.
4292
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004293 - CONFIG_ENV_OFFSET:
4294 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004295
4296 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004297 area within the first NAND device. CONFIG_ENV_OFFSET must be
4298 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004299
Scott Wood08239322010-09-17 14:38:37 -05004300 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004301
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004302 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004303 size used to hold a redundant copy of the environment data, so
4304 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004305 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004306 aligned to an erase block boundary.
4307
4308 - CONFIG_ENV_RANGE (optional):
4309
4310 Specifies the length of the region in which the environment
4311 can be written. This should be a multiple of the NAND device's
4312 block size. Specifying a range with more erase blocks than
4313 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4314 the range to be avoided.
4315
4316 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004317
Scott Wood08239322010-09-17 14:38:37 -05004318 Enables support for dynamically retrieving the offset of the
4319 environment from block zero's out-of-band data. The
4320 "nand env.oob" command can be used to record this offset.
4321 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4322 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004323
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004324- CONFIG_NAND_ENV_DST
4325
4326 Defines address in RAM to which the nand_spl code should copy the
4327 environment. If redundant environment is used, it will be copied to
4328 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4329
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004330- CONFIG_ENV_IS_IN_UBI:
4331
4332 Define this if you have an UBI volume that you want to use for the
4333 environment. This has the benefit of wear-leveling the environment
4334 accesses, which is important on NAND.
4335
4336 - CONFIG_ENV_UBI_PART:
4337
4338 Define this to a string that is the mtd partition containing the UBI.
4339
4340 - CONFIG_ENV_UBI_VOLUME:
4341
4342 Define this to the name of the volume that you want to store the
4343 environment in.
4344
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004345 - CONFIG_ENV_UBI_VOLUME_REDUND:
4346
4347 Define this to the name of another volume to store a second copy of
4348 the environment in. This will enable redundant environments in UBI.
4349 It is assumed that both volumes are in the same MTD partition.
4350
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004351 - CONFIG_UBI_SILENCE_MSG
4352 - CONFIG_UBIFS_SILENCE_MSG
4353
4354 You will probably want to define these to avoid a really noisy system
4355 when storing the env in UBI.
4356
Wu, Josha7d0c872014-06-24 17:31:03 +08004357- CONFIG_ENV_IS_IN_FAT:
4358 Define this if you want to use the FAT file system for the environment.
4359
4360 - FAT_ENV_INTERFACE:
4361
4362 Define this to a string that is the name of the block device.
4363
4364 - FAT_ENV_DEV_AND_PART:
4365
4366 Define this to a string to specify the partition of the device. It can
4367 be as following:
4368
4369 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4370 - "D:P": device D partition P. Error occurs if device D has no
4371 partition table.
4372 - "D:0": device D.
4373 - "D" or "D:": device D partition 1 if device D has partition
4374 table, or the whole device D if has no partition
4375 table.
4376 - "D:auto": first partition in device D with bootable flag set.
4377 If none, first valid paratition in device D. If no
4378 partition table then means device D.
4379
4380 - FAT_ENV_FILE:
4381
4382 It's a string of the FAT file name. This file use to store the
4383 envrionment.
4384
4385 - CONFIG_FAT_WRITE:
4386 This should be defined. Otherwise it cannot save the envrionment file.
4387
Stephen Warreneedcacd2013-06-11 15:14:00 -06004388- CONFIG_ENV_IS_IN_MMC:
4389
4390 Define this if you have an MMC device which you want to use for the
4391 environment.
4392
4393 - CONFIG_SYS_MMC_ENV_DEV:
4394
4395 Specifies which MMC device the environment is stored in.
4396
4397 - CONFIG_SYS_MMC_ENV_PART (optional):
4398
4399 Specifies which MMC partition the environment is stored in. If not
4400 set, defaults to partition 0, the user area. Common values might be
4401 1 (first MMC boot partition), 2 (second MMC boot partition).
4402
4403 - CONFIG_ENV_OFFSET:
4404 - CONFIG_ENV_SIZE:
4405
4406 These two #defines specify the offset and size of the environment
4407 area within the specified MMC device.
4408
Stephen Warren24dc2032013-06-11 15:14:02 -06004409 If offset is positive (the usual case), it is treated as relative to
4410 the start of the MMC partition. If offset is negative, it is treated
4411 as relative to the end of the MMC partition. This can be useful if
4412 your board may be fitted with different MMC devices, which have
4413 different sizes for the MMC partitions, and you always want the
4414 environment placed at the very end of the partition, to leave the
4415 maximum possible space before it, to store other data.
4416
Stephen Warreneedcacd2013-06-11 15:14:00 -06004417 These two values are in units of bytes, but must be aligned to an
4418 MMC sector boundary.
4419
4420 - CONFIG_ENV_OFFSET_REDUND (optional):
4421
4422 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4423 hold a redundant copy of the environment data. This provides a
4424 valid backup copy in case the other copy is corrupted, e.g. due
4425 to a power failure during a "saveenv" operation.
4426
Stephen Warren24dc2032013-06-11 15:14:02 -06004427 This value may also be positive or negative; this is handled in the
4428 same way as CONFIG_ENV_OFFSET.
4429
Stephen Warreneedcacd2013-06-11 15:14:00 -06004430 This value is also in units of bytes, but must also be aligned to
4431 an MMC sector boundary.
4432
4433 - CONFIG_ENV_SIZE_REDUND (optional):
4434
4435 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4436 set. If this value is set, it must be set to the same value as
4437 CONFIG_ENV_SIZE.
4438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004439- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004440
4441 Defines offset to the initial SPI buffer area in DPRAM. The
4442 area is used at an early stage (ROM part) if the environment
4443 is configured to reside in the SPI EEPROM: We need a 520 byte
4444 scratch DPRAM area. It is used between the two initialization
4445 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4446 to be a good choice since it makes it far enough from the
4447 start of the data area as well as from the stack pointer.
4448
Bruce Adleredecc942007-11-02 13:15:42 -07004449Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004450has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004451created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004452until then to read environment variables.
4453
wdenk8dba0502003-03-31 16:34:49 +00004454The environment is protected by a CRC32 checksum. Before the monitor
4455is relocated into RAM, as a result of a bad CRC you will be working
4456with the compiled-in default environment - *silently*!!! [This is
4457necessary, because the first environment variable we need is the
4458"baudrate" setting for the console - if we have a bad CRC, we don't
4459have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004460
4461Note: once the monitor has been relocated, then it will complain if
4462the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004463use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004465- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004466 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004468 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004469 also needs to be defined.
4470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004471- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004472 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004473
Ron Madriddfa028a2009-02-18 14:30:44 -08004474- CONFIG_NS16550_MIN_FUNCTIONS:
4475 Define this if you desire to only have use of the NS16550_init
4476 and NS16550_putc functions for the serial driver located at
4477 drivers/serial/ns16550.c. This option is useful for saving
4478 space for already greatly restricted images, including but not
4479 limited to NAND_SPL configurations.
4480
Simon Glass28a9e332012-11-30 13:01:18 +00004481- CONFIG_DISPLAY_BOARDINFO
4482 Display information about the board that U-Boot is running on
4483 when U-Boot starts up. The board function checkboard() is called
4484 to do this.
4485
Simon Glasse8822012012-11-30 13:01:19 +00004486- CONFIG_DISPLAY_BOARDINFO_LATE
4487 Similar to the previous option, but display this information
4488 later, once stdio is running and output goes to the LCD, if
4489 present.
4490
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004491- CONFIG_BOARD_SIZE_LIMIT:
4492 Maximum size of the U-Boot image. When defined, the
4493 build system checks that the actual size does not
4494 exceed it.
4495
wdenkc6097192002-11-03 00:24:07 +00004496Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004497---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004498
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004499- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004500 Cache Line Size of the CPU.
4501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004502- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004503 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004504
wdenk9c53f402003-10-15 23:53:47 +00004505 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4506 and RPXsuper) to be able to adjust the position of
4507 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004508
Timur Tabid8f341c2011-08-04 18:03:41 -05004509- CONFIG_SYS_CCSRBAR_DEFAULT:
4510 Default (power-on reset) physical address of CCSR on Freescale
4511 PowerPC SOCs.
4512
4513- CONFIG_SYS_CCSRBAR:
4514 Virtual address of CCSR. On a 32-bit build, this is typically
4515 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4516
4517 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4518 for cross-platform code that uses that macro instead.
4519
4520- CONFIG_SYS_CCSRBAR_PHYS:
4521 Physical address of CCSR. CCSR can be relocated to a new
4522 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004523 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004524 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4525 is typically relocated on 36-bit builds. It is recommended
4526 that this macro be defined via the _HIGH and _LOW macros:
4527
4528 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4529 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4530
4531- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004532 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4533 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004534 used in assembly code, so it must not contain typecasts or
4535 integer size suffixes (e.g. "ULL").
4536
4537- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4538 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4539 used in assembly code, so it must not contain typecasts or
4540 integer size suffixes (e.g. "ULL").
4541
4542- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4543 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4544 forced to a value that ensures that CCSR is not relocated.
4545
wdenk1272e232002-11-10 22:06:23 +00004546- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004547 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004548
4549 the default drive number (default value 0)
4550
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004551 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004553 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004554 (default value 1)
4555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004556 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004557
wdenk4a5c8a72003-03-06 00:02:04 +00004558 defines the offset of register from address. It
4559 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004560 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004562 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4563 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004564 default value.
wdenk1272e232002-11-10 22:06:23 +00004565
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004566 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004567 fdc_hw_init() is called at the beginning of the FDC
4568 setup. fdc_hw_init() must be provided by the board
4569 source code. It is used to make hardware dependant
4570 initializations.
wdenk1272e232002-11-10 22:06:23 +00004571
Macpaul Lind1e49942011-04-11 20:45:32 +00004572- CONFIG_IDE_AHB:
4573 Most IDE controllers were designed to be connected with PCI
4574 interface. Only few of them were designed for AHB interface.
4575 When software is doing ATA command and data transfer to
4576 IDE devices through IDE-AHB controller, some additional
4577 registers accessing to these kind of IDE-AHB controller
4578 is requierd.
4579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004580- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004581 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004582 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004584- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004585
wdenkeb20ad32003-09-05 23:19:14 +00004586 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004587 initial data and stack; please note that this must be
4588 writable memory that is working WITHOUT special
4589 initialization, i. e. you CANNOT use normal RAM which
4590 will become available only after programming the
4591 memory controller and running certain initialization
4592 sequences.
4593
4594 U-Boot uses the following memory types:
4595 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4596 - MPC824X: data cache
4597 - PPC4xx: data cache
4598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004599- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004600
4601 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004602 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4603 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004604 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004605 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004606 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4607 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4608 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004609
4610 Note:
4611 On the MPC824X (or other systems that use the data
4612 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004613 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004614 point to an otherwise UNUSED address space between
4615 the top of RAM and the start of the PCI space.
4616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004617- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004619- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004621- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004623- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004624
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004625- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004627- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004628
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004629- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004630 SDRAM timing
4631
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004632- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004633 periodic timer for refresh
4634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004635- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004637- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4638 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4639 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4640 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004641 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4642
4643- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004644 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4645 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004646 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004648- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4649 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004650 Machine Mode Register and Memory Periodic Timer
4651 Prescaler definitions (SDRAM timing)
4652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004653- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004654 enable I2C microcode relocation patch (MPC8xx);
4655 define relocation offset in DPRAM [DSP2]
4656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004657- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004658 enable SMC microcode relocation patch (MPC8xx);
4659 define relocation offset in DPRAM [SMC1]
4660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004661- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004662 enable SPI microcode relocation patch (MPC8xx);
4663 define relocation offset in DPRAM [SCC4]
4664
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004665- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004666 Use OSCM clock mode on MBX8xx board. Be careful,
4667 wrong setting might damage your board. Read
4668 doc/README.MBX before setting this variable!
4669
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004670- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004671 Offset of the bootmode word in DPRAM used by post
4672 (Power On Self Tests). This definition overrides
4673 #define'd default value in commproc.h resp.
4674 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004675
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004676- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4677 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4678 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4679 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4680 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4681 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4682 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4683 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004684 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004685
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004686- CONFIG_PCI_DISABLE_PCIE:
4687 Disable PCI-Express on systems where it is supported but not
4688 required.
4689
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004690- CONFIG_PCI_ENUM_ONLY
4691 Only scan through and get the devices on the busses.
4692 Don't do any setup work, presumably because someone or
4693 something has already done it, and we don't need to do it
4694 a second time. Useful for platforms that are pre-booted
4695 by coreboot or similar.
4696
Gabor Juhosb4458732013-05-30 07:06:12 +00004697- CONFIG_PCI_INDIRECT_BRIDGE:
4698 Enable support for indirect PCI bridges.
4699
Kumar Gala8975d7a2010-12-30 12:09:53 -06004700- CONFIG_SYS_SRIO:
4701 Chip has SRIO or not
4702
4703- CONFIG_SRIO1:
4704 Board has SRIO 1 port available
4705
4706- CONFIG_SRIO2:
4707 Board has SRIO 2 port available
4708
Liu Gang27afb9c2013-05-07 16:30:46 +08004709- CONFIG_SRIO_PCIE_BOOT_MASTER
4710 Board can support master function for Boot from SRIO and PCIE
4711
Kumar Gala8975d7a2010-12-30 12:09:53 -06004712- CONFIG_SYS_SRIOn_MEM_VIRT:
4713 Virtual Address of SRIO port 'n' memory region
4714
4715- CONFIG_SYS_SRIOn_MEM_PHYS:
4716 Physical Address of SRIO port 'n' memory region
4717
4718- CONFIG_SYS_SRIOn_MEM_SIZE:
4719 Size of SRIO port 'n' memory region
4720
Fabio Estevamf17e8782013-04-11 09:35:34 +00004721- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4722 Defined to tell the NAND controller that the NAND chip is using
4723 a 16 bit bus.
4724 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004725 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004726 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004727 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004728
4729- CONFIG_SYS_NDFC_EBC0_CFG
4730 Sets the EBC0_CFG register for the NDFC. If not defined
4731 a default value will be used.
4732
Ben Warren45657152006-09-07 16:50:54 -04004733- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004734 Get DDR timing information from an I2C EEPROM. Common
4735 with pluggable memory modules such as SODIMMs
4736
Ben Warren45657152006-09-07 16:50:54 -04004737 SPD_EEPROM_ADDRESS
4738 I2C address of the SPD EEPROM
4739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004740- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004741 If SPD EEPROM is on an I2C bus other than the first
4742 one, specify here. Note that the value must resolve
4743 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004744
York Sune73cc042011-06-07 09:42:16 +08004745- CONFIG_SYS_DDR_RAW_TIMING
4746 Get DDR timing information from other than SPD. Common with
4747 soldered DDR chips onboard without SPD. DDR raw timing
4748 parameters are extracted from datasheet and hard-coded into
4749 header files or board specific files.
4750
York Sunbd495cf2011-09-16 13:21:35 -07004751- CONFIG_FSL_DDR_INTERACTIVE
4752 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4753
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004754- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004755 Only for 83xx systems. If specified, then DDR should
4756 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004757
wdenk6203e402004-04-18 10:13:26 +00004758- CONFIG_ETHER_ON_FEC[12]
4759 Define to enable FEC[12] on a 8xx series processor.
4760
4761- CONFIG_FEC[12]_PHY
4762 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004763 to the given FEC; i. e.
4764 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004765 means that the PHY with address 4 is connected to FEC1
4766
4767 When set to -1, means to probe for first available.
4768
4769- CONFIG_FEC[12]_PHY_NORXERR
4770 The PHY does not have a RXERR line (RMII only).
4771 (so program the FEC to ignore it).
4772
4773- CONFIG_RMII
4774 Enable RMII mode for all FECs.
4775 Note that this is a global option, we can't
4776 have one FEC in standard MII mode and another in RMII mode.
4777
wdenk20c98a62004-04-23 20:32:05 +00004778- CONFIG_CRC32_VERIFY
4779 Add a verify option to the crc32 command.
4780 The syntax is:
4781
4782 => crc32 -v <address> <count> <crc32>
4783
4784 Where address/count indicate a memory area
4785 and crc32 is the correct crc32 which the
4786 area should have.
4787
wdenk64519362004-07-11 17:40:54 +00004788- CONFIG_LOOPW
4789 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004790 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004791
stroesecc3af832004-12-16 18:46:55 +00004792- CONFIG_MX_CYCLIC
4793 Add the "mdc" and "mwc" memory commands. These are cyclic
4794 "md/mw" commands.
4795 Examples:
4796
wdenk07d7e6b2004-12-16 21:44:03 +00004797 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004798 This command will print 4 bytes (10,11,12,13) each 500 ms.
4799
wdenk07d7e6b2004-12-16 21:44:03 +00004800 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004801 This command will write 12345678 to address 100 all 10 ms.
4802
wdenk07d7e6b2004-12-16 21:44:03 +00004803 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004804 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004805
wdenk3d3d99f2005-04-04 12:44:11 +00004806- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004807 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004808 low level initializations (like setting up the memory
4809 controller) are omitted and/or U-Boot does not
4810 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004811
Wolfgang Denk302141d2010-11-27 23:30:56 +01004812 Normally this variable MUST NOT be defined. The only
4813 exception is when U-Boot is loaded (to RAM) by some
4814 other boot loader or by a debugger which performs
4815 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004816
Aneesh V552a3192011-07-13 05:11:07 +00004817- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004818 Modifies the behaviour of start.S when compiling a loader
4819 that is executed before the actual U-Boot. E.g. when
4820 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004821
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004822- CONFIG_TPL_BUILD
4823 Modifies the behaviour of start.S when compiling a loader
4824 that is executed after the SPL and before the actual U-Boot.
4825 It is loaded by the SPL.
4826
Ying Zhang0d4f5442013-05-20 14:07:23 +08004827- CONFIG_SYS_MPC85XX_NO_RESETVEC
4828 Only for 85xx systems. If this variable is specified, the section
4829 .resetvec is not kept and the section .bootpg is placed in the
4830 previous 4k of the .text section.
4831
Simon Glass17dabf02013-02-24 17:33:14 +00004832- CONFIG_ARCH_MAP_SYSMEM
4833 Generally U-Boot (and in particular the md command) uses
4834 effective address. It is therefore not necessary to regard
4835 U-Boot address as virtual addresses that need to be translated
4836 to physical addresses. However, sandbox requires this, since
4837 it maintains its own little RAM buffer which contains all
4838 addressable memory. This option causes some memory accesses
4839 to be mapped through map_sysmem() / unmap_sysmem().
4840
Matthias Weisser93416c12011-03-10 21:36:32 +00004841- CONFIG_USE_ARCH_MEMCPY
4842 CONFIG_USE_ARCH_MEMSET
4843 If these options are used a optimized version of memcpy/memset will
4844 be used if available. These functions may be faster under some
4845 conditions but may increase the binary size.
4846
Simon Glassbfb59802013-02-14 04:18:54 +00004847- CONFIG_X86_RESET_VECTOR
4848 If defined, the x86 reset vector code is included. This is not
4849 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004850
Mark Jackson52b003c2013-03-04 01:27:20 +00004851- CONFIG_SYS_MPUCLK
4852 Defines the MPU clock speed (in MHz).
4853
4854 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004855
Heiko Schocher2233e462013-11-04 14:05:00 +01004856- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4857 Enables the RTC32K OSC on AM33xx based plattforms
4858
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004859- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4860 Option to disable subpage write in NAND driver
4861 driver that uses this:
4862 drivers/mtd/nand/davinci_nand.c
4863
Timur Tabi275f4bb2011-11-22 09:21:25 -06004864Freescale QE/FMAN Firmware Support:
4865-----------------------------------
4866
4867The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4868loading of "firmware", which is encoded in the QE firmware binary format.
4869This firmware often needs to be loaded during U-Boot booting, so macros
4870are used to identify the storage device (NOR flash, SPI, etc) and the address
4871within that device.
4872
Zhao Qiang83a90842014-03-21 16:21:44 +08004873- CONFIG_SYS_FMAN_FW_ADDR
4874 The address in the storage device where the FMAN microcode is located. The
4875 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4876 is also specified.
4877
4878- CONFIG_SYS_QE_FW_ADDR
4879 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004880 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4881 is also specified.
4882
4883- CONFIG_SYS_QE_FMAN_FW_LENGTH
4884 The maximum possible size of the firmware. The firmware binary format
4885 has a field that specifies the actual size of the firmware, but it
4886 might not be possible to read any part of the firmware unless some
4887 local storage is allocated to hold the entire firmware first.
4888
4889- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4890 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4891 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4892 virtual address in NOR flash.
4893
4894- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4895 Specifies that QE/FMAN firmware is located in NAND flash.
4896 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4897
4898- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4899 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4900 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4901
4902- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4903 Specifies that QE/FMAN firmware is located on the primary SPI
4904 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4905
Liu Gang1e084582012-03-08 00:33:18 +00004906- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4907 Specifies that QE/FMAN firmware is located in the remote (master)
4908 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004909 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4910 window->master inbound window->master LAW->the ucode address in
4911 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004912
J. German Rivera8ff14b72014-06-23 15:15:55 -07004913Freescale Layerscape Management Complex Firmware Support:
4914---------------------------------------------------------
4915The Freescale Layerscape Management Complex (MC) supports the loading of
4916"firmware".
4917This firmware often needs to be loaded during U-Boot booting, so macros
4918are used to identify the storage device (NOR flash, SPI, etc) and the address
4919within that device.
4920
4921- CONFIG_FSL_MC_ENET
4922 Enable the MC driver for Layerscape SoCs.
4923
4924- CONFIG_SYS_LS_MC_FW_ADDR
4925 The address in the storage device where the firmware is located. The
4926 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4927 is also specified.
4928
4929- CONFIG_SYS_LS_MC_FW_LENGTH
4930 The maximum possible size of the firmware. The firmware binary format
4931 has a field that specifies the actual size of the firmware, but it
4932 might not be possible to read any part of the firmware unless some
4933 local storage is allocated to hold the entire firmware first.
4934
4935- CONFIG_SYS_LS_MC_FW_IN_NOR
4936 Specifies that MC firmware is located in NOR flash, mapped as
4937 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4938 virtual address in NOR flash.
4939
wdenkc6097192002-11-03 00:24:07 +00004940Building the Software:
4941======================
4942
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004943Building U-Boot has been tested in several native build environments
4944and in many different cross environments. Of course we cannot support
4945all possibly existing versions of cross development tools in all
4946(potentially obsolete) versions. In case of tool chain problems we
4947recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4948which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004949
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004950If you are not using a native environment, it is assumed that you
4951have GNU cross compiling tools available in your path. In this case,
4952you must set the environment variable CROSS_COMPILE in your shell.
4953Note that no changes to the Makefile or any other source files are
4954necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004955
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004956 $ CROSS_COMPILE=ppc_4xx-
4957 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004958
Peter Tyserb06976d2009-03-13 18:54:51 -05004959Note: If you wish to generate Windows versions of the utilities in
4960 the tools directory you can use the MinGW toolchain
4961 (http://www.mingw.org). Set your HOST tools to the MinGW
4962 toolchain and execute 'make tools'. For example:
4963
4964 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4965
4966 Binaries such as tools/mkimage.exe will be created which can
4967 be executed on computers running Windows.
4968
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004969U-Boot is intended to be simple to build. After installing the
4970sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004971is done by typing:
4972
Holger Freyther7ba4e572014-08-04 09:26:05 +02004973 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004974
Holger Freyther7ba4e572014-08-04 09:26:05 +02004975where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004976rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978Note: for some board special configuration names may exist; check if
4979 additional information is available from the board vendor; for
4980 instance, the TQM823L systems are available without (standard)
4981 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004982 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004983
Holger Freyther7ba4e572014-08-04 09:26:05 +02004984 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004985 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004986
Holger Freyther7ba4e572014-08-04 09:26:05 +02004987 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004988 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990 etc.
wdenkc6097192002-11-03 00:24:07 +00004991
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk6c59edc2004-05-03 20:45:30 +00004993Finally, type "make all", and you should get some working U-Boot
4994images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004995
wdenk6c59edc2004-05-03 20:45:30 +00004996- "u-boot.bin" is a raw binary image
4997- "u-boot" is an image in ELF binary format
4998- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004999
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005000By default the build is performed locally and the objects are saved
5001in the source directory. One of the two methods can be used to change
5002this behavior and build U-Boot to some external directory:
5003
50041. Add O= to the make command line invocations:
5005
5006 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005007 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005008 make O=/tmp/build all
5009
50102. Set environment variable BUILD_DIR to point to the desired location:
5011
5012 export BUILD_DIR=/tmp/build
5013 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005014 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005015 make all
5016
5017Note that the command line "O=" setting overrides the BUILD_DIR environment
5018variable.
5019
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk6c59edc2004-05-03 20:45:30 +00005021Please be aware that the Makefiles assume you are using GNU make, so
5022for instance on NetBSD you might need to use "gmake" instead of
5023native "make".
wdenkc6097192002-11-03 00:24:07 +00005024
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026If the system board that you have is not listed, then you will need
5027to port U-Boot to your hardware platform. To do this, follow these
5028steps:
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk6c59edc2004-05-03 20:45:30 +000050301. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005031 "boards.cfg" file, using the existing entries as examples.
5032 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000050332. Create a new directory to hold your board specific code. Add any
5034 files you need. In your board directory, you will need at least
5035 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
50363. Create a new configuration file "include/configs/<board>.h" for
5037 your board
50383. If you're porting U-Boot to a new CPU, then also create a new
5039 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020050404. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000050415. Type "make", and you should get a working "u-boot.srec" file
5042 to be installed on your target system.
50436. Debug and solve any problems that might arise.
5044 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005045
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5048==============================================================
wdenkc6097192002-11-03 00:24:07 +00005049
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005050If you have modified U-Boot sources (for instance added a new board
5051or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005052provide feedback to the other developers. The feedback normally takes
5053the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005054official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005055
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005056But before you submit such a patch, please verify that your modifi-
5057cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005058the supported boards compile WITHOUT ANY compiler warnings. To do so,
5059just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005060for ALL supported system. Be warned, this will take a while. You can
5061select which (cross) compiler to use by passing a `CROSS_COMPILE'
5062environment variable to the script, i. e. to use the ELDK cross tools
5063you can type
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk6c59edc2004-05-03 20:45:30 +00005065 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005070
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005071When using the MAKEALL script, the default behaviour is to build
5072U-Boot in the source directory. This location can be changed by
5073setting the BUILD_DIR environment variable. Also, for each target
5074built, the MAKEALL script saves two log files (<target>.ERR and
5075<target>.MAKEALL) in the <source dir>/LOG directory. This default
5076location can be changed by setting the MAKEALL_LOGDIR environment
5077variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005078
5079 export BUILD_DIR=/tmp/build
5080 export MAKEALL_LOGDIR=/tmp/log
5081 CROSS_COMPILE=ppc_8xx- MAKEALL
5082
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005083With the above settings build objects are saved in the /tmp/build,
5084log files are saved in the /tmp/log and the source tree remains clean
5085during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005086
5087
wdenk6c59edc2004-05-03 20:45:30 +00005088See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005089
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk6c59edc2004-05-03 20:45:30 +00005091Monitor Commands - Overview:
5092============================
wdenkc6097192002-11-03 00:24:07 +00005093
wdenk6c59edc2004-05-03 20:45:30 +00005094go - start application at address 'addr'
5095run - run commands in an environment variable
5096bootm - boot application image from memory
5097bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005098bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005099tftpboot- boot image via network using TFTP protocol
5100 and env variables "ipaddr" and "serverip"
5101 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005102tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005103rarpboot- boot image via network using RARP/TFTP protocol
5104diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5105loads - load S-Record file over serial line
5106loadb - load binary file over serial line (kermit mode)
5107md - memory display
5108mm - memory modify (auto-incrementing)
5109nm - memory modify (constant address)
5110mw - memory write (fill)
5111cp - memory copy
5112cmp - memory compare
5113crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005114i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005115sspi - SPI utility commands
5116base - print or set address offset
5117printenv- print environment variables
5118setenv - set environment variables
5119saveenv - save environment variables to persistent storage
5120protect - enable or disable FLASH write protection
5121erase - erase FLASH memory
5122flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005123nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005124bdinfo - print Board Info structure
5125iminfo - print header information for application image
5126coninfo - print console devices and informations
5127ide - IDE sub-system
5128loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005129loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005130mtest - simple RAM test
5131icache - enable or disable instruction cache
5132dcache - enable or disable data cache
5133reset - Perform RESET of the CPU
5134echo - echo args to console
5135version - print monitor version
5136help - print online help
5137? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005138
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140Monitor Commands - Detailed Description:
5141========================================
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143TODO.
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005146
5147
wdenk6c59edc2004-05-03 20:45:30 +00005148Environment Variables:
5149======================
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151U-Boot supports user configuration using Environment Variables which
5152can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154Environment Variables are set using "setenv", printed using
5155"printenv", and saved to Flash using "saveenv". Using "setenv"
5156without a value can be used to delete a variable from the
5157environment. As long as you don't save the environment you are
5158working with an in-memory copy. In case the Flash area containing the
5159environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005160
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005161Some configuration options can be set using Environment Variables.
5162
5163List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +00005171 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk6c59edc2004-05-03 20:45:30 +00005173 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005174
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005175 bootm_low - Memory range available for image processing in the bootm
5176 command can be restricted. This variable is given as
5177 a hexadecimal number and defines lowest address allowed
5178 for use by the bootm command. See also "bootm_size"
5179 environment variable. Address defined by "bootm_low" is
5180 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005181 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5182 bootm_mapsize.
5183
Wolfgang Denk092ae952011-10-26 10:21:21 +00005184 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005185 This variable is given as a hexadecimal number and it
5186 defines the size of the memory region starting at base
5187 address bootm_low that is accessible by the Linux kernel
5188 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5189 as the default value if it is defined, and bootm_size is
5190 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005191
5192 bootm_size - Memory range available for image processing in the bootm
5193 command can be restricted. This variable is given as
5194 a hexadecimal number and defines the size of the region
5195 allowed for use by the bootm command. See also "bootm_low"
5196 environment variable.
5197
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005198 updatefile - Location of the software update file on a TFTP server, used
5199 by the automatic software update feature. Please refer to
5200 documentation in doc/README.update for more details.
5201
wdenk6c59edc2004-05-03 20:45:30 +00005202 autoload - if set to "no" (any string beginning with 'n'),
5203 "bootp" will just load perform a lookup of the
5204 configuration from the BOOTP server, but not try to
5205 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207 autostart - if set to "yes", an image loaded using the "bootp",
5208 "rarpboot", "tftpboot" or "diskboot" commands will
5209 be automatically started (by internally calling
5210 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212 If set to "no", a standalone image passed to the
5213 "bootm" command will be copied to the load address
5214 (and eventually uncompressed), but NOT be started.
5215 This can be used to load and uncompress arbitrary
5216 data.
wdenkc6097192002-11-03 00:24:07 +00005217
David A. Longd558a4e2011-07-09 16:40:19 -04005218 fdt_high - if set this restricts the maximum address that the
5219 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005220 For example, if you have a system with 1 GB memory
5221 at physical address 0x10000000, while Linux kernel
5222 only recognizes the first 704 MB as low memory, you
5223 may need to set fdt_high as 0x3C000000 to have the
5224 device tree blob be copied to the maximum address
5225 of the 704 MB low memory, so that Linux kernel can
5226 access it during the boot procedure.
5227
David A. Longd558a4e2011-07-09 16:40:19 -04005228 If this is set to the special value 0xFFFFFFFF then
5229 the fdt will not be copied at all on boot. For this
5230 to work it must reside in writable memory, have
5231 sufficient padding on the end of it for u-boot to
5232 add the information it needs into it, and the memory
5233 must be accessible by the kernel.
5234
Simon Glassdc6fa642011-10-24 19:15:34 +00005235 fdtcontroladdr- if set this is the address of the control flattened
5236 device tree used by U-Boot when CONFIG_OF_CONTROL is
5237 defined.
5238
wdenk0e2bd9c2004-06-06 21:51:03 +00005239 i2cfast - (PPC405GP|PPC405EP only)
5240 if set to 'y' configures Linux I2C driver for fast
5241 mode (400kHZ). This environment variable is used in
5242 initialization code. So, for changes to be effective
5243 it must be saved and board must be reset.
5244
wdenk6c59edc2004-05-03 20:45:30 +00005245 initrd_high - restrict positioning of initrd images:
5246 If this variable is not set, initrd images will be
5247 copied to the highest possible address in RAM; this
5248 is usually what you want since it allows for
5249 maximum initrd size. If for some reason you want to
5250 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005251 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005252 variable to a value of "no" or "off" or "0".
5253 Alternatively, you can set it to a maximum upper
5254 address to use (U-Boot will still check that it
5255 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005256
wdenk6c59edc2004-05-03 20:45:30 +00005257 For instance, when you have a system with 16 MB
5258 RAM, and want to reserve 4 MB from use by Linux,
5259 you can do this by adding "mem=12M" to the value of
5260 the "bootargs" variable. However, now you must make
5261 sure that the initrd image is placed in the first
5262 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk6c59edc2004-05-03 20:45:30 +00005264 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266 If you set initrd_high to 0xFFFFFFFF, this is an
5267 indication to U-Boot that all addresses are legal
5268 for the Linux kernel, including addresses in flash
5269 memory. In this case U-Boot will NOT COPY the
5270 ramdisk at all. This may be useful to reduce the
5271 boot time on your system, but requires that this
5272 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276 loadaddr - Default load address for commands like "bootp",
5277 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk6c59edc2004-05-03 20:45:30 +00005285 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005288
Mike Frysingera23230c2011-10-02 10:01:27 +00005289 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005290
Mike Frysingera23230c2011-10-02 10:01:27 +00005291 ethact - controls which interface is currently active.
5292 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005293
Heiko Schocherc5e84052010-07-20 17:45:02 +02005294 => setenv ethact FEC
5295 => ping 192.168.0.1 # traffic sent on FEC
5296 => setenv ethact SCC
5297 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005298
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005299 ethrotate - When set to "no" U-Boot does not go through all
5300 available network interfaces.
5301 It just stays at the currently selected interface.
5302
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005303 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005304 either succeed or fail without retrying.
5305 When set to "once" the network operation will
5306 fail when all the available network interfaces
5307 are tried once without success.
5308 Useful on scripts which control the retry operation
5309 themselves.
wdenkc6097192002-11-03 00:24:07 +00005310
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005311 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005312
Simon Glass5db3f932013-07-16 20:10:00 -07005313 silent_linux - If set then linux will be told to boot silently, by
5314 changing the console to be empty. If "yes" it will be
5315 made silent. If "no" it will not be made silent. If
5316 unset, then it will be made silent if the U-Boot console
5317 is silent.
5318
Wolfgang Denk227b5192005-09-24 23:25:46 +02005319 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005320 UDP source port.
5321
Wolfgang Denk227b5192005-09-24 23:25:46 +02005322 tftpdstport - If this is set, the value is used for TFTP's UDP
5323 destination port instead of the Well Know Port 69.
5324
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005325 tftpblocksize - Block size to use for TFTP transfers; if not set,
5326 we use the TFTP server's default block size
5327
5328 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5329 seconds, minimum value is 1000 = 1 second). Defines
5330 when a packet is considered to be lost so it has to
5331 be retransmitted. The default is 5000 = 5 seconds.
5332 Lowering this value may make downloads succeed
5333 faster in networks with high packet loss rates or
5334 with unreliable TFTP servers.
5335
5336 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005337 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005338 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005339
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005340The following image location variables contain the location of images
5341used in booting. The "Image" column gives the role of the image and is
5342not an environment variable name. The other columns are environment
5343variable names. "File Name" gives the name of the file on a TFTP
5344server, "RAM Address" gives the location in RAM the image will be
5345loaded to, and "Flash Location" gives the image's address in NOR
5346flash or offset in NAND flash.
5347
5348*Note* - these variables don't have to be defined for all boards, some
5349boards currenlty use other variables for these purposes, and some
5350boards use these variables for other purposes.
5351
Wolfgang Denk092ae952011-10-26 10:21:21 +00005352Image File Name RAM Address Flash Location
5353----- --------- ----------- --------------
5354u-boot u-boot u-boot_addr_r u-boot_addr
5355Linux kernel bootfile kernel_addr_r kernel_addr
5356device tree blob fdtfile fdt_addr_r fdt_addr
5357ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005358
wdenk6c59edc2004-05-03 20:45:30 +00005359The following environment variables may be used and automatically
5360updated by the network boot commands ("bootp" and "rarpboot"),
5361depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005362
wdenk6c59edc2004-05-03 20:45:30 +00005363 bootfile - see above
5364 dnsip - IP address of your Domain Name Server
5365 dnsip2 - IP address of your secondary Domain Name Server
5366 gatewayip - IP address of the Gateway (Router) to use
5367 hostname - Target hostname
5368 ipaddr - see above
5369 netmask - Subnet Mask
5370 rootpath - Pathname of the root filesystem on the NFS server
5371 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005372
wdenk145d2c12004-04-15 21:48:45 +00005373
wdenk6c59edc2004-05-03 20:45:30 +00005374There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk6c59edc2004-05-03 20:45:30 +00005376 serial# - contains hardware identification information such
5377 as type string and/or serial number
5378 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk6c59edc2004-05-03 20:45:30 +00005380These variables can be set only once (usually during manufacturing of
5381the board). U-Boot refuses to delete or overwrite these variables
5382once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005383
5384
wdenk6c59edc2004-05-03 20:45:30 +00005385Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk6c59edc2004-05-03 20:45:30 +00005387 ver - Contains the U-Boot version string as printed
5388 with the "version" command. This variable is
5389 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005390
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392Please note that changes to some configuration parameters may take
5393only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005394
stroeseb9c17c52003-04-04 15:53:41 +00005395
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005396Callback functions for environment variables:
5397---------------------------------------------
5398
5399For some environment variables, the behavior of u-boot needs to change
5400when their values are changed. This functionailty allows functions to
5401be associated with arbitrary variables. On creation, overwrite, or
5402deletion, the callback will provide the opportunity for some side
5403effect to happen or for the change to be rejected.
5404
5405The callbacks are named and associated with a function using the
5406U_BOOT_ENV_CALLBACK macro in your board or driver code.
5407
5408These callbacks are associated with variables in one of two ways. The
5409static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5410in the board configuration to a string that defines a list of
5411associations. The list must be in the following format:
5412
5413 entry = variable_name[:callback_name]
5414 list = entry[,list]
5415
5416If the callback name is not specified, then the callback is deleted.
5417Spaces are also allowed anywhere in the list.
5418
5419Callbacks can also be associated by defining the ".callbacks" variable
5420with the same list format above. Any association in ".callbacks" will
5421override any association in the static list. You can define
5422CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5423".callbacks" envirnoment variable in the default or embedded environment.
5424
5425
wdenk6c59edc2004-05-03 20:45:30 +00005426Command Line Parsing:
5427=====================
stroeseb9c17c52003-04-04 15:53:41 +00005428
wdenk6c59edc2004-05-03 20:45:30 +00005429There are two different command line parsers available with U-Boot:
5430the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432Old, simple command line parser:
5433--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005434
wdenk6c59edc2004-05-03 20:45:30 +00005435- supports environment variables (through setenv / saveenv commands)
5436- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005437- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005438- special characters ('$', ';') can be escaped by prefixing with '\',
5439 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005440 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005441- You can also escape text by enclosing in single apostrophes, for example:
5442 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444Hush shell:
5445-----------
wdenkf4688a22003-05-28 08:06:31 +00005446
wdenk6c59edc2004-05-03 20:45:30 +00005447- similar to Bourne shell, with control structures like
5448 if...then...else...fi, for...do...done; while...do...done,
5449 until...do...done, ...
5450- supports environment ("global") variables (through setenv / saveenv
5451 commands) and local shell variables (through standard shell syntax
5452 "name=value"); only environment variables can be used with "run"
5453 command
wdenkf4688a22003-05-28 08:06:31 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455General rules:
5456--------------
wdenkf4688a22003-05-28 08:06:31 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458(1) If a command line (or an environment variable executed by a "run"
5459 command) contains several commands separated by semicolon, and
5460 one of these commands fails, then the remaining commands will be
5461 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005462
wdenk6c59edc2004-05-03 20:45:30 +00005463(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005464 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005465 command will cause "run" to terminate, i. e. the remaining
5466 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468Note for Redundant Ethernet Interfaces:
5469=======================================
wdenkf4688a22003-05-28 08:06:31 +00005470
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005471Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005472such configurations and is capable of automatic selection of a
5473"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005474
wdenk6c59edc2004-05-03 20:45:30 +00005475Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5476MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5477"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005478
wdenk6c59edc2004-05-03 20:45:30 +00005479If the network interface stores some valid MAC address (for instance
5480in SROM), this is used as default address if there is NO correspon-
5481ding setting in the environment; if the corresponding environment
5482variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005483
wdenk6c59edc2004-05-03 20:45:30 +00005484o If the SROM has a valid MAC address, and there is no address in the
5485 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487o If there is no valid address in the SROM, and a definition in the
5488 environment exists, then the value from the environment variable is
5489 used.
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk6c59edc2004-05-03 20:45:30 +00005491o If both the SROM and the environment contain a MAC address, and
5492 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494o If both the SROM and the environment contain a MAC address, and the
5495 addresses differ, the value from the environment is used and a
5496 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005497
wdenk6c59edc2004-05-03 20:45:30 +00005498o If neither SROM nor the environment contain a MAC address, an error
5499 is raised.
wdenkc6097192002-11-03 00:24:07 +00005500
Ben Warren6db991a2010-04-26 11:11:46 -07005501If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005502will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005503may be skipped by setting the appropriate 'ethmacskip' environment variable.
5504The naming convention is as follows:
5505"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507Image Formats:
5508==============
wdenkc6097192002-11-03 00:24:07 +00005509
Marian Balakowicz18710b82008-03-12 12:13:13 +01005510U-Boot is capable of booting (and performing other auxiliary operations on)
5511images in two formats:
5512
5513New uImage format (FIT)
5514-----------------------
5515
5516Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5517to Flattened Device Tree). It allows the use of images with multiple
5518components (several kernels, ramdisks, etc.), with contents protected by
5519SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5520
5521
5522Old uImage format
5523-----------------
5524
5525Old image format is based on binary files which can be basically anything,
5526preceded by a special header; see the definitions in include/image.h for
5527details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5530 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005531 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5532 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5533 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005534* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005535 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5536 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005537* Compression Type (uncompressed, gzip, bzip2)
5538* Load Address
5539* Entry Point
5540* Image Name
5541* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543The header is marked by a special Magic Number, and both the header
5544and the data portions of the image are secured against corruption by
5545CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005546
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548Linux Support:
5549==============
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551Although U-Boot should support any OS or standalone application
5552easily, the main focus has always been on Linux during the design of
5553U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555U-Boot includes many features that so far have been part of some
5556special "boot loader" code within the Linux kernel. Also, any
5557"initrd" images to be used are no longer part of one big Linux image;
5558instead, kernel and "initrd" are separate images. This implementation
5559serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005560
wdenk6c59edc2004-05-03 20:45:30 +00005561- the same features can be used for other OS or standalone
5562 applications (for instance: using compressed images to reduce the
5563 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk6c59edc2004-05-03 20:45:30 +00005565- it becomes much easier to port new Linux kernel versions because
5566 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk6c59edc2004-05-03 20:45:30 +00005568- the same Linux kernel image can now be used with different "initrd"
5569 images; of course this also means that different kernel images can
5570 be run with the same "initrd". This makes testing easier (you don't
5571 have to build a new "zImage.initrd" Linux image when you just
5572 change a file in your "initrd"). Also, a field-upgrade of the
5573 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005574
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576Linux HOWTO:
5577============
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579Porting Linux to U-Boot based systems:
5580---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582U-Boot cannot save you from doing all the necessary modifications to
5583configure the Linux device drivers for use with your target hardware
5584(no, we don't intend to provide a full virtual machine interface to
5585Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005586
Stefan Roese88fbf932010-04-15 16:07:28 +02005587But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589Just make sure your machine specific header file (for instance
5590include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005591Information structure as we define in include/asm-<arch>/u-boot.h,
5592and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005593as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005594
Simon Glassd097e592014-06-11 23:29:46 -06005595Note that U-Boot now has a driver model, a unified model for drivers.
5596If you are adding a new driver, plumb it into driver model. If there
5597is no uclass available, you are encouraged to create one. See
5598doc/driver-model.
5599
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk6c59edc2004-05-03 20:45:30 +00005601Configuring the Linux kernel:
5602-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005603
wdenk6c59edc2004-05-03 20:45:30 +00005604No specific requirements for U-Boot. Make sure you have some root
5605device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005606
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608Building a Linux Image:
5609-----------------------
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5612not used. If you use recent kernel source, a new build target
5613"uImage" will exist which automatically builds an image usable by
5614U-Boot. Most older kernels also have support for a "pImage" target,
5615which was introduced for our predecessor project PPCBoot and uses a
5616100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618Example:
wdenkc6097192002-11-03 00:24:07 +00005619
Holger Freyther7ba4e572014-08-04 09:26:05 +02005620 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005621 make oldconfig
5622 make dep
5623 make uImage
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625The "uImage" build target uses a special tool (in 'tools/mkimage') to
5626encapsulate a compressed Linux kernel image with header information,
5627CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk6c59edc2004-05-03 20:45:30 +00005633 ${CROSS_COMPILE}-objcopy -O binary \
5634 -R .note -R .comment \
5635 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005642
wdenk6c59edc2004-05-03 20:45:30 +00005643 mkimage -A ppc -O linux -T kernel -C gzip \
5644 -a 0 -e 0 -n "Linux Kernel Image" \
5645 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005646
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648The "mkimage" tool can also be used to create ramdisk images for use
5649with U-Boot, either separated from the Linux kernel image, or
5650combined into one file. "mkimage" encapsulates the images with a 64
5651byte header containing information about target architecture,
5652operating system, image type, compression method, entry points, time
5653stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk6c59edc2004-05-03 20:45:30 +00005655"mkimage" can be called in two ways: to verify existing images and
5656print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658In the first form (with "-l" option) mkimage lists the information
5659contained in the header of an existing U-Boot image; this includes
5660checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662 tools/mkimage -l image
5663 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665The second form (with "-d" option) is used to build a U-Boot image
5666from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005667
wdenk6c59edc2004-05-03 20:45:30 +00005668 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5669 -n name -d data_file image
5670 -A ==> set architecture to 'arch'
5671 -O ==> set operating system to 'os'
5672 -T ==> set image type to 'type'
5673 -C ==> set compression type 'comp'
5674 -a ==> set load address to 'addr' (hex)
5675 -e ==> set entry point to 'ep' (hex)
5676 -n ==> set image name to 'name'
5677 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005678
wdenkcd914452004-05-29 16:53:29 +00005679Right now, all Linux kernels for PowerPC systems use the same load
5680address (0x00000000), but the entry point address depends on the
5681kernel version:
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk6c59edc2004-05-03 20:45:30 +00005683- 2.2.x kernels have the entry point at 0x0000000C,
5684- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk6c59edc2004-05-03 20:45:30 +00005686So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk6c59edc2004-05-03 20:45:30 +00005688 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5689 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005690 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005691 > examples/uImage.TQM850L
5692 Image Name: 2.4.4 kernel for TQM850L
5693 Created: Wed Jul 19 02:34:59 2000
5694 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5695 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5696 Load Address: 0x00000000
5697 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005698
wdenk6c59edc2004-05-03 20:45:30 +00005699To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005700
wdenk6c59edc2004-05-03 20:45:30 +00005701 -> tools/mkimage -l examples/uImage.TQM850L
5702 Image Name: 2.4.4 kernel for TQM850L
5703 Created: Wed Jul 19 02:34:59 2000
5704 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5705 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5706 Load Address: 0x00000000
5707 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709NOTE: for embedded systems where boot time is critical you can trade
5710speed for memory and install an UNCOMPRESSED image instead: this
5711needs more space in Flash, but boots much faster since it does not
5712need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005713
Stefan Roese88fbf932010-04-15 16:07:28 +02005714 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005715 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5716 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005717 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005718 > examples/uImage.TQM850L-uncompressed
5719 Image Name: 2.4.4 kernel for TQM850L
5720 Created: Wed Jul 19 02:34:59 2000
5721 Image Type: PowerPC Linux Kernel Image (uncompressed)
5722 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5723 Load Address: 0x00000000
5724 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005725
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5728when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005729
wdenk6c59edc2004-05-03 20:45:30 +00005730 -> tools/mkimage -n 'Simple Ramdisk Image' \
5731 > -A ppc -O linux -T ramdisk -C gzip \
5732 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5733 Image Name: Simple Ramdisk Image
5734 Created: Wed Jan 12 14:01:50 2000
5735 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5736 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5737 Load Address: 0x00000000
5738 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005739
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005740The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5741option performs the converse operation of the mkimage's second form (the "-d"
5742option). Given an image built by mkimage, the dumpimage extracts a "data file"
5743from the image:
5744
5745 tools/dumpimage -i image -p position data_file
5746 -i ==> extract from the 'image' a specific 'data_file', \
5747 indexed by 'position'
5748
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk6c59edc2004-05-03 20:45:30 +00005750Installing a Linux Image:
5751-------------------------
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753To downloading a U-Boot image over the serial (console) interface,
5754you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk6c59edc2004-05-03 20:45:30 +00005758The 'objcopy' does not understand the information in the U-Boot
5759image header, so the resulting S-Record file will be relative to
5760address 0x00000000. To load it to a given address, you need to
5761specify the target address as 'offset' parameter with the 'loads'
5762command.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764Example: install the image to address 0x40100000 (which on the
5765TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769 .......... done
5770 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk6c59edc2004-05-03 20:45:30 +00005772 => loads 40100000
5773 ## Ready for S-Record download ...
5774 ~>examples/image.srec
5775 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5776 ...
5777 15989 15990 15991 15992
5778 [file transfer complete]
5779 [connected]
5780 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005781
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005784this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005785corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789 ## Checking Image at 40100000 ...
5790 Image Name: 2.2.13 for initrd on TQM850L
5791 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5792 Data Size: 335725 Bytes = 327 kB = 0 MB
5793 Load Address: 00000000
5794 Entry Point: 0000000c
5795 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005796
5797
wdenk6c59edc2004-05-03 20:45:30 +00005798Boot Linux:
5799-----------
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801The "bootm" command is used to boot an application that is stored in
5802memory (RAM or Flash). In case of a Linux kernel image, the contents
5803of the "bootargs" environment variable is passed to the kernel as
5804parameters. You can check and modify this variable using the
5805"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005806
wdenkc6097192002-11-03 00:24:07 +00005807
wdenk6c59edc2004-05-03 20:45:30 +00005808 => printenv bootargs
5809 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk6c59edc2004-05-03 20:45:30 +00005811 => 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 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813 => printenv bootargs
5814 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 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816 => bootm 40020000
5817 ## Booting Linux kernel at 40020000 ...
5818 Image Name: 2.2.13 for NFS on TQM850L
5819 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5820 Data Size: 381681 Bytes = 372 kB = 0 MB
5821 Load Address: 00000000
5822 Entry Point: 0000000c
5823 Verifying Checksum ... OK
5824 Uncompressing Kernel Image ... OK
5825 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
5826 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5827 time_init: decrementer frequency = 187500000/60
5828 Calibrating delay loop... 49.77 BogoMIPS
5829 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5830 ...
wdenkc6097192002-11-03 00:24:07 +00005831
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005832If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005833the memory addresses of both the kernel and the initrd image (PPBCOOT
5834format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk6c59edc2004-05-03 20:45:30 +00005836 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005837
wdenk6c59edc2004-05-03 20:45:30 +00005838 ## Checking Image at 40100000 ...
5839 Image Name: 2.2.13 for initrd on TQM850L
5840 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5841 Data Size: 335725 Bytes = 327 kB = 0 MB
5842 Load Address: 00000000
5843 Entry Point: 0000000c
5844 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk6c59edc2004-05-03 20:45:30 +00005846 ## Checking Image at 40200000 ...
5847 Image Name: Simple Ramdisk Image
5848 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5849 Data Size: 566530 Bytes = 553 kB = 0 MB
5850 Load Address: 00000000
5851 Entry Point: 00000000
5852 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk6c59edc2004-05-03 20:45:30 +00005854 => bootm 40100000 40200000
5855 ## Booting Linux kernel at 40100000 ...
5856 Image Name: 2.2.13 for initrd on TQM850L
5857 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5858 Data Size: 335725 Bytes = 327 kB = 0 MB
5859 Load Address: 00000000
5860 Entry Point: 0000000c
5861 Verifying Checksum ... OK
5862 Uncompressing Kernel Image ... OK
5863 ## Loading RAMDisk Image at 40200000 ...
5864 Image Name: Simple Ramdisk Image
5865 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5866 Data Size: 566530 Bytes = 553 kB = 0 MB
5867 Load Address: 00000000
5868 Entry Point: 00000000
5869 Verifying Checksum ... OK
5870 Loading Ramdisk ... OK
5871 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
5872 Boot arguments: root=/dev/ram
5873 time_init: decrementer frequency = 187500000/60
5874 Calibrating delay loop... 49.77 BogoMIPS
5875 ...
5876 RAMDISK: Compressed image found at block 0
5877 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk6c59edc2004-05-03 20:45:30 +00005879 bash#
wdenkc6097192002-11-03 00:24:07 +00005880
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005881Boot Linux and pass a flat device tree:
5882-----------
5883
5884First, U-Boot must be compiled with the appropriate defines. See the section
5885titled "Linux Kernel Interface" above for a more in depth explanation. The
5886following is an example of how to start a kernel and pass an updated
5887flat device tree:
5888
5889=> print oftaddr
5890oftaddr=0x300000
5891=> print oft
5892oft=oftrees/mpc8540ads.dtb
5893=> tftp $oftaddr $oft
5894Speed: 1000, full duplex
5895Using TSEC0 device
5896TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5897Filename 'oftrees/mpc8540ads.dtb'.
5898Load address: 0x300000
5899Loading: #
5900done
5901Bytes transferred = 4106 (100a hex)
5902=> tftp $loadaddr $bootfile
5903Speed: 1000, full duplex
5904Using TSEC0 device
5905TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5906Filename 'uImage'.
5907Load address: 0x200000
5908Loading:############
5909done
5910Bytes transferred = 1029407 (fb51f hex)
5911=> print loadaddr
5912loadaddr=200000
5913=> print oftaddr
5914oftaddr=0x300000
5915=> bootm $loadaddr - $oftaddr
5916## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005917 Image Name: Linux-2.6.17-dirty
5918 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5919 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005920 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005921 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005922 Verifying Checksum ... OK
5923 Uncompressing Kernel Image ... OK
5924Booting using flat device tree at 0x300000
5925Using MPC85xx ADS machine description
5926Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5927[snip]
5928
5929
wdenk6c59edc2004-05-03 20:45:30 +00005930More About U-Boot Image Types:
5931------------------------------
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk6c59edc2004-05-03 20:45:30 +00005933U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935 "Standalone Programs" are directly runnable in the environment
5936 provided by U-Boot; it is expected that (if they behave
5937 well) you can continue to work in U-Boot after return from
5938 the Standalone Program.
5939 "OS Kernel Images" are usually images of some Embedded OS which
5940 will take over control completely. Usually these programs
5941 will install their own set of exception handlers, device
5942 drivers, set up the MMU, etc. - this means, that you cannot
5943 expect to re-enter U-Boot except by resetting the CPU.
5944 "RAMDisk Images" are more or less just data blocks, and their
5945 parameters (address, size) are passed to an OS kernel that is
5946 being started.
5947 "Multi-File Images" contain several images, typically an OS
5948 (Linux) kernel image and one or more data images like
5949 RAMDisks. This construct is useful for instance when you want
5950 to boot over the network using BOOTP etc., where the boot
5951 server provides just a single image file, but you want to get
5952 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005953
wdenk6c59edc2004-05-03 20:45:30 +00005954 "Multi-File Images" start with a list of image sizes, each
5955 image size (in bytes) specified by an "uint32_t" in network
5956 byte order. This list is terminated by an "(uint32_t)0".
5957 Immediately after the terminating 0 follow the images, one by
5958 one, all aligned on "uint32_t" boundaries (size rounded up to
5959 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005960
wdenk6c59edc2004-05-03 20:45:30 +00005961 "Firmware Images" are binary images containing firmware (like
5962 U-Boot or FPGA images) which usually will be programmed to
5963 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005964
wdenk6c59edc2004-05-03 20:45:30 +00005965 "Script files" are command sequences that will be executed by
5966 U-Boot's command interpreter; this feature is especially
5967 useful when you configure U-Boot to use a real shell (hush)
5968 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005969
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005970Booting the Linux zImage:
5971-------------------------
5972
5973On some platforms, it's possible to boot Linux zImage. This is done
5974using the "bootz" command. The syntax of "bootz" command is the same
5975as the syntax of "bootm" command.
5976
Tom Rini45f46d12013-05-16 11:40:11 -04005977Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005978kernel with raw initrd images. The syntax is slightly different, the
5979address of the initrd must be augmented by it's size, in the following
5980format: "<initrd addres>:<initrd size>".
5981
stroeseb9c17c52003-04-04 15:53:41 +00005982
wdenk6c59edc2004-05-03 20:45:30 +00005983Standalone HOWTO:
5984=================
stroeseb9c17c52003-04-04 15:53:41 +00005985
wdenk6c59edc2004-05-03 20:45:30 +00005986One of the features of U-Boot is that you can dynamically load and
5987run "standalone" applications, which can use some resources of
5988U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005989
wdenk6c59edc2004-05-03 20:45:30 +00005990Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005991
wdenk6c59edc2004-05-03 20:45:30 +00005992"Hello World" Demo:
5993-------------------
wdenkc6097192002-11-03 00:24:07 +00005994
wdenk6c59edc2004-05-03 20:45:30 +00005995'examples/hello_world.c' contains a small "Hello World" Demo
5996application; it is automatically compiled when you build U-Boot.
5997It's configured to run at address 0x00040004, so you can play with it
5998like that:
wdenkc6097192002-11-03 00:24:07 +00005999
wdenk6c59edc2004-05-03 20:45:30 +00006000 => loads
6001 ## Ready for S-Record download ...
6002 ~>examples/hello_world.srec
6003 1 2 3 4 5 6 7 8 9 10 11 ...
6004 [file transfer complete]
6005 [connected]
6006 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008 => go 40004 Hello World! This is a test.
6009 ## Starting application at 0x00040004 ...
6010 Hello World
6011 argc = 7
6012 argv[0] = "40004"
6013 argv[1] = "Hello"
6014 argv[2] = "World!"
6015 argv[3] = "This"
6016 argv[4] = "is"
6017 argv[5] = "a"
6018 argv[6] = "test."
6019 argv[7] = "<NULL>"
6020 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006023
wdenk6c59edc2004-05-03 20:45:30 +00006024Another example, which demonstrates how to register a CPM interrupt
6025handler with the U-Boot code, can be found in 'examples/timer.c'.
6026Here, a CPM timer is set up to generate an interrupt every second.
6027The interrupt service routine is trivial, just printing a '.'
6028character, but this is just a demo program. The application can be
6029controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006030
wdenk6c59edc2004-05-03 20:45:30 +00006031 ? - print current values og the CPM Timer registers
6032 b - enable interrupts and start timer
6033 e - stop timer and disable interrupts
6034 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006035
wdenk6c59edc2004-05-03 20:45:30 +00006036 => loads
6037 ## Ready for S-Record download ...
6038 ~>examples/timer.srec
6039 1 2 3 4 5 6 7 8 9 10 11 ...
6040 [file transfer complete]
6041 [connected]
6042 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006043
wdenk6c59edc2004-05-03 20:45:30 +00006044 => go 40004
6045 ## Starting application at 0x00040004 ...
6046 TIMERS=0xfff00980
6047 Using timer 1
6048 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050Hit 'b':
6051 [q, b, e, ?] Set interval 1000000 us
6052 Enabling timer
6053Hit '?':
6054 [q, b, e, ?] ........
6055 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6056Hit '?':
6057 [q, b, e, ?] .
6058 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6059Hit '?':
6060 [q, b, e, ?] .
6061 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6062Hit '?':
6063 [q, b, e, ?] .
6064 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6065Hit 'e':
6066 [q, b, e, ?] ...Stopping timer
6067Hit 'q':
6068 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006069
wdenkc6097192002-11-03 00:24:07 +00006070
wdenk6c59edc2004-05-03 20:45:30 +00006071Minicom warning:
6072================
wdenkc6097192002-11-03 00:24:07 +00006073
wdenk6c59edc2004-05-03 20:45:30 +00006074Over time, many people have reported problems when trying to use the
6075"minicom" terminal emulation program for serial download. I (wd)
6076consider minicom to be broken, and recommend not to use it. Under
6077Unix, I recommend to use C-Kermit for general purpose use (and
6078especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006079use "cu" for S-Record download ("loads" command). See
6080http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6081for help with kermit.
6082
wdenkc6097192002-11-03 00:24:07 +00006083
wdenk6c59edc2004-05-03 20:45:30 +00006084Nevertheless, if you absolutely want to use it try adding this
6085configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk6c59edc2004-05-03 20:45:30 +00006087 Name Program Name U/D FullScr IO-Red. Multi
6088 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6089 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006090
wdenk8dba0502003-03-31 16:34:49 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092NetBSD Notes:
6093=============
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk6c59edc2004-05-03 20:45:30 +00006095Starting at version 0.9.2, U-Boot supports NetBSD both as host
6096(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006097
wdenk6c59edc2004-05-03 20:45:30 +00006098Building requires a cross environment; it is known to work on
6099NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6100need gmake since the Makefiles are not compatible with BSD make).
6101Note that the cross-powerpc package does not install include files;
6102attempting to build U-Boot will fail because <machine/ansi.h> is
6103missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006104
wdenk6c59edc2004-05-03 20:45:30 +00006105 # cd /usr/pkg/cross/powerpc-netbsd/include
6106 # mkdir powerpc
6107 # ln -s powerpc machine
6108 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6109 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006110
wdenk6c59edc2004-05-03 20:45:30 +00006111Native builds *don't* work due to incompatibilities between native
6112and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114Booting assumes that (the first part of) the image booted is a
6115stage-2 loader which in turn loads and then invokes the kernel
6116proper. Loader sources will eventually appear in the NetBSD source
6117tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006118meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006119
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk6c59edc2004-05-03 20:45:30 +00006121Implementation Internals:
6122=========================
wdenkc6097192002-11-03 00:24:07 +00006123
wdenk6c59edc2004-05-03 20:45:30 +00006124The following is not intended to be a complete description of every
6125implementation detail. However, it should help to understand the
6126inner workings of U-Boot and make it easier to port it to custom
6127hardware.
wdenkc6097192002-11-03 00:24:07 +00006128
wdenkc6097192002-11-03 00:24:07 +00006129
wdenk6c59edc2004-05-03 20:45:30 +00006130Initial Stack, Global Data:
6131---------------------------
wdenkc6097192002-11-03 00:24:07 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133The implementation of U-Boot is complicated by the fact that U-Boot
6134starts running out of ROM (flash memory), usually without access to
6135system RAM (because the memory controller is not initialized yet).
6136This means that we don't have writable Data or BSS segments, and BSS
6137is not initialized as zero. To be able to get a C environment working
6138at all, we have to allocate at least a minimal stack. Implementation
6139options for this are defined and restricted by the CPU used: Some CPU
6140models provide on-chip memory (like the IMMR area on MPC8xx and
6141MPC826x processors), on others (parts of) the data cache can be
6142locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006143
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006144 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006145 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk6c59edc2004-05-03 20:45:30 +00006147 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6148 From: "Chris Hallinan" <clh@net1plus.com>
6149 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6150 ...
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk6c59edc2004-05-03 20:45:30 +00006152 Correct me if I'm wrong, folks, but the way I understand it
6153 is this: Using DCACHE as initial RAM for Stack, etc, does not
6154 require any physical RAM backing up the cache. The cleverness
6155 is that the cache is being used as a temporary supply of
6156 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006157 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006158 can see how this works by studying the cache architecture and
6159 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006160
wdenk6c59edc2004-05-03 20:45:30 +00006161 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6162 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006163 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006164 option should work for you. Using CS 4 should be fine if your
6165 board designers haven't used it for something that would
6166 cause you grief during the initial boot! It is frequently not
6167 used.
wdenkc6097192002-11-03 00:24:07 +00006168
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006169 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006170 with your processor/board/system design. The default value
6171 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006172 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006173 than your SDRAM module. If you have a 64MB SDRAM module, set
6174 it above 400_0000. Just make sure your board has no resources
6175 that are supposed to respond to that address! That code in
6176 start.S has been around a while and should work as is when
6177 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006178
wdenk6c59edc2004-05-03 20:45:30 +00006179 -Chris Hallinan
6180 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006181
wdenk6c59edc2004-05-03 20:45:30 +00006182It is essential to remember this, since it has some impact on the C
6183code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185* Initialized global data (data segment) is read-only. Do not attempt
6186 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006187
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006188* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00006189 as zero data - BSS segment) at all - this is undefined, initiali-
6190 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006191
wdenk6c59edc2004-05-03 20:45:30 +00006192* Stack space is very limited. Avoid big data buffers or things like
6193 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195Having only the stack as writable memory limits means we cannot use
6196normal global data to share information beween the code. But it
6197turned out that the implementation of U-Boot can be greatly
6198simplified by making a global data structure (gd_t) available to all
6199functions. We could pass a pointer to this data as argument to _all_
6200functions, but this would bloat the code. Instead we use a feature of
6201the GCC compiler (Global Register Variables) to share the data: we
6202place a pointer (gd) to the global data into a register which we
6203reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk6c59edc2004-05-03 20:45:30 +00006205When choosing a register for such a purpose we are restricted by the
6206relevant (E)ABI specifications for the current architecture, and by
6207GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006208
wdenk6c59edc2004-05-03 20:45:30 +00006209For PowerPC, the following registers have specific use:
6210 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006211 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006212 R3-R4: parameter passing and return values
6213 R5-R10: parameter passing
6214 R13: small data area pointer
6215 R30: GOT pointer
6216 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006217
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006218 (U-Boot also uses R12 as internal GOT pointer. r12
6219 is a volatile register so r12 needs to be reset when
6220 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006221
Wolfgang Denk69c09642008-02-14 22:43:22 +01006222 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006223
wdenk6c59edc2004-05-03 20:45:30 +00006224 Note: on PPC, we could use a static initializer (since the
6225 address of the global data structure is known at compile time),
6226 but it turned out that reserving a register results in somewhat
6227 smaller code - although the code savings are not that big (on
6228 average for all boards 752 bytes for the whole U-Boot image,
6229 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006230
Robin Getz2773d5f2009-08-17 15:23:02 +00006231On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006232 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6233
Robin Getz2773d5f2009-08-17 15:23:02 +00006234 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006235
wdenk6c59edc2004-05-03 20:45:30 +00006236On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006237
wdenk6c59edc2004-05-03 20:45:30 +00006238 R0: function argument word/integer result
6239 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006240 R9: platform specific
6241 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006242 R11: argument (frame) pointer
6243 R12: temporary workspace
6244 R13: stack pointer
6245 R14: link register
6246 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006247
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006248 ==> U-Boot will use R9 to hold a pointer to the global data
6249
6250 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006251
Thomas Chou8fa38582010-05-21 11:08:03 +08006252On Nios II, the ABI is documented here:
6253 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6254
6255 ==> U-Boot will use gp to hold a pointer to the global data
6256
6257 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6258 to access small data sections, so gp is free.
6259
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006260On NDS32, the following registers are used:
6261
6262 R0-R1: argument/return
6263 R2-R5: argument
6264 R15: temporary register for assembler
6265 R16: trampoline register
6266 R28: frame pointer (FP)
6267 R29: global pointer (GP)
6268 R30: link register (LP)
6269 R31: stack pointer (SP)
6270 PC: program counter (PC)
6271
6272 ==> U-Boot will use R10 to hold a pointer to the global data
6273
Wolfgang Denk6405a152006-03-31 18:32:53 +02006274NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6275or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk6c59edc2004-05-03 20:45:30 +00006277Memory Management:
6278------------------
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk6c59edc2004-05-03 20:45:30 +00006280U-Boot runs in system state and uses physical addresses, i.e. the
6281MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk6c59edc2004-05-03 20:45:30 +00006283The available memory is mapped to fixed addresses using the memory
6284controller. In this process, a contiguous block is formed for each
6285memory type (Flash, SDRAM, SRAM), even when it consists of several
6286physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006287
wdenk6c59edc2004-05-03 20:45:30 +00006288U-Boot is installed in the first 128 kB of the first Flash bank (on
6289TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6290booting and sizing and initializing DRAM, the code relocates itself
6291to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006292memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006293configuration setting]. Below that, a structure with global Board
6294Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006295
wdenk6c59edc2004-05-03 20:45:30 +00006296Additionally, some exception handler code is copied to the low 8 kB
6297of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299So a typical memory configuration with 16 MB of DRAM could look like
6300this:
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302 0x0000 0000 Exception Vector code
6303 :
6304 0x0000 1FFF
6305 0x0000 2000 Free for Application Use
6306 :
6307 :
wdenkc6097192002-11-03 00:24:07 +00006308
wdenk6c59edc2004-05-03 20:45:30 +00006309 :
6310 :
6311 0x00FB FF20 Monitor Stack (Growing downward)
6312 0x00FB FFAC Board Info Data and permanent copy of global data
6313 0x00FC 0000 Malloc Arena
6314 :
6315 0x00FD FFFF
6316 0x00FE 0000 RAM Copy of Monitor Code
6317 ... eventually: LCD or video framebuffer
6318 ... eventually: pRAM (Protected RAM - unchanged by reset)
6319 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006320
wdenkc6097192002-11-03 00:24:07 +00006321
wdenk6c59edc2004-05-03 20:45:30 +00006322System Initialization:
6323----------------------
wdenkc6097192002-11-03 00:24:07 +00006324
wdenk6c59edc2004-05-03 20:45:30 +00006325In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006326(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00006327configuration for CS0# this is a mirror of the onboard Flash memory.
6328To be able to re-map memory U-Boot then jumps to its link address.
6329To be able to implement the initialization code in C, a (small!)
6330initial stack is set up in the internal Dual Ported RAM (in case CPUs
6331which provide such a feature like MPC8xx or MPC8260), or in a locked
6332part of the data cache. After that, U-Boot initializes the CPU core,
6333the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006334
wdenk6c59edc2004-05-03 20:45:30 +00006335Next, all (potentially) available memory banks are mapped using a
6336preliminary mapping. For example, we put them on 512 MB boundaries
6337(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6338on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6339programmed for SDRAM access. Using the temporary configuration, a
6340simple memory test is run that determines the size of the SDRAM
6341banks.
wdenkc6097192002-11-03 00:24:07 +00006342
wdenk6c59edc2004-05-03 20:45:30 +00006343When there is more than one SDRAM bank, and the banks are of
6344different size, the largest is mapped first. For equal size, the first
6345bank (CS2#) is mapped first. The first mapping is always for address
63460x00000000, with any additional banks following immediately to create
6347contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006348
wdenk6c59edc2004-05-03 20:45:30 +00006349Then, the monitor installs itself at the upper end of the SDRAM area
6350and allocates memory for use by malloc() and for the global Board
6351Info data; also, the exception vector code is copied to the low RAM
6352pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006353
wdenk6c59edc2004-05-03 20:45:30 +00006354Only after this relocation will you have a "normal" C environment;
6355until that you are restricted in several ways, mostly because you are
6356running from ROM, and because the code will have to be relocated to a
6357new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006358
wdenkc6097192002-11-03 00:24:07 +00006359
wdenk6c59edc2004-05-03 20:45:30 +00006360U-Boot Porting Guide:
6361----------------------
wdenkc6097192002-11-03 00:24:07 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6364list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006365
wdenkc6097192002-11-03 00:24:07 +00006366
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006367int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006368{
6369 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006370
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006371 signal(SIGALRM, no_more_time);
6372 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006373
wdenk6c59edc2004-05-03 20:45:30 +00006374 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006375 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006376 return 0;
6377 }
wdenkc6097192002-11-03 00:24:07 +00006378
wdenk6c59edc2004-05-03 20:45:30 +00006379 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006380
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006381 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006382
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006383 if (clueless)
6384 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006385
wdenk6c59edc2004-05-03 20:45:30 +00006386 while (learning) {
6387 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006388 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6389 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006390 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006391 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006392 }
wdenkc6097192002-11-03 00:24:07 +00006393
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006394 if (available_money > toLocalCurrency ($2500))
6395 Buy a BDI3000;
6396 else
wdenk6c59edc2004-05-03 20:45:30 +00006397 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006398
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006399 if (a similar board exists) { /* hopefully... */
6400 cp -a board/<similar> board/<myboard>
6401 cp include/configs/<similar>.h include/configs/<myboard>.h
6402 } else {
6403 Create your own board support subdirectory;
6404 Create your own board include/configs/<myboard>.h file;
6405 }
6406 Edit new board/<myboard> files
6407 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006408
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006409 while (!accepted) {
6410 while (!running) {
6411 do {
6412 Add / modify source code;
6413 } until (compiles);
6414 Debug;
6415 if (clueless)
6416 email("Hi, I am having problems...");
6417 }
6418 Send patch file to the U-Boot email list;
6419 if (reasonable critiques)
6420 Incorporate improvements from email list code review;
6421 else
6422 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006423 }
wdenkc6097192002-11-03 00:24:07 +00006424
wdenk6c59edc2004-05-03 20:45:30 +00006425 return 0;
6426}
wdenkc6097192002-11-03 00:24:07 +00006427
wdenk6c59edc2004-05-03 20:45:30 +00006428void no_more_time (int sig)
6429{
6430 hire_a_guru();
6431}
wdenkc6097192002-11-03 00:24:07 +00006432
wdenkc6097192002-11-03 00:24:07 +00006433
wdenk6c59edc2004-05-03 20:45:30 +00006434Coding Standards:
6435-----------------
wdenkc6097192002-11-03 00:24:07 +00006436
wdenk6c59edc2004-05-03 20:45:30 +00006437All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006438coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006439"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006440
6441Source files originating from a different project (for example the
6442MTD subsystem) are generally exempt from these guidelines and are not
6443reformated to ease subsequent migration to newer versions of those
6444sources.
wdenkc6097192002-11-03 00:24:07 +00006445
Detlev Zundelaa63d482006-09-01 15:39:02 +02006446Please note that U-Boot is implemented in C (and to some small parts in
6447Assembler); no C++ is used, so please do not use C++ style comments (//)
6448in your code.
wdenkad276f22004-01-04 16:28:35 +00006449
wdenk6c59edc2004-05-03 20:45:30 +00006450Please also stick to the following formatting rules:
6451- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006452- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006453- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006454- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006455- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006456
wdenk6c59edc2004-05-03 20:45:30 +00006457Submissions which do not conform to the standards may be returned
6458with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006459
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk6c59edc2004-05-03 20:45:30 +00006461Submitting Patches:
6462-------------------
wdenkc6097192002-11-03 00:24:07 +00006463
wdenk6c59edc2004-05-03 20:45:30 +00006464Since the number of patches for U-Boot is growing, we need to
6465establish some rules. Submissions which do not conform to these rules
6466may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006467
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006468Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006469
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006470Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6471see http://lists.denx.de/mailman/listinfo/u-boot
6472
wdenk6c59edc2004-05-03 20:45:30 +00006473When you send a patch, please include the following information with
6474it:
wdenkc6097192002-11-03 00:24:07 +00006475
wdenk6c59edc2004-05-03 20:45:30 +00006476* For bug fixes: a description of the bug and how your patch fixes
6477 this bug. Please try to include a way of demonstrating that the
6478 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006479
wdenk6c59edc2004-05-03 20:45:30 +00006480* For new features: a description of the feature and your
6481 implementation.
wdenkc6097192002-11-03 00:24:07 +00006482
wdenk6c59edc2004-05-03 20:45:30 +00006483* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006484
wdenk6c59edc2004-05-03 20:45:30 +00006485* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006486
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006487* When you add support for a new board, don't forget to add a
6488 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006489
wdenk6c59edc2004-05-03 20:45:30 +00006490* If your patch adds new configuration options, don't forget to
6491 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006492
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006493* The patch itself. If you are using git (which is *strongly*
6494 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006495 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006496 the U-Boot mailing list, you will avoid most of the common problems
6497 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006498
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006499 If you cannot use git, use "diff -purN OLD NEW". If your version of
6500 diff does not support these options, then get the latest version of
6501 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006502
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006503 The current directory when running this command shall be the parent
6504 directory of the U-Boot source tree (i. e. please make sure that
6505 your patch includes sufficient directory information for the
6506 affected files).
6507
6508 We prefer patches as plain text. MIME attachments are discouraged,
6509 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006510
wdenk6c59edc2004-05-03 20:45:30 +00006511* If one logical set of modifications affects or creates several
6512 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006513
wdenk6c59edc2004-05-03 20:45:30 +00006514* Changesets that contain different, unrelated modifications shall be
6515 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006516
wdenkc6097192002-11-03 00:24:07 +00006517
wdenk6c59edc2004-05-03 20:45:30 +00006518Notes:
wdenkc6097192002-11-03 00:24:07 +00006519
wdenk6c59edc2004-05-03 20:45:30 +00006520* Before sending the patch, run the MAKEALL script on your patched
6521 source tree and make sure that no errors or warnings are reported
6522 for any of the boards.
6523
6524* Keep your modifications to the necessary minimum: A patch
6525 containing several unrelated changes or arbitrary reformats will be
6526 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006527
wdenk6c59edc2004-05-03 20:45:30 +00006528* If you modify existing code, make sure that your new code does not
6529 add to the memory footprint of the code ;-) Small is beautiful!
6530 When adding new features, these should compile conditionally only
6531 (using #ifdef), and the resulting code with the new feature
6532 disabled must not need more memory than the old code without your
6533 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006534
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006535* Remember that there is a size limit of 100 kB per message on the
6536 u-boot mailing list. Bigger patches will be moderated. If they are
6537 reasonable and not too big, they will be acknowledged. But patches
6538 bigger than the size limit should be avoided.