blob: 66770b648539701fe0fdd8b36b1076359557ddd3 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Daya269c932013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200255configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000256
257Example: For a TQM823L module type:
258
259 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-08-04 09:26:05 +0200263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000264directory according to the instructions in cogent/README.
265
266
Simon Glass53552c92014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wen20014762011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood80806962012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood80806962012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jainc73b9032013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jainc73b9032013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantiana7364af2014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sunf0626592013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun2896cb72014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun461c9392013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sunf0626592013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700505
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun29647ab2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun3a0916d2014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sunc459ae62014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
York Sun79a779b2014-08-01 15:51:00 -0700541 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
542 Number of controllers used as main memory.
543
544 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
545 Number of controllers used for other than main memory.
546
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530547 CONFIG_SYS_FSL_SEC_BE
548 Defines the SEC controller register space as Big Endian
549
550 CONFIG_SYS_FSL_SEC_LE
551 Defines the SEC controller register space as Little Endian
552
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100553- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200554 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100555
556 Defines the Monahans run mode to oscillator
557 ratio. Valid values are 8, 16, 24, 31. The core
558 frequency is this value multiplied by 13 MHz.
559
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200560 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200561
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100562 Defines the Monahans turbo mode to oscillator
563 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200564 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100565 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200566
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200567- MIPS CPU options:
568 CONFIG_SYS_INIT_SP_OFFSET
569
570 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
571 pointer. This is needed for the temporary stack before
572 relocation.
573
574 CONFIG_SYS_MIPS_CACHE_MODE
575
576 Cache operation mode for the MIPS CPU.
577 See also arch/mips/include/asm/mipsregs.h.
578 Possible values are:
579 CONF_CM_CACHABLE_NO_WA
580 CONF_CM_CACHABLE_WA
581 CONF_CM_UNCACHED
582 CONF_CM_CACHABLE_NONCOHERENT
583 CONF_CM_CACHABLE_CE
584 CONF_CM_CACHABLE_COW
585 CONF_CM_CACHABLE_CUW
586 CONF_CM_CACHABLE_ACCELERATED
587
588 CONFIG_SYS_XWAY_EBU_BOOTCFG
589
590 Special option for Lantiq XWAY SoCs for booting from NOR flash.
591 See also arch/mips/cpu/mips32/start.S.
592
593 CONFIG_XWAY_SWAP_BYTES
594
595 Enable compilation of tools/xway-swap-bytes needed for Lantiq
596 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
597 be swapped if a flash programmer is used.
598
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000599- ARM options:
600 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
601
602 Select high exception vectors of the ARM core, e.g., do not
603 clear the V bit of the c1 register of CP15.
604
Aneesh Vb8e40802012-03-08 07:20:19 +0000605 CONFIG_SYS_THUMB_BUILD
606
607 Use this flag to build U-Boot using the Thumb instruction
608 set for ARM architectures. Thumb instruction set provides
609 better code density. For ARM architectures that support
610 Thumb2 this flag will result in Thumb2 code generated by
611 GCC.
612
Stephen Warrenc63c3502013-03-04 13:29:40 +0000613 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000614 CONFIG_ARM_ERRATA_742230
615 CONFIG_ARM_ERRATA_743622
616 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500617 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500618 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000619
620 If set, the workarounds for these ARM errata are applied early
621 during U-Boot startup. Note that these options force the
622 workarounds to be applied; no CPU-type/version detection
623 exists, unlike the similar options in the Linux kernel. Do not
624 set these options unless they apply!
625
Simon Glass9fa901b2014-11-10 17:16:54 -0700626- Driver Model
627 Driver model is a new framework for devices in U-Boot
628 introduced in early 2014. U-Boot is being progressively
629 moved over to this. It offers a consistent device structure,
630 supports grouping devices into classes and has built-in
631 handling of platform data and device tree.
632
633 To enable transition to driver model in a relatively
634 painful fashion, each subsystem can be independently
635 switched between the legacy/ad-hoc approach and the new
636 driver model using the options below. Also, many uclass
637 interfaces include compatibility features which may be
638 removed once the conversion of that subsystem is complete.
639 As a result, the API provided by the subsystem may in fact
640 not change with driver model.
641
642 See doc/driver-model/README.txt for more information.
643
644 CONFIG_DM
645
646 Enable driver model. This brings in the core support,
647 including scanning of platform data on start-up. If
648 CONFIG_OF_CONTROL is enabled, the device tree will be
649 scanned also when available.
650
651 CONFIG_CMD_DM
652
653 Enable driver model test commands. These allow you to print
654 out the driver model tree and the uclasses.
655
656 CONFIG_DM_DEMO
657
658 Enable some demo devices and the 'demo' command. These are
659 really only useful for playing around while trying to
660 understand driver model in sandbox.
661
662 CONFIG_SPL_DM
663
664 Enable driver model in SPL. You will need to provide a
665 suitable malloc() implementation. If you are not using the
666 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
667 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
668 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
669 In most cases driver model will only allocate a few uclasses
670 and devices in SPL, so 1KB should be enable. See
671 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
672 it.
673
674 CONFIG_DM_SERIAL
675
676 Enable driver model for serial. This replaces
677 drivers/serial/serial.c with the serial uclass, which
678 implements serial_putc() etc. The uclass interface is
679 defined in include/serial.h.
680
681 CONFIG_DM_GPIO
682
683 Enable driver model for GPIO access. The standard GPIO
684 interface (gpio_get_value(), etc.) is then implemented by
685 the GPIO uclass. Drivers provide methods to query the
686 particular GPIOs that they provide. The uclass interface
687 is defined in include/asm-generic/gpio.h.
688
689 CONFIG_DM_SPI
690
691 Enable driver model for SPI. The SPI slave interface
692 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
693 the SPI uclass. Drivers provide methods to access the SPI
694 buses that they control. The uclass interface is defined in
695 include/spi.h. The existing spi_slave structure is attached
696 as 'parent data' to every slave on each bus. Slaves
697 typically use driver-private data instead of extending the
698 spi_slave structure.
699
700 CONFIG_DM_SPI_FLASH
701
702 Enable driver model for SPI flash. This SPI flash interface
703 (spi_flash_probe(), spi_flash_write(), etc.) is then
704 implemented by the SPI flash uclass. There is one standard
705 SPI flash driver which knows how to probe most chips
706 supported by U-Boot. The uclass interface is defined in
707 include/spi_flash.h, but is currently fully compatible
708 with the old interface to avoid confusion and duplication
709 during the transition parent. SPI and SPI flash must be
710 enabled together (it is not possible to use driver model
711 for one and not the other).
712
713 CONFIG_DM_CROS_EC
714
715 Enable driver model for the Chrome OS EC interface. This
716 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
717 but otherwise makes few changes. Since cros_ec also supports
718 I2C and LPC (which don't support driver model yet), a full
719 conversion is not yet possible.
720
721
722 ** Code size options: The following options are enabled by
723 default except in SPL. Enable them explicitly to get these
724 features in SPL.
725
726 CONFIG_DM_WARN
727
728 Enable the dm_warn() function. This can use up quite a bit
729 of space for its strings.
730
731 CONFIG_DM_STDIO
732
733 Enable registering a serial device with the stdio library.
734
735 CONFIG_DM_DEVICE_REMOVE
736
737 Enable removing of devices.
738
739
wdenk9b7f3842003-10-09 20:09:04 +0000740- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000741 CONFIG_CLOCKS_IN_MHZ
742
743 U-Boot stores all clock information in Hz
744 internally. For binary compatibility with older Linux
745 kernels (which expect the clocks passed in the
746 bd_info data to be in MHz) the environment variable
747 "clocks_in_mhz" can be defined so that U-Boot
748 converts clock data to MHZ before passing it to the
749 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000750 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100751 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000752 default environment.
753
wdenk9b7f3842003-10-09 20:09:04 +0000754 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
755
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200756 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000757 expect it to be in bytes, others in MB.
758 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
759
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400760 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200761
762 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400763 passed using flattened device trees (based on open firmware
764 concepts).
765
766 CONFIG_OF_LIBFDT
767 * New libfdt-based support
768 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500769 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400770
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200771 OF_CPU - The proper name of the cpus node (only required for
772 MPC512X and MPC5xxx based boards).
773 OF_SOC - The proper name of the soc node (only required for
774 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200775 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600776 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200777
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200778 boards with QUICC Engines require OF_QE to set UCC MAC
779 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500780
Kumar Gala1e26aa52006-01-11 13:54:17 -0600781 CONFIG_OF_BOARD_SETUP
782
783 Board code has addition modification that it wants to make
784 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000785
Simon Glass6c0be912014-10-23 18:58:54 -0600786 CONFIG_OF_SYSTEM_SETUP
787
788 Other code has addition modification that it wants to make
789 to the flat device tree before handing it off to the kernel.
790 This causes ft_system_setup() to be called before booting
791 the kernel.
792
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500793 CONFIG_OF_BOOT_CPU
794
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200795 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500796 param header, the default value is zero if undefined.
797
Heiko Schocherffb293a2009-09-23 07:56:08 +0200798 CONFIG_OF_IDE_FIXUP
799
800 U-Boot can detect if an IDE device is present or not.
801 If not, and this new config option is activated, U-Boot
802 removes the ATA node from the DTS before booting Linux,
803 so the Linux IDE driver does not probe the device and
804 crash. This is needed for buggy hardware (uc101) where
805 no pull down resistor is connected to the signal IDE5V_DD7.
806
Igor Grinberg06890672011-07-14 05:45:07 +0000807 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
808
809 This setting is mandatory for all boards that have only one
810 machine type and must be used to specify the machine type
811 number as it appears in the ARM machine registry
812 (see http://www.arm.linux.org.uk/developer/machines/).
813 Only boards that have multiple machine types supported
814 in a single configuration file and the machine type is
815 runtime discoverable, do not have to use this setting.
816
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100817- vxWorks boot parameters:
818
819 bootvx constructs a valid bootline using the following
820 environments variables: bootfile, ipaddr, serverip, hostname.
821 It loads the vxWorks image pointed bootfile.
822
823 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
824 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
825 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
826 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
827
828 CONFIG_SYS_VXWORKS_ADD_PARAMS
829
830 Add it at the end of the bootline. E.g "u=username pw=secret"
831
832 Note: If a "bootargs" environment is defined, it will overwride
833 the defaults discussed just above.
834
Aneesh V960f5c02011-06-16 23:30:47 +0000835- Cache Configuration:
836 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
837 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
838 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
839
Aneesh V686a0752011-06-16 23:30:51 +0000840- Cache Configuration for ARM:
841 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
842 controller
843 CONFIG_SYS_PL310_BASE - Physical base address of PL310
844 controller register space
845
wdenkda04a8b2004-08-02 23:22:59 +0000846- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200847 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000848
849 Define this if you want support for Amba PrimeCell PL010 UARTs.
850
Andreas Engel0813b122008-09-08 14:30:53 +0200851 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000852
853 Define this if you want support for Amba PrimeCell PL011 UARTs.
854
855 CONFIG_PL011_CLOCK
856
857 If you have Amba PrimeCell PL011 UARTs, set this variable to
858 the clock speed of the UARTs.
859
860 CONFIG_PL01x_PORTS
861
862 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
863 define this to a list of base addresses for each (supported)
864 port. See e.g. include/configs/versatile.h
865
John Rigby34e21ee2011-04-19 10:42:39 +0000866 CONFIG_PL011_SERIAL_RLCR
867
868 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
869 have separate receive and transmit line control registers. Set
870 this variable to initialize the extra register.
871
872 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
873
874 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
875 boot loader that has already initialized the UART. Define this
876 variable to flush the UART at init time.
877
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400878 CONFIG_SERIAL_HW_FLOW_CONTROL
879
880 Define this variable to enable hw flow control in serial driver.
881 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000882
wdenkc6097192002-11-03 00:24:07 +0000883- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000884 Depending on board, define exactly one serial port
885 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
886 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
887 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000888
889 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
890 port routines must be defined elsewhere
891 (i.e. serial_init(), serial_getc(), ...)
892
893 CONFIG_CFB_CONSOLE
894 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000895 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000896 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
897 (default big endian)
898 VIDEO_HW_RECTFILL graphic chip supports
899 rectangle fill
900 (cf. smiLynxEM)
901 VIDEO_HW_BITBLT graphic chip supports
902 bit-blit (cf. smiLynxEM)
903 VIDEO_VISIBLE_COLS visible pixel columns
904 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000905 VIDEO_VISIBLE_ROWS visible pixel rows
906 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000907 VIDEO_DATA_FORMAT graphic data format
908 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000909 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000910 VIDEO_KBD_INIT_FCT keyboard int fct
911 (i.e. i8042_kbd_init())
912 VIDEO_TSTC_FCT test char fct
913 (i.e. i8042_tstc)
914 VIDEO_GETC_FCT get char fct
915 (i.e. i8042_getc)
916 CONFIG_CONSOLE_CURSOR cursor drawing on/off
917 (requires blink timer
918 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200919 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000920 CONFIG_CONSOLE_TIME display time/date info in
921 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500922 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000923 CONFIG_VIDEO_LOGO display Linux logo in
924 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000925 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
926 linux_logo.h for logo.
927 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000928 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200929 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000930 the logo
931
Pali Rohár4a57da32012-10-19 13:30:09 +0000932 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
933 a limited number of ANSI escape sequences (cursor control,
934 erase functions and limited graphics rendition control).
935
wdenk4a5c8a72003-03-06 00:02:04 +0000936 When CONFIG_CFB_CONSOLE is defined, video console is
937 default i/o. Serial console can be forced with
938 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000939
wdenk1ebf41e2004-01-02 14:00:00 +0000940 When CONFIG_SILENT_CONSOLE is defined, all console
941 messages (by U-Boot and Linux!) can be silenced with
942 the "silent" environment variable. See
943 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000944
Heiko Schocher62759562013-10-22 11:06:06 +0200945 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
946 is 0x00.
947 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
948 is 0xa0.
949
wdenkc6097192002-11-03 00:24:07 +0000950- Console Baudrate:
951 CONFIG_BAUDRATE - in bps
952 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200953 CONFIG_SYS_BAUDRATE_TABLE, see below.
954 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000955
Heiko Schocher327480a2009-01-30 12:55:38 +0100956- Console Rx buffer length
957 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
958 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100959 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100960 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
961 must be defined, to setup the maximum idle timeout for
962 the SMC.
963
Graeme Russ3c28f482011-09-01 00:48:27 +0000964- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200965 Prior to the console being initialised (i.e. serial UART
966 initialised etc) all console output is silently discarded.
967 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
968 buffer any console messages prior to the console being
969 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
970 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
971 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200972 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200973 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000974
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200975 'Sane' compilers will generate smaller code if
976 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000977
Sonny Raocd55bde2011-11-02 09:52:08 +0000978- Safe printf() functions
979 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
980 the printf() functions. These are defined in
981 include/vsprintf.h and include snprintf(), vsnprintf() and
982 so on. Code size increase is approximately 300-500 bytes.
983 If this option is not given then these functions will
984 silently discard their buffer size argument - this means
985 you are not getting any overflow checking in this case.
986
wdenkc6097192002-11-03 00:24:07 +0000987- Boot Delay: CONFIG_BOOTDELAY - in seconds
988 Delay before automatically booting the default image;
989 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000990 set to -2 to autoboot with no delay and not check for abort
991 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000992
993 See doc/README.autoboot for these options that
994 work with CONFIG_BOOTDELAY. None are required.
995 CONFIG_BOOT_RETRY_TIME
996 CONFIG_BOOT_RETRY_MIN
997 CONFIG_AUTOBOOT_KEYED
998 CONFIG_AUTOBOOT_PROMPT
999 CONFIG_AUTOBOOT_DELAY_STR
1000 CONFIG_AUTOBOOT_STOP_STR
1001 CONFIG_AUTOBOOT_DELAY_STR2
1002 CONFIG_AUTOBOOT_STOP_STR2
1003 CONFIG_ZERO_BOOTDELAY_CHECK
1004 CONFIG_RESET_TO_RETRY
1005
1006- Autoboot Command:
1007 CONFIG_BOOTCOMMAND
1008 Only needed when CONFIG_BOOTDELAY is enabled;
1009 define a command string that is automatically executed
1010 when no character is read on the console interface
1011 within "Boot Delay" after reset.
1012
1013 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +00001014 This can be used to pass arguments to the bootm
1015 command. The value of CONFIG_BOOTARGS goes into the
1016 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001017
1018 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +00001019 The value of these goes into the environment as
1020 "ramboot" and "nfsboot" respectively, and can be used
1021 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001022 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001023
Heiko Schocher040c5c32013-11-04 14:04:59 +01001024- Bootcount:
1025 CONFIG_BOOTCOUNT_LIMIT
1026 Implements a mechanism for detecting a repeating reboot
1027 cycle, see:
1028 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1029
1030 CONFIG_BOOTCOUNT_ENV
1031 If no softreset save registers are found on the hardware
1032 "bootcount" is stored in the environment. To prevent a
1033 saveenv on all reboots, the environment variable
1034 "upgrade_available" is used. If "upgrade_available" is
1035 0, "bootcount" is always 0, if "upgrade_available" is
1036 1 "bootcount" is incremented in the environment.
1037 So the Userspace Applikation must set the "upgrade_available"
1038 and "bootcount" variable to 0, if a boot was successfully.
1039
wdenkc6097192002-11-03 00:24:07 +00001040- Pre-Boot Commands:
1041 CONFIG_PREBOOT
1042
1043 When this option is #defined, the existence of the
1044 environment variable "preboot" will be checked
1045 immediately before starting the CONFIG_BOOTDELAY
1046 countdown and/or running the auto-boot command resp.
1047 entering interactive mode.
1048
1049 This feature is especially useful when "preboot" is
1050 automatically generated or modified. For an example
1051 see the LWMON board specific code: here "preboot" is
1052 modified when the user holds down a certain
1053 combination of keys on the (special) keyboard when
1054 booting the systems
1055
1056- Serial Download Echo Mode:
1057 CONFIG_LOADS_ECHO
1058 If defined to 1, all characters received during a
1059 serial download (using the "loads" command) are
1060 echoed back. This might be needed by some terminal
1061 emulations (like "cu"), but may as well just take
1062 time on others. This setting #define's the initial
1063 value of the "loads_echo" environment variable.
1064
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001065- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001066 CONFIG_KGDB_BAUDRATE
1067 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001068 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001069
1070- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001071 Monitor commands can be included or excluded
1072 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001073 <config_cmd_all.h> and #undef'ing unwanted
1074 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001075 and augmenting with additional #define's
1076 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001077
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001078 The default command configuration includes all commands
1079 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001080
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001081 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001082 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001083 CONFIG_CMD_BDI bdinfo
1084 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1085 CONFIG_CMD_BMP * BMP support
1086 CONFIG_CMD_BSP * Board specific commands
1087 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001088 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001089 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001090 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001091 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001092 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001093 CONFIG_CMD_DATE * support for RTC, date/time...
1094 CONFIG_CMD_DHCP * DHCP support
1095 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001096 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1097 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1098 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1099 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001100 CONFIG_CMD_DTT * Digital Therm and Thermostat
1101 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001102 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001103 CONFIG_CMD_EEPROM * EEPROM read/write support
1104 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001105 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001106 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001107 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001108 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001109 CONFIG_CMD_EXT2 * ext2 command support
1110 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001111 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1112 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001113 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001114 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001115 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001116 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001117 CONFIG_CMD_FLASH flinfo, erase, protect
1118 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001119 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001120 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001121 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001122 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001123 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001124 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1125 CONFIG_CMD_I2C * I2C serial bus support
1126 CONFIG_CMD_IDE * IDE harddisk support
1127 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001128 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001129 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001130 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001131 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001132 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001133 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001134 CONFIG_CMD_IRQ * irqinfo
1135 CONFIG_CMD_ITEST Integer/string test of 2 values
1136 CONFIG_CMD_JFFS2 * JFFS2 Support
1137 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001138 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001139 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1140 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001141 CONFIG_CMD_LOADB loadb
1142 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001143 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001144 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001145 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001146 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001147 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001148 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001149 CONFIG_CMD_MISC Misc functions like sleep etc
1150 CONFIG_CMD_MMC * MMC memory mapped support
1151 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001152 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001153 CONFIG_CMD_NAND * NAND support
1154 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001155 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001156 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001157 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001158 CONFIG_CMD_PCI * pciinfo
1159 CONFIG_CMD_PCMCIA * PCMCIA support
1160 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1161 host
1162 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001163 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001164 CONFIG_CMD_REGINFO * Register dump
1165 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001166 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001167 CONFIG_CMD_SAVES * save S record dump
1168 CONFIG_CMD_SCSI * SCSI Support
1169 CONFIG_CMD_SDRAM * print SDRAM configuration information
1170 (requires CONFIG_CMD_I2C)
1171 CONFIG_CMD_SETGETDCR Support for DCR Register access
1172 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001173 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001174 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001175 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001176 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001177 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001178 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001179 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001180 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001181 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1182 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001183 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001184 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001185 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001186 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001187 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001188
1189 EXAMPLE: If you want all functions except of network
1190 support you can write:
1191
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001192 #include "config_cmd_all.h"
1193 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001194
Gerald Van Barend6abef42007-03-31 12:23:51 -04001195 Other Commands:
1196 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001197
1198 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001199 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001200 what you (and your U-Boot users) are doing. Data
1201 cache cannot be enabled on systems like the 8xx or
1202 8260 (where accesses to the IMMR region must be
1203 uncached), and it cannot be disabled on all other
1204 systems where we (mis-) use the data cache to hold an
1205 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001206
1207
1208 XXX - this list needs to get updated!
1209
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001210- Regular expression support:
1211 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001212 If this variable is defined, U-Boot is linked against
1213 the SLRE (Super Light Regular Expression) library,
1214 which adds regex support to some commands, as for
1215 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001216
Simon Glass3d686442011-10-15 05:48:20 +00001217- Device tree:
1218 CONFIG_OF_CONTROL
1219 If this variable is defined, U-Boot will use a device tree
1220 to configure its devices, instead of relying on statically
1221 compiled #defines in the board file. This option is
1222 experimental and only available on a few boards. The device
1223 tree is available in the global data as gd->fdt_blob.
1224
Simon Glass5cb34db2011-10-24 19:15:31 +00001225 U-Boot needs to get its device tree from somewhere. This can
1226 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001227
1228 CONFIG_OF_EMBED
1229 If this variable is defined, U-Boot will embed a device tree
1230 binary in its image. This device tree file should be in the
1231 board directory and called <soc>-<board>.dts. The binary file
1232 is then picked up in board_init_f() and made available through
1233 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001234
Simon Glass5cb34db2011-10-24 19:15:31 +00001235 CONFIG_OF_SEPARATE
1236 If this variable is defined, U-Boot will build a device tree
1237 binary. It will be called u-boot.dtb. Architecture-specific
1238 code will locate it at run-time. Generally this works by:
1239
1240 cat u-boot.bin u-boot.dtb >image.bin
1241
1242 and in fact, U-Boot does this for you, creating a file called
1243 u-boot-dtb.bin which is useful in the common case. You can
1244 still use the individual files if you need something more
1245 exotic.
1246
wdenkc6097192002-11-03 00:24:07 +00001247- Watchdog:
1248 CONFIG_WATCHDOG
1249 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001250 support for the SoC. There must be support in the SoC
1251 specific code for a watchdog. For the 8xx and 8260
1252 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1253 register. When supported for a specific SoC is
1254 available, then no further board specific code should
1255 be needed to use it.
1256
1257 CONFIG_HW_WATCHDOG
1258 When using a watchdog circuitry external to the used
1259 SoC, then define this variable and provide board
1260 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001261
stroeseb9c17c52003-04-04 15:53:41 +00001262- U-Boot Version:
1263 CONFIG_VERSION_VARIABLE
1264 If this variable is defined, an environment variable
1265 named "ver" is created by U-Boot showing the U-Boot
1266 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001267 Any change to this variable will be reverted at the
1268 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001269
wdenkc6097192002-11-03 00:24:07 +00001270- Real-Time Clock:
1271
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001272 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001273 has to be selected, too. Define exactly one of the
1274 following options:
1275
1276 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1277 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001278 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001279 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001280 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001281 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001282 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001283 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001284 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001285 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001286 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001287 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001288 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1289 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001290
wdenkb9bbd242003-06-30 16:24:52 +00001291 Note that if the RTC uses I2C, then the I2C interface
1292 must also be configured. See I2C Support, below.
1293
Peter Tyser9902e422008-12-17 16:36:21 -06001294- GPIO Support:
1295 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001296
Chris Packham9b383202010-12-19 10:12:13 +00001297 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1298 chip-ngpio pairs that tell the PCA953X driver the number of
1299 pins supported by a particular chip.
1300
Peter Tyser9902e422008-12-17 16:36:21 -06001301 Note that if the GPIO device uses I2C, then the I2C interface
1302 must also be configured. See I2C Support, below.
1303
Simon Glass4dc47ca2014-06-11 23:29:41 -06001304- I/O tracing:
1305 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1306 accesses and can checksum them or write a list of them out
1307 to memory. See the 'iotrace' command for details. This is
1308 useful for testing device drivers since it can confirm that
1309 the driver behaves the same way before and after a code
1310 change. Currently this is supported on sandbox and arm. To
1311 add support for your architecture, add '#include <iotrace.h>'
1312 to the bottom of arch/<arch>/include/asm/io.h and test.
1313
1314 Example output from the 'iotrace stats' command is below.
1315 Note that if the trace buffer is exhausted, the checksum will
1316 still continue to operate.
1317
1318 iotrace is enabled
1319 Start: 10000000 (buffer start address)
1320 Size: 00010000 (buffer size)
1321 Offset: 00000120 (current buffer offset)
1322 Output: 10000120 (start + offset)
1323 Count: 00000018 (number of trace records)
1324 CRC32: 9526fb66 (CRC32 of all trace records)
1325
wdenkc6097192002-11-03 00:24:07 +00001326- Timestamp Support:
1327
wdenk4a5c8a72003-03-06 00:02:04 +00001328 When CONFIG_TIMESTAMP is selected, the timestamp
1329 (date and time) of an image is printed by image
1330 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001331 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001332
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001333- Partition Labels (disklabels) Supported:
1334 Zero or more of the following:
1335 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1336 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1337 Intel architecture, USB sticks, etc.
1338 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1339 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1340 bootloader. Note 2TB partition limit; see
1341 disk/part_efi.c
1342 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001343
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001344 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1345 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001346 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001347
1348- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001349 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1350 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001351
wdenk369d43d2004-03-14 14:09:05 +00001352 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1353 be performed by calling the function
1354 ide_set_reset(int reset)
1355 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001356
1357- ATAPI Support:
1358 CONFIG_ATAPI
1359
1360 Set this to enable ATAPI support.
1361
wdenkf602aa02004-03-13 23:29:43 +00001362- LBA48 Support
1363 CONFIG_LBA48
1364
1365 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001366 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001367 Whithout these , LBA48 support uses 32bit variables and will 'only'
1368 support disks up to 2.1TB.
1369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001370 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001371 When enabled, makes the IDE subsystem use 64bit sector addresses.
1372 Default is 32bit.
1373
wdenkc6097192002-11-03 00:24:07 +00001374- SCSI Support:
1375 At the moment only there is only support for the
1376 SYM53C8XX SCSI controller; define
1377 CONFIG_SCSI_SYM53C8XX to enable it.
1378
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001379 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1380 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1381 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001382 maximum numbers of LUNs, SCSI ID's and target
1383 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001384 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001385
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001386 The environment variable 'scsidevs' is set to the number of
1387 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001388
wdenkc6097192002-11-03 00:24:07 +00001389- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001390 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001391 Support for Intel 8254x/8257x gigabit chips.
1392
1393 CONFIG_E1000_SPI
1394 Utility code for direct access to the SPI bus on Intel 8257x.
1395 This does not do anything useful unless you set at least one
1396 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1397
1398 CONFIG_E1000_SPI_GENERIC
1399 Allow generic access to the SPI bus on the Intel 8257x, for
1400 example with the "sspi" command.
1401
1402 CONFIG_CMD_E1000
1403 Management command for E1000 devices. When used on devices
1404 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001405
Andre Schwarz68c2a302008-03-06 16:45:44 +01001406 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001407 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001408
wdenkc6097192002-11-03 00:24:07 +00001409 CONFIG_EEPRO100
1410 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001411 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001412 write routine for first time initialisation.
1413
1414 CONFIG_TULIP
1415 Support for Digital 2114x chips.
1416 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1417 modem chip initialisation (KS8761/QS6611).
1418
1419 CONFIG_NATSEMI
1420 Support for National dp83815 chips.
1421
1422 CONFIG_NS8382X
1423 Support for National dp8382[01] gigabit chips.
1424
wdenkaa603362003-05-12 21:50:16 +00001425- NETWORK Support (other):
1426
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001427 CONFIG_DRIVER_AT91EMAC
1428 Support for AT91RM9200 EMAC.
1429
1430 CONFIG_RMII
1431 Define this to use reduced MII inteface
1432
1433 CONFIG_DRIVER_AT91EMAC_QUIET
1434 If this defined, the driver is quiet.
1435 The driver doen't show link status messages.
1436
Rob Herringc9830dc2011-12-15 11:15:49 +00001437 CONFIG_CALXEDA_XGMAC
1438 Support for the Calxeda XGMAC device
1439
Ashok93fb8722012-10-15 06:20:47 +00001440 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001441 Support for SMSC's LAN91C96 chips.
1442
1443 CONFIG_LAN91C96_BASE
1444 Define this to hold the physical address
1445 of the LAN91C96's I/O space
1446
1447 CONFIG_LAN91C96_USE_32_BIT
1448 Define this to enable 32 bit addressing
1449
Ashok93fb8722012-10-15 06:20:47 +00001450 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001451 Support for SMSC's LAN91C111 chip
1452
1453 CONFIG_SMC91111_BASE
1454 Define this to hold the physical address
1455 of the device (I/O space)
1456
1457 CONFIG_SMC_USE_32_BIT
1458 Define this if data bus is 32 bits
1459
1460 CONFIG_SMC_USE_IOFUNCS
1461 Define this to use i/o functions instead of macros
1462 (some hardware wont work with macros)
1463
Heiko Schocher7d037f72011-11-15 10:00:04 -05001464 CONFIG_DRIVER_TI_EMAC
1465 Support for davinci emac
1466
1467 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1468 Define this if you have more then 3 PHYs.
1469
Macpaul Lin199c6252010-12-21 16:59:46 +08001470 CONFIG_FTGMAC100
1471 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1472
1473 CONFIG_FTGMAC100_EGIGA
1474 Define this to use GE link update with gigabit PHY.
1475 Define this if FTGMAC100 is connected to gigabit PHY.
1476 If your system has 10/100 PHY only, it might not occur
1477 wrong behavior. Because PHY usually return timeout or
1478 useless data when polling gigabit status and gigabit
1479 control registers. This behavior won't affect the
1480 correctnessof 10/100 link speed update.
1481
Mike Rapoportf4761af2009-11-11 10:03:03 +02001482 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001483 Support for SMSC's LAN911x and LAN921x chips
1484
Mike Rapoportf4761af2009-11-11 10:03:03 +02001485 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001486 Define this to hold the physical address
1487 of the device (I/O space)
1488
Mike Rapoportf4761af2009-11-11 10:03:03 +02001489 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001490 Define this if data bus is 32 bits
1491
Mike Rapoportf4761af2009-11-11 10:03:03 +02001492 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001493 Define this if data bus is 16 bits. If your processor
1494 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001495 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001496
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001497 CONFIG_SH_ETHER
1498 Support for Renesas on-chip Ethernet controller
1499
1500 CONFIG_SH_ETHER_USE_PORT
1501 Define the number of ports to be used
1502
1503 CONFIG_SH_ETHER_PHY_ADDR
1504 Define the ETH PHY's address
1505
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001506 CONFIG_SH_ETHER_CACHE_WRITEBACK
1507 If this option is set, the driver enables cache flush.
1508
Heiko Schocher2b387762014-07-18 06:07:19 +02001509- PWM Support:
1510 CONFIG_PWM_IMX
1511 Support for PWM modul on the imx6.
1512
Vadim Bendeburydac69642011-10-17 08:36:14 +00001513- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001514 CONFIG_TPM
1515 Support TPM devices.
1516
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001517 CONFIG_TPM_TIS_I2C
1518 Support for i2c bus TPM devices. Only one device
1519 per system is supported at this time.
1520
1521 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1522 Define the the i2c bus number for the TPM device
1523
1524 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1525 Define the TPM's address on the i2c bus
1526
1527 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1528 Define the burst count bytes upper limit
1529
Dirk Eibach20489092013-06-26 15:55:15 +02001530 CONFIG_TPM_ATMEL_TWI
1531 Support for Atmel TWI TPM device. Requires I2C support.
1532
Che-liang Chiouacea5702013-04-12 11:04:34 +00001533 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001534 Support for generic parallel port TPM devices. Only one device
1535 per system is supported at this time.
1536
1537 CONFIG_TPM_TIS_BASE_ADDRESS
1538 Base address where the generic TPM device is mapped
1539 to. Contemporary x86 systems usually map it at
1540 0xfed40000.
1541
Reinhard Pfau4fece432013-06-26 15:55:13 +02001542 CONFIG_CMD_TPM
1543 Add tpm monitor functions.
1544 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1545 provides monitor access to authorized functions.
1546
1547 CONFIG_TPM
1548 Define this to enable the TPM support library which provides
1549 functional interfaces to some TPM commands.
1550 Requires support for a TPM device.
1551
1552 CONFIG_TPM_AUTH_SESSIONS
1553 Define this to enable authorized functions in the TPM library.
1554 Requires CONFIG_TPM and CONFIG_SHA1.
1555
wdenkc6097192002-11-03 00:24:07 +00001556- USB Support:
1557 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001558 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001559 CONFIG_USB_UHCI to enable it.
1560 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001561 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001562 storage devices.
1563 Note:
1564 Supported are USB Keyboards and USB Floppy drives
1565 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001566 MPC5200 USB requires additional defines:
1567 CONFIG_USB_CLOCK
1568 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001569 CONFIG_PSC3_USB
1570 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001571 CONFIG_USB_CONFIG
1572 for differential drivers: 0x00001000
1573 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001574 for differential drivers on PSC3: 0x00000100
1575 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001576 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001577 May be defined to allow interrupt polling
1578 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001579
Simon Glass5978cdb2012-02-27 10:52:47 +00001580 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1581 txfilltuning field in the EHCI controller on reset.
1582
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001583 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1584 HW module registers.
1585
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001586- USB Device:
1587 Define the below if you wish to use the USB console.
1588 Once firmware is rebuilt from a serial console issue the
1589 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001590 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001591 it has found a new device. The environment variable usbtty
1592 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001593 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001594 Common Device Class Abstract Control Model serial device.
1595 If you select usbtty = gserial you should be able to enumerate
1596 a Linux host by
1597 # modprobe usbserial vendor=0xVendorID product=0xProductID
1598 else if using cdc_acm, simply setting the environment
1599 variable usbtty to be cdc_acm should suffice. The following
1600 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001601
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001602 CONFIG_USB_DEVICE
1603 Define this to build a UDC device
1604
1605 CONFIG_USB_TTY
1606 Define this to have a tty type of device available to
1607 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001608
Vipin KUMARbdb17702012-03-26 15:38:06 +05301609 CONFIG_USBD_HS
1610 Define this to enable the high speed support for usb
1611 device and usbtty. If this feature is enabled, a routine
1612 int is_usbd_high_speed(void)
1613 also needs to be defined by the driver to dynamically poll
1614 whether the enumeration has succeded at high speed or full
1615 speed.
1616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001617 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001618 Define this if you want stdin, stdout &/or stderr to
1619 be set to usbtty.
1620
1621 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001622 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001623 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001624 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001626 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001627 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001628 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001629
Wolfgang Denke2601822006-06-14 18:14:56 +02001630 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001631 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001632 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001633 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1634 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1635 should pretend to be a Linux device to it's target host.
1636
1637 CONFIG_USBD_MANUFACTURER
1638 Define this string as the name of your company for
1639 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001640
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001641 CONFIG_USBD_PRODUCT_NAME
1642 Define this string as the name of your product
1643 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001644
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001645 CONFIG_USBD_VENDORID
1646 Define this as your assigned Vendor ID from the USB
1647 Implementors Forum. This *must* be a genuine Vendor ID
1648 to avoid polluting the USB namespace.
1649 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001650
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001651 CONFIG_USBD_PRODUCTID
1652 Define this as the unique Product ID
1653 for your device
1654 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001655
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001656- ULPI Layer Support:
1657 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1658 the generic ULPI layer. The generic layer accesses the ULPI PHY
1659 via the platform viewport, so you need both the genric layer and
1660 the viewport enabled. Currently only Chipidea/ARC based
1661 viewport is supported.
1662 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1663 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001664 If your ULPI phy needs a different reference clock than the
1665 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1666 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001667
wdenk7a428cc2003-06-15 22:40:42 +00001668- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001669 The MMC controller on the Intel PXA is supported. To
1670 enable this define CONFIG_MMC. The MMC can be
1671 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001672 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001673 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1674 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001675
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001676 CONFIG_SH_MMCIF
1677 Support for Renesas on-chip MMCIF controller
1678
1679 CONFIG_SH_MMCIF_ADDR
1680 Define the base address of MMCIF registers
1681
1682 CONFIG_SH_MMCIF_CLK
1683 Define the clock frequency for MMCIF
1684
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001685 CONFIG_GENERIC_MMC
1686 Enable the generic MMC driver
1687
1688 CONFIG_SUPPORT_EMMC_BOOT
1689 Enable some additional features of the eMMC boot partitions.
1690
1691 CONFIG_SUPPORT_EMMC_RPMB
1692 Enable the commands for reading, writing and programming the
1693 key for the Replay Protection Memory Block partition in eMMC.
1694
Tom Rini58a8d322013-03-14 05:32:47 +00001695- USB Device Firmware Update (DFU) class support:
1696 CONFIG_DFU_FUNCTION
1697 This enables the USB portion of the DFU USB class
1698
1699 CONFIG_CMD_DFU
1700 This enables the command "dfu" which is used to have
1701 U-Boot create a DFU class device via USB. This command
1702 requires that the "dfu_alt_info" environment variable be
1703 set and define the alt settings to expose to the host.
1704
1705 CONFIG_DFU_MMC
1706 This enables support for exposing (e)MMC devices via DFU.
1707
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001708 CONFIG_DFU_NAND
1709 This enables support for exposing NAND devices via DFU.
1710
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301711 CONFIG_DFU_RAM
1712 This enables support for exposing RAM via DFU.
1713 Note: DFU spec refer to non-volatile memory usage, but
1714 allow usages beyond the scope of spec - here RAM usage,
1715 one that would help mostly the developer.
1716
Heiko Schochera2f831e2013-06-12 06:05:51 +02001717 CONFIG_SYS_DFU_DATA_BUF_SIZE
1718 Dfu transfer uses a buffer before writing data to the
1719 raw storage device. Make the size (in bytes) of this buffer
1720 configurable. The size of this buffer is also configurable
1721 through the "dfu_bufsiz" environment variable.
1722
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001723 CONFIG_SYS_DFU_MAX_FILE_SIZE
1724 When updating files rather than the raw storage device,
1725 we use a static buffer to copy the file into and then write
1726 the buffer once we've been given the whole file. Define
1727 this to the maximum filesize (in bytes) for the buffer.
1728 Default is 4 MiB if undefined.
1729
Heiko Schochere1ba1512014-03-18 08:09:56 +01001730 DFU_DEFAULT_POLL_TIMEOUT
1731 Poll timeout [ms], is the timeout a device can send to the
1732 host. The host must wait for this timeout before sending
1733 a subsequent DFU_GET_STATUS request to the device.
1734
1735 DFU_MANIFEST_POLL_TIMEOUT
1736 Poll timeout [ms], which the device sends to the host when
1737 entering dfuMANIFEST state. Host waits this timeout, before
1738 sending again an USB request to the device.
1739
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001740- USB Device Android Fastboot support:
1741 CONFIG_CMD_FASTBOOT
1742 This enables the command "fastboot" which enables the Android
1743 fastboot mode for the platform's USB device. Fastboot is a USB
1744 protocol for downloading images, flashing and device control
1745 used on Android devices.
1746 See doc/README.android-fastboot for more information.
1747
1748 CONFIG_ANDROID_BOOT_IMAGE
1749 This enables support for booting images which use the Android
1750 image format header.
1751
1752 CONFIG_USB_FASTBOOT_BUF_ADDR
1753 The fastboot protocol requires a large memory buffer for
1754 downloads. Define this to the starting RAM address to use for
1755 downloaded images.
1756
1757 CONFIG_USB_FASTBOOT_BUF_SIZE
1758 The fastboot protocol requires a large memory buffer for
1759 downloads. This buffer should be as large as possible for a
1760 platform. Define this to the size available RAM for fastboot.
1761
Steve Raebfb9ba42014-08-26 11:47:28 -07001762 CONFIG_FASTBOOT_FLASH
1763 The fastboot protocol includes a "flash" command for writing
1764 the downloaded image to a non-volatile storage device. Define
1765 this to enable the "fastboot flash" command.
1766
1767 CONFIG_FASTBOOT_FLASH_MMC_DEV
1768 The fastboot "flash" command requires additional information
1769 regarding the non-volatile storage device. Define this to
1770 the eMMC device that fastboot should use to store the image.
1771
wdenkda04a8b2004-08-02 23:22:59 +00001772- Journaling Flash filesystem support:
1773 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1774 CONFIG_JFFS2_NAND_DEV
1775 Define these for a default partition on a NAND device
1776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001777 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1778 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001779 Define these for a default partition on a NOR device
1780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001781 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001782 Define this to create an own partition. You have to provide a
1783 function struct part_info* jffs2_part_info(int part_num)
1784
1785 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001786 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001787 to disable the command chpart. This is the default when you
1788 have not defined a custom partition
1789
Donggeun Kim8f814002011-10-24 21:15:28 +00001790- FAT(File Allocation Table) filesystem write function support:
1791 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001792
1793 Define this to enable support for saving memory data as a
1794 file in FAT formatted partition.
1795
1796 This will also enable the command "fatwrite" enabling the
1797 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001798
Gabe Black7f8574c2012-10-12 14:26:11 +00001799CBFS (Coreboot Filesystem) support
1800 CONFIG_CMD_CBFS
1801
1802 Define this to enable support for reading from a Coreboot
1803 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1804 and cbfsload.
1805
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301806- FAT(File Allocation Table) filesystem cluster size:
1807 CONFIG_FS_FAT_MAX_CLUSTSIZE
1808
1809 Define the max cluster size for fat operations else
1810 a default value of 65536 will be defined.
1811
wdenkc6097192002-11-03 00:24:07 +00001812- Keyboard Support:
1813 CONFIG_ISA_KEYBOARD
1814
1815 Define this to enable standard (PC-Style) keyboard
1816 support
1817
1818 CONFIG_I8042_KBD
1819 Standard PC keyboard driver with US (is default) and
1820 GERMAN key layout (switch via environment 'keymap=de') support.
1821 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1822 for cfb_console. Supports cursor blinking.
1823
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001824 CONFIG_CROS_EC_KEYB
1825 Enables a Chrome OS keyboard using the CROS_EC interface.
1826 This uses CROS_EC to communicate with a second microcontroller
1827 which provides key scans on request.
1828
wdenkc6097192002-11-03 00:24:07 +00001829- Video support:
1830 CONFIG_VIDEO
1831
1832 Define this to enable video support (for output to
1833 video).
1834
1835 CONFIG_VIDEO_CT69000
1836
1837 Enable Chips & Technologies 69000 Video chip
1838
1839 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001840 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001841 video output is selected via environment 'videoout'
1842 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1843 assumed.
wdenkc6097192002-11-03 00:24:07 +00001844
wdenkd3602132004-03-25 15:14:43 +00001845 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001846 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001847 are possible:
1848 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001849 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001850
1851 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1852 -------------+---------------------------------------------
1853 8 bits | 0x301* 0x303 0x305 0x161 0x307
1854 15 bits | 0x310 0x313 0x316 0x162 0x319
1855 16 bits | 0x311 0x314 0x317 0x163 0x31A
1856 24 bits | 0x312 0x315 0x318 ? 0x31B
1857 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001858 (i.e. setenv videomode 317; saveenv; reset;)
1859
wdenkd3602132004-03-25 15:14:43 +00001860 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001861 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001862
1863
stroeseb9c17c52003-04-04 15:53:41 +00001864 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001865 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001866 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1867 or CONFIG_VIDEO_SED13806_16BPP
1868
Timur Tabi020edd22011-02-15 17:09:19 -06001869 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001870 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001871 SOCs that have a DIU should define this macro to enable DIU
1872 support, and should also define these other macros:
1873
1874 CONFIG_SYS_DIU_ADDR
1875 CONFIG_VIDEO
1876 CONFIG_CMD_BMP
1877 CONFIG_CFB_CONSOLE
1878 CONFIG_VIDEO_SW_CURSOR
1879 CONFIG_VGA_AS_SINGLE_DEVICE
1880 CONFIG_VIDEO_LOGO
1881 CONFIG_VIDEO_BMP_LOGO
1882
Timur Tabi32f709e2011-04-11 14:18:22 -05001883 The DIU driver will look for the 'video-mode' environment
1884 variable, and if defined, enable the DIU as a console during
1885 boot. See the documentation file README.video for a
1886 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001887
Simon Glass54df8ce2012-12-03 13:59:47 +00001888 CONFIG_VIDEO_VGA
1889
1890 Enable the VGA video / BIOS for x86. The alternative if you
1891 are using coreboot is to use the coreboot frame buffer
1892 driver.
1893
1894
wdenk4e112c12003-06-03 23:54:09 +00001895- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001896 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001897
wdenk57b2d802003-06-27 21:31:46 +00001898 Define this to enable a custom keyboard support.
1899 This simply calls drv_keyboard_init() which must be
1900 defined in your board-specific files.
1901 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001902
wdenkc6097192002-11-03 00:24:07 +00001903- LCD Support: CONFIG_LCD
1904
1905 Define this to enable LCD support (for output to LCD
1906 display); also select one of the supported displays
1907 by defining one of these:
1908
Stelian Popf6f86652008-05-09 21:57:18 +02001909 CONFIG_ATMEL_LCD:
1910
1911 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1912
wdenkc0d54ae2003-11-25 16:55:19 +00001913 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001914
wdenkc0d54ae2003-11-25 16:55:19 +00001915 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001916
wdenkc0d54ae2003-11-25 16:55:19 +00001917 CONFIG_NEC_NL6448BC20
1918
1919 NEC NL6448BC20-08. 6.5", 640x480.
1920 Active, color, single scan.
1921
1922 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001923
wdenkc0d54ae2003-11-25 16:55:19 +00001924 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001925 Active, color, single scan.
1926
1927 CONFIG_SHARP_16x9
1928
1929 Sharp 320x240. Active, color, single scan.
1930 It isn't 16x9, and I am not sure what it is.
1931
1932 CONFIG_SHARP_LQ64D341
1933
1934 Sharp LQ64D341 display, 640x480.
1935 Active, color, single scan.
1936
1937 CONFIG_HLD1045
1938
1939 HLD1045 display, 640x480.
1940 Active, color, single scan.
1941
1942 CONFIG_OPTREX_BW
1943
1944 Optrex CBL50840-2 NF-FW 99 22 M5
1945 or
1946 Hitachi LMG6912RPFC-00T
1947 or
1948 Hitachi SP14Q002
1949
1950 320x240. Black & white.
1951
1952 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001953 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001954
Simon Glass599a4df2012-10-17 13:24:54 +00001955 CONFIG_LCD_ALIGNMENT
1956
1957 Normally the LCD is page-aligned (tyically 4KB). If this is
1958 defined then the LCD will be aligned to this value instead.
1959 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1960 here, since it is cheaper to change data cache settings on
1961 a per-section basis.
1962
Simon Glassaf3e2802012-10-17 13:24:59 +00001963 CONFIG_CONSOLE_SCROLL_LINES
1964
1965 When the console need to be scrolled, this is the number of
1966 lines to scroll by. It defaults to 1. Increasing this makes
1967 the console jump but can help speed up operation when scrolling
1968 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001969
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001970 CONFIG_LCD_BMP_RLE8
1971
1972 Support drawing of RLE8-compressed bitmaps on the LCD.
1973
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001974 CONFIG_I2C_EDID
1975
1976 Enables an 'i2c edid' command which can read EDID
1977 information over I2C from an attached LCD display.
1978
wdenkeb20ad32003-09-05 23:19:14 +00001979- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001980
wdenk57b2d802003-06-27 21:31:46 +00001981 If this option is set, the environment is checked for
1982 a variable "splashimage". If found, the usual display
1983 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001984 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001985 specified in "splashimage" is loaded instead. The
1986 console is redirected to the "nulldev", too. This
1987 allows for a "silent" boot where a splash screen is
1988 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001989
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001990 CONFIG_SPLASHIMAGE_GUARD
1991
1992 If this option is set, then U-Boot will prevent the environment
1993 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001994 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001995 This option is useful for targets where, due to alignment
1996 restrictions, an improperly aligned BMP image will cause a data
1997 abort. If you think you will not have problems with unaligned
1998 accesses (for example because your toolchain prevents them)
1999 there is no need to set this option.
2000
Matthias Weisser53884182009-07-09 16:07:30 +02002001 CONFIG_SPLASH_SCREEN_ALIGN
2002
2003 If this option is set the splash image can be freely positioned
2004 on the screen. Environment variable "splashpos" specifies the
2005 position as "x,y". If a positive number is given it is used as
2006 number of pixel from left/top. If a negative number is given it
2007 is used as number of pixel from right/bottom. You can also
2008 specify 'm' for centering the image.
2009
2010 Example:
2011 setenv splashpos m,m
2012 => image at center of screen
2013
2014 setenv splashpos 30,20
2015 => image at x = 30 and y = 20
2016
2017 setenv splashpos -10,m
2018 => vertically centered image
2019 at x = dspWidth - bmpWidth - 9
2020
Stefan Roesed9d97742005-09-22 09:04:17 +02002021- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2022
2023 If this option is set, additionally to standard BMP
2024 images, gzipped BMP images can be displayed via the
2025 splashscreen support or the bmp command.
2026
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002027- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2028
2029 If this option is set, 8-bit RLE compressed BMP images
2030 can be displayed via the splashscreen support or the
2031 bmp command.
2032
Lei Wene4e248d2012-09-28 04:26:47 +00002033- Do compresssing for memory range:
2034 CONFIG_CMD_ZIP
2035
2036 If this option is set, it would use zlib deflate method
2037 to compress the specified memory at its best effort.
2038
wdenk710e3502003-08-29 20:57:53 +00002039- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002040 CONFIG_GZIP
2041
2042 Enabled by default to support gzip compressed images.
2043
wdenk710e3502003-08-29 20:57:53 +00002044 CONFIG_BZIP2
2045
2046 If this option is set, support for bzip2 compressed
2047 images is included. If not, only uncompressed and gzip
2048 compressed images are supported.
2049
wdenk9c53f402003-10-15 23:53:47 +00002050 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002051 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002052 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002053
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002054 CONFIG_LZMA
2055
2056 If this option is set, support for lzma compressed
2057 images is included.
2058
2059 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2060 requires an amount of dynamic memory that is given by the
2061 formula:
2062
2063 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2064
2065 Where lc and lp stand for, respectively, Literal context bits
2066 and Literal pos bits.
2067
2068 This value is upper-bounded by 14MB in the worst case. Anyway,
2069 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2070 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2071 a very small buffer.
2072
2073 Use the lzmainfo tool to determinate the lc and lp values and
2074 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002075 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002076
Kees Cook5b06e642013-08-16 07:59:12 -07002077 CONFIG_LZO
2078
2079 If this option is set, support for LZO compressed images
2080 is included.
2081
wdenk0e2bd9c2004-06-06 21:51:03 +00002082- MII/PHY support:
2083 CONFIG_PHY_ADDR
2084
2085 The address of PHY on MII bus.
2086
2087 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2088
2089 The clock frequency of the MII bus
2090
2091 CONFIG_PHY_GIGE
2092
2093 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002094 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002095
2096 CONFIG_PHY_RESET_DELAY
2097
2098 Some PHY like Intel LXT971A need extra delay after
2099 reset before any MII register access is possible.
2100 For such PHY, set this option to the usec delay
2101 required. (minimum 300usec for LXT971A)
2102
2103 CONFIG_PHY_CMD_DELAY (ppc4xx)
2104
2105 Some PHY like Intel LXT971A need extra delay after
2106 command issued before MII status register can be read
2107
wdenkc6097192002-11-03 00:24:07 +00002108- Ethernet address:
2109 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002110 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002111 CONFIG_ETH2ADDR
2112 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002113 CONFIG_ETH4ADDR
2114 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002115
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002116 Define a default value for Ethernet address to use
2117 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002118 is not determined automatically.
2119
2120- IP address:
2121 CONFIG_IPADDR
2122
2123 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002124 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002125 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002126 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002127
2128- Server IP address:
2129 CONFIG_SERVERIP
2130
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002131 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002132 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002133 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002134
Robin Getz470a6d42009-07-21 12:15:28 -04002135 CONFIG_KEEP_SERVERADDR
2136
2137 Keeps the server's MAC address, in the env 'serveraddr'
2138 for passing to bootargs (like Linux's netconsole option)
2139
Wolfgang Denk26da2992011-10-26 10:21:22 +00002140- Gateway IP address:
2141 CONFIG_GATEWAYIP
2142
2143 Defines a default value for the IP address of the
2144 default router where packets to other networks are
2145 sent to.
2146 (Environment variable "gatewayip")
2147
2148- Subnet mask:
2149 CONFIG_NETMASK
2150
2151 Defines a default value for the subnet mask (or
2152 routing prefix) which is used to determine if an IP
2153 address belongs to the local subnet or needs to be
2154 forwarded through a router.
2155 (Environment variable "netmask")
2156
David Updegraff7280da72007-06-11 10:41:07 -05002157- Multicast TFTP Mode:
2158 CONFIG_MCAST_TFTP
2159
2160 Defines whether you want to support multicast TFTP as per
2161 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002162 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002163 driver in use must provide a function: mcast() to join/leave a
2164 multicast group.
2165
wdenkc6097192002-11-03 00:24:07 +00002166- BOOTP Recovery Mode:
2167 CONFIG_BOOTP_RANDOM_DELAY
2168
2169 If you have many targets in a network that try to
2170 boot using BOOTP, you may want to avoid that all
2171 systems send out BOOTP requests at precisely the same
2172 moment (which would happen for instance at recovery
2173 from a power failure, when all systems will try to
2174 boot, thus flooding the BOOTP server. Defining
2175 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2176 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002177 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002178
2179 1st BOOTP request: delay 0 ... 1 sec
2180 2nd BOOTP request: delay 0 ... 2 sec
2181 3rd BOOTP request: delay 0 ... 4 sec
2182 4th and following
2183 BOOTP requests: delay 0 ... 8 sec
2184
Thierry Reding8977cda2014-08-19 10:21:24 +02002185 CONFIG_BOOTP_ID_CACHE_SIZE
2186
2187 BOOTP packets are uniquely identified using a 32-bit ID. The
2188 server will copy the ID from client requests to responses and
2189 U-Boot will use this to determine if it is the destination of
2190 an incoming response. Some servers will check that addresses
2191 aren't in use before handing them out (usually using an ARP
2192 ping) and therefore take up to a few hundred milliseconds to
2193 respond. Network congestion may also influence the time it
2194 takes for a response to make it back to the client. If that
2195 time is too long, U-Boot will retransmit requests. In order
2196 to allow earlier responses to still be accepted after these
2197 retransmissions, U-Boot's BOOTP client keeps a small cache of
2198 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2199 cache. The default is to keep IDs for up to four outstanding
2200 requests. Increasing this will allow U-Boot to accept offers
2201 from a BOOTP client in networks with unusually high latency.
2202
stroesee0aadfb2003-08-28 14:17:32 +00002203- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002204 You can fine tune the DHCP functionality by defining
2205 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002206
Jon Loeliger5336a762007-07-09 22:08:34 -05002207 CONFIG_BOOTP_SUBNETMASK
2208 CONFIG_BOOTP_GATEWAY
2209 CONFIG_BOOTP_HOSTNAME
2210 CONFIG_BOOTP_NISDOMAIN
2211 CONFIG_BOOTP_BOOTPATH
2212 CONFIG_BOOTP_BOOTFILESIZE
2213 CONFIG_BOOTP_DNS
2214 CONFIG_BOOTP_DNS2
2215 CONFIG_BOOTP_SEND_HOSTNAME
2216 CONFIG_BOOTP_NTPSERVER
2217 CONFIG_BOOTP_TIMEOFFSET
2218 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002219 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002220
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002221 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2222 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002223
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002224 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2225 after the configured retry count, the call will fail
2226 instead of starting over. This can be used to fail over
2227 to Link-local IP address configuration if the DHCP server
2228 is not available.
2229
stroesee0aadfb2003-08-28 14:17:32 +00002230 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2231 serverip from a DHCP server, it is possible that more
2232 than one DNS serverip is offered to the client.
2233 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2234 serverip will be stored in the additional environment
2235 variable "dnsip2". The first DNS serverip is always
2236 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002237 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002238
2239 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2240 to do a dynamic update of a DNS server. To do this, they
2241 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002242 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002243 of the "hostname" environment variable is passed as
2244 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002245
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002246 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2247
2248 A 32bit value in microseconds for a delay between
2249 receiving a "DHCP Offer" and sending the "DHCP Request".
2250 This fixes a problem with certain DHCP servers that don't
2251 respond 100% of the time to a "DHCP request". E.g. On an
2252 AT91RM9200 processor running at 180MHz, this delay needed
2253 to be *at least* 15,000 usec before a Windows Server 2003
2254 DHCP server would reply 100% of the time. I recommend at
2255 least 50,000 usec to be safe. The alternative is to hope
2256 that one of the retries will be successful but note that
2257 the DHCP timeout and retry process takes a longer than
2258 this delay.
2259
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002260 - Link-local IP address negotiation:
2261 Negotiate with other link-local clients on the local network
2262 for an address that doesn't require explicit configuration.
2263 This is especially useful if a DHCP server cannot be guaranteed
2264 to exist in all environments that the device must operate.
2265
2266 See doc/README.link-local for more information.
2267
wdenk145d2c12004-04-15 21:48:45 +00002268 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002269 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002270
2271 The device id used in CDP trigger frames.
2272
2273 CONFIG_CDP_DEVICE_ID_PREFIX
2274
2275 A two character string which is prefixed to the MAC address
2276 of the device.
2277
2278 CONFIG_CDP_PORT_ID
2279
2280 A printf format string which contains the ascii name of
2281 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002282 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002283
2284 CONFIG_CDP_CAPABILITIES
2285
2286 A 32bit integer which indicates the device capabilities;
2287 0x00000010 for a normal host which does not forwards.
2288
2289 CONFIG_CDP_VERSION
2290
2291 An ascii string containing the version of the software.
2292
2293 CONFIG_CDP_PLATFORM
2294
2295 An ascii string containing the name of the platform.
2296
2297 CONFIG_CDP_TRIGGER
2298
2299 A 32bit integer sent on the trigger.
2300
2301 CONFIG_CDP_POWER_CONSUMPTION
2302
2303 A 16bit integer containing the power consumption of the
2304 device in .1 of milliwatts.
2305
2306 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2307
2308 A byte containing the id of the VLAN.
2309
wdenkc6097192002-11-03 00:24:07 +00002310- Status LED: CONFIG_STATUS_LED
2311
2312 Several configurations allow to display the current
2313 status using a LED. For instance, the LED will blink
2314 fast while running U-Boot code, stop blinking as
2315 soon as a reply to a BOOTP request was received, and
2316 start blinking slow once the Linux kernel is running
2317 (supported by a status LED driver in the Linux
2318 kernel). Defining CONFIG_STATUS_LED enables this
2319 feature in U-Boot.
2320
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002321 Additional options:
2322
2323 CONFIG_GPIO_LED
2324 The status LED can be connected to a GPIO pin.
2325 In such cases, the gpio_led driver can be used as a
2326 status LED backend implementation. Define CONFIG_GPIO_LED
2327 to include the gpio_led driver in the U-Boot binary.
2328
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002329 CONFIG_GPIO_LED_INVERTED_TABLE
2330 Some GPIO connected LEDs may have inverted polarity in which
2331 case the GPIO high value corresponds to LED off state and
2332 GPIO low value corresponds to LED on state.
2333 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2334 with a list of GPIO LEDs that have inverted polarity.
2335
wdenkc6097192002-11-03 00:24:07 +00002336- CAN Support: CONFIG_CAN_DRIVER
2337
2338 Defining CONFIG_CAN_DRIVER enables CAN driver support
2339 on those systems that support this (optional)
2340 feature, like the TQM8xxL modules.
2341
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002342- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002343
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002344 This enable the NEW i2c subsystem, and will allow you to use
2345 i2c commands at the u-boot command line (as long as you set
2346 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2347 based realtime clock chips or other i2c devices. See
2348 common/cmd_i2c.c for a description of the command line
2349 interface.
2350
2351 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002352 - drivers/i2c/soft_i2c.c:
2353 - activate first bus with CONFIG_SYS_I2C_SOFT define
2354 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2355 for defining speed and slave address
2356 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2357 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2358 for defining speed and slave address
2359 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2360 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2361 for defining speed and slave address
2362 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2363 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2364 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002365
Heiko Schocherf2850742012-10-24 13:48:22 +02002366 - drivers/i2c/fsl_i2c.c:
2367 - activate i2c driver with CONFIG_SYS_I2C_FSL
2368 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2369 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2370 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2371 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002372 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002373 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2374 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2375 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2376 second bus.
2377
Simon Glass026fefb2012-10-30 07:28:53 +00002378 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002379 - activate this driver with CONFIG_SYS_I2C_TEGRA
2380 - This driver adds 4 i2c buses with a fix speed from
2381 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002382
Dirk Eibach42b204f2013-04-25 02:40:01 +00002383 - drivers/i2c/ppc4xx_i2c.c
2384 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2385 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2386 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2387
trema49f40a2013-09-21 18:13:35 +02002388 - drivers/i2c/i2c_mxc.c
2389 - activate this driver with CONFIG_SYS_I2C_MXC
2390 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2391 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2392 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2393 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2394 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2395 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2396 If thoses defines are not set, default value is 100000
2397 for speed, and 0 for slave.
2398
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002399 - drivers/i2c/rcar_i2c.c:
2400 - activate this driver with CONFIG_SYS_I2C_RCAR
2401 - This driver adds 4 i2c buses
2402
2403 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2404 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2405 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2406 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2407 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2408 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2409 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2410 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2411 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2412
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002413 - drivers/i2c/sh_i2c.c:
2414 - activate this driver with CONFIG_SYS_I2C_SH
2415 - This driver adds from 2 to 5 i2c buses
2416
2417 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2418 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2419 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2420 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2421 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2422 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2423 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2424 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2425 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2426 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2427 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2428 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2429 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2430
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002431 - drivers/i2c/omap24xx_i2c.c
2432 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2433 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2434 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2435 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2436 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2437 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2438 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2439 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2440 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2441 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2442 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2443
Heiko Schocher465819a2013-11-08 07:30:53 +01002444 - drivers/i2c/zynq_i2c.c
2445 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2446 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2447 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2448
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302449 - drivers/i2c/s3c24x0_i2c.c:
2450 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2451 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2452 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2453 with a fix speed from 100000 and the slave addr 0!
2454
Dirk Eibachb9577432014-07-03 09:28:18 +02002455 - drivers/i2c/ihs_i2c.c
2456 - activate this driver with CONFIG_SYS_I2C_IHS
2457 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2458 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2459 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2460 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2461 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2462 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2463 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2464 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2465 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2466 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2467 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2468 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2469
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002470 additional defines:
2471
2472 CONFIG_SYS_NUM_I2C_BUSES
2473 Hold the number of i2c busses you want to use. If you
2474 don't use/have i2c muxes on your i2c bus, this
2475 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2476 omit this define.
2477
2478 CONFIG_SYS_I2C_DIRECT_BUS
2479 define this, if you don't use i2c muxes on your hardware.
2480 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2481 omit this define.
2482
2483 CONFIG_SYS_I2C_MAX_HOPS
2484 define how many muxes are maximal consecutively connected
2485 on one i2c bus. If you not use i2c muxes, omit this
2486 define.
2487
2488 CONFIG_SYS_I2C_BUSES
2489 hold a list of busses you want to use, only used if
2490 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2491 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2492 CONFIG_SYS_NUM_I2C_BUSES = 9:
2493
2494 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2495 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2496 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2497 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2498 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2499 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2500 {1, {I2C_NULL_HOP}}, \
2501 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2502 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2503 }
2504
2505 which defines
2506 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002507 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2508 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2509 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2510 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2511 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002512 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002513 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2514 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002515
2516 If you do not have i2c muxes on your board, omit this define.
2517
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002518- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002519
2520 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2521 provides the following compelling advantages:
2522
2523 - more than one i2c adapter is usable
2524 - approved multibus support
2525 - better i2c mux support
2526
2527 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002528
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002529 These enable legacy I2C serial bus commands. Defining
2530 CONFIG_HARD_I2C will include the appropriate I2C driver
2531 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk21136db2003-07-16 21:53:01 +00002533 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002534 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002535 CONFIG_COMMANDS) and communicate with i2c based realtime
2536 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002537 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002538
Ben Warren45657152006-09-07 16:50:54 -04002539 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002540
wdenk21136db2003-07-16 21:53:01 +00002541 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002542 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002545 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002546 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002547 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002548
Peter Tysere4d1abc2010-04-12 22:28:21 -05002549 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002550 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002551 and so its address should therefore be cleared to 0 (See,
2552 eg, MPC823e User's Manual p.16-473). So, set
2553 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002554
Eric Millbrandt12990a42009-09-03 08:09:44 -05002555 CONFIG_SYS_I2C_INIT_MPC5XXX
2556
2557 When a board is reset during an i2c bus transfer
2558 chips might think that the current transfer is still
2559 in progress. Reset the slave devices by sending start
2560 commands until the slave device responds.
2561
wdenk21136db2003-07-16 21:53:01 +00002562 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002563
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002564 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002565 then the following macros need to be defined (examples are
2566 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002567
2568 I2C_INIT
2569
wdenkb9bbd242003-06-30 16:24:52 +00002570 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002571 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002572
wdenk544e9732004-02-06 23:19:44 +00002573 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002574
wdenkc6097192002-11-03 00:24:07 +00002575 I2C_PORT
2576
wdenk4a5c8a72003-03-06 00:02:04 +00002577 (Only for MPC8260 CPU). The I/O port to use (the code
2578 assumes both bits are on the same port). Valid values
2579 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002580
2581 I2C_ACTIVE
2582
2583 The code necessary to make the I2C data line active
2584 (driven). If the data line is open collector, this
2585 define can be null.
2586
wdenkb9bbd242003-06-30 16:24:52 +00002587 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2588
wdenkc6097192002-11-03 00:24:07 +00002589 I2C_TRISTATE
2590
2591 The code necessary to make the I2C data line tri-stated
2592 (inactive). If the data line is open collector, this
2593 define can be null.
2594
wdenkb9bbd242003-06-30 16:24:52 +00002595 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2596
wdenkc6097192002-11-03 00:24:07 +00002597 I2C_READ
2598
York Sun4a598092013-04-01 11:29:11 -07002599 Code that returns true if the I2C data line is high,
2600 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002601
wdenkb9bbd242003-06-30 16:24:52 +00002602 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2603
wdenkc6097192002-11-03 00:24:07 +00002604 I2C_SDA(bit)
2605
York Sun4a598092013-04-01 11:29:11 -07002606 If <bit> is true, sets the I2C data line high. If it
2607 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002608
wdenkb9bbd242003-06-30 16:24:52 +00002609 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002610 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002611 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002612
wdenkc6097192002-11-03 00:24:07 +00002613 I2C_SCL(bit)
2614
York Sun4a598092013-04-01 11:29:11 -07002615 If <bit> is true, sets the I2C clock line high. If it
2616 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002617
wdenkb9bbd242003-06-30 16:24:52 +00002618 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002619 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002620 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002621
wdenkc6097192002-11-03 00:24:07 +00002622 I2C_DELAY
2623
2624 This delay is invoked four times per clock cycle so this
2625 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002626 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002627 like:
2628
wdenkb9bbd242003-06-30 16:24:52 +00002629 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002630
Mike Frysingeree12d542010-07-21 13:38:02 -04002631 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2632
2633 If your arch supports the generic GPIO framework (asm/gpio.h),
2634 then you may alternatively define the two GPIOs that are to be
2635 used as SCL / SDA. Any of the previous I2C_xxx macros will
2636 have GPIO-based defaults assigned to them as appropriate.
2637
2638 You should define these to the GPIO value as given directly to
2639 the generic GPIO functions.
2640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002641 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002642
wdenk57b2d802003-06-27 21:31:46 +00002643 When a board is reset during an i2c bus transfer
2644 chips might think that the current transfer is still
2645 in progress. On some boards it is possible to access
2646 the i2c SCLK line directly, either by using the
2647 processor pin as a GPIO or by having a second pin
2648 connected to the bus. If this option is defined a
2649 custom i2c_init_board() routine in boards/xxx/board.c
2650 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002651
Richard Retanubundf0149c2010-04-12 15:08:17 -04002652 CONFIG_SYS_I2C_BOARD_LATE_INIT
2653
2654 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2655 defined a custom i2c_board_late_init() routine in
2656 boards/xxx/board.c is run AFTER the operations in i2c_init()
2657 is completed. This callpoint can be used to unreset i2c bus
2658 using CPU i2c controller register accesses for CPUs whose i2c
2659 controller provide such a method. It is called at the end of
2660 i2c_init() to allow i2c_init operations to setup the i2c bus
2661 controller on the CPU (e.g. setting bus speed & slave address).
2662
wdenk0e2bd9c2004-06-06 21:51:03 +00002663 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2664
2665 This option enables configuration of bi_iic_fast[] flags
2666 in u-boot bd_info structure based on u-boot environment
2667 variable "i2cfast". (see also i2cfast)
2668
Ben Warren45657152006-09-07 16:50:54 -04002669 CONFIG_I2C_MULTI_BUS
2670
2671 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002672 must have a controller. At any point in time, only one bus is
2673 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002674 Note that bus numbering is zero-based.
2675
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002676 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002677
2678 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002679 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002680 is set, specify a list of bus-device pairs. Otherwise, specify
2681 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002682
2683 e.g.
2684 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002685 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002686
2687 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2688
Wolfgang Denk092ae952011-10-26 10:21:21 +00002689 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002690 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002691
2692 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2693
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002694 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002695
2696 If defined, then this indicates the I2C bus number for DDR SPD.
2697 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002699 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002700
2701 If defined, then this indicates the I2C bus number for the RTC.
2702 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002704 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002705
2706 If defined, then this indicates the I2C bus number for the DTT.
2707 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002709 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002710
2711 If defined, specifies the I2C address of the DTT device.
2712 If not defined, then U-Boot uses predefined value for
2713 specified DTT device.
2714
Andrew Dyer58c41f92008-12-29 17:36:01 -06002715 CONFIG_SOFT_I2C_READ_REPEATED_START
2716
2717 defining this will force the i2c_read() function in
2718 the soft_i2c driver to perform an I2C repeated start
2719 between writing the address pointer and reading the
2720 data. If this define is omitted the default behaviour
2721 of doing a stop-start sequence will be used. Most I2C
2722 devices can use either method, but some require one or
2723 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002724
wdenkc6097192002-11-03 00:24:07 +00002725- SPI Support: CONFIG_SPI
2726
2727 Enables SPI driver (so far only tested with
2728 SPI EEPROM, also an instance works with Crystal A/D and
2729 D/As on the SACSng board)
2730
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002731 CONFIG_SH_SPI
2732
2733 Enables the driver for SPI controller on SuperH. Currently
2734 only SH7757 is supported.
2735
wdenkc6097192002-11-03 00:24:07 +00002736 CONFIG_SPI_X
2737
2738 Enables extended (16-bit) SPI EEPROM addressing.
2739 (symmetrical to CONFIG_I2C_X)
2740
2741 CONFIG_SOFT_SPI
2742
wdenk4a5c8a72003-03-06 00:02:04 +00002743 Enables a software (bit-bang) SPI driver rather than
2744 using hardware support. This is a general purpose
2745 driver that only requires three general I/O port pins
2746 (two outputs, one input) to function. If this is
2747 defined, the board configuration must define several
2748 SPI configuration items (port pins to use, etc). For
2749 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002750
Ben Warren7efe9272008-01-16 22:37:35 -05002751 CONFIG_HARD_SPI
2752
2753 Enables a hardware SPI driver for general-purpose reads
2754 and writes. As with CONFIG_SOFT_SPI, the board configuration
2755 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002756 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002757 example, see include/configs/mpc8349emds.h.
2758
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002759 CONFIG_MXC_SPI
2760
2761 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002762 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002763
Heiko Schocherb77c8882014-07-14 10:22:11 +02002764 CONFIG_SYS_SPI_MXC_WAIT
2765 Timeout for waiting until spi transfer completed.
2766 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2767
Matthias Fuchsa4400872007-12-27 17:12:34 +01002768- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002769
Matthias Fuchsa4400872007-12-27 17:12:34 +01002770 Enables FPGA subsystem.
2771
2772 CONFIG_FPGA_<vendor>
2773
2774 Enables support for specific chip vendors.
2775 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002776
Matthias Fuchsa4400872007-12-27 17:12:34 +01002777 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002778
Matthias Fuchsa4400872007-12-27 17:12:34 +01002779 Enables support for FPGA family.
2780 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2781
2782 CONFIG_FPGA_COUNT
2783
2784 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002785
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302786 CONFIG_CMD_FPGA_LOADMK
2787
2788 Enable support for fpga loadmk command
2789
Michal Simek64c70982014-05-02 13:43:39 +02002790 CONFIG_CMD_FPGA_LOADP
2791
2792 Enable support for fpga loadp command - load partial bitstream
2793
2794 CONFIG_CMD_FPGA_LOADBP
2795
2796 Enable support for fpga loadbp command - load partial bitstream
2797 (Xilinx only)
2798
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002799 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002800
wdenk57b2d802003-06-27 21:31:46 +00002801 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002803 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002804
wdenk4a5c8a72003-03-06 00:02:04 +00002805 Enable checks on FPGA configuration interface busy
2806 status by the configuration function. This option
2807 will require a board or device specific function to
2808 be written.
wdenkc6097192002-11-03 00:24:07 +00002809
2810 CONFIG_FPGA_DELAY
2811
2812 If defined, a function that provides delays in the FPGA
2813 configuration driver.
2814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002815 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002816 Allow Control-C to interrupt FPGA configuration
2817
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002818 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002819
wdenk4a5c8a72003-03-06 00:02:04 +00002820 Check for configuration errors during FPGA bitfile
2821 loading. For example, abort during Virtex II
2822 configuration if the INIT_B line goes low (which
2823 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk4a5c8a72003-03-06 00:02:04 +00002827 Maximum time to wait for the INIT_B line to deassert
2828 after PROB_B has been deasserted during a Virtex II
2829 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002830 ms.
wdenkc6097192002-11-03 00:24:07 +00002831
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002832 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002833
wdenk4a5c8a72003-03-06 00:02:04 +00002834 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002835 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002836
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002837 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002838
wdenk4a5c8a72003-03-06 00:02:04 +00002839 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002840 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002841
2842- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002843 CONFIG_BUILD_TARGET
2844
2845 Some SoCs need special image types (e.g. U-Boot binary
2846 with a special header) as build targets. By defining
2847 CONFIG_BUILD_TARGET in the SoC / board header, this
2848 special image will be automatically built upon calling
2849 make / MAKEALL.
2850
wdenkc6097192002-11-03 00:24:07 +00002851 CONFIG_IDENT_STRING
2852
wdenk4a5c8a72003-03-06 00:02:04 +00002853 If defined, this string will be added to the U-Boot
2854 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002855
2856- Vendor Parameter Protection:
2857
wdenk4a5c8a72003-03-06 00:02:04 +00002858 U-Boot considers the values of the environment
2859 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002860 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002861 are set once by the board vendor / manufacturer, and
2862 protects these variables from casual modification by
2863 the user. Once set, these variables are read-only,
2864 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002865 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002866
2867 If CONFIG_ENV_OVERWRITE is #defined in your config
2868 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002869 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002870 these parameters.
2871
2872 Alternatively, if you #define _both_ CONFIG_ETHADDR
2873 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002874 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002875 which can be changed exactly ONCE by the user. [The
2876 serial# is unaffected by this, i. e. it remains
2877 read-only.]
2878
Joe Hershberger71497d02012-12-11 22:16:31 -06002879 The same can be accomplished in a more flexible way
2880 for any variable by configuring the type of access
2881 to allow for those variables in the ".flags" variable
2882 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2883
wdenkc6097192002-11-03 00:24:07 +00002884- Protected RAM:
2885 CONFIG_PRAM
2886
2887 Define this variable to enable the reservation of
2888 "protected RAM", i. e. RAM which is not overwritten
2889 by U-Boot. Define CONFIG_PRAM to hold the number of
2890 kB you want to reserve for pRAM. You can overwrite
2891 this default value by defining an environment
2892 variable "pram" to the number of kB you want to
2893 reserve. Note that the board info structure will
2894 still show the full amount of RAM. If pRAM is
2895 reserved, a new environment variable "mem" will
2896 automatically be defined to hold the amount of
2897 remaining RAM in a form that can be passed as boot
2898 argument to Linux, for instance like that:
2899
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002900 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002901 saveenv
2902
2903 This way you can tell Linux not to use this memory,
2904 either, which results in a memory region that will
2905 not be affected by reboots.
2906
2907 *WARNING* If your board configuration uses automatic
2908 detection of the RAM size, you must make sure that
2909 this memory test is non-destructive. So far, the
2910 following board configurations are known to be
2911 "pRAM-clean":
2912
Wolfgang Denk90326762012-10-24 02:36:15 +00002913 IVMS8, IVML24, SPD8xx, TQM8xxL,
2914 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002915 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002916
Gabe Blacka2f3a932012-12-02 04:55:18 +00002917- Access to physical memory region (> 4GB)
2918 Some basic support is provided for operations on memory not
2919 normally accessible to U-Boot - e.g. some architectures
2920 support access to more than 4GB of memory on 32-bit
2921 machines using physical address extension or similar.
2922 Define CONFIG_PHYSMEM to access this basic support, which
2923 currently only supports clearing the memory.
2924
wdenkc6097192002-11-03 00:24:07 +00002925- Error Recovery:
2926 CONFIG_PANIC_HANG
2927
2928 Define this variable to stop the system in case of a
2929 fatal error, so that you have to reset it manually.
2930 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002931 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002932 automatically as fast as possible, but it may be
2933 useful during development since you can try to debug
2934 the conditions that lead to the situation.
2935
2936 CONFIG_NET_RETRY_COUNT
2937
wdenk4a5c8a72003-03-06 00:02:04 +00002938 This variable defines the number of retries for
2939 network operations like ARP, RARP, TFTP, or BOOTP
2940 before giving up the operation. If not defined, a
2941 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002942
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002943 CONFIG_ARP_TIMEOUT
2944
2945 Timeout waiting for an ARP reply in milliseconds.
2946
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002947 CONFIG_NFS_TIMEOUT
2948
2949 Timeout in milliseconds used in NFS protocol.
2950 If you encounter "ERROR: Cannot umount" in nfs command,
2951 try longer timeout such as
2952 #define CONFIG_NFS_TIMEOUT 10000UL
2953
wdenkc6097192002-11-03 00:24:07 +00002954- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002955 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002956
2957 Enable auto completion of commands using TAB.
2958
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002959 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002960
2961 This defines the secondary prompt string, which is
2962 printed when the command interpreter needs more input
2963 to complete a command. Usually "> ".
2964
2965 Note:
2966
wdenk57b2d802003-06-27 21:31:46 +00002967 In the current implementation, the local variables
2968 space and global environment variables space are
2969 separated. Local variables are those you define by
2970 simply typing `name=value'. To access a local
2971 variable later on, you have write `$name' or
2972 `${name}'; to execute the contents of a variable
2973 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002974
wdenk4a5c8a72003-03-06 00:02:04 +00002975 Global environment variables are those you use
2976 setenv/printenv to work with. To run a command stored
2977 in such a variable, you need to use the run command,
2978 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002979
2980 To store commands and special characters in a
2981 variable, please use double quotation marks
2982 surrounding the whole text of the variable, instead
2983 of the backslashes before semicolons and special
2984 symbols.
2985
Wolfgang Denk2039a072006-07-21 11:35:21 +02002986- Commandline Editing and History:
2987 CONFIG_CMDLINE_EDITING
2988
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002989 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002990 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002991
wdenkc0aa5c52003-12-06 19:49:23 +00002992- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002993 CONFIG_EXTRA_ENV_SETTINGS
2994
wdenk4a5c8a72003-03-06 00:02:04 +00002995 Define this to contain any number of null terminated
2996 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002997 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002998
wdenk4a5c8a72003-03-06 00:02:04 +00002999 For example, place something like this in your
3000 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003001
3002 #define CONFIG_EXTRA_ENV_SETTINGS \
3003 "myvar1=value1\0" \
3004 "myvar2=value2\0"
3005
wdenk4a5c8a72003-03-06 00:02:04 +00003006 Warning: This method is based on knowledge about the
3007 internal format how the environment is stored by the
3008 U-Boot code. This is NOT an official, exported
3009 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003010 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003011 You better know what you are doing here.
3012
wdenk4a5c8a72003-03-06 00:02:04 +00003013 Note: overly (ab)use of the default environment is
3014 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003015 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003016 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003017
Stephen Warren1465d5f2012-05-22 09:21:54 +00003018 CONFIG_ENV_VARS_UBOOT_CONFIG
3019
3020 Define this in order to add variables describing the
3021 U-Boot build configuration to the default environment.
3022 These will be named arch, cpu, board, vendor, and soc.
3023
3024 Enabling this option will cause the following to be defined:
3025
3026 - CONFIG_SYS_ARCH
3027 - CONFIG_SYS_CPU
3028 - CONFIG_SYS_BOARD
3029 - CONFIG_SYS_VENDOR
3030 - CONFIG_SYS_SOC
3031
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003032 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3033
3034 Define this in order to add variables describing certain
3035 run-time determined information about the hardware to the
3036 environment. These will be named board_name, board_rev.
3037
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003038 CONFIG_DELAY_ENVIRONMENT
3039
3040 Normally the environment is loaded when the board is
3041 intialised so that it is available to U-Boot. This inhibits
3042 that so that the environment is not available until
3043 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3044 this is instead controlled by the value of
3045 /config/load-environment.
3046
wdenkc0aa5c52003-12-06 19:49:23 +00003047- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003048 CONFIG_HAS_DATAFLASH
3049
wdenk57b2d802003-06-27 21:31:46 +00003050 Defining this option enables DataFlash features and
3051 allows to read/write in Dataflash via the standard
3052 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003053
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003054- Serial Flash support
3055 CONFIG_CMD_SF
3056
3057 Defining this option enables SPI flash commands
3058 'sf probe/read/write/erase/update'.
3059
3060 Usage requires an initial 'probe' to define the serial
3061 flash parameters, followed by read/write/erase/update
3062 commands.
3063
3064 The following defaults may be provided by the platform
3065 to handle the common case when only a single serial
3066 flash is present on the system.
3067
3068 CONFIG_SF_DEFAULT_BUS Bus identifier
3069 CONFIG_SF_DEFAULT_CS Chip-select
3070 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3071 CONFIG_SF_DEFAULT_SPEED in Hz
3072
Simon Glass4b5545e2012-10-08 13:16:02 +00003073 CONFIG_CMD_SF_TEST
3074
3075 Define this option to include a destructive SPI flash
3076 test ('sf test').
3077
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303078 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3079
3080 Define this option to use the Bank addr/Extended addr
3081 support on SPI flashes which has size > 16Mbytes.
3082
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303083 CONFIG_SF_DUAL_FLASH Dual flash memories
3084
3085 Define this option to use dual flash support where two flash
3086 memories can be connected with a given cs line.
3087 currently Xilinx Zynq qspi support these type of connections.
3088
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02003089 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3090 enable the W#/Vpp signal to disable writing to the status
3091 register on ST MICRON flashes like the N25Q128.
3092 The status register write enable/disable bit, combined with
3093 the W#/VPP signal provides hardware data protection for the
3094 device as follows: When the enable/disable bit is set to 1,
3095 and the W#/VPP signal is driven LOW, the status register
3096 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3097 operation will not execute. The only way to exit this
3098 hardware-protected mode is to drive W#/VPP HIGH.
3099
wdenkef893942004-02-23 16:11:30 +00003100- SystemACE Support:
3101 CONFIG_SYSTEMACE
3102
3103 Adding this option adds support for Xilinx SystemACE
3104 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003105 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003106 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003107
3108 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003109 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003110
3111 When SystemACE support is added, the "ace" device type
3112 becomes available to the fat commands, i.e. fatls.
3113
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003114- TFTP Fixed UDP Port:
3115 CONFIG_TFTP_PORT
3116
Wolfgang Denk227b5192005-09-24 23:25:46 +02003117 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003118 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003119 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003120 number generator is used.
3121
Wolfgang Denk227b5192005-09-24 23:25:46 +02003122 Also, the environment variable tftpdstp is used to supply
3123 the TFTP UDP destination port value. If tftpdstp isn't
3124 defined, the normal port 69 is used.
3125
3126 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003127 blindly start the TFTP transfer using the pre-configured
3128 target IP address and UDP port. This has the effect of
3129 "punching through" the (Windows XP) firewall, allowing
3130 the remainder of the TFTP transfer to proceed normally.
3131 A better solution is to properly configure the firewall,
3132 but sometimes that is not allowed.
3133
Simon Glass058bb8d2012-12-05 14:46:38 +00003134- Hashing support:
3135 CONFIG_CMD_HASH
3136
3137 This enables a generic 'hash' command which can produce
3138 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3139
3140 CONFIG_HASH_VERIFY
3141
3142 Enable the hash verify command (hash -v). This adds to code
3143 size a little.
3144
3145 CONFIG_SHA1 - support SHA1 hashing
3146 CONFIG_SHA256 - support SHA256 hashing
3147
3148 Note: There is also a sha1sum command, which should perhaps
3149 be deprecated in favour of 'hash sha1'.
3150
Robert Winkler765ccf42013-07-24 17:57:06 -07003151- Freescale i.MX specific commands:
3152 CONFIG_CMD_HDMIDETECT
3153 This enables 'hdmidet' command which returns true if an
3154 HDMI monitor is detected. This command is i.MX 6 specific.
3155
3156 CONFIG_CMD_BMODE
3157 This enables the 'bmode' (bootmode) command for forcing
3158 a boot from specific media.
3159
3160 This is useful for forcing the ROM's usb downloader to
3161 activate upon a watchdog reset which is nice when iterating
3162 on U-Boot. Using the reset button or running bmode normal
3163 will set it back to normal. This command currently
3164 supports i.MX53 and i.MX6.
3165
Simon Glass35191a32013-06-13 15:10:02 -07003166- Signing support:
3167 CONFIG_RSA
3168
3169 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003170 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003171
3172 The signing part is build into mkimage regardless of this
3173 option.
3174
Heiko Schocher443ca402014-01-25 07:27:13 +01003175- bootcount support:
3176 CONFIG_BOOTCOUNT_LIMIT
3177
3178 This enables the bootcounter support, see:
3179 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3180
3181 CONFIG_AT91SAM9XE
3182 enable special bootcounter support on at91sam9xe based boards.
3183 CONFIG_BLACKFIN
3184 enable special bootcounter support on blackfin based boards.
3185 CONFIG_SOC_DA8XX
3186 enable special bootcounter support on da850 based boards.
3187 CONFIG_BOOTCOUNT_RAM
3188 enable support for the bootcounter in RAM
3189 CONFIG_BOOTCOUNT_I2C
3190 enable support for the bootcounter on an i2c (like RTC) device.
3191 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3192 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3193 the bootcounter.
3194 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003195
wdenkc0aa5c52003-12-06 19:49:23 +00003196- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003197 CONFIG_SHOW_BOOT_PROGRESS
3198
wdenk4a5c8a72003-03-06 00:02:04 +00003199 Defining this option allows to add some board-
3200 specific code (calling a user-provided function
3201 "show_boot_progress(int)") that enables you to show
3202 the system's boot progress on some display (for
3203 example, some LED's) on your board. At the moment,
3204 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003205
Simon Glass31a870e2012-02-13 13:51:19 +00003206- Detailed boot stage timing
3207 CONFIG_BOOTSTAGE
3208 Define this option to get detailed timing of each stage
3209 of the boot process.
3210
3211 CONFIG_BOOTSTAGE_USER_COUNT
3212 This is the number of available user bootstage records.
3213 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3214 a new ID will be allocated from this stash. If you exceed
3215 the limit, recording will stop.
3216
3217 CONFIG_BOOTSTAGE_REPORT
3218 Define this to print a report before boot, similar to this:
3219
3220 Timer summary in microseconds:
3221 Mark Elapsed Stage
3222 0 0 reset
3223 3,575,678 3,575,678 board_init_f start
3224 3,575,695 17 arch_cpu_init A9
3225 3,575,777 82 arch_cpu_init done
3226 3,659,598 83,821 board_init_r start
3227 3,910,375 250,777 main_loop
3228 29,916,167 26,005,792 bootm_start
3229 30,361,327 445,160 start_kernel
3230
Simon Glass4afd88e2012-09-28 08:56:39 +00003231 CONFIG_CMD_BOOTSTAGE
3232 Add a 'bootstage' command which supports printing a report
3233 and un/stashing of bootstage data.
3234
Simon Glass0fa36a42012-09-28 08:56:37 +00003235 CONFIG_BOOTSTAGE_FDT
3236 Stash the bootstage information in the FDT. A root 'bootstage'
3237 node is created with each bootstage id as a child. Each child
3238 has a 'name' property and either 'mark' containing the
3239 mark time in microsecond, or 'accum' containing the
3240 accumulated time for that bootstage id in microseconds.
3241 For example:
3242
3243 bootstage {
3244 154 {
3245 name = "board_init_f";
3246 mark = <3575678>;
3247 };
3248 170 {
3249 name = "lcd";
3250 accum = <33482>;
3251 };
3252 };
3253
3254 Code in the Linux kernel can find this in /proc/devicetree.
3255
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003256Legacy uImage format:
3257
wdenkc6097192002-11-03 00:24:07 +00003258 Arg Where When
3259 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003260 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003261 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003262 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003263 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003264 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003265 4 common/cmd_bootm.c Image data has correct checksum
3266 -4 common/cmd_bootm.c Image is for unsupported architecture
3267 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003268 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003269 6 common/cmd_bootm.c Image Type check OK
3270 -6 common/cmd_bootm.c gunzip uncompression error
3271 -7 common/cmd_bootm.c Unimplemented compression type
3272 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003273 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003274 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003275
3276 9 common/image.c Start initial ramdisk verification
3277 -10 common/image.c Ramdisk header has bad magic number
3278 -11 common/image.c Ramdisk header has bad checksum
3279 10 common/image.c Ramdisk header is OK
3280 -12 common/image.c Ramdisk data has bad checksum
3281 11 common/image.c Ramdisk data has correct checksum
3282 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003283 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003284 13 common/image.c Start multifile image verification
3285 14 common/image.c No initial ramdisk, no multifile, continue.
3286
Wolfgang Denk092ae952011-10-26 10:21:21 +00003287 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003288
Stefan Roese88fbf932010-04-15 16:07:28 +02003289 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003290 -31 post/post.c POST test failed, detected by post_output_backlog()
3291 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003292
Heiko Schocher633e03a2007-06-22 19:11:54 +02003293 34 common/cmd_doc.c before loading a Image from a DOC device
3294 -35 common/cmd_doc.c Bad usage of "doc" command
3295 35 common/cmd_doc.c correct usage of "doc" command
3296 -36 common/cmd_doc.c No boot device
3297 36 common/cmd_doc.c correct boot device
3298 -37 common/cmd_doc.c Unknown Chip ID on boot device
3299 37 common/cmd_doc.c correct chip ID found, device available
3300 -38 common/cmd_doc.c Read Error on boot device
3301 38 common/cmd_doc.c reading Image header from DOC device OK
3302 -39 common/cmd_doc.c Image header has bad magic number
3303 39 common/cmd_doc.c Image header has correct magic number
3304 -40 common/cmd_doc.c Error reading Image from DOC device
3305 40 common/cmd_doc.c Image header has correct magic number
3306 41 common/cmd_ide.c before loading a Image from a IDE device
3307 -42 common/cmd_ide.c Bad usage of "ide" command
3308 42 common/cmd_ide.c correct usage of "ide" command
3309 -43 common/cmd_ide.c No boot device
3310 43 common/cmd_ide.c boot device found
3311 -44 common/cmd_ide.c Device not available
3312 44 common/cmd_ide.c Device available
3313 -45 common/cmd_ide.c wrong partition selected
3314 45 common/cmd_ide.c partition selected
3315 -46 common/cmd_ide.c Unknown partition table
3316 46 common/cmd_ide.c valid partition table found
3317 -47 common/cmd_ide.c Invalid partition type
3318 47 common/cmd_ide.c correct partition type
3319 -48 common/cmd_ide.c Error reading Image Header on boot device
3320 48 common/cmd_ide.c reading Image Header from IDE device OK
3321 -49 common/cmd_ide.c Image header has bad magic number
3322 49 common/cmd_ide.c Image header has correct magic number
3323 -50 common/cmd_ide.c Image header has bad checksum
3324 50 common/cmd_ide.c Image header has correct checksum
3325 -51 common/cmd_ide.c Error reading Image from IDE device
3326 51 common/cmd_ide.c reading Image from IDE device OK
3327 52 common/cmd_nand.c before loading a Image from a NAND device
3328 -53 common/cmd_nand.c Bad usage of "nand" command
3329 53 common/cmd_nand.c correct usage of "nand" command
3330 -54 common/cmd_nand.c No boot device
3331 54 common/cmd_nand.c boot device found
3332 -55 common/cmd_nand.c Unknown Chip ID on boot device
3333 55 common/cmd_nand.c correct chip ID found, device available
3334 -56 common/cmd_nand.c Error reading Image Header on boot device
3335 56 common/cmd_nand.c reading Image Header from NAND device OK
3336 -57 common/cmd_nand.c Image header has bad magic number
3337 57 common/cmd_nand.c Image header has correct magic number
3338 -58 common/cmd_nand.c Error reading Image from NAND device
3339 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003340
Heiko Schocher633e03a2007-06-22 19:11:54 +02003341 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003342
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003343 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003344 -64 net/eth.c no Ethernet found.
3345 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003346
Heiko Schocher633e03a2007-06-22 19:11:54 +02003347 -80 common/cmd_net.c usage wrong
3348 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003349 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003350 81 common/cmd_net.c NetLoop() back without error
3351 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3352 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003353 83 common/cmd_net.c running "source" command
3354 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003355 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003356
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003357FIT uImage format:
3358
3359 Arg Where When
3360 100 common/cmd_bootm.c Kernel FIT Image has correct format
3361 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3362 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3363 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3364 102 common/cmd_bootm.c Kernel unit name specified
3365 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003366 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003367 104 common/cmd_bootm.c Got kernel subimage node offset
3368 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3369 105 common/cmd_bootm.c Kernel subimage hash verification OK
3370 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3371 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003372 -106 common/cmd_bootm.c Kernel subimage has wrong type
3373 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003374 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3375 108 common/cmd_bootm.c Got kernel subimage data/size
3376 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3377 -109 common/cmd_bootm.c Can't get kernel subimage type
3378 -110 common/cmd_bootm.c Can't get kernel subimage comp
3379 -111 common/cmd_bootm.c Can't get kernel subimage os
3380 -112 common/cmd_bootm.c Can't get kernel subimage load address
3381 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3382
3383 120 common/image.c Start initial ramdisk verification
3384 -120 common/image.c Ramdisk FIT image has incorrect format
3385 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003386 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003387 -122 common/image.c Can't get configuration for ramdisk subimage
3388 123 common/image.c Ramdisk unit name specified
3389 -124 common/image.c Can't get ramdisk subimage node offset
3390 125 common/image.c Got ramdisk subimage node offset
3391 -125 common/image.c Ramdisk subimage hash verification failed
3392 126 common/image.c Ramdisk subimage hash verification OK
3393 -126 common/image.c Ramdisk subimage for unsupported architecture
3394 127 common/image.c Architecture check OK
3395 -127 common/image.c Can't get ramdisk subimage data/size
3396 128 common/image.c Got ramdisk subimage data/size
3397 129 common/image.c Can't get ramdisk load address
3398 -129 common/image.c Got ramdisk load address
3399
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003400 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003401 131 common/cmd_doc.c FIT image format OK
3402
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003403 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003404 141 common/cmd_ide.c FIT image format OK
3405
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003406 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003407 151 common/cmd_nand.c FIT image format OK
3408
Heiko Schocher515eb122014-05-28 11:33:33 +02003409- legacy image format:
3410 CONFIG_IMAGE_FORMAT_LEGACY
3411 enables the legacy image format support in U-Boot.
3412
3413 Default:
3414 enabled if CONFIG_FIT_SIGNATURE is not defined.
3415
3416 CONFIG_DISABLE_IMAGE_LEGACY
3417 disable the legacy image format
3418
3419 This define is introduced, as the legacy image format is
3420 enabled per default for backward compatibility.
3421
Gabe Blackd572e162012-10-25 16:31:10 +00003422- FIT image support:
3423 CONFIG_FIT
3424 Enable support for the FIT uImage format.
3425
3426 CONFIG_FIT_BEST_MATCH
3427 When no configuration is explicitly selected, default to the
3428 one whose fdt's compatibility field best matches that of
3429 U-Boot itself. A match is considered "best" if it matches the
3430 most specific compatibility entry of U-Boot's fdt's root node.
3431 The order of entries in the configuration's fdt is ignored.
3432
Simon Glass58fe7e52013-06-13 15:10:00 -07003433 CONFIG_FIT_SIGNATURE
3434 This option enables signature verification of FIT uImages,
3435 using a hash signed and verified using RSA. See
3436 doc/uImage.FIT/signature.txt for more details.
3437
Heiko Schocher515eb122014-05-28 11:33:33 +02003438 WARNING: When relying on signed FIT images with required
3439 signature check the legacy image format is default
3440 disabled. If a board need legacy image format support
3441 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3442
Dirk Eibach88919ca2014-07-03 09:28:26 +02003443 CONFIG_FIT_DISABLE_SHA256
3444 Supporting SHA256 hashes has quite an impact on binary size.
3445 For constrained systems sha256 hash support can be disabled
3446 with this option.
3447
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003448- Standalone program support:
3449 CONFIG_STANDALONE_LOAD_ADDR
3450
Wolfgang Denk23f78482011-10-09 21:06:34 +02003451 This option defines a board specific value for the
3452 address where standalone program gets loaded, thus
3453 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003454 settings.
3455
3456- Frame Buffer Address:
3457 CONFIG_FB_ADDR
3458
3459 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003460 address for frame buffer. This is typically the case
3461 when using a graphics controller has separate video
3462 memory. U-Boot will then place the frame buffer at
3463 the given address instead of dynamically reserving it
3464 in system RAM by calling lcd_setmem(), which grabs
3465 the memory for the frame buffer depending on the
3466 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003467
3468 Please see board_init_f function.
3469
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003470- Automatic software updates via TFTP server
3471 CONFIG_UPDATE_TFTP
3472 CONFIG_UPDATE_TFTP_CNT_MAX
3473 CONFIG_UPDATE_TFTP_MSEC_MAX
3474
3475 These options enable and control the auto-update feature;
3476 for a more detailed description refer to doc/README.update.
3477
3478- MTD Support (mtdparts command, UBI support)
3479 CONFIG_MTD_DEVICE
3480
3481 Adds the MTD device infrastructure from the Linux kernel.
3482 Needed for mtdparts command support.
3483
3484 CONFIG_MTD_PARTITIONS
3485
3486 Adds the MTD partitioning infrastructure from the Linux
3487 kernel. Needed for UBI support.
3488
Heiko Schocherf5895d12014-06-24 10:10:04 +02003489 CONFIG_MTD_NAND_VERIFY_WRITE
3490 verify if the written data is correct reread.
3491
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003492- UBI support
3493 CONFIG_CMD_UBI
3494
3495 Adds commands for interacting with MTD partitions formatted
3496 with the UBI flash translation layer
3497
3498 Requires also defining CONFIG_RBTREE
3499
Joe Hershberger47550fc2013-04-08 10:32:49 +00003500 CONFIG_UBI_SILENCE_MSG
3501
3502 Make the verbose messages from UBI stop printing. This leaves
3503 warnings and errors enabled.
3504
Heiko Schocherf5895d12014-06-24 10:10:04 +02003505
3506 CONFIG_MTD_UBI_WL_THRESHOLD
3507 This parameter defines the maximum difference between the highest
3508 erase counter value and the lowest erase counter value of eraseblocks
3509 of UBI devices. When this threshold is exceeded, UBI starts performing
3510 wear leveling by means of moving data from eraseblock with low erase
3511 counter to eraseblocks with high erase counter.
3512
3513 The default value should be OK for SLC NAND flashes, NOR flashes and
3514 other flashes which have eraseblock life-cycle 100000 or more.
3515 However, in case of MLC NAND flashes which typically have eraseblock
3516 life-cycle less than 10000, the threshold should be lessened (e.g.,
3517 to 128 or 256, although it does not have to be power of 2).
3518
3519 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003520
Heiko Schocherf5895d12014-06-24 10:10:04 +02003521 CONFIG_MTD_UBI_BEB_LIMIT
3522 This option specifies the maximum bad physical eraseblocks UBI
3523 expects on the MTD device (per 1024 eraseblocks). If the
3524 underlying flash does not admit of bad eraseblocks (e.g. NOR
3525 flash), this value is ignored.
3526
3527 NAND datasheets often specify the minimum and maximum NVM
3528 (Number of Valid Blocks) for the flashes' endurance lifetime.
3529 The maximum expected bad eraseblocks per 1024 eraseblocks
3530 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3531 which gives 20 for most NANDs (MaxNVB is basically the total
3532 count of eraseblocks on the chip).
3533
3534 To put it differently, if this value is 20, UBI will try to
3535 reserve about 1.9% of physical eraseblocks for bad blocks
3536 handling. And that will be 1.9% of eraseblocks on the entire
3537 NAND chip, not just the MTD partition UBI attaches. This means
3538 that if you have, say, a NAND flash chip admits maximum 40 bad
3539 eraseblocks, and it is split on two MTD partitions of the same
3540 size, UBI will reserve 40 eraseblocks when attaching a
3541 partition.
3542
3543 default: 20
3544
3545 CONFIG_MTD_UBI_FASTMAP
3546 Fastmap is a mechanism which allows attaching an UBI device
3547 in nearly constant time. Instead of scanning the whole MTD device it
3548 only has to locate a checkpoint (called fastmap) on the device.
3549 The on-flash fastmap contains all information needed to attach
3550 the device. Using fastmap makes only sense on large devices where
3551 attaching by scanning takes long. UBI will not automatically install
3552 a fastmap on old images, but you can set the UBI parameter
3553 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3554 that fastmap-enabled images are still usable with UBI implementations
3555 without fastmap support. On typical flash devices the whole fastmap
3556 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3557
3558 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3559 Set this parameter to enable fastmap automatically on images
3560 without a fastmap.
3561 default: 0
3562
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003563- UBIFS support
3564 CONFIG_CMD_UBIFS
3565
3566 Adds commands for interacting with UBI volumes formatted as
3567 UBIFS. UBIFS is read-only in u-boot.
3568
3569 Requires UBI support as well as CONFIG_LZO
3570
Joe Hershberger47550fc2013-04-08 10:32:49 +00003571 CONFIG_UBIFS_SILENCE_MSG
3572
3573 Make the verbose messages from UBIFS stop printing. This leaves
3574 warnings and errors enabled.
3575
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003576- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003577 CONFIG_SPL
3578 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003579
Tom Rini36853852012-02-14 07:29:40 +00003580 CONFIG_SPL_LDSCRIPT
3581 LDSCRIPT for linking the SPL binary.
3582
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003583 CONFIG_SPL_MAX_FOOTPRINT
3584 Maximum size in memory allocated to the SPL, BSS included.
3585 When defined, the linker checks that the actual memory
3586 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003587 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003588 must not be both defined at the same time.
3589
Tom Rini36853852012-02-14 07:29:40 +00003590 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003591 Maximum size of the SPL image (text, data, rodata, and
3592 linker lists sections), BSS excluded.
3593 When defined, the linker checks that the actual size does
3594 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003595
Wolfgang Denk825223d2011-09-11 21:24:09 +02003596 CONFIG_SPL_TEXT_BASE
3597 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003598
Scott Woodc4f0d002012-09-20 19:05:12 -05003599 CONFIG_SPL_RELOC_TEXT_BASE
3600 Address to relocate to. If unspecified, this is equal to
3601 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3602
Tom Rini36853852012-02-14 07:29:40 +00003603 CONFIG_SPL_BSS_START_ADDR
3604 Link address for the BSS within the SPL binary.
3605
3606 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003607 Maximum size in memory allocated to the SPL BSS.
3608 When defined, the linker checks that the actual memory used
3609 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003610 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003611 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003612
3613 CONFIG_SPL_STACK
3614 Adress of the start of the stack SPL will use
3615
Scott Woodc4f0d002012-09-20 19:05:12 -05003616 CONFIG_SPL_RELOC_STACK
3617 Adress of the start of the stack SPL will use after
3618 relocation. If unspecified, this is equal to
3619 CONFIG_SPL_STACK.
3620
Tom Rini36853852012-02-14 07:29:40 +00003621 CONFIG_SYS_SPL_MALLOC_START
3622 Starting address of the malloc pool used in SPL.
3623
3624 CONFIG_SYS_SPL_MALLOC_SIZE
3625 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003626
Tom Rini28591df2012-08-13 12:03:19 -07003627 CONFIG_SPL_FRAMEWORK
3628 Enable the SPL framework under common/. This framework
3629 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3630 NAND loading of the Linux Kernel.
3631
Tom Rinic2b76002014-03-28 12:03:39 -04003632 CONFIG_SPL_OS_BOOT
3633 Enable booting directly to an OS from SPL.
3634 See also: doc/README.falcon
3635
Tom Rinife3b0c72012-08-13 11:37:56 -07003636 CONFIG_SPL_DISPLAY_PRINT
3637 For ARM, enable an optional function to print more information
3638 about the running system.
3639
Scott Wood7c810902012-09-20 16:35:21 -05003640 CONFIG_SPL_INIT_MINIMAL
3641 Arch init code should be built for a very small image
3642
Wolfgang Denk825223d2011-09-11 21:24:09 +02003643 CONFIG_SPL_LIBCOMMON_SUPPORT
3644 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003645
Wolfgang Denk825223d2011-09-11 21:24:09 +02003646 CONFIG_SPL_LIBDISK_SUPPORT
3647 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003648
Wolfgang Denk825223d2011-09-11 21:24:09 +02003649 CONFIG_SPL_I2C_SUPPORT
3650 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003651
Wolfgang Denk825223d2011-09-11 21:24:09 +02003652 CONFIG_SPL_GPIO_SUPPORT
3653 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003654
Wolfgang Denk825223d2011-09-11 21:24:09 +02003655 CONFIG_SPL_MMC_SUPPORT
3656 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003657
Tom Rini36853852012-02-14 07:29:40 +00003658 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3659 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Guillaume GARDET5065b712014-10-15 17:53:13 +02003660 CONFIG_SYS_MMC_SD_FS_BOOT_PARTITION
Tom Rini36853852012-02-14 07:29:40 +00003661 Address, size and partition on the MMC to load U-Boot from
3662 when the MMC is being used in raw mode.
3663
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003664 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3665 Sector to load kernel uImage from when MMC is being
3666 used in raw mode (for Falcon mode)
3667
3668 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3669 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3670 Sector and number of sectors to load kernel argument
3671 parameters from when MMC is being used in raw mode
3672 (for falcon mode)
3673
Tom Rini36853852012-02-14 07:29:40 +00003674 CONFIG_SPL_FAT_SUPPORT
3675 Support for fs/fat/libfat.o in SPL binary
3676
Guillaume GARDET5065b712014-10-15 17:53:13 +02003677 CONFIG_SPL_EXT_SUPPORT
3678 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003679
Guillaume GARDET5065b712014-10-15 17:53:13 +02003680 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3681 Filename to read to load U-Boot when reading from filesystem
3682
3683 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003684 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003685 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003686
Guillaume GARDET5065b712014-10-15 17:53:13 +02003687 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003688 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003689 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003690
Scott Wood2b36fbb2012-12-06 13:33:17 +00003691 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3692 Set this for NAND SPL on PPC mpc83xx targets, so that
3693 start.S waits for the rest of the SPL to load before
3694 continuing (the hardware starts execution after just
3695 loading the first page rather than the full 4K).
3696
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303697 CONFIG_SPL_SKIP_RELOCATE
3698 Avoid SPL relocation
3699
Scott Woodc352a0c2012-09-20 19:09:07 -05003700 CONFIG_SPL_NAND_BASE
3701 Include nand_base.c in the SPL. Requires
3702 CONFIG_SPL_NAND_DRIVERS.
3703
3704 CONFIG_SPL_NAND_DRIVERS
3705 SPL uses normal NAND drivers, not minimal drivers.
3706
3707 CONFIG_SPL_NAND_ECC
3708 Include standard software ECC in the SPL
3709
Tom Rini36853852012-02-14 07:29:40 +00003710 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003711 Support for NAND boot using simple NAND drivers that
3712 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003713
Tom Rini543c9f12014-03-28 12:03:36 -04003714 CONFIG_SPL_MTD_SUPPORT
3715 Support for the MTD subsystem within SPL. Useful for
3716 environment on NAND support within SPL.
3717
Heiko Schochercf000272014-10-31 08:31:00 +01003718 CONFIG_SPL_NAND_RAW_ONLY
3719 Support to boot only raw u-boot.bin images. Use this only
3720 if you need to save space.
3721
Ying Zhang9ff70262013-08-16 15:16:11 +08003722 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3723 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003724 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003725
Ying Zhangdfb2b152013-08-16 15:16:12 +08003726 CONFIG_SPL_COMMON_INIT_DDR
3727 Set for common ddr init with serial presence detect in
3728 SPL binary.
3729
Tom Rini36853852012-02-14 07:29:40 +00003730 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3731 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3732 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3733 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3734 CONFIG_SYS_NAND_ECCBYTES
3735 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003736 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003737
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303738 CONFIG_SPL_NAND_BOOT
3739 Add support NAND boot
3740
Tom Rini36853852012-02-14 07:29:40 +00003741 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003742 Location in NAND to read U-Boot from
3743
3744 CONFIG_SYS_NAND_U_BOOT_DST
3745 Location in memory to load U-Boot to
3746
3747 CONFIG_SYS_NAND_U_BOOT_SIZE
3748 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003749
3750 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003751 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003752
3753 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3754 Define this if you need to first read the OOB and then the
3755 data. This is used for example on davinci plattforms.
3756
3757 CONFIG_SPL_OMAP3_ID_NAND
3758 Support for an OMAP3-specific set of functions to return the
3759 ID and MFR of the first attached NAND chip, if present.
3760
Wolfgang Denk825223d2011-09-11 21:24:09 +02003761 CONFIG_SPL_SERIAL_SUPPORT
3762 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003763
Wolfgang Denk825223d2011-09-11 21:24:09 +02003764 CONFIG_SPL_SPI_FLASH_SUPPORT
3765 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003766
Wolfgang Denk825223d2011-09-11 21:24:09 +02003767 CONFIG_SPL_SPI_SUPPORT
3768 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003769
Pavel Machekde997252012-08-30 22:42:11 +02003770 CONFIG_SPL_RAM_DEVICE
3771 Support for running image already present in ram, in SPL binary
3772
Wolfgang Denk825223d2011-09-11 21:24:09 +02003773 CONFIG_SPL_LIBGENERIC_SUPPORT
3774 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003775
Ying Zhang602f7d32013-05-20 14:07:25 +08003776 CONFIG_SPL_ENV_SUPPORT
3777 Support for the environment operating in SPL binary
3778
3779 CONFIG_SPL_NET_SUPPORT
3780 Support for the net/libnet.o in SPL binary.
3781 It conflicts with SPL env from storage medium specified by
3782 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3783
Scott Woodeb7bd972012-12-06 13:33:16 +00003784 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003785 Image offset to which the SPL should be padded before appending
3786 the SPL payload. By default, this is defined as
3787 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3788 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3789 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003790
Scott Woodf147eb72012-09-21 16:27:32 -05003791 CONFIG_SPL_TARGET
3792 Final target image containing SPL and payload. Some SPLs
3793 use an arch-specific makefile fragment instead, for
3794 example if more than one image needs to be produced.
3795
Simon Glass82d94532013-05-08 08:05:59 +00003796 CONFIG_FIT_SPL_PRINT
3797 Printing information about a FIT image adds quite a bit of
3798 code to SPL. So this is normally disabled in SPL. Use this
3799 option to re-enable it. This will affect the output of the
3800 bootm command when booting a FIT image.
3801
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003802- TPL framework
3803 CONFIG_TPL
3804 Enable building of TPL globally.
3805
3806 CONFIG_TPL_PAD_TO
3807 Image offset to which the TPL should be padded before appending
3808 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003809 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3810 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3811 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003812
wdenkc6097192002-11-03 00:24:07 +00003813Modem Support:
3814--------------
3815
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003816[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003817
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003818- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003819 CONFIG_MODEM_SUPPORT
3820
3821- RTS/CTS Flow control enable:
3822 CONFIG_HWFLOW
3823
3824- Modem debug support:
3825 CONFIG_MODEM_SUPPORT_DEBUG
3826
wdenk4a5c8a72003-03-06 00:02:04 +00003827 Enables debugging stuff (char screen[1024], dbg())
3828 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003829
wdenkc0aa5c52003-12-06 19:49:23 +00003830- Interrupt support (PPC):
3831
wdenk1ebf41e2004-01-02 14:00:00 +00003832 There are common interrupt_init() and timer_interrupt()
3833 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003834 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003835 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003836 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003837 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003838 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003839 specific handling. If board has watchdog / status_led
3840 / other_activity_monitor it works automatically from
3841 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003842
wdenkc6097192002-11-03 00:24:07 +00003843- General:
3844
wdenk4a5c8a72003-03-06 00:02:04 +00003845 In the target system modem support is enabled when a
3846 specific key (key combination) is pressed during
3847 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003848 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003849 board_init(). Currently key_pressed() is a dummy
3850 function, returning 1 and thus enabling modem
3851 initialization.
wdenkc6097192002-11-03 00:24:07 +00003852
wdenk4a5c8a72003-03-06 00:02:04 +00003853 If there are no modem init strings in the
3854 environment, U-Boot proceed to autoboot; the
3855 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003856 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003857
3858 See also: doc/README.Modem
3859
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003860Board initialization settings:
3861------------------------------
3862
3863During Initialization u-boot calls a number of board specific functions
3864to allow the preparation of board specific prerequisites, e.g. pin setup
3865before drivers are initialized. To enable these callbacks the
3866following configuration macros have to be defined. Currently this is
3867architecture specific, so please check arch/your_architecture/lib/board.c
3868typically in board_init_f() and board_init_r().
3869
3870- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3871- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3872- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3873- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003874
wdenkc6097192002-11-03 00:24:07 +00003875Configuration Settings:
3876-----------------------
3877
York Sun6c480012014-02-26 17:03:19 -08003878- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3879 Optionally it can be defined to support 64-bit memory commands.
3880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003881- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003882 undefine this when you're short of memory.
3883
Peter Tyserdfb72b82009-01-27 18:03:12 -06003884- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3885 width of the commands listed in the 'help' command output.
3886
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003887- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003888 prompt for user input.
3889
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003890- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003893
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003894- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003896- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003897 the application (usually a Linux kernel) when it is
3898 booted
3899
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003900- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003901 List of legal baudrate settings for this board.
3902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003903- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003904 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003905
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003906- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003907 If the board specific function
3908 extern int overwrite_console (void);
3909 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003910 serial port, else the settings in the environment are used.
3911
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003912- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003913 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003916 Enable overwrite of previous console environment settings.
3917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003918- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003919 Begin and End addresses of the area used by the
3920 simple memory test.
3921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003922- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003923 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003926 Scratch address used by the alternate memory test
3927 You only need to set this if address zero isn't writeable
3928
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3930 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003931 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003932 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003933 fixing up gd->ram_size the Linux kernel should gets passed
3934 the now "corrected" memory size and won't touch it either.
3935 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003936 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003937 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003938 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003939
3940 This option can be used as a workaround for the 440EPx/GRx
3941 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3942 be touched.
3943
3944 WARNING: Please make sure that this value is a multiple of
3945 the Linux page size (normally 4k). If this is not the case,
3946 then the end address of the Linux memory will be located at a
3947 non page size aligned address and this could cause major
3948 problems.
3949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003950- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003951 Enable temporary baudrate change while serial download
3952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003953- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003954 Physical start address of SDRAM. _Must_ be 0 here.
3955
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003956- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003957 Physical start address of Motherboard I/O (if using a
3958 Cogent motherboard)
3959
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003960- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003961 Physical start address of Flash memory.
3962
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003963- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003964 Physical start address of boot monitor code (set by
3965 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003966 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003967 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003969- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003970 Size of memory reserved for monitor code, used to
3971 determine _at_compile_time_ (!) if the environment is
3972 embedded within the U-Boot image, or in a separate
3973 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003974
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003975- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003976 Size of DRAM reserved for malloc() use.
3977
Simon Glass863e4042014-07-10 22:23:28 -06003978- CONFIG_SYS_MALLOC_F_LEN
3979 Size of the malloc() pool for use before relocation. If
3980 this is defined, then a very simple malloc() implementation
3981 will become available before relocation. The address is just
3982 below the global data, and the stack is moved down to make
3983 space.
3984
3985 This feature allocates regions with increasing addresses
3986 within the region. calloc() is supported, but realloc()
3987 is not available. free() is supported but does nothing.
3988 The memory will be freed (or in fact just forgotton) when
3989 U-Boot relocates itself.
3990
Simon Glasse997f752014-09-15 06:33:18 -06003991 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003992 at present but is fairly easy to enable for other archs.
3993
Simon Glass9fa901b2014-11-10 17:16:54 -07003994- CONFIG_SYS_MALLOC_SIMPLE
3995 Provides a simple and small malloc() and calloc() for those
3996 boards which do not use the full malloc in SPL (which is
3997 enabled with CONFIG_SYS_SPL_MALLOC_START).
3998
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003999- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01004000 Normally compressed uImages are limited to an
4001 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004002 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004003 to adjust this setting to your needs.
4004
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004005- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004006 Maximum size of memory mapped by the startup code of
4007 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004008 the Linux kernel (bd_info, boot arguments, FDT blob if
4009 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004010 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004011 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004012 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004013 variable "bootm_mapsize" will override the value of
4014 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4015 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004016
John Rigbyeea8e692010-10-13 13:57:35 -06004017- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4018 Enable initrd_high functionality. If defined then the
4019 initrd_high feature is enabled and the bootm ramdisk subcommand
4020 is enabled.
4021
4022- CONFIG_SYS_BOOT_GET_CMDLINE:
4023 Enables allocating and saving kernel cmdline in space between
4024 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4025
4026- CONFIG_SYS_BOOT_GET_KBD:
4027 Enables allocating and saving a kernel copy of the bd_info in
4028 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4029
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004030- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004031 Max number of Flash memory banks
4032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004033- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004034 Max number of sectors on a Flash chip
4035
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004036- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004037 Timeout for Flash erase operations (in ms)
4038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004039- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004040 Timeout for Flash write operations (in ms)
4041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004042- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004043 Timeout for Flash set sector lock bit operation (in ms)
4044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004045- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004046 Timeout for Flash clear lock bits operation (in ms)
4047
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004048- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004049 If defined, hardware flash sectors protection is used
4050 instead of U-Boot software protection.
4051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004052- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004053
4054 Enable TFTP transfers directly to flash memory;
4055 without this option such a download has to be
4056 performed in two steps: (1) download to RAM, and (2)
4057 copy from RAM to flash.
4058
4059 The two-step approach is usually more reliable, since
4060 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004061 the flash, but in some situations (when system RAM is
4062 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004063 downloaded image) this option may be very useful.
4064
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004065- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004066 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004067 common flash structure for storing flash geometry.
4068
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004069- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004070 This option also enables the building of the cfi_flash driver
4071 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004072
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004073- CONFIG_FLASH_CFI_MTD
4074 This option enables the building of the cfi_mtd driver
4075 in the drivers directory. The driver exports CFI flash
4076 to the MTD layer.
4077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004078- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004079 Use buffered writes to flash.
4080
4081- CONFIG_FLASH_SPANSION_S29WS_N
4082 s29ws-n MirrorBit flash has non-standard addresses for buffered
4083 write commands.
4084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004085- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004086 If this option is defined, the common CFI flash doesn't
4087 print it's warning upon not recognized FLASH banks. This
4088 is useful, if some of the configured banks are only
4089 optionally available.
4090
Jerry Van Barenaae73572008-03-08 13:48:01 -05004091- CONFIG_FLASH_SHOW_PROGRESS
4092 If defined (must be an integer), print out countdown
4093 digits and dots. Recommended value: 45 (9..1) for 80
4094 column displays, 15 (3..1) for 40 column displays.
4095
Stefan Roesed20cba52013-04-04 15:53:14 +02004096- CONFIG_FLASH_VERIFY
4097 If defined, the content of the flash (destination) is compared
4098 against the source after the write operation. An error message
4099 will be printed when the contents are not identical.
4100 Please note that this option is useless in nearly all cases,
4101 since such flash programming errors usually are detected earlier
4102 while unprotecting/erasing/programming. Please only enable
4103 this option if you really know what you are doing.
4104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004105- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004106 Defines the number of Ethernet receive buffers. On some
4107 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004108 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4109 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004110 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004111 Defaults to 4 if not defined.
4112
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004113- CONFIG_ENV_MAX_ENTRIES
4114
Wolfgang Denk1136f692010-10-27 22:48:30 +02004115 Maximum number of entries in the hash table that is used
4116 internally to store the environment settings. The default
4117 setting is supposed to be generous and should work in most
4118 cases. This setting can be used to tune behaviour; see
4119 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004120
Joe Hershberger71497d02012-12-11 22:16:31 -06004121- CONFIG_ENV_FLAGS_LIST_DEFAULT
4122- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004123 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004124 calling env set. Variables can be restricted to only decimal,
4125 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4126 the variables can also be restricted to IP address or MAC address.
4127
4128 The format of the list is:
4129 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004130 access_atribute = [a|r|o|c]
4131 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004132 entry = variable_name[:attributes]
4133 list = entry[,list]
4134
4135 The type attributes are:
4136 s - String (default)
4137 d - Decimal
4138 x - Hexadecimal
4139 b - Boolean ([1yYtT|0nNfF])
4140 i - IP address
4141 m - MAC address
4142
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004143 The access attributes are:
4144 a - Any (default)
4145 r - Read-only
4146 o - Write-once
4147 c - Change-default
4148
Joe Hershberger71497d02012-12-11 22:16:31 -06004149 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4150 Define this to a list (string) to define the ".flags"
4151 envirnoment variable in the default or embedded environment.
4152
4153 - CONFIG_ENV_FLAGS_LIST_STATIC
4154 Define this to a list (string) to define validation that
4155 should be done if an entry is not found in the ".flags"
4156 environment variable. To override a setting in the static
4157 list, simply add an entry for the same variable name to the
4158 ".flags" variable.
4159
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004160- CONFIG_ENV_ACCESS_IGNORE_FORCE
4161 If defined, don't allow the -f switch to env set override variable
4162 access flags.
4163
Simon Glass66828322013-03-08 13:45:27 +00004164- CONFIG_SYS_GENERIC_BOARD
4165 This selects the architecture-generic board system instead of the
4166 architecture-specific board files. It is intended to move boards
4167 to this new framework over time. Defining this will disable the
4168 arch/foo/lib/board.c file and use common/board_f.c and
4169 common/board_r.c instead. To use this option your architecture
4170 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4171 its config.mk file). If you find problems enabling this option on
4172 your board please report the problem and send patches!
4173
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004174- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4175 This is set by OMAP boards for the max time that reset should
4176 be asserted. See doc/README.omap-reset-time for details on how
4177 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004178
Gabe Black3687fe42014-10-15 04:38:30 -06004179- CONFIG_USE_STDINT
4180 If stdint.h is available with your toolchain you can define this
4181 option to enable it. You can provide option 'USE_STDINT=1' when
4182 building U-Boot to enable this.
4183
wdenkc6097192002-11-03 00:24:07 +00004184The following definitions that deal with the placement and management
4185of environment data (variable area); in general, we support the
4186following configurations:
4187
Mike Frysinger63b8f122011-07-08 10:44:25 +00004188- CONFIG_BUILD_ENVCRC:
4189
4190 Builds up envcrc with the target environment so that external utils
4191 may easily extract it and embed it in final U-Boot images.
4192
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004193- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004194
4195 Define this if the environment is in flash memory.
4196
4197 a) The environment occupies one whole flash sector, which is
4198 "embedded" in the text segment with the U-Boot code. This
4199 happens usually with "bottom boot sector" or "top boot
4200 sector" type flash chips, which have several smaller
4201 sectors at the start or the end. For instance, such a
4202 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4203 such a case you would place the environment in one of the
4204 4 kB sectors - with U-Boot code before and after it. With
4205 "top boot sector" type flash chips, you would put the
4206 environment in one of the last sectors, leaving a gap
4207 between U-Boot and the environment.
4208
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004209 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004210
4211 Offset of environment data (variable area) to the
4212 beginning of flash memory; for instance, with bottom boot
4213 type flash chips the second sector can be used: the offset
4214 for this sector is given here.
4215
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004216 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004217
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004218 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004219
4220 This is just another way to specify the start address of
4221 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004222 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004223
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004224 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004225
4226 Size of the sector containing the environment.
4227
4228
4229 b) Sometimes flash chips have few, equal sized, BIG sectors.
4230 In such a case you don't want to spend a whole sector for
4231 the environment.
4232
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004233 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004234
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004235 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004236 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004237 of this flash sector for the environment. This saves
4238 memory for the RAM copy of the environment.
4239
4240 It may also save flash memory if you decide to use this
4241 when your environment is "embedded" within U-Boot code,
4242 since then the remainder of the flash sector could be used
4243 for U-Boot code. It should be pointed out that this is
4244 STRONGLY DISCOURAGED from a robustness point of view:
4245 updating the environment in flash makes it always
4246 necessary to erase the WHOLE sector. If something goes
4247 wrong before the contents has been restored from a copy in
4248 RAM, your target system will be dead.
4249
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004250 - CONFIG_ENV_ADDR_REDUND
4251 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk4a5c8a72003-03-06 00:02:04 +00004253 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004254 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004255 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004256 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004257
4258BE CAREFUL! Any changes to the flash layout, and some changes to the
4259source code will make it necessary to adapt <board>/u-boot.lds*
4260accordingly!
4261
4262
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004263- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004264
4265 Define this if you have some non-volatile memory device
4266 (NVRAM, battery buffered SRAM) which you want to use for the
4267 environment.
4268
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004269 - CONFIG_ENV_ADDR:
4270 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004271
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004272 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004273 want to use for environment. It is assumed that this memory
4274 can just be read and written to, without any special
4275 provision.
4276
4277BE CAREFUL! The first access to the environment happens quite early
4278in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004279console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004280U-Boot will hang.
4281
4282Please note that even with NVRAM we still use a copy of the
4283environment in RAM: we could work on NVRAM directly, but we want to
4284keep settings there always unmodified except somebody uses "saveenv"
4285to save the current settings.
4286
4287
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004288- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004289
4290 Use this if you have an EEPROM or similar serial access
4291 device and a driver for it.
4292
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004293 - CONFIG_ENV_OFFSET:
4294 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004295
4296 These two #defines specify the offset and size of the
4297 environment area within the total memory of your EEPROM.
4298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004299 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004300 If defined, specified the chip address of the EEPROM device.
4301 The default address is zero.
4302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004303 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004304 If defined, the number of bits used to address bytes in a
4305 single page in the EEPROM device. A 64 byte page, for example
4306 would require six bits.
4307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004308 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004309 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004310 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004312 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004313 The length in bytes of the EEPROM memory array address. Note
4314 that this is NOT the chip address length!
4315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004316 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004317 EEPROM chips that implement "address overflow" are ones
4318 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4319 address and the extra bits end up in the "chip address" bit
4320 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4321 byte chips.
4322
4323 Note that we consider the length of the address field to
4324 still be one byte because the extra address bits are hidden
4325 in the chip address.
4326
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004327 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004328 The size in bytes of the EEPROM device.
4329
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004330 - CONFIG_ENV_EEPROM_IS_ON_I2C
4331 define this, if you have I2C and SPI activated, and your
4332 EEPROM, which holds the environment, is on the I2C bus.
4333
4334 - CONFIG_I2C_ENV_EEPROM_BUS
4335 if you have an Environment on an EEPROM reached over
4336 I2C muxes, you can define here, how to reach this
4337 EEPROM. For example:
4338
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004339 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004340
4341 EEPROM which holds the environment, is reached over
4342 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004343
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004344- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004345
wdenk1ebf41e2004-01-02 14:00:00 +00004346 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004347 want to use for the environment.
4348
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004349 - CONFIG_ENV_OFFSET:
4350 - CONFIG_ENV_ADDR:
4351 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004352
4353 These three #defines specify the offset and size of the
4354 environment area within the total memory of your DataFlash placed
4355 at the specified address.
4356
Wu, Josh76db7bf2014-07-01 19:30:13 +08004357- CONFIG_ENV_IS_IN_SPI_FLASH:
4358
4359 Define this if you have a SPI Flash memory device which you
4360 want to use for the environment.
4361
4362 - CONFIG_ENV_OFFSET:
4363 - CONFIG_ENV_SIZE:
4364
4365 These two #defines specify the offset and size of the
4366 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4367 aligned to an erase sector boundary.
4368
4369 - CONFIG_ENV_SECT_SIZE:
4370
4371 Define the SPI flash's sector size.
4372
4373 - CONFIG_ENV_OFFSET_REDUND (optional):
4374
4375 This setting describes a second storage area of CONFIG_ENV_SIZE
4376 size used to hold a redundant copy of the environment data, so
4377 that there is a valid backup copy in case there is a power failure
4378 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4379 aligned to an erase sector boundary.
4380
4381 - CONFIG_ENV_SPI_BUS (optional):
4382 - CONFIG_ENV_SPI_CS (optional):
4383
4384 Define the SPI bus and chip select. If not defined they will be 0.
4385
4386 - CONFIG_ENV_SPI_MAX_HZ (optional):
4387
4388 Define the SPI max work clock. If not defined then use 1MHz.
4389
4390 - CONFIG_ENV_SPI_MODE (optional):
4391
4392 Define the SPI work mode. If not defined then use SPI_MODE_3.
4393
Liu Gang85bcd732012-03-08 00:33:20 +00004394- CONFIG_ENV_IS_IN_REMOTE:
4395
4396 Define this if you have a remote memory space which you
4397 want to use for the local device's environment.
4398
4399 - CONFIG_ENV_ADDR:
4400 - CONFIG_ENV_SIZE:
4401
4402 These two #defines specify the address and size of the
4403 environment area within the remote memory space. The
4404 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004405 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004406
4407BE CAREFUL! For some special cases, the local device can not use
4408"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004409environment stored in a remote NOR flash by SRIO or PCIE link,
4410but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004411
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004412- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004413
4414 Define this if you have a NAND device which you want to use
4415 for the environment.
4416
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004417 - CONFIG_ENV_OFFSET:
4418 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004419
4420 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004421 area within the first NAND device. CONFIG_ENV_OFFSET must be
4422 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004423
Scott Wood08239322010-09-17 14:38:37 -05004424 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004425
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004426 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004427 size used to hold a redundant copy of the environment data, so
4428 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004429 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004430 aligned to an erase block boundary.
4431
4432 - CONFIG_ENV_RANGE (optional):
4433
4434 Specifies the length of the region in which the environment
4435 can be written. This should be a multiple of the NAND device's
4436 block size. Specifying a range with more erase blocks than
4437 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4438 the range to be avoided.
4439
4440 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004441
Scott Wood08239322010-09-17 14:38:37 -05004442 Enables support for dynamically retrieving the offset of the
4443 environment from block zero's out-of-band data. The
4444 "nand env.oob" command can be used to record this offset.
4445 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4446 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004447
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004448- CONFIG_NAND_ENV_DST
4449
4450 Defines address in RAM to which the nand_spl code should copy the
4451 environment. If redundant environment is used, it will be copied to
4452 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4453
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004454- CONFIG_ENV_IS_IN_UBI:
4455
4456 Define this if you have an UBI volume that you want to use for the
4457 environment. This has the benefit of wear-leveling the environment
4458 accesses, which is important on NAND.
4459
4460 - CONFIG_ENV_UBI_PART:
4461
4462 Define this to a string that is the mtd partition containing the UBI.
4463
4464 - CONFIG_ENV_UBI_VOLUME:
4465
4466 Define this to the name of the volume that you want to store the
4467 environment in.
4468
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004469 - CONFIG_ENV_UBI_VOLUME_REDUND:
4470
4471 Define this to the name of another volume to store a second copy of
4472 the environment in. This will enable redundant environments in UBI.
4473 It is assumed that both volumes are in the same MTD partition.
4474
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004475 - CONFIG_UBI_SILENCE_MSG
4476 - CONFIG_UBIFS_SILENCE_MSG
4477
4478 You will probably want to define these to avoid a really noisy system
4479 when storing the env in UBI.
4480
Wu, Josha7d0c872014-06-24 17:31:03 +08004481- CONFIG_ENV_IS_IN_FAT:
4482 Define this if you want to use the FAT file system for the environment.
4483
4484 - FAT_ENV_INTERFACE:
4485
4486 Define this to a string that is the name of the block device.
4487
4488 - FAT_ENV_DEV_AND_PART:
4489
4490 Define this to a string to specify the partition of the device. It can
4491 be as following:
4492
4493 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4494 - "D:P": device D partition P. Error occurs if device D has no
4495 partition table.
4496 - "D:0": device D.
4497 - "D" or "D:": device D partition 1 if device D has partition
4498 table, or the whole device D if has no partition
4499 table.
4500 - "D:auto": first partition in device D with bootable flag set.
4501 If none, first valid paratition in device D. If no
4502 partition table then means device D.
4503
4504 - FAT_ENV_FILE:
4505
4506 It's a string of the FAT file name. This file use to store the
4507 envrionment.
4508
4509 - CONFIG_FAT_WRITE:
4510 This should be defined. Otherwise it cannot save the envrionment file.
4511
Stephen Warreneedcacd2013-06-11 15:14:00 -06004512- CONFIG_ENV_IS_IN_MMC:
4513
4514 Define this if you have an MMC device which you want to use for the
4515 environment.
4516
4517 - CONFIG_SYS_MMC_ENV_DEV:
4518
4519 Specifies which MMC device the environment is stored in.
4520
4521 - CONFIG_SYS_MMC_ENV_PART (optional):
4522
4523 Specifies which MMC partition the environment is stored in. If not
4524 set, defaults to partition 0, the user area. Common values might be
4525 1 (first MMC boot partition), 2 (second MMC boot partition).
4526
4527 - CONFIG_ENV_OFFSET:
4528 - CONFIG_ENV_SIZE:
4529
4530 These two #defines specify the offset and size of the environment
4531 area within the specified MMC device.
4532
Stephen Warren24dc2032013-06-11 15:14:02 -06004533 If offset is positive (the usual case), it is treated as relative to
4534 the start of the MMC partition. If offset is negative, it is treated
4535 as relative to the end of the MMC partition. This can be useful if
4536 your board may be fitted with different MMC devices, which have
4537 different sizes for the MMC partitions, and you always want the
4538 environment placed at the very end of the partition, to leave the
4539 maximum possible space before it, to store other data.
4540
Stephen Warreneedcacd2013-06-11 15:14:00 -06004541 These two values are in units of bytes, but must be aligned to an
4542 MMC sector boundary.
4543
4544 - CONFIG_ENV_OFFSET_REDUND (optional):
4545
4546 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4547 hold a redundant copy of the environment data. This provides a
4548 valid backup copy in case the other copy is corrupted, e.g. due
4549 to a power failure during a "saveenv" operation.
4550
Stephen Warren24dc2032013-06-11 15:14:02 -06004551 This value may also be positive or negative; this is handled in the
4552 same way as CONFIG_ENV_OFFSET.
4553
Stephen Warreneedcacd2013-06-11 15:14:00 -06004554 This value is also in units of bytes, but must also be aligned to
4555 an MMC sector boundary.
4556
4557 - CONFIG_ENV_SIZE_REDUND (optional):
4558
4559 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4560 set. If this value is set, it must be set to the same value as
4561 CONFIG_ENV_SIZE.
4562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004563- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004564
4565 Defines offset to the initial SPI buffer area in DPRAM. The
4566 area is used at an early stage (ROM part) if the environment
4567 is configured to reside in the SPI EEPROM: We need a 520 byte
4568 scratch DPRAM area. It is used between the two initialization
4569 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4570 to be a good choice since it makes it far enough from the
4571 start of the data area as well as from the stack pointer.
4572
Bruce Adleredecc942007-11-02 13:15:42 -07004573Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004574has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004575created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004576until then to read environment variables.
4577
wdenk8dba0502003-03-31 16:34:49 +00004578The environment is protected by a CRC32 checksum. Before the monitor
4579is relocated into RAM, as a result of a bad CRC you will be working
4580with the compiled-in default environment - *silently*!!! [This is
4581necessary, because the first environment variable we need is the
4582"baudrate" setting for the console - if we have a bad CRC, we don't
4583have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004584
4585Note: once the monitor has been relocated, then it will complain if
4586the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004587use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004589- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004590 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004592 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004593 also needs to be defined.
4594
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004595- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004596 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004597
Ron Madriddfa028a2009-02-18 14:30:44 -08004598- CONFIG_NS16550_MIN_FUNCTIONS:
4599 Define this if you desire to only have use of the NS16550_init
4600 and NS16550_putc functions for the serial driver located at
4601 drivers/serial/ns16550.c. This option is useful for saving
4602 space for already greatly restricted images, including but not
4603 limited to NAND_SPL configurations.
4604
Simon Glass28a9e332012-11-30 13:01:18 +00004605- CONFIG_DISPLAY_BOARDINFO
4606 Display information about the board that U-Boot is running on
4607 when U-Boot starts up. The board function checkboard() is called
4608 to do this.
4609
Simon Glasse8822012012-11-30 13:01:19 +00004610- CONFIG_DISPLAY_BOARDINFO_LATE
4611 Similar to the previous option, but display this information
4612 later, once stdio is running and output goes to the LCD, if
4613 present.
4614
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004615- CONFIG_BOARD_SIZE_LIMIT:
4616 Maximum size of the U-Boot image. When defined, the
4617 build system checks that the actual size does not
4618 exceed it.
4619
wdenkc6097192002-11-03 00:24:07 +00004620Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004621---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004623- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004624 Cache Line Size of the CPU.
4625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004626- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004627 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004628
wdenk9c53f402003-10-15 23:53:47 +00004629 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4630 and RPXsuper) to be able to adjust the position of
4631 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004632
Timur Tabid8f341c2011-08-04 18:03:41 -05004633- CONFIG_SYS_CCSRBAR_DEFAULT:
4634 Default (power-on reset) physical address of CCSR on Freescale
4635 PowerPC SOCs.
4636
4637- CONFIG_SYS_CCSRBAR:
4638 Virtual address of CCSR. On a 32-bit build, this is typically
4639 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4640
4641 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4642 for cross-platform code that uses that macro instead.
4643
4644- CONFIG_SYS_CCSRBAR_PHYS:
4645 Physical address of CCSR. CCSR can be relocated to a new
4646 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004647 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004648 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4649 is typically relocated on 36-bit builds. It is recommended
4650 that this macro be defined via the _HIGH and _LOW macros:
4651
4652 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4653 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4654
4655- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004656 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4657 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004658 used in assembly code, so it must not contain typecasts or
4659 integer size suffixes (e.g. "ULL").
4660
4661- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4662 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4663 used in assembly code, so it must not contain typecasts or
4664 integer size suffixes (e.g. "ULL").
4665
4666- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4667 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4668 forced to a value that ensures that CCSR is not relocated.
4669
wdenk1272e232002-11-10 22:06:23 +00004670- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004672
4673 the default drive number (default value 0)
4674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004675 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004676
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004677 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004678 (default value 1)
4679
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004680 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004681
wdenk4a5c8a72003-03-06 00:02:04 +00004682 defines the offset of register from address. It
4683 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004684 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004686 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4687 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004688 default value.
wdenk1272e232002-11-10 22:06:23 +00004689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004690 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004691 fdc_hw_init() is called at the beginning of the FDC
4692 setup. fdc_hw_init() must be provided by the board
4693 source code. It is used to make hardware dependant
4694 initializations.
wdenk1272e232002-11-10 22:06:23 +00004695
Macpaul Lind1e49942011-04-11 20:45:32 +00004696- CONFIG_IDE_AHB:
4697 Most IDE controllers were designed to be connected with PCI
4698 interface. Only few of them were designed for AHB interface.
4699 When software is doing ATA command and data transfer to
4700 IDE devices through IDE-AHB controller, some additional
4701 registers accessing to these kind of IDE-AHB controller
4702 is requierd.
4703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004705 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004706 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004708- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004709
wdenkeb20ad32003-09-05 23:19:14 +00004710 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004711 initial data and stack; please note that this must be
4712 writable memory that is working WITHOUT special
4713 initialization, i. e. you CANNOT use normal RAM which
4714 will become available only after programming the
4715 memory controller and running certain initialization
4716 sequences.
4717
4718 U-Boot uses the following memory types:
4719 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4720 - MPC824X: data cache
4721 - PPC4xx: data cache
4722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004723- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004724
4725 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004726 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4727 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004728 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004729 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004730 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4731 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4732 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004733
4734 Note:
4735 On the MPC824X (or other systems that use the data
4736 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004737 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004738 point to an otherwise UNUSED address space between
4739 the top of RAM and the start of the PCI space.
4740
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004741- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004743- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004745- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004746
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004747- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004748
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004749- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004751- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004753- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004754 SDRAM timing
4755
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004756- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004757 periodic timer for refresh
4758
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004759- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004761- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4762 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4763 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4764 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004765 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4766
4767- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004768 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4769 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004770 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004772- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4773 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004774 Machine Mode Register and Memory Periodic Timer
4775 Prescaler definitions (SDRAM timing)
4776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004777- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004778 enable I2C microcode relocation patch (MPC8xx);
4779 define relocation offset in DPRAM [DSP2]
4780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004781- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004782 enable SMC microcode relocation patch (MPC8xx);
4783 define relocation offset in DPRAM [SMC1]
4784
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004785- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004786 enable SPI microcode relocation patch (MPC8xx);
4787 define relocation offset in DPRAM [SCC4]
4788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004789- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004790 Use OSCM clock mode on MBX8xx board. Be careful,
4791 wrong setting might damage your board. Read
4792 doc/README.MBX before setting this variable!
4793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004794- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004795 Offset of the bootmode word in DPRAM used by post
4796 (Power On Self Tests). This definition overrides
4797 #define'd default value in commproc.h resp.
4798 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004800- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4801 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4802 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4803 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4804 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4805 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4806 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4807 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004808 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004809
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004810- CONFIG_PCI_DISABLE_PCIE:
4811 Disable PCI-Express on systems where it is supported but not
4812 required.
4813
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004814- CONFIG_PCI_ENUM_ONLY
4815 Only scan through and get the devices on the busses.
4816 Don't do any setup work, presumably because someone or
4817 something has already done it, and we don't need to do it
4818 a second time. Useful for platforms that are pre-booted
4819 by coreboot or similar.
4820
Gabor Juhosb4458732013-05-30 07:06:12 +00004821- CONFIG_PCI_INDIRECT_BRIDGE:
4822 Enable support for indirect PCI bridges.
4823
Kumar Gala8975d7a2010-12-30 12:09:53 -06004824- CONFIG_SYS_SRIO:
4825 Chip has SRIO or not
4826
4827- CONFIG_SRIO1:
4828 Board has SRIO 1 port available
4829
4830- CONFIG_SRIO2:
4831 Board has SRIO 2 port available
4832
Liu Gang27afb9c2013-05-07 16:30:46 +08004833- CONFIG_SRIO_PCIE_BOOT_MASTER
4834 Board can support master function for Boot from SRIO and PCIE
4835
Kumar Gala8975d7a2010-12-30 12:09:53 -06004836- CONFIG_SYS_SRIOn_MEM_VIRT:
4837 Virtual Address of SRIO port 'n' memory region
4838
4839- CONFIG_SYS_SRIOn_MEM_PHYS:
4840 Physical Address of SRIO port 'n' memory region
4841
4842- CONFIG_SYS_SRIOn_MEM_SIZE:
4843 Size of SRIO port 'n' memory region
4844
Fabio Estevamf17e8782013-04-11 09:35:34 +00004845- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4846 Defined to tell the NAND controller that the NAND chip is using
4847 a 16 bit bus.
4848 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004849 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004850 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004851 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004852
4853- CONFIG_SYS_NDFC_EBC0_CFG
4854 Sets the EBC0_CFG register for the NDFC. If not defined
4855 a default value will be used.
4856
Ben Warren45657152006-09-07 16:50:54 -04004857- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004858 Get DDR timing information from an I2C EEPROM. Common
4859 with pluggable memory modules such as SODIMMs
4860
Ben Warren45657152006-09-07 16:50:54 -04004861 SPD_EEPROM_ADDRESS
4862 I2C address of the SPD EEPROM
4863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004864- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004865 If SPD EEPROM is on an I2C bus other than the first
4866 one, specify here. Note that the value must resolve
4867 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004868
York Sune73cc042011-06-07 09:42:16 +08004869- CONFIG_SYS_DDR_RAW_TIMING
4870 Get DDR timing information from other than SPD. Common with
4871 soldered DDR chips onboard without SPD. DDR raw timing
4872 parameters are extracted from datasheet and hard-coded into
4873 header files or board specific files.
4874
York Sunbd495cf2011-09-16 13:21:35 -07004875- CONFIG_FSL_DDR_INTERACTIVE
4876 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004878- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004879 Only for 83xx systems. If specified, then DDR should
4880 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004881
wdenk6203e402004-04-18 10:13:26 +00004882- CONFIG_ETHER_ON_FEC[12]
4883 Define to enable FEC[12] on a 8xx series processor.
4884
4885- CONFIG_FEC[12]_PHY
4886 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004887 to the given FEC; i. e.
4888 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004889 means that the PHY with address 4 is connected to FEC1
4890
4891 When set to -1, means to probe for first available.
4892
4893- CONFIG_FEC[12]_PHY_NORXERR
4894 The PHY does not have a RXERR line (RMII only).
4895 (so program the FEC to ignore it).
4896
4897- CONFIG_RMII
4898 Enable RMII mode for all FECs.
4899 Note that this is a global option, we can't
4900 have one FEC in standard MII mode and another in RMII mode.
4901
wdenk20c98a62004-04-23 20:32:05 +00004902- CONFIG_CRC32_VERIFY
4903 Add a verify option to the crc32 command.
4904 The syntax is:
4905
4906 => crc32 -v <address> <count> <crc32>
4907
4908 Where address/count indicate a memory area
4909 and crc32 is the correct crc32 which the
4910 area should have.
4911
wdenk64519362004-07-11 17:40:54 +00004912- CONFIG_LOOPW
4913 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004914 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004915
stroesecc3af832004-12-16 18:46:55 +00004916- CONFIG_MX_CYCLIC
4917 Add the "mdc" and "mwc" memory commands. These are cyclic
4918 "md/mw" commands.
4919 Examples:
4920
wdenk07d7e6b2004-12-16 21:44:03 +00004921 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004922 This command will print 4 bytes (10,11,12,13) each 500 ms.
4923
wdenk07d7e6b2004-12-16 21:44:03 +00004924 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004925 This command will write 12345678 to address 100 all 10 ms.
4926
wdenk07d7e6b2004-12-16 21:44:03 +00004927 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004928 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004929
wdenk3d3d99f2005-04-04 12:44:11 +00004930- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004931 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004932 low level initializations (like setting up the memory
4933 controller) are omitted and/or U-Boot does not
4934 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004935
Wolfgang Denk302141d2010-11-27 23:30:56 +01004936 Normally this variable MUST NOT be defined. The only
4937 exception is when U-Boot is loaded (to RAM) by some
4938 other boot loader or by a debugger which performs
4939 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004940
Aneesh V552a3192011-07-13 05:11:07 +00004941- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004942 Modifies the behaviour of start.S when compiling a loader
4943 that is executed before the actual U-Boot. E.g. when
4944 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004945
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004946- CONFIG_TPL_BUILD
4947 Modifies the behaviour of start.S when compiling a loader
4948 that is executed after the SPL and before the actual U-Boot.
4949 It is loaded by the SPL.
4950
Ying Zhang0d4f5442013-05-20 14:07:23 +08004951- CONFIG_SYS_MPC85XX_NO_RESETVEC
4952 Only for 85xx systems. If this variable is specified, the section
4953 .resetvec is not kept and the section .bootpg is placed in the
4954 previous 4k of the .text section.
4955
Simon Glass17dabf02013-02-24 17:33:14 +00004956- CONFIG_ARCH_MAP_SYSMEM
4957 Generally U-Boot (and in particular the md command) uses
4958 effective address. It is therefore not necessary to regard
4959 U-Boot address as virtual addresses that need to be translated
4960 to physical addresses. However, sandbox requires this, since
4961 it maintains its own little RAM buffer which contains all
4962 addressable memory. This option causes some memory accesses
4963 to be mapped through map_sysmem() / unmap_sysmem().
4964
Matthias Weisser93416c12011-03-10 21:36:32 +00004965- CONFIG_USE_ARCH_MEMCPY
4966 CONFIG_USE_ARCH_MEMSET
4967 If these options are used a optimized version of memcpy/memset will
4968 be used if available. These functions may be faster under some
4969 conditions but may increase the binary size.
4970
Simon Glassbfb59802013-02-14 04:18:54 +00004971- CONFIG_X86_RESET_VECTOR
4972 If defined, the x86 reset vector code is included. This is not
4973 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004974
Mark Jackson52b003c2013-03-04 01:27:20 +00004975- CONFIG_SYS_MPUCLK
4976 Defines the MPU clock speed (in MHz).
4977
4978 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004979
Heiko Schocher2233e462013-11-04 14:05:00 +01004980- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4981 Enables the RTC32K OSC on AM33xx based plattforms
4982
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004983- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4984 Option to disable subpage write in NAND driver
4985 driver that uses this:
4986 drivers/mtd/nand/davinci_nand.c
4987
Timur Tabi275f4bb2011-11-22 09:21:25 -06004988Freescale QE/FMAN Firmware Support:
4989-----------------------------------
4990
4991The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4992loading of "firmware", which is encoded in the QE firmware binary format.
4993This firmware often needs to be loaded during U-Boot booting, so macros
4994are used to identify the storage device (NOR flash, SPI, etc) and the address
4995within that device.
4996
Zhao Qiang83a90842014-03-21 16:21:44 +08004997- CONFIG_SYS_FMAN_FW_ADDR
4998 The address in the storage device where the FMAN microcode is located. The
4999 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5000 is also specified.
5001
5002- CONFIG_SYS_QE_FW_ADDR
5003 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005004 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5005 is also specified.
5006
5007- CONFIG_SYS_QE_FMAN_FW_LENGTH
5008 The maximum possible size of the firmware. The firmware binary format
5009 has a field that specifies the actual size of the firmware, but it
5010 might not be possible to read any part of the firmware unless some
5011 local storage is allocated to hold the entire firmware first.
5012
5013- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5014 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5015 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5016 virtual address in NOR flash.
5017
5018- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5019 Specifies that QE/FMAN firmware is located in NAND flash.
5020 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5021
5022- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5023 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5024 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5025
5026- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5027 Specifies that QE/FMAN firmware is located on the primary SPI
5028 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5029
Liu Gang1e084582012-03-08 00:33:18 +00005030- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5031 Specifies that QE/FMAN firmware is located in the remote (master)
5032 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005033 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5034 window->master inbound window->master LAW->the ucode address in
5035 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005036
J. German Rivera8ff14b72014-06-23 15:15:55 -07005037Freescale Layerscape Management Complex Firmware Support:
5038---------------------------------------------------------
5039The Freescale Layerscape Management Complex (MC) supports the loading of
5040"firmware".
5041This firmware often needs to be loaded during U-Boot booting, so macros
5042are used to identify the storage device (NOR flash, SPI, etc) and the address
5043within that device.
5044
5045- CONFIG_FSL_MC_ENET
5046 Enable the MC driver for Layerscape SoCs.
5047
5048- CONFIG_SYS_LS_MC_FW_ADDR
5049 The address in the storage device where the firmware is located. The
5050 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5051 is also specified.
5052
5053- CONFIG_SYS_LS_MC_FW_LENGTH
5054 The maximum possible size of the firmware. The firmware binary format
5055 has a field that specifies the actual size of the firmware, but it
5056 might not be possible to read any part of the firmware unless some
5057 local storage is allocated to hold the entire firmware first.
5058
5059- CONFIG_SYS_LS_MC_FW_IN_NOR
5060 Specifies that MC firmware is located in NOR flash, mapped as
5061 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5062 virtual address in NOR flash.
5063
wdenkc6097192002-11-03 00:24:07 +00005064Building the Software:
5065======================
5066
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005067Building U-Boot has been tested in several native build environments
5068and in many different cross environments. Of course we cannot support
5069all possibly existing versions of cross development tools in all
5070(potentially obsolete) versions. In case of tool chain problems we
5071recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5072which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005073
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005074If you are not using a native environment, it is assumed that you
5075have GNU cross compiling tools available in your path. In this case,
5076you must set the environment variable CROSS_COMPILE in your shell.
5077Note that no changes to the Makefile or any other source files are
5078necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005079
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005080 $ CROSS_COMPILE=ppc_4xx-
5081 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005082
Peter Tyserb06976d2009-03-13 18:54:51 -05005083Note: If you wish to generate Windows versions of the utilities in
5084 the tools directory you can use the MinGW toolchain
5085 (http://www.mingw.org). Set your HOST tools to the MinGW
5086 toolchain and execute 'make tools'. For example:
5087
5088 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5089
5090 Binaries such as tools/mkimage.exe will be created which can
5091 be executed on computers running Windows.
5092
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005093U-Boot is intended to be simple to build. After installing the
5094sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005095is done by typing:
5096
Holger Freyther7ba4e572014-08-04 09:26:05 +02005097 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005098
Holger Freyther7ba4e572014-08-04 09:26:05 +02005099where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005100rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102Note: for some board special configuration names may exist; check if
5103 additional information is available from the board vendor; for
5104 instance, the TQM823L systems are available without (standard)
5105 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005106 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005107
Holger Freyther7ba4e572014-08-04 09:26:05 +02005108 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005109 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005110
Holger Freyther7ba4e572014-08-04 09:26:05 +02005111 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005112 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114 etc.
wdenkc6097192002-11-03 00:24:07 +00005115
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk6c59edc2004-05-03 20:45:30 +00005117Finally, type "make all", and you should get some working U-Boot
5118images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120- "u-boot.bin" is a raw binary image
5121- "u-boot" is an image in ELF binary format
5122- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005123
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005124By default the build is performed locally and the objects are saved
5125in the source directory. One of the two methods can be used to change
5126this behavior and build U-Boot to some external directory:
5127
51281. Add O= to the make command line invocations:
5129
5130 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005131 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005132 make O=/tmp/build all
5133
Timo Ketolac8c67602014-11-06 14:39:05 +020051342. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005135
Timo Ketolac8c67602014-11-06 14:39:05 +02005136 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005137 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005138 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005139 make all
5140
Timo Ketolac8c67602014-11-06 14:39:05 +02005141Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005142variable.
5143
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145Please be aware that the Makefiles assume you are using GNU make, so
5146for instance on NetBSD you might need to use "gmake" instead of
5147native "make".
wdenkc6097192002-11-03 00:24:07 +00005148
wdenkc6097192002-11-03 00:24:07 +00005149
wdenk6c59edc2004-05-03 20:45:30 +00005150If the system board that you have is not listed, then you will need
5151to port U-Boot to your hardware platform. To do this, follow these
5152steps:
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk6c59edc2004-05-03 20:45:30 +000051541. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005155 "boards.cfg" file, using the existing entries as examples.
5156 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000051572. Create a new directory to hold your board specific code. Add any
5158 files you need. In your board directory, you will need at least
5159 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51603. Create a new configuration file "include/configs/<board>.h" for
5161 your board
51623. If you're porting U-Boot to a new CPU, then also create a new
5163 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051644. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051655. Type "make", and you should get a working "u-boot.srec" file
5166 to be installed on your target system.
51676. Debug and solve any problems that might arise.
5168 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005169
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +00005171Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5172==============================================================
wdenkc6097192002-11-03 00:24:07 +00005173
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005174If you have modified U-Boot sources (for instance added a new board
5175or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005176provide feedback to the other developers. The feedback normally takes
5177the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005178official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005179
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005180But before you submit such a patch, please verify that your modifi-
5181cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005182the supported boards compile WITHOUT ANY compiler warnings. To do so,
5183just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005184for ALL supported system. Be warned, this will take a while. You can
5185select which (cross) compiler to use by passing a `CROSS_COMPILE'
5186environment variable to the script, i. e. to use the ELDK cross tools
5187you can type
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk6c59edc2004-05-03 20:45:30 +00005193 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005194
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005195When using the MAKEALL script, the default behaviour is to build
5196U-Boot in the source directory. This location can be changed by
5197setting the BUILD_DIR environment variable. Also, for each target
5198built, the MAKEALL script saves two log files (<target>.ERR and
5199<target>.MAKEALL) in the <source dir>/LOG directory. This default
5200location can be changed by setting the MAKEALL_LOGDIR environment
5201variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005202
5203 export BUILD_DIR=/tmp/build
5204 export MAKEALL_LOGDIR=/tmp/log
5205 CROSS_COMPILE=ppc_8xx- MAKEALL
5206
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005207With the above settings build objects are saved in the /tmp/build,
5208log files are saved in the /tmp/log and the source tree remains clean
5209during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005210
5211
wdenk6c59edc2004-05-03 20:45:30 +00005212See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005213
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215Monitor Commands - Overview:
5216============================
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218go - start application at address 'addr'
5219run - run commands in an environment variable
5220bootm - boot application image from memory
5221bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005222bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005223tftpboot- boot image via network using TFTP protocol
5224 and env variables "ipaddr" and "serverip"
5225 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005226tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005227rarpboot- boot image via network using RARP/TFTP protocol
5228diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5229loads - load S-Record file over serial line
5230loadb - load binary file over serial line (kermit mode)
5231md - memory display
5232mm - memory modify (auto-incrementing)
5233nm - memory modify (constant address)
5234mw - memory write (fill)
5235cp - memory copy
5236cmp - memory compare
5237crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005238i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005239sspi - SPI utility commands
5240base - print or set address offset
5241printenv- print environment variables
5242setenv - set environment variables
5243saveenv - save environment variables to persistent storage
5244protect - enable or disable FLASH write protection
5245erase - erase FLASH memory
5246flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005247nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005248bdinfo - print Board Info structure
5249iminfo - print header information for application image
5250coninfo - print console devices and informations
5251ide - IDE sub-system
5252loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005253loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005254mtest - simple RAM test
5255icache - enable or disable instruction cache
5256dcache - enable or disable data cache
5257reset - Perform RESET of the CPU
5258echo - echo args to console
5259version - print monitor version
5260help - print online help
5261? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005262
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk6c59edc2004-05-03 20:45:30 +00005264Monitor Commands - Detailed Description:
5265========================================
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk6c59edc2004-05-03 20:45:30 +00005267TODO.
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk6c59edc2004-05-03 20:45:30 +00005269For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005270
5271
wdenk6c59edc2004-05-03 20:45:30 +00005272Environment Variables:
5273======================
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275U-Boot supports user configuration using Environment Variables which
5276can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005277
wdenk6c59edc2004-05-03 20:45:30 +00005278Environment Variables are set using "setenv", printed using
5279"printenv", and saved to Flash using "saveenv". Using "setenv"
5280without a value can be used to delete a variable from the
5281environment. As long as you don't save the environment you are
5282working with an in-memory copy. In case the Flash area containing the
5283environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005284
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005285Some configuration options can be set using Environment Variables.
5286
5287List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk6c59edc2004-05-03 20:45:30 +00005291 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk6c59edc2004-05-03 20:45:30 +00005297 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005298
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005299 bootm_low - Memory range available for image processing in the bootm
5300 command can be restricted. This variable is given as
5301 a hexadecimal number and defines lowest address allowed
5302 for use by the bootm command. See also "bootm_size"
5303 environment variable. Address defined by "bootm_low" is
5304 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005305 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5306 bootm_mapsize.
5307
Wolfgang Denk092ae952011-10-26 10:21:21 +00005308 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005309 This variable is given as a hexadecimal number and it
5310 defines the size of the memory region starting at base
5311 address bootm_low that is accessible by the Linux kernel
5312 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5313 as the default value if it is defined, and bootm_size is
5314 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005315
5316 bootm_size - Memory range available for image processing in the bootm
5317 command can be restricted. This variable is given as
5318 a hexadecimal number and defines the size of the region
5319 allowed for use by the bootm command. See also "bootm_low"
5320 environment variable.
5321
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005322 updatefile - Location of the software update file on a TFTP server, used
5323 by the automatic software update feature. Please refer to
5324 documentation in doc/README.update for more details.
5325
wdenk6c59edc2004-05-03 20:45:30 +00005326 autoload - if set to "no" (any string beginning with 'n'),
5327 "bootp" will just load perform a lookup of the
5328 configuration from the BOOTP server, but not try to
5329 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 autostart - if set to "yes", an image loaded using the "bootp",
5332 "rarpboot", "tftpboot" or "diskboot" commands will
5333 be automatically started (by internally calling
5334 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336 If set to "no", a standalone image passed to the
5337 "bootm" command will be copied to the load address
5338 (and eventually uncompressed), but NOT be started.
5339 This can be used to load and uncompress arbitrary
5340 data.
wdenkc6097192002-11-03 00:24:07 +00005341
David A. Longd558a4e2011-07-09 16:40:19 -04005342 fdt_high - if set this restricts the maximum address that the
5343 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005344 For example, if you have a system with 1 GB memory
5345 at physical address 0x10000000, while Linux kernel
5346 only recognizes the first 704 MB as low memory, you
5347 may need to set fdt_high as 0x3C000000 to have the
5348 device tree blob be copied to the maximum address
5349 of the 704 MB low memory, so that Linux kernel can
5350 access it during the boot procedure.
5351
David A. Longd558a4e2011-07-09 16:40:19 -04005352 If this is set to the special value 0xFFFFFFFF then
5353 the fdt will not be copied at all on boot. For this
5354 to work it must reside in writable memory, have
5355 sufficient padding on the end of it for u-boot to
5356 add the information it needs into it, and the memory
5357 must be accessible by the kernel.
5358
Simon Glassdc6fa642011-10-24 19:15:34 +00005359 fdtcontroladdr- if set this is the address of the control flattened
5360 device tree used by U-Boot when CONFIG_OF_CONTROL is
5361 defined.
5362
wdenk0e2bd9c2004-06-06 21:51:03 +00005363 i2cfast - (PPC405GP|PPC405EP only)
5364 if set to 'y' configures Linux I2C driver for fast
5365 mode (400kHZ). This environment variable is used in
5366 initialization code. So, for changes to be effective
5367 it must be saved and board must be reset.
5368
wdenk6c59edc2004-05-03 20:45:30 +00005369 initrd_high - restrict positioning of initrd images:
5370 If this variable is not set, initrd images will be
5371 copied to the highest possible address in RAM; this
5372 is usually what you want since it allows for
5373 maximum initrd size. If for some reason you want to
5374 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005375 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005376 variable to a value of "no" or "off" or "0".
5377 Alternatively, you can set it to a maximum upper
5378 address to use (U-Boot will still check that it
5379 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381 For instance, when you have a system with 16 MB
5382 RAM, and want to reserve 4 MB from use by Linux,
5383 you can do this by adding "mem=12M" to the value of
5384 the "bootargs" variable. However, now you must make
5385 sure that the initrd image is placed in the first
5386 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005387
wdenk6c59edc2004-05-03 20:45:30 +00005388 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk6c59edc2004-05-03 20:45:30 +00005390 If you set initrd_high to 0xFFFFFFFF, this is an
5391 indication to U-Boot that all addresses are legal
5392 for the Linux kernel, including addresses in flash
5393 memory. In this case U-Boot will NOT COPY the
5394 ramdisk at all. This may be useful to reduce the
5395 boot time on your system, but requires that this
5396 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005397
wdenk6c59edc2004-05-03 20:45:30 +00005398 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400 loadaddr - Default load address for commands like "bootp",
5401 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005402
wdenk6c59edc2004-05-03 20:45:30 +00005403 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005406
wdenk6c59edc2004-05-03 20:45:30 +00005407 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005412
Mike Frysingera23230c2011-10-02 10:01:27 +00005413 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005414
Mike Frysingera23230c2011-10-02 10:01:27 +00005415 ethact - controls which interface is currently active.
5416 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005417
Heiko Schocherc5e84052010-07-20 17:45:02 +02005418 => setenv ethact FEC
5419 => ping 192.168.0.1 # traffic sent on FEC
5420 => setenv ethact SCC
5421 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005422
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005423 ethrotate - When set to "no" U-Boot does not go through all
5424 available network interfaces.
5425 It just stays at the currently selected interface.
5426
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005427 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005428 either succeed or fail without retrying.
5429 When set to "once" the network operation will
5430 fail when all the available network interfaces
5431 are tried once without success.
5432 Useful on scripts which control the retry operation
5433 themselves.
wdenkc6097192002-11-03 00:24:07 +00005434
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005435 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005436
Simon Glass5db3f932013-07-16 20:10:00 -07005437 silent_linux - If set then linux will be told to boot silently, by
5438 changing the console to be empty. If "yes" it will be
5439 made silent. If "no" it will not be made silent. If
5440 unset, then it will be made silent if the U-Boot console
5441 is silent.
5442
Wolfgang Denk227b5192005-09-24 23:25:46 +02005443 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005444 UDP source port.
5445
Wolfgang Denk227b5192005-09-24 23:25:46 +02005446 tftpdstport - If this is set, the value is used for TFTP's UDP
5447 destination port instead of the Well Know Port 69.
5448
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005449 tftpblocksize - Block size to use for TFTP transfers; if not set,
5450 we use the TFTP server's default block size
5451
5452 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5453 seconds, minimum value is 1000 = 1 second). Defines
5454 when a packet is considered to be lost so it has to
5455 be retransmitted. The default is 5000 = 5 seconds.
5456 Lowering this value may make downloads succeed
5457 faster in networks with high packet loss rates or
5458 with unreliable TFTP servers.
5459
5460 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005461 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005462 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005463
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005464The following image location variables contain the location of images
5465used in booting. The "Image" column gives the role of the image and is
5466not an environment variable name. The other columns are environment
5467variable names. "File Name" gives the name of the file on a TFTP
5468server, "RAM Address" gives the location in RAM the image will be
5469loaded to, and "Flash Location" gives the image's address in NOR
5470flash or offset in NAND flash.
5471
5472*Note* - these variables don't have to be defined for all boards, some
5473boards currenlty use other variables for these purposes, and some
5474boards use these variables for other purposes.
5475
Wolfgang Denk092ae952011-10-26 10:21:21 +00005476Image File Name RAM Address Flash Location
5477----- --------- ----------- --------------
5478u-boot u-boot u-boot_addr_r u-boot_addr
5479Linux kernel bootfile kernel_addr_r kernel_addr
5480device tree blob fdtfile fdt_addr_r fdt_addr
5481ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005482
wdenk6c59edc2004-05-03 20:45:30 +00005483The following environment variables may be used and automatically
5484updated by the network boot commands ("bootp" and "rarpboot"),
5485depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487 bootfile - see above
5488 dnsip - IP address of your Domain Name Server
5489 dnsip2 - IP address of your secondary Domain Name Server
5490 gatewayip - IP address of the Gateway (Router) to use
5491 hostname - Target hostname
5492 ipaddr - see above
5493 netmask - Subnet Mask
5494 rootpath - Pathname of the root filesystem on the NFS server
5495 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005496
wdenk145d2c12004-04-15 21:48:45 +00005497
wdenk6c59edc2004-05-03 20:45:30 +00005498There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005499
wdenk6c59edc2004-05-03 20:45:30 +00005500 serial# - contains hardware identification information such
5501 as type string and/or serial number
5502 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504These variables can be set only once (usually during manufacturing of
5505the board). U-Boot refuses to delete or overwrite these variables
5506once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005507
5508
wdenk6c59edc2004-05-03 20:45:30 +00005509Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511 ver - Contains the U-Boot version string as printed
5512 with the "version" command. This variable is
5513 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005514
wdenkc6097192002-11-03 00:24:07 +00005515
wdenk6c59edc2004-05-03 20:45:30 +00005516Please note that changes to some configuration parameters may take
5517only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005518
stroeseb9c17c52003-04-04 15:53:41 +00005519
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005520Callback functions for environment variables:
5521---------------------------------------------
5522
5523For some environment variables, the behavior of u-boot needs to change
5524when their values are changed. This functionailty allows functions to
5525be associated with arbitrary variables. On creation, overwrite, or
5526deletion, the callback will provide the opportunity for some side
5527effect to happen or for the change to be rejected.
5528
5529The callbacks are named and associated with a function using the
5530U_BOOT_ENV_CALLBACK macro in your board or driver code.
5531
5532These callbacks are associated with variables in one of two ways. The
5533static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5534in the board configuration to a string that defines a list of
5535associations. The list must be in the following format:
5536
5537 entry = variable_name[:callback_name]
5538 list = entry[,list]
5539
5540If the callback name is not specified, then the callback is deleted.
5541Spaces are also allowed anywhere in the list.
5542
5543Callbacks can also be associated by defining the ".callbacks" variable
5544with the same list format above. Any association in ".callbacks" will
5545override any association in the static list. You can define
5546CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5547".callbacks" envirnoment variable in the default or embedded environment.
5548
5549
wdenk6c59edc2004-05-03 20:45:30 +00005550Command Line Parsing:
5551=====================
stroeseb9c17c52003-04-04 15:53:41 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553There are two different command line parsers available with U-Boot:
5554the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556Old, simple command line parser:
5557--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559- supports environment variables (through setenv / saveenv commands)
5560- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005561- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005562- special characters ('$', ';') can be escaped by prefixing with '\',
5563 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005564 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005565- You can also escape text by enclosing in single apostrophes, for example:
5566 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk6c59edc2004-05-03 20:45:30 +00005568Hush shell:
5569-----------
wdenkf4688a22003-05-28 08:06:31 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571- similar to Bourne shell, with control structures like
5572 if...then...else...fi, for...do...done; while...do...done,
5573 until...do...done, ...
5574- supports environment ("global") variables (through setenv / saveenv
5575 commands) and local shell variables (through standard shell syntax
5576 "name=value"); only environment variables can be used with "run"
5577 command
wdenkf4688a22003-05-28 08:06:31 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579General rules:
5580--------------
wdenkf4688a22003-05-28 08:06:31 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582(1) If a command line (or an environment variable executed by a "run"
5583 command) contains several commands separated by semicolon, and
5584 one of these commands fails, then the remaining commands will be
5585 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005586
wdenk6c59edc2004-05-03 20:45:30 +00005587(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005588 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005589 command will cause "run" to terminate, i. e. the remaining
5590 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592Note for Redundant Ethernet Interfaces:
5593=======================================
wdenkf4688a22003-05-28 08:06:31 +00005594
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005595Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005596such configurations and is capable of automatic selection of a
5597"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5600MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5601"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005602
wdenk6c59edc2004-05-03 20:45:30 +00005603If the network interface stores some valid MAC address (for instance
5604in SROM), this is used as default address if there is NO correspon-
5605ding setting in the environment; if the corresponding environment
5606variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608o If the SROM has a valid MAC address, and there is no address in the
5609 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611o If there is no valid address in the SROM, and a definition in the
5612 environment exists, then the value from the environment variable is
5613 used.
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615o If both the SROM and the environment contain a MAC address, and
5616 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618o If both the SROM and the environment contain a MAC address, and the
5619 addresses differ, the value from the environment is used and a
5620 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk6c59edc2004-05-03 20:45:30 +00005622o If neither SROM nor the environment contain a MAC address, an error
5623 is raised.
wdenkc6097192002-11-03 00:24:07 +00005624
Ben Warren6db991a2010-04-26 11:11:46 -07005625If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005626will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005627may be skipped by setting the appropriate 'ethmacskip' environment variable.
5628The naming convention is as follows:
5629"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631Image Formats:
5632==============
wdenkc6097192002-11-03 00:24:07 +00005633
Marian Balakowicz18710b82008-03-12 12:13:13 +01005634U-Boot is capable of booting (and performing other auxiliary operations on)
5635images in two formats:
5636
5637New uImage format (FIT)
5638-----------------------
5639
5640Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5641to Flattened Device Tree). It allows the use of images with multiple
5642components (several kernels, ramdisks, etc.), with contents protected by
5643SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5644
5645
5646Old uImage format
5647-----------------
5648
5649Old image format is based on binary files which can be basically anything,
5650preceded by a special header; see the definitions in include/image.h for
5651details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5654 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005655 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5656 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5657 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005658* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005659 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5660 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005661* Compression Type (uncompressed, gzip, bzip2)
5662* Load Address
5663* Entry Point
5664* Image Name
5665* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667The header is marked by a special Magic Number, and both the header
5668and the data portions of the image are secured against corruption by
5669CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005670
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672Linux Support:
5673==============
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675Although U-Boot should support any OS or standalone application
5676easily, the main focus has always been on Linux during the design of
5677U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk6c59edc2004-05-03 20:45:30 +00005679U-Boot includes many features that so far have been part of some
5680special "boot loader" code within the Linux kernel. Also, any
5681"initrd" images to be used are no longer part of one big Linux image;
5682instead, kernel and "initrd" are separate images. This implementation
5683serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685- the same features can be used for other OS or standalone
5686 applications (for instance: using compressed images to reduce the
5687 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005688
wdenk6c59edc2004-05-03 20:45:30 +00005689- it becomes much easier to port new Linux kernel versions because
5690 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692- the same Linux kernel image can now be used with different "initrd"
5693 images; of course this also means that different kernel images can
5694 be run with the same "initrd". This makes testing easier (you don't
5695 have to build a new "zImage.initrd" Linux image when you just
5696 change a file in your "initrd"). Also, a field-upgrade of the
5697 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005698
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700Linux HOWTO:
5701============
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk6c59edc2004-05-03 20:45:30 +00005703Porting Linux to U-Boot based systems:
5704---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706U-Boot cannot save you from doing all the necessary modifications to
5707configure the Linux device drivers for use with your target hardware
5708(no, we don't intend to provide a full virtual machine interface to
5709Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005710
Stefan Roese88fbf932010-04-15 16:07:28 +02005711But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005712
wdenk6c59edc2004-05-03 20:45:30 +00005713Just make sure your machine specific header file (for instance
5714include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005715Information structure as we define in include/asm-<arch>/u-boot.h,
5716and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005717as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005718
Simon Glassd097e592014-06-11 23:29:46 -06005719Note that U-Boot now has a driver model, a unified model for drivers.
5720If you are adding a new driver, plumb it into driver model. If there
5721is no uclass available, you are encouraged to create one. See
5722doc/driver-model.
5723
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725Configuring the Linux kernel:
5726-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728No specific requirements for U-Boot. Make sure you have some root
5729device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005730
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732Building a Linux Image:
5733-----------------------
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5736not used. If you use recent kernel source, a new build target
5737"uImage" will exist which automatically builds an image usable by
5738U-Boot. Most older kernels also have support for a "pImage" target,
5739which was introduced for our predecessor project PPCBoot and uses a
5740100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk6c59edc2004-05-03 20:45:30 +00005742Example:
wdenkc6097192002-11-03 00:24:07 +00005743
Holger Freyther7ba4e572014-08-04 09:26:05 +02005744 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005745 make oldconfig
5746 make dep
5747 make uImage
wdenkc6097192002-11-03 00:24:07 +00005748
wdenk6c59edc2004-05-03 20:45:30 +00005749The "uImage" build target uses a special tool (in 'tools/mkimage') to
5750encapsulate a compressed Linux kernel image with header information,
5751CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757 ${CROSS_COMPILE}-objcopy -O binary \
5758 -R .note -R .comment \
5759 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005760
wdenk6c59edc2004-05-03 20:45:30 +00005761* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767 mkimage -A ppc -O linux -T kernel -C gzip \
5768 -a 0 -e 0 -n "Linux Kernel Image" \
5769 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005770
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk6c59edc2004-05-03 20:45:30 +00005772The "mkimage" tool can also be used to create ramdisk images for use
5773with U-Boot, either separated from the Linux kernel image, or
5774combined into one file. "mkimage" encapsulates the images with a 64
5775byte header containing information about target architecture,
5776operating system, image type, compression method, entry points, time
5777stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005778
wdenk6c59edc2004-05-03 20:45:30 +00005779"mkimage" can be called in two ways: to verify existing images and
5780print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005781
wdenk6c59edc2004-05-03 20:45:30 +00005782In the first form (with "-l" option) mkimage lists the information
5783contained in the header of an existing U-Boot image; this includes
5784checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005785
wdenk6c59edc2004-05-03 20:45:30 +00005786 tools/mkimage -l image
5787 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789The second form (with "-d" option) is used to build a U-Boot image
5790from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5793 -n name -d data_file image
5794 -A ==> set architecture to 'arch'
5795 -O ==> set operating system to 'os'
5796 -T ==> set image type to 'type'
5797 -C ==> set compression type 'comp'
5798 -a ==> set load address to 'addr' (hex)
5799 -e ==> set entry point to 'ep' (hex)
5800 -n ==> set image name to 'name'
5801 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005802
wdenkcd914452004-05-29 16:53:29 +00005803Right now, all Linux kernels for PowerPC systems use the same load
5804address (0x00000000), but the entry point address depends on the
5805kernel version:
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807- 2.2.x kernels have the entry point at 0x0000000C,
5808- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005809
wdenk6c59edc2004-05-03 20:45:30 +00005810So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005811
wdenk6c59edc2004-05-03 20:45:30 +00005812 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5813 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005814 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005815 > examples/uImage.TQM850L
5816 Image Name: 2.4.4 kernel for TQM850L
5817 Created: Wed Jul 19 02:34:59 2000
5818 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5819 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5820 Load Address: 0x00000000
5821 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005822
wdenk6c59edc2004-05-03 20:45:30 +00005823To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005824
wdenk6c59edc2004-05-03 20:45:30 +00005825 -> tools/mkimage -l examples/uImage.TQM850L
5826 Image Name: 2.4.4 kernel for TQM850L
5827 Created: Wed Jul 19 02:34:59 2000
5828 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5829 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5830 Load Address: 0x00000000
5831 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk6c59edc2004-05-03 20:45:30 +00005833NOTE: for embedded systems where boot time is critical you can trade
5834speed for memory and install an UNCOMPRESSED image instead: this
5835needs more space in Flash, but boots much faster since it does not
5836need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005837
Stefan Roese88fbf932010-04-15 16:07:28 +02005838 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005839 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5840 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005841 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005842 > examples/uImage.TQM850L-uncompressed
5843 Image Name: 2.4.4 kernel for TQM850L
5844 Created: Wed Jul 19 02:34:59 2000
5845 Image Type: PowerPC Linux Kernel Image (uncompressed)
5846 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5847 Load Address: 0x00000000
5848 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005849
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk6c59edc2004-05-03 20:45:30 +00005851Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5852when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk6c59edc2004-05-03 20:45:30 +00005854 -> tools/mkimage -n 'Simple Ramdisk Image' \
5855 > -A ppc -O linux -T ramdisk -C gzip \
5856 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5857 Image Name: Simple Ramdisk Image
5858 Created: Wed Jan 12 14:01:50 2000
5859 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5860 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5861 Load Address: 0x00000000
5862 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005863
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005864The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5865option performs the converse operation of the mkimage's second form (the "-d"
5866option). Given an image built by mkimage, the dumpimage extracts a "data file"
5867from the image:
5868
5869 tools/dumpimage -i image -p position data_file
5870 -i ==> extract from the 'image' a specific 'data_file', \
5871 indexed by 'position'
5872
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk6c59edc2004-05-03 20:45:30 +00005874Installing a Linux Image:
5875-------------------------
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk6c59edc2004-05-03 20:45:30 +00005877To downloading a U-Boot image over the serial (console) interface,
5878you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk6c59edc2004-05-03 20:45:30 +00005880 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005881
wdenk6c59edc2004-05-03 20:45:30 +00005882The 'objcopy' does not understand the information in the U-Boot
5883image header, so the resulting S-Record file will be relative to
5884address 0x00000000. To load it to a given address, you need to
5885specify the target address as 'offset' parameter with the 'loads'
5886command.
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk6c59edc2004-05-03 20:45:30 +00005888Example: install the image to address 0x40100000 (which on the
5889TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk6c59edc2004-05-03 20:45:30 +00005893 .......... done
5894 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005895
wdenk6c59edc2004-05-03 20:45:30 +00005896 => loads 40100000
5897 ## Ready for S-Record download ...
5898 ~>examples/image.srec
5899 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5900 ...
5901 15989 15990 15991 15992
5902 [file transfer complete]
5903 [connected]
5904 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005905
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005908this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005909corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk6c59edc2004-05-03 20:45:30 +00005913 ## Checking Image at 40100000 ...
5914 Image Name: 2.2.13 for initrd on TQM850L
5915 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5916 Data Size: 335725 Bytes = 327 kB = 0 MB
5917 Load Address: 00000000
5918 Entry Point: 0000000c
5919 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005920
5921
wdenk6c59edc2004-05-03 20:45:30 +00005922Boot Linux:
5923-----------
wdenkc6097192002-11-03 00:24:07 +00005924
wdenk6c59edc2004-05-03 20:45:30 +00005925The "bootm" command is used to boot an application that is stored in
5926memory (RAM or Flash). In case of a Linux kernel image, the contents
5927of the "bootargs" environment variable is passed to the kernel as
5928parameters. You can check and modify this variable using the
5929"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005930
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932 => printenv bootargs
5933 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935 => 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 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937 => printenv bootargs
5938 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 +00005939
wdenk6c59edc2004-05-03 20:45:30 +00005940 => bootm 40020000
5941 ## Booting Linux kernel at 40020000 ...
5942 Image Name: 2.2.13 for NFS on TQM850L
5943 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5944 Data Size: 381681 Bytes = 372 kB = 0 MB
5945 Load Address: 00000000
5946 Entry Point: 0000000c
5947 Verifying Checksum ... OK
5948 Uncompressing Kernel Image ... OK
5949 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
5950 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5951 time_init: decrementer frequency = 187500000/60
5952 Calibrating delay loop... 49.77 BogoMIPS
5953 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5954 ...
wdenkc6097192002-11-03 00:24:07 +00005955
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005956If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005957the memory addresses of both the kernel and the initrd image (PPBCOOT
5958format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005961
wdenk6c59edc2004-05-03 20:45:30 +00005962 ## Checking Image at 40100000 ...
5963 Image Name: 2.2.13 for initrd on TQM850L
5964 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5965 Data Size: 335725 Bytes = 327 kB = 0 MB
5966 Load Address: 00000000
5967 Entry Point: 0000000c
5968 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970 ## Checking Image at 40200000 ...
5971 Image Name: Simple Ramdisk Image
5972 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5973 Data Size: 566530 Bytes = 553 kB = 0 MB
5974 Load Address: 00000000
5975 Entry Point: 00000000
5976 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005977
wdenk6c59edc2004-05-03 20:45:30 +00005978 => bootm 40100000 40200000
5979 ## Booting Linux kernel at 40100000 ...
5980 Image Name: 2.2.13 for initrd on TQM850L
5981 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5982 Data Size: 335725 Bytes = 327 kB = 0 MB
5983 Load Address: 00000000
5984 Entry Point: 0000000c
5985 Verifying Checksum ... OK
5986 Uncompressing Kernel Image ... OK
5987 ## Loading RAMDisk Image at 40200000 ...
5988 Image Name: Simple Ramdisk Image
5989 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5990 Data Size: 566530 Bytes = 553 kB = 0 MB
5991 Load Address: 00000000
5992 Entry Point: 00000000
5993 Verifying Checksum ... OK
5994 Loading Ramdisk ... OK
5995 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
5996 Boot arguments: root=/dev/ram
5997 time_init: decrementer frequency = 187500000/60
5998 Calibrating delay loop... 49.77 BogoMIPS
5999 ...
6000 RAMDISK: Compressed image found at block 0
6001 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006002
wdenk6c59edc2004-05-03 20:45:30 +00006003 bash#
wdenkc6097192002-11-03 00:24:07 +00006004
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006005Boot Linux and pass a flat device tree:
6006-----------
6007
6008First, U-Boot must be compiled with the appropriate defines. See the section
6009titled "Linux Kernel Interface" above for a more in depth explanation. The
6010following is an example of how to start a kernel and pass an updated
6011flat device tree:
6012
6013=> print oftaddr
6014oftaddr=0x300000
6015=> print oft
6016oft=oftrees/mpc8540ads.dtb
6017=> tftp $oftaddr $oft
6018Speed: 1000, full duplex
6019Using TSEC0 device
6020TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6021Filename 'oftrees/mpc8540ads.dtb'.
6022Load address: 0x300000
6023Loading: #
6024done
6025Bytes transferred = 4106 (100a hex)
6026=> tftp $loadaddr $bootfile
6027Speed: 1000, full duplex
6028Using TSEC0 device
6029TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6030Filename 'uImage'.
6031Load address: 0x200000
6032Loading:############
6033done
6034Bytes transferred = 1029407 (fb51f hex)
6035=> print loadaddr
6036loadaddr=200000
6037=> print oftaddr
6038oftaddr=0x300000
6039=> bootm $loadaddr - $oftaddr
6040## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006041 Image Name: Linux-2.6.17-dirty
6042 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6043 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006044 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006045 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006046 Verifying Checksum ... OK
6047 Uncompressing Kernel Image ... OK
6048Booting using flat device tree at 0x300000
6049Using MPC85xx ADS machine description
6050Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6051[snip]
6052
6053
wdenk6c59edc2004-05-03 20:45:30 +00006054More About U-Boot Image Types:
6055------------------------------
wdenkc6097192002-11-03 00:24:07 +00006056
wdenk6c59edc2004-05-03 20:45:30 +00006057U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006058
wdenk6c59edc2004-05-03 20:45:30 +00006059 "Standalone Programs" are directly runnable in the environment
6060 provided by U-Boot; it is expected that (if they behave
6061 well) you can continue to work in U-Boot after return from
6062 the Standalone Program.
6063 "OS Kernel Images" are usually images of some Embedded OS which
6064 will take over control completely. Usually these programs
6065 will install their own set of exception handlers, device
6066 drivers, set up the MMU, etc. - this means, that you cannot
6067 expect to re-enter U-Boot except by resetting the CPU.
6068 "RAMDisk Images" are more or less just data blocks, and their
6069 parameters (address, size) are passed to an OS kernel that is
6070 being started.
6071 "Multi-File Images" contain several images, typically an OS
6072 (Linux) kernel image and one or more data images like
6073 RAMDisks. This construct is useful for instance when you want
6074 to boot over the network using BOOTP etc., where the boot
6075 server provides just a single image file, but you want to get
6076 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078 "Multi-File Images" start with a list of image sizes, each
6079 image size (in bytes) specified by an "uint32_t" in network
6080 byte order. This list is terminated by an "(uint32_t)0".
6081 Immediately after the terminating 0 follow the images, one by
6082 one, all aligned on "uint32_t" boundaries (size rounded up to
6083 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006084
wdenk6c59edc2004-05-03 20:45:30 +00006085 "Firmware Images" are binary images containing firmware (like
6086 U-Boot or FPGA images) which usually will be programmed to
6087 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006088
wdenk6c59edc2004-05-03 20:45:30 +00006089 "Script files" are command sequences that will be executed by
6090 U-Boot's command interpreter; this feature is especially
6091 useful when you configure U-Boot to use a real shell (hush)
6092 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006093
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006094Booting the Linux zImage:
6095-------------------------
6096
6097On some platforms, it's possible to boot Linux zImage. This is done
6098using the "bootz" command. The syntax of "bootz" command is the same
6099as the syntax of "bootm" command.
6100
Tom Rini45f46d12013-05-16 11:40:11 -04006101Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006102kernel with raw initrd images. The syntax is slightly different, the
6103address of the initrd must be augmented by it's size, in the following
6104format: "<initrd addres>:<initrd size>".
6105
stroeseb9c17c52003-04-04 15:53:41 +00006106
wdenk6c59edc2004-05-03 20:45:30 +00006107Standalone HOWTO:
6108=================
stroeseb9c17c52003-04-04 15:53:41 +00006109
wdenk6c59edc2004-05-03 20:45:30 +00006110One of the features of U-Boot is that you can dynamically load and
6111run "standalone" applications, which can use some resources of
6112U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006115
wdenk6c59edc2004-05-03 20:45:30 +00006116"Hello World" Demo:
6117-------------------
wdenkc6097192002-11-03 00:24:07 +00006118
wdenk6c59edc2004-05-03 20:45:30 +00006119'examples/hello_world.c' contains a small "Hello World" Demo
6120application; it is automatically compiled when you build U-Boot.
6121It's configured to run at address 0x00040004, so you can play with it
6122like that:
wdenkc6097192002-11-03 00:24:07 +00006123
wdenk6c59edc2004-05-03 20:45:30 +00006124 => loads
6125 ## Ready for S-Record download ...
6126 ~>examples/hello_world.srec
6127 1 2 3 4 5 6 7 8 9 10 11 ...
6128 [file transfer complete]
6129 [connected]
6130 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006131
wdenk6c59edc2004-05-03 20:45:30 +00006132 => go 40004 Hello World! This is a test.
6133 ## Starting application at 0x00040004 ...
6134 Hello World
6135 argc = 7
6136 argv[0] = "40004"
6137 argv[1] = "Hello"
6138 argv[2] = "World!"
6139 argv[3] = "This"
6140 argv[4] = "is"
6141 argv[5] = "a"
6142 argv[6] = "test."
6143 argv[7] = "<NULL>"
6144 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006145
wdenk6c59edc2004-05-03 20:45:30 +00006146 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006147
wdenk6c59edc2004-05-03 20:45:30 +00006148Another example, which demonstrates how to register a CPM interrupt
6149handler with the U-Boot code, can be found in 'examples/timer.c'.
6150Here, a CPM timer is set up to generate an interrupt every second.
6151The interrupt service routine is trivial, just printing a '.'
6152character, but this is just a demo program. The application can be
6153controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk6c59edc2004-05-03 20:45:30 +00006155 ? - print current values og the CPM Timer registers
6156 b - enable interrupts and start timer
6157 e - stop timer and disable interrupts
6158 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006159
wdenk6c59edc2004-05-03 20:45:30 +00006160 => loads
6161 ## Ready for S-Record download ...
6162 ~>examples/timer.srec
6163 1 2 3 4 5 6 7 8 9 10 11 ...
6164 [file transfer complete]
6165 [connected]
6166 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006167
wdenk6c59edc2004-05-03 20:45:30 +00006168 => go 40004
6169 ## Starting application at 0x00040004 ...
6170 TIMERS=0xfff00980
6171 Using timer 1
6172 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006173
wdenk6c59edc2004-05-03 20:45:30 +00006174Hit 'b':
6175 [q, b, e, ?] Set interval 1000000 us
6176 Enabling timer
6177Hit '?':
6178 [q, b, e, ?] ........
6179 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6180Hit '?':
6181 [q, b, e, ?] .
6182 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6183Hit '?':
6184 [q, b, e, ?] .
6185 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6186Hit '?':
6187 [q, b, e, ?] .
6188 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6189Hit 'e':
6190 [q, b, e, ?] ...Stopping timer
6191Hit 'q':
6192 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006193
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195Minicom warning:
6196================
wdenkc6097192002-11-03 00:24:07 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198Over time, many people have reported problems when trying to use the
6199"minicom" terminal emulation program for serial download. I (wd)
6200consider minicom to be broken, and recommend not to use it. Under
6201Unix, I recommend to use C-Kermit for general purpose use (and
6202especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006203use "cu" for S-Record download ("loads" command). See
6204http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6205for help with kermit.
6206
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208Nevertheless, if you absolutely want to use it try adding this
6209configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211 Name Program Name U/D FullScr IO-Red. Multi
6212 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6213 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006214
wdenk8dba0502003-03-31 16:34:49 +00006215
wdenk6c59edc2004-05-03 20:45:30 +00006216NetBSD Notes:
6217=============
wdenkc6097192002-11-03 00:24:07 +00006218
wdenk6c59edc2004-05-03 20:45:30 +00006219Starting at version 0.9.2, U-Boot supports NetBSD both as host
6220(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006221
wdenk6c59edc2004-05-03 20:45:30 +00006222Building requires a cross environment; it is known to work on
6223NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6224need gmake since the Makefiles are not compatible with BSD make).
6225Note that the cross-powerpc package does not install include files;
6226attempting to build U-Boot will fail because <machine/ansi.h> is
6227missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006228
wdenk6c59edc2004-05-03 20:45:30 +00006229 # cd /usr/pkg/cross/powerpc-netbsd/include
6230 # mkdir powerpc
6231 # ln -s powerpc machine
6232 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6233 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006234
wdenk6c59edc2004-05-03 20:45:30 +00006235Native builds *don't* work due to incompatibilities between native
6236and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006237
wdenk6c59edc2004-05-03 20:45:30 +00006238Booting assumes that (the first part of) the image booted is a
6239stage-2 loader which in turn loads and then invokes the kernel
6240proper. Loader sources will eventually appear in the NetBSD source
6241tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006242meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006243
wdenkc6097192002-11-03 00:24:07 +00006244
wdenk6c59edc2004-05-03 20:45:30 +00006245Implementation Internals:
6246=========================
wdenkc6097192002-11-03 00:24:07 +00006247
wdenk6c59edc2004-05-03 20:45:30 +00006248The following is not intended to be a complete description of every
6249implementation detail. However, it should help to understand the
6250inner workings of U-Boot and make it easier to port it to custom
6251hardware.
wdenkc6097192002-11-03 00:24:07 +00006252
wdenkc6097192002-11-03 00:24:07 +00006253
wdenk6c59edc2004-05-03 20:45:30 +00006254Initial Stack, Global Data:
6255---------------------------
wdenkc6097192002-11-03 00:24:07 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257The implementation of U-Boot is complicated by the fact that U-Boot
6258starts running out of ROM (flash memory), usually without access to
6259system RAM (because the memory controller is not initialized yet).
6260This means that we don't have writable Data or BSS segments, and BSS
6261is not initialized as zero. To be able to get a C environment working
6262at all, we have to allocate at least a minimal stack. Implementation
6263options for this are defined and restricted by the CPU used: Some CPU
6264models provide on-chip memory (like the IMMR area on MPC8xx and
6265MPC826x processors), on others (parts of) the data cache can be
6266locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006267
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006268 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006269 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk6c59edc2004-05-03 20:45:30 +00006271 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6272 From: "Chris Hallinan" <clh@net1plus.com>
6273 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6274 ...
wdenkc6097192002-11-03 00:24:07 +00006275
wdenk6c59edc2004-05-03 20:45:30 +00006276 Correct me if I'm wrong, folks, but the way I understand it
6277 is this: Using DCACHE as initial RAM for Stack, etc, does not
6278 require any physical RAM backing up the cache. The cleverness
6279 is that the cache is being used as a temporary supply of
6280 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006281 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006282 can see how this works by studying the cache architecture and
6283 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006284
wdenk6c59edc2004-05-03 20:45:30 +00006285 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6286 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006287 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006288 option should work for you. Using CS 4 should be fine if your
6289 board designers haven't used it for something that would
6290 cause you grief during the initial boot! It is frequently not
6291 used.
wdenkc6097192002-11-03 00:24:07 +00006292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006293 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006294 with your processor/board/system design. The default value
6295 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006296 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006297 than your SDRAM module. If you have a 64MB SDRAM module, set
6298 it above 400_0000. Just make sure your board has no resources
6299 that are supposed to respond to that address! That code in
6300 start.S has been around a while and should work as is when
6301 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006302
wdenk6c59edc2004-05-03 20:45:30 +00006303 -Chris Hallinan
6304 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006305
wdenk6c59edc2004-05-03 20:45:30 +00006306It is essential to remember this, since it has some impact on the C
6307code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006308
wdenk6c59edc2004-05-03 20:45:30 +00006309* Initialized global data (data segment) is read-only. Do not attempt
6310 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006311
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006312* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00006313 as zero data - BSS segment) at all - this is undefined, initiali-
6314 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006315
wdenk6c59edc2004-05-03 20:45:30 +00006316* Stack space is very limited. Avoid big data buffers or things like
6317 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006318
wdenk6c59edc2004-05-03 20:45:30 +00006319Having only the stack as writable memory limits means we cannot use
6320normal global data to share information beween the code. But it
6321turned out that the implementation of U-Boot can be greatly
6322simplified by making a global data structure (gd_t) available to all
6323functions. We could pass a pointer to this data as argument to _all_
6324functions, but this would bloat the code. Instead we use a feature of
6325the GCC compiler (Global Register Variables) to share the data: we
6326place a pointer (gd) to the global data into a register which we
6327reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006328
wdenk6c59edc2004-05-03 20:45:30 +00006329When choosing a register for such a purpose we are restricted by the
6330relevant (E)ABI specifications for the current architecture, and by
6331GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006332
wdenk6c59edc2004-05-03 20:45:30 +00006333For PowerPC, the following registers have specific use:
6334 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006335 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006336 R3-R4: parameter passing and return values
6337 R5-R10: parameter passing
6338 R13: small data area pointer
6339 R30: GOT pointer
6340 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006341
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006342 (U-Boot also uses R12 as internal GOT pointer. r12
6343 is a volatile register so r12 needs to be reset when
6344 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006345
Wolfgang Denk69c09642008-02-14 22:43:22 +01006346 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006347
wdenk6c59edc2004-05-03 20:45:30 +00006348 Note: on PPC, we could use a static initializer (since the
6349 address of the global data structure is known at compile time),
6350 but it turned out that reserving a register results in somewhat
6351 smaller code - although the code savings are not that big (on
6352 average for all boards 752 bytes for the whole U-Boot image,
6353 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006354
Robin Getz2773d5f2009-08-17 15:23:02 +00006355On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006356 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6357
Robin Getz2773d5f2009-08-17 15:23:02 +00006358 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006359
wdenk6c59edc2004-05-03 20:45:30 +00006360On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006361
wdenk6c59edc2004-05-03 20:45:30 +00006362 R0: function argument word/integer result
6363 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006364 R9: platform specific
6365 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006366 R11: argument (frame) pointer
6367 R12: temporary workspace
6368 R13: stack pointer
6369 R14: link register
6370 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006371
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006372 ==> U-Boot will use R9 to hold a pointer to the global data
6373
6374 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006375
Thomas Chou8fa38582010-05-21 11:08:03 +08006376On Nios II, the ABI is documented here:
6377 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6378
6379 ==> U-Boot will use gp to hold a pointer to the global data
6380
6381 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6382 to access small data sections, so gp is free.
6383
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006384On NDS32, the following registers are used:
6385
6386 R0-R1: argument/return
6387 R2-R5: argument
6388 R15: temporary register for assembler
6389 R16: trampoline register
6390 R28: frame pointer (FP)
6391 R29: global pointer (GP)
6392 R30: link register (LP)
6393 R31: stack pointer (SP)
6394 PC: program counter (PC)
6395
6396 ==> U-Boot will use R10 to hold a pointer to the global data
6397
Wolfgang Denk6405a152006-03-31 18:32:53 +02006398NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6399or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk6c59edc2004-05-03 20:45:30 +00006401Memory Management:
6402------------------
wdenkc6097192002-11-03 00:24:07 +00006403
wdenk6c59edc2004-05-03 20:45:30 +00006404U-Boot runs in system state and uses physical addresses, i.e. the
6405MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006406
wdenk6c59edc2004-05-03 20:45:30 +00006407The available memory is mapped to fixed addresses using the memory
6408controller. In this process, a contiguous block is formed for each
6409memory type (Flash, SDRAM, SRAM), even when it consists of several
6410physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006411
wdenk6c59edc2004-05-03 20:45:30 +00006412U-Boot is installed in the first 128 kB of the first Flash bank (on
6413TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6414booting and sizing and initializing DRAM, the code relocates itself
6415to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006416memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006417configuration setting]. Below that, a structure with global Board
6418Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006419
wdenk6c59edc2004-05-03 20:45:30 +00006420Additionally, some exception handler code is copied to the low 8 kB
6421of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006422
wdenk6c59edc2004-05-03 20:45:30 +00006423So a typical memory configuration with 16 MB of DRAM could look like
6424this:
wdenkc6097192002-11-03 00:24:07 +00006425
wdenk6c59edc2004-05-03 20:45:30 +00006426 0x0000 0000 Exception Vector code
6427 :
6428 0x0000 1FFF
6429 0x0000 2000 Free for Application Use
6430 :
6431 :
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk6c59edc2004-05-03 20:45:30 +00006433 :
6434 :
6435 0x00FB FF20 Monitor Stack (Growing downward)
6436 0x00FB FFAC Board Info Data and permanent copy of global data
6437 0x00FC 0000 Malloc Arena
6438 :
6439 0x00FD FFFF
6440 0x00FE 0000 RAM Copy of Monitor Code
6441 ... eventually: LCD or video framebuffer
6442 ... eventually: pRAM (Protected RAM - unchanged by reset)
6443 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006444
wdenkc6097192002-11-03 00:24:07 +00006445
wdenk6c59edc2004-05-03 20:45:30 +00006446System Initialization:
6447----------------------
wdenkc6097192002-11-03 00:24:07 +00006448
wdenk6c59edc2004-05-03 20:45:30 +00006449In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006450(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00006451configuration for CS0# this is a mirror of the onboard Flash memory.
6452To be able to re-map memory U-Boot then jumps to its link address.
6453To be able to implement the initialization code in C, a (small!)
6454initial stack is set up in the internal Dual Ported RAM (in case CPUs
6455which provide such a feature like MPC8xx or MPC8260), or in a locked
6456part of the data cache. After that, U-Boot initializes the CPU core,
6457the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk6c59edc2004-05-03 20:45:30 +00006459Next, all (potentially) available memory banks are mapped using a
6460preliminary mapping. For example, we put them on 512 MB boundaries
6461(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6462on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6463programmed for SDRAM access. Using the temporary configuration, a
6464simple memory test is run that determines the size of the SDRAM
6465banks.
wdenkc6097192002-11-03 00:24:07 +00006466
wdenk6c59edc2004-05-03 20:45:30 +00006467When there is more than one SDRAM bank, and the banks are of
6468different size, the largest is mapped first. For equal size, the first
6469bank (CS2#) is mapped first. The first mapping is always for address
64700x00000000, with any additional banks following immediately to create
6471contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006472
wdenk6c59edc2004-05-03 20:45:30 +00006473Then, the monitor installs itself at the upper end of the SDRAM area
6474and allocates memory for use by malloc() and for the global Board
6475Info data; also, the exception vector code is copied to the low RAM
6476pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006477
wdenk6c59edc2004-05-03 20:45:30 +00006478Only after this relocation will you have a "normal" C environment;
6479until that you are restricted in several ways, mostly because you are
6480running from ROM, and because the code will have to be relocated to a
6481new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006482
wdenkc6097192002-11-03 00:24:07 +00006483
wdenk6c59edc2004-05-03 20:45:30 +00006484U-Boot Porting Guide:
6485----------------------
wdenkc6097192002-11-03 00:24:07 +00006486
wdenk6c59edc2004-05-03 20:45:30 +00006487[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6488list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006489
wdenkc6097192002-11-03 00:24:07 +00006490
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006491int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006492{
6493 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006494
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006495 signal(SIGALRM, no_more_time);
6496 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006497
wdenk6c59edc2004-05-03 20:45:30 +00006498 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006499 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006500 return 0;
6501 }
wdenkc6097192002-11-03 00:24:07 +00006502
wdenk6c59edc2004-05-03 20:45:30 +00006503 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006504
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006505 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006506
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006507 if (clueless)
6508 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006509
wdenk6c59edc2004-05-03 20:45:30 +00006510 while (learning) {
6511 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006512 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6513 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006514 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006515 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006516 }
wdenkc6097192002-11-03 00:24:07 +00006517
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006518 if (available_money > toLocalCurrency ($2500))
6519 Buy a BDI3000;
6520 else
wdenk6c59edc2004-05-03 20:45:30 +00006521 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006522
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006523 if (a similar board exists) { /* hopefully... */
6524 cp -a board/<similar> board/<myboard>
6525 cp include/configs/<similar>.h include/configs/<myboard>.h
6526 } else {
6527 Create your own board support subdirectory;
6528 Create your own board include/configs/<myboard>.h file;
6529 }
6530 Edit new board/<myboard> files
6531 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006532
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006533 while (!accepted) {
6534 while (!running) {
6535 do {
6536 Add / modify source code;
6537 } until (compiles);
6538 Debug;
6539 if (clueless)
6540 email("Hi, I am having problems...");
6541 }
6542 Send patch file to the U-Boot email list;
6543 if (reasonable critiques)
6544 Incorporate improvements from email list code review;
6545 else
6546 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006547 }
wdenkc6097192002-11-03 00:24:07 +00006548
wdenk6c59edc2004-05-03 20:45:30 +00006549 return 0;
6550}
wdenkc6097192002-11-03 00:24:07 +00006551
wdenk6c59edc2004-05-03 20:45:30 +00006552void no_more_time (int sig)
6553{
6554 hire_a_guru();
6555}
wdenkc6097192002-11-03 00:24:07 +00006556
wdenkc6097192002-11-03 00:24:07 +00006557
wdenk6c59edc2004-05-03 20:45:30 +00006558Coding Standards:
6559-----------------
wdenkc6097192002-11-03 00:24:07 +00006560
wdenk6c59edc2004-05-03 20:45:30 +00006561All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006562coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006563"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006564
6565Source files originating from a different project (for example the
6566MTD subsystem) are generally exempt from these guidelines and are not
6567reformated to ease subsequent migration to newer versions of those
6568sources.
wdenkc6097192002-11-03 00:24:07 +00006569
Detlev Zundelaa63d482006-09-01 15:39:02 +02006570Please note that U-Boot is implemented in C (and to some small parts in
6571Assembler); no C++ is used, so please do not use C++ style comments (//)
6572in your code.
wdenkad276f22004-01-04 16:28:35 +00006573
wdenk6c59edc2004-05-03 20:45:30 +00006574Please also stick to the following formatting rules:
6575- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006576- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006577- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006578- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006579- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006580
wdenk6c59edc2004-05-03 20:45:30 +00006581Submissions which do not conform to the standards may be returned
6582with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006583
wdenkc6097192002-11-03 00:24:07 +00006584
wdenk6c59edc2004-05-03 20:45:30 +00006585Submitting Patches:
6586-------------------
wdenkc6097192002-11-03 00:24:07 +00006587
wdenk6c59edc2004-05-03 20:45:30 +00006588Since the number of patches for U-Boot is growing, we need to
6589establish some rules. Submissions which do not conform to these rules
6590may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006591
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006592Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006593
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006594Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6595see http://lists.denx.de/mailman/listinfo/u-boot
6596
wdenk6c59edc2004-05-03 20:45:30 +00006597When you send a patch, please include the following information with
6598it:
wdenkc6097192002-11-03 00:24:07 +00006599
wdenk6c59edc2004-05-03 20:45:30 +00006600* For bug fixes: a description of the bug and how your patch fixes
6601 this bug. Please try to include a way of demonstrating that the
6602 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006603
wdenk6c59edc2004-05-03 20:45:30 +00006604* For new features: a description of the feature and your
6605 implementation.
wdenkc6097192002-11-03 00:24:07 +00006606
wdenk6c59edc2004-05-03 20:45:30 +00006607* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006608
wdenk6c59edc2004-05-03 20:45:30 +00006609* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006610
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006611* When you add support for a new board, don't forget to add a
6612 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006613
wdenk6c59edc2004-05-03 20:45:30 +00006614* If your patch adds new configuration options, don't forget to
6615 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006616
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006617* The patch itself. If you are using git (which is *strongly*
6618 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006619 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006620 the U-Boot mailing list, you will avoid most of the common problems
6621 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006622
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006623 If you cannot use git, use "diff -purN OLD NEW". If your version of
6624 diff does not support these options, then get the latest version of
6625 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006626
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006627 The current directory when running this command shall be the parent
6628 directory of the U-Boot source tree (i. e. please make sure that
6629 your patch includes sufficient directory information for the
6630 affected files).
6631
6632 We prefer patches as plain text. MIME attachments are discouraged,
6633 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006634
wdenk6c59edc2004-05-03 20:45:30 +00006635* If one logical set of modifications affects or creates several
6636 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006637
wdenk6c59edc2004-05-03 20:45:30 +00006638* Changesets that contain different, unrelated modifications shall be
6639 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006640
wdenkc6097192002-11-03 00:24:07 +00006641
wdenk6c59edc2004-05-03 20:45:30 +00006642Notes:
wdenkc6097192002-11-03 00:24:07 +00006643
wdenk6c59edc2004-05-03 20:45:30 +00006644* Before sending the patch, run the MAKEALL script on your patched
6645 source tree and make sure that no errors or warnings are reported
6646 for any of the boards.
6647
6648* Keep your modifications to the necessary minimum: A patch
6649 containing several unrelated changes or arbitrary reformats will be
6650 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006651
wdenk6c59edc2004-05-03 20:45:30 +00006652* If you modify existing code, make sure that your new code does not
6653 add to the memory footprint of the code ;-) Small is beautiful!
6654 When adding new features, these should compile conditionally only
6655 (using #ifdef), and the resulting code with the new feature
6656 disabled must not need more memory than the old code without your
6657 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006658
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006659* Remember that there is a size limit of 100 kB per message on the
6660 u-boot mailing list. Bigger patches will be moderated. If they are
6661 reasonable and not too big, they will be acknowledged. But patches
6662 bigger than the size limit should be avoided.