blob: febefb50c24a9bc4efacb6d4224ef17b4b244763 [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
Peter Tysere4d1abc2010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Daya269c932013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass53552c92014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600274
275
wdenkc6097192002-11-03 00:24:07 +0000276Configuration Options:
277----------------------
278
279Configuration depends on the combination of board and CPU type; all
280such information is kept in a configuration file
281"include/configs/<board_name>.h".
282
283Example: For a TQM823L module, all configuration settings are in
284"include/configs/TQM823L.h".
285
286
wdenk1272e232002-11-10 22:06:23 +0000287Many of the options are named exactly as the corresponding Linux
288kernel configuration options. The intention is to make it easier to
289build a config tool - later.
290
291
wdenkc6097192002-11-03 00:24:07 +0000292The following options need to be configured:
293
Kim Phillips203fee32007-08-10 13:28:25 -0500294- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200297
298- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100299 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000300
301- CPU Module Type: (if CONFIG_COGENT is defined)
302 Define exactly one of
303 CONFIG_CMA286_60_OLD
304--- FIXME --- not tested yet:
305 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
306 CONFIG_CMA287_23, CONFIG_CMA287_50
307
308- Motherboard Type: (if CONFIG_COGENT is defined)
309 Define exactly one of
310 CONFIG_CMA101, CONFIG_CMA102
311
312- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
313 Define one or more of
314 CONFIG_CMA302
315
316- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
317 Define one or more of
318 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200319 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000320 a "rotator" |\-/|\-/
321
Lei Wen20014762011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
333 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000334
wdenk20bddb32004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000342
wdenk544e9732004-02-06 23:19:44 +0000343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000349
Heiko Schocher734f0272009-03-12 07:37:15 +0100350 CONFIG_SYS_DELAYED_ICACHE
351
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
354
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000356 CONFIG_SYS_PPC64
357
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
361
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala179b1b22011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000373 CONFIG_SYS_PPC_E500_DEBUG_TLB
374
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
380 purpose.
381
Scott Wood80806962012-08-14 10:14:53 +0000382 CONFIG_SYS_FSL_ERRATUM_A004510
383
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
387
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
390
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
393
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
398
399 See Freescale App Note 4493 for more information about
400 this erratum.
401
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800404 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530405
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530406 CONFIG_A008044_WORKAROUND
407 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800408 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530409
Scott Wood80806962012-08-14 10:14:53 +0000410 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
411
412 This is the value to write into CCSR offset 0x18600
413 according to the A004510 workaround.
414
Priyanka Jainc73b9032013-07-02 09:21:04 +0530415 CONFIG_SYS_FSL_DSP_DDR_ADDR
416 This value denotes start offset of DDR memory which is
417 connected exclusively to the DSP cores.
418
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530419 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
420 This value denotes start offset of M2 memory
421 which is directly connected to the DSP core.
422
Priyanka Jainc73b9032013-07-02 09:21:04 +0530423 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
424 This value denotes start offset of M3 memory which is directly
425 connected to the DSP core.
426
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530427 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
428 This value denotes start offset of DSP CCSR space.
429
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530430 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
431 Single Source Clock is clocking mode present in some of FSL SoC's.
432 In this mode, a single differential clock is used to supply
433 clocks to the sysclock, ddrclock and usbclock.
434
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530435 CONFIG_SYS_CPC_REINIT_F
436 This CONFIG is defined when the CPC is configured as SRAM at the
437 time of U-boot entry and is required to be re-initialized.
438
Tang Yuantiana7364af2014-04-17 15:33:46 +0800439 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800440 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800441 supported, core will start to execute uboot when wakes up.
442
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000443- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700444 CONFIG_SYS_GENERIC_GLOBAL_DATA
445 Defines global data is initialized in generic board board_init_f().
446 If this macro is defined, global data is created and cleared in
447 generic board board_init_f(). Without this macro, architecture/board
448 should initialize global data before calling board_init_f().
449
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000450 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
451
452 Defines the endianess of the CPU. Implementation of those
453 values is arch specific.
454
York Sunf0626592013-09-30 09:22:09 -0700455 CONFIG_SYS_FSL_DDR
456 Freescale DDR driver in use. This type of DDR controller is
457 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
458 SoCs.
459
460 CONFIG_SYS_FSL_DDR_ADDR
461 Freescale DDR memory-mapped register base.
462
463 CONFIG_SYS_FSL_DDR_EMU
464 Specify emulator support for DDR. Some DDR features such as
465 deskew training are not available.
466
467 CONFIG_SYS_FSL_DDRC_GEN1
468 Freescale DDR1 controller.
469
470 CONFIG_SYS_FSL_DDRC_GEN2
471 Freescale DDR2 controller.
472
473 CONFIG_SYS_FSL_DDRC_GEN3
474 Freescale DDR3 controller.
475
York Sun2896cb72014-03-27 17:54:47 -0700476 CONFIG_SYS_FSL_DDRC_GEN4
477 Freescale DDR4 controller.
478
York Sun461c9392013-09-30 14:20:51 -0700479 CONFIG_SYS_FSL_DDRC_ARM_GEN3
480 Freescale DDR3 controller for ARM-based SoCs.
481
York Sunf0626592013-09-30 09:22:09 -0700482 CONFIG_SYS_FSL_DDR1
483 Board config to use DDR1. It can be enabled for SoCs with
484 Freescale DDR1 or DDR2 controllers, depending on the board
485 implemetation.
486
487 CONFIG_SYS_FSL_DDR2
488 Board config to use DDR2. It can be eanbeld for SoCs with
489 Freescale DDR2 or DDR3 controllers, depending on the board
490 implementation.
491
492 CONFIG_SYS_FSL_DDR3
493 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700494 Freescale DDR3 or DDR3L controllers.
495
496 CONFIG_SYS_FSL_DDR3L
497 Board config to use DDR3L. It can be enabled for SoCs with
498 DDR3L controllers.
499
500 CONFIG_SYS_FSL_DDR4
501 Board config to use DDR4. It can be enabled for SoCs with
502 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700503
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530504 CONFIG_SYS_FSL_IFC_BE
505 Defines the IFC controller register space as Big Endian
506
507 CONFIG_SYS_FSL_IFC_LE
508 Defines the IFC controller register space as Little Endian
509
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530510 CONFIG_SYS_FSL_PBL_PBI
511 It enables addition of RCW (Power on reset configuration) in built image.
512 Please refer doc/README.pblimage for more details
513
514 CONFIG_SYS_FSL_PBL_RCW
515 It adds PBI(pre-boot instructions) commands in u-boot build image.
516 PBI commands can be used to configure SoC before it starts the execution.
517 Please refer doc/README.pblimage for more details
518
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530519 CONFIG_SPL_FSL_PBL
520 It adds a target to create boot binary having SPL binary in PBI format
521 concatenated with u-boot binary.
522
York Sun29647ab2014-02-10 13:59:42 -0800523 CONFIG_SYS_FSL_DDR_BE
524 Defines the DDR controller register space as Big Endian
525
526 CONFIG_SYS_FSL_DDR_LE
527 Defines the DDR controller register space as Little Endian
528
York Sun3a0916d2014-02-10 13:59:43 -0800529 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
530 Physical address from the view of DDR controllers. It is the
531 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
532 it could be different for ARM SoCs.
533
York Sunc459ae62014-02-10 13:59:44 -0800534 CONFIG_SYS_FSL_DDR_INTLV_256B
535 DDR controller interleaving on 256-byte. This is a special
536 interleaving mode, handled by Dickens for Freescale layerscape
537 SoCs with ARM core.
538
York Sun79a779b2014-08-01 15:51:00 -0700539 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
540 Number of controllers used as main memory.
541
542 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
543 Number of controllers used for other than main memory.
544
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530545 CONFIG_SYS_FSL_SEC_BE
546 Defines the SEC controller register space as Big Endian
547
548 CONFIG_SYS_FSL_SEC_LE
549 Defines the SEC controller register space as Little Endian
550
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100551- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200552 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100553
554 Defines the Monahans run mode to oscillator
555 ratio. Valid values are 8, 16, 24, 31. The core
556 frequency is this value multiplied by 13 MHz.
557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200558 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200559
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100560 Defines the Monahans turbo mode to oscillator
561 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200562 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100563 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200564
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200565- MIPS CPU options:
566 CONFIG_SYS_INIT_SP_OFFSET
567
568 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
569 pointer. This is needed for the temporary stack before
570 relocation.
571
572 CONFIG_SYS_MIPS_CACHE_MODE
573
574 Cache operation mode for the MIPS CPU.
575 See also arch/mips/include/asm/mipsregs.h.
576 Possible values are:
577 CONF_CM_CACHABLE_NO_WA
578 CONF_CM_CACHABLE_WA
579 CONF_CM_UNCACHED
580 CONF_CM_CACHABLE_NONCOHERENT
581 CONF_CM_CACHABLE_CE
582 CONF_CM_CACHABLE_COW
583 CONF_CM_CACHABLE_CUW
584 CONF_CM_CACHABLE_ACCELERATED
585
586 CONFIG_SYS_XWAY_EBU_BOOTCFG
587
588 Special option for Lantiq XWAY SoCs for booting from NOR flash.
589 See also arch/mips/cpu/mips32/start.S.
590
591 CONFIG_XWAY_SWAP_BYTES
592
593 Enable compilation of tools/xway-swap-bytes needed for Lantiq
594 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
595 be swapped if a flash programmer is used.
596
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000597- ARM options:
598 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
599
600 Select high exception vectors of the ARM core, e.g., do not
601 clear the V bit of the c1 register of CP15.
602
Aneesh Vb8e40802012-03-08 07:20:19 +0000603 CONFIG_SYS_THUMB_BUILD
604
605 Use this flag to build U-Boot using the Thumb instruction
606 set for ARM architectures. Thumb instruction set provides
607 better code density. For ARM architectures that support
608 Thumb2 this flag will result in Thumb2 code generated by
609 GCC.
610
Stephen Warrenc63c3502013-03-04 13:29:40 +0000611 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000612 CONFIG_ARM_ERRATA_742230
613 CONFIG_ARM_ERRATA_743622
614 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500615 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500616 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000617
618 If set, the workarounds for these ARM errata are applied early
619 during U-Boot startup. Note that these options force the
620 workarounds to be applied; no CPU-type/version detection
621 exists, unlike the similar options in the Linux kernel. Do not
622 set these options unless they apply!
623
Simon Glass9fa901b2014-11-10 17:16:54 -0700624- Driver Model
625 Driver model is a new framework for devices in U-Boot
626 introduced in early 2014. U-Boot is being progressively
627 moved over to this. It offers a consistent device structure,
628 supports grouping devices into classes and has built-in
629 handling of platform data and device tree.
630
631 To enable transition to driver model in a relatively
632 painful fashion, each subsystem can be independently
633 switched between the legacy/ad-hoc approach and the new
634 driver model using the options below. Also, many uclass
635 interfaces include compatibility features which may be
636 removed once the conversion of that subsystem is complete.
637 As a result, the API provided by the subsystem may in fact
638 not change with driver model.
639
640 See doc/driver-model/README.txt for more information.
641
642 CONFIG_DM
643
644 Enable driver model. This brings in the core support,
645 including scanning of platform data on start-up. If
646 CONFIG_OF_CONTROL is enabled, the device tree will be
647 scanned also when available.
648
649 CONFIG_CMD_DM
650
651 Enable driver model test commands. These allow you to print
652 out the driver model tree and the uclasses.
653
654 CONFIG_DM_DEMO
655
656 Enable some demo devices and the 'demo' command. These are
657 really only useful for playing around while trying to
658 understand driver model in sandbox.
659
660 CONFIG_SPL_DM
661
662 Enable driver model in SPL. You will need to provide a
663 suitable malloc() implementation. If you are not using the
664 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
665 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
666 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
667 In most cases driver model will only allocate a few uclasses
668 and devices in SPL, so 1KB should be enable. See
669 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
670 it.
671
672 CONFIG_DM_SERIAL
673
674 Enable driver model for serial. This replaces
675 drivers/serial/serial.c with the serial uclass, which
676 implements serial_putc() etc. The uclass interface is
677 defined in include/serial.h.
678
679 CONFIG_DM_GPIO
680
681 Enable driver model for GPIO access. The standard GPIO
682 interface (gpio_get_value(), etc.) is then implemented by
683 the GPIO uclass. Drivers provide methods to query the
684 particular GPIOs that they provide. The uclass interface
685 is defined in include/asm-generic/gpio.h.
686
687 CONFIG_DM_SPI
688
689 Enable driver model for SPI. The SPI slave interface
690 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
691 the SPI uclass. Drivers provide methods to access the SPI
692 buses that they control. The uclass interface is defined in
693 include/spi.h. The existing spi_slave structure is attached
694 as 'parent data' to every slave on each bus. Slaves
695 typically use driver-private data instead of extending the
696 spi_slave structure.
697
698 CONFIG_DM_SPI_FLASH
699
700 Enable driver model for SPI flash. This SPI flash interface
701 (spi_flash_probe(), spi_flash_write(), etc.) is then
702 implemented by the SPI flash uclass. There is one standard
703 SPI flash driver which knows how to probe most chips
704 supported by U-Boot. The uclass interface is defined in
705 include/spi_flash.h, but is currently fully compatible
706 with the old interface to avoid confusion and duplication
707 during the transition parent. SPI and SPI flash must be
708 enabled together (it is not possible to use driver model
709 for one and not the other).
710
711 CONFIG_DM_CROS_EC
712
713 Enable driver model for the Chrome OS EC interface. This
714 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
715 but otherwise makes few changes. Since cros_ec also supports
716 I2C and LPC (which don't support driver model yet), a full
717 conversion is not yet possible.
718
719
720 ** Code size options: The following options are enabled by
721 default except in SPL. Enable them explicitly to get these
722 features in SPL.
723
724 CONFIG_DM_WARN
725
726 Enable the dm_warn() function. This can use up quite a bit
727 of space for its strings.
728
729 CONFIG_DM_STDIO
730
731 Enable registering a serial device with the stdio library.
732
733 CONFIG_DM_DEVICE_REMOVE
734
735 Enable removing of devices.
736
737
wdenk9b7f3842003-10-09 20:09:04 +0000738- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000739 CONFIG_CLOCKS_IN_MHZ
740
741 U-Boot stores all clock information in Hz
742 internally. For binary compatibility with older Linux
743 kernels (which expect the clocks passed in the
744 bd_info data to be in MHz) the environment variable
745 "clocks_in_mhz" can be defined so that U-Boot
746 converts clock data to MHZ before passing it to the
747 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000748 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100749 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000750 default environment.
751
wdenk9b7f3842003-10-09 20:09:04 +0000752 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
753
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800754 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000755 expect it to be in bytes, others in MB.
756 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
757
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400758 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200759
760 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400761 passed using flattened device trees (based on open firmware
762 concepts).
763
764 CONFIG_OF_LIBFDT
765 * New libfdt-based support
766 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500767 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400768
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200769 OF_CPU - The proper name of the cpus node (only required for
770 MPC512X and MPC5xxx based boards).
771 OF_SOC - The proper name of the soc node (only required for
772 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200773 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600774 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200775
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200776 boards with QUICC Engines require OF_QE to set UCC MAC
777 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500778
Kumar Gala1e26aa52006-01-11 13:54:17 -0600779 CONFIG_OF_BOARD_SETUP
780
781 Board code has addition modification that it wants to make
782 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000783
Simon Glass6c0be912014-10-23 18:58:54 -0600784 CONFIG_OF_SYSTEM_SETUP
785
786 Other code has addition modification that it wants to make
787 to the flat device tree before handing it off to the kernel.
788 This causes ft_system_setup() to be called before booting
789 the kernel.
790
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500791 CONFIG_OF_BOOT_CPU
792
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200793 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500794 param header, the default value is zero if undefined.
795
Heiko Schocherffb293a2009-09-23 07:56:08 +0200796 CONFIG_OF_IDE_FIXUP
797
798 U-Boot can detect if an IDE device is present or not.
799 If not, and this new config option is activated, U-Boot
800 removes the ATA node from the DTS before booting Linux,
801 so the Linux IDE driver does not probe the device and
802 crash. This is needed for buggy hardware (uc101) where
803 no pull down resistor is connected to the signal IDE5V_DD7.
804
Igor Grinberg06890672011-07-14 05:45:07 +0000805 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
806
807 This setting is mandatory for all boards that have only one
808 machine type and must be used to specify the machine type
809 number as it appears in the ARM machine registry
810 (see http://www.arm.linux.org.uk/developer/machines/).
811 Only boards that have multiple machine types supported
812 in a single configuration file and the machine type is
813 runtime discoverable, do not have to use this setting.
814
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100815- vxWorks boot parameters:
816
817 bootvx constructs a valid bootline using the following
818 environments variables: bootfile, ipaddr, serverip, hostname.
819 It loads the vxWorks image pointed bootfile.
820
821 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
822 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
823 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
824 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
825
826 CONFIG_SYS_VXWORKS_ADD_PARAMS
827
828 Add it at the end of the bootline. E.g "u=username pw=secret"
829
830 Note: If a "bootargs" environment is defined, it will overwride
831 the defaults discussed just above.
832
Aneesh V960f5c02011-06-16 23:30:47 +0000833- Cache Configuration:
834 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
835 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
836 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
837
Aneesh V686a0752011-06-16 23:30:51 +0000838- Cache Configuration for ARM:
839 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
840 controller
841 CONFIG_SYS_PL310_BASE - Physical base address of PL310
842 controller register space
843
wdenkda04a8b2004-08-02 23:22:59 +0000844- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200845 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000846
847 Define this if you want support for Amba PrimeCell PL010 UARTs.
848
Andreas Engel0813b122008-09-08 14:30:53 +0200849 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000850
851 Define this if you want support for Amba PrimeCell PL011 UARTs.
852
853 CONFIG_PL011_CLOCK
854
855 If you have Amba PrimeCell PL011 UARTs, set this variable to
856 the clock speed of the UARTs.
857
858 CONFIG_PL01x_PORTS
859
860 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
861 define this to a list of base addresses for each (supported)
862 port. See e.g. include/configs/versatile.h
863
John Rigby34e21ee2011-04-19 10:42:39 +0000864 CONFIG_PL011_SERIAL_RLCR
865
866 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
867 have separate receive and transmit line control registers. Set
868 this variable to initialize the extra register.
869
870 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
871
872 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
873 boot loader that has already initialized the UART. Define this
874 variable to flush the UART at init time.
875
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400876 CONFIG_SERIAL_HW_FLOW_CONTROL
877
878 Define this variable to enable hw flow control in serial driver.
879 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000880
wdenkc6097192002-11-03 00:24:07 +0000881- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000882 Depending on board, define exactly one serial port
883 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
884 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
885 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000886
887 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
888 port routines must be defined elsewhere
889 (i.e. serial_init(), serial_getc(), ...)
890
891 CONFIG_CFB_CONSOLE
892 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000893 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000894 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
895 (default big endian)
896 VIDEO_HW_RECTFILL graphic chip supports
897 rectangle fill
898 (cf. smiLynxEM)
899 VIDEO_HW_BITBLT graphic chip supports
900 bit-blit (cf. smiLynxEM)
901 VIDEO_VISIBLE_COLS visible pixel columns
902 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000903 VIDEO_VISIBLE_ROWS visible pixel rows
904 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000905 VIDEO_DATA_FORMAT graphic data format
906 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000907 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000908 VIDEO_KBD_INIT_FCT keyboard int fct
909 (i.e. i8042_kbd_init())
910 VIDEO_TSTC_FCT test char fct
911 (i.e. i8042_tstc)
912 VIDEO_GETC_FCT get char fct
913 (i.e. i8042_getc)
914 CONFIG_CONSOLE_CURSOR cursor drawing on/off
915 (requires blink timer
916 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200917 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000918 CONFIG_CONSOLE_TIME display time/date info in
919 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000921 CONFIG_VIDEO_LOGO display Linux logo in
922 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000923 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
924 linux_logo.h for logo.
925 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000926 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200927 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000928 the logo
929
Pali Rohár4a57da32012-10-19 13:30:09 +0000930 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
931 a limited number of ANSI escape sequences (cursor control,
932 erase functions and limited graphics rendition control).
933
wdenk4a5c8a72003-03-06 00:02:04 +0000934 When CONFIG_CFB_CONSOLE is defined, video console is
935 default i/o. Serial console can be forced with
936 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000937
wdenk1ebf41e2004-01-02 14:00:00 +0000938 When CONFIG_SILENT_CONSOLE is defined, all console
939 messages (by U-Boot and Linux!) can be silenced with
940 the "silent" environment variable. See
941 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000942
Heiko Schocher62759562013-10-22 11:06:06 +0200943 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
944 is 0x00.
945 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
946 is 0xa0.
947
wdenkc6097192002-11-03 00:24:07 +0000948- Console Baudrate:
949 CONFIG_BAUDRATE - in bps
950 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200951 CONFIG_SYS_BAUDRATE_TABLE, see below.
952 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000953
Heiko Schocher327480a2009-01-30 12:55:38 +0100954- Console Rx buffer length
955 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
956 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100957 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100958 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
959 must be defined, to setup the maximum idle timeout for
960 the SMC.
961
Graeme Russ3c28f482011-09-01 00:48:27 +0000962- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200963 Prior to the console being initialised (i.e. serial UART
964 initialised etc) all console output is silently discarded.
965 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
966 buffer any console messages prior to the console being
967 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
968 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
969 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200970 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200971 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000972
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200973 'Sane' compilers will generate smaller code if
974 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000975
Sonny Raocd55bde2011-11-02 09:52:08 +0000976- Safe printf() functions
977 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
978 the printf() functions. These are defined in
979 include/vsprintf.h and include snprintf(), vsnprintf() and
980 so on. Code size increase is approximately 300-500 bytes.
981 If this option is not given then these functions will
982 silently discard their buffer size argument - this means
983 you are not getting any overflow checking in this case.
984
wdenkc6097192002-11-03 00:24:07 +0000985- Boot Delay: CONFIG_BOOTDELAY - in seconds
986 Delay before automatically booting the default image;
987 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000988 set to -2 to autoboot with no delay and not check for abort
989 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000990
991 See doc/README.autoboot for these options that
992 work with CONFIG_BOOTDELAY. None are required.
993 CONFIG_BOOT_RETRY_TIME
994 CONFIG_BOOT_RETRY_MIN
995 CONFIG_AUTOBOOT_KEYED
996 CONFIG_AUTOBOOT_PROMPT
997 CONFIG_AUTOBOOT_DELAY_STR
998 CONFIG_AUTOBOOT_STOP_STR
999 CONFIG_AUTOBOOT_DELAY_STR2
1000 CONFIG_AUTOBOOT_STOP_STR2
1001 CONFIG_ZERO_BOOTDELAY_CHECK
1002 CONFIG_RESET_TO_RETRY
1003
1004- Autoboot Command:
1005 CONFIG_BOOTCOMMAND
1006 Only needed when CONFIG_BOOTDELAY is enabled;
1007 define a command string that is automatically executed
1008 when no character is read on the console interface
1009 within "Boot Delay" after reset.
1010
1011 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +00001012 This can be used to pass arguments to the bootm
1013 command. The value of CONFIG_BOOTARGS goes into the
1014 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001015
1016 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +00001017 The value of these goes into the environment as
1018 "ramboot" and "nfsboot" respectively, and can be used
1019 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001020 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001021
Heiko Schocher040c5c32013-11-04 14:04:59 +01001022- Bootcount:
1023 CONFIG_BOOTCOUNT_LIMIT
1024 Implements a mechanism for detecting a repeating reboot
1025 cycle, see:
1026 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1027
1028 CONFIG_BOOTCOUNT_ENV
1029 If no softreset save registers are found on the hardware
1030 "bootcount" is stored in the environment. To prevent a
1031 saveenv on all reboots, the environment variable
1032 "upgrade_available" is used. If "upgrade_available" is
1033 0, "bootcount" is always 0, if "upgrade_available" is
1034 1 "bootcount" is incremented in the environment.
1035 So the Userspace Applikation must set the "upgrade_available"
1036 and "bootcount" variable to 0, if a boot was successfully.
1037
wdenkc6097192002-11-03 00:24:07 +00001038- Pre-Boot Commands:
1039 CONFIG_PREBOOT
1040
1041 When this option is #defined, the existence of the
1042 environment variable "preboot" will be checked
1043 immediately before starting the CONFIG_BOOTDELAY
1044 countdown and/or running the auto-boot command resp.
1045 entering interactive mode.
1046
1047 This feature is especially useful when "preboot" is
1048 automatically generated or modified. For an example
1049 see the LWMON board specific code: here "preboot" is
1050 modified when the user holds down a certain
1051 combination of keys on the (special) keyboard when
1052 booting the systems
1053
1054- Serial Download Echo Mode:
1055 CONFIG_LOADS_ECHO
1056 If defined to 1, all characters received during a
1057 serial download (using the "loads" command) are
1058 echoed back. This might be needed by some terminal
1059 emulations (like "cu"), but may as well just take
1060 time on others. This setting #define's the initial
1061 value of the "loads_echo" environment variable.
1062
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001063- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001064 CONFIG_KGDB_BAUDRATE
1065 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001066 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001067
1068- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 Monitor commands can be included or excluded
1070 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001071 <config_cmd_all.h> and #undef'ing unwanted
1072 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001073 and augmenting with additional #define's
1074 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001075
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001076 The default command configuration includes all commands
1077 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001078
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001079 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001080 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001081 CONFIG_CMD_BDI bdinfo
1082 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1083 CONFIG_CMD_BMP * BMP support
1084 CONFIG_CMD_BSP * Board specific commands
1085 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001086 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001087 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001088 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001089 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001090 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001091 CONFIG_CMD_DATE * support for RTC, date/time...
1092 CONFIG_CMD_DHCP * DHCP support
1093 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001094 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1095 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1096 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1097 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001098 CONFIG_CMD_DTT * Digital Therm and Thermostat
1099 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001100 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001101 CONFIG_CMD_EEPROM * EEPROM read/write support
1102 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001103 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001104 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001105 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001106 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001107 CONFIG_CMD_EXT2 * ext2 command support
1108 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001109 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1110 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001111 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001112 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001113 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001114 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001115 CONFIG_CMD_FLASH flinfo, erase, protect
1116 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001117 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001118 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001119 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001120 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001121 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001122 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1123 CONFIG_CMD_I2C * I2C serial bus support
1124 CONFIG_CMD_IDE * IDE harddisk support
1125 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001126 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001127 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001128 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001129 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001130 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001131 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001132 CONFIG_CMD_IRQ * irqinfo
1133 CONFIG_CMD_ITEST Integer/string test of 2 values
1134 CONFIG_CMD_JFFS2 * JFFS2 Support
1135 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001136 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001137 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1138 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001139 CONFIG_CMD_LOADB loadb
1140 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001141 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001142 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001143 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001144 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001145 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001146 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001147 CONFIG_CMD_MISC Misc functions like sleep etc
1148 CONFIG_CMD_MMC * MMC memory mapped support
1149 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001150 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001151 CONFIG_CMD_NAND * NAND support
1152 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001153 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001154 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001155 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001156 CONFIG_CMD_PCI * pciinfo
1157 CONFIG_CMD_PCMCIA * PCMCIA support
1158 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1159 host
1160 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001161 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001162 CONFIG_CMD_REGINFO * Register dump
1163 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001164 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001165 CONFIG_CMD_SAVES * save S record dump
1166 CONFIG_CMD_SCSI * SCSI Support
1167 CONFIG_CMD_SDRAM * print SDRAM configuration information
1168 (requires CONFIG_CMD_I2C)
1169 CONFIG_CMD_SETGETDCR Support for DCR Register access
1170 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001171 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001172 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001173 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001174 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001175 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001176 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001177 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001178 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001179 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1180 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001181 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001182 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001183 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001184 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001185 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001186
1187 EXAMPLE: If you want all functions except of network
1188 support you can write:
1189
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001190 #include "config_cmd_all.h"
1191 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001192
Gerald Van Barend6abef42007-03-31 12:23:51 -04001193 Other Commands:
1194 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001195
1196 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001197 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001198 what you (and your U-Boot users) are doing. Data
1199 cache cannot be enabled on systems like the 8xx or
1200 8260 (where accesses to the IMMR region must be
1201 uncached), and it cannot be disabled on all other
1202 systems where we (mis-) use the data cache to hold an
1203 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001204
1205
1206 XXX - this list needs to get updated!
1207
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001208- Regular expression support:
1209 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001210 If this variable is defined, U-Boot is linked against
1211 the SLRE (Super Light Regular Expression) library,
1212 which adds regex support to some commands, as for
1213 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001214
Simon Glass3d686442011-10-15 05:48:20 +00001215- Device tree:
1216 CONFIG_OF_CONTROL
1217 If this variable is defined, U-Boot will use a device tree
1218 to configure its devices, instead of relying on statically
1219 compiled #defines in the board file. This option is
1220 experimental and only available on a few boards. The device
1221 tree is available in the global data as gd->fdt_blob.
1222
Simon Glass5cb34db2011-10-24 19:15:31 +00001223 U-Boot needs to get its device tree from somewhere. This can
1224 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001225
1226 CONFIG_OF_EMBED
1227 If this variable is defined, U-Boot will embed a device tree
1228 binary in its image. This device tree file should be in the
1229 board directory and called <soc>-<board>.dts. The binary file
1230 is then picked up in board_init_f() and made available through
1231 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001232
Simon Glass5cb34db2011-10-24 19:15:31 +00001233 CONFIG_OF_SEPARATE
1234 If this variable is defined, U-Boot will build a device tree
1235 binary. It will be called u-boot.dtb. Architecture-specific
1236 code will locate it at run-time. Generally this works by:
1237
1238 cat u-boot.bin u-boot.dtb >image.bin
1239
1240 and in fact, U-Boot does this for you, creating a file called
1241 u-boot-dtb.bin which is useful in the common case. You can
1242 still use the individual files if you need something more
1243 exotic.
1244
wdenkc6097192002-11-03 00:24:07 +00001245- Watchdog:
1246 CONFIG_WATCHDOG
1247 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001248 support for the SoC. There must be support in the SoC
1249 specific code for a watchdog. For the 8xx and 8260
1250 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1251 register. When supported for a specific SoC is
1252 available, then no further board specific code should
1253 be needed to use it.
1254
1255 CONFIG_HW_WATCHDOG
1256 When using a watchdog circuitry external to the used
1257 SoC, then define this variable and provide board
1258 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001259
Heiko Schocher735326c2015-01-21 08:38:22 +01001260 CONFIG_AT91_HW_WDT_TIMEOUT
1261 specify the timeout in seconds. default 2 seconds.
1262
stroeseb9c17c52003-04-04 15:53:41 +00001263- U-Boot Version:
1264 CONFIG_VERSION_VARIABLE
1265 If this variable is defined, an environment variable
1266 named "ver" is created by U-Boot showing the U-Boot
1267 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001268 Any change to this variable will be reverted at the
1269 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001270
wdenkc6097192002-11-03 00:24:07 +00001271- Real-Time Clock:
1272
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001273 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001274 has to be selected, too. Define exactly one of the
1275 following options:
1276
1277 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1278 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001279 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001280 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001281 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001282 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001283 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001284 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001285 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001286 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001287 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001288 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001289 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1290 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001291
wdenkb9bbd242003-06-30 16:24:52 +00001292 Note that if the RTC uses I2C, then the I2C interface
1293 must also be configured. See I2C Support, below.
1294
Peter Tyser9902e422008-12-17 16:36:21 -06001295- GPIO Support:
1296 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001297
Chris Packham9b383202010-12-19 10:12:13 +00001298 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1299 chip-ngpio pairs that tell the PCA953X driver the number of
1300 pins supported by a particular chip.
1301
Peter Tyser9902e422008-12-17 16:36:21 -06001302 Note that if the GPIO device uses I2C, then the I2C interface
1303 must also be configured. See I2C Support, below.
1304
Simon Glass4dc47ca2014-06-11 23:29:41 -06001305- I/O tracing:
1306 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1307 accesses and can checksum them or write a list of them out
1308 to memory. See the 'iotrace' command for details. This is
1309 useful for testing device drivers since it can confirm that
1310 the driver behaves the same way before and after a code
1311 change. Currently this is supported on sandbox and arm. To
1312 add support for your architecture, add '#include <iotrace.h>'
1313 to the bottom of arch/<arch>/include/asm/io.h and test.
1314
1315 Example output from the 'iotrace stats' command is below.
1316 Note that if the trace buffer is exhausted, the checksum will
1317 still continue to operate.
1318
1319 iotrace is enabled
1320 Start: 10000000 (buffer start address)
1321 Size: 00010000 (buffer size)
1322 Offset: 00000120 (current buffer offset)
1323 Output: 10000120 (start + offset)
1324 Count: 00000018 (number of trace records)
1325 CRC32: 9526fb66 (CRC32 of all trace records)
1326
wdenkc6097192002-11-03 00:24:07 +00001327- Timestamp Support:
1328
wdenk4a5c8a72003-03-06 00:02:04 +00001329 When CONFIG_TIMESTAMP is selected, the timestamp
1330 (date and time) of an image is printed by image
1331 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001332 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001333
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001334- Partition Labels (disklabels) Supported:
1335 Zero or more of the following:
1336 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1337 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1338 Intel architecture, USB sticks, etc.
1339 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1340 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1341 bootloader. Note 2TB partition limit; see
1342 disk/part_efi.c
1343 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001344
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001345 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1346 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001347 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001348
1349- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001350 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1351 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001352
wdenk369d43d2004-03-14 14:09:05 +00001353 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1354 be performed by calling the function
1355 ide_set_reset(int reset)
1356 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001357
1358- ATAPI Support:
1359 CONFIG_ATAPI
1360
1361 Set this to enable ATAPI support.
1362
wdenkf602aa02004-03-13 23:29:43 +00001363- LBA48 Support
1364 CONFIG_LBA48
1365
1366 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001367 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001368 Whithout these , LBA48 support uses 32bit variables and will 'only'
1369 support disks up to 2.1TB.
1370
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001371 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001372 When enabled, makes the IDE subsystem use 64bit sector addresses.
1373 Default is 32bit.
1374
wdenkc6097192002-11-03 00:24:07 +00001375- SCSI Support:
1376 At the moment only there is only support for the
1377 SYM53C8XX SCSI controller; define
1378 CONFIG_SCSI_SYM53C8XX to enable it.
1379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001380 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1381 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1382 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001383 maximum numbers of LUNs, SCSI ID's and target
1384 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001385 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001386
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001387 The environment variable 'scsidevs' is set to the number of
1388 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001389
wdenkc6097192002-11-03 00:24:07 +00001390- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001391 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001392 Support for Intel 8254x/8257x gigabit chips.
1393
1394 CONFIG_E1000_SPI
1395 Utility code for direct access to the SPI bus on Intel 8257x.
1396 This does not do anything useful unless you set at least one
1397 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1398
1399 CONFIG_E1000_SPI_GENERIC
1400 Allow generic access to the SPI bus on the Intel 8257x, for
1401 example with the "sspi" command.
1402
1403 CONFIG_CMD_E1000
1404 Management command for E1000 devices. When used on devices
1405 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001406
Andre Schwarz68c2a302008-03-06 16:45:44 +01001407 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001408 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001409
wdenkc6097192002-11-03 00:24:07 +00001410 CONFIG_EEPRO100
1411 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001412 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001413 write routine for first time initialisation.
1414
1415 CONFIG_TULIP
1416 Support for Digital 2114x chips.
1417 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1418 modem chip initialisation (KS8761/QS6611).
1419
1420 CONFIG_NATSEMI
1421 Support for National dp83815 chips.
1422
1423 CONFIG_NS8382X
1424 Support for National dp8382[01] gigabit chips.
1425
wdenkaa603362003-05-12 21:50:16 +00001426- NETWORK Support (other):
1427
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001428 CONFIG_DRIVER_AT91EMAC
1429 Support for AT91RM9200 EMAC.
1430
1431 CONFIG_RMII
1432 Define this to use reduced MII inteface
1433
1434 CONFIG_DRIVER_AT91EMAC_QUIET
1435 If this defined, the driver is quiet.
1436 The driver doen't show link status messages.
1437
Rob Herringc9830dc2011-12-15 11:15:49 +00001438 CONFIG_CALXEDA_XGMAC
1439 Support for the Calxeda XGMAC device
1440
Ashok93fb8722012-10-15 06:20:47 +00001441 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001442 Support for SMSC's LAN91C96 chips.
1443
1444 CONFIG_LAN91C96_BASE
1445 Define this to hold the physical address
1446 of the LAN91C96's I/O space
1447
1448 CONFIG_LAN91C96_USE_32_BIT
1449 Define this to enable 32 bit addressing
1450
Ashok93fb8722012-10-15 06:20:47 +00001451 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001452 Support for SMSC's LAN91C111 chip
1453
1454 CONFIG_SMC91111_BASE
1455 Define this to hold the physical address
1456 of the device (I/O space)
1457
1458 CONFIG_SMC_USE_32_BIT
1459 Define this if data bus is 32 bits
1460
1461 CONFIG_SMC_USE_IOFUNCS
1462 Define this to use i/o functions instead of macros
1463 (some hardware wont work with macros)
1464
Heiko Schocher7d037f72011-11-15 10:00:04 -05001465 CONFIG_DRIVER_TI_EMAC
1466 Support for davinci emac
1467
1468 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1469 Define this if you have more then 3 PHYs.
1470
Macpaul Lin199c6252010-12-21 16:59:46 +08001471 CONFIG_FTGMAC100
1472 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1473
1474 CONFIG_FTGMAC100_EGIGA
1475 Define this to use GE link update with gigabit PHY.
1476 Define this if FTGMAC100 is connected to gigabit PHY.
1477 If your system has 10/100 PHY only, it might not occur
1478 wrong behavior. Because PHY usually return timeout or
1479 useless data when polling gigabit status and gigabit
1480 control registers. This behavior won't affect the
1481 correctnessof 10/100 link speed update.
1482
Mike Rapoportf4761af2009-11-11 10:03:03 +02001483 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001484 Support for SMSC's LAN911x and LAN921x chips
1485
Mike Rapoportf4761af2009-11-11 10:03:03 +02001486 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001487 Define this to hold the physical address
1488 of the device (I/O space)
1489
Mike Rapoportf4761af2009-11-11 10:03:03 +02001490 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001491 Define this if data bus is 32 bits
1492
Mike Rapoportf4761af2009-11-11 10:03:03 +02001493 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001494 Define this if data bus is 16 bits. If your processor
1495 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001496 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001497
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001498 CONFIG_SH_ETHER
1499 Support for Renesas on-chip Ethernet controller
1500
1501 CONFIG_SH_ETHER_USE_PORT
1502 Define the number of ports to be used
1503
1504 CONFIG_SH_ETHER_PHY_ADDR
1505 Define the ETH PHY's address
1506
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001507 CONFIG_SH_ETHER_CACHE_WRITEBACK
1508 If this option is set, the driver enables cache flush.
1509
Heiko Schocher2b387762014-07-18 06:07:19 +02001510- PWM Support:
1511 CONFIG_PWM_IMX
1512 Support for PWM modul on the imx6.
1513
Vadim Bendeburydac69642011-10-17 08:36:14 +00001514- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001515 CONFIG_TPM
1516 Support TPM devices.
1517
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001518 CONFIG_TPM_TIS_I2C
1519 Support for i2c bus TPM devices. Only one device
1520 per system is supported at this time.
1521
1522 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1523 Define the the i2c bus number for the TPM device
1524
1525 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1526 Define the TPM's address on the i2c bus
1527
1528 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1529 Define the burst count bytes upper limit
1530
Dirk Eibach20489092013-06-26 15:55:15 +02001531 CONFIG_TPM_ATMEL_TWI
1532 Support for Atmel TWI TPM device. Requires I2C support.
1533
Che-liang Chiouacea5702013-04-12 11:04:34 +00001534 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001535 Support for generic parallel port TPM devices. Only one device
1536 per system is supported at this time.
1537
1538 CONFIG_TPM_TIS_BASE_ADDRESS
1539 Base address where the generic TPM device is mapped
1540 to. Contemporary x86 systems usually map it at
1541 0xfed40000.
1542
Reinhard Pfau4fece432013-06-26 15:55:13 +02001543 CONFIG_CMD_TPM
1544 Add tpm monitor functions.
1545 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1546 provides monitor access to authorized functions.
1547
1548 CONFIG_TPM
1549 Define this to enable the TPM support library which provides
1550 functional interfaces to some TPM commands.
1551 Requires support for a TPM device.
1552
1553 CONFIG_TPM_AUTH_SESSIONS
1554 Define this to enable authorized functions in the TPM library.
1555 Requires CONFIG_TPM and CONFIG_SHA1.
1556
wdenkc6097192002-11-03 00:24:07 +00001557- USB Support:
1558 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001559 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001560 CONFIG_USB_UHCI to enable it.
1561 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001562 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001563 storage devices.
1564 Note:
1565 Supported are USB Keyboards and USB Floppy drives
1566 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001567 MPC5200 USB requires additional defines:
1568 CONFIG_USB_CLOCK
1569 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001570 CONFIG_PSC3_USB
1571 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001572 CONFIG_USB_CONFIG
1573 for differential drivers: 0x00001000
1574 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001575 for differential drivers on PSC3: 0x00000100
1576 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001577 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001578 May be defined to allow interrupt polling
1579 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001580
Simon Glass5978cdb2012-02-27 10:52:47 +00001581 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1582 txfilltuning field in the EHCI controller on reset.
1583
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001584 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1585 HW module registers.
1586
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001587- USB Device:
1588 Define the below if you wish to use the USB console.
1589 Once firmware is rebuilt from a serial console issue the
1590 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001591 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001592 it has found a new device. The environment variable usbtty
1593 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001594 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001595 Common Device Class Abstract Control Model serial device.
1596 If you select usbtty = gserial you should be able to enumerate
1597 a Linux host by
1598 # modprobe usbserial vendor=0xVendorID product=0xProductID
1599 else if using cdc_acm, simply setting the environment
1600 variable usbtty to be cdc_acm should suffice. The following
1601 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001602
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001603 CONFIG_USB_DEVICE
1604 Define this to build a UDC device
1605
1606 CONFIG_USB_TTY
1607 Define this to have a tty type of device available to
1608 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001609
Vipin KUMARbdb17702012-03-26 15:38:06 +05301610 CONFIG_USBD_HS
1611 Define this to enable the high speed support for usb
1612 device and usbtty. If this feature is enabled, a routine
1613 int is_usbd_high_speed(void)
1614 also needs to be defined by the driver to dynamically poll
1615 whether the enumeration has succeded at high speed or full
1616 speed.
1617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001618 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001619 Define this if you want stdin, stdout &/or stderr to
1620 be set to usbtty.
1621
1622 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001623 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001624 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001625 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001627 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001628 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001629 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001630
Wolfgang Denke2601822006-06-14 18:14:56 +02001631 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001632 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001633 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001634 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1635 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1636 should pretend to be a Linux device to it's target host.
1637
1638 CONFIG_USBD_MANUFACTURER
1639 Define this string as the name of your company for
1640 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001641
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001642 CONFIG_USBD_PRODUCT_NAME
1643 Define this string as the name of your product
1644 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001645
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001646 CONFIG_USBD_VENDORID
1647 Define this as your assigned Vendor ID from the USB
1648 Implementors Forum. This *must* be a genuine Vendor ID
1649 to avoid polluting the USB namespace.
1650 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001651
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001652 CONFIG_USBD_PRODUCTID
1653 Define this as the unique Product ID
1654 for your device
1655 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001656
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001657- ULPI Layer Support:
1658 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1659 the generic ULPI layer. The generic layer accesses the ULPI PHY
1660 via the platform viewport, so you need both the genric layer and
1661 the viewport enabled. Currently only Chipidea/ARC based
1662 viewport is supported.
1663 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1664 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001665 If your ULPI phy needs a different reference clock than the
1666 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1667 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001668
wdenk7a428cc2003-06-15 22:40:42 +00001669- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001670 The MMC controller on the Intel PXA is supported. To
1671 enable this define CONFIG_MMC. The MMC can be
1672 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001673 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001674 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1675 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001676
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001677 CONFIG_SH_MMCIF
1678 Support for Renesas on-chip MMCIF controller
1679
1680 CONFIG_SH_MMCIF_ADDR
1681 Define the base address of MMCIF registers
1682
1683 CONFIG_SH_MMCIF_CLK
1684 Define the clock frequency for MMCIF
1685
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001686 CONFIG_GENERIC_MMC
1687 Enable the generic MMC driver
1688
1689 CONFIG_SUPPORT_EMMC_BOOT
1690 Enable some additional features of the eMMC boot partitions.
1691
1692 CONFIG_SUPPORT_EMMC_RPMB
1693 Enable the commands for reading, writing and programming the
1694 key for the Replay Protection Memory Block partition in eMMC.
1695
Tom Rini58a8d322013-03-14 05:32:47 +00001696- USB Device Firmware Update (DFU) class support:
1697 CONFIG_DFU_FUNCTION
1698 This enables the USB portion of the DFU USB class
1699
1700 CONFIG_CMD_DFU
1701 This enables the command "dfu" which is used to have
1702 U-Boot create a DFU class device via USB. This command
1703 requires that the "dfu_alt_info" environment variable be
1704 set and define the alt settings to expose to the host.
1705
1706 CONFIG_DFU_MMC
1707 This enables support for exposing (e)MMC devices via DFU.
1708
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001709 CONFIG_DFU_NAND
1710 This enables support for exposing NAND devices via DFU.
1711
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301712 CONFIG_DFU_RAM
1713 This enables support for exposing RAM via DFU.
1714 Note: DFU spec refer to non-volatile memory usage, but
1715 allow usages beyond the scope of spec - here RAM usage,
1716 one that would help mostly the developer.
1717
Heiko Schochera2f831e2013-06-12 06:05:51 +02001718 CONFIG_SYS_DFU_DATA_BUF_SIZE
1719 Dfu transfer uses a buffer before writing data to the
1720 raw storage device. Make the size (in bytes) of this buffer
1721 configurable. The size of this buffer is also configurable
1722 through the "dfu_bufsiz" environment variable.
1723
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001724 CONFIG_SYS_DFU_MAX_FILE_SIZE
1725 When updating files rather than the raw storage device,
1726 we use a static buffer to copy the file into and then write
1727 the buffer once we've been given the whole file. Define
1728 this to the maximum filesize (in bytes) for the buffer.
1729 Default is 4 MiB if undefined.
1730
Heiko Schochere1ba1512014-03-18 08:09:56 +01001731 DFU_DEFAULT_POLL_TIMEOUT
1732 Poll timeout [ms], is the timeout a device can send to the
1733 host. The host must wait for this timeout before sending
1734 a subsequent DFU_GET_STATUS request to the device.
1735
1736 DFU_MANIFEST_POLL_TIMEOUT
1737 Poll timeout [ms], which the device sends to the host when
1738 entering dfuMANIFEST state. Host waits this timeout, before
1739 sending again an USB request to the device.
1740
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001741- USB Device Android Fastboot support:
1742 CONFIG_CMD_FASTBOOT
1743 This enables the command "fastboot" which enables the Android
1744 fastboot mode for the platform's USB device. Fastboot is a USB
1745 protocol for downloading images, flashing and device control
1746 used on Android devices.
1747 See doc/README.android-fastboot for more information.
1748
1749 CONFIG_ANDROID_BOOT_IMAGE
1750 This enables support for booting images which use the Android
1751 image format header.
1752
1753 CONFIG_USB_FASTBOOT_BUF_ADDR
1754 The fastboot protocol requires a large memory buffer for
1755 downloads. Define this to the starting RAM address to use for
1756 downloaded images.
1757
1758 CONFIG_USB_FASTBOOT_BUF_SIZE
1759 The fastboot protocol requires a large memory buffer for
1760 downloads. This buffer should be as large as possible for a
1761 platform. Define this to the size available RAM for fastboot.
1762
Steve Raebfb9ba42014-08-26 11:47:28 -07001763 CONFIG_FASTBOOT_FLASH
1764 The fastboot protocol includes a "flash" command for writing
1765 the downloaded image to a non-volatile storage device. Define
1766 this to enable the "fastboot flash" command.
1767
1768 CONFIG_FASTBOOT_FLASH_MMC_DEV
1769 The fastboot "flash" command requires additional information
1770 regarding the non-volatile storage device. Define this to
1771 the eMMC device that fastboot should use to store the image.
1772
Steve Rae7d059342014-12-12 15:51:54 -08001773 CONFIG_FASTBOOT_GPT_NAME
1774 The fastboot "flash" command supports writing the downloaded
1775 image to the Protective MBR and the Primary GUID Partition
1776 Table. (Additionally, this downloaded image is post-processed
1777 to generate and write the Backup GUID Partition Table.)
1778 This occurs when the specified "partition name" on the
1779 "fastboot flash" command line matches this value.
1780 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1781
wdenkda04a8b2004-08-02 23:22:59 +00001782- Journaling Flash filesystem support:
1783 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1784 CONFIG_JFFS2_NAND_DEV
1785 Define these for a default partition on a NAND device
1786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001787 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1788 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001789 Define these for a default partition on a NOR device
1790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001791 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001792 Define this to create an own partition. You have to provide a
1793 function struct part_info* jffs2_part_info(int part_num)
1794
1795 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001796 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001797 to disable the command chpart. This is the default when you
1798 have not defined a custom partition
1799
Donggeun Kim8f814002011-10-24 21:15:28 +00001800- FAT(File Allocation Table) filesystem write function support:
1801 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001802
1803 Define this to enable support for saving memory data as a
1804 file in FAT formatted partition.
1805
1806 This will also enable the command "fatwrite" enabling the
1807 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001808
Gabe Black7f8574c2012-10-12 14:26:11 +00001809CBFS (Coreboot Filesystem) support
1810 CONFIG_CMD_CBFS
1811
1812 Define this to enable support for reading from a Coreboot
1813 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1814 and cbfsload.
1815
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301816- FAT(File Allocation Table) filesystem cluster size:
1817 CONFIG_FS_FAT_MAX_CLUSTSIZE
1818
1819 Define the max cluster size for fat operations else
1820 a default value of 65536 will be defined.
1821
wdenkc6097192002-11-03 00:24:07 +00001822- Keyboard Support:
1823 CONFIG_ISA_KEYBOARD
1824
1825 Define this to enable standard (PC-Style) keyboard
1826 support
1827
1828 CONFIG_I8042_KBD
1829 Standard PC keyboard driver with US (is default) and
1830 GERMAN key layout (switch via environment 'keymap=de') support.
1831 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1832 for cfb_console. Supports cursor blinking.
1833
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001834 CONFIG_CROS_EC_KEYB
1835 Enables a Chrome OS keyboard using the CROS_EC interface.
1836 This uses CROS_EC to communicate with a second microcontroller
1837 which provides key scans on request.
1838
wdenkc6097192002-11-03 00:24:07 +00001839- Video support:
1840 CONFIG_VIDEO
1841
1842 Define this to enable video support (for output to
1843 video).
1844
1845 CONFIG_VIDEO_CT69000
1846
1847 Enable Chips & Technologies 69000 Video chip
1848
1849 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001850 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001851 video output is selected via environment 'videoout'
1852 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1853 assumed.
wdenkc6097192002-11-03 00:24:07 +00001854
wdenkd3602132004-03-25 15:14:43 +00001855 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001856 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001857 are possible:
1858 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001859 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001860
1861 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1862 -------------+---------------------------------------------
1863 8 bits | 0x301* 0x303 0x305 0x161 0x307
1864 15 bits | 0x310 0x313 0x316 0x162 0x319
1865 16 bits | 0x311 0x314 0x317 0x163 0x31A
1866 24 bits | 0x312 0x315 0x318 ? 0x31B
1867 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001868 (i.e. setenv videomode 317; saveenv; reset;)
1869
wdenkd3602132004-03-25 15:14:43 +00001870 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001871 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001872
1873
stroeseb9c17c52003-04-04 15:53:41 +00001874 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001875 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001876 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1877 or CONFIG_VIDEO_SED13806_16BPP
1878
Timur Tabi020edd22011-02-15 17:09:19 -06001879 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001880 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001881 SOCs that have a DIU should define this macro to enable DIU
1882 support, and should also define these other macros:
1883
1884 CONFIG_SYS_DIU_ADDR
1885 CONFIG_VIDEO
1886 CONFIG_CMD_BMP
1887 CONFIG_CFB_CONSOLE
1888 CONFIG_VIDEO_SW_CURSOR
1889 CONFIG_VGA_AS_SINGLE_DEVICE
1890 CONFIG_VIDEO_LOGO
1891 CONFIG_VIDEO_BMP_LOGO
1892
Timur Tabi32f709e2011-04-11 14:18:22 -05001893 The DIU driver will look for the 'video-mode' environment
1894 variable, and if defined, enable the DIU as a console during
1895 boot. See the documentation file README.video for a
1896 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001897
Simon Glass54df8ce2012-12-03 13:59:47 +00001898 CONFIG_VIDEO_VGA
1899
1900 Enable the VGA video / BIOS for x86. The alternative if you
1901 are using coreboot is to use the coreboot frame buffer
1902 driver.
1903
1904
wdenk4e112c12003-06-03 23:54:09 +00001905- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001906 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001907
wdenk57b2d802003-06-27 21:31:46 +00001908 Define this to enable a custom keyboard support.
1909 This simply calls drv_keyboard_init() which must be
1910 defined in your board-specific files.
1911 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001912
wdenkc6097192002-11-03 00:24:07 +00001913- LCD Support: CONFIG_LCD
1914
1915 Define this to enable LCD support (for output to LCD
1916 display); also select one of the supported displays
1917 by defining one of these:
1918
Stelian Popf6f86652008-05-09 21:57:18 +02001919 CONFIG_ATMEL_LCD:
1920
1921 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1922
wdenkc0d54ae2003-11-25 16:55:19 +00001923 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001924
wdenkc0d54ae2003-11-25 16:55:19 +00001925 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001926
wdenkc0d54ae2003-11-25 16:55:19 +00001927 CONFIG_NEC_NL6448BC20
1928
1929 NEC NL6448BC20-08. 6.5", 640x480.
1930 Active, color, single scan.
1931
1932 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001933
wdenkc0d54ae2003-11-25 16:55:19 +00001934 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001935 Active, color, single scan.
1936
1937 CONFIG_SHARP_16x9
1938
1939 Sharp 320x240. Active, color, single scan.
1940 It isn't 16x9, and I am not sure what it is.
1941
1942 CONFIG_SHARP_LQ64D341
1943
1944 Sharp LQ64D341 display, 640x480.
1945 Active, color, single scan.
1946
1947 CONFIG_HLD1045
1948
1949 HLD1045 display, 640x480.
1950 Active, color, single scan.
1951
1952 CONFIG_OPTREX_BW
1953
1954 Optrex CBL50840-2 NF-FW 99 22 M5
1955 or
1956 Hitachi LMG6912RPFC-00T
1957 or
1958 Hitachi SP14Q002
1959
1960 320x240. Black & white.
1961
1962 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001963 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001964
Simon Glass599a4df2012-10-17 13:24:54 +00001965 CONFIG_LCD_ALIGNMENT
1966
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001967 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001968 defined then the LCD will be aligned to this value instead.
1969 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1970 here, since it is cheaper to change data cache settings on
1971 a per-section basis.
1972
Simon Glassaf3e2802012-10-17 13:24:59 +00001973 CONFIG_CONSOLE_SCROLL_LINES
1974
1975 When the console need to be scrolled, this is the number of
1976 lines to scroll by. It defaults to 1. Increasing this makes
1977 the console jump but can help speed up operation when scrolling
1978 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001979
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001980 CONFIG_LCD_BMP_RLE8
1981
1982 Support drawing of RLE8-compressed bitmaps on the LCD.
1983
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001984 CONFIG_I2C_EDID
1985
1986 Enables an 'i2c edid' command which can read EDID
1987 information over I2C from an attached LCD display.
1988
wdenkeb20ad32003-09-05 23:19:14 +00001989- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001990
wdenk57b2d802003-06-27 21:31:46 +00001991 If this option is set, the environment is checked for
1992 a variable "splashimage". If found, the usual display
1993 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001994 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001995 specified in "splashimage" is loaded instead. The
1996 console is redirected to the "nulldev", too. This
1997 allows for a "silent" boot where a splash screen is
1998 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001999
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002000 CONFIG_SPLASHIMAGE_GUARD
2001
2002 If this option is set, then U-Boot will prevent the environment
2003 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05002004 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002005 This option is useful for targets where, due to alignment
2006 restrictions, an improperly aligned BMP image will cause a data
2007 abort. If you think you will not have problems with unaligned
2008 accesses (for example because your toolchain prevents them)
2009 there is no need to set this option.
2010
Matthias Weisser53884182009-07-09 16:07:30 +02002011 CONFIG_SPLASH_SCREEN_ALIGN
2012
2013 If this option is set the splash image can be freely positioned
2014 on the screen. Environment variable "splashpos" specifies the
2015 position as "x,y". If a positive number is given it is used as
2016 number of pixel from left/top. If a negative number is given it
2017 is used as number of pixel from right/bottom. You can also
2018 specify 'm' for centering the image.
2019
2020 Example:
2021 setenv splashpos m,m
2022 => image at center of screen
2023
2024 setenv splashpos 30,20
2025 => image at x = 30 and y = 20
2026
2027 setenv splashpos -10,m
2028 => vertically centered image
2029 at x = dspWidth - bmpWidth - 9
2030
Stefan Roesed9d97742005-09-22 09:04:17 +02002031- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2032
2033 If this option is set, additionally to standard BMP
2034 images, gzipped BMP images can be displayed via the
2035 splashscreen support or the bmp command.
2036
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002037- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2038
2039 If this option is set, 8-bit RLE compressed BMP images
2040 can be displayed via the splashscreen support or the
2041 bmp command.
2042
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002043- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002044 CONFIG_CMD_ZIP
2045
2046 If this option is set, it would use zlib deflate method
2047 to compress the specified memory at its best effort.
2048
wdenk710e3502003-08-29 20:57:53 +00002049- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002050 CONFIG_GZIP
2051
2052 Enabled by default to support gzip compressed images.
2053
wdenk710e3502003-08-29 20:57:53 +00002054 CONFIG_BZIP2
2055
2056 If this option is set, support for bzip2 compressed
2057 images is included. If not, only uncompressed and gzip
2058 compressed images are supported.
2059
wdenk9c53f402003-10-15 23:53:47 +00002060 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002061 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002062 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002063
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002064 CONFIG_LZMA
2065
2066 If this option is set, support for lzma compressed
2067 images is included.
2068
2069 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2070 requires an amount of dynamic memory that is given by the
2071 formula:
2072
2073 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2074
2075 Where lc and lp stand for, respectively, Literal context bits
2076 and Literal pos bits.
2077
2078 This value is upper-bounded by 14MB in the worst case. Anyway,
2079 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2080 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2081 a very small buffer.
2082
2083 Use the lzmainfo tool to determinate the lc and lp values and
2084 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002085 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002086
Kees Cook5b06e642013-08-16 07:59:12 -07002087 CONFIG_LZO
2088
2089 If this option is set, support for LZO compressed images
2090 is included.
2091
wdenk0e2bd9c2004-06-06 21:51:03 +00002092- MII/PHY support:
2093 CONFIG_PHY_ADDR
2094
2095 The address of PHY on MII bus.
2096
2097 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2098
2099 The clock frequency of the MII bus
2100
2101 CONFIG_PHY_GIGE
2102
2103 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002104 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002105
2106 CONFIG_PHY_RESET_DELAY
2107
2108 Some PHY like Intel LXT971A need extra delay after
2109 reset before any MII register access is possible.
2110 For such PHY, set this option to the usec delay
2111 required. (minimum 300usec for LXT971A)
2112
2113 CONFIG_PHY_CMD_DELAY (ppc4xx)
2114
2115 Some PHY like Intel LXT971A need extra delay after
2116 command issued before MII status register can be read
2117
wdenkc6097192002-11-03 00:24:07 +00002118- Ethernet address:
2119 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002120 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002121 CONFIG_ETH2ADDR
2122 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002123 CONFIG_ETH4ADDR
2124 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002125
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002126 Define a default value for Ethernet address to use
2127 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002128 is not determined automatically.
2129
2130- IP address:
2131 CONFIG_IPADDR
2132
2133 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002134 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002135 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002136 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002137
2138- Server IP address:
2139 CONFIG_SERVERIP
2140
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002141 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002142 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002143 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002144
Robin Getz470a6d42009-07-21 12:15:28 -04002145 CONFIG_KEEP_SERVERADDR
2146
2147 Keeps the server's MAC address, in the env 'serveraddr'
2148 for passing to bootargs (like Linux's netconsole option)
2149
Wolfgang Denk26da2992011-10-26 10:21:22 +00002150- Gateway IP address:
2151 CONFIG_GATEWAYIP
2152
2153 Defines a default value for the IP address of the
2154 default router where packets to other networks are
2155 sent to.
2156 (Environment variable "gatewayip")
2157
2158- Subnet mask:
2159 CONFIG_NETMASK
2160
2161 Defines a default value for the subnet mask (or
2162 routing prefix) which is used to determine if an IP
2163 address belongs to the local subnet or needs to be
2164 forwarded through a router.
2165 (Environment variable "netmask")
2166
David Updegraff7280da72007-06-11 10:41:07 -05002167- Multicast TFTP Mode:
2168 CONFIG_MCAST_TFTP
2169
2170 Defines whether you want to support multicast TFTP as per
2171 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002172 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002173 driver in use must provide a function: mcast() to join/leave a
2174 multicast group.
2175
wdenkc6097192002-11-03 00:24:07 +00002176- BOOTP Recovery Mode:
2177 CONFIG_BOOTP_RANDOM_DELAY
2178
2179 If you have many targets in a network that try to
2180 boot using BOOTP, you may want to avoid that all
2181 systems send out BOOTP requests at precisely the same
2182 moment (which would happen for instance at recovery
2183 from a power failure, when all systems will try to
2184 boot, thus flooding the BOOTP server. Defining
2185 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2186 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002187 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002188
2189 1st BOOTP request: delay 0 ... 1 sec
2190 2nd BOOTP request: delay 0 ... 2 sec
2191 3rd BOOTP request: delay 0 ... 4 sec
2192 4th and following
2193 BOOTP requests: delay 0 ... 8 sec
2194
Thierry Reding8977cda2014-08-19 10:21:24 +02002195 CONFIG_BOOTP_ID_CACHE_SIZE
2196
2197 BOOTP packets are uniquely identified using a 32-bit ID. The
2198 server will copy the ID from client requests to responses and
2199 U-Boot will use this to determine if it is the destination of
2200 an incoming response. Some servers will check that addresses
2201 aren't in use before handing them out (usually using an ARP
2202 ping) and therefore take up to a few hundred milliseconds to
2203 respond. Network congestion may also influence the time it
2204 takes for a response to make it back to the client. If that
2205 time is too long, U-Boot will retransmit requests. In order
2206 to allow earlier responses to still be accepted after these
2207 retransmissions, U-Boot's BOOTP client keeps a small cache of
2208 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2209 cache. The default is to keep IDs for up to four outstanding
2210 requests. Increasing this will allow U-Boot to accept offers
2211 from a BOOTP client in networks with unusually high latency.
2212
stroesee0aadfb2003-08-28 14:17:32 +00002213- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002214 You can fine tune the DHCP functionality by defining
2215 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002216
Jon Loeliger5336a762007-07-09 22:08:34 -05002217 CONFIG_BOOTP_SUBNETMASK
2218 CONFIG_BOOTP_GATEWAY
2219 CONFIG_BOOTP_HOSTNAME
2220 CONFIG_BOOTP_NISDOMAIN
2221 CONFIG_BOOTP_BOOTPATH
2222 CONFIG_BOOTP_BOOTFILESIZE
2223 CONFIG_BOOTP_DNS
2224 CONFIG_BOOTP_DNS2
2225 CONFIG_BOOTP_SEND_HOSTNAME
2226 CONFIG_BOOTP_NTPSERVER
2227 CONFIG_BOOTP_TIMEOFFSET
2228 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002229 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002230
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002231 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2232 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002233
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002234 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2235 after the configured retry count, the call will fail
2236 instead of starting over. This can be used to fail over
2237 to Link-local IP address configuration if the DHCP server
2238 is not available.
2239
stroesee0aadfb2003-08-28 14:17:32 +00002240 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2241 serverip from a DHCP server, it is possible that more
2242 than one DNS serverip is offered to the client.
2243 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2244 serverip will be stored in the additional environment
2245 variable "dnsip2". The first DNS serverip is always
2246 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002247 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002248
2249 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2250 to do a dynamic update of a DNS server. To do this, they
2251 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002252 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002253 of the "hostname" environment variable is passed as
2254 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002255
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002256 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2257
2258 A 32bit value in microseconds for a delay between
2259 receiving a "DHCP Offer" and sending the "DHCP Request".
2260 This fixes a problem with certain DHCP servers that don't
2261 respond 100% of the time to a "DHCP request". E.g. On an
2262 AT91RM9200 processor running at 180MHz, this delay needed
2263 to be *at least* 15,000 usec before a Windows Server 2003
2264 DHCP server would reply 100% of the time. I recommend at
2265 least 50,000 usec to be safe. The alternative is to hope
2266 that one of the retries will be successful but note that
2267 the DHCP timeout and retry process takes a longer than
2268 this delay.
2269
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002270 - Link-local IP address negotiation:
2271 Negotiate with other link-local clients on the local network
2272 for an address that doesn't require explicit configuration.
2273 This is especially useful if a DHCP server cannot be guaranteed
2274 to exist in all environments that the device must operate.
2275
2276 See doc/README.link-local for more information.
2277
wdenk145d2c12004-04-15 21:48:45 +00002278 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002279 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002280
2281 The device id used in CDP trigger frames.
2282
2283 CONFIG_CDP_DEVICE_ID_PREFIX
2284
2285 A two character string which is prefixed to the MAC address
2286 of the device.
2287
2288 CONFIG_CDP_PORT_ID
2289
2290 A printf format string which contains the ascii name of
2291 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002292 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002293
2294 CONFIG_CDP_CAPABILITIES
2295
2296 A 32bit integer which indicates the device capabilities;
2297 0x00000010 for a normal host which does not forwards.
2298
2299 CONFIG_CDP_VERSION
2300
2301 An ascii string containing the version of the software.
2302
2303 CONFIG_CDP_PLATFORM
2304
2305 An ascii string containing the name of the platform.
2306
2307 CONFIG_CDP_TRIGGER
2308
2309 A 32bit integer sent on the trigger.
2310
2311 CONFIG_CDP_POWER_CONSUMPTION
2312
2313 A 16bit integer containing the power consumption of the
2314 device in .1 of milliwatts.
2315
2316 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2317
2318 A byte containing the id of the VLAN.
2319
wdenkc6097192002-11-03 00:24:07 +00002320- Status LED: CONFIG_STATUS_LED
2321
2322 Several configurations allow to display the current
2323 status using a LED. For instance, the LED will blink
2324 fast while running U-Boot code, stop blinking as
2325 soon as a reply to a BOOTP request was received, and
2326 start blinking slow once the Linux kernel is running
2327 (supported by a status LED driver in the Linux
2328 kernel). Defining CONFIG_STATUS_LED enables this
2329 feature in U-Boot.
2330
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002331 Additional options:
2332
2333 CONFIG_GPIO_LED
2334 The status LED can be connected to a GPIO pin.
2335 In such cases, the gpio_led driver can be used as a
2336 status LED backend implementation. Define CONFIG_GPIO_LED
2337 to include the gpio_led driver in the U-Boot binary.
2338
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002339 CONFIG_GPIO_LED_INVERTED_TABLE
2340 Some GPIO connected LEDs may have inverted polarity in which
2341 case the GPIO high value corresponds to LED off state and
2342 GPIO low value corresponds to LED on state.
2343 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2344 with a list of GPIO LEDs that have inverted polarity.
2345
wdenkc6097192002-11-03 00:24:07 +00002346- CAN Support: CONFIG_CAN_DRIVER
2347
2348 Defining CONFIG_CAN_DRIVER enables CAN driver support
2349 on those systems that support this (optional)
2350 feature, like the TQM8xxL modules.
2351
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002352- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002353
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002354 This enable the NEW i2c subsystem, and will allow you to use
2355 i2c commands at the u-boot command line (as long as you set
2356 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2357 based realtime clock chips or other i2c devices. See
2358 common/cmd_i2c.c for a description of the command line
2359 interface.
2360
2361 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002362 - drivers/i2c/soft_i2c.c:
2363 - activate first bus with CONFIG_SYS_I2C_SOFT define
2364 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2365 for defining speed and slave address
2366 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2367 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2368 for defining speed and slave address
2369 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2370 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2371 for defining speed and slave address
2372 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2373 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2374 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002375
Heiko Schocherf2850742012-10-24 13:48:22 +02002376 - drivers/i2c/fsl_i2c.c:
2377 - activate i2c driver with CONFIG_SYS_I2C_FSL
2378 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2379 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2380 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2381 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002382 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002383 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2384 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2385 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2386 second bus.
2387
Simon Glass026fefb2012-10-30 07:28:53 +00002388 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002389 - activate this driver with CONFIG_SYS_I2C_TEGRA
2390 - This driver adds 4 i2c buses with a fix speed from
2391 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002392
Dirk Eibach42b204f2013-04-25 02:40:01 +00002393 - drivers/i2c/ppc4xx_i2c.c
2394 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2395 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2396 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2397
trema49f40a2013-09-21 18:13:35 +02002398 - drivers/i2c/i2c_mxc.c
2399 - activate this driver with CONFIG_SYS_I2C_MXC
2400 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2401 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2402 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2403 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2404 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2405 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002406 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002407 for speed, and 0 for slave.
2408
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002409 - drivers/i2c/rcar_i2c.c:
2410 - activate this driver with CONFIG_SYS_I2C_RCAR
2411 - This driver adds 4 i2c buses
2412
2413 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2414 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2415 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2416 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2417 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2418 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2419 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2420 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2421 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2422
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002423 - drivers/i2c/sh_i2c.c:
2424 - activate this driver with CONFIG_SYS_I2C_SH
2425 - This driver adds from 2 to 5 i2c buses
2426
2427 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2428 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2429 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2430 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2431 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2432 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2433 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2434 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2435 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2436 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2437 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2438 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002439 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002440
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002441 - drivers/i2c/omap24xx_i2c.c
2442 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2443 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2445 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2446 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2447 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2448 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2449 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2450 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2451 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2452 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2453
Heiko Schocher465819a2013-11-08 07:30:53 +01002454 - drivers/i2c/zynq_i2c.c
2455 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2456 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2457 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2458
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302459 - drivers/i2c/s3c24x0_i2c.c:
2460 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2461 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2462 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2463 with a fix speed from 100000 and the slave addr 0!
2464
Dirk Eibachb9577432014-07-03 09:28:18 +02002465 - drivers/i2c/ihs_i2c.c
2466 - activate this driver with CONFIG_SYS_I2C_IHS
2467 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2468 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2469 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2470 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2471 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2472 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2473 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2474 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2475 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2476 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2477 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2478 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2479
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002480 additional defines:
2481
2482 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002483 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002484 don't use/have i2c muxes on your i2c bus, this
2485 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2486 omit this define.
2487
2488 CONFIG_SYS_I2C_DIRECT_BUS
2489 define this, if you don't use i2c muxes on your hardware.
2490 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2491 omit this define.
2492
2493 CONFIG_SYS_I2C_MAX_HOPS
2494 define how many muxes are maximal consecutively connected
2495 on one i2c bus. If you not use i2c muxes, omit this
2496 define.
2497
2498 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002499 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002500 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2501 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2502 CONFIG_SYS_NUM_I2C_BUSES = 9:
2503
2504 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2505 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2506 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2507 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2508 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2509 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2510 {1, {I2C_NULL_HOP}}, \
2511 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2512 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2513 }
2514
2515 which defines
2516 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002517 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2518 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2519 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2520 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2521 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002522 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002523 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2524 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002525
2526 If you do not have i2c muxes on your board, omit this define.
2527
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002528- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002529
2530 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2531 provides the following compelling advantages:
2532
2533 - more than one i2c adapter is usable
2534 - approved multibus support
2535 - better i2c mux support
2536
2537 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002538
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002539 These enable legacy I2C serial bus commands. Defining
2540 CONFIG_HARD_I2C will include the appropriate I2C driver
2541 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002542
wdenk21136db2003-07-16 21:53:01 +00002543 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002544 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002545 CONFIG_COMMANDS) and communicate with i2c based realtime
2546 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002547 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002548
Ben Warren45657152006-09-07 16:50:54 -04002549 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002550
wdenk21136db2003-07-16 21:53:01 +00002551 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002552 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002554 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002555 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002556 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002557 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002558
Peter Tysere4d1abc2010-04-12 22:28:21 -05002559 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002560 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002561 and so its address should therefore be cleared to 0 (See,
2562 eg, MPC823e User's Manual p.16-473). So, set
2563 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002564
Eric Millbrandt12990a42009-09-03 08:09:44 -05002565 CONFIG_SYS_I2C_INIT_MPC5XXX
2566
2567 When a board is reset during an i2c bus transfer
2568 chips might think that the current transfer is still
2569 in progress. Reset the slave devices by sending start
2570 commands until the slave device responds.
2571
wdenk21136db2003-07-16 21:53:01 +00002572 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002573
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002574 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002575 then the following macros need to be defined (examples are
2576 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002577
2578 I2C_INIT
2579
wdenkb9bbd242003-06-30 16:24:52 +00002580 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002581 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk544e9732004-02-06 23:19:44 +00002583 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002584
wdenkc6097192002-11-03 00:24:07 +00002585 I2C_PORT
2586
wdenk4a5c8a72003-03-06 00:02:04 +00002587 (Only for MPC8260 CPU). The I/O port to use (the code
2588 assumes both bits are on the same port). Valid values
2589 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002590
2591 I2C_ACTIVE
2592
2593 The code necessary to make the I2C data line active
2594 (driven). If the data line is open collector, this
2595 define can be null.
2596
wdenkb9bbd242003-06-30 16:24:52 +00002597 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2598
wdenkc6097192002-11-03 00:24:07 +00002599 I2C_TRISTATE
2600
2601 The code necessary to make the I2C data line tri-stated
2602 (inactive). If the data line is open collector, this
2603 define can be null.
2604
wdenkb9bbd242003-06-30 16:24:52 +00002605 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2606
wdenkc6097192002-11-03 00:24:07 +00002607 I2C_READ
2608
York Sun4a598092013-04-01 11:29:11 -07002609 Code that returns true if the I2C data line is high,
2610 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002611
wdenkb9bbd242003-06-30 16:24:52 +00002612 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2613
wdenkc6097192002-11-03 00:24:07 +00002614 I2C_SDA(bit)
2615
York Sun4a598092013-04-01 11:29:11 -07002616 If <bit> is true, sets the I2C data line high. If it
2617 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002618
wdenkb9bbd242003-06-30 16:24:52 +00002619 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002620 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002621 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002622
wdenkc6097192002-11-03 00:24:07 +00002623 I2C_SCL(bit)
2624
York Sun4a598092013-04-01 11:29:11 -07002625 If <bit> is true, sets the I2C clock line high. If it
2626 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002627
wdenkb9bbd242003-06-30 16:24:52 +00002628 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002629 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002630 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002631
wdenkc6097192002-11-03 00:24:07 +00002632 I2C_DELAY
2633
2634 This delay is invoked four times per clock cycle so this
2635 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002636 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002637 like:
2638
wdenkb9bbd242003-06-30 16:24:52 +00002639 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002640
Mike Frysingeree12d542010-07-21 13:38:02 -04002641 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2642
2643 If your arch supports the generic GPIO framework (asm/gpio.h),
2644 then you may alternatively define the two GPIOs that are to be
2645 used as SCL / SDA. Any of the previous I2C_xxx macros will
2646 have GPIO-based defaults assigned to them as appropriate.
2647
2648 You should define these to the GPIO value as given directly to
2649 the generic GPIO functions.
2650
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002651 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002652
wdenk57b2d802003-06-27 21:31:46 +00002653 When a board is reset during an i2c bus transfer
2654 chips might think that the current transfer is still
2655 in progress. On some boards it is possible to access
2656 the i2c SCLK line directly, either by using the
2657 processor pin as a GPIO or by having a second pin
2658 connected to the bus. If this option is defined a
2659 custom i2c_init_board() routine in boards/xxx/board.c
2660 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002661
Richard Retanubundf0149c2010-04-12 15:08:17 -04002662 CONFIG_SYS_I2C_BOARD_LATE_INIT
2663
2664 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2665 defined a custom i2c_board_late_init() routine in
2666 boards/xxx/board.c is run AFTER the operations in i2c_init()
2667 is completed. This callpoint can be used to unreset i2c bus
2668 using CPU i2c controller register accesses for CPUs whose i2c
2669 controller provide such a method. It is called at the end of
2670 i2c_init() to allow i2c_init operations to setup the i2c bus
2671 controller on the CPU (e.g. setting bus speed & slave address).
2672
wdenk0e2bd9c2004-06-06 21:51:03 +00002673 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2674
2675 This option enables configuration of bi_iic_fast[] flags
2676 in u-boot bd_info structure based on u-boot environment
2677 variable "i2cfast". (see also i2cfast)
2678
Ben Warren45657152006-09-07 16:50:54 -04002679 CONFIG_I2C_MULTI_BUS
2680
2681 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002682 must have a controller. At any point in time, only one bus is
2683 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002684 Note that bus numbering is zero-based.
2685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002686 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002687
2688 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002689 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002690 is set, specify a list of bus-device pairs. Otherwise, specify
2691 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002692
2693 e.g.
2694 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002695 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002696
2697 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2698
Wolfgang Denk092ae952011-10-26 10:21:21 +00002699 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002700 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002701
2702 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002704 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002705
2706 If defined, then this indicates the I2C bus number for DDR SPD.
2707 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002709 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002710
2711 If defined, then this indicates the I2C bus number for the RTC.
2712 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002714 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002715
2716 If defined, then this indicates the I2C bus number for the DTT.
2717 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002719 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002720
2721 If defined, specifies the I2C address of the DTT device.
2722 If not defined, then U-Boot uses predefined value for
2723 specified DTT device.
2724
Andrew Dyer58c41f92008-12-29 17:36:01 -06002725 CONFIG_SOFT_I2C_READ_REPEATED_START
2726
2727 defining this will force the i2c_read() function in
2728 the soft_i2c driver to perform an I2C repeated start
2729 between writing the address pointer and reading the
2730 data. If this define is omitted the default behaviour
2731 of doing a stop-start sequence will be used. Most I2C
2732 devices can use either method, but some require one or
2733 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002734
wdenkc6097192002-11-03 00:24:07 +00002735- SPI Support: CONFIG_SPI
2736
2737 Enables SPI driver (so far only tested with
2738 SPI EEPROM, also an instance works with Crystal A/D and
2739 D/As on the SACSng board)
2740
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002741 CONFIG_SH_SPI
2742
2743 Enables the driver for SPI controller on SuperH. Currently
2744 only SH7757 is supported.
2745
wdenkc6097192002-11-03 00:24:07 +00002746 CONFIG_SPI_X
2747
2748 Enables extended (16-bit) SPI EEPROM addressing.
2749 (symmetrical to CONFIG_I2C_X)
2750
2751 CONFIG_SOFT_SPI
2752
wdenk4a5c8a72003-03-06 00:02:04 +00002753 Enables a software (bit-bang) SPI driver rather than
2754 using hardware support. This is a general purpose
2755 driver that only requires three general I/O port pins
2756 (two outputs, one input) to function. If this is
2757 defined, the board configuration must define several
2758 SPI configuration items (port pins to use, etc). For
2759 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002760
Ben Warren7efe9272008-01-16 22:37:35 -05002761 CONFIG_HARD_SPI
2762
2763 Enables a hardware SPI driver for general-purpose reads
2764 and writes. As with CONFIG_SOFT_SPI, the board configuration
2765 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002766 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002767 example, see include/configs/mpc8349emds.h.
2768
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002769 CONFIG_MXC_SPI
2770
2771 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002772 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002773
Heiko Schocherb77c8882014-07-14 10:22:11 +02002774 CONFIG_SYS_SPI_MXC_WAIT
2775 Timeout for waiting until spi transfer completed.
2776 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2777
Matthias Fuchsa4400872007-12-27 17:12:34 +01002778- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002779
Matthias Fuchsa4400872007-12-27 17:12:34 +01002780 Enables FPGA subsystem.
2781
2782 CONFIG_FPGA_<vendor>
2783
2784 Enables support for specific chip vendors.
2785 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002786
Matthias Fuchsa4400872007-12-27 17:12:34 +01002787 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002788
Matthias Fuchsa4400872007-12-27 17:12:34 +01002789 Enables support for FPGA family.
2790 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2791
2792 CONFIG_FPGA_COUNT
2793
2794 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002795
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302796 CONFIG_CMD_FPGA_LOADMK
2797
2798 Enable support for fpga loadmk command
2799
Michal Simek64c70982014-05-02 13:43:39 +02002800 CONFIG_CMD_FPGA_LOADP
2801
2802 Enable support for fpga loadp command - load partial bitstream
2803
2804 CONFIG_CMD_FPGA_LOADBP
2805
2806 Enable support for fpga loadbp command - load partial bitstream
2807 (Xilinx only)
2808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002809 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk57b2d802003-06-27 21:31:46 +00002811 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002813 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk4a5c8a72003-03-06 00:02:04 +00002815 Enable checks on FPGA configuration interface busy
2816 status by the configuration function. This option
2817 will require a board or device specific function to
2818 be written.
wdenkc6097192002-11-03 00:24:07 +00002819
2820 CONFIG_FPGA_DELAY
2821
2822 If defined, a function that provides delays in the FPGA
2823 configuration driver.
2824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002826 Allow Control-C to interrupt FPGA configuration
2827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002828 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk4a5c8a72003-03-06 00:02:04 +00002830 Check for configuration errors during FPGA bitfile
2831 loading. For example, abort during Virtex II
2832 configuration if the INIT_B line goes low (which
2833 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002835 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002836
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002837 Maximum time to wait for the INIT_B line to de-assert
2838 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002839 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002840 ms.
wdenkc6097192002-11-03 00:24:07 +00002841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002842 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002843
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002844 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002845 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002847 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002848
wdenk4a5c8a72003-03-06 00:02:04 +00002849 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002850 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002851
2852- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002853 CONFIG_BUILD_TARGET
2854
2855 Some SoCs need special image types (e.g. U-Boot binary
2856 with a special header) as build targets. By defining
2857 CONFIG_BUILD_TARGET in the SoC / board header, this
2858 special image will be automatically built upon calling
2859 make / MAKEALL.
2860
wdenkc6097192002-11-03 00:24:07 +00002861 CONFIG_IDENT_STRING
2862
wdenk4a5c8a72003-03-06 00:02:04 +00002863 If defined, this string will be added to the U-Boot
2864 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002865
2866- Vendor Parameter Protection:
2867
wdenk4a5c8a72003-03-06 00:02:04 +00002868 U-Boot considers the values of the environment
2869 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002870 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002871 are set once by the board vendor / manufacturer, and
2872 protects these variables from casual modification by
2873 the user. Once set, these variables are read-only,
2874 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002875 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002876
2877 If CONFIG_ENV_OVERWRITE is #defined in your config
2878 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002879 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002880 these parameters.
2881
2882 Alternatively, if you #define _both_ CONFIG_ETHADDR
2883 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002884 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002885 which can be changed exactly ONCE by the user. [The
2886 serial# is unaffected by this, i. e. it remains
2887 read-only.]
2888
Joe Hershberger71497d02012-12-11 22:16:31 -06002889 The same can be accomplished in a more flexible way
2890 for any variable by configuring the type of access
2891 to allow for those variables in the ".flags" variable
2892 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2893
wdenkc6097192002-11-03 00:24:07 +00002894- Protected RAM:
2895 CONFIG_PRAM
2896
2897 Define this variable to enable the reservation of
2898 "protected RAM", i. e. RAM which is not overwritten
2899 by U-Boot. Define CONFIG_PRAM to hold the number of
2900 kB you want to reserve for pRAM. You can overwrite
2901 this default value by defining an environment
2902 variable "pram" to the number of kB you want to
2903 reserve. Note that the board info structure will
2904 still show the full amount of RAM. If pRAM is
2905 reserved, a new environment variable "mem" will
2906 automatically be defined to hold the amount of
2907 remaining RAM in a form that can be passed as boot
2908 argument to Linux, for instance like that:
2909
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002910 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002911 saveenv
2912
2913 This way you can tell Linux not to use this memory,
2914 either, which results in a memory region that will
2915 not be affected by reboots.
2916
2917 *WARNING* If your board configuration uses automatic
2918 detection of the RAM size, you must make sure that
2919 this memory test is non-destructive. So far, the
2920 following board configurations are known to be
2921 "pRAM-clean":
2922
Wolfgang Denk90326762012-10-24 02:36:15 +00002923 IVMS8, IVML24, SPD8xx, TQM8xxL,
2924 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002925 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002926
Gabe Blacka2f3a932012-12-02 04:55:18 +00002927- Access to physical memory region (> 4GB)
2928 Some basic support is provided for operations on memory not
2929 normally accessible to U-Boot - e.g. some architectures
2930 support access to more than 4GB of memory on 32-bit
2931 machines using physical address extension or similar.
2932 Define CONFIG_PHYSMEM to access this basic support, which
2933 currently only supports clearing the memory.
2934
wdenkc6097192002-11-03 00:24:07 +00002935- Error Recovery:
2936 CONFIG_PANIC_HANG
2937
2938 Define this variable to stop the system in case of a
2939 fatal error, so that you have to reset it manually.
2940 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002941 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002942 automatically as fast as possible, but it may be
2943 useful during development since you can try to debug
2944 the conditions that lead to the situation.
2945
2946 CONFIG_NET_RETRY_COUNT
2947
wdenk4a5c8a72003-03-06 00:02:04 +00002948 This variable defines the number of retries for
2949 network operations like ARP, RARP, TFTP, or BOOTP
2950 before giving up the operation. If not defined, a
2951 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002952
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002953 CONFIG_ARP_TIMEOUT
2954
2955 Timeout waiting for an ARP reply in milliseconds.
2956
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002957 CONFIG_NFS_TIMEOUT
2958
2959 Timeout in milliseconds used in NFS protocol.
2960 If you encounter "ERROR: Cannot umount" in nfs command,
2961 try longer timeout such as
2962 #define CONFIG_NFS_TIMEOUT 10000UL
2963
wdenkc6097192002-11-03 00:24:07 +00002964- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002965 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002966
2967 Enable auto completion of commands using TAB.
2968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002969 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002970
2971 This defines the secondary prompt string, which is
2972 printed when the command interpreter needs more input
2973 to complete a command. Usually "> ".
2974
2975 Note:
2976
wdenk57b2d802003-06-27 21:31:46 +00002977 In the current implementation, the local variables
2978 space and global environment variables space are
2979 separated. Local variables are those you define by
2980 simply typing `name=value'. To access a local
2981 variable later on, you have write `$name' or
2982 `${name}'; to execute the contents of a variable
2983 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk4a5c8a72003-03-06 00:02:04 +00002985 Global environment variables are those you use
2986 setenv/printenv to work with. To run a command stored
2987 in such a variable, you need to use the run command,
2988 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002989
2990 To store commands and special characters in a
2991 variable, please use double quotation marks
2992 surrounding the whole text of the variable, instead
2993 of the backslashes before semicolons and special
2994 symbols.
2995
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002996- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002997 CONFIG_CMDLINE_EDITING
2998
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002999 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003000 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02003001
wdenkc0aa5c52003-12-06 19:49:23 +00003002- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003003 CONFIG_EXTRA_ENV_SETTINGS
3004
wdenk4a5c8a72003-03-06 00:02:04 +00003005 Define this to contain any number of null terminated
3006 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00003007 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00003008
wdenk4a5c8a72003-03-06 00:02:04 +00003009 For example, place something like this in your
3010 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003011
3012 #define CONFIG_EXTRA_ENV_SETTINGS \
3013 "myvar1=value1\0" \
3014 "myvar2=value2\0"
3015
wdenk4a5c8a72003-03-06 00:02:04 +00003016 Warning: This method is based on knowledge about the
3017 internal format how the environment is stored by the
3018 U-Boot code. This is NOT an official, exported
3019 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003020 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003021 You better know what you are doing here.
3022
wdenk4a5c8a72003-03-06 00:02:04 +00003023 Note: overly (ab)use of the default environment is
3024 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003025 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003026 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003027
Stephen Warren1465d5f2012-05-22 09:21:54 +00003028 CONFIG_ENV_VARS_UBOOT_CONFIG
3029
3030 Define this in order to add variables describing the
3031 U-Boot build configuration to the default environment.
3032 These will be named arch, cpu, board, vendor, and soc.
3033
3034 Enabling this option will cause the following to be defined:
3035
3036 - CONFIG_SYS_ARCH
3037 - CONFIG_SYS_CPU
3038 - CONFIG_SYS_BOARD
3039 - CONFIG_SYS_VENDOR
3040 - CONFIG_SYS_SOC
3041
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003042 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3043
3044 Define this in order to add variables describing certain
3045 run-time determined information about the hardware to the
3046 environment. These will be named board_name, board_rev.
3047
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003048 CONFIG_DELAY_ENVIRONMENT
3049
3050 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003051 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003052 that so that the environment is not available until
3053 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3054 this is instead controlled by the value of
3055 /config/load-environment.
3056
wdenkc0aa5c52003-12-06 19:49:23 +00003057- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003058 CONFIG_HAS_DATAFLASH
3059
wdenk57b2d802003-06-27 21:31:46 +00003060 Defining this option enables DataFlash features and
3061 allows to read/write in Dataflash via the standard
3062 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003063
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003064- Serial Flash support
3065 CONFIG_CMD_SF
3066
3067 Defining this option enables SPI flash commands
3068 'sf probe/read/write/erase/update'.
3069
3070 Usage requires an initial 'probe' to define the serial
3071 flash parameters, followed by read/write/erase/update
3072 commands.
3073
3074 The following defaults may be provided by the platform
3075 to handle the common case when only a single serial
3076 flash is present on the system.
3077
3078 CONFIG_SF_DEFAULT_BUS Bus identifier
3079 CONFIG_SF_DEFAULT_CS Chip-select
3080 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3081 CONFIG_SF_DEFAULT_SPEED in Hz
3082
Simon Glass4b5545e2012-10-08 13:16:02 +00003083 CONFIG_CMD_SF_TEST
3084
3085 Define this option to include a destructive SPI flash
3086 test ('sf test').
3087
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303088 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3089
3090 Define this option to use the Bank addr/Extended addr
3091 support on SPI flashes which has size > 16Mbytes.
3092
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303093 CONFIG_SF_DUAL_FLASH Dual flash memories
3094
3095 Define this option to use dual flash support where two flash
3096 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003097 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303098
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02003099 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3100 enable the W#/Vpp signal to disable writing to the status
3101 register on ST MICRON flashes like the N25Q128.
3102 The status register write enable/disable bit, combined with
3103 the W#/VPP signal provides hardware data protection for the
3104 device as follows: When the enable/disable bit is set to 1,
3105 and the W#/VPP signal is driven LOW, the status register
3106 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3107 operation will not execute. The only way to exit this
3108 hardware-protected mode is to drive W#/VPP HIGH.
3109
wdenkef893942004-02-23 16:11:30 +00003110- SystemACE Support:
3111 CONFIG_SYSTEMACE
3112
3113 Adding this option adds support for Xilinx SystemACE
3114 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003115 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003117
3118 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003119 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003120
3121 When SystemACE support is added, the "ace" device type
3122 becomes available to the fat commands, i.e. fatls.
3123
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003124- TFTP Fixed UDP Port:
3125 CONFIG_TFTP_PORT
3126
Wolfgang Denk227b5192005-09-24 23:25:46 +02003127 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003128 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003129 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003130 number generator is used.
3131
Wolfgang Denk227b5192005-09-24 23:25:46 +02003132 Also, the environment variable tftpdstp is used to supply
3133 the TFTP UDP destination port value. If tftpdstp isn't
3134 defined, the normal port 69 is used.
3135
3136 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003137 blindly start the TFTP transfer using the pre-configured
3138 target IP address and UDP port. This has the effect of
3139 "punching through" the (Windows XP) firewall, allowing
3140 the remainder of the TFTP transfer to proceed normally.
3141 A better solution is to properly configure the firewall,
3142 but sometimes that is not allowed.
3143
Simon Glass058bb8d2012-12-05 14:46:38 +00003144- Hashing support:
3145 CONFIG_CMD_HASH
3146
3147 This enables a generic 'hash' command which can produce
3148 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3149
3150 CONFIG_HASH_VERIFY
3151
3152 Enable the hash verify command (hash -v). This adds to code
3153 size a little.
3154
gaurav ranaef201592015-02-20 12:51:46 +05303155 CONFIG_SHA1 - This option enables support of hashing using SHA1
3156 algorithm. The hash is calculated in software.
3157 CONFIG_SHA256 - This option enables support of hashing using
3158 SHA256 algorithm. The hash is calculated in software.
3159 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3160 for SHA1/SHA256 hashing.
3161 This affects the 'hash' command and also the
3162 hash_lookup_algo() function.
3163 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3164 hardware-acceleration for SHA1/SHA256 progressive hashing.
3165 Data can be streamed in a block at a time and the hashing
3166 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003167
3168 Note: There is also a sha1sum command, which should perhaps
3169 be deprecated in favour of 'hash sha1'.
3170
Robert Winkler765ccf42013-07-24 17:57:06 -07003171- Freescale i.MX specific commands:
3172 CONFIG_CMD_HDMIDETECT
3173 This enables 'hdmidet' command which returns true if an
3174 HDMI monitor is detected. This command is i.MX 6 specific.
3175
3176 CONFIG_CMD_BMODE
3177 This enables the 'bmode' (bootmode) command for forcing
3178 a boot from specific media.
3179
3180 This is useful for forcing the ROM's usb downloader to
3181 activate upon a watchdog reset which is nice when iterating
3182 on U-Boot. Using the reset button or running bmode normal
3183 will set it back to normal. This command currently
3184 supports i.MX53 and i.MX6.
3185
Simon Glass35191a32013-06-13 15:10:02 -07003186- Signing support:
3187 CONFIG_RSA
3188
3189 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003190 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003191
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303192 The Modular Exponentiation algorithm in RSA is implemented using
3193 driver model. So CONFIG_DM needs to be enabled by default for this
3194 library to function.
3195
Simon Glass35191a32013-06-13 15:10:02 -07003196 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303197 option. The software based modular exponentiation is built into
3198 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003199
Heiko Schocher443ca402014-01-25 07:27:13 +01003200- bootcount support:
3201 CONFIG_BOOTCOUNT_LIMIT
3202
3203 This enables the bootcounter support, see:
3204 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3205
3206 CONFIG_AT91SAM9XE
3207 enable special bootcounter support on at91sam9xe based boards.
3208 CONFIG_BLACKFIN
3209 enable special bootcounter support on blackfin based boards.
3210 CONFIG_SOC_DA8XX
3211 enable special bootcounter support on da850 based boards.
3212 CONFIG_BOOTCOUNT_RAM
3213 enable support for the bootcounter in RAM
3214 CONFIG_BOOTCOUNT_I2C
3215 enable support for the bootcounter on an i2c (like RTC) device.
3216 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3217 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3218 the bootcounter.
3219 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003220
wdenkc0aa5c52003-12-06 19:49:23 +00003221- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003222 CONFIG_SHOW_BOOT_PROGRESS
3223
wdenk4a5c8a72003-03-06 00:02:04 +00003224 Defining this option allows to add some board-
3225 specific code (calling a user-provided function
3226 "show_boot_progress(int)") that enables you to show
3227 the system's boot progress on some display (for
3228 example, some LED's) on your board. At the moment,
3229 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003230
Simon Glass31a870e2012-02-13 13:51:19 +00003231- Detailed boot stage timing
3232 CONFIG_BOOTSTAGE
3233 Define this option to get detailed timing of each stage
3234 of the boot process.
3235
3236 CONFIG_BOOTSTAGE_USER_COUNT
3237 This is the number of available user bootstage records.
3238 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3239 a new ID will be allocated from this stash. If you exceed
3240 the limit, recording will stop.
3241
3242 CONFIG_BOOTSTAGE_REPORT
3243 Define this to print a report before boot, similar to this:
3244
3245 Timer summary in microseconds:
3246 Mark Elapsed Stage
3247 0 0 reset
3248 3,575,678 3,575,678 board_init_f start
3249 3,575,695 17 arch_cpu_init A9
3250 3,575,777 82 arch_cpu_init done
3251 3,659,598 83,821 board_init_r start
3252 3,910,375 250,777 main_loop
3253 29,916,167 26,005,792 bootm_start
3254 30,361,327 445,160 start_kernel
3255
Simon Glass4afd88e2012-09-28 08:56:39 +00003256 CONFIG_CMD_BOOTSTAGE
3257 Add a 'bootstage' command which supports printing a report
3258 and un/stashing of bootstage data.
3259
Simon Glass0fa36a42012-09-28 08:56:37 +00003260 CONFIG_BOOTSTAGE_FDT
3261 Stash the bootstage information in the FDT. A root 'bootstage'
3262 node is created with each bootstage id as a child. Each child
3263 has a 'name' property and either 'mark' containing the
3264 mark time in microsecond, or 'accum' containing the
3265 accumulated time for that bootstage id in microseconds.
3266 For example:
3267
3268 bootstage {
3269 154 {
3270 name = "board_init_f";
3271 mark = <3575678>;
3272 };
3273 170 {
3274 name = "lcd";
3275 accum = <33482>;
3276 };
3277 };
3278
3279 Code in the Linux kernel can find this in /proc/devicetree.
3280
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003281Legacy uImage format:
3282
wdenkc6097192002-11-03 00:24:07 +00003283 Arg Where When
3284 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003285 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003286 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003287 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003288 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003289 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003290 4 common/cmd_bootm.c Image data has correct checksum
3291 -4 common/cmd_bootm.c Image is for unsupported architecture
3292 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003293 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003294 6 common/cmd_bootm.c Image Type check OK
3295 -6 common/cmd_bootm.c gunzip uncompression error
3296 -7 common/cmd_bootm.c Unimplemented compression type
3297 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003298 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003299 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003300
3301 9 common/image.c Start initial ramdisk verification
3302 -10 common/image.c Ramdisk header has bad magic number
3303 -11 common/image.c Ramdisk header has bad checksum
3304 10 common/image.c Ramdisk header is OK
3305 -12 common/image.c Ramdisk data has bad checksum
3306 11 common/image.c Ramdisk data has correct checksum
3307 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003308 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003309 13 common/image.c Start multifile image verification
3310 14 common/image.c No initial ramdisk, no multifile, continue.
3311
Wolfgang Denk092ae952011-10-26 10:21:21 +00003312 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003313
Stefan Roese88fbf932010-04-15 16:07:28 +02003314 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003315 -31 post/post.c POST test failed, detected by post_output_backlog()
3316 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003317
Heiko Schocher633e03a2007-06-22 19:11:54 +02003318 34 common/cmd_doc.c before loading a Image from a DOC device
3319 -35 common/cmd_doc.c Bad usage of "doc" command
3320 35 common/cmd_doc.c correct usage of "doc" command
3321 -36 common/cmd_doc.c No boot device
3322 36 common/cmd_doc.c correct boot device
3323 -37 common/cmd_doc.c Unknown Chip ID on boot device
3324 37 common/cmd_doc.c correct chip ID found, device available
3325 -38 common/cmd_doc.c Read Error on boot device
3326 38 common/cmd_doc.c reading Image header from DOC device OK
3327 -39 common/cmd_doc.c Image header has bad magic number
3328 39 common/cmd_doc.c Image header has correct magic number
3329 -40 common/cmd_doc.c Error reading Image from DOC device
3330 40 common/cmd_doc.c Image header has correct magic number
3331 41 common/cmd_ide.c before loading a Image from a IDE device
3332 -42 common/cmd_ide.c Bad usage of "ide" command
3333 42 common/cmd_ide.c correct usage of "ide" command
3334 -43 common/cmd_ide.c No boot device
3335 43 common/cmd_ide.c boot device found
3336 -44 common/cmd_ide.c Device not available
3337 44 common/cmd_ide.c Device available
3338 -45 common/cmd_ide.c wrong partition selected
3339 45 common/cmd_ide.c partition selected
3340 -46 common/cmd_ide.c Unknown partition table
3341 46 common/cmd_ide.c valid partition table found
3342 -47 common/cmd_ide.c Invalid partition type
3343 47 common/cmd_ide.c correct partition type
3344 -48 common/cmd_ide.c Error reading Image Header on boot device
3345 48 common/cmd_ide.c reading Image Header from IDE device OK
3346 -49 common/cmd_ide.c Image header has bad magic number
3347 49 common/cmd_ide.c Image header has correct magic number
3348 -50 common/cmd_ide.c Image header has bad checksum
3349 50 common/cmd_ide.c Image header has correct checksum
3350 -51 common/cmd_ide.c Error reading Image from IDE device
3351 51 common/cmd_ide.c reading Image from IDE device OK
3352 52 common/cmd_nand.c before loading a Image from a NAND device
3353 -53 common/cmd_nand.c Bad usage of "nand" command
3354 53 common/cmd_nand.c correct usage of "nand" command
3355 -54 common/cmd_nand.c No boot device
3356 54 common/cmd_nand.c boot device found
3357 -55 common/cmd_nand.c Unknown Chip ID on boot device
3358 55 common/cmd_nand.c correct chip ID found, device available
3359 -56 common/cmd_nand.c Error reading Image Header on boot device
3360 56 common/cmd_nand.c reading Image Header from NAND device OK
3361 -57 common/cmd_nand.c Image header has bad magic number
3362 57 common/cmd_nand.c Image header has correct magic number
3363 -58 common/cmd_nand.c Error reading Image from NAND device
3364 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003365
Heiko Schocher633e03a2007-06-22 19:11:54 +02003366 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003367
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003368 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003369 -64 net/eth.c no Ethernet found.
3370 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003371
Heiko Schocher633e03a2007-06-22 19:11:54 +02003372 -80 common/cmd_net.c usage wrong
3373 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003374 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003375 81 common/cmd_net.c NetLoop() back without error
3376 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3377 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003378 83 common/cmd_net.c running "source" command
3379 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003380 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003381
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003382FIT uImage format:
3383
3384 Arg Where When
3385 100 common/cmd_bootm.c Kernel FIT Image has correct format
3386 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3387 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3388 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3389 102 common/cmd_bootm.c Kernel unit name specified
3390 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003391 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003392 104 common/cmd_bootm.c Got kernel subimage node offset
3393 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3394 105 common/cmd_bootm.c Kernel subimage hash verification OK
3395 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3396 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003397 -106 common/cmd_bootm.c Kernel subimage has wrong type
3398 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003399 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3400 108 common/cmd_bootm.c Got kernel subimage data/size
3401 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3402 -109 common/cmd_bootm.c Can't get kernel subimage type
3403 -110 common/cmd_bootm.c Can't get kernel subimage comp
3404 -111 common/cmd_bootm.c Can't get kernel subimage os
3405 -112 common/cmd_bootm.c Can't get kernel subimage load address
3406 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3407
3408 120 common/image.c Start initial ramdisk verification
3409 -120 common/image.c Ramdisk FIT image has incorrect format
3410 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003411 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003412 -122 common/image.c Can't get configuration for ramdisk subimage
3413 123 common/image.c Ramdisk unit name specified
3414 -124 common/image.c Can't get ramdisk subimage node offset
3415 125 common/image.c Got ramdisk subimage node offset
3416 -125 common/image.c Ramdisk subimage hash verification failed
3417 126 common/image.c Ramdisk subimage hash verification OK
3418 -126 common/image.c Ramdisk subimage for unsupported architecture
3419 127 common/image.c Architecture check OK
3420 -127 common/image.c Can't get ramdisk subimage data/size
3421 128 common/image.c Got ramdisk subimage data/size
3422 129 common/image.c Can't get ramdisk load address
3423 -129 common/image.c Got ramdisk load address
3424
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003425 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003426 131 common/cmd_doc.c FIT image format OK
3427
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003428 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003429 141 common/cmd_ide.c FIT image format OK
3430
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003431 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003432 151 common/cmd_nand.c FIT image format OK
3433
Heiko Schocher515eb122014-05-28 11:33:33 +02003434- legacy image format:
3435 CONFIG_IMAGE_FORMAT_LEGACY
3436 enables the legacy image format support in U-Boot.
3437
3438 Default:
3439 enabled if CONFIG_FIT_SIGNATURE is not defined.
3440
3441 CONFIG_DISABLE_IMAGE_LEGACY
3442 disable the legacy image format
3443
3444 This define is introduced, as the legacy image format is
3445 enabled per default for backward compatibility.
3446
Gabe Blackd572e162012-10-25 16:31:10 +00003447- FIT image support:
3448 CONFIG_FIT
3449 Enable support for the FIT uImage format.
3450
3451 CONFIG_FIT_BEST_MATCH
3452 When no configuration is explicitly selected, default to the
3453 one whose fdt's compatibility field best matches that of
3454 U-Boot itself. A match is considered "best" if it matches the
3455 most specific compatibility entry of U-Boot's fdt's root node.
3456 The order of entries in the configuration's fdt is ignored.
3457
Simon Glass58fe7e52013-06-13 15:10:00 -07003458 CONFIG_FIT_SIGNATURE
3459 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303460 using a hash signed and verified using RSA. If
3461 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3462 hashing is available using hardware, RSA library will use it.
3463 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003464
Heiko Schocher515eb122014-05-28 11:33:33 +02003465 WARNING: When relying on signed FIT images with required
3466 signature check the legacy image format is default
3467 disabled. If a board need legacy image format support
3468 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3469
Dirk Eibach88919ca2014-07-03 09:28:26 +02003470 CONFIG_FIT_DISABLE_SHA256
3471 Supporting SHA256 hashes has quite an impact on binary size.
3472 For constrained systems sha256 hash support can be disabled
3473 with this option.
3474
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003475- Standalone program support:
3476 CONFIG_STANDALONE_LOAD_ADDR
3477
Wolfgang Denk23f78482011-10-09 21:06:34 +02003478 This option defines a board specific value for the
3479 address where standalone program gets loaded, thus
3480 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003481 settings.
3482
3483- Frame Buffer Address:
3484 CONFIG_FB_ADDR
3485
3486 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003487 address for frame buffer. This is typically the case
3488 when using a graphics controller has separate video
3489 memory. U-Boot will then place the frame buffer at
3490 the given address instead of dynamically reserving it
3491 in system RAM by calling lcd_setmem(), which grabs
3492 the memory for the frame buffer depending on the
3493 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003494
3495 Please see board_init_f function.
3496
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003497- Automatic software updates via TFTP server
3498 CONFIG_UPDATE_TFTP
3499 CONFIG_UPDATE_TFTP_CNT_MAX
3500 CONFIG_UPDATE_TFTP_MSEC_MAX
3501
3502 These options enable and control the auto-update feature;
3503 for a more detailed description refer to doc/README.update.
3504
3505- MTD Support (mtdparts command, UBI support)
3506 CONFIG_MTD_DEVICE
3507
3508 Adds the MTD device infrastructure from the Linux kernel.
3509 Needed for mtdparts command support.
3510
3511 CONFIG_MTD_PARTITIONS
3512
3513 Adds the MTD partitioning infrastructure from the Linux
3514 kernel. Needed for UBI support.
3515
Heiko Schocherf5895d12014-06-24 10:10:04 +02003516 CONFIG_MTD_NAND_VERIFY_WRITE
3517 verify if the written data is correct reread.
3518
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003519- UBI support
3520 CONFIG_CMD_UBI
3521
3522 Adds commands for interacting with MTD partitions formatted
3523 with the UBI flash translation layer
3524
3525 Requires also defining CONFIG_RBTREE
3526
Joe Hershberger47550fc2013-04-08 10:32:49 +00003527 CONFIG_UBI_SILENCE_MSG
3528
3529 Make the verbose messages from UBI stop printing. This leaves
3530 warnings and errors enabled.
3531
Heiko Schocherf5895d12014-06-24 10:10:04 +02003532
3533 CONFIG_MTD_UBI_WL_THRESHOLD
3534 This parameter defines the maximum difference between the highest
3535 erase counter value and the lowest erase counter value of eraseblocks
3536 of UBI devices. When this threshold is exceeded, UBI starts performing
3537 wear leveling by means of moving data from eraseblock with low erase
3538 counter to eraseblocks with high erase counter.
3539
3540 The default value should be OK for SLC NAND flashes, NOR flashes and
3541 other flashes which have eraseblock life-cycle 100000 or more.
3542 However, in case of MLC NAND flashes which typically have eraseblock
3543 life-cycle less than 10000, the threshold should be lessened (e.g.,
3544 to 128 or 256, although it does not have to be power of 2).
3545
3546 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003547
Heiko Schocherf5895d12014-06-24 10:10:04 +02003548 CONFIG_MTD_UBI_BEB_LIMIT
3549 This option specifies the maximum bad physical eraseblocks UBI
3550 expects on the MTD device (per 1024 eraseblocks). If the
3551 underlying flash does not admit of bad eraseblocks (e.g. NOR
3552 flash), this value is ignored.
3553
3554 NAND datasheets often specify the minimum and maximum NVM
3555 (Number of Valid Blocks) for the flashes' endurance lifetime.
3556 The maximum expected bad eraseblocks per 1024 eraseblocks
3557 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3558 which gives 20 for most NANDs (MaxNVB is basically the total
3559 count of eraseblocks on the chip).
3560
3561 To put it differently, if this value is 20, UBI will try to
3562 reserve about 1.9% of physical eraseblocks for bad blocks
3563 handling. And that will be 1.9% of eraseblocks on the entire
3564 NAND chip, not just the MTD partition UBI attaches. This means
3565 that if you have, say, a NAND flash chip admits maximum 40 bad
3566 eraseblocks, and it is split on two MTD partitions of the same
3567 size, UBI will reserve 40 eraseblocks when attaching a
3568 partition.
3569
3570 default: 20
3571
3572 CONFIG_MTD_UBI_FASTMAP
3573 Fastmap is a mechanism which allows attaching an UBI device
3574 in nearly constant time. Instead of scanning the whole MTD device it
3575 only has to locate a checkpoint (called fastmap) on the device.
3576 The on-flash fastmap contains all information needed to attach
3577 the device. Using fastmap makes only sense on large devices where
3578 attaching by scanning takes long. UBI will not automatically install
3579 a fastmap on old images, but you can set the UBI parameter
3580 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3581 that fastmap-enabled images are still usable with UBI implementations
3582 without fastmap support. On typical flash devices the whole fastmap
3583 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3584
3585 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3586 Set this parameter to enable fastmap automatically on images
3587 without a fastmap.
3588 default: 0
3589
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003590- UBIFS support
3591 CONFIG_CMD_UBIFS
3592
3593 Adds commands for interacting with UBI volumes formatted as
3594 UBIFS. UBIFS is read-only in u-boot.
3595
3596 Requires UBI support as well as CONFIG_LZO
3597
Joe Hershberger47550fc2013-04-08 10:32:49 +00003598 CONFIG_UBIFS_SILENCE_MSG
3599
3600 Make the verbose messages from UBIFS stop printing. This leaves
3601 warnings and errors enabled.
3602
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003603- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003604 CONFIG_SPL
3605 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003606
Tom Rini36853852012-02-14 07:29:40 +00003607 CONFIG_SPL_LDSCRIPT
3608 LDSCRIPT for linking the SPL binary.
3609
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003610 CONFIG_SPL_MAX_FOOTPRINT
3611 Maximum size in memory allocated to the SPL, BSS included.
3612 When defined, the linker checks that the actual memory
3613 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003614 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003615 must not be both defined at the same time.
3616
Tom Rini36853852012-02-14 07:29:40 +00003617 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003618 Maximum size of the SPL image (text, data, rodata, and
3619 linker lists sections), BSS excluded.
3620 When defined, the linker checks that the actual size does
3621 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003622
Wolfgang Denk825223d2011-09-11 21:24:09 +02003623 CONFIG_SPL_TEXT_BASE
3624 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003625
Scott Woodc4f0d002012-09-20 19:05:12 -05003626 CONFIG_SPL_RELOC_TEXT_BASE
3627 Address to relocate to. If unspecified, this is equal to
3628 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3629
Tom Rini36853852012-02-14 07:29:40 +00003630 CONFIG_SPL_BSS_START_ADDR
3631 Link address for the BSS within the SPL binary.
3632
3633 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003634 Maximum size in memory allocated to the SPL BSS.
3635 When defined, the linker checks that the actual memory used
3636 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003637 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003638 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003639
3640 CONFIG_SPL_STACK
3641 Adress of the start of the stack SPL will use
3642
Scott Woodc4f0d002012-09-20 19:05:12 -05003643 CONFIG_SPL_RELOC_STACK
3644 Adress of the start of the stack SPL will use after
3645 relocation. If unspecified, this is equal to
3646 CONFIG_SPL_STACK.
3647
Tom Rini36853852012-02-14 07:29:40 +00003648 CONFIG_SYS_SPL_MALLOC_START
3649 Starting address of the malloc pool used in SPL.
3650
3651 CONFIG_SYS_SPL_MALLOC_SIZE
3652 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003653
Tom Rini28591df2012-08-13 12:03:19 -07003654 CONFIG_SPL_FRAMEWORK
3655 Enable the SPL framework under common/. This framework
3656 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3657 NAND loading of the Linux Kernel.
3658
Tom Rinic2b76002014-03-28 12:03:39 -04003659 CONFIG_SPL_OS_BOOT
3660 Enable booting directly to an OS from SPL.
3661 See also: doc/README.falcon
3662
Tom Rinife3b0c72012-08-13 11:37:56 -07003663 CONFIG_SPL_DISPLAY_PRINT
3664 For ARM, enable an optional function to print more information
3665 about the running system.
3666
Scott Wood7c810902012-09-20 16:35:21 -05003667 CONFIG_SPL_INIT_MINIMAL
3668 Arch init code should be built for a very small image
3669
Wolfgang Denk825223d2011-09-11 21:24:09 +02003670 CONFIG_SPL_LIBCOMMON_SUPPORT
3671 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003672
Wolfgang Denk825223d2011-09-11 21:24:09 +02003673 CONFIG_SPL_LIBDISK_SUPPORT
3674 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003675
Wolfgang Denk825223d2011-09-11 21:24:09 +02003676 CONFIG_SPL_I2C_SUPPORT
3677 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003678
Wolfgang Denk825223d2011-09-11 21:24:09 +02003679 CONFIG_SPL_GPIO_SUPPORT
3680 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003681
Wolfgang Denk825223d2011-09-11 21:24:09 +02003682 CONFIG_SPL_MMC_SUPPORT
3683 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003684
Tom Rini36853852012-02-14 07:29:40 +00003685 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3686 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003687 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003688 when the MMC is being used in raw mode.
3689
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003690 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3691 Partition on the MMC to load U-Boot from when the MMC is being
3692 used in raw mode
3693
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003694 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3695 Sector to load kernel uImage from when MMC is being
3696 used in raw mode (for Falcon mode)
3697
3698 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3699 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3700 Sector and number of sectors to load kernel argument
3701 parameters from when MMC is being used in raw mode
3702 (for falcon mode)
3703
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003704 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3705 Partition on the MMC to load U-Boot from when the MMC is being
3706 used in fs mode
3707
Tom Rini36853852012-02-14 07:29:40 +00003708 CONFIG_SPL_FAT_SUPPORT
3709 Support for fs/fat/libfat.o in SPL binary
3710
Guillaume GARDET5065b712014-10-15 17:53:13 +02003711 CONFIG_SPL_EXT_SUPPORT
3712 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003713
Guillaume GARDET5065b712014-10-15 17:53:13 +02003714 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3715 Filename to read to load U-Boot when reading from filesystem
3716
3717 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003718 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003719 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003720
Guillaume GARDET5065b712014-10-15 17:53:13 +02003721 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003722 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003723 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003724
Scott Wood2b36fbb2012-12-06 13:33:17 +00003725 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3726 Set this for NAND SPL on PPC mpc83xx targets, so that
3727 start.S waits for the rest of the SPL to load before
3728 continuing (the hardware starts execution after just
3729 loading the first page rather than the full 4K).
3730
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303731 CONFIG_SPL_SKIP_RELOCATE
3732 Avoid SPL relocation
3733
Scott Woodc352a0c2012-09-20 19:09:07 -05003734 CONFIG_SPL_NAND_BASE
3735 Include nand_base.c in the SPL. Requires
3736 CONFIG_SPL_NAND_DRIVERS.
3737
3738 CONFIG_SPL_NAND_DRIVERS
3739 SPL uses normal NAND drivers, not minimal drivers.
3740
3741 CONFIG_SPL_NAND_ECC
3742 Include standard software ECC in the SPL
3743
Tom Rini36853852012-02-14 07:29:40 +00003744 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003745 Support for NAND boot using simple NAND drivers that
3746 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003747
Tom Rini543c9f12014-03-28 12:03:36 -04003748 CONFIG_SPL_MTD_SUPPORT
3749 Support for the MTD subsystem within SPL. Useful for
3750 environment on NAND support within SPL.
3751
Heiko Schochercf000272014-10-31 08:31:00 +01003752 CONFIG_SPL_NAND_RAW_ONLY
3753 Support to boot only raw u-boot.bin images. Use this only
3754 if you need to save space.
3755
Ying Zhang9ff70262013-08-16 15:16:11 +08003756 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3757 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003758 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003759
Ying Zhangdfb2b152013-08-16 15:16:12 +08003760 CONFIG_SPL_COMMON_INIT_DDR
3761 Set for common ddr init with serial presence detect in
3762 SPL binary.
3763
Tom Rini36853852012-02-14 07:29:40 +00003764 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3765 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3766 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3767 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3768 CONFIG_SYS_NAND_ECCBYTES
3769 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003770 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003771
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303772 CONFIG_SPL_NAND_BOOT
3773 Add support NAND boot
3774
Tom Rini36853852012-02-14 07:29:40 +00003775 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003776 Location in NAND to read U-Boot from
3777
3778 CONFIG_SYS_NAND_U_BOOT_DST
3779 Location in memory to load U-Boot to
3780
3781 CONFIG_SYS_NAND_U_BOOT_SIZE
3782 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003783
3784 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003785 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003786
3787 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3788 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003789 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003790
3791 CONFIG_SPL_OMAP3_ID_NAND
3792 Support for an OMAP3-specific set of functions to return the
3793 ID and MFR of the first attached NAND chip, if present.
3794
Wolfgang Denk825223d2011-09-11 21:24:09 +02003795 CONFIG_SPL_SERIAL_SUPPORT
3796 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003797
Wolfgang Denk825223d2011-09-11 21:24:09 +02003798 CONFIG_SPL_SPI_FLASH_SUPPORT
3799 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003800
Wolfgang Denk825223d2011-09-11 21:24:09 +02003801 CONFIG_SPL_SPI_SUPPORT
3802 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003803
Pavel Machekde997252012-08-30 22:42:11 +02003804 CONFIG_SPL_RAM_DEVICE
3805 Support for running image already present in ram, in SPL binary
3806
Wolfgang Denk825223d2011-09-11 21:24:09 +02003807 CONFIG_SPL_LIBGENERIC_SUPPORT
3808 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003809
Ying Zhang602f7d32013-05-20 14:07:25 +08003810 CONFIG_SPL_ENV_SUPPORT
3811 Support for the environment operating in SPL binary
3812
3813 CONFIG_SPL_NET_SUPPORT
3814 Support for the net/libnet.o in SPL binary.
3815 It conflicts with SPL env from storage medium specified by
3816 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3817
Scott Woodeb7bd972012-12-06 13:33:16 +00003818 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003819 Image offset to which the SPL should be padded before appending
3820 the SPL payload. By default, this is defined as
3821 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3822 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3823 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003824
Scott Woodf147eb72012-09-21 16:27:32 -05003825 CONFIG_SPL_TARGET
3826 Final target image containing SPL and payload. Some SPLs
3827 use an arch-specific makefile fragment instead, for
3828 example if more than one image needs to be produced.
3829
Simon Glass82d94532013-05-08 08:05:59 +00003830 CONFIG_FIT_SPL_PRINT
3831 Printing information about a FIT image adds quite a bit of
3832 code to SPL. So this is normally disabled in SPL. Use this
3833 option to re-enable it. This will affect the output of the
3834 bootm command when booting a FIT image.
3835
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003836- TPL framework
3837 CONFIG_TPL
3838 Enable building of TPL globally.
3839
3840 CONFIG_TPL_PAD_TO
3841 Image offset to which the TPL should be padded before appending
3842 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003843 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3844 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3845 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003846
wdenkc6097192002-11-03 00:24:07 +00003847Modem Support:
3848--------------
3849
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003850[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003851
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003852- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003853 CONFIG_MODEM_SUPPORT
3854
3855- RTS/CTS Flow control enable:
3856 CONFIG_HWFLOW
3857
3858- Modem debug support:
3859 CONFIG_MODEM_SUPPORT_DEBUG
3860
wdenk4a5c8a72003-03-06 00:02:04 +00003861 Enables debugging stuff (char screen[1024], dbg())
3862 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003863
wdenkc0aa5c52003-12-06 19:49:23 +00003864- Interrupt support (PPC):
3865
wdenk1ebf41e2004-01-02 14:00:00 +00003866 There are common interrupt_init() and timer_interrupt()
3867 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003868 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003869 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003870 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003871 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003872 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003873 specific handling. If board has watchdog / status_led
3874 / other_activity_monitor it works automatically from
3875 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003876
wdenkc6097192002-11-03 00:24:07 +00003877- General:
3878
wdenk4a5c8a72003-03-06 00:02:04 +00003879 In the target system modem support is enabled when a
3880 specific key (key combination) is pressed during
3881 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003882 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003883 board_init(). Currently key_pressed() is a dummy
3884 function, returning 1 and thus enabling modem
3885 initialization.
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk4a5c8a72003-03-06 00:02:04 +00003887 If there are no modem init strings in the
3888 environment, U-Boot proceed to autoboot; the
3889 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003890 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003891
3892 See also: doc/README.Modem
3893
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003894Board initialization settings:
3895------------------------------
3896
3897During Initialization u-boot calls a number of board specific functions
3898to allow the preparation of board specific prerequisites, e.g. pin setup
3899before drivers are initialized. To enable these callbacks the
3900following configuration macros have to be defined. Currently this is
3901architecture specific, so please check arch/your_architecture/lib/board.c
3902typically in board_init_f() and board_init_r().
3903
3904- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3905- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3906- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3907- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003908
wdenkc6097192002-11-03 00:24:07 +00003909Configuration Settings:
3910-----------------------
3911
York Sun6c480012014-02-26 17:03:19 -08003912- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3913 Optionally it can be defined to support 64-bit memory commands.
3914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003916 undefine this when you're short of memory.
3917
Peter Tyserdfb72b82009-01-27 18:03:12 -06003918- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3919 width of the commands listed in the 'help' command output.
3920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003922 prompt for user input.
3923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003924- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003926- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003928- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003930- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003931 the application (usually a Linux kernel) when it is
3932 booted
3933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003934- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003935 List of legal baudrate settings for this board.
3936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003938 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003939
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003940- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003941 If the board specific function
3942 extern int overwrite_console (void);
3943 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003944 serial port, else the settings in the environment are used.
3945
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003946- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003947 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003948
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003949- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003950 Enable overwrite of previous console environment settings.
3951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003952- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003953 Begin and End addresses of the area used by the
3954 simple memory test.
3955
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003956- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003957 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003958
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003959- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003960 Scratch address used by the alternate memory test
3961 You only need to set this if address zero isn't writeable
3962
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003963- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3964 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003965 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003966 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003967 fixing up gd->ram_size the Linux kernel should gets passed
3968 the now "corrected" memory size and won't touch it either.
3969 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003970 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003971 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003972 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003973
3974 This option can be used as a workaround for the 440EPx/GRx
3975 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3976 be touched.
3977
3978 WARNING: Please make sure that this value is a multiple of
3979 the Linux page size (normally 4k). If this is not the case,
3980 then the end address of the Linux memory will be located at a
3981 non page size aligned address and this could cause major
3982 problems.
3983
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003984- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003985 Enable temporary baudrate change while serial download
3986
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003987- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003988 Physical start address of SDRAM. _Must_ be 0 here.
3989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003990- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003991 Physical start address of Motherboard I/O (if using a
3992 Cogent motherboard)
3993
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003994- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003995 Physical start address of Flash memory.
3996
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003997- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003998 Physical start address of boot monitor code (set by
3999 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02004000 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004001 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00004002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004003- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00004004 Size of memory reserved for monitor code, used to
4005 determine _at_compile_time_ (!) if the environment is
4006 embedded within the U-Boot image, or in a separate
4007 flash sector.
wdenkc6097192002-11-03 00:24:07 +00004008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004009- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00004010 Size of DRAM reserved for malloc() use.
4011
Simon Glass863e4042014-07-10 22:23:28 -06004012- CONFIG_SYS_MALLOC_F_LEN
4013 Size of the malloc() pool for use before relocation. If
4014 this is defined, then a very simple malloc() implementation
4015 will become available before relocation. The address is just
4016 below the global data, and the stack is moved down to make
4017 space.
4018
4019 This feature allocates regions with increasing addresses
4020 within the region. calloc() is supported, but realloc()
4021 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004022 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06004023 U-Boot relocates itself.
4024
Simon Glasse997f752014-09-15 06:33:18 -06004025 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06004026 at present but is fairly easy to enable for other archs.
4027
Simon Glass9fa901b2014-11-10 17:16:54 -07004028- CONFIG_SYS_MALLOC_SIMPLE
4029 Provides a simple and small malloc() and calloc() for those
4030 boards which do not use the full malloc in SPL (which is
4031 enabled with CONFIG_SYS_SPL_MALLOC_START).
4032
Thierry Redingc97d9742014-12-09 22:25:22 -07004033- CONFIG_SYS_NONCACHED_MEMORY:
4034 Size of non-cached memory area. This area of memory will be
4035 typically located right below the malloc() area and mapped
4036 uncached in the MMU. This is useful for drivers that would
4037 otherwise require a lot of explicit cache maintenance. For
4038 some drivers it's also impossible to properly maintain the
4039 cache. For example if the regions that need to be flushed
4040 are not a multiple of the cache-line size, *and* padding
4041 cannot be allocated between the regions to align them (i.e.
4042 if the HW requires a contiguous array of regions, and the
4043 size of each region is not cache-aligned), then a flush of
4044 one region may result in overwriting data that hardware has
4045 written to another region in the same cache-line. This can
4046 happen for example in network drivers where descriptors for
4047 buffers are typically smaller than the CPU cache-line (e.g.
4048 16 bytes vs. 32 or 64 bytes).
4049
4050 Non-cached memory is only supported on 32-bit ARM at present.
4051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004052- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01004053 Normally compressed uImages are limited to an
4054 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004055 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004056 to adjust this setting to your needs.
4057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004058- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004059 Maximum size of memory mapped by the startup code of
4060 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004061 the Linux kernel (bd_info, boot arguments, FDT blob if
4062 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004063 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004064 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004065 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004066 variable "bootm_mapsize" will override the value of
4067 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4068 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004069
John Rigbyeea8e692010-10-13 13:57:35 -06004070- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4071 Enable initrd_high functionality. If defined then the
4072 initrd_high feature is enabled and the bootm ramdisk subcommand
4073 is enabled.
4074
4075- CONFIG_SYS_BOOT_GET_CMDLINE:
4076 Enables allocating and saving kernel cmdline in space between
4077 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4078
4079- CONFIG_SYS_BOOT_GET_KBD:
4080 Enables allocating and saving a kernel copy of the bd_info in
4081 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4082
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004083- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004084 Max number of Flash memory banks
4085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004086- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004087 Max number of sectors on a Flash chip
4088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004089- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004090 Timeout for Flash erase operations (in ms)
4091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004092- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004093 Timeout for Flash write operations (in ms)
4094
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004095- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004096 Timeout for Flash set sector lock bit operation (in ms)
4097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004098- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004099 Timeout for Flash clear lock bits operation (in ms)
4100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004101- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004102 If defined, hardware flash sectors protection is used
4103 instead of U-Boot software protection.
4104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004105- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004106
4107 Enable TFTP transfers directly to flash memory;
4108 without this option such a download has to be
4109 performed in two steps: (1) download to RAM, and (2)
4110 copy from RAM to flash.
4111
4112 The two-step approach is usually more reliable, since
4113 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004114 the flash, but in some situations (when system RAM is
4115 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004116 downloaded image) this option may be very useful.
4117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004118- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004119 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004120 common flash structure for storing flash geometry.
4121
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004122- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004123 This option also enables the building of the cfi_flash driver
4124 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004125
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004126- CONFIG_FLASH_CFI_MTD
4127 This option enables the building of the cfi_mtd driver
4128 in the drivers directory. The driver exports CFI flash
4129 to the MTD layer.
4130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004131- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004132 Use buffered writes to flash.
4133
4134- CONFIG_FLASH_SPANSION_S29WS_N
4135 s29ws-n MirrorBit flash has non-standard addresses for buffered
4136 write commands.
4137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004138- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004139 If this option is defined, the common CFI flash doesn't
4140 print it's warning upon not recognized FLASH banks. This
4141 is useful, if some of the configured banks are only
4142 optionally available.
4143
Jerry Van Barenaae73572008-03-08 13:48:01 -05004144- CONFIG_FLASH_SHOW_PROGRESS
4145 If defined (must be an integer), print out countdown
4146 digits and dots. Recommended value: 45 (9..1) for 80
4147 column displays, 15 (3..1) for 40 column displays.
4148
Stefan Roesed20cba52013-04-04 15:53:14 +02004149- CONFIG_FLASH_VERIFY
4150 If defined, the content of the flash (destination) is compared
4151 against the source after the write operation. An error message
4152 will be printed when the contents are not identical.
4153 Please note that this option is useless in nearly all cases,
4154 since such flash programming errors usually are detected earlier
4155 while unprotecting/erasing/programming. Please only enable
4156 this option if you really know what you are doing.
4157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004159 Defines the number of Ethernet receive buffers. On some
4160 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004161 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4162 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004163 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004164 Defaults to 4 if not defined.
4165
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004166- CONFIG_ENV_MAX_ENTRIES
4167
Wolfgang Denk1136f692010-10-27 22:48:30 +02004168 Maximum number of entries in the hash table that is used
4169 internally to store the environment settings. The default
4170 setting is supposed to be generous and should work in most
4171 cases. This setting can be used to tune behaviour; see
4172 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004173
Joe Hershberger71497d02012-12-11 22:16:31 -06004174- CONFIG_ENV_FLAGS_LIST_DEFAULT
4175- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004176 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004177 calling env set. Variables can be restricted to only decimal,
4178 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4179 the variables can also be restricted to IP address or MAC address.
4180
4181 The format of the list is:
4182 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004183 access_attribute = [a|r|o|c]
4184 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004185 entry = variable_name[:attributes]
4186 list = entry[,list]
4187
4188 The type attributes are:
4189 s - String (default)
4190 d - Decimal
4191 x - Hexadecimal
4192 b - Boolean ([1yYtT|0nNfF])
4193 i - IP address
4194 m - MAC address
4195
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004196 The access attributes are:
4197 a - Any (default)
4198 r - Read-only
4199 o - Write-once
4200 c - Change-default
4201
Joe Hershberger71497d02012-12-11 22:16:31 -06004202 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4203 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004204 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004205
4206 - CONFIG_ENV_FLAGS_LIST_STATIC
4207 Define this to a list (string) to define validation that
4208 should be done if an entry is not found in the ".flags"
4209 environment variable. To override a setting in the static
4210 list, simply add an entry for the same variable name to the
4211 ".flags" variable.
4212
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004213- CONFIG_ENV_ACCESS_IGNORE_FORCE
4214 If defined, don't allow the -f switch to env set override variable
4215 access flags.
4216
Simon Glass66828322013-03-08 13:45:27 +00004217- CONFIG_SYS_GENERIC_BOARD
4218 This selects the architecture-generic board system instead of the
4219 architecture-specific board files. It is intended to move boards
4220 to this new framework over time. Defining this will disable the
4221 arch/foo/lib/board.c file and use common/board_f.c and
4222 common/board_r.c instead. To use this option your architecture
4223 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4224 its config.mk file). If you find problems enabling this option on
4225 your board please report the problem and send patches!
4226
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004227- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4228 This is set by OMAP boards for the max time that reset should
4229 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004230 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004231
Gabe Black3687fe42014-10-15 04:38:30 -06004232- CONFIG_USE_STDINT
4233 If stdint.h is available with your toolchain you can define this
4234 option to enable it. You can provide option 'USE_STDINT=1' when
4235 building U-Boot to enable this.
4236
wdenkc6097192002-11-03 00:24:07 +00004237The following definitions that deal with the placement and management
4238of environment data (variable area); in general, we support the
4239following configurations:
4240
Mike Frysinger63b8f122011-07-08 10:44:25 +00004241- CONFIG_BUILD_ENVCRC:
4242
4243 Builds up envcrc with the target environment so that external utils
4244 may easily extract it and embed it in final U-Boot images.
4245
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004246- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004247
4248 Define this if the environment is in flash memory.
4249
4250 a) The environment occupies one whole flash sector, which is
4251 "embedded" in the text segment with the U-Boot code. This
4252 happens usually with "bottom boot sector" or "top boot
4253 sector" type flash chips, which have several smaller
4254 sectors at the start or the end. For instance, such a
4255 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4256 such a case you would place the environment in one of the
4257 4 kB sectors - with U-Boot code before and after it. With
4258 "top boot sector" type flash chips, you would put the
4259 environment in one of the last sectors, leaving a gap
4260 between U-Boot and the environment.
4261
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004262 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004263
4264 Offset of environment data (variable area) to the
4265 beginning of flash memory; for instance, with bottom boot
4266 type flash chips the second sector can be used: the offset
4267 for this sector is given here.
4268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004269 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004270
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004271 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004272
4273 This is just another way to specify the start address of
4274 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004275 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004276
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004277 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004278
4279 Size of the sector containing the environment.
4280
4281
4282 b) Sometimes flash chips have few, equal sized, BIG sectors.
4283 In such a case you don't want to spend a whole sector for
4284 the environment.
4285
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004286 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004287
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004288 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004289 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004290 of this flash sector for the environment. This saves
4291 memory for the RAM copy of the environment.
4292
4293 It may also save flash memory if you decide to use this
4294 when your environment is "embedded" within U-Boot code,
4295 since then the remainder of the flash sector could be used
4296 for U-Boot code. It should be pointed out that this is
4297 STRONGLY DISCOURAGED from a robustness point of view:
4298 updating the environment in flash makes it always
4299 necessary to erase the WHOLE sector. If something goes
4300 wrong before the contents has been restored from a copy in
4301 RAM, your target system will be dead.
4302
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004303 - CONFIG_ENV_ADDR_REDUND
4304 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk4a5c8a72003-03-06 00:02:04 +00004306 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004307 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004308 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004309 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004310
4311BE CAREFUL! Any changes to the flash layout, and some changes to the
4312source code will make it necessary to adapt <board>/u-boot.lds*
4313accordingly!
4314
4315
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004316- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004317
4318 Define this if you have some non-volatile memory device
4319 (NVRAM, battery buffered SRAM) which you want to use for the
4320 environment.
4321
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004322 - CONFIG_ENV_ADDR:
4323 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004324
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004325 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004326 want to use for environment. It is assumed that this memory
4327 can just be read and written to, without any special
4328 provision.
4329
4330BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004331in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004332console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004333U-Boot will hang.
4334
4335Please note that even with NVRAM we still use a copy of the
4336environment in RAM: we could work on NVRAM directly, but we want to
4337keep settings there always unmodified except somebody uses "saveenv"
4338to save the current settings.
4339
4340
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004341- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004342
4343 Use this if you have an EEPROM or similar serial access
4344 device and a driver for it.
4345
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004346 - CONFIG_ENV_OFFSET:
4347 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004348
4349 These two #defines specify the offset and size of the
4350 environment area within the total memory of your EEPROM.
4351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004352 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004353 If defined, specified the chip address of the EEPROM device.
4354 The default address is zero.
4355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004356 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004357 If defined, the number of bits used to address bytes in a
4358 single page in the EEPROM device. A 64 byte page, for example
4359 would require six bits.
4360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004361 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004362 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004363 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004365 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004366 The length in bytes of the EEPROM memory array address. Note
4367 that this is NOT the chip address length!
4368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004369 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004370 EEPROM chips that implement "address overflow" are ones
4371 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4372 address and the extra bits end up in the "chip address" bit
4373 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4374 byte chips.
4375
4376 Note that we consider the length of the address field to
4377 still be one byte because the extra address bits are hidden
4378 in the chip address.
4379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004380 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004381 The size in bytes of the EEPROM device.
4382
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004383 - CONFIG_ENV_EEPROM_IS_ON_I2C
4384 define this, if you have I2C and SPI activated, and your
4385 EEPROM, which holds the environment, is on the I2C bus.
4386
4387 - CONFIG_I2C_ENV_EEPROM_BUS
4388 if you have an Environment on an EEPROM reached over
4389 I2C muxes, you can define here, how to reach this
4390 EEPROM. For example:
4391
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004392 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004393
4394 EEPROM which holds the environment, is reached over
4395 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004396
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004397- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004398
wdenk1ebf41e2004-01-02 14:00:00 +00004399 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004400 want to use for the environment.
4401
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004402 - CONFIG_ENV_OFFSET:
4403 - CONFIG_ENV_ADDR:
4404 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004405
4406 These three #defines specify the offset and size of the
4407 environment area within the total memory of your DataFlash placed
4408 at the specified address.
4409
Wu, Josh76db7bf2014-07-01 19:30:13 +08004410- CONFIG_ENV_IS_IN_SPI_FLASH:
4411
4412 Define this if you have a SPI Flash memory device which you
4413 want to use for the environment.
4414
4415 - CONFIG_ENV_OFFSET:
4416 - CONFIG_ENV_SIZE:
4417
4418 These two #defines specify the offset and size of the
4419 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4420 aligned to an erase sector boundary.
4421
4422 - CONFIG_ENV_SECT_SIZE:
4423
4424 Define the SPI flash's sector size.
4425
4426 - CONFIG_ENV_OFFSET_REDUND (optional):
4427
4428 This setting describes a second storage area of CONFIG_ENV_SIZE
4429 size used to hold a redundant copy of the environment data, so
4430 that there is a valid backup copy in case there is a power failure
4431 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4432 aligned to an erase sector boundary.
4433
4434 - CONFIG_ENV_SPI_BUS (optional):
4435 - CONFIG_ENV_SPI_CS (optional):
4436
4437 Define the SPI bus and chip select. If not defined they will be 0.
4438
4439 - CONFIG_ENV_SPI_MAX_HZ (optional):
4440
4441 Define the SPI max work clock. If not defined then use 1MHz.
4442
4443 - CONFIG_ENV_SPI_MODE (optional):
4444
4445 Define the SPI work mode. If not defined then use SPI_MODE_3.
4446
Liu Gang85bcd732012-03-08 00:33:20 +00004447- CONFIG_ENV_IS_IN_REMOTE:
4448
4449 Define this if you have a remote memory space which you
4450 want to use for the local device's environment.
4451
4452 - CONFIG_ENV_ADDR:
4453 - CONFIG_ENV_SIZE:
4454
4455 These two #defines specify the address and size of the
4456 environment area within the remote memory space. The
4457 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004458 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004459
4460BE CAREFUL! For some special cases, the local device can not use
4461"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004462environment stored in a remote NOR flash by SRIO or PCIE link,
4463but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004464
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004465- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004466
4467 Define this if you have a NAND device which you want to use
4468 for the environment.
4469
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004470 - CONFIG_ENV_OFFSET:
4471 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004472
4473 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004474 area within the first NAND device. CONFIG_ENV_OFFSET must be
4475 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004476
Scott Wood08239322010-09-17 14:38:37 -05004477 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004478
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004479 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004480 size used to hold a redundant copy of the environment data, so
4481 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004482 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004483 aligned to an erase block boundary.
4484
4485 - CONFIG_ENV_RANGE (optional):
4486
4487 Specifies the length of the region in which the environment
4488 can be written. This should be a multiple of the NAND device's
4489 block size. Specifying a range with more erase blocks than
4490 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4491 the range to be avoided.
4492
4493 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004494
Scott Wood08239322010-09-17 14:38:37 -05004495 Enables support for dynamically retrieving the offset of the
4496 environment from block zero's out-of-band data. The
4497 "nand env.oob" command can be used to record this offset.
4498 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4499 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004500
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004501- CONFIG_NAND_ENV_DST
4502
4503 Defines address in RAM to which the nand_spl code should copy the
4504 environment. If redundant environment is used, it will be copied to
4505 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4506
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004507- CONFIG_ENV_IS_IN_UBI:
4508
4509 Define this if you have an UBI volume that you want to use for the
4510 environment. This has the benefit of wear-leveling the environment
4511 accesses, which is important on NAND.
4512
4513 - CONFIG_ENV_UBI_PART:
4514
4515 Define this to a string that is the mtd partition containing the UBI.
4516
4517 - CONFIG_ENV_UBI_VOLUME:
4518
4519 Define this to the name of the volume that you want to store the
4520 environment in.
4521
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004522 - CONFIG_ENV_UBI_VOLUME_REDUND:
4523
4524 Define this to the name of another volume to store a second copy of
4525 the environment in. This will enable redundant environments in UBI.
4526 It is assumed that both volumes are in the same MTD partition.
4527
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004528 - CONFIG_UBI_SILENCE_MSG
4529 - CONFIG_UBIFS_SILENCE_MSG
4530
4531 You will probably want to define these to avoid a really noisy system
4532 when storing the env in UBI.
4533
Wu, Josha7d0c872014-06-24 17:31:03 +08004534- CONFIG_ENV_IS_IN_FAT:
4535 Define this if you want to use the FAT file system for the environment.
4536
4537 - FAT_ENV_INTERFACE:
4538
4539 Define this to a string that is the name of the block device.
4540
4541 - FAT_ENV_DEV_AND_PART:
4542
4543 Define this to a string to specify the partition of the device. It can
4544 be as following:
4545
4546 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4547 - "D:P": device D partition P. Error occurs if device D has no
4548 partition table.
4549 - "D:0": device D.
4550 - "D" or "D:": device D partition 1 if device D has partition
4551 table, or the whole device D if has no partition
4552 table.
4553 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004554 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004555 partition table then means device D.
4556
4557 - FAT_ENV_FILE:
4558
4559 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004560 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004561
4562 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004563 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004564
Stephen Warreneedcacd2013-06-11 15:14:00 -06004565- CONFIG_ENV_IS_IN_MMC:
4566
4567 Define this if you have an MMC device which you want to use for the
4568 environment.
4569
4570 - CONFIG_SYS_MMC_ENV_DEV:
4571
4572 Specifies which MMC device the environment is stored in.
4573
4574 - CONFIG_SYS_MMC_ENV_PART (optional):
4575
4576 Specifies which MMC partition the environment is stored in. If not
4577 set, defaults to partition 0, the user area. Common values might be
4578 1 (first MMC boot partition), 2 (second MMC boot partition).
4579
4580 - CONFIG_ENV_OFFSET:
4581 - CONFIG_ENV_SIZE:
4582
4583 These two #defines specify the offset and size of the environment
4584 area within the specified MMC device.
4585
Stephen Warren24dc2032013-06-11 15:14:02 -06004586 If offset is positive (the usual case), it is treated as relative to
4587 the start of the MMC partition. If offset is negative, it is treated
4588 as relative to the end of the MMC partition. This can be useful if
4589 your board may be fitted with different MMC devices, which have
4590 different sizes for the MMC partitions, and you always want the
4591 environment placed at the very end of the partition, to leave the
4592 maximum possible space before it, to store other data.
4593
Stephen Warreneedcacd2013-06-11 15:14:00 -06004594 These two values are in units of bytes, but must be aligned to an
4595 MMC sector boundary.
4596
4597 - CONFIG_ENV_OFFSET_REDUND (optional):
4598
4599 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4600 hold a redundant copy of the environment data. This provides a
4601 valid backup copy in case the other copy is corrupted, e.g. due
4602 to a power failure during a "saveenv" operation.
4603
Stephen Warren24dc2032013-06-11 15:14:02 -06004604 This value may also be positive or negative; this is handled in the
4605 same way as CONFIG_ENV_OFFSET.
4606
Stephen Warreneedcacd2013-06-11 15:14:00 -06004607 This value is also in units of bytes, but must also be aligned to
4608 an MMC sector boundary.
4609
4610 - CONFIG_ENV_SIZE_REDUND (optional):
4611
4612 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4613 set. If this value is set, it must be set to the same value as
4614 CONFIG_ENV_SIZE.
4615
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004616- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004617
4618 Defines offset to the initial SPI buffer area in DPRAM. The
4619 area is used at an early stage (ROM part) if the environment
4620 is configured to reside in the SPI EEPROM: We need a 520 byte
4621 scratch DPRAM area. It is used between the two initialization
4622 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4623 to be a good choice since it makes it far enough from the
4624 start of the data area as well as from the stack pointer.
4625
Bruce Adleredecc942007-11-02 13:15:42 -07004626Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004627has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004628created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004629until then to read environment variables.
4630
wdenk8dba0502003-03-31 16:34:49 +00004631The environment is protected by a CRC32 checksum. Before the monitor
4632is relocated into RAM, as a result of a bad CRC you will be working
4633with the compiled-in default environment - *silently*!!! [This is
4634necessary, because the first environment variable we need is the
4635"baudrate" setting for the console - if we have a bad CRC, we don't
4636have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004637
4638Note: once the monitor has been relocated, then it will complain if
4639the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004640use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004641
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004642- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004643 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004645 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004646 also needs to be defined.
4647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004648- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004649 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004650
Ron Madriddfa028a2009-02-18 14:30:44 -08004651- CONFIG_NS16550_MIN_FUNCTIONS:
4652 Define this if you desire to only have use of the NS16550_init
4653 and NS16550_putc functions for the serial driver located at
4654 drivers/serial/ns16550.c. This option is useful for saving
4655 space for already greatly restricted images, including but not
4656 limited to NAND_SPL configurations.
4657
Simon Glass28a9e332012-11-30 13:01:18 +00004658- CONFIG_DISPLAY_BOARDINFO
4659 Display information about the board that U-Boot is running on
4660 when U-Boot starts up. The board function checkboard() is called
4661 to do this.
4662
Simon Glasse8822012012-11-30 13:01:19 +00004663- CONFIG_DISPLAY_BOARDINFO_LATE
4664 Similar to the previous option, but display this information
4665 later, once stdio is running and output goes to the LCD, if
4666 present.
4667
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004668- CONFIG_BOARD_SIZE_LIMIT:
4669 Maximum size of the U-Boot image. When defined, the
4670 build system checks that the actual size does not
4671 exceed it.
4672
wdenkc6097192002-11-03 00:24:07 +00004673Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004674---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004675
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004676- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004677 Cache Line Size of the CPU.
4678
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004679- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004680 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004681
wdenk9c53f402003-10-15 23:53:47 +00004682 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4683 and RPXsuper) to be able to adjust the position of
4684 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004685
Timur Tabid8f341c2011-08-04 18:03:41 -05004686- CONFIG_SYS_CCSRBAR_DEFAULT:
4687 Default (power-on reset) physical address of CCSR on Freescale
4688 PowerPC SOCs.
4689
4690- CONFIG_SYS_CCSRBAR:
4691 Virtual address of CCSR. On a 32-bit build, this is typically
4692 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4693
4694 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4695 for cross-platform code that uses that macro instead.
4696
4697- CONFIG_SYS_CCSRBAR_PHYS:
4698 Physical address of CCSR. CCSR can be relocated to a new
4699 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004700 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004701 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4702 is typically relocated on 36-bit builds. It is recommended
4703 that this macro be defined via the _HIGH and _LOW macros:
4704
4705 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4706 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4707
4708- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004709 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4710 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004711 used in assembly code, so it must not contain typecasts or
4712 integer size suffixes (e.g. "ULL").
4713
4714- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4715 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4716 used in assembly code, so it must not contain typecasts or
4717 integer size suffixes (e.g. "ULL").
4718
4719- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4720 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4721 forced to a value that ensures that CCSR is not relocated.
4722
wdenk1272e232002-11-10 22:06:23 +00004723- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004724 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004725
4726 the default drive number (default value 0)
4727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004728 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004729
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004730 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004731 (default value 1)
4732
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004733 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004734
wdenk4a5c8a72003-03-06 00:02:04 +00004735 defines the offset of register from address. It
4736 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004737 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004738
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004739 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4740 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004741 default value.
wdenk1272e232002-11-10 22:06:23 +00004742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004743 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004744 fdc_hw_init() is called at the beginning of the FDC
4745 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004746 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004747 initializations.
wdenk1272e232002-11-10 22:06:23 +00004748
Macpaul Lind1e49942011-04-11 20:45:32 +00004749- CONFIG_IDE_AHB:
4750 Most IDE controllers were designed to be connected with PCI
4751 interface. Only few of them were designed for AHB interface.
4752 When software is doing ATA command and data transfer to
4753 IDE devices through IDE-AHB controller, some additional
4754 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004755 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004757- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004758 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004759 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004761- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004762
wdenkeb20ad32003-09-05 23:19:14 +00004763 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004764 initial data and stack; please note that this must be
4765 writable memory that is working WITHOUT special
4766 initialization, i. e. you CANNOT use normal RAM which
4767 will become available only after programming the
4768 memory controller and running certain initialization
4769 sequences.
4770
4771 U-Boot uses the following memory types:
4772 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4773 - MPC824X: data cache
4774 - PPC4xx: data cache
4775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004776- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004777
4778 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004779 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4780 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004781 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004782 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004783 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4784 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4785 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004786
4787 Note:
4788 On the MPC824X (or other systems that use the data
4789 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004790 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004791 point to an otherwise UNUSED address space between
4792 the top of RAM and the start of the PCI space.
4793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004794- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004795
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004796- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004798- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004800- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004802- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004804- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004806- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004807 SDRAM timing
4808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004809- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004810 periodic timer for refresh
4811
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004812- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004814- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4815 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4816 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4817 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004818 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4819
4820- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004821 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4822 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004823 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004825- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4826 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004827 Machine Mode Register and Memory Periodic Timer
4828 Prescaler definitions (SDRAM timing)
4829
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004830- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004831 enable I2C microcode relocation patch (MPC8xx);
4832 define relocation offset in DPRAM [DSP2]
4833
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004834- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004835 enable SMC microcode relocation patch (MPC8xx);
4836 define relocation offset in DPRAM [SMC1]
4837
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004838- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004839 enable SPI microcode relocation patch (MPC8xx);
4840 define relocation offset in DPRAM [SCC4]
4841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004842- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004843 Use OSCM clock mode on MBX8xx board. Be careful,
4844 wrong setting might damage your board. Read
4845 doc/README.MBX before setting this variable!
4846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004847- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004848 Offset of the bootmode word in DPRAM used by post
4849 (Power On Self Tests). This definition overrides
4850 #define'd default value in commproc.h resp.
4851 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004852
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004853- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4854 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4855 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4856 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4857 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4858 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4859 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4860 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004861 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004862
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004863- CONFIG_PCI_DISABLE_PCIE:
4864 Disable PCI-Express on systems where it is supported but not
4865 required.
4866
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004867- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004868 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004869 Don't do any setup work, presumably because someone or
4870 something has already done it, and we don't need to do it
4871 a second time. Useful for platforms that are pre-booted
4872 by coreboot or similar.
4873
Gabor Juhosb4458732013-05-30 07:06:12 +00004874- CONFIG_PCI_INDIRECT_BRIDGE:
4875 Enable support for indirect PCI bridges.
4876
Kumar Gala8975d7a2010-12-30 12:09:53 -06004877- CONFIG_SYS_SRIO:
4878 Chip has SRIO or not
4879
4880- CONFIG_SRIO1:
4881 Board has SRIO 1 port available
4882
4883- CONFIG_SRIO2:
4884 Board has SRIO 2 port available
4885
Liu Gang27afb9c2013-05-07 16:30:46 +08004886- CONFIG_SRIO_PCIE_BOOT_MASTER
4887 Board can support master function for Boot from SRIO and PCIE
4888
Kumar Gala8975d7a2010-12-30 12:09:53 -06004889- CONFIG_SYS_SRIOn_MEM_VIRT:
4890 Virtual Address of SRIO port 'n' memory region
4891
4892- CONFIG_SYS_SRIOn_MEM_PHYS:
4893 Physical Address of SRIO port 'n' memory region
4894
4895- CONFIG_SYS_SRIOn_MEM_SIZE:
4896 Size of SRIO port 'n' memory region
4897
Fabio Estevamf17e8782013-04-11 09:35:34 +00004898- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4899 Defined to tell the NAND controller that the NAND chip is using
4900 a 16 bit bus.
4901 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004902 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004903 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004904 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004905
4906- CONFIG_SYS_NDFC_EBC0_CFG
4907 Sets the EBC0_CFG register for the NDFC. If not defined
4908 a default value will be used.
4909
Ben Warren45657152006-09-07 16:50:54 -04004910- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004911 Get DDR timing information from an I2C EEPROM. Common
4912 with pluggable memory modules such as SODIMMs
4913
Ben Warren45657152006-09-07 16:50:54 -04004914 SPD_EEPROM_ADDRESS
4915 I2C address of the SPD EEPROM
4916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004917- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004918 If SPD EEPROM is on an I2C bus other than the first
4919 one, specify here. Note that the value must resolve
4920 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004921
York Sune73cc042011-06-07 09:42:16 +08004922- CONFIG_SYS_DDR_RAW_TIMING
4923 Get DDR timing information from other than SPD. Common with
4924 soldered DDR chips onboard without SPD. DDR raw timing
4925 parameters are extracted from datasheet and hard-coded into
4926 header files or board specific files.
4927
York Sunbd495cf2011-09-16 13:21:35 -07004928- CONFIG_FSL_DDR_INTERACTIVE
4929 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4930
York Sun8ced0502015-01-06 13:18:55 -08004931- CONFIG_FSL_DDR_SYNC_REFRESH
4932 Enable sync of refresh for multiple controllers.
4933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004934- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004935 Only for 83xx systems. If specified, then DDR should
4936 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004937
wdenk6203e402004-04-18 10:13:26 +00004938- CONFIG_ETHER_ON_FEC[12]
4939 Define to enable FEC[12] on a 8xx series processor.
4940
4941- CONFIG_FEC[12]_PHY
4942 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004943 to the given FEC; i. e.
4944 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004945 means that the PHY with address 4 is connected to FEC1
4946
4947 When set to -1, means to probe for first available.
4948
4949- CONFIG_FEC[12]_PHY_NORXERR
4950 The PHY does not have a RXERR line (RMII only).
4951 (so program the FEC to ignore it).
4952
4953- CONFIG_RMII
4954 Enable RMII mode for all FECs.
4955 Note that this is a global option, we can't
4956 have one FEC in standard MII mode and another in RMII mode.
4957
wdenk20c98a62004-04-23 20:32:05 +00004958- CONFIG_CRC32_VERIFY
4959 Add a verify option to the crc32 command.
4960 The syntax is:
4961
4962 => crc32 -v <address> <count> <crc32>
4963
4964 Where address/count indicate a memory area
4965 and crc32 is the correct crc32 which the
4966 area should have.
4967
wdenk64519362004-07-11 17:40:54 +00004968- CONFIG_LOOPW
4969 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004970 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004971
stroesecc3af832004-12-16 18:46:55 +00004972- CONFIG_MX_CYCLIC
4973 Add the "mdc" and "mwc" memory commands. These are cyclic
4974 "md/mw" commands.
4975 Examples:
4976
wdenk07d7e6b2004-12-16 21:44:03 +00004977 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004978 This command will print 4 bytes (10,11,12,13) each 500 ms.
4979
wdenk07d7e6b2004-12-16 21:44:03 +00004980 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004981 This command will write 12345678 to address 100 all 10 ms.
4982
wdenk07d7e6b2004-12-16 21:44:03 +00004983 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004984 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004985
wdenk3d3d99f2005-04-04 12:44:11 +00004986- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004987 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004988 low level initializations (like setting up the memory
4989 controller) are omitted and/or U-Boot does not
4990 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004991
Wolfgang Denk302141d2010-11-27 23:30:56 +01004992 Normally this variable MUST NOT be defined. The only
4993 exception is when U-Boot is loaded (to RAM) by some
4994 other boot loader or by a debugger which performs
4995 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004996
Aneesh V552a3192011-07-13 05:11:07 +00004997- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004998 Modifies the behaviour of start.S when compiling a loader
4999 that is executed before the actual U-Boot. E.g. when
5000 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00005001
Ying Zhang2d2e3b62013-08-16 15:16:15 +08005002- CONFIG_TPL_BUILD
5003 Modifies the behaviour of start.S when compiling a loader
5004 that is executed after the SPL and before the actual U-Boot.
5005 It is loaded by the SPL.
5006
Ying Zhang0d4f5442013-05-20 14:07:23 +08005007- CONFIG_SYS_MPC85XX_NO_RESETVEC
5008 Only for 85xx systems. If this variable is specified, the section
5009 .resetvec is not kept and the section .bootpg is placed in the
5010 previous 4k of the .text section.
5011
Simon Glass17dabf02013-02-24 17:33:14 +00005012- CONFIG_ARCH_MAP_SYSMEM
5013 Generally U-Boot (and in particular the md command) uses
5014 effective address. It is therefore not necessary to regard
5015 U-Boot address as virtual addresses that need to be translated
5016 to physical addresses. However, sandbox requires this, since
5017 it maintains its own little RAM buffer which contains all
5018 addressable memory. This option causes some memory accesses
5019 to be mapped through map_sysmem() / unmap_sysmem().
5020
Matthias Weisser93416c12011-03-10 21:36:32 +00005021- CONFIG_USE_ARCH_MEMCPY
5022 CONFIG_USE_ARCH_MEMSET
5023 If these options are used a optimized version of memcpy/memset will
5024 be used if available. These functions may be faster under some
5025 conditions but may increase the binary size.
5026
Simon Glassbfb59802013-02-14 04:18:54 +00005027- CONFIG_X86_RESET_VECTOR
5028 If defined, the x86 reset vector code is included. This is not
5029 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00005030
Mark Jackson52b003c2013-03-04 01:27:20 +00005031- CONFIG_SYS_MPUCLK
5032 Defines the MPU clock speed (in MHz).
5033
5034 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00005035
Heiko Schocher2233e462013-11-04 14:05:00 +01005036- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5037 Enables the RTC32K OSC on AM33xx based plattforms
5038
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04005039- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5040 Option to disable subpage write in NAND driver
5041 driver that uses this:
5042 drivers/mtd/nand/davinci_nand.c
5043
Timur Tabi275f4bb2011-11-22 09:21:25 -06005044Freescale QE/FMAN Firmware Support:
5045-----------------------------------
5046
5047The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5048loading of "firmware", which is encoded in the QE firmware binary format.
5049This firmware often needs to be loaded during U-Boot booting, so macros
5050are used to identify the storage device (NOR flash, SPI, etc) and the address
5051within that device.
5052
Zhao Qiang83a90842014-03-21 16:21:44 +08005053- CONFIG_SYS_FMAN_FW_ADDR
5054 The address in the storage device where the FMAN microcode is located. The
5055 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5056 is also specified.
5057
5058- CONFIG_SYS_QE_FW_ADDR
5059 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005060 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5061 is also specified.
5062
5063- CONFIG_SYS_QE_FMAN_FW_LENGTH
5064 The maximum possible size of the firmware. The firmware binary format
5065 has a field that specifies the actual size of the firmware, but it
5066 might not be possible to read any part of the firmware unless some
5067 local storage is allocated to hold the entire firmware first.
5068
5069- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5070 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5071 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5072 virtual address in NOR flash.
5073
5074- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5075 Specifies that QE/FMAN firmware is located in NAND flash.
5076 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5077
5078- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5079 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5080 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5081
5082- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5083 Specifies that QE/FMAN firmware is located on the primary SPI
5084 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5085
Liu Gang1e084582012-03-08 00:33:18 +00005086- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5087 Specifies that QE/FMAN firmware is located in the remote (master)
5088 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005089 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5090 window->master inbound window->master LAW->the ucode address in
5091 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005092
J. German Rivera8ff14b72014-06-23 15:15:55 -07005093Freescale Layerscape Management Complex Firmware Support:
5094---------------------------------------------------------
5095The Freescale Layerscape Management Complex (MC) supports the loading of
5096"firmware".
5097This firmware often needs to be loaded during U-Boot booting, so macros
5098are used to identify the storage device (NOR flash, SPI, etc) and the address
5099within that device.
5100
5101- CONFIG_FSL_MC_ENET
5102 Enable the MC driver for Layerscape SoCs.
5103
5104- CONFIG_SYS_LS_MC_FW_ADDR
5105 The address in the storage device where the firmware is located. The
5106 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5107 is also specified.
5108
5109- CONFIG_SYS_LS_MC_FW_LENGTH
5110 The maximum possible size of the firmware. The firmware binary format
5111 has a field that specifies the actual size of the firmware, but it
5112 might not be possible to read any part of the firmware unless some
5113 local storage is allocated to hold the entire firmware first.
5114
5115- CONFIG_SYS_LS_MC_FW_IN_NOR
5116 Specifies that MC firmware is located in NOR flash, mapped as
5117 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5118 virtual address in NOR flash.
5119
wdenkc6097192002-11-03 00:24:07 +00005120Building the Software:
5121======================
5122
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005123Building U-Boot has been tested in several native build environments
5124and in many different cross environments. Of course we cannot support
5125all possibly existing versions of cross development tools in all
5126(potentially obsolete) versions. In case of tool chain problems we
5127recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5128which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005129
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005130If you are not using a native environment, it is assumed that you
5131have GNU cross compiling tools available in your path. In this case,
5132you must set the environment variable CROSS_COMPILE in your shell.
5133Note that no changes to the Makefile or any other source files are
5134necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005135
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005136 $ CROSS_COMPILE=ppc_4xx-
5137 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005138
Peter Tyserb06976d2009-03-13 18:54:51 -05005139Note: If you wish to generate Windows versions of the utilities in
5140 the tools directory you can use the MinGW toolchain
5141 (http://www.mingw.org). Set your HOST tools to the MinGW
5142 toolchain and execute 'make tools'. For example:
5143
5144 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5145
5146 Binaries such as tools/mkimage.exe will be created which can
5147 be executed on computers running Windows.
5148
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005149U-Boot is intended to be simple to build. After installing the
5150sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005151is done by typing:
5152
Holger Freyther7ba4e572014-08-04 09:26:05 +02005153 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005154
Holger Freyther7ba4e572014-08-04 09:26:05 +02005155where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005156rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005157
wdenk6c59edc2004-05-03 20:45:30 +00005158Note: for some board special configuration names may exist; check if
5159 additional information is available from the board vendor; for
5160 instance, the TQM823L systems are available without (standard)
5161 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005162 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005163
Holger Freyther7ba4e572014-08-04 09:26:05 +02005164 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005165 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005166
Holger Freyther7ba4e572014-08-04 09:26:05 +02005167 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005168 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170 etc.
wdenkc6097192002-11-03 00:24:07 +00005171
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk6c59edc2004-05-03 20:45:30 +00005173Finally, type "make all", and you should get some working U-Boot
5174images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176- "u-boot.bin" is a raw binary image
5177- "u-boot" is an image in ELF binary format
5178- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005179
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005180By default the build is performed locally and the objects are saved
5181in the source directory. One of the two methods can be used to change
5182this behavior and build U-Boot to some external directory:
5183
51841. Add O= to the make command line invocations:
5185
5186 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005187 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005188 make O=/tmp/build all
5189
Timo Ketolac8c67602014-11-06 14:39:05 +020051902. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005191
Timo Ketolac8c67602014-11-06 14:39:05 +02005192 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005193 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005194 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005195 make all
5196
Timo Ketolac8c67602014-11-06 14:39:05 +02005197Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005198variable.
5199
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk6c59edc2004-05-03 20:45:30 +00005201Please be aware that the Makefiles assume you are using GNU make, so
5202for instance on NetBSD you might need to use "gmake" instead of
5203native "make".
wdenkc6097192002-11-03 00:24:07 +00005204
wdenkc6097192002-11-03 00:24:07 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206If the system board that you have is not listed, then you will need
5207to port U-Boot to your hardware platform. To do this, follow these
5208steps:
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +000052101. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005211 "boards.cfg" file, using the existing entries as examples.
5212 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000052132. Create a new directory to hold your board specific code. Add any
5214 files you need. In your board directory, you will need at least
5215 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
52163. Create a new configuration file "include/configs/<board>.h" for
5217 your board
52183. If you're porting U-Boot to a new CPU, then also create a new
5219 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020052204. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000052215. Type "make", and you should get a working "u-boot.srec" file
5222 to be installed on your target system.
52236. Debug and solve any problems that might arise.
5224 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005225
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5228==============================================================
wdenkc6097192002-11-03 00:24:07 +00005229
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005230If you have modified U-Boot sources (for instance added a new board
5231or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005232provide feedback to the other developers. The feedback normally takes
5233the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005234official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005235
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005236But before you submit such a patch, please verify that your modifi-
5237cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005238the supported boards compile WITHOUT ANY compiler warnings. To do so,
5239just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005240for ALL supported system. Be warned, this will take a while. You can
5241select which (cross) compiler to use by passing a `CROSS_COMPILE'
5242environment variable to the script, i. e. to use the ELDK cross tools
5243you can type
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk6c59edc2004-05-03 20:45:30 +00005249 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005250
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005251When using the MAKEALL script, the default behaviour is to build
5252U-Boot in the source directory. This location can be changed by
5253setting the BUILD_DIR environment variable. Also, for each target
5254built, the MAKEALL script saves two log files (<target>.ERR and
5255<target>.MAKEALL) in the <source dir>/LOG directory. This default
5256location can be changed by setting the MAKEALL_LOGDIR environment
5257variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005258
5259 export BUILD_DIR=/tmp/build
5260 export MAKEALL_LOGDIR=/tmp/log
5261 CROSS_COMPILE=ppc_8xx- MAKEALL
5262
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005263With the above settings build objects are saved in the /tmp/build,
5264log files are saved in the /tmp/log and the source tree remains clean
5265during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005266
5267
wdenk6c59edc2004-05-03 20:45:30 +00005268See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005269
wdenkc6097192002-11-03 00:24:07 +00005270
wdenk6c59edc2004-05-03 20:45:30 +00005271Monitor Commands - Overview:
5272============================
wdenkc6097192002-11-03 00:24:07 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274go - start application at address 'addr'
5275run - run commands in an environment variable
5276bootm - boot application image from memory
5277bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005278bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005279tftpboot- boot image via network using TFTP protocol
5280 and env variables "ipaddr" and "serverip"
5281 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005282tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005283rarpboot- boot image via network using RARP/TFTP protocol
5284diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5285loads - load S-Record file over serial line
5286loadb - load binary file over serial line (kermit mode)
5287md - memory display
5288mm - memory modify (auto-incrementing)
5289nm - memory modify (constant address)
5290mw - memory write (fill)
5291cp - memory copy
5292cmp - memory compare
5293crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005294i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005295sspi - SPI utility commands
5296base - print or set address offset
5297printenv- print environment variables
5298setenv - set environment variables
5299saveenv - save environment variables to persistent storage
5300protect - enable or disable FLASH write protection
5301erase - erase FLASH memory
5302flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005303nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005304bdinfo - print Board Info structure
5305iminfo - print header information for application image
5306coninfo - print console devices and informations
5307ide - IDE sub-system
5308loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005309loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005310mtest - simple RAM test
5311icache - enable or disable instruction cache
5312dcache - enable or disable data cache
5313reset - Perform RESET of the CPU
5314echo - echo args to console
5315version - print monitor version
5316help - print online help
5317? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005318
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320Monitor Commands - Detailed Description:
5321========================================
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323TODO.
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005326
5327
wdenk6c59edc2004-05-03 20:45:30 +00005328Environment Variables:
5329======================
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331U-Boot supports user configuration using Environment Variables which
5332can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334Environment Variables are set using "setenv", printed using
5335"printenv", and saved to Flash using "saveenv". Using "setenv"
5336without a value can be used to delete a variable from the
5337environment. As long as you don't save the environment you are
5338working with an in-memory copy. In case the Flash area containing the
5339environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005340
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005341Some configuration options can be set using Environment Variables.
5342
5343List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005354
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005355 bootm_low - Memory range available for image processing in the bootm
5356 command can be restricted. This variable is given as
5357 a hexadecimal number and defines lowest address allowed
5358 for use by the bootm command. See also "bootm_size"
5359 environment variable. Address defined by "bootm_low" is
5360 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005361 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5362 bootm_mapsize.
5363
Wolfgang Denk092ae952011-10-26 10:21:21 +00005364 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005365 This variable is given as a hexadecimal number and it
5366 defines the size of the memory region starting at base
5367 address bootm_low that is accessible by the Linux kernel
5368 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5369 as the default value if it is defined, and bootm_size is
5370 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005371
5372 bootm_size - Memory range available for image processing in the bootm
5373 command can be restricted. This variable is given as
5374 a hexadecimal number and defines the size of the region
5375 allowed for use by the bootm command. See also "bootm_low"
5376 environment variable.
5377
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005378 updatefile - Location of the software update file on a TFTP server, used
5379 by the automatic software update feature. Please refer to
5380 documentation in doc/README.update for more details.
5381
wdenk6c59edc2004-05-03 20:45:30 +00005382 autoload - if set to "no" (any string beginning with 'n'),
5383 "bootp" will just load perform a lookup of the
5384 configuration from the BOOTP server, but not try to
5385 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk6c59edc2004-05-03 20:45:30 +00005387 autostart - if set to "yes", an image loaded using the "bootp",
5388 "rarpboot", "tftpboot" or "diskboot" commands will
5389 be automatically started (by internally calling
5390 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392 If set to "no", a standalone image passed to the
5393 "bootm" command will be copied to the load address
5394 (and eventually uncompressed), but NOT be started.
5395 This can be used to load and uncompress arbitrary
5396 data.
wdenkc6097192002-11-03 00:24:07 +00005397
David A. Longd558a4e2011-07-09 16:40:19 -04005398 fdt_high - if set this restricts the maximum address that the
5399 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005400 For example, if you have a system with 1 GB memory
5401 at physical address 0x10000000, while Linux kernel
5402 only recognizes the first 704 MB as low memory, you
5403 may need to set fdt_high as 0x3C000000 to have the
5404 device tree blob be copied to the maximum address
5405 of the 704 MB low memory, so that Linux kernel can
5406 access it during the boot procedure.
5407
David A. Longd558a4e2011-07-09 16:40:19 -04005408 If this is set to the special value 0xFFFFFFFF then
5409 the fdt will not be copied at all on boot. For this
5410 to work it must reside in writable memory, have
5411 sufficient padding on the end of it for u-boot to
5412 add the information it needs into it, and the memory
5413 must be accessible by the kernel.
5414
Simon Glassdc6fa642011-10-24 19:15:34 +00005415 fdtcontroladdr- if set this is the address of the control flattened
5416 device tree used by U-Boot when CONFIG_OF_CONTROL is
5417 defined.
5418
wdenk0e2bd9c2004-06-06 21:51:03 +00005419 i2cfast - (PPC405GP|PPC405EP only)
5420 if set to 'y' configures Linux I2C driver for fast
5421 mode (400kHZ). This environment variable is used in
5422 initialization code. So, for changes to be effective
5423 it must be saved and board must be reset.
5424
wdenk6c59edc2004-05-03 20:45:30 +00005425 initrd_high - restrict positioning of initrd images:
5426 If this variable is not set, initrd images will be
5427 copied to the highest possible address in RAM; this
5428 is usually what you want since it allows for
5429 maximum initrd size. If for some reason you want to
5430 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005431 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005432 variable to a value of "no" or "off" or "0".
5433 Alternatively, you can set it to a maximum upper
5434 address to use (U-Boot will still check that it
5435 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk6c59edc2004-05-03 20:45:30 +00005437 For instance, when you have a system with 16 MB
5438 RAM, and want to reserve 4 MB from use by Linux,
5439 you can do this by adding "mem=12M" to the value of
5440 the "bootargs" variable. However, now you must make
5441 sure that the initrd image is placed in the first
5442 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005445
wdenk6c59edc2004-05-03 20:45:30 +00005446 If you set initrd_high to 0xFFFFFFFF, this is an
5447 indication to U-Boot that all addresses are legal
5448 for the Linux kernel, including addresses in flash
5449 memory. In this case U-Boot will NOT COPY the
5450 ramdisk at all. This may be useful to reduce the
5451 boot time on your system, but requires that this
5452 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005453
wdenk6c59edc2004-05-03 20:45:30 +00005454 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005455
wdenk6c59edc2004-05-03 20:45:30 +00005456 loadaddr - Default load address for commands like "bootp",
5457 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005462
wdenk6c59edc2004-05-03 20:45:30 +00005463 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk6c59edc2004-05-03 20:45:30 +00005465 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005466
wdenk6c59edc2004-05-03 20:45:30 +00005467 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005468
Mike Frysingera23230c2011-10-02 10:01:27 +00005469 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005470
Mike Frysingera23230c2011-10-02 10:01:27 +00005471 ethact - controls which interface is currently active.
5472 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005473
Heiko Schocherc5e84052010-07-20 17:45:02 +02005474 => setenv ethact FEC
5475 => ping 192.168.0.1 # traffic sent on FEC
5476 => setenv ethact SCC
5477 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005478
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005479 ethrotate - When set to "no" U-Boot does not go through all
5480 available network interfaces.
5481 It just stays at the currently selected interface.
5482
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005483 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005484 either succeed or fail without retrying.
5485 When set to "once" the network operation will
5486 fail when all the available network interfaces
5487 are tried once without success.
5488 Useful on scripts which control the retry operation
5489 themselves.
wdenkc6097192002-11-03 00:24:07 +00005490
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005491 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005492
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005493 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005494 changing the console to be empty. If "yes" it will be
5495 made silent. If "no" it will not be made silent. If
5496 unset, then it will be made silent if the U-Boot console
5497 is silent.
5498
Wolfgang Denk227b5192005-09-24 23:25:46 +02005499 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005500 UDP source port.
5501
Wolfgang Denk227b5192005-09-24 23:25:46 +02005502 tftpdstport - If this is set, the value is used for TFTP's UDP
5503 destination port instead of the Well Know Port 69.
5504
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005505 tftpblocksize - Block size to use for TFTP transfers; if not set,
5506 we use the TFTP server's default block size
5507
5508 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5509 seconds, minimum value is 1000 = 1 second). Defines
5510 when a packet is considered to be lost so it has to
5511 be retransmitted. The default is 5000 = 5 seconds.
5512 Lowering this value may make downloads succeed
5513 faster in networks with high packet loss rates or
5514 with unreliable TFTP servers.
5515
5516 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005517 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005518 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005519
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005520The following image location variables contain the location of images
5521used in booting. The "Image" column gives the role of the image and is
5522not an environment variable name. The other columns are environment
5523variable names. "File Name" gives the name of the file on a TFTP
5524server, "RAM Address" gives the location in RAM the image will be
5525loaded to, and "Flash Location" gives the image's address in NOR
5526flash or offset in NAND flash.
5527
5528*Note* - these variables don't have to be defined for all boards, some
5529boards currenlty use other variables for these purposes, and some
5530boards use these variables for other purposes.
5531
Wolfgang Denk092ae952011-10-26 10:21:21 +00005532Image File Name RAM Address Flash Location
5533----- --------- ----------- --------------
5534u-boot u-boot u-boot_addr_r u-boot_addr
5535Linux kernel bootfile kernel_addr_r kernel_addr
5536device tree blob fdtfile fdt_addr_r fdt_addr
5537ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539The following environment variables may be used and automatically
5540updated by the network boot commands ("bootp" and "rarpboot"),
5541depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543 bootfile - see above
5544 dnsip - IP address of your Domain Name Server
5545 dnsip2 - IP address of your secondary Domain Name Server
5546 gatewayip - IP address of the Gateway (Router) to use
5547 hostname - Target hostname
5548 ipaddr - see above
5549 netmask - Subnet Mask
5550 rootpath - Pathname of the root filesystem on the NFS server
5551 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005552
wdenk145d2c12004-04-15 21:48:45 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556 serial# - contains hardware identification information such
5557 as type string and/or serial number
5558 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560These variables can be set only once (usually during manufacturing of
5561the board). U-Boot refuses to delete or overwrite these variables
5562once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005563
5564
wdenk6c59edc2004-05-03 20:45:30 +00005565Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005566
wdenk6c59edc2004-05-03 20:45:30 +00005567 ver - Contains the U-Boot version string as printed
5568 with the "version" command. This variable is
5569 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005570
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk6c59edc2004-05-03 20:45:30 +00005572Please note that changes to some configuration parameters may take
5573only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005574
stroeseb9c17c52003-04-04 15:53:41 +00005575
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005576Callback functions for environment variables:
5577---------------------------------------------
5578
5579For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005580when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005581be associated with arbitrary variables. On creation, overwrite, or
5582deletion, the callback will provide the opportunity for some side
5583effect to happen or for the change to be rejected.
5584
5585The callbacks are named and associated with a function using the
5586U_BOOT_ENV_CALLBACK macro in your board or driver code.
5587
5588These callbacks are associated with variables in one of two ways. The
5589static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5590in the board configuration to a string that defines a list of
5591associations. The list must be in the following format:
5592
5593 entry = variable_name[:callback_name]
5594 list = entry[,list]
5595
5596If the callback name is not specified, then the callback is deleted.
5597Spaces are also allowed anywhere in the list.
5598
5599Callbacks can also be associated by defining the ".callbacks" variable
5600with the same list format above. Any association in ".callbacks" will
5601override any association in the static list. You can define
5602CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005603".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005604
5605
wdenk6c59edc2004-05-03 20:45:30 +00005606Command Line Parsing:
5607=====================
stroeseb9c17c52003-04-04 15:53:41 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609There are two different command line parsers available with U-Boot:
5610the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612Old, simple command line parser:
5613--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615- supports environment variables (through setenv / saveenv commands)
5616- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005617- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005618- special characters ('$', ';') can be escaped by prefixing with '\',
5619 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005620 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005621- You can also escape text by enclosing in single apostrophes, for example:
5622 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624Hush shell:
5625-----------
wdenkf4688a22003-05-28 08:06:31 +00005626
wdenk6c59edc2004-05-03 20:45:30 +00005627- similar to Bourne shell, with control structures like
5628 if...then...else...fi, for...do...done; while...do...done,
5629 until...do...done, ...
5630- supports environment ("global") variables (through setenv / saveenv
5631 commands) and local shell variables (through standard shell syntax
5632 "name=value"); only environment variables can be used with "run"
5633 command
wdenkf4688a22003-05-28 08:06:31 +00005634
wdenk6c59edc2004-05-03 20:45:30 +00005635General rules:
5636--------------
wdenkf4688a22003-05-28 08:06:31 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638(1) If a command line (or an environment variable executed by a "run"
5639 command) contains several commands separated by semicolon, and
5640 one of these commands fails, then the remaining commands will be
5641 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005642
wdenk6c59edc2004-05-03 20:45:30 +00005643(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005644 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005645 command will cause "run" to terminate, i. e. the remaining
5646 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648Note for Redundant Ethernet Interfaces:
5649=======================================
wdenkf4688a22003-05-28 08:06:31 +00005650
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005651Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005652such configurations and is capable of automatic selection of a
5653"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005654
wdenk6c59edc2004-05-03 20:45:30 +00005655Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5656MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5657"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659If the network interface stores some valid MAC address (for instance
5660in SROM), this is used as default address if there is NO correspon-
5661ding setting in the environment; if the corresponding environment
5662variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664o If the SROM has a valid MAC address, and there is no address in the
5665 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667o If there is no valid address in the SROM, and a definition in the
5668 environment exists, then the value from the environment variable is
5669 used.
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk6c59edc2004-05-03 20:45:30 +00005671o If both the SROM and the environment contain a MAC address, and
5672 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk6c59edc2004-05-03 20:45:30 +00005674o If both the SROM and the environment contain a MAC address, and the
5675 addresses differ, the value from the environment is used and a
5676 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678o If neither SROM nor the environment contain a MAC address, an error
5679 is raised.
wdenkc6097192002-11-03 00:24:07 +00005680
Ben Warren6db991a2010-04-26 11:11:46 -07005681If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005682will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005683may be skipped by setting the appropriate 'ethmacskip' environment variable.
5684The naming convention is as follows:
5685"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687Image Formats:
5688==============
wdenkc6097192002-11-03 00:24:07 +00005689
Marian Balakowicz18710b82008-03-12 12:13:13 +01005690U-Boot is capable of booting (and performing other auxiliary operations on)
5691images in two formats:
5692
5693New uImage format (FIT)
5694-----------------------
5695
5696Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5697to Flattened Device Tree). It allows the use of images with multiple
5698components (several kernels, ramdisks, etc.), with contents protected by
5699SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5700
5701
5702Old uImage format
5703-----------------
5704
5705Old image format is based on binary files which can be basically anything,
5706preceded by a special header; see the definitions in include/image.h for
5707details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5710 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005711 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5712 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5713 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005714* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005715 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5716 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005717* Compression Type (uncompressed, gzip, bzip2)
5718* Load Address
5719* Entry Point
5720* Image Name
5721* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk6c59edc2004-05-03 20:45:30 +00005723The header is marked by a special Magic Number, and both the header
5724and the data portions of the image are secured against corruption by
5725CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005726
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728Linux Support:
5729==============
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731Although U-Boot should support any OS or standalone application
5732easily, the main focus has always been on Linux during the design of
5733U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735U-Boot includes many features that so far have been part of some
5736special "boot loader" code within the Linux kernel. Also, any
5737"initrd" images to be used are no longer part of one big Linux image;
5738instead, kernel and "initrd" are separate images. This implementation
5739serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741- the same features can be used for other OS or standalone
5742 applications (for instance: using compressed images to reduce the
5743 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745- it becomes much easier to port new Linux kernel versions because
5746 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748- the same Linux kernel image can now be used with different "initrd"
5749 images; of course this also means that different kernel images can
5750 be run with the same "initrd". This makes testing easier (you don't
5751 have to build a new "zImage.initrd" Linux image when you just
5752 change a file in your "initrd"). Also, a field-upgrade of the
5753 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005754
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756Linux HOWTO:
5757============
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk6c59edc2004-05-03 20:45:30 +00005759Porting Linux to U-Boot based systems:
5760---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762U-Boot cannot save you from doing all the necessary modifications to
5763configure the Linux device drivers for use with your target hardware
5764(no, we don't intend to provide a full virtual machine interface to
5765Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005766
Stefan Roese88fbf932010-04-15 16:07:28 +02005767But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769Just make sure your machine specific header file (for instance
5770include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005771Information structure as we define in include/asm-<arch>/u-boot.h,
5772and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005773as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005774
Simon Glassd097e592014-06-11 23:29:46 -06005775Note that U-Boot now has a driver model, a unified model for drivers.
5776If you are adding a new driver, plumb it into driver model. If there
5777is no uclass available, you are encouraged to create one. See
5778doc/driver-model.
5779
wdenkc6097192002-11-03 00:24:07 +00005780
wdenk6c59edc2004-05-03 20:45:30 +00005781Configuring the Linux kernel:
5782-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784No specific requirements for U-Boot. Make sure you have some root
5785device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005786
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788Building a Linux Image:
5789-----------------------
wdenkc6097192002-11-03 00:24:07 +00005790
wdenk6c59edc2004-05-03 20:45:30 +00005791With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5792not used. If you use recent kernel source, a new build target
5793"uImage" will exist which automatically builds an image usable by
5794U-Boot. Most older kernels also have support for a "pImage" target,
5795which was introduced for our predecessor project PPCBoot and uses a
5796100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005797
wdenk6c59edc2004-05-03 20:45:30 +00005798Example:
wdenkc6097192002-11-03 00:24:07 +00005799
Holger Freyther7ba4e572014-08-04 09:26:05 +02005800 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005801 make oldconfig
5802 make dep
5803 make uImage
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk6c59edc2004-05-03 20:45:30 +00005805The "uImage" build target uses a special tool (in 'tools/mkimage') to
5806encapsulate a compressed Linux kernel image with header information,
5807CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk6c59edc2004-05-03 20:45:30 +00005811* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813 ${CROSS_COMPILE}-objcopy -O binary \
5814 -R .note -R .comment \
5815 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005818
wdenk6c59edc2004-05-03 20:45:30 +00005819 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005820
wdenk6c59edc2004-05-03 20:45:30 +00005821* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005822
wdenk6c59edc2004-05-03 20:45:30 +00005823 mkimage -A ppc -O linux -T kernel -C gzip \
5824 -a 0 -e 0 -n "Linux Kernel Image" \
5825 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005826
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk6c59edc2004-05-03 20:45:30 +00005828The "mkimage" tool can also be used to create ramdisk images for use
5829with U-Boot, either separated from the Linux kernel image, or
5830combined into one file. "mkimage" encapsulates the images with a 64
5831byte header containing information about target architecture,
5832operating system, image type, compression method, entry points, time
5833stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835"mkimage" can be called in two ways: to verify existing images and
5836print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005837
wdenk6c59edc2004-05-03 20:45:30 +00005838In the first form (with "-l" option) mkimage lists the information
5839contained in the header of an existing U-Boot image; this includes
5840checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842 tools/mkimage -l image
5843 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845The second form (with "-d" option) is used to build a U-Boot image
5846from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005847
wdenk6c59edc2004-05-03 20:45:30 +00005848 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5849 -n name -d data_file image
5850 -A ==> set architecture to 'arch'
5851 -O ==> set operating system to 'os'
5852 -T ==> set image type to 'type'
5853 -C ==> set compression type 'comp'
5854 -a ==> set load address to 'addr' (hex)
5855 -e ==> set entry point to 'ep' (hex)
5856 -n ==> set image name to 'name'
5857 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005858
wdenkcd914452004-05-29 16:53:29 +00005859Right now, all Linux kernels for PowerPC systems use the same load
5860address (0x00000000), but the entry point address depends on the
5861kernel version:
wdenkc6097192002-11-03 00:24:07 +00005862
wdenk6c59edc2004-05-03 20:45:30 +00005863- 2.2.x kernels have the entry point at 0x0000000C,
5864- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005865
wdenk6c59edc2004-05-03 20:45:30 +00005866So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005867
wdenk6c59edc2004-05-03 20:45:30 +00005868 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5869 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005870 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005871 > examples/uImage.TQM850L
5872 Image Name: 2.4.4 kernel for TQM850L
5873 Created: Wed Jul 19 02:34:59 2000
5874 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5875 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5876 Load Address: 0x00000000
5877 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk6c59edc2004-05-03 20:45:30 +00005879To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881 -> tools/mkimage -l examples/uImage.TQM850L
5882 Image Name: 2.4.4 kernel for TQM850L
5883 Created: Wed Jul 19 02:34:59 2000
5884 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5885 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5886 Load Address: 0x00000000
5887 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005888
wdenk6c59edc2004-05-03 20:45:30 +00005889NOTE: for embedded systems where boot time is critical you can trade
5890speed for memory and install an UNCOMPRESSED image instead: this
5891needs more space in Flash, but boots much faster since it does not
5892need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005893
Stefan Roese88fbf932010-04-15 16:07:28 +02005894 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005895 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5896 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005897 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005898 > examples/uImage.TQM850L-uncompressed
5899 Image Name: 2.4.4 kernel for TQM850L
5900 Created: Wed Jul 19 02:34:59 2000
5901 Image Type: PowerPC Linux Kernel Image (uncompressed)
5902 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5903 Load Address: 0x00000000
5904 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005905
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5908when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk6c59edc2004-05-03 20:45:30 +00005910 -> tools/mkimage -n 'Simple Ramdisk Image' \
5911 > -A ppc -O linux -T ramdisk -C gzip \
5912 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5913 Image Name: Simple Ramdisk Image
5914 Created: Wed Jan 12 14:01:50 2000
5915 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5916 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5917 Load Address: 0x00000000
5918 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005919
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005920The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5921option performs the converse operation of the mkimage's second form (the "-d"
5922option). Given an image built by mkimage, the dumpimage extracts a "data file"
5923from the image:
5924
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005925 tools/dumpimage -i image -T type -p position data_file
5926 -i ==> extract from the 'image' a specific 'data_file'
5927 -T ==> set image type to 'type'
5928 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005929
wdenkc6097192002-11-03 00:24:07 +00005930
wdenk6c59edc2004-05-03 20:45:30 +00005931Installing a Linux Image:
5932-------------------------
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk6c59edc2004-05-03 20:45:30 +00005934To downloading a U-Boot image over the serial (console) interface,
5935you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk6c59edc2004-05-03 20:45:30 +00005939The 'objcopy' does not understand the information in the U-Boot
5940image header, so the resulting S-Record file will be relative to
5941address 0x00000000. To load it to a given address, you need to
5942specify the target address as 'offset' parameter with the 'loads'
5943command.
wdenkc6097192002-11-03 00:24:07 +00005944
wdenk6c59edc2004-05-03 20:45:30 +00005945Example: install the image to address 0x40100000 (which on the
5946TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk6c59edc2004-05-03 20:45:30 +00005948 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005949
wdenk6c59edc2004-05-03 20:45:30 +00005950 .......... done
5951 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk6c59edc2004-05-03 20:45:30 +00005953 => loads 40100000
5954 ## Ready for S-Record download ...
5955 ~>examples/image.srec
5956 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5957 ...
5958 15989 15990 15991 15992
5959 [file transfer complete]
5960 [connected]
5961 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005962
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk6c59edc2004-05-03 20:45:30 +00005964You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005965this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005966corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970 ## Checking Image at 40100000 ...
5971 Image Name: 2.2.13 for initrd on TQM850L
5972 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5973 Data Size: 335725 Bytes = 327 kB = 0 MB
5974 Load Address: 00000000
5975 Entry Point: 0000000c
5976 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005977
5978
wdenk6c59edc2004-05-03 20:45:30 +00005979Boot Linux:
5980-----------
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk6c59edc2004-05-03 20:45:30 +00005982The "bootm" command is used to boot an application that is stored in
5983memory (RAM or Flash). In case of a Linux kernel image, the contents
5984of the "bootargs" environment variable is passed to the kernel as
5985parameters. You can check and modify this variable using the
5986"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005987
wdenkc6097192002-11-03 00:24:07 +00005988
wdenk6c59edc2004-05-03 20:45:30 +00005989 => printenv bootargs
5990 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005991
wdenk6c59edc2004-05-03 20:45:30 +00005992 => 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 +00005993
wdenk6c59edc2004-05-03 20:45:30 +00005994 => printenv bootargs
5995 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 +00005996
wdenk6c59edc2004-05-03 20:45:30 +00005997 => bootm 40020000
5998 ## Booting Linux kernel at 40020000 ...
5999 Image Name: 2.2.13 for NFS on TQM850L
6000 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6001 Data Size: 381681 Bytes = 372 kB = 0 MB
6002 Load Address: 00000000
6003 Entry Point: 0000000c
6004 Verifying Checksum ... OK
6005 Uncompressing Kernel Image ... OK
6006 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
6007 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6008 time_init: decrementer frequency = 187500000/60
6009 Calibrating delay loop... 49.77 BogoMIPS
6010 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6011 ...
wdenkc6097192002-11-03 00:24:07 +00006012
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006013If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00006014the memory addresses of both the kernel and the initrd image (PPBCOOT
6015format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00006016
wdenk6c59edc2004-05-03 20:45:30 +00006017 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006018
wdenk6c59edc2004-05-03 20:45:30 +00006019 ## Checking Image at 40100000 ...
6020 Image Name: 2.2.13 for initrd on TQM850L
6021 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6022 Data Size: 335725 Bytes = 327 kB = 0 MB
6023 Load Address: 00000000
6024 Entry Point: 0000000c
6025 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006026
wdenk6c59edc2004-05-03 20:45:30 +00006027 ## Checking Image at 40200000 ...
6028 Image Name: Simple Ramdisk Image
6029 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6030 Data Size: 566530 Bytes = 553 kB = 0 MB
6031 Load Address: 00000000
6032 Entry Point: 00000000
6033 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006034
wdenk6c59edc2004-05-03 20:45:30 +00006035 => bootm 40100000 40200000
6036 ## Booting Linux kernel at 40100000 ...
6037 Image Name: 2.2.13 for initrd on TQM850L
6038 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6039 Data Size: 335725 Bytes = 327 kB = 0 MB
6040 Load Address: 00000000
6041 Entry Point: 0000000c
6042 Verifying Checksum ... OK
6043 Uncompressing Kernel Image ... OK
6044 ## Loading RAMDisk Image at 40200000 ...
6045 Image Name: Simple Ramdisk Image
6046 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6047 Data Size: 566530 Bytes = 553 kB = 0 MB
6048 Load Address: 00000000
6049 Entry Point: 00000000
6050 Verifying Checksum ... OK
6051 Loading Ramdisk ... OK
6052 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
6053 Boot arguments: root=/dev/ram
6054 time_init: decrementer frequency = 187500000/60
6055 Calibrating delay loop... 49.77 BogoMIPS
6056 ...
6057 RAMDISK: Compressed image found at block 0
6058 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006059
wdenk6c59edc2004-05-03 20:45:30 +00006060 bash#
wdenkc6097192002-11-03 00:24:07 +00006061
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006062Boot Linux and pass a flat device tree:
6063-----------
6064
6065First, U-Boot must be compiled with the appropriate defines. See the section
6066titled "Linux Kernel Interface" above for a more in depth explanation. The
6067following is an example of how to start a kernel and pass an updated
6068flat device tree:
6069
6070=> print oftaddr
6071oftaddr=0x300000
6072=> print oft
6073oft=oftrees/mpc8540ads.dtb
6074=> tftp $oftaddr $oft
6075Speed: 1000, full duplex
6076Using TSEC0 device
6077TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6078Filename 'oftrees/mpc8540ads.dtb'.
6079Load address: 0x300000
6080Loading: #
6081done
6082Bytes transferred = 4106 (100a hex)
6083=> tftp $loadaddr $bootfile
6084Speed: 1000, full duplex
6085Using TSEC0 device
6086TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6087Filename 'uImage'.
6088Load address: 0x200000
6089Loading:############
6090done
6091Bytes transferred = 1029407 (fb51f hex)
6092=> print loadaddr
6093loadaddr=200000
6094=> print oftaddr
6095oftaddr=0x300000
6096=> bootm $loadaddr - $oftaddr
6097## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006098 Image Name: Linux-2.6.17-dirty
6099 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6100 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006101 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006102 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006103 Verifying Checksum ... OK
6104 Uncompressing Kernel Image ... OK
6105Booting using flat device tree at 0x300000
6106Using MPC85xx ADS machine description
6107Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6108[snip]
6109
6110
wdenk6c59edc2004-05-03 20:45:30 +00006111More About U-Boot Image Types:
6112------------------------------
wdenkc6097192002-11-03 00:24:07 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006115
wdenk6c59edc2004-05-03 20:45:30 +00006116 "Standalone Programs" are directly runnable in the environment
6117 provided by U-Boot; it is expected that (if they behave
6118 well) you can continue to work in U-Boot after return from
6119 the Standalone Program.
6120 "OS Kernel Images" are usually images of some Embedded OS which
6121 will take over control completely. Usually these programs
6122 will install their own set of exception handlers, device
6123 drivers, set up the MMU, etc. - this means, that you cannot
6124 expect to re-enter U-Boot except by resetting the CPU.
6125 "RAMDisk Images" are more or less just data blocks, and their
6126 parameters (address, size) are passed to an OS kernel that is
6127 being started.
6128 "Multi-File Images" contain several images, typically an OS
6129 (Linux) kernel image and one or more data images like
6130 RAMDisks. This construct is useful for instance when you want
6131 to boot over the network using BOOTP etc., where the boot
6132 server provides just a single image file, but you want to get
6133 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006134
wdenk6c59edc2004-05-03 20:45:30 +00006135 "Multi-File Images" start with a list of image sizes, each
6136 image size (in bytes) specified by an "uint32_t" in network
6137 byte order. This list is terminated by an "(uint32_t)0".
6138 Immediately after the terminating 0 follow the images, one by
6139 one, all aligned on "uint32_t" boundaries (size rounded up to
6140 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006141
wdenk6c59edc2004-05-03 20:45:30 +00006142 "Firmware Images" are binary images containing firmware (like
6143 U-Boot or FPGA images) which usually will be programmed to
6144 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006145
wdenk6c59edc2004-05-03 20:45:30 +00006146 "Script files" are command sequences that will be executed by
6147 U-Boot's command interpreter; this feature is especially
6148 useful when you configure U-Boot to use a real shell (hush)
6149 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006150
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006151Booting the Linux zImage:
6152-------------------------
6153
6154On some platforms, it's possible to boot Linux zImage. This is done
6155using the "bootz" command. The syntax of "bootz" command is the same
6156as the syntax of "bootm" command.
6157
Tom Rini45f46d12013-05-16 11:40:11 -04006158Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006159kernel with raw initrd images. The syntax is slightly different, the
6160address of the initrd must be augmented by it's size, in the following
6161format: "<initrd addres>:<initrd size>".
6162
stroeseb9c17c52003-04-04 15:53:41 +00006163
wdenk6c59edc2004-05-03 20:45:30 +00006164Standalone HOWTO:
6165=================
stroeseb9c17c52003-04-04 15:53:41 +00006166
wdenk6c59edc2004-05-03 20:45:30 +00006167One of the features of U-Boot is that you can dynamically load and
6168run "standalone" applications, which can use some resources of
6169U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006172
wdenk6c59edc2004-05-03 20:45:30 +00006173"Hello World" Demo:
6174-------------------
wdenkc6097192002-11-03 00:24:07 +00006175
wdenk6c59edc2004-05-03 20:45:30 +00006176'examples/hello_world.c' contains a small "Hello World" Demo
6177application; it is automatically compiled when you build U-Boot.
6178It's configured to run at address 0x00040004, so you can play with it
6179like that:
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk6c59edc2004-05-03 20:45:30 +00006181 => loads
6182 ## Ready for S-Record download ...
6183 ~>examples/hello_world.srec
6184 1 2 3 4 5 6 7 8 9 10 11 ...
6185 [file transfer complete]
6186 [connected]
6187 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006188
wdenk6c59edc2004-05-03 20:45:30 +00006189 => go 40004 Hello World! This is a test.
6190 ## Starting application at 0x00040004 ...
6191 Hello World
6192 argc = 7
6193 argv[0] = "40004"
6194 argv[1] = "Hello"
6195 argv[2] = "World!"
6196 argv[3] = "This"
6197 argv[4] = "is"
6198 argv[5] = "a"
6199 argv[6] = "test."
6200 argv[7] = "<NULL>"
6201 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006202
wdenk6c59edc2004-05-03 20:45:30 +00006203 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk6c59edc2004-05-03 20:45:30 +00006205Another example, which demonstrates how to register a CPM interrupt
6206handler with the U-Boot code, can be found in 'examples/timer.c'.
6207Here, a CPM timer is set up to generate an interrupt every second.
6208The interrupt service routine is trivial, just printing a '.'
6209character, but this is just a demo program. The application can be
6210controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006211
wdenk6c59edc2004-05-03 20:45:30 +00006212 ? - print current values og the CPM Timer registers
6213 b - enable interrupts and start timer
6214 e - stop timer and disable interrupts
6215 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006216
wdenk6c59edc2004-05-03 20:45:30 +00006217 => loads
6218 ## Ready for S-Record download ...
6219 ~>examples/timer.srec
6220 1 2 3 4 5 6 7 8 9 10 11 ...
6221 [file transfer complete]
6222 [connected]
6223 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006224
wdenk6c59edc2004-05-03 20:45:30 +00006225 => go 40004
6226 ## Starting application at 0x00040004 ...
6227 TIMERS=0xfff00980
6228 Using timer 1
6229 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006230
wdenk6c59edc2004-05-03 20:45:30 +00006231Hit 'b':
6232 [q, b, e, ?] Set interval 1000000 us
6233 Enabling timer
6234Hit '?':
6235 [q, b, e, ?] ........
6236 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6237Hit '?':
6238 [q, b, e, ?] .
6239 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6240Hit '?':
6241 [q, b, e, ?] .
6242 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6243Hit '?':
6244 [q, b, e, ?] .
6245 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6246Hit 'e':
6247 [q, b, e, ?] ...Stopping timer
6248Hit 'q':
6249 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006250
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk6c59edc2004-05-03 20:45:30 +00006252Minicom warning:
6253================
wdenkc6097192002-11-03 00:24:07 +00006254
wdenk6c59edc2004-05-03 20:45:30 +00006255Over time, many people have reported problems when trying to use the
6256"minicom" terminal emulation program for serial download. I (wd)
6257consider minicom to be broken, and recommend not to use it. Under
6258Unix, I recommend to use C-Kermit for general purpose use (and
6259especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006260use "cu" for S-Record download ("loads" command). See
6261http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6262for help with kermit.
6263
wdenkc6097192002-11-03 00:24:07 +00006264
wdenk6c59edc2004-05-03 20:45:30 +00006265Nevertheless, if you absolutely want to use it try adding this
6266configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006267
wdenk6c59edc2004-05-03 20:45:30 +00006268 Name Program Name U/D FullScr IO-Red. Multi
6269 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6270 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006271
wdenk8dba0502003-03-31 16:34:49 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273NetBSD Notes:
6274=============
wdenkc6097192002-11-03 00:24:07 +00006275
wdenk6c59edc2004-05-03 20:45:30 +00006276Starting at version 0.9.2, U-Boot supports NetBSD both as host
6277(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006278
wdenk6c59edc2004-05-03 20:45:30 +00006279Building requires a cross environment; it is known to work on
6280NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6281need gmake since the Makefiles are not compatible with BSD make).
6282Note that the cross-powerpc package does not install include files;
6283attempting to build U-Boot will fail because <machine/ansi.h> is
6284missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006285
wdenk6c59edc2004-05-03 20:45:30 +00006286 # cd /usr/pkg/cross/powerpc-netbsd/include
6287 # mkdir powerpc
6288 # ln -s powerpc machine
6289 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6290 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006291
wdenk6c59edc2004-05-03 20:45:30 +00006292Native builds *don't* work due to incompatibilities between native
6293and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006294
wdenk6c59edc2004-05-03 20:45:30 +00006295Booting assumes that (the first part of) the image booted is a
6296stage-2 loader which in turn loads and then invokes the kernel
6297proper. Loader sources will eventually appear in the NetBSD source
6298tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006299meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006300
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302Implementation Internals:
6303=========================
wdenkc6097192002-11-03 00:24:07 +00006304
wdenk6c59edc2004-05-03 20:45:30 +00006305The following is not intended to be a complete description of every
6306implementation detail. However, it should help to understand the
6307inner workings of U-Boot and make it easier to port it to custom
6308hardware.
wdenkc6097192002-11-03 00:24:07 +00006309
wdenkc6097192002-11-03 00:24:07 +00006310
wdenk6c59edc2004-05-03 20:45:30 +00006311Initial Stack, Global Data:
6312---------------------------
wdenkc6097192002-11-03 00:24:07 +00006313
wdenk6c59edc2004-05-03 20:45:30 +00006314The implementation of U-Boot is complicated by the fact that U-Boot
6315starts running out of ROM (flash memory), usually without access to
6316system RAM (because the memory controller is not initialized yet).
6317This means that we don't have writable Data or BSS segments, and BSS
6318is not initialized as zero. To be able to get a C environment working
6319at all, we have to allocate at least a minimal stack. Implementation
6320options for this are defined and restricted by the CPU used: Some CPU
6321models provide on-chip memory (like the IMMR area on MPC8xx and
6322MPC826x processors), on others (parts of) the data cache can be
6323locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006324
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006325 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006326 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006327
wdenk6c59edc2004-05-03 20:45:30 +00006328 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6329 From: "Chris Hallinan" <clh@net1plus.com>
6330 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6331 ...
wdenkc6097192002-11-03 00:24:07 +00006332
wdenk6c59edc2004-05-03 20:45:30 +00006333 Correct me if I'm wrong, folks, but the way I understand it
6334 is this: Using DCACHE as initial RAM for Stack, etc, does not
6335 require any physical RAM backing up the cache. The cleverness
6336 is that the cache is being used as a temporary supply of
6337 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006338 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006339 can see how this works by studying the cache architecture and
6340 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006341
wdenk6c59edc2004-05-03 20:45:30 +00006342 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6343 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006344 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006345 option should work for you. Using CS 4 should be fine if your
6346 board designers haven't used it for something that would
6347 cause you grief during the initial boot! It is frequently not
6348 used.
wdenkc6097192002-11-03 00:24:07 +00006349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006350 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006351 with your processor/board/system design. The default value
6352 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006353 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006354 than your SDRAM module. If you have a 64MB SDRAM module, set
6355 it above 400_0000. Just make sure your board has no resources
6356 that are supposed to respond to that address! That code in
6357 start.S has been around a while and should work as is when
6358 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006359
wdenk6c59edc2004-05-03 20:45:30 +00006360 -Chris Hallinan
6361 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363It is essential to remember this, since it has some impact on the C
6364code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006365
wdenk6c59edc2004-05-03 20:45:30 +00006366* Initialized global data (data segment) is read-only. Do not attempt
6367 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006368
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006369* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006370 as zero data - BSS segment) at all - this is undefined, initiali-
6371 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006372
wdenk6c59edc2004-05-03 20:45:30 +00006373* Stack space is very limited. Avoid big data buffers or things like
6374 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006375
wdenk6c59edc2004-05-03 20:45:30 +00006376Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006377normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006378turned out that the implementation of U-Boot can be greatly
6379simplified by making a global data structure (gd_t) available to all
6380functions. We could pass a pointer to this data as argument to _all_
6381functions, but this would bloat the code. Instead we use a feature of
6382the GCC compiler (Global Register Variables) to share the data: we
6383place a pointer (gd) to the global data into a register which we
6384reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006385
wdenk6c59edc2004-05-03 20:45:30 +00006386When choosing a register for such a purpose we are restricted by the
6387relevant (E)ABI specifications for the current architecture, and by
6388GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006389
wdenk6c59edc2004-05-03 20:45:30 +00006390For PowerPC, the following registers have specific use:
6391 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006392 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006393 R3-R4: parameter passing and return values
6394 R5-R10: parameter passing
6395 R13: small data area pointer
6396 R30: GOT pointer
6397 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006398
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006399 (U-Boot also uses R12 as internal GOT pointer. r12
6400 is a volatile register so r12 needs to be reset when
6401 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006402
Wolfgang Denk69c09642008-02-14 22:43:22 +01006403 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006404
wdenk6c59edc2004-05-03 20:45:30 +00006405 Note: on PPC, we could use a static initializer (since the
6406 address of the global data structure is known at compile time),
6407 but it turned out that reserving a register results in somewhat
6408 smaller code - although the code savings are not that big (on
6409 average for all boards 752 bytes for the whole U-Boot image,
6410 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006411
Robin Getz2773d5f2009-08-17 15:23:02 +00006412On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006413 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6414
Robin Getz2773d5f2009-08-17 15:23:02 +00006415 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006416
wdenk6c59edc2004-05-03 20:45:30 +00006417On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006418
wdenk6c59edc2004-05-03 20:45:30 +00006419 R0: function argument word/integer result
6420 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006421 R9: platform specific
6422 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006423 R11: argument (frame) pointer
6424 R12: temporary workspace
6425 R13: stack pointer
6426 R14: link register
6427 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006428
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006429 ==> U-Boot will use R9 to hold a pointer to the global data
6430
6431 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006432
Thomas Chou8fa38582010-05-21 11:08:03 +08006433On Nios II, the ABI is documented here:
6434 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6435
6436 ==> U-Boot will use gp to hold a pointer to the global data
6437
6438 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6439 to access small data sections, so gp is free.
6440
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006441On NDS32, the following registers are used:
6442
6443 R0-R1: argument/return
6444 R2-R5: argument
6445 R15: temporary register for assembler
6446 R16: trampoline register
6447 R28: frame pointer (FP)
6448 R29: global pointer (GP)
6449 R30: link register (LP)
6450 R31: stack pointer (SP)
6451 PC: program counter (PC)
6452
6453 ==> U-Boot will use R10 to hold a pointer to the global data
6454
Wolfgang Denk6405a152006-03-31 18:32:53 +02006455NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6456or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006457
wdenk6c59edc2004-05-03 20:45:30 +00006458Memory Management:
6459------------------
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk6c59edc2004-05-03 20:45:30 +00006461U-Boot runs in system state and uses physical addresses, i.e. the
6462MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006463
wdenk6c59edc2004-05-03 20:45:30 +00006464The available memory is mapped to fixed addresses using the memory
6465controller. In this process, a contiguous block is formed for each
6466memory type (Flash, SDRAM, SRAM), even when it consists of several
6467physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006468
wdenk6c59edc2004-05-03 20:45:30 +00006469U-Boot is installed in the first 128 kB of the first Flash bank (on
6470TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6471booting and sizing and initializing DRAM, the code relocates itself
6472to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006473memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006474configuration setting]. Below that, a structure with global Board
6475Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006476
wdenk6c59edc2004-05-03 20:45:30 +00006477Additionally, some exception handler code is copied to the low 8 kB
6478of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006479
wdenk6c59edc2004-05-03 20:45:30 +00006480So a typical memory configuration with 16 MB of DRAM could look like
6481this:
wdenkc6097192002-11-03 00:24:07 +00006482
wdenk6c59edc2004-05-03 20:45:30 +00006483 0x0000 0000 Exception Vector code
6484 :
6485 0x0000 1FFF
6486 0x0000 2000 Free for Application Use
6487 :
6488 :
wdenkc6097192002-11-03 00:24:07 +00006489
wdenk6c59edc2004-05-03 20:45:30 +00006490 :
6491 :
6492 0x00FB FF20 Monitor Stack (Growing downward)
6493 0x00FB FFAC Board Info Data and permanent copy of global data
6494 0x00FC 0000 Malloc Arena
6495 :
6496 0x00FD FFFF
6497 0x00FE 0000 RAM Copy of Monitor Code
6498 ... eventually: LCD or video framebuffer
6499 ... eventually: pRAM (Protected RAM - unchanged by reset)
6500 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006501
wdenkc6097192002-11-03 00:24:07 +00006502
wdenk6c59edc2004-05-03 20:45:30 +00006503System Initialization:
6504----------------------
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk6c59edc2004-05-03 20:45:30 +00006506In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006507(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006508configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006509To be able to re-map memory U-Boot then jumps to its link address.
6510To be able to implement the initialization code in C, a (small!)
6511initial stack is set up in the internal Dual Ported RAM (in case CPUs
6512which provide such a feature like MPC8xx or MPC8260), or in a locked
6513part of the data cache. After that, U-Boot initializes the CPU core,
6514the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006515
wdenk6c59edc2004-05-03 20:45:30 +00006516Next, all (potentially) available memory banks are mapped using a
6517preliminary mapping. For example, we put them on 512 MB boundaries
6518(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6519on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6520programmed for SDRAM access. Using the temporary configuration, a
6521simple memory test is run that determines the size of the SDRAM
6522banks.
wdenkc6097192002-11-03 00:24:07 +00006523
wdenk6c59edc2004-05-03 20:45:30 +00006524When there is more than one SDRAM bank, and the banks are of
6525different size, the largest is mapped first. For equal size, the first
6526bank (CS2#) is mapped first. The first mapping is always for address
65270x00000000, with any additional banks following immediately to create
6528contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006529
wdenk6c59edc2004-05-03 20:45:30 +00006530Then, the monitor installs itself at the upper end of the SDRAM area
6531and allocates memory for use by malloc() and for the global Board
6532Info data; also, the exception vector code is copied to the low RAM
6533pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006534
wdenk6c59edc2004-05-03 20:45:30 +00006535Only after this relocation will you have a "normal" C environment;
6536until that you are restricted in several ways, mostly because you are
6537running from ROM, and because the code will have to be relocated to a
6538new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006539
wdenkc6097192002-11-03 00:24:07 +00006540
wdenk6c59edc2004-05-03 20:45:30 +00006541U-Boot Porting Guide:
6542----------------------
wdenkc6097192002-11-03 00:24:07 +00006543
wdenk6c59edc2004-05-03 20:45:30 +00006544[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6545list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006546
wdenkc6097192002-11-03 00:24:07 +00006547
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006548int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006549{
6550 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006551
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006552 signal(SIGALRM, no_more_time);
6553 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006554
wdenk6c59edc2004-05-03 20:45:30 +00006555 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006556 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006557 return 0;
6558 }
wdenkc6097192002-11-03 00:24:07 +00006559
wdenk6c59edc2004-05-03 20:45:30 +00006560 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006561
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006562 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006563
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006564 if (clueless)
6565 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006566
wdenk6c59edc2004-05-03 20:45:30 +00006567 while (learning) {
6568 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006569 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6570 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006571 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006572 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006573 }
wdenkc6097192002-11-03 00:24:07 +00006574
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006575 if (available_money > toLocalCurrency ($2500))
6576 Buy a BDI3000;
6577 else
wdenk6c59edc2004-05-03 20:45:30 +00006578 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006579
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006580 if (a similar board exists) { /* hopefully... */
6581 cp -a board/<similar> board/<myboard>
6582 cp include/configs/<similar>.h include/configs/<myboard>.h
6583 } else {
6584 Create your own board support subdirectory;
6585 Create your own board include/configs/<myboard>.h file;
6586 }
6587 Edit new board/<myboard> files
6588 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006589
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006590 while (!accepted) {
6591 while (!running) {
6592 do {
6593 Add / modify source code;
6594 } until (compiles);
6595 Debug;
6596 if (clueless)
6597 email("Hi, I am having problems...");
6598 }
6599 Send patch file to the U-Boot email list;
6600 if (reasonable critiques)
6601 Incorporate improvements from email list code review;
6602 else
6603 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006604 }
wdenkc6097192002-11-03 00:24:07 +00006605
wdenk6c59edc2004-05-03 20:45:30 +00006606 return 0;
6607}
wdenkc6097192002-11-03 00:24:07 +00006608
wdenk6c59edc2004-05-03 20:45:30 +00006609void no_more_time (int sig)
6610{
6611 hire_a_guru();
6612}
wdenkc6097192002-11-03 00:24:07 +00006613
wdenkc6097192002-11-03 00:24:07 +00006614
wdenk6c59edc2004-05-03 20:45:30 +00006615Coding Standards:
6616-----------------
wdenkc6097192002-11-03 00:24:07 +00006617
wdenk6c59edc2004-05-03 20:45:30 +00006618All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006619coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006620"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006621
6622Source files originating from a different project (for example the
6623MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006624reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006625sources.
wdenkc6097192002-11-03 00:24:07 +00006626
Detlev Zundelaa63d482006-09-01 15:39:02 +02006627Please note that U-Boot is implemented in C (and to some small parts in
6628Assembler); no C++ is used, so please do not use C++ style comments (//)
6629in your code.
wdenkad276f22004-01-04 16:28:35 +00006630
wdenk6c59edc2004-05-03 20:45:30 +00006631Please also stick to the following formatting rules:
6632- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006633- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006634- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006635- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006636- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006637
wdenk6c59edc2004-05-03 20:45:30 +00006638Submissions which do not conform to the standards may be returned
6639with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006640
wdenkc6097192002-11-03 00:24:07 +00006641
wdenk6c59edc2004-05-03 20:45:30 +00006642Submitting Patches:
6643-------------------
wdenkc6097192002-11-03 00:24:07 +00006644
wdenk6c59edc2004-05-03 20:45:30 +00006645Since the number of patches for U-Boot is growing, we need to
6646establish some rules. Submissions which do not conform to these rules
6647may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006648
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006649Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006650
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006651Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6652see http://lists.denx.de/mailman/listinfo/u-boot
6653
wdenk6c59edc2004-05-03 20:45:30 +00006654When you send a patch, please include the following information with
6655it:
wdenkc6097192002-11-03 00:24:07 +00006656
wdenk6c59edc2004-05-03 20:45:30 +00006657* For bug fixes: a description of the bug and how your patch fixes
6658 this bug. Please try to include a way of demonstrating that the
6659 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006660
wdenk6c59edc2004-05-03 20:45:30 +00006661* For new features: a description of the feature and your
6662 implementation.
wdenkc6097192002-11-03 00:24:07 +00006663
wdenk6c59edc2004-05-03 20:45:30 +00006664* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006665
wdenk6c59edc2004-05-03 20:45:30 +00006666* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006667
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006668* When you add support for a new board, don't forget to add a
6669 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006670
wdenk6c59edc2004-05-03 20:45:30 +00006671* If your patch adds new configuration options, don't forget to
6672 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006673
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006674* The patch itself. If you are using git (which is *strongly*
6675 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006676 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006677 the U-Boot mailing list, you will avoid most of the common problems
6678 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006679
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006680 If you cannot use git, use "diff -purN OLD NEW". If your version of
6681 diff does not support these options, then get the latest version of
6682 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006683
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006684 The current directory when running this command shall be the parent
6685 directory of the U-Boot source tree (i. e. please make sure that
6686 your patch includes sufficient directory information for the
6687 affected files).
6688
6689 We prefer patches as plain text. MIME attachments are discouraged,
6690 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006691
wdenk6c59edc2004-05-03 20:45:30 +00006692* If one logical set of modifications affects or creates several
6693 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006694
wdenk6c59edc2004-05-03 20:45:30 +00006695* Changesets that contain different, unrelated modifications shall be
6696 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006697
wdenkc6097192002-11-03 00:24:07 +00006698
wdenk6c59edc2004-05-03 20:45:30 +00006699Notes:
wdenkc6097192002-11-03 00:24:07 +00006700
wdenk6c59edc2004-05-03 20:45:30 +00006701* Before sending the patch, run the MAKEALL script on your patched
6702 source tree and make sure that no errors or warnings are reported
6703 for any of the boards.
6704
6705* Keep your modifications to the necessary minimum: A patch
6706 containing several unrelated changes or arbitrary reformats will be
6707 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006708
wdenk6c59edc2004-05-03 20:45:30 +00006709* If you modify existing code, make sure that your new code does not
6710 add to the memory footprint of the code ;-) Small is beautiful!
6711 When adding new features, these should compile conditionally only
6712 (using #ifdef), and the resulting code with the new feature
6713 disabled must not need more memory than the old code without your
6714 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006715
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006716* Remember that there is a size limit of 100 kB per message on the
6717 u-boot mailing list. Bigger patches will be moderated. If they are
6718 reasonable and not too big, they will be acknowledged. But patches
6719 bigger than the size limit should be avoided.