blob: 4ca04d0489ed3dcd3f04f403cc527f633746f1c2 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
Holger Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-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 Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-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
wdenk7f6c2cb2002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Gala66412c62011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala8f290842011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood33eee332012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530412 CONFIG_A008044_WORKAROUND
413 Enables a workaround for T1040/T1042 erratum A008044. It is only
414 requred during NAND boot and valid for Rev 1.0 SoC revision
415
Scott Wood33eee332012-08-14 10:14:53 +0000416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Priyanka Jain64501c62013-07-02 09:21:04 +0530421 CONFIG_SYS_FSL_DSP_DDR_ADDR
422 This value denotes start offset of DDR memory which is
423 connected exclusively to the DSP cores.
424
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
Priyanka Jain64501c62013-07-02 09:21:04 +0530429 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430 This value denotes start offset of M3 memory which is directly
431 connected to the DSP core.
432
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530433 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434 This value denotes start offset of DSP CCSR space.
435
Priyanka Jainb1359912013-12-17 14:25:52 +0530436 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437 Single Source Clock is clocking mode present in some of FSL SoC's.
438 In this mode, a single differential clock is used to supply
439 clocks to the sysclock, ddrclock and usbclock.
440
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530441 CONFIG_SYS_CPC_REINIT_F
442 This CONFIG is defined when the CPC is configured as SRAM at the
443 time of U-boot entry and is required to be re-initialized.
444
Tang Yuantianaade2002014-04-17 15:33:46 +0800445 CONFIG_DEEP_SLEEP
446 Inidcates this SoC supports deep sleep feature. If deep sleep is
447 supported, core will start to execute uboot when wakes up.
448
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000449- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700450 CONFIG_SYS_GENERIC_GLOBAL_DATA
451 Defines global data is initialized in generic board board_init_f().
452 If this macro is defined, global data is created and cleared in
453 generic board board_init_f(). Without this macro, architecture/board
454 should initialize global data before calling board_init_f().
455
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000456 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458 Defines the endianess of the CPU. Implementation of those
459 values is arch specific.
460
York Sun5614e712013-09-30 09:22:09 -0700461 CONFIG_SYS_FSL_DDR
462 Freescale DDR driver in use. This type of DDR controller is
463 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464 SoCs.
465
466 CONFIG_SYS_FSL_DDR_ADDR
467 Freescale DDR memory-mapped register base.
468
469 CONFIG_SYS_FSL_DDR_EMU
470 Specify emulator support for DDR. Some DDR features such as
471 deskew training are not available.
472
473 CONFIG_SYS_FSL_DDRC_GEN1
474 Freescale DDR1 controller.
475
476 CONFIG_SYS_FSL_DDRC_GEN2
477 Freescale DDR2 controller.
478
479 CONFIG_SYS_FSL_DDRC_GEN3
480 Freescale DDR3 controller.
481
York Sun34e026f2014-03-27 17:54:47 -0700482 CONFIG_SYS_FSL_DDRC_GEN4
483 Freescale DDR4 controller.
484
York Sun9ac4ffb2013-09-30 14:20:51 -0700485 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486 Freescale DDR3 controller for ARM-based SoCs.
487
York Sun5614e712013-09-30 09:22:09 -0700488 CONFIG_SYS_FSL_DDR1
489 Board config to use DDR1. It can be enabled for SoCs with
490 Freescale DDR1 or DDR2 controllers, depending on the board
491 implemetation.
492
493 CONFIG_SYS_FSL_DDR2
494 Board config to use DDR2. It can be eanbeld for SoCs with
495 Freescale DDR2 or DDR3 controllers, depending on the board
496 implementation.
497
498 CONFIG_SYS_FSL_DDR3
499 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700500 Freescale DDR3 or DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR3L
503 Board config to use DDR3L. It can be enabled for SoCs with
504 DDR3L controllers.
505
506 CONFIG_SYS_FSL_DDR4
507 Board config to use DDR4. It can be enabled for SoCs with
508 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700509
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530510 CONFIG_SYS_FSL_IFC_BE
511 Defines the IFC controller register space as Big Endian
512
513 CONFIG_SYS_FSL_IFC_LE
514 Defines the IFC controller register space as Little Endian
515
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530516 CONFIG_SYS_FSL_PBL_PBI
517 It enables addition of RCW (Power on reset configuration) in built image.
518 Please refer doc/README.pblimage for more details
519
520 CONFIG_SYS_FSL_PBL_RCW
521 It adds PBI(pre-boot instructions) commands in u-boot build image.
522 PBI commands can be used to configure SoC before it starts the execution.
523 Please refer doc/README.pblimage for more details
524
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530525 CONFIG_SPL_FSL_PBL
526 It adds a target to create boot binary having SPL binary in PBI format
527 concatenated with u-boot binary.
528
York Sun4e5b1bd2014-02-10 13:59:42 -0800529 CONFIG_SYS_FSL_DDR_BE
530 Defines the DDR controller register space as Big Endian
531
532 CONFIG_SYS_FSL_DDR_LE
533 Defines the DDR controller register space as Little Endian
534
York Sun6b9e3092014-02-10 13:59:43 -0800535 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536 Physical address from the view of DDR controllers. It is the
537 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
538 it could be different for ARM SoCs.
539
York Sun6b1e1252014-02-10 13:59:44 -0800540 CONFIG_SYS_FSL_DDR_INTLV_256B
541 DDR controller interleaving on 256-byte. This is a special
542 interleaving mode, handled by Dickens for Freescale layerscape
543 SoCs with ARM core.
544
York Sun1d71efb2014-08-01 15:51:00 -0700545 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546 Number of controllers used as main memory.
547
548 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549 Number of controllers used for other than main memory.
550
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530551 CONFIG_SYS_FSL_SEC_BE
552 Defines the SEC controller register space as Big Endian
553
554 CONFIG_SYS_FSL_SEC_LE
555 Defines the SEC controller register space as Little Endian
556
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100557- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200558 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100559
560 Defines the Monahans run mode to oscillator
561 ratio. Valid values are 8, 16, 24, 31. The core
562 frequency is this value multiplied by 13 MHz.
563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200564 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200565
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100566 Defines the Monahans turbo mode to oscillator
567 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200568 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100569 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200570
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200571- MIPS CPU options:
572 CONFIG_SYS_INIT_SP_OFFSET
573
574 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
575 pointer. This is needed for the temporary stack before
576 relocation.
577
578 CONFIG_SYS_MIPS_CACHE_MODE
579
580 Cache operation mode for the MIPS CPU.
581 See also arch/mips/include/asm/mipsregs.h.
582 Possible values are:
583 CONF_CM_CACHABLE_NO_WA
584 CONF_CM_CACHABLE_WA
585 CONF_CM_UNCACHED
586 CONF_CM_CACHABLE_NONCOHERENT
587 CONF_CM_CACHABLE_CE
588 CONF_CM_CACHABLE_COW
589 CONF_CM_CACHABLE_CUW
590 CONF_CM_CACHABLE_ACCELERATED
591
592 CONFIG_SYS_XWAY_EBU_BOOTCFG
593
594 Special option for Lantiq XWAY SoCs for booting from NOR flash.
595 See also arch/mips/cpu/mips32/start.S.
596
597 CONFIG_XWAY_SWAP_BYTES
598
599 Enable compilation of tools/xway-swap-bytes needed for Lantiq
600 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
601 be swapped if a flash programmer is used.
602
Christian Rieschb67d8812012-02-02 00:44:39 +0000603- ARM options:
604 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
605
606 Select high exception vectors of the ARM core, e.g., do not
607 clear the V bit of the c1 register of CP15.
608
Aneesh V5356f542012-03-08 07:20:19 +0000609 CONFIG_SYS_THUMB_BUILD
610
611 Use this flag to build U-Boot using the Thumb instruction
612 set for ARM architectures. Thumb instruction set provides
613 better code density. For ARM architectures that support
614 Thumb2 this flag will result in Thumb2 code generated by
615 GCC.
616
Stephen Warrenc5d47522013-03-04 13:29:40 +0000617 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000618 CONFIG_ARM_ERRATA_742230
619 CONFIG_ARM_ERRATA_743622
620 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500621 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500622 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000623
624 If set, the workarounds for these ARM errata are applied early
625 during U-Boot startup. Note that these options force the
626 workarounds to be applied; no CPU-type/version detection
627 exists, unlike the similar options in the Linux kernel. Do not
628 set these options unless they apply!
629
Simon Glass38687ae2014-11-10 17:16:54 -0700630- Driver Model
631 Driver model is a new framework for devices in U-Boot
632 introduced in early 2014. U-Boot is being progressively
633 moved over to this. It offers a consistent device structure,
634 supports grouping devices into classes and has built-in
635 handling of platform data and device tree.
636
637 To enable transition to driver model in a relatively
638 painful fashion, each subsystem can be independently
639 switched between the legacy/ad-hoc approach and the new
640 driver model using the options below. Also, many uclass
641 interfaces include compatibility features which may be
642 removed once the conversion of that subsystem is complete.
643 As a result, the API provided by the subsystem may in fact
644 not change with driver model.
645
646 See doc/driver-model/README.txt for more information.
647
648 CONFIG_DM
649
650 Enable driver model. This brings in the core support,
651 including scanning of platform data on start-up. If
652 CONFIG_OF_CONTROL is enabled, the device tree will be
653 scanned also when available.
654
655 CONFIG_CMD_DM
656
657 Enable driver model test commands. These allow you to print
658 out the driver model tree and the uclasses.
659
660 CONFIG_DM_DEMO
661
662 Enable some demo devices and the 'demo' command. These are
663 really only useful for playing around while trying to
664 understand driver model in sandbox.
665
666 CONFIG_SPL_DM
667
668 Enable driver model in SPL. You will need to provide a
669 suitable malloc() implementation. If you are not using the
670 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
671 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
672 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
673 In most cases driver model will only allocate a few uclasses
674 and devices in SPL, so 1KB should be enable. See
675 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
676 it.
677
678 CONFIG_DM_SERIAL
679
680 Enable driver model for serial. This replaces
681 drivers/serial/serial.c with the serial uclass, which
682 implements serial_putc() etc. The uclass interface is
683 defined in include/serial.h.
684
685 CONFIG_DM_GPIO
686
687 Enable driver model for GPIO access. The standard GPIO
688 interface (gpio_get_value(), etc.) is then implemented by
689 the GPIO uclass. Drivers provide methods to query the
690 particular GPIOs that they provide. The uclass interface
691 is defined in include/asm-generic/gpio.h.
692
693 CONFIG_DM_SPI
694
695 Enable driver model for SPI. The SPI slave interface
696 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
697 the SPI uclass. Drivers provide methods to access the SPI
698 buses that they control. The uclass interface is defined in
699 include/spi.h. The existing spi_slave structure is attached
700 as 'parent data' to every slave on each bus. Slaves
701 typically use driver-private data instead of extending the
702 spi_slave structure.
703
704 CONFIG_DM_SPI_FLASH
705
706 Enable driver model for SPI flash. This SPI flash interface
707 (spi_flash_probe(), spi_flash_write(), etc.) is then
708 implemented by the SPI flash uclass. There is one standard
709 SPI flash driver which knows how to probe most chips
710 supported by U-Boot. The uclass interface is defined in
711 include/spi_flash.h, but is currently fully compatible
712 with the old interface to avoid confusion and duplication
713 during the transition parent. SPI and SPI flash must be
714 enabled together (it is not possible to use driver model
715 for one and not the other).
716
717 CONFIG_DM_CROS_EC
718
719 Enable driver model for the Chrome OS EC interface. This
720 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
721 but otherwise makes few changes. Since cros_ec also supports
722 I2C and LPC (which don't support driver model yet), a full
723 conversion is not yet possible.
724
725
726 ** Code size options: The following options are enabled by
727 default except in SPL. Enable them explicitly to get these
728 features in SPL.
729
730 CONFIG_DM_WARN
731
732 Enable the dm_warn() function. This can use up quite a bit
733 of space for its strings.
734
735 CONFIG_DM_STDIO
736
737 Enable registering a serial device with the stdio library.
738
739 CONFIG_DM_DEVICE_REMOVE
740
741 Enable removing of devices.
742
743
wdenk5da627a2003-10-09 20:09:04 +0000744- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_CLOCKS_IN_MHZ
746
747 U-Boot stores all clock information in Hz
748 internally. For binary compatibility with older Linux
749 kernels (which expect the clocks passed in the
750 bd_info data to be in MHz) the environment variable
751 "clocks_in_mhz" can be defined so that U-Boot
752 converts clock data to MHZ before passing it to the
753 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000754 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100755 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000756 default environment.
757
wdenk5da627a2003-10-09 20:09:04 +0000758 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
759
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200760 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000761 expect it to be in bytes, others in MB.
762 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
763
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400764 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200765
766 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400767 passed using flattened device trees (based on open firmware
768 concepts).
769
770 CONFIG_OF_LIBFDT
771 * New libfdt-based support
772 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500773 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400774
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200775 OF_CPU - The proper name of the cpus node (only required for
776 MPC512X and MPC5xxx based boards).
777 OF_SOC - The proper name of the soc node (only required for
778 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200779 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600780 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200781
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200782 boards with QUICC Engines require OF_QE to set UCC MAC
783 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500784
Kumar Gala4e253132006-01-11 13:54:17 -0600785 CONFIG_OF_BOARD_SETUP
786
787 Board code has addition modification that it wants to make
788 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000789
Simon Glassc654b512014-10-23 18:58:54 -0600790 CONFIG_OF_SYSTEM_SETUP
791
792 Other code has addition modification that it wants to make
793 to the flat device tree before handing it off to the kernel.
794 This causes ft_system_setup() to be called before booting
795 the kernel.
796
Matthew McClintock02677682006-06-28 10:41:37 -0500797 CONFIG_OF_BOOT_CPU
798
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200799 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500800 param header, the default value is zero if undefined.
801
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200802 CONFIG_OF_IDE_FIXUP
803
804 U-Boot can detect if an IDE device is present or not.
805 If not, and this new config option is activated, U-Boot
806 removes the ATA node from the DTS before booting Linux,
807 so the Linux IDE driver does not probe the device and
808 crash. This is needed for buggy hardware (uc101) where
809 no pull down resistor is connected to the signal IDE5V_DD7.
810
Igor Grinberg7eb29392011-07-14 05:45:07 +0000811 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
812
813 This setting is mandatory for all boards that have only one
814 machine type and must be used to specify the machine type
815 number as it appears in the ARM machine registry
816 (see http://www.arm.linux.org.uk/developer/machines/).
817 Only boards that have multiple machine types supported
818 in a single configuration file and the machine type is
819 runtime discoverable, do not have to use this setting.
820
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100821- vxWorks boot parameters:
822
823 bootvx constructs a valid bootline using the following
824 environments variables: bootfile, ipaddr, serverip, hostname.
825 It loads the vxWorks image pointed bootfile.
826
827 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
828 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
829 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
830 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
831
832 CONFIG_SYS_VXWORKS_ADD_PARAMS
833
834 Add it at the end of the bootline. E.g "u=username pw=secret"
835
836 Note: If a "bootargs" environment is defined, it will overwride
837 the defaults discussed just above.
838
Aneesh V2c451f72011-06-16 23:30:47 +0000839- Cache Configuration:
840 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
841 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
842 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
843
Aneesh V93bc2192011-06-16 23:30:51 +0000844- Cache Configuration for ARM:
845 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
846 controller
847 CONFIG_SYS_PL310_BASE - Physical base address of PL310
848 controller register space
849
wdenk6705d812004-08-02 23:22:59 +0000850- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200851 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000852
853 Define this if you want support for Amba PrimeCell PL010 UARTs.
854
Andreas Engel48d01922008-09-08 14:30:53 +0200855 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000856
857 Define this if you want support for Amba PrimeCell PL011 UARTs.
858
859 CONFIG_PL011_CLOCK
860
861 If you have Amba PrimeCell PL011 UARTs, set this variable to
862 the clock speed of the UARTs.
863
864 CONFIG_PL01x_PORTS
865
866 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
867 define this to a list of base addresses for each (supported)
868 port. See e.g. include/configs/versatile.h
869
John Rigby910f1ae2011-04-19 10:42:39 +0000870 CONFIG_PL011_SERIAL_RLCR
871
872 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
873 have separate receive and transmit line control registers. Set
874 this variable to initialize the extra register.
875
876 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
877
878 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
879 boot loader that has already initialized the UART. Define this
880 variable to flush the UART at init time.
881
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400882 CONFIG_SERIAL_HW_FLOW_CONTROL
883
884 Define this variable to enable hw flow control in serial driver.
885 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000886
wdenkc6097192002-11-03 00:24:07 +0000887- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000888 Depending on board, define exactly one serial port
889 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
890 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
891 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000892
893 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
894 port routines must be defined elsewhere
895 (i.e. serial_init(), serial_getc(), ...)
896
897 CONFIG_CFB_CONSOLE
898 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000899 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000900 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
901 (default big endian)
902 VIDEO_HW_RECTFILL graphic chip supports
903 rectangle fill
904 (cf. smiLynxEM)
905 VIDEO_HW_BITBLT graphic chip supports
906 bit-blit (cf. smiLynxEM)
907 VIDEO_VISIBLE_COLS visible pixel columns
908 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000909 VIDEO_VISIBLE_ROWS visible pixel rows
910 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000911 VIDEO_DATA_FORMAT graphic data format
912 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000913 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000914 VIDEO_KBD_INIT_FCT keyboard int fct
915 (i.e. i8042_kbd_init())
916 VIDEO_TSTC_FCT test char fct
917 (i.e. i8042_tstc)
918 VIDEO_GETC_FCT get char fct
919 (i.e. i8042_getc)
920 CONFIG_CONSOLE_CURSOR cursor drawing on/off
921 (requires blink timer
922 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200923 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000924 CONFIG_CONSOLE_TIME display time/date info in
925 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500926 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000927 CONFIG_VIDEO_LOGO display Linux logo in
928 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000929 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
930 linux_logo.h for logo.
931 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000932 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200933 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000934 the logo
935
Pali Rohár33a35bb2012-10-19 13:30:09 +0000936 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
937 a limited number of ANSI escape sequences (cursor control,
938 erase functions and limited graphics rendition control).
939
wdenk43d96162003-03-06 00:02:04 +0000940 When CONFIG_CFB_CONSOLE is defined, video console is
941 default i/o. Serial console can be forced with
942 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000943
wdenkd4ca31c2004-01-02 14:00:00 +0000944 When CONFIG_SILENT_CONSOLE is defined, all console
945 messages (by U-Boot and Linux!) can be silenced with
946 the "silent" environment variable. See
947 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000948
Heiko Schocher45ae2542013-10-22 11:06:06 +0200949 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
950 is 0x00.
951 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
952 is 0xa0.
953
wdenkc6097192002-11-03 00:24:07 +0000954- Console Baudrate:
955 CONFIG_BAUDRATE - in bps
956 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200957 CONFIG_SYS_BAUDRATE_TABLE, see below.
958 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000959
Heiko Schocherc92fac92009-01-30 12:55:38 +0100960- Console Rx buffer length
961 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
962 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100963 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100964 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
965 must be defined, to setup the maximum idle timeout for
966 the SMC.
967
Graeme Russ9558b482011-09-01 00:48:27 +0000968- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200969 Prior to the console being initialised (i.e. serial UART
970 initialised etc) all console output is silently discarded.
971 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
972 buffer any console messages prior to the console being
973 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
974 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
975 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200976 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200977 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000978
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200979 'Sane' compilers will generate smaller code if
980 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000981
Sonny Rao046a37b2011-11-02 09:52:08 +0000982- Safe printf() functions
983 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
984 the printf() functions. These are defined in
985 include/vsprintf.h and include snprintf(), vsnprintf() and
986 so on. Code size increase is approximately 300-500 bytes.
987 If this option is not given then these functions will
988 silently discard their buffer size argument - this means
989 you are not getting any overflow checking in this case.
990
wdenkc6097192002-11-03 00:24:07 +0000991- Boot Delay: CONFIG_BOOTDELAY - in seconds
992 Delay before automatically booting the default image;
993 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000994 set to -2 to autoboot with no delay and not check for abort
995 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000996
997 See doc/README.autoboot for these options that
998 work with CONFIG_BOOTDELAY. None are required.
999 CONFIG_BOOT_RETRY_TIME
1000 CONFIG_BOOT_RETRY_MIN
1001 CONFIG_AUTOBOOT_KEYED
1002 CONFIG_AUTOBOOT_PROMPT
1003 CONFIG_AUTOBOOT_DELAY_STR
1004 CONFIG_AUTOBOOT_STOP_STR
1005 CONFIG_AUTOBOOT_DELAY_STR2
1006 CONFIG_AUTOBOOT_STOP_STR2
1007 CONFIG_ZERO_BOOTDELAY_CHECK
1008 CONFIG_RESET_TO_RETRY
1009
1010- Autoboot Command:
1011 CONFIG_BOOTCOMMAND
1012 Only needed when CONFIG_BOOTDELAY is enabled;
1013 define a command string that is automatically executed
1014 when no character is read on the console interface
1015 within "Boot Delay" after reset.
1016
1017 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +00001018 This can be used to pass arguments to the bootm
1019 command. The value of CONFIG_BOOTARGS goes into the
1020 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001021
1022 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +00001023 The value of these goes into the environment as
1024 "ramboot" and "nfsboot" respectively, and can be used
1025 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001026 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001027
Heiko Schochereda0ba32013-11-04 14:04:59 +01001028- Bootcount:
1029 CONFIG_BOOTCOUNT_LIMIT
1030 Implements a mechanism for detecting a repeating reboot
1031 cycle, see:
1032 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1033
1034 CONFIG_BOOTCOUNT_ENV
1035 If no softreset save registers are found on the hardware
1036 "bootcount" is stored in the environment. To prevent a
1037 saveenv on all reboots, the environment variable
1038 "upgrade_available" is used. If "upgrade_available" is
1039 0, "bootcount" is always 0, if "upgrade_available" is
1040 1 "bootcount" is incremented in the environment.
1041 So the Userspace Applikation must set the "upgrade_available"
1042 and "bootcount" variable to 0, if a boot was successfully.
1043
wdenkc6097192002-11-03 00:24:07 +00001044- Pre-Boot Commands:
1045 CONFIG_PREBOOT
1046
1047 When this option is #defined, the existence of the
1048 environment variable "preboot" will be checked
1049 immediately before starting the CONFIG_BOOTDELAY
1050 countdown and/or running the auto-boot command resp.
1051 entering interactive mode.
1052
1053 This feature is especially useful when "preboot" is
1054 automatically generated or modified. For an example
1055 see the LWMON board specific code: here "preboot" is
1056 modified when the user holds down a certain
1057 combination of keys on the (special) keyboard when
1058 booting the systems
1059
1060- Serial Download Echo Mode:
1061 CONFIG_LOADS_ECHO
1062 If defined to 1, all characters received during a
1063 serial download (using the "loads" command) are
1064 echoed back. This might be needed by some terminal
1065 emulations (like "cu"), but may as well just take
1066 time on others. This setting #define's the initial
1067 value of the "loads_echo" environment variable.
1068
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001070 CONFIG_KGDB_BAUDRATE
1071 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001073
1074- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001075 Monitor commands can be included or excluded
1076 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001077 <config_cmd_all.h> and #undef'ing unwanted
1078 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001079 and augmenting with additional #define's
1080 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001081
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001082 The default command configuration includes all commands
1083 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001084
Marek Vasutb401b732014-03-05 19:58:39 +01001085 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001086 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001087 CONFIG_CMD_BDI bdinfo
1088 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1089 CONFIG_CMD_BMP * BMP support
1090 CONFIG_CMD_BSP * Board specific commands
1091 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001092 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001093 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001094 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001095 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001096 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001097 CONFIG_CMD_DATE * support for RTC, date/time...
1098 CONFIG_CMD_DHCP * DHCP support
1099 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001100 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1101 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1102 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1103 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001104 CONFIG_CMD_DTT * Digital Therm and Thermostat
1105 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001106 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001107 CONFIG_CMD_EEPROM * EEPROM read/write support
1108 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001109 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001110 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001111 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001112 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001113 CONFIG_CMD_EXT2 * ext2 command support
1114 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001115 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1116 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001117 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001118 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001119 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001120 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001121 CONFIG_CMD_FLASH flinfo, erase, protect
1122 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001123 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001124 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001125 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001126 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001127 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001128 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1129 CONFIG_CMD_I2C * I2C serial bus support
1130 CONFIG_CMD_IDE * IDE harddisk support
1131 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001132 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001133 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001134 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001135 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001136 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001137 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001138 CONFIG_CMD_IRQ * irqinfo
1139 CONFIG_CMD_ITEST Integer/string test of 2 values
1140 CONFIG_CMD_JFFS2 * JFFS2 Support
1141 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001142 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001143 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1144 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001145 CONFIG_CMD_LOADB loadb
1146 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001147 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001148 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001149 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001150 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001151 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001152 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001153 CONFIG_CMD_MISC Misc functions like sleep etc
1154 CONFIG_CMD_MMC * MMC memory mapped support
1155 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001156 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001157 CONFIG_CMD_NAND * NAND support
1158 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001159 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001160 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001161 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001162 CONFIG_CMD_PCI * pciinfo
1163 CONFIG_CMD_PCMCIA * PCMCIA support
1164 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1165 host
1166 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001167 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001168 CONFIG_CMD_REGINFO * Register dump
1169 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001170 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001171 CONFIG_CMD_SAVES * save S record dump
1172 CONFIG_CMD_SCSI * SCSI Support
1173 CONFIG_CMD_SDRAM * print SDRAM configuration information
1174 (requires CONFIG_CMD_I2C)
1175 CONFIG_CMD_SETGETDCR Support for DCR Register access
1176 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001177 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001178 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001179 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001180 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001181 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001182 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001183 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001184 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001185 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1186 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001187 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001188 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001189 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001190 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001191 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001192
1193 EXAMPLE: If you want all functions except of network
1194 support you can write:
1195
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001196 #include "config_cmd_all.h"
1197 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001198
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001199 Other Commands:
1200 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001201
1202 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001203 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001204 what you (and your U-Boot users) are doing. Data
1205 cache cannot be enabled on systems like the 8xx or
1206 8260 (where accesses to the IMMR region must be
1207 uncached), and it cannot be disabled on all other
1208 systems where we (mis-) use the data cache to hold an
1209 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001210
1211
1212 XXX - this list needs to get updated!
1213
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001214- Regular expression support:
1215 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001216 If this variable is defined, U-Boot is linked against
1217 the SLRE (Super Light Regular Expression) library,
1218 which adds regex support to some commands, as for
1219 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001220
Simon Glass45ba8072011-10-15 05:48:20 +00001221- Device tree:
1222 CONFIG_OF_CONTROL
1223 If this variable is defined, U-Boot will use a device tree
1224 to configure its devices, instead of relying on statically
1225 compiled #defines in the board file. This option is
1226 experimental and only available on a few boards. The device
1227 tree is available in the global data as gd->fdt_blob.
1228
Simon Glass2c0f79e2011-10-24 19:15:31 +00001229 U-Boot needs to get its device tree from somewhere. This can
1230 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001231
1232 CONFIG_OF_EMBED
1233 If this variable is defined, U-Boot will embed a device tree
1234 binary in its image. This device tree file should be in the
1235 board directory and called <soc>-<board>.dts. The binary file
1236 is then picked up in board_init_f() and made available through
1237 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001238
Simon Glass2c0f79e2011-10-24 19:15:31 +00001239 CONFIG_OF_SEPARATE
1240 If this variable is defined, U-Boot will build a device tree
1241 binary. It will be called u-boot.dtb. Architecture-specific
1242 code will locate it at run-time. Generally this works by:
1243
1244 cat u-boot.bin u-boot.dtb >image.bin
1245
1246 and in fact, U-Boot does this for you, creating a file called
1247 u-boot-dtb.bin which is useful in the common case. You can
1248 still use the individual files if you need something more
1249 exotic.
1250
wdenkc6097192002-11-03 00:24:07 +00001251- Watchdog:
1252 CONFIG_WATCHDOG
1253 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001254 support for the SoC. There must be support in the SoC
1255 specific code for a watchdog. For the 8xx and 8260
1256 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1257 register. When supported for a specific SoC is
1258 available, then no further board specific code should
1259 be needed to use it.
1260
1261 CONFIG_HW_WATCHDOG
1262 When using a watchdog circuitry external to the used
1263 SoC, then define this variable and provide board
1264 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001265
stroesec1551ea2003-04-04 15:53:41 +00001266- U-Boot Version:
1267 CONFIG_VERSION_VARIABLE
1268 If this variable is defined, an environment variable
1269 named "ver" is created by U-Boot showing the U-Boot
1270 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001271 Any change to this variable will be reverted at the
1272 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001273
wdenkc6097192002-11-03 00:24:07 +00001274- Real-Time Clock:
1275
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001276 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001277 has to be selected, too. Define exactly one of the
1278 following options:
1279
1280 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1281 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001282 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001283 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001284 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001285 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001286 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001287 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001288 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001289 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001290 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001291 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001292 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1293 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkb37c7e52003-06-30 16:24:52 +00001295 Note that if the RTC uses I2C, then the I2C interface
1296 must also be configured. See I2C Support, below.
1297
Peter Tysere92739d2008-12-17 16:36:21 -06001298- GPIO Support:
1299 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001300
Chris Packham5dec49c2010-12-19 10:12:13 +00001301 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1302 chip-ngpio pairs that tell the PCA953X driver the number of
1303 pins supported by a particular chip.
1304
Peter Tysere92739d2008-12-17 16:36:21 -06001305 Note that if the GPIO device uses I2C, then the I2C interface
1306 must also be configured. See I2C Support, below.
1307
Simon Glassaa532332014-06-11 23:29:41 -06001308- I/O tracing:
1309 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1310 accesses and can checksum them or write a list of them out
1311 to memory. See the 'iotrace' command for details. This is
1312 useful for testing device drivers since it can confirm that
1313 the driver behaves the same way before and after a code
1314 change. Currently this is supported on sandbox and arm. To
1315 add support for your architecture, add '#include <iotrace.h>'
1316 to the bottom of arch/<arch>/include/asm/io.h and test.
1317
1318 Example output from the 'iotrace stats' command is below.
1319 Note that if the trace buffer is exhausted, the checksum will
1320 still continue to operate.
1321
1322 iotrace is enabled
1323 Start: 10000000 (buffer start address)
1324 Size: 00010000 (buffer size)
1325 Offset: 00000120 (current buffer offset)
1326 Output: 10000120 (start + offset)
1327 Count: 00000018 (number of trace records)
1328 CRC32: 9526fb66 (CRC32 of all trace records)
1329
wdenkc6097192002-11-03 00:24:07 +00001330- Timestamp Support:
1331
wdenk43d96162003-03-06 00:02:04 +00001332 When CONFIG_TIMESTAMP is selected, the timestamp
1333 (date and time) of an image is printed by image
1334 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001335 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001336
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001337- Partition Labels (disklabels) Supported:
1338 Zero or more of the following:
1339 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1340 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1341 Intel architecture, USB sticks, etc.
1342 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1343 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1344 bootloader. Note 2TB partition limit; see
1345 disk/part_efi.c
1346 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001347
Wolfgang Denk218ca722008-03-26 10:40:12 +01001348 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1349 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001350 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001351
1352- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001353 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1354 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001355
wdenk4d13cba2004-03-14 14:09:05 +00001356 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1357 be performed by calling the function
1358 ide_set_reset(int reset)
1359 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001360
1361- ATAPI Support:
1362 CONFIG_ATAPI
1363
1364 Set this to enable ATAPI support.
1365
wdenkc40b2952004-03-13 23:29:43 +00001366- LBA48 Support
1367 CONFIG_LBA48
1368
1369 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001370 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001371 Whithout these , LBA48 support uses 32bit variables and will 'only'
1372 support disks up to 2.1TB.
1373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001374 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001375 When enabled, makes the IDE subsystem use 64bit sector addresses.
1376 Default is 32bit.
1377
wdenkc6097192002-11-03 00:24:07 +00001378- SCSI Support:
1379 At the moment only there is only support for the
1380 SYM53C8XX SCSI controller; define
1381 CONFIG_SCSI_SYM53C8XX to enable it.
1382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001383 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1384 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1385 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001386 maximum numbers of LUNs, SCSI ID's and target
1387 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001388 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001389
Wolfgang Denk93e14592013-10-04 17:43:24 +02001390 The environment variable 'scsidevs' is set to the number of
1391 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001392
wdenkc6097192002-11-03 00:24:07 +00001393- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001394 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001395 Support for Intel 8254x/8257x gigabit chips.
1396
1397 CONFIG_E1000_SPI
1398 Utility code for direct access to the SPI bus on Intel 8257x.
1399 This does not do anything useful unless you set at least one
1400 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1401
1402 CONFIG_E1000_SPI_GENERIC
1403 Allow generic access to the SPI bus on the Intel 8257x, for
1404 example with the "sspi" command.
1405
1406 CONFIG_CMD_E1000
1407 Management command for E1000 devices. When used on devices
1408 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001409
Andre Schwarzac3315c2008-03-06 16:45:44 +01001410 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001411 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001412
wdenkc6097192002-11-03 00:24:07 +00001413 CONFIG_EEPRO100
1414 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001415 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001416 write routine for first time initialisation.
1417
1418 CONFIG_TULIP
1419 Support for Digital 2114x chips.
1420 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1421 modem chip initialisation (KS8761/QS6611).
1422
1423 CONFIG_NATSEMI
1424 Support for National dp83815 chips.
1425
1426 CONFIG_NS8382X
1427 Support for National dp8382[01] gigabit chips.
1428
wdenk45219c42003-05-12 21:50:16 +00001429- NETWORK Support (other):
1430
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001431 CONFIG_DRIVER_AT91EMAC
1432 Support for AT91RM9200 EMAC.
1433
1434 CONFIG_RMII
1435 Define this to use reduced MII inteface
1436
1437 CONFIG_DRIVER_AT91EMAC_QUIET
1438 If this defined, the driver is quiet.
1439 The driver doen't show link status messages.
1440
Rob Herringefdd7312011-12-15 11:15:49 +00001441 CONFIG_CALXEDA_XGMAC
1442 Support for the Calxeda XGMAC device
1443
Ashok3bb46d22012-10-15 06:20:47 +00001444 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001445 Support for SMSC's LAN91C96 chips.
1446
1447 CONFIG_LAN91C96_BASE
1448 Define this to hold the physical address
1449 of the LAN91C96's I/O space
1450
1451 CONFIG_LAN91C96_USE_32_BIT
1452 Define this to enable 32 bit addressing
1453
Ashok3bb46d22012-10-15 06:20:47 +00001454 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001455 Support for SMSC's LAN91C111 chip
1456
1457 CONFIG_SMC91111_BASE
1458 Define this to hold the physical address
1459 of the device (I/O space)
1460
1461 CONFIG_SMC_USE_32_BIT
1462 Define this if data bus is 32 bits
1463
1464 CONFIG_SMC_USE_IOFUNCS
1465 Define this to use i/o functions instead of macros
1466 (some hardware wont work with macros)
1467
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001468 CONFIG_DRIVER_TI_EMAC
1469 Support for davinci emac
1470
1471 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1472 Define this if you have more then 3 PHYs.
1473
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001474 CONFIG_FTGMAC100
1475 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1476
1477 CONFIG_FTGMAC100_EGIGA
1478 Define this to use GE link update with gigabit PHY.
1479 Define this if FTGMAC100 is connected to gigabit PHY.
1480 If your system has 10/100 PHY only, it might not occur
1481 wrong behavior. Because PHY usually return timeout or
1482 useless data when polling gigabit status and gigabit
1483 control registers. This behavior won't affect the
1484 correctnessof 10/100 link speed update.
1485
Mike Rapoportc2fff332009-11-11 10:03:03 +02001486 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001487 Support for SMSC's LAN911x and LAN921x chips
1488
Mike Rapoportc2fff332009-11-11 10:03:03 +02001489 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001490 Define this to hold the physical address
1491 of the device (I/O space)
1492
Mike Rapoportc2fff332009-11-11 10:03:03 +02001493 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001494 Define this if data bus is 32 bits
1495
Mike Rapoportc2fff332009-11-11 10:03:03 +02001496 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001497 Define this if data bus is 16 bits. If your processor
1498 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001499 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001500
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001501 CONFIG_SH_ETHER
1502 Support for Renesas on-chip Ethernet controller
1503
1504 CONFIG_SH_ETHER_USE_PORT
1505 Define the number of ports to be used
1506
1507 CONFIG_SH_ETHER_PHY_ADDR
1508 Define the ETH PHY's address
1509
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001510 CONFIG_SH_ETHER_CACHE_WRITEBACK
1511 If this option is set, the driver enables cache flush.
1512
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001513- PWM Support:
1514 CONFIG_PWM_IMX
1515 Support for PWM modul on the imx6.
1516
Vadim Bendebury5e124722011-10-17 08:36:14 +00001517- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001518 CONFIG_TPM
1519 Support TPM devices.
1520
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001521 CONFIG_TPM_TIS_I2C
1522 Support for i2c bus TPM devices. Only one device
1523 per system is supported at this time.
1524
1525 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1526 Define the the i2c bus number for the TPM device
1527
1528 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1529 Define the TPM's address on the i2c bus
1530
1531 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1532 Define the burst count bytes upper limit
1533
Dirk Eibachc01939c2013-06-26 15:55:15 +02001534 CONFIG_TPM_ATMEL_TWI
1535 Support for Atmel TWI TPM device. Requires I2C support.
1536
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001537 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001538 Support for generic parallel port TPM devices. Only one device
1539 per system is supported at this time.
1540
1541 CONFIG_TPM_TIS_BASE_ADDRESS
1542 Base address where the generic TPM device is mapped
1543 to. Contemporary x86 systems usually map it at
1544 0xfed40000.
1545
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001546 CONFIG_CMD_TPM
1547 Add tpm monitor functions.
1548 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1549 provides monitor access to authorized functions.
1550
1551 CONFIG_TPM
1552 Define this to enable the TPM support library which provides
1553 functional interfaces to some TPM commands.
1554 Requires support for a TPM device.
1555
1556 CONFIG_TPM_AUTH_SESSIONS
1557 Define this to enable authorized functions in the TPM library.
1558 Requires CONFIG_TPM and CONFIG_SHA1.
1559
wdenkc6097192002-11-03 00:24:07 +00001560- USB Support:
1561 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001562 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001563 CONFIG_USB_UHCI to enable it.
1564 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001565 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001566 storage devices.
1567 Note:
1568 Supported are USB Keyboards and USB Floppy drives
1569 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001570 MPC5200 USB requires additional defines:
1571 CONFIG_USB_CLOCK
1572 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001573 CONFIG_PSC3_USB
1574 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001575 CONFIG_USB_CONFIG
1576 for differential drivers: 0x00001000
1577 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001578 for differential drivers on PSC3: 0x00000100
1579 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001580 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001581 May be defined to allow interrupt polling
1582 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001583
Simon Glass9ab4ce22012-02-27 10:52:47 +00001584 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1585 txfilltuning field in the EHCI controller on reset.
1586
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001587 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1588 HW module registers.
1589
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001590- USB Device:
1591 Define the below if you wish to use the USB console.
1592 Once firmware is rebuilt from a serial console issue the
1593 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001594 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001595 it has found a new device. The environment variable usbtty
1596 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001597 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001598 Common Device Class Abstract Control Model serial device.
1599 If you select usbtty = gserial you should be able to enumerate
1600 a Linux host by
1601 # modprobe usbserial vendor=0xVendorID product=0xProductID
1602 else if using cdc_acm, simply setting the environment
1603 variable usbtty to be cdc_acm should suffice. The following
1604 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001605
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001606 CONFIG_USB_DEVICE
1607 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001608
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001609 CONFIG_USB_TTY
1610 Define this to have a tty type of device available to
1611 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001612
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301613 CONFIG_USBD_HS
1614 Define this to enable the high speed support for usb
1615 device and usbtty. If this feature is enabled, a routine
1616 int is_usbd_high_speed(void)
1617 also needs to be defined by the driver to dynamically poll
1618 whether the enumeration has succeded at high speed or full
1619 speed.
1620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001621 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001622 Define this if you want stdin, stdout &/or stderr to
1623 be set to usbtty.
1624
1625 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001627 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001628 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001630 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001631 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001632 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001633
Wolfgang Denk386eda02006-06-14 18:14:56 +02001634 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001635 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001636 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001637 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1638 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1639 should pretend to be a Linux device to it's target host.
1640
1641 CONFIG_USBD_MANUFACTURER
1642 Define this string as the name of your company for
1643 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001644
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001645 CONFIG_USBD_PRODUCT_NAME
1646 Define this string as the name of your product
1647 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1648
1649 CONFIG_USBD_VENDORID
1650 Define this as your assigned Vendor ID from the USB
1651 Implementors Forum. This *must* be a genuine Vendor ID
1652 to avoid polluting the USB namespace.
1653 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001654
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001655 CONFIG_USBD_PRODUCTID
1656 Define this as the unique Product ID
1657 for your device
1658 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001659
Igor Grinbergd70a5602011-12-12 12:08:35 +02001660- ULPI Layer Support:
1661 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1662 the generic ULPI layer. The generic layer accesses the ULPI PHY
1663 via the platform viewport, so you need both the genric layer and
1664 the viewport enabled. Currently only Chipidea/ARC based
1665 viewport is supported.
1666 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1667 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001668 If your ULPI phy needs a different reference clock than the
1669 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1670 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001671
1672- MMC Support:
1673 The MMC controller on the Intel PXA is supported. To
1674 enable this define CONFIG_MMC. The MMC can be
1675 accessed from the boot prompt by mapping the device
1676 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001677 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1678 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001679
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001680 CONFIG_SH_MMCIF
1681 Support for Renesas on-chip MMCIF controller
1682
1683 CONFIG_SH_MMCIF_ADDR
1684 Define the base address of MMCIF registers
1685
1686 CONFIG_SH_MMCIF_CLK
1687 Define the clock frequency for MMCIF
1688
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001689 CONFIG_GENERIC_MMC
1690 Enable the generic MMC driver
1691
1692 CONFIG_SUPPORT_EMMC_BOOT
1693 Enable some additional features of the eMMC boot partitions.
1694
1695 CONFIG_SUPPORT_EMMC_RPMB
1696 Enable the commands for reading, writing and programming the
1697 key for the Replay Protection Memory Block partition in eMMC.
1698
Tom Rinib3ba6e92013-03-14 05:32:47 +00001699- USB Device Firmware Update (DFU) class support:
1700 CONFIG_DFU_FUNCTION
1701 This enables the USB portion of the DFU USB class
1702
1703 CONFIG_CMD_DFU
1704 This enables the command "dfu" which is used to have
1705 U-Boot create a DFU class device via USB. This command
1706 requires that the "dfu_alt_info" environment variable be
1707 set and define the alt settings to expose to the host.
1708
1709 CONFIG_DFU_MMC
1710 This enables support for exposing (e)MMC devices via DFU.
1711
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001712 CONFIG_DFU_NAND
1713 This enables support for exposing NAND devices via DFU.
1714
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301715 CONFIG_DFU_RAM
1716 This enables support for exposing RAM via DFU.
1717 Note: DFU spec refer to non-volatile memory usage, but
1718 allow usages beyond the scope of spec - here RAM usage,
1719 one that would help mostly the developer.
1720
Heiko Schochere7e75c72013-06-12 06:05:51 +02001721 CONFIG_SYS_DFU_DATA_BUF_SIZE
1722 Dfu transfer uses a buffer before writing data to the
1723 raw storage device. Make the size (in bytes) of this buffer
1724 configurable. The size of this buffer is also configurable
1725 through the "dfu_bufsiz" environment variable.
1726
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001727 CONFIG_SYS_DFU_MAX_FILE_SIZE
1728 When updating files rather than the raw storage device,
1729 we use a static buffer to copy the file into and then write
1730 the buffer once we've been given the whole file. Define
1731 this to the maximum filesize (in bytes) for the buffer.
1732 Default is 4 MiB if undefined.
1733
Heiko Schocher001a8312014-03-18 08:09:56 +01001734 DFU_DEFAULT_POLL_TIMEOUT
1735 Poll timeout [ms], is the timeout a device can send to the
1736 host. The host must wait for this timeout before sending
1737 a subsequent DFU_GET_STATUS request to the device.
1738
1739 DFU_MANIFEST_POLL_TIMEOUT
1740 Poll timeout [ms], which the device sends to the host when
1741 entering dfuMANIFEST state. Host waits this timeout, before
1742 sending again an USB request to the device.
1743
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001744- USB Device Android Fastboot support:
1745 CONFIG_CMD_FASTBOOT
1746 This enables the command "fastboot" which enables the Android
1747 fastboot mode for the platform's USB device. Fastboot is a USB
1748 protocol for downloading images, flashing and device control
1749 used on Android devices.
1750 See doc/README.android-fastboot for more information.
1751
1752 CONFIG_ANDROID_BOOT_IMAGE
1753 This enables support for booting images which use the Android
1754 image format header.
1755
1756 CONFIG_USB_FASTBOOT_BUF_ADDR
1757 The fastboot protocol requires a large memory buffer for
1758 downloads. Define this to the starting RAM address to use for
1759 downloaded images.
1760
1761 CONFIG_USB_FASTBOOT_BUF_SIZE
1762 The fastboot protocol requires a large memory buffer for
1763 downloads. This buffer should be as large as possible for a
1764 platform. Define this to the size available RAM for fastboot.
1765
Steve Raed1b5ed02014-08-26 11:47:28 -07001766 CONFIG_FASTBOOT_FLASH
1767 The fastboot protocol includes a "flash" command for writing
1768 the downloaded image to a non-volatile storage device. Define
1769 this to enable the "fastboot flash" command.
1770
1771 CONFIG_FASTBOOT_FLASH_MMC_DEV
1772 The fastboot "flash" command requires additional information
1773 regarding the non-volatile storage device. Define this to
1774 the eMMC device that fastboot should use to store the image.
1775
wdenk6705d812004-08-02 23:22:59 +00001776- Journaling Flash filesystem support:
1777 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1778 CONFIG_JFFS2_NAND_DEV
1779 Define these for a default partition on a NAND device
1780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001781 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1782 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001783 Define these for a default partition on a NOR device
1784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001785 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001786 Define this to create an own partition. You have to provide a
1787 function struct part_info* jffs2_part_info(int part_num)
1788
1789 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001790 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001791 to disable the command chpart. This is the default when you
1792 have not defined a custom partition
1793
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001794- FAT(File Allocation Table) filesystem write function support:
1795 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001796
1797 Define this to enable support for saving memory data as a
1798 file in FAT formatted partition.
1799
1800 This will also enable the command "fatwrite" enabling the
1801 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001802
Gabe Black84cd9322012-10-12 14:26:11 +00001803CBFS (Coreboot Filesystem) support
1804 CONFIG_CMD_CBFS
1805
1806 Define this to enable support for reading from a Coreboot
1807 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1808 and cbfsload.
1809
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301810- FAT(File Allocation Table) filesystem cluster size:
1811 CONFIG_FS_FAT_MAX_CLUSTSIZE
1812
1813 Define the max cluster size for fat operations else
1814 a default value of 65536 will be defined.
1815
wdenkc6097192002-11-03 00:24:07 +00001816- Keyboard Support:
1817 CONFIG_ISA_KEYBOARD
1818
1819 Define this to enable standard (PC-Style) keyboard
1820 support
1821
1822 CONFIG_I8042_KBD
1823 Standard PC keyboard driver with US (is default) and
1824 GERMAN key layout (switch via environment 'keymap=de') support.
1825 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1826 for cfb_console. Supports cursor blinking.
1827
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001828 CONFIG_CROS_EC_KEYB
1829 Enables a Chrome OS keyboard using the CROS_EC interface.
1830 This uses CROS_EC to communicate with a second microcontroller
1831 which provides key scans on request.
1832
wdenkc6097192002-11-03 00:24:07 +00001833- Video support:
1834 CONFIG_VIDEO
1835
1836 Define this to enable video support (for output to
1837 video).
1838
1839 CONFIG_VIDEO_CT69000
1840
1841 Enable Chips & Technologies 69000 Video chip
1842
1843 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001844 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001845 video output is selected via environment 'videoout'
1846 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1847 assumed.
wdenkc6097192002-11-03 00:24:07 +00001848
wdenkb79a11c2004-03-25 15:14:43 +00001849 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001850 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001851 are possible:
1852 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001853 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001854
1855 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1856 -------------+---------------------------------------------
1857 8 bits | 0x301* 0x303 0x305 0x161 0x307
1858 15 bits | 0x310 0x313 0x316 0x162 0x319
1859 16 bits | 0x311 0x314 0x317 0x163 0x31A
1860 24 bits | 0x312 0x315 0x318 ? 0x31B
1861 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001862 (i.e. setenv videomode 317; saveenv; reset;)
1863
wdenkb79a11c2004-03-25 15:14:43 +00001864 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001865 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001866
1867
stroesec1551ea2003-04-04 15:53:41 +00001868 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001869 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001870 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1871 or CONFIG_VIDEO_SED13806_16BPP
1872
Timur Tabi7d3053f2011-02-15 17:09:19 -06001873 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001874 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001875 SOCs that have a DIU should define this macro to enable DIU
1876 support, and should also define these other macros:
1877
1878 CONFIG_SYS_DIU_ADDR
1879 CONFIG_VIDEO
1880 CONFIG_CMD_BMP
1881 CONFIG_CFB_CONSOLE
1882 CONFIG_VIDEO_SW_CURSOR
1883 CONFIG_VGA_AS_SINGLE_DEVICE
1884 CONFIG_VIDEO_LOGO
1885 CONFIG_VIDEO_BMP_LOGO
1886
Timur Tabiba8e76b2011-04-11 14:18:22 -05001887 The DIU driver will look for the 'video-mode' environment
1888 variable, and if defined, enable the DIU as a console during
1889 boot. See the documentation file README.video for a
1890 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001891
Simon Glass058d59b2012-12-03 13:59:47 +00001892 CONFIG_VIDEO_VGA
1893
1894 Enable the VGA video / BIOS for x86. The alternative if you
1895 are using coreboot is to use the coreboot frame buffer
1896 driver.
1897
1898
wdenk682011f2003-06-03 23:54:09 +00001899- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001900 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001901
wdenk8bde7f72003-06-27 21:31:46 +00001902 Define this to enable a custom keyboard support.
1903 This simply calls drv_keyboard_init() which must be
1904 defined in your board-specific files.
1905 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001906
wdenkc6097192002-11-03 00:24:07 +00001907- LCD Support: CONFIG_LCD
1908
1909 Define this to enable LCD support (for output to LCD
1910 display); also select one of the supported displays
1911 by defining one of these:
1912
Stelian Pop39cf4802008-05-09 21:57:18 +02001913 CONFIG_ATMEL_LCD:
1914
1915 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1916
wdenkfd3103b2003-11-25 16:55:19 +00001917 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001918
wdenkfd3103b2003-11-25 16:55:19 +00001919 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001920
wdenkfd3103b2003-11-25 16:55:19 +00001921 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001922
wdenkfd3103b2003-11-25 16:55:19 +00001923 NEC NL6448BC20-08. 6.5", 640x480.
1924 Active, color, single scan.
1925
1926 CONFIG_NEC_NL6448BC33_54
1927
1928 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001929 Active, color, single scan.
1930
1931 CONFIG_SHARP_16x9
1932
1933 Sharp 320x240. Active, color, single scan.
1934 It isn't 16x9, and I am not sure what it is.
1935
1936 CONFIG_SHARP_LQ64D341
1937
1938 Sharp LQ64D341 display, 640x480.
1939 Active, color, single scan.
1940
1941 CONFIG_HLD1045
1942
1943 HLD1045 display, 640x480.
1944 Active, color, single scan.
1945
1946 CONFIG_OPTREX_BW
1947
1948 Optrex CBL50840-2 NF-FW 99 22 M5
1949 or
1950 Hitachi LMG6912RPFC-00T
1951 or
1952 Hitachi SP14Q002
1953
1954 320x240. Black & white.
1955
1956 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001957 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001958
Simon Glass676d3192012-10-17 13:24:54 +00001959 CONFIG_LCD_ALIGNMENT
1960
1961 Normally the LCD is page-aligned (tyically 4KB). If this is
1962 defined then the LCD will be aligned to this value instead.
1963 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1964 here, since it is cheaper to change data cache settings on
1965 a per-section basis.
1966
Simon Glass0d89efe2012-10-17 13:24:59 +00001967 CONFIG_CONSOLE_SCROLL_LINES
1968
1969 When the console need to be scrolled, this is the number of
1970 lines to scroll by. It defaults to 1. Increasing this makes
1971 the console jump but can help speed up operation when scrolling
1972 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001973
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001974 CONFIG_LCD_BMP_RLE8
1975
1976 Support drawing of RLE8-compressed bitmaps on the LCD.
1977
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001978 CONFIG_I2C_EDID
1979
1980 Enables an 'i2c edid' command which can read EDID
1981 information over I2C from an attached LCD display.
1982
wdenk7152b1d2003-09-05 23:19:14 +00001983- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001984
wdenk8bde7f72003-06-27 21:31:46 +00001985 If this option is set, the environment is checked for
1986 a variable "splashimage". If found, the usual display
1987 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001988 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001989 specified in "splashimage" is loaded instead. The
1990 console is redirected to the "nulldev", too. This
1991 allows for a "silent" boot where a splash screen is
1992 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001993
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001994 CONFIG_SPLASHIMAGE_GUARD
1995
1996 If this option is set, then U-Boot will prevent the environment
1997 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001998 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001999 This option is useful for targets where, due to alignment
2000 restrictions, an improperly aligned BMP image will cause a data
2001 abort. If you think you will not have problems with unaligned
2002 accesses (for example because your toolchain prevents them)
2003 there is no need to set this option.
2004
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002005 CONFIG_SPLASH_SCREEN_ALIGN
2006
2007 If this option is set the splash image can be freely positioned
2008 on the screen. Environment variable "splashpos" specifies the
2009 position as "x,y". If a positive number is given it is used as
2010 number of pixel from left/top. If a negative number is given it
2011 is used as number of pixel from right/bottom. You can also
2012 specify 'm' for centering the image.
2013
2014 Example:
2015 setenv splashpos m,m
2016 => image at center of screen
2017
2018 setenv splashpos 30,20
2019 => image at x = 30 and y = 20
2020
2021 setenv splashpos -10,m
2022 => vertically centered image
2023 at x = dspWidth - bmpWidth - 9
2024
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002025- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2026
2027 If this option is set, additionally to standard BMP
2028 images, gzipped BMP images can be displayed via the
2029 splashscreen support or the bmp command.
2030
Anatolij Gustschind5011762010-03-15 14:50:25 +01002031- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2032
2033 If this option is set, 8-bit RLE compressed BMP images
2034 can be displayed via the splashscreen support or the
2035 bmp command.
2036
Lei Wenf2b96df2012-09-28 04:26:47 +00002037- Do compresssing for memory range:
2038 CONFIG_CMD_ZIP
2039
2040 If this option is set, it would use zlib deflate method
2041 to compress the specified memory at its best effort.
2042
wdenkc29fdfc2003-08-29 20:57:53 +00002043- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002044 CONFIG_GZIP
2045
2046 Enabled by default to support gzip compressed images.
2047
wdenkc29fdfc2003-08-29 20:57:53 +00002048 CONFIG_BZIP2
2049
2050 If this option is set, support for bzip2 compressed
2051 images is included. If not, only uncompressed and gzip
2052 compressed images are supported.
2053
wdenk42d1f032003-10-15 23:53:47 +00002054 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002055 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002056 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002057
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002058 CONFIG_LZMA
2059
2060 If this option is set, support for lzma compressed
2061 images is included.
2062
2063 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2064 requires an amount of dynamic memory that is given by the
2065 formula:
2066
2067 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2068
2069 Where lc and lp stand for, respectively, Literal context bits
2070 and Literal pos bits.
2071
2072 This value is upper-bounded by 14MB in the worst case. Anyway,
2073 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2074 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2075 a very small buffer.
2076
2077 Use the lzmainfo tool to determinate the lc and lp values and
2078 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002079 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002080
Kees Cook8ef70472013-08-16 07:59:12 -07002081 CONFIG_LZO
2082
2083 If this option is set, support for LZO compressed images
2084 is included.
2085
wdenk17ea1172004-06-06 21:51:03 +00002086- MII/PHY support:
2087 CONFIG_PHY_ADDR
2088
2089 The address of PHY on MII bus.
2090
2091 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2092
2093 The clock frequency of the MII bus
2094
2095 CONFIG_PHY_GIGE
2096
2097 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002098 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002099
2100 CONFIG_PHY_RESET_DELAY
2101
2102 Some PHY like Intel LXT971A need extra delay after
2103 reset before any MII register access is possible.
2104 For such PHY, set this option to the usec delay
2105 required. (minimum 300usec for LXT971A)
2106
2107 CONFIG_PHY_CMD_DELAY (ppc4xx)
2108
2109 Some PHY like Intel LXT971A need extra delay after
2110 command issued before MII status register can be read
2111
wdenkc6097192002-11-03 00:24:07 +00002112- Ethernet address:
2113 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002114 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002115 CONFIG_ETH2ADDR
2116 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002117 CONFIG_ETH4ADDR
2118 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002119
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002120 Define a default value for Ethernet address to use
2121 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002122 is not determined automatically.
2123
2124- IP address:
2125 CONFIG_IPADDR
2126
2127 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002128 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002129 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002130 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002131
2132- Server IP address:
2133 CONFIG_SERVERIP
2134
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002135 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002136 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002137 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002138
Robin Getz97cfe862009-07-21 12:15:28 -04002139 CONFIG_KEEP_SERVERADDR
2140
2141 Keeps the server's MAC address, in the env 'serveraddr'
2142 for passing to bootargs (like Linux's netconsole option)
2143
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002144- Gateway IP address:
2145 CONFIG_GATEWAYIP
2146
2147 Defines a default value for the IP address of the
2148 default router where packets to other networks are
2149 sent to.
2150 (Environment variable "gatewayip")
2151
2152- Subnet mask:
2153 CONFIG_NETMASK
2154
2155 Defines a default value for the subnet mask (or
2156 routing prefix) which is used to determine if an IP
2157 address belongs to the local subnet or needs to be
2158 forwarded through a router.
2159 (Environment variable "netmask")
2160
David Updegraff53a5c422007-06-11 10:41:07 -05002161- Multicast TFTP Mode:
2162 CONFIG_MCAST_TFTP
2163
2164 Defines whether you want to support multicast TFTP as per
2165 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002166 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002167 driver in use must provide a function: mcast() to join/leave a
2168 multicast group.
2169
wdenkc6097192002-11-03 00:24:07 +00002170- BOOTP Recovery Mode:
2171 CONFIG_BOOTP_RANDOM_DELAY
2172
2173 If you have many targets in a network that try to
2174 boot using BOOTP, you may want to avoid that all
2175 systems send out BOOTP requests at precisely the same
2176 moment (which would happen for instance at recovery
2177 from a power failure, when all systems will try to
2178 boot, thus flooding the BOOTP server. Defining
2179 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2180 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002181 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002182
2183 1st BOOTP request: delay 0 ... 1 sec
2184 2nd BOOTP request: delay 0 ... 2 sec
2185 3rd BOOTP request: delay 0 ... 4 sec
2186 4th and following
2187 BOOTP requests: delay 0 ... 8 sec
2188
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002189 CONFIG_BOOTP_ID_CACHE_SIZE
2190
2191 BOOTP packets are uniquely identified using a 32-bit ID. The
2192 server will copy the ID from client requests to responses and
2193 U-Boot will use this to determine if it is the destination of
2194 an incoming response. Some servers will check that addresses
2195 aren't in use before handing them out (usually using an ARP
2196 ping) and therefore take up to a few hundred milliseconds to
2197 respond. Network congestion may also influence the time it
2198 takes for a response to make it back to the client. If that
2199 time is too long, U-Boot will retransmit requests. In order
2200 to allow earlier responses to still be accepted after these
2201 retransmissions, U-Boot's BOOTP client keeps a small cache of
2202 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2203 cache. The default is to keep IDs for up to four outstanding
2204 requests. Increasing this will allow U-Boot to accept offers
2205 from a BOOTP client in networks with unusually high latency.
2206
stroesefe389a82003-08-28 14:17:32 +00002207- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002208 You can fine tune the DHCP functionality by defining
2209 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002210
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002211 CONFIG_BOOTP_SUBNETMASK
2212 CONFIG_BOOTP_GATEWAY
2213 CONFIG_BOOTP_HOSTNAME
2214 CONFIG_BOOTP_NISDOMAIN
2215 CONFIG_BOOTP_BOOTPATH
2216 CONFIG_BOOTP_BOOTFILESIZE
2217 CONFIG_BOOTP_DNS
2218 CONFIG_BOOTP_DNS2
2219 CONFIG_BOOTP_SEND_HOSTNAME
2220 CONFIG_BOOTP_NTPSERVER
2221 CONFIG_BOOTP_TIMEOFFSET
2222 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002223 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002224
Wilson Callan5d110f02007-07-28 10:56:13 -04002225 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2226 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002227
Joe Hershberger2c00e092012-05-23 07:59:19 +00002228 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2229 after the configured retry count, the call will fail
2230 instead of starting over. This can be used to fail over
2231 to Link-local IP address configuration if the DHCP server
2232 is not available.
2233
stroesefe389a82003-08-28 14:17:32 +00002234 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2235 serverip from a DHCP server, it is possible that more
2236 than one DNS serverip is offered to the client.
2237 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2238 serverip will be stored in the additional environment
2239 variable "dnsip2". The first DNS serverip is always
2240 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002241 is defined.
stroesefe389a82003-08-28 14:17:32 +00002242
2243 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2244 to do a dynamic update of a DNS server. To do this, they
2245 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002246 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002247 of the "hostname" environment variable is passed as
2248 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002249
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002250 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2251
2252 A 32bit value in microseconds for a delay between
2253 receiving a "DHCP Offer" and sending the "DHCP Request".
2254 This fixes a problem with certain DHCP servers that don't
2255 respond 100% of the time to a "DHCP request". E.g. On an
2256 AT91RM9200 processor running at 180MHz, this delay needed
2257 to be *at least* 15,000 usec before a Windows Server 2003
2258 DHCP server would reply 100% of the time. I recommend at
2259 least 50,000 usec to be safe. The alternative is to hope
2260 that one of the retries will be successful but note that
2261 the DHCP timeout and retry process takes a longer than
2262 this delay.
2263
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002264 - Link-local IP address negotiation:
2265 Negotiate with other link-local clients on the local network
2266 for an address that doesn't require explicit configuration.
2267 This is especially useful if a DHCP server cannot be guaranteed
2268 to exist in all environments that the device must operate.
2269
2270 See doc/README.link-local for more information.
2271
wdenka3d991b2004-04-15 21:48:45 +00002272 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002273 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002274
2275 The device id used in CDP trigger frames.
2276
2277 CONFIG_CDP_DEVICE_ID_PREFIX
2278
2279 A two character string which is prefixed to the MAC address
2280 of the device.
2281
2282 CONFIG_CDP_PORT_ID
2283
2284 A printf format string which contains the ascii name of
2285 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002286 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002287
2288 CONFIG_CDP_CAPABILITIES
2289
2290 A 32bit integer which indicates the device capabilities;
2291 0x00000010 for a normal host which does not forwards.
2292
2293 CONFIG_CDP_VERSION
2294
2295 An ascii string containing the version of the software.
2296
2297 CONFIG_CDP_PLATFORM
2298
2299 An ascii string containing the name of the platform.
2300
2301 CONFIG_CDP_TRIGGER
2302
2303 A 32bit integer sent on the trigger.
2304
2305 CONFIG_CDP_POWER_CONSUMPTION
2306
2307 A 16bit integer containing the power consumption of the
2308 device in .1 of milliwatts.
2309
2310 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2311
2312 A byte containing the id of the VLAN.
2313
wdenkc6097192002-11-03 00:24:07 +00002314- Status LED: CONFIG_STATUS_LED
2315
2316 Several configurations allow to display the current
2317 status using a LED. For instance, the LED will blink
2318 fast while running U-Boot code, stop blinking as
2319 soon as a reply to a BOOTP request was received, and
2320 start blinking slow once the Linux kernel is running
2321 (supported by a status LED driver in the Linux
2322 kernel). Defining CONFIG_STATUS_LED enables this
2323 feature in U-Boot.
2324
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002325 Additional options:
2326
2327 CONFIG_GPIO_LED
2328 The status LED can be connected to a GPIO pin.
2329 In such cases, the gpio_led driver can be used as a
2330 status LED backend implementation. Define CONFIG_GPIO_LED
2331 to include the gpio_led driver in the U-Boot binary.
2332
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002333 CONFIG_GPIO_LED_INVERTED_TABLE
2334 Some GPIO connected LEDs may have inverted polarity in which
2335 case the GPIO high value corresponds to LED off state and
2336 GPIO low value corresponds to LED on state.
2337 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2338 with a list of GPIO LEDs that have inverted polarity.
2339
wdenkc6097192002-11-03 00:24:07 +00002340- CAN Support: CONFIG_CAN_DRIVER
2341
2342 Defining CONFIG_CAN_DRIVER enables CAN driver support
2343 on those systems that support this (optional)
2344 feature, like the TQM8xxL modules.
2345
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002346- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002347
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002348 This enable the NEW i2c subsystem, and will allow you to use
2349 i2c commands at the u-boot command line (as long as you set
2350 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2351 based realtime clock chips or other i2c devices. See
2352 common/cmd_i2c.c for a description of the command line
2353 interface.
2354
2355 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002356 - drivers/i2c/soft_i2c.c:
2357 - activate first bus with CONFIG_SYS_I2C_SOFT define
2358 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2359 for defining speed and slave address
2360 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2361 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2362 for defining speed and slave address
2363 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2364 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2365 for defining speed and slave address
2366 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2367 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2368 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002369
Heiko Schocher00f792e2012-10-24 13:48:22 +02002370 - drivers/i2c/fsl_i2c.c:
2371 - activate i2c driver with CONFIG_SYS_I2C_FSL
2372 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2373 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2374 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2375 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002376 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002377 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2378 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2379 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2380 second bus.
2381
Simon Glass1f2ba722012-10-30 07:28:53 +00002382 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002383 - activate this driver with CONFIG_SYS_I2C_TEGRA
2384 - This driver adds 4 i2c buses with a fix speed from
2385 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002386
Dirk Eibach880540d2013-04-25 02:40:01 +00002387 - drivers/i2c/ppc4xx_i2c.c
2388 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2389 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2390 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2391
tremfac96402013-09-21 18:13:35 +02002392 - drivers/i2c/i2c_mxc.c
2393 - activate this driver with CONFIG_SYS_I2C_MXC
2394 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2395 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2396 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2397 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2398 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2399 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2400 If thoses defines are not set, default value is 100000
2401 for speed, and 0 for slave.
2402
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002403 - drivers/i2c/rcar_i2c.c:
2404 - activate this driver with CONFIG_SYS_I2C_RCAR
2405 - This driver adds 4 i2c buses
2406
2407 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2408 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2409 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2410 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2411 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2412 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2413 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2414 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2415 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2416
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002417 - drivers/i2c/sh_i2c.c:
2418 - activate this driver with CONFIG_SYS_I2C_SH
2419 - This driver adds from 2 to 5 i2c buses
2420
2421 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2422 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2423 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2424 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2425 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2426 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2427 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2428 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2429 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2430 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2431 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2432 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2433 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2434
Heiko Schocher6789e842013-10-22 11:03:18 +02002435 - drivers/i2c/omap24xx_i2c.c
2436 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2437 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2438 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2439 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2440 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2441 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2442 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2443 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2445 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2446 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2447
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002448 - drivers/i2c/zynq_i2c.c
2449 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2450 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2451 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2452
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302453 - drivers/i2c/s3c24x0_i2c.c:
2454 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2455 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2456 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2457 with a fix speed from 100000 and the slave addr 0!
2458
Dirk Eibachb46226b2014-07-03 09:28:18 +02002459 - drivers/i2c/ihs_i2c.c
2460 - activate this driver with CONFIG_SYS_I2C_IHS
2461 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2462 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2463 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2464 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2465 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2466 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2467 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2468 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2469 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2470 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2471 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2472 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2473
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002474 additional defines:
2475
2476 CONFIG_SYS_NUM_I2C_BUSES
2477 Hold the number of i2c busses you want to use. If you
2478 don't use/have i2c muxes on your i2c bus, this
2479 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2480 omit this define.
2481
2482 CONFIG_SYS_I2C_DIRECT_BUS
2483 define this, if you don't use i2c muxes on your hardware.
2484 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2485 omit this define.
2486
2487 CONFIG_SYS_I2C_MAX_HOPS
2488 define how many muxes are maximal consecutively connected
2489 on one i2c bus. If you not use i2c muxes, omit this
2490 define.
2491
2492 CONFIG_SYS_I2C_BUSES
2493 hold a list of busses you want to use, only used if
2494 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2495 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2496 CONFIG_SYS_NUM_I2C_BUSES = 9:
2497
2498 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2499 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2500 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2501 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2502 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2503 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2504 {1, {I2C_NULL_HOP}}, \
2505 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2506 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2507 }
2508
2509 which defines
2510 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002511 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2512 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2513 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2514 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2515 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002516 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002517 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2518 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002519
2520 If you do not have i2c muxes on your board, omit this define.
2521
Heiko Schocherea818db2013-01-29 08:53:15 +01002522- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002523
2524 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2525 provides the following compelling advantages:
2526
2527 - more than one i2c adapter is usable
2528 - approved multibus support
2529 - better i2c mux support
2530
2531 ** Please consider updating your I2C driver now. **
2532
Heiko Schocherea818db2013-01-29 08:53:15 +01002533 These enable legacy I2C serial bus commands. Defining
2534 CONFIG_HARD_I2C will include the appropriate I2C driver
2535 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk945af8d2003-07-16 21:53:01 +00002537 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002538 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002539 CONFIG_COMMANDS) and communicate with i2c based realtime
2540 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002541 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002542
Ben Warrenbb99ad62006-09-07 16:50:54 -04002543 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002544
wdenk945af8d2003-07-16 21:53:01 +00002545 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002546 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002548 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002549 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002550 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002551 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002552
Peter Tyser8d321b82010-04-12 22:28:21 -05002553 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002554 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002555 and so its address should therefore be cleared to 0 (See,
2556 eg, MPC823e User's Manual p.16-473). So, set
2557 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002558
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002559 CONFIG_SYS_I2C_INIT_MPC5XXX
2560
2561 When a board is reset during an i2c bus transfer
2562 chips might think that the current transfer is still
2563 in progress. Reset the slave devices by sending start
2564 commands until the slave device responds.
2565
wdenk945af8d2003-07-16 21:53:01 +00002566 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002567
Heiko Schocherea818db2013-01-29 08:53:15 +01002568 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002569 then the following macros need to be defined (examples are
2570 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002571
2572 I2C_INIT
2573
wdenkb37c7e52003-06-30 16:24:52 +00002574 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002575 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002576
wdenkba56f622004-02-06 23:19:44 +00002577 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002578
wdenkc6097192002-11-03 00:24:07 +00002579 I2C_PORT
2580
wdenk43d96162003-03-06 00:02:04 +00002581 (Only for MPC8260 CPU). The I/O port to use (the code
2582 assumes both bits are on the same port). Valid values
2583 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002584
2585 I2C_ACTIVE
2586
2587 The code necessary to make the I2C data line active
2588 (driven). If the data line is open collector, this
2589 define can be null.
2590
wdenkb37c7e52003-06-30 16:24:52 +00002591 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2592
wdenkc6097192002-11-03 00:24:07 +00002593 I2C_TRISTATE
2594
2595 The code necessary to make the I2C data line tri-stated
2596 (inactive). If the data line is open collector, this
2597 define can be null.
2598
wdenkb37c7e52003-06-30 16:24:52 +00002599 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2600
wdenkc6097192002-11-03 00:24:07 +00002601 I2C_READ
2602
York Sun472d5462013-04-01 11:29:11 -07002603 Code that returns true if the I2C data line is high,
2604 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002605
wdenkb37c7e52003-06-30 16:24:52 +00002606 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2607
wdenkc6097192002-11-03 00:24:07 +00002608 I2C_SDA(bit)
2609
York Sun472d5462013-04-01 11:29:11 -07002610 If <bit> is true, sets the I2C data line high. If it
2611 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002612
wdenkb37c7e52003-06-30 16:24:52 +00002613 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002614 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002615 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002616
wdenkc6097192002-11-03 00:24:07 +00002617 I2C_SCL(bit)
2618
York Sun472d5462013-04-01 11:29:11 -07002619 If <bit> is true, sets the I2C clock line high. If it
2620 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002621
wdenkb37c7e52003-06-30 16:24:52 +00002622 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002623 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002624 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002625
wdenkc6097192002-11-03 00:24:07 +00002626 I2C_DELAY
2627
2628 This delay is invoked four times per clock cycle so this
2629 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002630 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002631 like:
2632
wdenkb37c7e52003-06-30 16:24:52 +00002633 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002634
Mike Frysinger793b5722010-07-21 13:38:02 -04002635 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2636
2637 If your arch supports the generic GPIO framework (asm/gpio.h),
2638 then you may alternatively define the two GPIOs that are to be
2639 used as SCL / SDA. Any of the previous I2C_xxx macros will
2640 have GPIO-based defaults assigned to them as appropriate.
2641
2642 You should define these to the GPIO value as given directly to
2643 the generic GPIO functions.
2644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002645 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002646
wdenk8bde7f72003-06-27 21:31:46 +00002647 When a board is reset during an i2c bus transfer
2648 chips might think that the current transfer is still
2649 in progress. On some boards it is possible to access
2650 the i2c SCLK line directly, either by using the
2651 processor pin as a GPIO or by having a second pin
2652 connected to the bus. If this option is defined a
2653 custom i2c_init_board() routine in boards/xxx/board.c
2654 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002655
Richard Retanubun26a33502010-04-12 15:08:17 -04002656 CONFIG_SYS_I2C_BOARD_LATE_INIT
2657
2658 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2659 defined a custom i2c_board_late_init() routine in
2660 boards/xxx/board.c is run AFTER the operations in i2c_init()
2661 is completed. This callpoint can be used to unreset i2c bus
2662 using CPU i2c controller register accesses for CPUs whose i2c
2663 controller provide such a method. It is called at the end of
2664 i2c_init() to allow i2c_init operations to setup the i2c bus
2665 controller on the CPU (e.g. setting bus speed & slave address).
2666
wdenk17ea1172004-06-06 21:51:03 +00002667 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2668
2669 This option enables configuration of bi_iic_fast[] flags
2670 in u-boot bd_info structure based on u-boot environment
2671 variable "i2cfast". (see also i2cfast)
2672
Ben Warrenbb99ad62006-09-07 16:50:54 -04002673 CONFIG_I2C_MULTI_BUS
2674
2675 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002676 must have a controller. At any point in time, only one bus is
2677 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002678 Note that bus numbering is zero-based.
2679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002681
2682 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002683 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002684 is set, specify a list of bus-device pairs. Otherwise, specify
2685 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002686
2687 e.g.
2688 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002689 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002690
2691 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2692
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002693 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002694 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002695
2696 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2697
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002698 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002699
2700 If defined, then this indicates the I2C bus number for DDR SPD.
2701 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002704
2705 If defined, then this indicates the I2C bus number for the RTC.
2706 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002708 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002709
2710 If defined, then this indicates the I2C bus number for the DTT.
2711 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002714
2715 If defined, specifies the I2C address of the DTT device.
2716 If not defined, then U-Boot uses predefined value for
2717 specified DTT device.
2718
Andrew Dyer2ac69852008-12-29 17:36:01 -06002719 CONFIG_SOFT_I2C_READ_REPEATED_START
2720
2721 defining this will force the i2c_read() function in
2722 the soft_i2c driver to perform an I2C repeated start
2723 between writing the address pointer and reading the
2724 data. If this define is omitted the default behaviour
2725 of doing a stop-start sequence will be used. Most I2C
2726 devices can use either method, but some require one or
2727 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002728
wdenkc6097192002-11-03 00:24:07 +00002729- SPI Support: CONFIG_SPI
2730
2731 Enables SPI driver (so far only tested with
2732 SPI EEPROM, also an instance works with Crystal A/D and
2733 D/As on the SACSng board)
2734
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002735 CONFIG_SH_SPI
2736
2737 Enables the driver for SPI controller on SuperH. Currently
2738 only SH7757 is supported.
2739
wdenkc6097192002-11-03 00:24:07 +00002740 CONFIG_SPI_X
2741
2742 Enables extended (16-bit) SPI EEPROM addressing.
2743 (symmetrical to CONFIG_I2C_X)
2744
2745 CONFIG_SOFT_SPI
2746
wdenk43d96162003-03-06 00:02:04 +00002747 Enables a software (bit-bang) SPI driver rather than
2748 using hardware support. This is a general purpose
2749 driver that only requires three general I/O port pins
2750 (two outputs, one input) to function. If this is
2751 defined, the board configuration must define several
2752 SPI configuration items (port pins to use, etc). For
2753 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002754
Ben Warren04a9e112008-01-16 22:37:35 -05002755 CONFIG_HARD_SPI
2756
2757 Enables a hardware SPI driver for general-purpose reads
2758 and writes. As with CONFIG_SOFT_SPI, the board configuration
2759 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002760 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002761 example, see include/configs/mpc8349emds.h.
2762
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002763 CONFIG_MXC_SPI
2764
2765 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002766 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002767
Heiko Schocherf659b572014-07-14 10:22:11 +02002768 CONFIG_SYS_SPI_MXC_WAIT
2769 Timeout for waiting until spi transfer completed.
2770 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2771
Matthias Fuchs01335022007-12-27 17:12:34 +01002772- FPGA Support: CONFIG_FPGA
2773
2774 Enables FPGA subsystem.
2775
2776 CONFIG_FPGA_<vendor>
2777
2778 Enables support for specific chip vendors.
2779 (ALTERA, XILINX)
2780
2781 CONFIG_FPGA_<family>
2782
2783 Enables support for FPGA family.
2784 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2785
2786 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002787
wdenk43d96162003-03-06 00:02:04 +00002788 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002789
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302790 CONFIG_CMD_FPGA_LOADMK
2791
2792 Enable support for fpga loadmk command
2793
Michal Simek67193862014-05-02 13:43:39 +02002794 CONFIG_CMD_FPGA_LOADP
2795
2796 Enable support for fpga loadp command - load partial bitstream
2797
2798 CONFIG_CMD_FPGA_LOADBP
2799
2800 Enable support for fpga loadbp command - load partial bitstream
2801 (Xilinx only)
2802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002804
wdenk8bde7f72003-06-27 21:31:46 +00002805 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002808
wdenk43d96162003-03-06 00:02:04 +00002809 Enable checks on FPGA configuration interface busy
2810 status by the configuration function. This option
2811 will require a board or device specific function to
2812 be written.
wdenkc6097192002-11-03 00:24:07 +00002813
2814 CONFIG_FPGA_DELAY
2815
2816 If defined, a function that provides delays in the FPGA
2817 configuration driver.
2818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002819 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002820 Allow Control-C to interrupt FPGA configuration
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002823
wdenk43d96162003-03-06 00:02:04 +00002824 Check for configuration errors during FPGA bitfile
2825 loading. For example, abort during Virtex II
2826 configuration if the INIT_B line goes low (which
2827 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk43d96162003-03-06 00:02:04 +00002831 Maximum time to wait for the INIT_B line to deassert
2832 after PROB_B has been deasserted during a Virtex II
2833 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002834 ms.
wdenkc6097192002-11-03 00:24:07 +00002835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002836 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002837
wdenk43d96162003-03-06 00:02:04 +00002838 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002839 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002841 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk43d96162003-03-06 00:02:04 +00002843 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002844 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002845
2846- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002847 CONFIG_BUILD_TARGET
2848
2849 Some SoCs need special image types (e.g. U-Boot binary
2850 with a special header) as build targets. By defining
2851 CONFIG_BUILD_TARGET in the SoC / board header, this
2852 special image will be automatically built upon calling
2853 make / MAKEALL.
2854
wdenkc6097192002-11-03 00:24:07 +00002855 CONFIG_IDENT_STRING
2856
wdenk43d96162003-03-06 00:02:04 +00002857 If defined, this string will be added to the U-Boot
2858 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002859
2860- Vendor Parameter Protection:
2861
wdenk43d96162003-03-06 00:02:04 +00002862 U-Boot considers the values of the environment
2863 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002864 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002865 are set once by the board vendor / manufacturer, and
2866 protects these variables from casual modification by
2867 the user. Once set, these variables are read-only,
2868 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002869 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002870
2871 If CONFIG_ENV_OVERWRITE is #defined in your config
2872 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002873 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002874 these parameters.
2875
2876 Alternatively, if you #define _both_ CONFIG_ETHADDR
2877 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002878 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002879 which can be changed exactly ONCE by the user. [The
2880 serial# is unaffected by this, i. e. it remains
2881 read-only.]
2882
Joe Hershberger25980902012-12-11 22:16:31 -06002883 The same can be accomplished in a more flexible way
2884 for any variable by configuring the type of access
2885 to allow for those variables in the ".flags" variable
2886 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2887
wdenkc6097192002-11-03 00:24:07 +00002888- Protected RAM:
2889 CONFIG_PRAM
2890
2891 Define this variable to enable the reservation of
2892 "protected RAM", i. e. RAM which is not overwritten
2893 by U-Boot. Define CONFIG_PRAM to hold the number of
2894 kB you want to reserve for pRAM. You can overwrite
2895 this default value by defining an environment
2896 variable "pram" to the number of kB you want to
2897 reserve. Note that the board info structure will
2898 still show the full amount of RAM. If pRAM is
2899 reserved, a new environment variable "mem" will
2900 automatically be defined to hold the amount of
2901 remaining RAM in a form that can be passed as boot
2902 argument to Linux, for instance like that:
2903
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002904 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002905 saveenv
2906
2907 This way you can tell Linux not to use this memory,
2908 either, which results in a memory region that will
2909 not be affected by reboots.
2910
2911 *WARNING* If your board configuration uses automatic
2912 detection of the RAM size, you must make sure that
2913 this memory test is non-destructive. So far, the
2914 following board configurations are known to be
2915 "pRAM-clean":
2916
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002917 IVMS8, IVML24, SPD8xx, TQM8xxL,
2918 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002919 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002920
Gabe Black40fef042012-12-02 04:55:18 +00002921- Access to physical memory region (> 4GB)
2922 Some basic support is provided for operations on memory not
2923 normally accessible to U-Boot - e.g. some architectures
2924 support access to more than 4GB of memory on 32-bit
2925 machines using physical address extension or similar.
2926 Define CONFIG_PHYSMEM to access this basic support, which
2927 currently only supports clearing the memory.
2928
wdenkc6097192002-11-03 00:24:07 +00002929- Error Recovery:
2930 CONFIG_PANIC_HANG
2931
2932 Define this variable to stop the system in case of a
2933 fatal error, so that you have to reset it manually.
2934 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002935 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002936 automatically as fast as possible, but it may be
2937 useful during development since you can try to debug
2938 the conditions that lead to the situation.
2939
2940 CONFIG_NET_RETRY_COUNT
2941
wdenk43d96162003-03-06 00:02:04 +00002942 This variable defines the number of retries for
2943 network operations like ARP, RARP, TFTP, or BOOTP
2944 before giving up the operation. If not defined, a
2945 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002946
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002947 CONFIG_ARP_TIMEOUT
2948
2949 Timeout waiting for an ARP reply in milliseconds.
2950
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002951 CONFIG_NFS_TIMEOUT
2952
2953 Timeout in milliseconds used in NFS protocol.
2954 If you encounter "ERROR: Cannot umount" in nfs command,
2955 try longer timeout such as
2956 #define CONFIG_NFS_TIMEOUT 10000UL
2957
wdenkc6097192002-11-03 00:24:07 +00002958- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002959 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002960
2961 Enable auto completion of commands using TAB.
2962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002963 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002964
2965 This defines the secondary prompt string, which is
2966 printed when the command interpreter needs more input
2967 to complete a command. Usually "> ".
2968
2969 Note:
2970
wdenk8bde7f72003-06-27 21:31:46 +00002971 In the current implementation, the local variables
2972 space and global environment variables space are
2973 separated. Local variables are those you define by
2974 simply typing `name=value'. To access a local
2975 variable later on, you have write `$name' or
2976 `${name}'; to execute the contents of a variable
2977 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002978
wdenk43d96162003-03-06 00:02:04 +00002979 Global environment variables are those you use
2980 setenv/printenv to work with. To run a command stored
2981 in such a variable, you need to use the run command,
2982 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002983
2984 To store commands and special characters in a
2985 variable, please use double quotation marks
2986 surrounding the whole text of the variable, instead
2987 of the backslashes before semicolons and special
2988 symbols.
2989
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002990- Commandline Editing and History:
2991 CONFIG_CMDLINE_EDITING
2992
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002993 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002994 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002995
wdenka8c7c702003-12-06 19:49:23 +00002996- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002997 CONFIG_EXTRA_ENV_SETTINGS
2998
wdenk43d96162003-03-06 00:02:04 +00002999 Define this to contain any number of null terminated
3000 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003001 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003002
wdenk43d96162003-03-06 00:02:04 +00003003 For example, place something like this in your
3004 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003005
3006 #define CONFIG_EXTRA_ENV_SETTINGS \
3007 "myvar1=value1\0" \
3008 "myvar2=value2\0"
3009
wdenk43d96162003-03-06 00:02:04 +00003010 Warning: This method is based on knowledge about the
3011 internal format how the environment is stored by the
3012 U-Boot code. This is NOT an official, exported
3013 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003014 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003015 You better know what you are doing here.
3016
wdenk43d96162003-03-06 00:02:04 +00003017 Note: overly (ab)use of the default environment is
3018 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003019 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003020 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003021
Stephen Warren5e724ca2012-05-22 09:21:54 +00003022 CONFIG_ENV_VARS_UBOOT_CONFIG
3023
3024 Define this in order to add variables describing the
3025 U-Boot build configuration to the default environment.
3026 These will be named arch, cpu, board, vendor, and soc.
3027
3028 Enabling this option will cause the following to be defined:
3029
3030 - CONFIG_SYS_ARCH
3031 - CONFIG_SYS_CPU
3032 - CONFIG_SYS_BOARD
3033 - CONFIG_SYS_VENDOR
3034 - CONFIG_SYS_SOC
3035
Tom Rini7e27f892012-10-24 07:28:16 +00003036 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3037
3038 Define this in order to add variables describing certain
3039 run-time determined information about the hardware to the
3040 environment. These will be named board_name, board_rev.
3041
Simon Glass06fd8532012-11-30 13:01:17 +00003042 CONFIG_DELAY_ENVIRONMENT
3043
3044 Normally the environment is loaded when the board is
3045 intialised so that it is available to U-Boot. This inhibits
3046 that so that the environment is not available until
3047 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3048 this is instead controlled by the value of
3049 /config/load-environment.
3050
wdenka8c7c702003-12-06 19:49:23 +00003051- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003052 CONFIG_HAS_DATAFLASH
3053
wdenk8bde7f72003-06-27 21:31:46 +00003054 Defining this option enables DataFlash features and
3055 allows to read/write in Dataflash via the standard
3056 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003057
Eric Nelsonf61ec452012-01-31 10:52:08 -07003058- Serial Flash support
3059 CONFIG_CMD_SF
3060
3061 Defining this option enables SPI flash commands
3062 'sf probe/read/write/erase/update'.
3063
3064 Usage requires an initial 'probe' to define the serial
3065 flash parameters, followed by read/write/erase/update
3066 commands.
3067
3068 The following defaults may be provided by the platform
3069 to handle the common case when only a single serial
3070 flash is present on the system.
3071
3072 CONFIG_SF_DEFAULT_BUS Bus identifier
3073 CONFIG_SF_DEFAULT_CS Chip-select
3074 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3075 CONFIG_SF_DEFAULT_SPEED in Hz
3076
Simon Glass24007272012-10-08 13:16:02 +00003077 CONFIG_CMD_SF_TEST
3078
3079 Define this option to include a destructive SPI flash
3080 test ('sf test').
3081
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303082 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3083
3084 Define this option to use the Bank addr/Extended addr
3085 support on SPI flashes which has size > 16Mbytes.
3086
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303087 CONFIG_SF_DUAL_FLASH Dual flash memories
3088
3089 Define this option to use dual flash support where two flash
3090 memories can be connected with a given cs line.
3091 currently Xilinx Zynq qspi support these type of connections.
3092
Heiko Schocher562f8df2014-07-18 06:07:21 +02003093 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3094 enable the W#/Vpp signal to disable writing to the status
3095 register on ST MICRON flashes like the N25Q128.
3096 The status register write enable/disable bit, combined with
3097 the W#/VPP signal provides hardware data protection for the
3098 device as follows: When the enable/disable bit is set to 1,
3099 and the W#/VPP signal is driven LOW, the status register
3100 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3101 operation will not execute. The only way to exit this
3102 hardware-protected mode is to drive W#/VPP HIGH.
3103
wdenk3f85ce22004-02-23 16:11:30 +00003104- SystemACE Support:
3105 CONFIG_SYSTEMACE
3106
3107 Adding this option adds support for Xilinx SystemACE
3108 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003109 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003110 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003111
3112 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003113 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003114
3115 When SystemACE support is added, the "ace" device type
3116 becomes available to the fat commands, i.e. fatls.
3117
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003118- TFTP Fixed UDP Port:
3119 CONFIG_TFTP_PORT
3120
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003121 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003122 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003123 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003124 number generator is used.
3125
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003126 Also, the environment variable tftpdstp is used to supply
3127 the TFTP UDP destination port value. If tftpdstp isn't
3128 defined, the normal port 69 is used.
3129
3130 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003131 blindly start the TFTP transfer using the pre-configured
3132 target IP address and UDP port. This has the effect of
3133 "punching through" the (Windows XP) firewall, allowing
3134 the remainder of the TFTP transfer to proceed normally.
3135 A better solution is to properly configure the firewall,
3136 but sometimes that is not allowed.
3137
Simon Glassbf36c5d2012-12-05 14:46:38 +00003138- Hashing support:
3139 CONFIG_CMD_HASH
3140
3141 This enables a generic 'hash' command which can produce
3142 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3143
3144 CONFIG_HASH_VERIFY
3145
3146 Enable the hash verify command (hash -v). This adds to code
3147 size a little.
3148
3149 CONFIG_SHA1 - support SHA1 hashing
3150 CONFIG_SHA256 - support SHA256 hashing
3151
3152 Note: There is also a sha1sum command, which should perhaps
3153 be deprecated in favour of 'hash sha1'.
3154
Robert Winklera11f1872013-07-24 17:57:06 -07003155- Freescale i.MX specific commands:
3156 CONFIG_CMD_HDMIDETECT
3157 This enables 'hdmidet' command which returns true if an
3158 HDMI monitor is detected. This command is i.MX 6 specific.
3159
3160 CONFIG_CMD_BMODE
3161 This enables the 'bmode' (bootmode) command for forcing
3162 a boot from specific media.
3163
3164 This is useful for forcing the ROM's usb downloader to
3165 activate upon a watchdog reset which is nice when iterating
3166 on U-Boot. Using the reset button or running bmode normal
3167 will set it back to normal. This command currently
3168 supports i.MX53 and i.MX6.
3169
Simon Glass19c402a2013-06-13 15:10:02 -07003170- Signing support:
3171 CONFIG_RSA
3172
3173 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003174 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003175
3176 The signing part is build into mkimage regardless of this
3177 option.
3178
Heiko Schocher9e50c402014-01-25 07:27:13 +01003179- bootcount support:
3180 CONFIG_BOOTCOUNT_LIMIT
3181
3182 This enables the bootcounter support, see:
3183 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3184
3185 CONFIG_AT91SAM9XE
3186 enable special bootcounter support on at91sam9xe based boards.
3187 CONFIG_BLACKFIN
3188 enable special bootcounter support on blackfin based boards.
3189 CONFIG_SOC_DA8XX
3190 enable special bootcounter support on da850 based boards.
3191 CONFIG_BOOTCOUNT_RAM
3192 enable support for the bootcounter in RAM
3193 CONFIG_BOOTCOUNT_I2C
3194 enable support for the bootcounter on an i2c (like RTC) device.
3195 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3196 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3197 the bootcounter.
3198 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003199
wdenka8c7c702003-12-06 19:49:23 +00003200- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003201 CONFIG_SHOW_BOOT_PROGRESS
3202
wdenk43d96162003-03-06 00:02:04 +00003203 Defining this option allows to add some board-
3204 specific code (calling a user-provided function
3205 "show_boot_progress(int)") that enables you to show
3206 the system's boot progress on some display (for
3207 example, some LED's) on your board. At the moment,
3208 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003209
Simon Glass3a608ca2012-02-13 13:51:19 +00003210- Detailed boot stage timing
3211 CONFIG_BOOTSTAGE
3212 Define this option to get detailed timing of each stage
3213 of the boot process.
3214
3215 CONFIG_BOOTSTAGE_USER_COUNT
3216 This is the number of available user bootstage records.
3217 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3218 a new ID will be allocated from this stash. If you exceed
3219 the limit, recording will stop.
3220
3221 CONFIG_BOOTSTAGE_REPORT
3222 Define this to print a report before boot, similar to this:
3223
3224 Timer summary in microseconds:
3225 Mark Elapsed Stage
3226 0 0 reset
3227 3,575,678 3,575,678 board_init_f start
3228 3,575,695 17 arch_cpu_init A9
3229 3,575,777 82 arch_cpu_init done
3230 3,659,598 83,821 board_init_r start
3231 3,910,375 250,777 main_loop
3232 29,916,167 26,005,792 bootm_start
3233 30,361,327 445,160 start_kernel
3234
Simon Glass2eba38c2012-09-28 08:56:39 +00003235 CONFIG_CMD_BOOTSTAGE
3236 Add a 'bootstage' command which supports printing a report
3237 and un/stashing of bootstage data.
3238
Simon Glass94fd1312012-09-28 08:56:37 +00003239 CONFIG_BOOTSTAGE_FDT
3240 Stash the bootstage information in the FDT. A root 'bootstage'
3241 node is created with each bootstage id as a child. Each child
3242 has a 'name' property and either 'mark' containing the
3243 mark time in microsecond, or 'accum' containing the
3244 accumulated time for that bootstage id in microseconds.
3245 For example:
3246
3247 bootstage {
3248 154 {
3249 name = "board_init_f";
3250 mark = <3575678>;
3251 };
3252 170 {
3253 name = "lcd";
3254 accum = <33482>;
3255 };
3256 };
3257
3258 Code in the Linux kernel can find this in /proc/devicetree.
3259
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003260Legacy uImage format:
3261
wdenkc6097192002-11-03 00:24:07 +00003262 Arg Where When
3263 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003264 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003265 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003266 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003267 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003268 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003269 4 common/cmd_bootm.c Image data has correct checksum
3270 -4 common/cmd_bootm.c Image is for unsupported architecture
3271 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003272 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003273 6 common/cmd_bootm.c Image Type check OK
3274 -6 common/cmd_bootm.c gunzip uncompression error
3275 -7 common/cmd_bootm.c Unimplemented compression type
3276 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003277 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003278 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003279
3280 9 common/image.c Start initial ramdisk verification
3281 -10 common/image.c Ramdisk header has bad magic number
3282 -11 common/image.c Ramdisk header has bad checksum
3283 10 common/image.c Ramdisk header is OK
3284 -12 common/image.c Ramdisk data has bad checksum
3285 11 common/image.c Ramdisk data has correct checksum
3286 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003287 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003288 13 common/image.c Start multifile image verification
3289 14 common/image.c No initial ramdisk, no multifile, continue.
3290
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003291 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003292
Stefan Roesea47a12b2010-04-15 16:07:28 +02003293 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00003294 -31 post/post.c POST test failed, detected by post_output_backlog()
3295 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003296
Heiko Schocher566a4942007-06-22 19:11:54 +02003297 34 common/cmd_doc.c before loading a Image from a DOC device
3298 -35 common/cmd_doc.c Bad usage of "doc" command
3299 35 common/cmd_doc.c correct usage of "doc" command
3300 -36 common/cmd_doc.c No boot device
3301 36 common/cmd_doc.c correct boot device
3302 -37 common/cmd_doc.c Unknown Chip ID on boot device
3303 37 common/cmd_doc.c correct chip ID found, device available
3304 -38 common/cmd_doc.c Read Error on boot device
3305 38 common/cmd_doc.c reading Image header from DOC device OK
3306 -39 common/cmd_doc.c Image header has bad magic number
3307 39 common/cmd_doc.c Image header has correct magic number
3308 -40 common/cmd_doc.c Error reading Image from DOC device
3309 40 common/cmd_doc.c Image header has correct magic number
3310 41 common/cmd_ide.c before loading a Image from a IDE device
3311 -42 common/cmd_ide.c Bad usage of "ide" command
3312 42 common/cmd_ide.c correct usage of "ide" command
3313 -43 common/cmd_ide.c No boot device
3314 43 common/cmd_ide.c boot device found
3315 -44 common/cmd_ide.c Device not available
3316 44 common/cmd_ide.c Device available
3317 -45 common/cmd_ide.c wrong partition selected
3318 45 common/cmd_ide.c partition selected
3319 -46 common/cmd_ide.c Unknown partition table
3320 46 common/cmd_ide.c valid partition table found
3321 -47 common/cmd_ide.c Invalid partition type
3322 47 common/cmd_ide.c correct partition type
3323 -48 common/cmd_ide.c Error reading Image Header on boot device
3324 48 common/cmd_ide.c reading Image Header from IDE device OK
3325 -49 common/cmd_ide.c Image header has bad magic number
3326 49 common/cmd_ide.c Image header has correct magic number
3327 -50 common/cmd_ide.c Image header has bad checksum
3328 50 common/cmd_ide.c Image header has correct checksum
3329 -51 common/cmd_ide.c Error reading Image from IDE device
3330 51 common/cmd_ide.c reading Image from IDE device OK
3331 52 common/cmd_nand.c before loading a Image from a NAND device
3332 -53 common/cmd_nand.c Bad usage of "nand" command
3333 53 common/cmd_nand.c correct usage of "nand" command
3334 -54 common/cmd_nand.c No boot device
3335 54 common/cmd_nand.c boot device found
3336 -55 common/cmd_nand.c Unknown Chip ID on boot device
3337 55 common/cmd_nand.c correct chip ID found, device available
3338 -56 common/cmd_nand.c Error reading Image Header on boot device
3339 56 common/cmd_nand.c reading Image Header from NAND device OK
3340 -57 common/cmd_nand.c Image header has bad magic number
3341 57 common/cmd_nand.c Image header has correct magic number
3342 -58 common/cmd_nand.c Error reading Image from NAND device
3343 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003344
Heiko Schocher566a4942007-06-22 19:11:54 +02003345 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003346
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003347 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003348 -64 net/eth.c no Ethernet found.
3349 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003350
Heiko Schocher566a4942007-06-22 19:11:54 +02003351 -80 common/cmd_net.c usage wrong
3352 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003353 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003354 81 common/cmd_net.c NetLoop() back without error
3355 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3356 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003357 83 common/cmd_net.c running "source" command
3358 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003359 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003360
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003361FIT uImage format:
3362
3363 Arg Where When
3364 100 common/cmd_bootm.c Kernel FIT Image has correct format
3365 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3366 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3367 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3368 102 common/cmd_bootm.c Kernel unit name specified
3369 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003370 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003371 104 common/cmd_bootm.c Got kernel subimage node offset
3372 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3373 105 common/cmd_bootm.c Kernel subimage hash verification OK
3374 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3375 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003376 -106 common/cmd_bootm.c Kernel subimage has wrong type
3377 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003378 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3379 108 common/cmd_bootm.c Got kernel subimage data/size
3380 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3381 -109 common/cmd_bootm.c Can't get kernel subimage type
3382 -110 common/cmd_bootm.c Can't get kernel subimage comp
3383 -111 common/cmd_bootm.c Can't get kernel subimage os
3384 -112 common/cmd_bootm.c Can't get kernel subimage load address
3385 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3386
3387 120 common/image.c Start initial ramdisk verification
3388 -120 common/image.c Ramdisk FIT image has incorrect format
3389 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003390 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003391 -122 common/image.c Can't get configuration for ramdisk subimage
3392 123 common/image.c Ramdisk unit name specified
3393 -124 common/image.c Can't get ramdisk subimage node offset
3394 125 common/image.c Got ramdisk subimage node offset
3395 -125 common/image.c Ramdisk subimage hash verification failed
3396 126 common/image.c Ramdisk subimage hash verification OK
3397 -126 common/image.c Ramdisk subimage for unsupported architecture
3398 127 common/image.c Architecture check OK
3399 -127 common/image.c Can't get ramdisk subimage data/size
3400 128 common/image.c Got ramdisk subimage data/size
3401 129 common/image.c Can't get ramdisk load address
3402 -129 common/image.c Got ramdisk load address
3403
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003404 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003405 131 common/cmd_doc.c FIT image format OK
3406
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003407 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003408 141 common/cmd_ide.c FIT image format OK
3409
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003410 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003411 151 common/cmd_nand.c FIT image format OK
3412
Heiko Schocher21d29f72014-05-28 11:33:33 +02003413- legacy image format:
3414 CONFIG_IMAGE_FORMAT_LEGACY
3415 enables the legacy image format support in U-Boot.
3416
3417 Default:
3418 enabled if CONFIG_FIT_SIGNATURE is not defined.
3419
3420 CONFIG_DISABLE_IMAGE_LEGACY
3421 disable the legacy image format
3422
3423 This define is introduced, as the legacy image format is
3424 enabled per default for backward compatibility.
3425
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003426- FIT image support:
3427 CONFIG_FIT
3428 Enable support for the FIT uImage format.
3429
3430 CONFIG_FIT_BEST_MATCH
3431 When no configuration is explicitly selected, default to the
3432 one whose fdt's compatibility field best matches that of
3433 U-Boot itself. A match is considered "best" if it matches the
3434 most specific compatibility entry of U-Boot's fdt's root node.
3435 The order of entries in the configuration's fdt is ignored.
3436
Simon Glass3e569a62013-06-13 15:10:00 -07003437 CONFIG_FIT_SIGNATURE
3438 This option enables signature verification of FIT uImages,
3439 using a hash signed and verified using RSA. See
3440 doc/uImage.FIT/signature.txt for more details.
3441
Heiko Schocher21d29f72014-05-28 11:33:33 +02003442 WARNING: When relying on signed FIT images with required
3443 signature check the legacy image format is default
3444 disabled. If a board need legacy image format support
3445 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3446
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003447 CONFIG_FIT_DISABLE_SHA256
3448 Supporting SHA256 hashes has quite an impact on binary size.
3449 For constrained systems sha256 hash support can be disabled
3450 with this option.
3451
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003452- Standalone program support:
3453 CONFIG_STANDALONE_LOAD_ADDR
3454
Wolfgang Denk6feff892011-10-09 21:06:34 +02003455 This option defines a board specific value for the
3456 address where standalone program gets loaded, thus
3457 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003458 settings.
3459
3460- Frame Buffer Address:
3461 CONFIG_FB_ADDR
3462
3463 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003464 address for frame buffer. This is typically the case
3465 when using a graphics controller has separate video
3466 memory. U-Boot will then place the frame buffer at
3467 the given address instead of dynamically reserving it
3468 in system RAM by calling lcd_setmem(), which grabs
3469 the memory for the frame buffer depending on the
3470 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003471
3472 Please see board_init_f function.
3473
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003474- Automatic software updates via TFTP server
3475 CONFIG_UPDATE_TFTP
3476 CONFIG_UPDATE_TFTP_CNT_MAX
3477 CONFIG_UPDATE_TFTP_MSEC_MAX
3478
3479 These options enable and control the auto-update feature;
3480 for a more detailed description refer to doc/README.update.
3481
3482- MTD Support (mtdparts command, UBI support)
3483 CONFIG_MTD_DEVICE
3484
3485 Adds the MTD device infrastructure from the Linux kernel.
3486 Needed for mtdparts command support.
3487
3488 CONFIG_MTD_PARTITIONS
3489
3490 Adds the MTD partitioning infrastructure from the Linux
3491 kernel. Needed for UBI support.
3492
Heiko Schocherff94bc42014-06-24 10:10:04 +02003493 CONFIG_MTD_NAND_VERIFY_WRITE
3494 verify if the written data is correct reread.
3495
Joe Hershberger70c219c2013-04-08 10:32:48 +00003496- UBI support
3497 CONFIG_CMD_UBI
3498
3499 Adds commands for interacting with MTD partitions formatted
3500 with the UBI flash translation layer
3501
3502 Requires also defining CONFIG_RBTREE
3503
Joe Hershberger147162d2013-04-08 10:32:49 +00003504 CONFIG_UBI_SILENCE_MSG
3505
3506 Make the verbose messages from UBI stop printing. This leaves
3507 warnings and errors enabled.
3508
Heiko Schocherff94bc42014-06-24 10:10:04 +02003509
3510 CONFIG_MTD_UBI_WL_THRESHOLD
3511 This parameter defines the maximum difference between the highest
3512 erase counter value and the lowest erase counter value of eraseblocks
3513 of UBI devices. When this threshold is exceeded, UBI starts performing
3514 wear leveling by means of moving data from eraseblock with low erase
3515 counter to eraseblocks with high erase counter.
3516
3517 The default value should be OK for SLC NAND flashes, NOR flashes and
3518 other flashes which have eraseblock life-cycle 100000 or more.
3519 However, in case of MLC NAND flashes which typically have eraseblock
3520 life-cycle less than 10000, the threshold should be lessened (e.g.,
3521 to 128 or 256, although it does not have to be power of 2).
3522
3523 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003524
Heiko Schocherff94bc42014-06-24 10:10:04 +02003525 CONFIG_MTD_UBI_BEB_LIMIT
3526 This option specifies the maximum bad physical eraseblocks UBI
3527 expects on the MTD device (per 1024 eraseblocks). If the
3528 underlying flash does not admit of bad eraseblocks (e.g. NOR
3529 flash), this value is ignored.
3530
3531 NAND datasheets often specify the minimum and maximum NVM
3532 (Number of Valid Blocks) for the flashes' endurance lifetime.
3533 The maximum expected bad eraseblocks per 1024 eraseblocks
3534 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3535 which gives 20 for most NANDs (MaxNVB is basically the total
3536 count of eraseblocks on the chip).
3537
3538 To put it differently, if this value is 20, UBI will try to
3539 reserve about 1.9% of physical eraseblocks for bad blocks
3540 handling. And that will be 1.9% of eraseblocks on the entire
3541 NAND chip, not just the MTD partition UBI attaches. This means
3542 that if you have, say, a NAND flash chip admits maximum 40 bad
3543 eraseblocks, and it is split on two MTD partitions of the same
3544 size, UBI will reserve 40 eraseblocks when attaching a
3545 partition.
3546
3547 default: 20
3548
3549 CONFIG_MTD_UBI_FASTMAP
3550 Fastmap is a mechanism which allows attaching an UBI device
3551 in nearly constant time. Instead of scanning the whole MTD device it
3552 only has to locate a checkpoint (called fastmap) on the device.
3553 The on-flash fastmap contains all information needed to attach
3554 the device. Using fastmap makes only sense on large devices where
3555 attaching by scanning takes long. UBI will not automatically install
3556 a fastmap on old images, but you can set the UBI parameter
3557 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3558 that fastmap-enabled images are still usable with UBI implementations
3559 without fastmap support. On typical flash devices the whole fastmap
3560 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3561
3562 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3563 Set this parameter to enable fastmap automatically on images
3564 without a fastmap.
3565 default: 0
3566
Joe Hershberger70c219c2013-04-08 10:32:48 +00003567- UBIFS support
3568 CONFIG_CMD_UBIFS
3569
3570 Adds commands for interacting with UBI volumes formatted as
3571 UBIFS. UBIFS is read-only in u-boot.
3572
3573 Requires UBI support as well as CONFIG_LZO
3574
Joe Hershberger147162d2013-04-08 10:32:49 +00003575 CONFIG_UBIFS_SILENCE_MSG
3576
3577 Make the verbose messages from UBIFS stop printing. This leaves
3578 warnings and errors enabled.
3579
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003580- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003581 CONFIG_SPL
3582 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003583
Tom Rini95579792012-02-14 07:29:40 +00003584 CONFIG_SPL_LDSCRIPT
3585 LDSCRIPT for linking the SPL binary.
3586
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003587 CONFIG_SPL_MAX_FOOTPRINT
3588 Maximum size in memory allocated to the SPL, BSS included.
3589 When defined, the linker checks that the actual memory
3590 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003591 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003592 must not be both defined at the same time.
3593
Tom Rini95579792012-02-14 07:29:40 +00003594 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003595 Maximum size of the SPL image (text, data, rodata, and
3596 linker lists sections), BSS excluded.
3597 When defined, the linker checks that the actual size does
3598 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003599
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003600 CONFIG_SPL_TEXT_BASE
3601 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003602
Scott Wood94a45bb2012-09-20 19:05:12 -05003603 CONFIG_SPL_RELOC_TEXT_BASE
3604 Address to relocate to. If unspecified, this is equal to
3605 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3606
Tom Rini95579792012-02-14 07:29:40 +00003607 CONFIG_SPL_BSS_START_ADDR
3608 Link address for the BSS within the SPL binary.
3609
3610 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003611 Maximum size in memory allocated to the SPL BSS.
3612 When defined, the linker checks that the actual memory used
3613 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003614 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003615 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003616
3617 CONFIG_SPL_STACK
3618 Adress of the start of the stack SPL will use
3619
Scott Wood94a45bb2012-09-20 19:05:12 -05003620 CONFIG_SPL_RELOC_STACK
3621 Adress of the start of the stack SPL will use after
3622 relocation. If unspecified, this is equal to
3623 CONFIG_SPL_STACK.
3624
Tom Rini95579792012-02-14 07:29:40 +00003625 CONFIG_SYS_SPL_MALLOC_START
3626 Starting address of the malloc pool used in SPL.
3627
3628 CONFIG_SYS_SPL_MALLOC_SIZE
3629 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003630
Tom Rini47f7bca2012-08-13 12:03:19 -07003631 CONFIG_SPL_FRAMEWORK
3632 Enable the SPL framework under common/. This framework
3633 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3634 NAND loading of the Linux Kernel.
3635
Tom Rini9607faf2014-03-28 12:03:39 -04003636 CONFIG_SPL_OS_BOOT
3637 Enable booting directly to an OS from SPL.
3638 See also: doc/README.falcon
3639
Tom Rini861a86f2012-08-13 11:37:56 -07003640 CONFIG_SPL_DISPLAY_PRINT
3641 For ARM, enable an optional function to print more information
3642 about the running system.
3643
Scott Wood4b919722012-09-20 16:35:21 -05003644 CONFIG_SPL_INIT_MINIMAL
3645 Arch init code should be built for a very small image
3646
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003647 CONFIG_SPL_LIBCOMMON_SUPPORT
3648 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003649
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003650 CONFIG_SPL_LIBDISK_SUPPORT
3651 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003652
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003653 CONFIG_SPL_I2C_SUPPORT
3654 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003655
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003656 CONFIG_SPL_GPIO_SUPPORT
3657 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003658
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003659 CONFIG_SPL_MMC_SUPPORT
3660 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003661
Tom Rini95579792012-02-14 07:29:40 +00003662 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3663 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003664 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003665 when the MMC is being used in raw mode.
3666
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003667 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3668 Partition on the MMC to load U-Boot from when the MMC is being
3669 used in raw mode
3670
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003671 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3672 Sector to load kernel uImage from when MMC is being
3673 used in raw mode (for Falcon mode)
3674
3675 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3676 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3677 Sector and number of sectors to load kernel argument
3678 parameters from when MMC is being used in raw mode
3679 (for falcon mode)
3680
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003681 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3682 Partition on the MMC to load U-Boot from when the MMC is being
3683 used in fs mode
3684
Tom Rini95579792012-02-14 07:29:40 +00003685 CONFIG_SPL_FAT_SUPPORT
3686 Support for fs/fat/libfat.o in SPL binary
3687
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003688 CONFIG_SPL_EXT_SUPPORT
3689 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003690
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003691 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3692 Filename to read to load U-Boot when reading from filesystem
3693
3694 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003695 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003696 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003697
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003698 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003699 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003700 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003701
Scott Wood06f60ae2012-12-06 13:33:17 +00003702 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3703 Set this for NAND SPL on PPC mpc83xx targets, so that
3704 start.S waits for the rest of the SPL to load before
3705 continuing (the hardware starts execution after just
3706 loading the first page rather than the full 4K).
3707
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303708 CONFIG_SPL_SKIP_RELOCATE
3709 Avoid SPL relocation
3710
Scott Wood6f2f01b2012-09-20 19:09:07 -05003711 CONFIG_SPL_NAND_BASE
3712 Include nand_base.c in the SPL. Requires
3713 CONFIG_SPL_NAND_DRIVERS.
3714
3715 CONFIG_SPL_NAND_DRIVERS
3716 SPL uses normal NAND drivers, not minimal drivers.
3717
3718 CONFIG_SPL_NAND_ECC
3719 Include standard software ECC in the SPL
3720
Tom Rini95579792012-02-14 07:29:40 +00003721 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003722 Support for NAND boot using simple NAND drivers that
3723 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003724
Tom Rini6dd3b562014-03-28 12:03:36 -04003725 CONFIG_SPL_MTD_SUPPORT
3726 Support for the MTD subsystem within SPL. Useful for
3727 environment on NAND support within SPL.
3728
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003729 CONFIG_SPL_NAND_RAW_ONLY
3730 Support to boot only raw u-boot.bin images. Use this only
3731 if you need to save space.
3732
Ying Zhangbb0dc102013-08-16 15:16:11 +08003733 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3734 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003735 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003736
Ying Zhang7c8eea52013-08-16 15:16:12 +08003737 CONFIG_SPL_COMMON_INIT_DDR
3738 Set for common ddr init with serial presence detect in
3739 SPL binary.
3740
Tom Rini95579792012-02-14 07:29:40 +00003741 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3742 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3743 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3744 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3745 CONFIG_SYS_NAND_ECCBYTES
3746 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003747 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003748
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303749 CONFIG_SPL_NAND_BOOT
3750 Add support NAND boot
3751
Tom Rini95579792012-02-14 07:29:40 +00003752 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003753 Location in NAND to read U-Boot from
3754
3755 CONFIG_SYS_NAND_U_BOOT_DST
3756 Location in memory to load U-Boot to
3757
3758 CONFIG_SYS_NAND_U_BOOT_SIZE
3759 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003760
3761 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003762 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003763
3764 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3765 Define this if you need to first read the OOB and then the
3766 data. This is used for example on davinci plattforms.
3767
3768 CONFIG_SPL_OMAP3_ID_NAND
3769 Support for an OMAP3-specific set of functions to return the
3770 ID and MFR of the first attached NAND chip, if present.
3771
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003772 CONFIG_SPL_SERIAL_SUPPORT
3773 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003774
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003775 CONFIG_SPL_SPI_FLASH_SUPPORT
3776 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003777
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003778 CONFIG_SPL_SPI_SUPPORT
3779 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003780
Pavel Machekc57b9532012-08-30 22:42:11 +02003781 CONFIG_SPL_RAM_DEVICE
3782 Support for running image already present in ram, in SPL binary
3783
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003784 CONFIG_SPL_LIBGENERIC_SUPPORT
3785 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003786
Ying Zhangba1bee42013-05-20 14:07:25 +08003787 CONFIG_SPL_ENV_SUPPORT
3788 Support for the environment operating in SPL binary
3789
3790 CONFIG_SPL_NET_SUPPORT
3791 Support for the net/libnet.o in SPL binary.
3792 It conflicts with SPL env from storage medium specified by
3793 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3794
Scott Wood74752ba2012-12-06 13:33:16 +00003795 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003796 Image offset to which the SPL should be padded before appending
3797 the SPL payload. By default, this is defined as
3798 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3799 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3800 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003801
Scott Woodca2fca22012-09-21 16:27:32 -05003802 CONFIG_SPL_TARGET
3803 Final target image containing SPL and payload. Some SPLs
3804 use an arch-specific makefile fragment instead, for
3805 example if more than one image needs to be produced.
3806
Simon Glass87ebee32013-05-08 08:05:59 +00003807 CONFIG_FIT_SPL_PRINT
3808 Printing information about a FIT image adds quite a bit of
3809 code to SPL. So this is normally disabled in SPL. Use this
3810 option to re-enable it. This will affect the output of the
3811 bootm command when booting a FIT image.
3812
Ying Zhang3aa29de2013-08-16 15:16:15 +08003813- TPL framework
3814 CONFIG_TPL
3815 Enable building of TPL globally.
3816
3817 CONFIG_TPL_PAD_TO
3818 Image offset to which the TPL should be padded before appending
3819 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003820 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3821 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3822 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003823
wdenkc6097192002-11-03 00:24:07 +00003824Modem Support:
3825--------------
3826
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003827[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003828
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003829- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003830 CONFIG_MODEM_SUPPORT
3831
3832- RTS/CTS Flow control enable:
3833 CONFIG_HWFLOW
3834
3835- Modem debug support:
3836 CONFIG_MODEM_SUPPORT_DEBUG
3837
wdenk43d96162003-03-06 00:02:04 +00003838 Enables debugging stuff (char screen[1024], dbg())
3839 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003840
wdenka8c7c702003-12-06 19:49:23 +00003841- Interrupt support (PPC):
3842
wdenkd4ca31c2004-01-02 14:00:00 +00003843 There are common interrupt_init() and timer_interrupt()
3844 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003845 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003846 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003847 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003848 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003849 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003850 specific handling. If board has watchdog / status_led
3851 / other_activity_monitor it works automatically from
3852 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003853
wdenkc6097192002-11-03 00:24:07 +00003854- General:
3855
wdenk43d96162003-03-06 00:02:04 +00003856 In the target system modem support is enabled when a
3857 specific key (key combination) is pressed during
3858 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003859 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003860 board_init(). Currently key_pressed() is a dummy
3861 function, returning 1 and thus enabling modem
3862 initialization.
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk43d96162003-03-06 00:02:04 +00003864 If there are no modem init strings in the
3865 environment, U-Boot proceed to autoboot; the
3866 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003867 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003868
3869 See also: doc/README.Modem
3870
Helmut Raiger9660e442011-10-20 04:19:47 +00003871Board initialization settings:
3872------------------------------
3873
3874During Initialization u-boot calls a number of board specific functions
3875to allow the preparation of board specific prerequisites, e.g. pin setup
3876before drivers are initialized. To enable these callbacks the
3877following configuration macros have to be defined. Currently this is
3878architecture specific, so please check arch/your_architecture/lib/board.c
3879typically in board_init_f() and board_init_r().
3880
3881- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3882- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3883- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3884- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003885
wdenkc6097192002-11-03 00:24:07 +00003886Configuration Settings:
3887-----------------------
3888
York Sun4d1fd7f2014-02-26 17:03:19 -08003889- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3890 Optionally it can be defined to support 64-bit memory commands.
3891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003892- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003893 undefine this when you're short of memory.
3894
Peter Tyser2fb26042009-01-27 18:03:12 -06003895- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3896 width of the commands listed in the 'help' command output.
3897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003898- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003899 prompt for user input.
3900
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003901- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003903- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003905- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003908 the application (usually a Linux kernel) when it is
3909 booted
3910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003911- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003912 List of legal baudrate settings for this board.
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003915 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003917- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003918 If the board specific function
3919 extern int overwrite_console (void);
3920 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003921 serial port, else the settings in the environment are used.
3922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003923- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003924 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003927 Enable overwrite of previous console environment settings.
3928
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003929- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003930 Begin and End addresses of the area used by the
3931 simple memory test.
3932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003933- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003934 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003937 Scratch address used by the alternate memory test
3938 You only need to set this if address zero isn't writeable
3939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003940- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3941 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003942 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003943 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003944 fixing up gd->ram_size the Linux kernel should gets passed
3945 the now "corrected" memory size and won't touch it either.
3946 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003947 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003948 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003949 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003950
3951 This option can be used as a workaround for the 440EPx/GRx
3952 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3953 be touched.
3954
3955 WARNING: Please make sure that this value is a multiple of
3956 the Linux page size (normally 4k). If this is not the case,
3957 then the end address of the Linux memory will be located at a
3958 non page size aligned address and this could cause major
3959 problems.
3960
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003961- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003962 Enable temporary baudrate change while serial download
3963
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003964- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003965 Physical start address of SDRAM. _Must_ be 0 here.
3966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003967- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003968 Physical start address of Motherboard I/O (if using a
3969 Cogent motherboard)
3970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003971- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003972 Physical start address of Flash memory.
3973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003974- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003975 Physical start address of boot monitor code (set by
3976 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003977 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003978 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003980- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003981 Size of memory reserved for monitor code, used to
3982 determine _at_compile_time_ (!) if the environment is
3983 embedded within the U-Boot image, or in a separate
3984 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003986- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003987 Size of DRAM reserved for malloc() use.
3988
Simon Glassd59476b2014-07-10 22:23:28 -06003989- CONFIG_SYS_MALLOC_F_LEN
3990 Size of the malloc() pool for use before relocation. If
3991 this is defined, then a very simple malloc() implementation
3992 will become available before relocation. The address is just
3993 below the global data, and the stack is moved down to make
3994 space.
3995
3996 This feature allocates regions with increasing addresses
3997 within the region. calloc() is supported, but realloc()
3998 is not available. free() is supported but does nothing.
3999 The memory will be freed (or in fact just forgotton) when
4000 U-Boot relocates itself.
4001
Simon Glasse7b14e92014-09-15 06:33:18 -06004002 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06004003 at present but is fairly easy to enable for other archs.
4004
Simon Glass38687ae2014-11-10 17:16:54 -07004005- CONFIG_SYS_MALLOC_SIMPLE
4006 Provides a simple and small malloc() and calloc() for those
4007 boards which do not use the full malloc in SPL (which is
4008 enabled with CONFIG_SYS_SPL_MALLOC_START).
4009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004010- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01004011 Normally compressed uImages are limited to an
4012 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004013 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01004014 to adjust this setting to your needs.
4015
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004016- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004017 Maximum size of memory mapped by the startup code of
4018 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004019 the Linux kernel (bd_info, boot arguments, FDT blob if
4020 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004021 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004022 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004023 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004024 variable "bootm_mapsize" will override the value of
4025 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4026 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004027
John Rigbyfca43cc2010-10-13 13:57:35 -06004028- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4029 Enable initrd_high functionality. If defined then the
4030 initrd_high feature is enabled and the bootm ramdisk subcommand
4031 is enabled.
4032
4033- CONFIG_SYS_BOOT_GET_CMDLINE:
4034 Enables allocating and saving kernel cmdline in space between
4035 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4036
4037- CONFIG_SYS_BOOT_GET_KBD:
4038 Enables allocating and saving a kernel copy of the bd_info in
4039 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004041- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004042 Max number of Flash memory banks
4043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004044- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004045 Max number of sectors on a Flash chip
4046
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004047- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004048 Timeout for Flash erase operations (in ms)
4049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004050- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004051 Timeout for Flash write operations (in ms)
4052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004053- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004054 Timeout for Flash set sector lock bit operation (in ms)
4055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004056- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004057 Timeout for Flash clear lock bits operation (in ms)
4058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004059- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004060 If defined, hardware flash sectors protection is used
4061 instead of U-Boot software protection.
4062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004063- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004064
4065 Enable TFTP transfers directly to flash memory;
4066 without this option such a download has to be
4067 performed in two steps: (1) download to RAM, and (2)
4068 copy from RAM to flash.
4069
4070 The two-step approach is usually more reliable, since
4071 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004072 the flash, but in some situations (when system RAM is
4073 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004074 downloaded image) this option may be very useful.
4075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004076- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004077 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004078 common flash structure for storing flash geometry.
4079
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004080- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004081 This option also enables the building of the cfi_flash driver
4082 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004083
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004084- CONFIG_FLASH_CFI_MTD
4085 This option enables the building of the cfi_mtd driver
4086 in the drivers directory. The driver exports CFI flash
4087 to the MTD layer.
4088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004089- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004090 Use buffered writes to flash.
4091
4092- CONFIG_FLASH_SPANSION_S29WS_N
4093 s29ws-n MirrorBit flash has non-standard addresses for buffered
4094 write commands.
4095
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004096- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004097 If this option is defined, the common CFI flash doesn't
4098 print it's warning upon not recognized FLASH banks. This
4099 is useful, if some of the configured banks are only
4100 optionally available.
4101
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004102- CONFIG_FLASH_SHOW_PROGRESS
4103 If defined (must be an integer), print out countdown
4104 digits and dots. Recommended value: 45 (9..1) for 80
4105 column displays, 15 (3..1) for 40 column displays.
4106
Stefan Roese352ef3f2013-04-04 15:53:14 +02004107- CONFIG_FLASH_VERIFY
4108 If defined, the content of the flash (destination) is compared
4109 against the source after the write operation. An error message
4110 will be printed when the contents are not identical.
4111 Please note that this option is useless in nearly all cases,
4112 since such flash programming errors usually are detected earlier
4113 while unprotecting/erasing/programming. Please only enable
4114 this option if you really know what you are doing.
4115
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004116- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004117 Defines the number of Ethernet receive buffers. On some
4118 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004119 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4120 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004121 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004122 Defaults to 4 if not defined.
4123
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004124- CONFIG_ENV_MAX_ENTRIES
4125
Wolfgang Denk071bc922010-10-27 22:48:30 +02004126 Maximum number of entries in the hash table that is used
4127 internally to store the environment settings. The default
4128 setting is supposed to be generous and should work in most
4129 cases. This setting can be used to tune behaviour; see
4130 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004131
Joe Hershberger25980902012-12-11 22:16:31 -06004132- CONFIG_ENV_FLAGS_LIST_DEFAULT
4133- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004134 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004135 calling env set. Variables can be restricted to only decimal,
4136 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4137 the variables can also be restricted to IP address or MAC address.
4138
4139 The format of the list is:
4140 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06004141 access_atribute = [a|r|o|c]
4142 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004143 entry = variable_name[:attributes]
4144 list = entry[,list]
4145
4146 The type attributes are:
4147 s - String (default)
4148 d - Decimal
4149 x - Hexadecimal
4150 b - Boolean ([1yYtT|0nNfF])
4151 i - IP address
4152 m - MAC address
4153
Joe Hershberger267541f2012-12-11 22:16:34 -06004154 The access attributes are:
4155 a - Any (default)
4156 r - Read-only
4157 o - Write-once
4158 c - Change-default
4159
Joe Hershberger25980902012-12-11 22:16:31 -06004160 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4161 Define this to a list (string) to define the ".flags"
4162 envirnoment variable in the default or embedded environment.
4163
4164 - CONFIG_ENV_FLAGS_LIST_STATIC
4165 Define this to a list (string) to define validation that
4166 should be done if an entry is not found in the ".flags"
4167 environment variable. To override a setting in the static
4168 list, simply add an entry for the same variable name to the
4169 ".flags" variable.
4170
Joe Hershberger267541f2012-12-11 22:16:34 -06004171- CONFIG_ENV_ACCESS_IGNORE_FORCE
4172 If defined, don't allow the -f switch to env set override variable
4173 access flags.
4174
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004175- CONFIG_SYS_GENERIC_BOARD
4176 This selects the architecture-generic board system instead of the
4177 architecture-specific board files. It is intended to move boards
4178 to this new framework over time. Defining this will disable the
4179 arch/foo/lib/board.c file and use common/board_f.c and
4180 common/board_r.c instead. To use this option your architecture
4181 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4182 its config.mk file). If you find problems enabling this option on
4183 your board please report the problem and send patches!
4184
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004185- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4186 This is set by OMAP boards for the max time that reset should
4187 be asserted. See doc/README.omap-reset-time for details on how
4188 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004189
Gabe Black0d296cc2014-10-15 04:38:30 -06004190- CONFIG_USE_STDINT
4191 If stdint.h is available with your toolchain you can define this
4192 option to enable it. You can provide option 'USE_STDINT=1' when
4193 building U-Boot to enable this.
4194
wdenkc6097192002-11-03 00:24:07 +00004195The following definitions that deal with the placement and management
4196of environment data (variable area); in general, we support the
4197following configurations:
4198
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004199- CONFIG_BUILD_ENVCRC:
4200
4201 Builds up envcrc with the target environment so that external utils
4202 may easily extract it and embed it in final U-Boot images.
4203
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004204- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004205
4206 Define this if the environment is in flash memory.
4207
4208 a) The environment occupies one whole flash sector, which is
4209 "embedded" in the text segment with the U-Boot code. This
4210 happens usually with "bottom boot sector" or "top boot
4211 sector" type flash chips, which have several smaller
4212 sectors at the start or the end. For instance, such a
4213 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4214 such a case you would place the environment in one of the
4215 4 kB sectors - with U-Boot code before and after it. With
4216 "top boot sector" type flash chips, you would put the
4217 environment in one of the last sectors, leaving a gap
4218 between U-Boot and the environment.
4219
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004220 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004221
4222 Offset of environment data (variable area) to the
4223 beginning of flash memory; for instance, with bottom boot
4224 type flash chips the second sector can be used: the offset
4225 for this sector is given here.
4226
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004227 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004228
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004229 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004230
4231 This is just another way to specify the start address of
4232 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004233 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004234
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004235 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004236
4237 Size of the sector containing the environment.
4238
4239
4240 b) Sometimes flash chips have few, equal sized, BIG sectors.
4241 In such a case you don't want to spend a whole sector for
4242 the environment.
4243
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004244 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004245
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004246 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004247 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004248 of this flash sector for the environment. This saves
4249 memory for the RAM copy of the environment.
4250
4251 It may also save flash memory if you decide to use this
4252 when your environment is "embedded" within U-Boot code,
4253 since then the remainder of the flash sector could be used
4254 for U-Boot code. It should be pointed out that this is
4255 STRONGLY DISCOURAGED from a robustness point of view:
4256 updating the environment in flash makes it always
4257 necessary to erase the WHOLE sector. If something goes
4258 wrong before the contents has been restored from a copy in
4259 RAM, your target system will be dead.
4260
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004261 - CONFIG_ENV_ADDR_REDUND
4262 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk43d96162003-03-06 00:02:04 +00004264 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004265 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004266 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004267 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004268
4269BE CAREFUL! Any changes to the flash layout, and some changes to the
4270source code will make it necessary to adapt <board>/u-boot.lds*
4271accordingly!
4272
4273
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004274- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004275
4276 Define this if you have some non-volatile memory device
4277 (NVRAM, battery buffered SRAM) which you want to use for the
4278 environment.
4279
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004280 - CONFIG_ENV_ADDR:
4281 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004282
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004283 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004284 want to use for environment. It is assumed that this memory
4285 can just be read and written to, without any special
4286 provision.
4287
4288BE CAREFUL! The first access to the environment happens quite early
4289in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004290console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004291U-Boot will hang.
4292
4293Please note that even with NVRAM we still use a copy of the
4294environment in RAM: we could work on NVRAM directly, but we want to
4295keep settings there always unmodified except somebody uses "saveenv"
4296to save the current settings.
4297
4298
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004299- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004300
4301 Use this if you have an EEPROM or similar serial access
4302 device and a driver for it.
4303
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004304 - CONFIG_ENV_OFFSET:
4305 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004306
4307 These two #defines specify the offset and size of the
4308 environment area within the total memory of your EEPROM.
4309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004310 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004311 If defined, specified the chip address of the EEPROM device.
4312 The default address is zero.
4313
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004314 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004315 If defined, the number of bits used to address bytes in a
4316 single page in the EEPROM device. A 64 byte page, for example
4317 would require six bits.
4318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004319 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004320 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004321 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004323 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004324 The length in bytes of the EEPROM memory array address. Note
4325 that this is NOT the chip address length!
4326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004327 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004328 EEPROM chips that implement "address overflow" are ones
4329 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4330 address and the extra bits end up in the "chip address" bit
4331 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4332 byte chips.
4333
4334 Note that we consider the length of the address field to
4335 still be one byte because the extra address bits are hidden
4336 in the chip address.
4337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004338 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004339 The size in bytes of the EEPROM device.
4340
Heiko Schocher548738b2010-01-07 08:55:40 +01004341 - CONFIG_ENV_EEPROM_IS_ON_I2C
4342 define this, if you have I2C and SPI activated, and your
4343 EEPROM, which holds the environment, is on the I2C bus.
4344
4345 - CONFIG_I2C_ENV_EEPROM_BUS
4346 if you have an Environment on an EEPROM reached over
4347 I2C muxes, you can define here, how to reach this
4348 EEPROM. For example:
4349
Heiko Schocherea818db2013-01-29 08:53:15 +01004350 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004351
4352 EEPROM which holds the environment, is reached over
4353 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004354
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004355- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004356
wdenkd4ca31c2004-01-02 14:00:00 +00004357 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004358 want to use for the environment.
4359
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004360 - CONFIG_ENV_OFFSET:
4361 - CONFIG_ENV_ADDR:
4362 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004363
4364 These three #defines specify the offset and size of the
4365 environment area within the total memory of your DataFlash placed
4366 at the specified address.
4367
Wu, Joshbd83b592014-07-01 19:30:13 +08004368- CONFIG_ENV_IS_IN_SPI_FLASH:
4369
4370 Define this if you have a SPI Flash memory device which you
4371 want to use for the environment.
4372
4373 - CONFIG_ENV_OFFSET:
4374 - CONFIG_ENV_SIZE:
4375
4376 These two #defines specify the offset and size of the
4377 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4378 aligned to an erase sector boundary.
4379
4380 - CONFIG_ENV_SECT_SIZE:
4381
4382 Define the SPI flash's sector size.
4383
4384 - CONFIG_ENV_OFFSET_REDUND (optional):
4385
4386 This setting describes a second storage area of CONFIG_ENV_SIZE
4387 size used to hold a redundant copy of the environment data, so
4388 that there is a valid backup copy in case there is a power failure
4389 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4390 aligned to an erase sector boundary.
4391
4392 - CONFIG_ENV_SPI_BUS (optional):
4393 - CONFIG_ENV_SPI_CS (optional):
4394
4395 Define the SPI bus and chip select. If not defined they will be 0.
4396
4397 - CONFIG_ENV_SPI_MAX_HZ (optional):
4398
4399 Define the SPI max work clock. If not defined then use 1MHz.
4400
4401 - CONFIG_ENV_SPI_MODE (optional):
4402
4403 Define the SPI work mode. If not defined then use SPI_MODE_3.
4404
Liu Gang0a85a9e2012-03-08 00:33:20 +00004405- CONFIG_ENV_IS_IN_REMOTE:
4406
4407 Define this if you have a remote memory space which you
4408 want to use for the local device's environment.
4409
4410 - CONFIG_ENV_ADDR:
4411 - CONFIG_ENV_SIZE:
4412
4413 These two #defines specify the address and size of the
4414 environment area within the remote memory space. The
4415 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004416 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004417
4418BE CAREFUL! For some special cases, the local device can not use
4419"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004420environment stored in a remote NOR flash by SRIO or PCIE link,
4421but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004422
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004423- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004424
4425 Define this if you have a NAND device which you want to use
4426 for the environment.
4427
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004428 - CONFIG_ENV_OFFSET:
4429 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004430
4431 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004432 area within the first NAND device. CONFIG_ENV_OFFSET must be
4433 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004434
Scott Woodfdd813d2010-09-17 14:38:37 -05004435 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004436
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004437 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004438 size used to hold a redundant copy of the environment data, so
4439 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004440 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004441 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004442
Scott Woodfdd813d2010-09-17 14:38:37 -05004443 - CONFIG_ENV_RANGE (optional):
4444
4445 Specifies the length of the region in which the environment
4446 can be written. This should be a multiple of the NAND device's
4447 block size. Specifying a range with more erase blocks than
4448 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4449 the range to be avoided.
4450
4451 - CONFIG_ENV_OFFSET_OOB (optional):
4452
4453 Enables support for dynamically retrieving the offset of the
4454 environment from block zero's out-of-band data. The
4455 "nand env.oob" command can be used to record this offset.
4456 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4457 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004458
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004459- CONFIG_NAND_ENV_DST
4460
4461 Defines address in RAM to which the nand_spl code should copy the
4462 environment. If redundant environment is used, it will be copied to
4463 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4464
Joe Hershberger2b744332013-04-08 10:32:51 +00004465- CONFIG_ENV_IS_IN_UBI:
4466
4467 Define this if you have an UBI volume that you want to use for the
4468 environment. This has the benefit of wear-leveling the environment
4469 accesses, which is important on NAND.
4470
4471 - CONFIG_ENV_UBI_PART:
4472
4473 Define this to a string that is the mtd partition containing the UBI.
4474
4475 - CONFIG_ENV_UBI_VOLUME:
4476
4477 Define this to the name of the volume that you want to store the
4478 environment in.
4479
Joe Hershberger785881f2013-04-08 10:32:52 +00004480 - CONFIG_ENV_UBI_VOLUME_REDUND:
4481
4482 Define this to the name of another volume to store a second copy of
4483 the environment in. This will enable redundant environments in UBI.
4484 It is assumed that both volumes are in the same MTD partition.
4485
Joe Hershberger2b744332013-04-08 10:32:51 +00004486 - CONFIG_UBI_SILENCE_MSG
4487 - CONFIG_UBIFS_SILENCE_MSG
4488
4489 You will probably want to define these to avoid a really noisy system
4490 when storing the env in UBI.
4491
Wu, Joshd1db76f2014-06-24 17:31:03 +08004492- CONFIG_ENV_IS_IN_FAT:
4493 Define this if you want to use the FAT file system for the environment.
4494
4495 - FAT_ENV_INTERFACE:
4496
4497 Define this to a string that is the name of the block device.
4498
4499 - FAT_ENV_DEV_AND_PART:
4500
4501 Define this to a string to specify the partition of the device. It can
4502 be as following:
4503
4504 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4505 - "D:P": device D partition P. Error occurs if device D has no
4506 partition table.
4507 - "D:0": device D.
4508 - "D" or "D:": device D partition 1 if device D has partition
4509 table, or the whole device D if has no partition
4510 table.
4511 - "D:auto": first partition in device D with bootable flag set.
4512 If none, first valid paratition in device D. If no
4513 partition table then means device D.
4514
4515 - FAT_ENV_FILE:
4516
4517 It's a string of the FAT file name. This file use to store the
4518 envrionment.
4519
4520 - CONFIG_FAT_WRITE:
4521 This should be defined. Otherwise it cannot save the envrionment file.
4522
Stephen Warren06e4ae52013-06-11 15:14:00 -06004523- CONFIG_ENV_IS_IN_MMC:
4524
4525 Define this if you have an MMC device which you want to use for the
4526 environment.
4527
4528 - CONFIG_SYS_MMC_ENV_DEV:
4529
4530 Specifies which MMC device the environment is stored in.
4531
4532 - CONFIG_SYS_MMC_ENV_PART (optional):
4533
4534 Specifies which MMC partition the environment is stored in. If not
4535 set, defaults to partition 0, the user area. Common values might be
4536 1 (first MMC boot partition), 2 (second MMC boot partition).
4537
4538 - CONFIG_ENV_OFFSET:
4539 - CONFIG_ENV_SIZE:
4540
4541 These two #defines specify the offset and size of the environment
4542 area within the specified MMC device.
4543
Stephen Warren5c088ee2013-06-11 15:14:02 -06004544 If offset is positive (the usual case), it is treated as relative to
4545 the start of the MMC partition. If offset is negative, it is treated
4546 as relative to the end of the MMC partition. This can be useful if
4547 your board may be fitted with different MMC devices, which have
4548 different sizes for the MMC partitions, and you always want the
4549 environment placed at the very end of the partition, to leave the
4550 maximum possible space before it, to store other data.
4551
Stephen Warren06e4ae52013-06-11 15:14:00 -06004552 These two values are in units of bytes, but must be aligned to an
4553 MMC sector boundary.
4554
4555 - CONFIG_ENV_OFFSET_REDUND (optional):
4556
4557 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4558 hold a redundant copy of the environment data. This provides a
4559 valid backup copy in case the other copy is corrupted, e.g. due
4560 to a power failure during a "saveenv" operation.
4561
Stephen Warren5c088ee2013-06-11 15:14:02 -06004562 This value may also be positive or negative; this is handled in the
4563 same way as CONFIG_ENV_OFFSET.
4564
Stephen Warren06e4ae52013-06-11 15:14:00 -06004565 This value is also in units of bytes, but must also be aligned to
4566 an MMC sector boundary.
4567
4568 - CONFIG_ENV_SIZE_REDUND (optional):
4569
4570 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4571 set. If this value is set, it must be set to the same value as
4572 CONFIG_ENV_SIZE.
4573
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004574- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004575
4576 Defines offset to the initial SPI buffer area in DPRAM. The
4577 area is used at an early stage (ROM part) if the environment
4578 is configured to reside in the SPI EEPROM: We need a 520 byte
4579 scratch DPRAM area. It is used between the two initialization
4580 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4581 to be a good choice since it makes it far enough from the
4582 start of the data area as well as from the stack pointer.
4583
Bruce Adlere881cb52007-11-02 13:15:42 -07004584Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004585has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004586created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004587until then to read environment variables.
4588
wdenk85ec0bc2003-03-31 16:34:49 +00004589The environment is protected by a CRC32 checksum. Before the monitor
4590is relocated into RAM, as a result of a bad CRC you will be working
4591with the compiled-in default environment - *silently*!!! [This is
4592necessary, because the first environment variable we need is the
4593"baudrate" setting for the console - if we have a bad CRC, we don't
4594have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004595
4596Note: once the monitor has been relocated, then it will complain if
4597the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004598use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004600- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004601 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004603 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004604 also needs to be defined.
4605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004606- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004607 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004608
Ron Madridf5675aa2009-02-18 14:30:44 -08004609- CONFIG_NS16550_MIN_FUNCTIONS:
4610 Define this if you desire to only have use of the NS16550_init
4611 and NS16550_putc functions for the serial driver located at
4612 drivers/serial/ns16550.c. This option is useful for saving
4613 space for already greatly restricted images, including but not
4614 limited to NAND_SPL configurations.
4615
Simon Glassb2b92f52012-11-30 13:01:18 +00004616- CONFIG_DISPLAY_BOARDINFO
4617 Display information about the board that U-Boot is running on
4618 when U-Boot starts up. The board function checkboard() is called
4619 to do this.
4620
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004621- CONFIG_DISPLAY_BOARDINFO_LATE
4622 Similar to the previous option, but display this information
4623 later, once stdio is running and output goes to the LCD, if
4624 present.
4625
Sascha Silbefeb85802013-08-11 16:40:43 +02004626- CONFIG_BOARD_SIZE_LIMIT:
4627 Maximum size of the U-Boot image. When defined, the
4628 build system checks that the actual size does not
4629 exceed it.
4630
wdenkc6097192002-11-03 00:24:07 +00004631Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004632---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004634- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004635 Cache Line Size of the CPU.
4636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004637- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004638 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004639
wdenk42d1f032003-10-15 23:53:47 +00004640 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4641 and RPXsuper) to be able to adjust the position of
4642 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004643
Timur Tabie46fedf2011-08-04 18:03:41 -05004644- CONFIG_SYS_CCSRBAR_DEFAULT:
4645 Default (power-on reset) physical address of CCSR on Freescale
4646 PowerPC SOCs.
4647
4648- CONFIG_SYS_CCSRBAR:
4649 Virtual address of CCSR. On a 32-bit build, this is typically
4650 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4651
4652 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4653 for cross-platform code that uses that macro instead.
4654
4655- CONFIG_SYS_CCSRBAR_PHYS:
4656 Physical address of CCSR. CCSR can be relocated to a new
4657 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004658 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004659 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4660 is typically relocated on 36-bit builds. It is recommended
4661 that this macro be defined via the _HIGH and _LOW macros:
4662
4663 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4664 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4665
4666- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004667 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4668 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004669 used in assembly code, so it must not contain typecasts or
4670 integer size suffixes (e.g. "ULL").
4671
4672- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4673 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4674 used in assembly code, so it must not contain typecasts or
4675 integer size suffixes (e.g. "ULL").
4676
4677- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4678 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4679 forced to a value that ensures that CCSR is not relocated.
4680
wdenk7f6c2cb2002-11-10 22:06:23 +00004681- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004682 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004683
4684 the default drive number (default value 0)
4685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004686 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004687
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004688 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004689 (default value 1)
4690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004691 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004692
wdenk43d96162003-03-06 00:02:04 +00004693 defines the offset of register from address. It
4694 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004695 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004697 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4698 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004699 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004701 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004702 fdc_hw_init() is called at the beginning of the FDC
4703 setup. fdc_hw_init() must be provided by the board
4704 source code. It is used to make hardware dependant
4705 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004706
Macpaul Lin0abddf82011-04-11 20:45:32 +00004707- CONFIG_IDE_AHB:
4708 Most IDE controllers were designed to be connected with PCI
4709 interface. Only few of them were designed for AHB interface.
4710 When software is doing ATA command and data transfer to
4711 IDE devices through IDE-AHB controller, some additional
4712 registers accessing to these kind of IDE-AHB controller
4713 is requierd.
4714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004715- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004716 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004717 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk7152b1d2003-09-05 23:19:14 +00004721 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004722 initial data and stack; please note that this must be
4723 writable memory that is working WITHOUT special
4724 initialization, i. e. you CANNOT use normal RAM which
4725 will become available only after programming the
4726 memory controller and running certain initialization
4727 sequences.
4728
4729 U-Boot uses the following memory types:
4730 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4731 - MPC824X: data cache
4732 - PPC4xx: data cache
4733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004734- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004735
4736 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004737 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4738 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004739 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004740 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004741 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4742 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4743 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004744
4745 Note:
4746 On the MPC824X (or other systems that use the data
4747 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004748 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004749 point to an otherwise UNUSED address space between
4750 the top of RAM and the start of the PCI space.
4751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004752- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004754- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004756- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004758- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004760- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004762- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004764- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004765 SDRAM timing
4766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004767- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004768 periodic timer for refresh
4769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004770- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004772- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4773 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4774 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4775 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004776 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4777
4778- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004779 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4780 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004781 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004783- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4784 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004785 Machine Mode Register and Memory Periodic Timer
4786 Prescaler definitions (SDRAM timing)
4787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004788- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004789 enable I2C microcode relocation patch (MPC8xx);
4790 define relocation offset in DPRAM [DSP2]
4791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004792- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004793 enable SMC microcode relocation patch (MPC8xx);
4794 define relocation offset in DPRAM [SMC1]
4795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004796- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004797 enable SPI microcode relocation patch (MPC8xx);
4798 define relocation offset in DPRAM [SCC4]
4799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004800- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004801 Use OSCM clock mode on MBX8xx board. Be careful,
4802 wrong setting might damage your board. Read
4803 doc/README.MBX before setting this variable!
4804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004805- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004806 Offset of the bootmode word in DPRAM used by post
4807 (Power On Self Tests). This definition overrides
4808 #define'd default value in commproc.h resp.
4809 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004811- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4812 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4813 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4814 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4815 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4816 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4817 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4818 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004819 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004820
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004821- CONFIG_PCI_DISABLE_PCIE:
4822 Disable PCI-Express on systems where it is supported but not
4823 required.
4824
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004825- CONFIG_PCI_ENUM_ONLY
4826 Only scan through and get the devices on the busses.
4827 Don't do any setup work, presumably because someone or
4828 something has already done it, and we don't need to do it
4829 a second time. Useful for platforms that are pre-booted
4830 by coreboot or similar.
4831
Gabor Juhos842033e2013-05-30 07:06:12 +00004832- CONFIG_PCI_INDIRECT_BRIDGE:
4833 Enable support for indirect PCI bridges.
4834
Kumar Galaa09b9b62010-12-30 12:09:53 -06004835- CONFIG_SYS_SRIO:
4836 Chip has SRIO or not
4837
4838- CONFIG_SRIO1:
4839 Board has SRIO 1 port available
4840
4841- CONFIG_SRIO2:
4842 Board has SRIO 2 port available
4843
Liu Gangc8b28152013-05-07 16:30:46 +08004844- CONFIG_SRIO_PCIE_BOOT_MASTER
4845 Board can support master function for Boot from SRIO and PCIE
4846
Kumar Galaa09b9b62010-12-30 12:09:53 -06004847- CONFIG_SYS_SRIOn_MEM_VIRT:
4848 Virtual Address of SRIO port 'n' memory region
4849
4850- CONFIG_SYS_SRIOn_MEM_PHYS:
4851 Physical Address of SRIO port 'n' memory region
4852
4853- CONFIG_SYS_SRIOn_MEM_SIZE:
4854 Size of SRIO port 'n' memory region
4855
Fabio Estevam66bd1842013-04-11 09:35:34 +00004856- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4857 Defined to tell the NAND controller that the NAND chip is using
4858 a 16 bit bus.
4859 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004860 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004861 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004862 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004863
4864- CONFIG_SYS_NDFC_EBC0_CFG
4865 Sets the EBC0_CFG register for the NDFC. If not defined
4866 a default value will be used.
4867
Ben Warrenbb99ad62006-09-07 16:50:54 -04004868- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004869 Get DDR timing information from an I2C EEPROM. Common
4870 with pluggable memory modules such as SODIMMs
4871
Ben Warrenbb99ad62006-09-07 16:50:54 -04004872 SPD_EEPROM_ADDRESS
4873 I2C address of the SPD EEPROM
4874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004875- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004876 If SPD EEPROM is on an I2C bus other than the first
4877 one, specify here. Note that the value must resolve
4878 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004879
York Sun1b3e3c42011-06-07 09:42:16 +08004880- CONFIG_SYS_DDR_RAW_TIMING
4881 Get DDR timing information from other than SPD. Common with
4882 soldered DDR chips onboard without SPD. DDR raw timing
4883 parameters are extracted from datasheet and hard-coded into
4884 header files or board specific files.
4885
York Sun6f5e1dc2011-09-16 13:21:35 -07004886- CONFIG_FSL_DDR_INTERACTIVE
4887 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004889- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004890 Only for 83xx systems. If specified, then DDR should
4891 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004892
wdenkc26e4542004-04-18 10:13:26 +00004893- CONFIG_ETHER_ON_FEC[12]
4894 Define to enable FEC[12] on a 8xx series processor.
4895
4896- CONFIG_FEC[12]_PHY
4897 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004898 to the given FEC; i. e.
4899 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004900 means that the PHY with address 4 is connected to FEC1
4901
4902 When set to -1, means to probe for first available.
4903
4904- CONFIG_FEC[12]_PHY_NORXERR
4905 The PHY does not have a RXERR line (RMII only).
4906 (so program the FEC to ignore it).
4907
4908- CONFIG_RMII
4909 Enable RMII mode for all FECs.
4910 Note that this is a global option, we can't
4911 have one FEC in standard MII mode and another in RMII mode.
4912
wdenk5cf91d62004-04-23 20:32:05 +00004913- CONFIG_CRC32_VERIFY
4914 Add a verify option to the crc32 command.
4915 The syntax is:
4916
4917 => crc32 -v <address> <count> <crc32>
4918
4919 Where address/count indicate a memory area
4920 and crc32 is the correct crc32 which the
4921 area should have.
4922
wdenk56523f12004-07-11 17:40:54 +00004923- CONFIG_LOOPW
4924 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004925 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004926
stroese7b466642004-12-16 18:46:55 +00004927- CONFIG_MX_CYCLIC
4928 Add the "mdc" and "mwc" memory commands. These are cyclic
4929 "md/mw" commands.
4930 Examples:
4931
wdenkefe2a4d2004-12-16 21:44:03 +00004932 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004933 This command will print 4 bytes (10,11,12,13) each 500 ms.
4934
wdenkefe2a4d2004-12-16 21:44:03 +00004935 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004936 This command will write 12345678 to address 100 all 10 ms.
4937
wdenkefe2a4d2004-12-16 21:44:03 +00004938 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004939 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004940
wdenk8aa1a2d2005-04-04 12:44:11 +00004941- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004942 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004943 low level initializations (like setting up the memory
4944 controller) are omitted and/or U-Boot does not
4945 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004946
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004947 Normally this variable MUST NOT be defined. The only
4948 exception is when U-Boot is loaded (to RAM) by some
4949 other boot loader or by a debugger which performs
4950 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004951
Aneesh V401bb302011-07-13 05:11:07 +00004952- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004953 Modifies the behaviour of start.S when compiling a loader
4954 that is executed before the actual U-Boot. E.g. when
4955 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004956
Ying Zhang3aa29de2013-08-16 15:16:15 +08004957- CONFIG_TPL_BUILD
4958 Modifies the behaviour of start.S when compiling a loader
4959 that is executed after the SPL and before the actual U-Boot.
4960 It is loaded by the SPL.
4961
Ying Zhang5df572f2013-05-20 14:07:23 +08004962- CONFIG_SYS_MPC85XX_NO_RESETVEC
4963 Only for 85xx systems. If this variable is specified, the section
4964 .resetvec is not kept and the section .bootpg is placed in the
4965 previous 4k of the .text section.
4966
Simon Glass4213fc22013-02-24 17:33:14 +00004967- CONFIG_ARCH_MAP_SYSMEM
4968 Generally U-Boot (and in particular the md command) uses
4969 effective address. It is therefore not necessary to regard
4970 U-Boot address as virtual addresses that need to be translated
4971 to physical addresses. However, sandbox requires this, since
4972 it maintains its own little RAM buffer which contains all
4973 addressable memory. This option causes some memory accesses
4974 to be mapped through map_sysmem() / unmap_sysmem().
4975
Matthias Weisserd8834a12011-03-10 21:36:32 +00004976- CONFIG_USE_ARCH_MEMCPY
4977 CONFIG_USE_ARCH_MEMSET
4978 If these options are used a optimized version of memcpy/memset will
4979 be used if available. These functions may be faster under some
4980 conditions but may increase the binary size.
4981
Simon Glass588a13f2013-02-14 04:18:54 +00004982- CONFIG_X86_RESET_VECTOR
4983 If defined, the x86 reset vector code is included. This is not
4984 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004985
Mark Jacksonfc337052013-03-04 01:27:20 +00004986- CONFIG_SYS_MPUCLK
4987 Defines the MPU clock speed (in MHz).
4988
4989 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004990
Heiko Schocher16678eb2013-11-04 14:05:00 +01004991- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4992 Enables the RTC32K OSC on AM33xx based plattforms
4993
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004994- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4995 Option to disable subpage write in NAND driver
4996 driver that uses this:
4997 drivers/mtd/nand/davinci_nand.c
4998
Timur Tabif2717b42011-11-22 09:21:25 -06004999Freescale QE/FMAN Firmware Support:
5000-----------------------------------
5001
5002The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5003loading of "firmware", which is encoded in the QE firmware binary format.
5004This firmware often needs to be loaded during U-Boot booting, so macros
5005are used to identify the storage device (NOR flash, SPI, etc) and the address
5006within that device.
5007
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005008- CONFIG_SYS_FMAN_FW_ADDR
5009 The address in the storage device where the FMAN microcode is located. The
5010 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5011 is also specified.
5012
5013- CONFIG_SYS_QE_FW_ADDR
5014 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005015 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5016 is also specified.
5017
5018- CONFIG_SYS_QE_FMAN_FW_LENGTH
5019 The maximum possible size of the firmware. The firmware binary format
5020 has a field that specifies the actual size of the firmware, but it
5021 might not be possible to read any part of the firmware unless some
5022 local storage is allocated to hold the entire firmware first.
5023
5024- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5025 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5026 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5027 virtual address in NOR flash.
5028
5029- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5030 Specifies that QE/FMAN firmware is located in NAND flash.
5031 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5032
5033- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5034 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5035 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5036
5037- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5038 Specifies that QE/FMAN firmware is located on the primary SPI
5039 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5040
Liu Gang292dc6c2012-03-08 00:33:18 +00005041- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5042 Specifies that QE/FMAN firmware is located in the remote (master)
5043 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005044 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5045 window->master inbound window->master LAW->the ucode address in
5046 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005047
J. German Riverab940ca62014-06-23 15:15:55 -07005048Freescale Layerscape Management Complex Firmware Support:
5049---------------------------------------------------------
5050The Freescale Layerscape Management Complex (MC) supports the loading of
5051"firmware".
5052This firmware often needs to be loaded during U-Boot booting, so macros
5053are used to identify the storage device (NOR flash, SPI, etc) and the address
5054within that device.
5055
5056- CONFIG_FSL_MC_ENET
5057 Enable the MC driver for Layerscape SoCs.
5058
5059- CONFIG_SYS_LS_MC_FW_ADDR
5060 The address in the storage device where the firmware is located. The
5061 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5062 is also specified.
5063
5064- CONFIG_SYS_LS_MC_FW_LENGTH
5065 The maximum possible size of the firmware. The firmware binary format
5066 has a field that specifies the actual size of the firmware, but it
5067 might not be possible to read any part of the firmware unless some
5068 local storage is allocated to hold the entire firmware first.
5069
5070- CONFIG_SYS_LS_MC_FW_IN_NOR
5071 Specifies that MC firmware is located in NOR flash, mapped as
5072 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5073 virtual address in NOR flash.
5074
wdenkc6097192002-11-03 00:24:07 +00005075Building the Software:
5076======================
5077
Wolfgang Denk218ca722008-03-26 10:40:12 +01005078Building U-Boot has been tested in several native build environments
5079and in many different cross environments. Of course we cannot support
5080all possibly existing versions of cross development tools in all
5081(potentially obsolete) versions. In case of tool chain problems we
5082recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5083which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005084
Wolfgang Denk218ca722008-03-26 10:40:12 +01005085If you are not using a native environment, it is assumed that you
5086have GNU cross compiling tools available in your path. In this case,
5087you must set the environment variable CROSS_COMPILE in your shell.
5088Note that no changes to the Makefile or any other source files are
5089necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005090
Wolfgang Denk218ca722008-03-26 10:40:12 +01005091 $ CROSS_COMPILE=ppc_4xx-
5092 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005093
Peter Tyser2f8d3962009-03-13 18:54:51 -05005094Note: If you wish to generate Windows versions of the utilities in
5095 the tools directory you can use the MinGW toolchain
5096 (http://www.mingw.org). Set your HOST tools to the MinGW
5097 toolchain and execute 'make tools'. For example:
5098
5099 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5100
5101 Binaries such as tools/mkimage.exe will be created which can
5102 be executed on computers running Windows.
5103
Wolfgang Denk218ca722008-03-26 10:40:12 +01005104U-Boot is intended to be simple to build. After installing the
5105sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005106is done by typing:
5107
Holger Freytherab584d62014-08-04 09:26:05 +02005108 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005109
Holger Freytherab584d62014-08-04 09:26:05 +02005110where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005111rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113Note: for some board special configuration names may exist; check if
5114 additional information is available from the board vendor; for
5115 instance, the TQM823L systems are available without (standard)
5116 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005117 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005118
Holger Freytherab584d62014-08-04 09:26:05 +02005119 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005120 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005121
Holger Freytherab584d62014-08-04 09:26:05 +02005122 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005123 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125 etc.
wdenkc6097192002-11-03 00:24:07 +00005126
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk2729af92004-05-03 20:45:30 +00005128Finally, type "make all", and you should get some working U-Boot
5129images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131- "u-boot.bin" is a raw binary image
5132- "u-boot" is an image in ELF binary format
5133- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005134
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005135By default the build is performed locally and the objects are saved
5136in the source directory. One of the two methods can be used to change
5137this behavior and build U-Boot to some external directory:
5138
51391. Add O= to the make command line invocations:
5140
5141 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005142 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005143 make O=/tmp/build all
5144
Timo Ketolaadbba992014-11-06 14:39:05 +020051452. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005146
Timo Ketolaadbba992014-11-06 14:39:05 +02005147 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005148 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005149 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005150 make all
5151
Timo Ketolaadbba992014-11-06 14:39:05 +02005152Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005153variable.
5154
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156Please be aware that the Makefiles assume you are using GNU make, so
5157for instance on NetBSD you might need to use "gmake" instead of
5158native "make".
wdenkc6097192002-11-03 00:24:07 +00005159
wdenkc6097192002-11-03 00:24:07 +00005160
wdenk2729af92004-05-03 20:45:30 +00005161If the system board that you have is not listed, then you will need
5162to port U-Boot to your hardware platform. To do this, follow these
5163steps:
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk2729af92004-05-03 20:45:30 +000051651. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005166 "boards.cfg" file, using the existing entries as examples.
5167 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051682. Create a new directory to hold your board specific code. Add any
5169 files you need. In your board directory, you will need at least
5170 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51713. Create a new configuration file "include/configs/<board>.h" for
5172 your board
51733. If you're porting U-Boot to a new CPU, then also create a new
5174 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051754. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051765. Type "make", and you should get a working "u-boot.srec" file
5177 to be installed on your target system.
51786. Debug and solve any problems that might arise.
5179 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005180
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5183==============================================================
wdenkc6097192002-11-03 00:24:07 +00005184
Wolfgang Denk218ca722008-03-26 10:40:12 +01005185If you have modified U-Boot sources (for instance added a new board
5186or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005187provide feedback to the other developers. The feedback normally takes
5188the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005189official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005190
Wolfgang Denk218ca722008-03-26 10:40:12 +01005191But before you submit such a patch, please verify that your modifi-
5192cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005193the supported boards compile WITHOUT ANY compiler warnings. To do so,
5194just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005195for ALL supported system. Be warned, this will take a while. You can
5196select which (cross) compiler to use by passing a `CROSS_COMPILE'
5197environment variable to the script, i. e. to use the ELDK cross tools
5198you can type
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk2729af92004-05-03 20:45:30 +00005200 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005201
wdenk2729af92004-05-03 20:45:30 +00005202or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005205
Wolfgang Denk218ca722008-03-26 10:40:12 +01005206When using the MAKEALL script, the default behaviour is to build
5207U-Boot in the source directory. This location can be changed by
5208setting the BUILD_DIR environment variable. Also, for each target
5209built, the MAKEALL script saves two log files (<target>.ERR and
5210<target>.MAKEALL) in the <source dir>/LOG directory. This default
5211location can be changed by setting the MAKEALL_LOGDIR environment
5212variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005213
5214 export BUILD_DIR=/tmp/build
5215 export MAKEALL_LOGDIR=/tmp/log
5216 CROSS_COMPILE=ppc_8xx- MAKEALL
5217
Wolfgang Denk218ca722008-03-26 10:40:12 +01005218With the above settings build objects are saved in the /tmp/build,
5219log files are saved in the /tmp/log and the source tree remains clean
5220during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005221
5222
wdenk2729af92004-05-03 20:45:30 +00005223See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005224
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226Monitor Commands - Overview:
5227============================
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk2729af92004-05-03 20:45:30 +00005229go - start application at address 'addr'
5230run - run commands in an environment variable
5231bootm - boot application image from memory
5232bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005233bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005234tftpboot- boot image via network using TFTP protocol
5235 and env variables "ipaddr" and "serverip"
5236 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005237tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005238rarpboot- boot image via network using RARP/TFTP protocol
5239diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5240loads - load S-Record file over serial line
5241loadb - load binary file over serial line (kermit mode)
5242md - memory display
5243mm - memory modify (auto-incrementing)
5244nm - memory modify (constant address)
5245mw - memory write (fill)
5246cp - memory copy
5247cmp - memory compare
5248crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005249i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005250sspi - SPI utility commands
5251base - print or set address offset
5252printenv- print environment variables
5253setenv - set environment variables
5254saveenv - save environment variables to persistent storage
5255protect - enable or disable FLASH write protection
5256erase - erase FLASH memory
5257flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005258nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005259bdinfo - print Board Info structure
5260iminfo - print header information for application image
5261coninfo - print console devices and informations
5262ide - IDE sub-system
5263loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005264loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005265mtest - simple RAM test
5266icache - enable or disable instruction cache
5267dcache - enable or disable data cache
5268reset - Perform RESET of the CPU
5269echo - echo args to console
5270version - print monitor version
5271help - print online help
5272? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005273
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk2729af92004-05-03 20:45:30 +00005275Monitor Commands - Detailed Description:
5276========================================
wdenkc6097192002-11-03 00:24:07 +00005277
wdenk2729af92004-05-03 20:45:30 +00005278TODO.
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk2729af92004-05-03 20:45:30 +00005280For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005281
5282
wdenk2729af92004-05-03 20:45:30 +00005283Environment Variables:
5284======================
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk2729af92004-05-03 20:45:30 +00005286U-Boot supports user configuration using Environment Variables which
5287can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk2729af92004-05-03 20:45:30 +00005289Environment Variables are set using "setenv", printed using
5290"printenv", and saved to Flash using "saveenv". Using "setenv"
5291without a value can be used to delete a variable from the
5292environment. As long as you don't save the environment you are
5293working with an in-memory copy. In case the Flash area containing the
5294environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005295
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005296Some configuration options can be set using Environment Variables.
5297
5298List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk2729af92004-05-03 20:45:30 +00005302 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk2729af92004-05-03 20:45:30 +00005304 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk2729af92004-05-03 20:45:30 +00005306 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005309
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005310 bootm_low - Memory range available for image processing in the bootm
5311 command can be restricted. This variable is given as
5312 a hexadecimal number and defines lowest address allowed
5313 for use by the bootm command. See also "bootm_size"
5314 environment variable. Address defined by "bootm_low" is
5315 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005316 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5317 bootm_mapsize.
5318
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005319 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005320 This variable is given as a hexadecimal number and it
5321 defines the size of the memory region starting at base
5322 address bootm_low that is accessible by the Linux kernel
5323 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5324 as the default value if it is defined, and bootm_size is
5325 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005326
5327 bootm_size - Memory range available for image processing in the bootm
5328 command can be restricted. This variable is given as
5329 a hexadecimal number and defines the size of the region
5330 allowed for use by the bootm command. See also "bootm_low"
5331 environment variable.
5332
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005333 updatefile - Location of the software update file on a TFTP server, used
5334 by the automatic software update feature. Please refer to
5335 documentation in doc/README.update for more details.
5336
wdenk2729af92004-05-03 20:45:30 +00005337 autoload - if set to "no" (any string beginning with 'n'),
5338 "bootp" will just load perform a lookup of the
5339 configuration from the BOOTP server, but not try to
5340 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk2729af92004-05-03 20:45:30 +00005342 autostart - if set to "yes", an image loaded using the "bootp",
5343 "rarpboot", "tftpboot" or "diskboot" commands will
5344 be automatically started (by internally calling
5345 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk2729af92004-05-03 20:45:30 +00005347 If set to "no", a standalone image passed to the
5348 "bootm" command will be copied to the load address
5349 (and eventually uncompressed), but NOT be started.
5350 This can be used to load and uncompress arbitrary
5351 data.
wdenkc6097192002-11-03 00:24:07 +00005352
David A. Longa28afca2011-07-09 16:40:19 -04005353 fdt_high - if set this restricts the maximum address that the
5354 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005355 For example, if you have a system with 1 GB memory
5356 at physical address 0x10000000, while Linux kernel
5357 only recognizes the first 704 MB as low memory, you
5358 may need to set fdt_high as 0x3C000000 to have the
5359 device tree blob be copied to the maximum address
5360 of the 704 MB low memory, so that Linux kernel can
5361 access it during the boot procedure.
5362
David A. Longa28afca2011-07-09 16:40:19 -04005363 If this is set to the special value 0xFFFFFFFF then
5364 the fdt will not be copied at all on boot. For this
5365 to work it must reside in writable memory, have
5366 sufficient padding on the end of it for u-boot to
5367 add the information it needs into it, and the memory
5368 must be accessible by the kernel.
5369
Simon Glasseea63e02011-10-24 19:15:34 +00005370 fdtcontroladdr- if set this is the address of the control flattened
5371 device tree used by U-Boot when CONFIG_OF_CONTROL is
5372 defined.
5373
wdenk17ea1172004-06-06 21:51:03 +00005374 i2cfast - (PPC405GP|PPC405EP only)
5375 if set to 'y' configures Linux I2C driver for fast
5376 mode (400kHZ). This environment variable is used in
5377 initialization code. So, for changes to be effective
5378 it must be saved and board must be reset.
5379
wdenk2729af92004-05-03 20:45:30 +00005380 initrd_high - restrict positioning of initrd images:
5381 If this variable is not set, initrd images will be
5382 copied to the highest possible address in RAM; this
5383 is usually what you want since it allows for
5384 maximum initrd size. If for some reason you want to
5385 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005386 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005387 variable to a value of "no" or "off" or "0".
5388 Alternatively, you can set it to a maximum upper
5389 address to use (U-Boot will still check that it
5390 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392 For instance, when you have a system with 16 MB
5393 RAM, and want to reserve 4 MB from use by Linux,
5394 you can do this by adding "mem=12M" to the value of
5395 the "bootargs" variable. However, now you must make
5396 sure that the initrd image is placed in the first
5397 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005398
wdenk2729af92004-05-03 20:45:30 +00005399 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401 If you set initrd_high to 0xFFFFFFFF, this is an
5402 indication to U-Boot that all addresses are legal
5403 for the Linux kernel, including addresses in flash
5404 memory. In this case U-Boot will NOT COPY the
5405 ramdisk at all. This may be useful to reduce the
5406 boot time on your system, but requires that this
5407 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005408
wdenk2729af92004-05-03 20:45:30 +00005409 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk2729af92004-05-03 20:45:30 +00005411 loadaddr - Default load address for commands like "bootp",
5412 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005417
wdenk2729af92004-05-03 20:45:30 +00005418 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk2729af92004-05-03 20:45:30 +00005420 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk2729af92004-05-03 20:45:30 +00005422 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005423
Mike Frysingere2a53452011-10-02 10:01:27 +00005424 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005425
Mike Frysingere2a53452011-10-02 10:01:27 +00005426 ethact - controls which interface is currently active.
5427 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005428
Heiko Schocher48690d82010-07-20 17:45:02 +02005429 => setenv ethact FEC
5430 => ping 192.168.0.1 # traffic sent on FEC
5431 => setenv ethact SCC
5432 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005433
Matthias Fuchse1692572008-01-17 07:45:05 +01005434 ethrotate - When set to "no" U-Boot does not go through all
5435 available network interfaces.
5436 It just stays at the currently selected interface.
5437
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005438 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005439 either succeed or fail without retrying.
5440 When set to "once" the network operation will
5441 fail when all the available network interfaces
5442 are tried once without success.
5443 Useful on scripts which control the retry operation
5444 themselves.
wdenkc6097192002-11-03 00:24:07 +00005445
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005446 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005447
Simon Glass8d51aac2013-07-16 20:10:00 -07005448 silent_linux - If set then linux will be told to boot silently, by
5449 changing the console to be empty. If "yes" it will be
5450 made silent. If "no" it will not be made silent. If
5451 unset, then it will be made silent if the U-Boot console
5452 is silent.
5453
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005454 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005455 UDP source port.
5456
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005457 tftpdstport - If this is set, the value is used for TFTP's UDP
5458 destination port instead of the Well Know Port 69.
5459
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005460 tftpblocksize - Block size to use for TFTP transfers; if not set,
5461 we use the TFTP server's default block size
5462
5463 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5464 seconds, minimum value is 1000 = 1 second). Defines
5465 when a packet is considered to be lost so it has to
5466 be retransmitted. The default is 5000 = 5 seconds.
5467 Lowering this value may make downloads succeed
5468 faster in networks with high packet loss rates or
5469 with unreliable TFTP servers.
5470
5471 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005472 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005473 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005474
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005475The following image location variables contain the location of images
5476used in booting. The "Image" column gives the role of the image and is
5477not an environment variable name. The other columns are environment
5478variable names. "File Name" gives the name of the file on a TFTP
5479server, "RAM Address" gives the location in RAM the image will be
5480loaded to, and "Flash Location" gives the image's address in NOR
5481flash or offset in NAND flash.
5482
5483*Note* - these variables don't have to be defined for all boards, some
5484boards currenlty use other variables for these purposes, and some
5485boards use these variables for other purposes.
5486
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005487Image File Name RAM Address Flash Location
5488----- --------- ----------- --------------
5489u-boot u-boot u-boot_addr_r u-boot_addr
5490Linux kernel bootfile kernel_addr_r kernel_addr
5491device tree blob fdtfile fdt_addr_r fdt_addr
5492ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005493
wdenk2729af92004-05-03 20:45:30 +00005494The following environment variables may be used and automatically
5495updated by the network boot commands ("bootp" and "rarpboot"),
5496depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005497
wdenk2729af92004-05-03 20:45:30 +00005498 bootfile - see above
5499 dnsip - IP address of your Domain Name Server
5500 dnsip2 - IP address of your secondary Domain Name Server
5501 gatewayip - IP address of the Gateway (Router) to use
5502 hostname - Target hostname
5503 ipaddr - see above
5504 netmask - Subnet Mask
5505 rootpath - Pathname of the root filesystem on the NFS server
5506 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005507
wdenka3d991b2004-04-15 21:48:45 +00005508
wdenk2729af92004-05-03 20:45:30 +00005509There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk2729af92004-05-03 20:45:30 +00005511 serial# - contains hardware identification information such
5512 as type string and/or serial number
5513 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005514
wdenk2729af92004-05-03 20:45:30 +00005515These variables can be set only once (usually during manufacturing of
5516the board). U-Boot refuses to delete or overwrite these variables
5517once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005518
5519
wdenk2729af92004-05-03 20:45:30 +00005520Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005521
wdenk2729af92004-05-03 20:45:30 +00005522 ver - Contains the U-Boot version string as printed
5523 with the "version" command. This variable is
5524 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005525
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk2729af92004-05-03 20:45:30 +00005527Please note that changes to some configuration parameters may take
5528only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005529
stroesec1551ea2003-04-04 15:53:41 +00005530
Joe Hershberger170ab112012-12-11 22:16:24 -06005531Callback functions for environment variables:
5532---------------------------------------------
5533
5534For some environment variables, the behavior of u-boot needs to change
5535when their values are changed. This functionailty allows functions to
5536be associated with arbitrary variables. On creation, overwrite, or
5537deletion, the callback will provide the opportunity for some side
5538effect to happen or for the change to be rejected.
5539
5540The callbacks are named and associated with a function using the
5541U_BOOT_ENV_CALLBACK macro in your board or driver code.
5542
5543These callbacks are associated with variables in one of two ways. The
5544static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5545in the board configuration to a string that defines a list of
5546associations. The list must be in the following format:
5547
5548 entry = variable_name[:callback_name]
5549 list = entry[,list]
5550
5551If the callback name is not specified, then the callback is deleted.
5552Spaces are also allowed anywhere in the list.
5553
5554Callbacks can also be associated by defining the ".callbacks" variable
5555with the same list format above. Any association in ".callbacks" will
5556override any association in the static list. You can define
5557CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5558".callbacks" envirnoment variable in the default or embedded environment.
5559
5560
wdenk2729af92004-05-03 20:45:30 +00005561Command Line Parsing:
5562=====================
stroesec1551ea2003-04-04 15:53:41 +00005563
wdenk2729af92004-05-03 20:45:30 +00005564There are two different command line parsers available with U-Boot:
5565the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005566
wdenk2729af92004-05-03 20:45:30 +00005567Old, simple command line parser:
5568--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk2729af92004-05-03 20:45:30 +00005570- supports environment variables (through setenv / saveenv commands)
5571- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005572- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005573- special characters ('$', ';') can be escaped by prefixing with '\',
5574 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005575 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005576- You can also escape text by enclosing in single apostrophes, for example:
5577 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk2729af92004-05-03 20:45:30 +00005579Hush shell:
5580-----------
wdenkf07771c2003-05-28 08:06:31 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582- similar to Bourne shell, with control structures like
5583 if...then...else...fi, for...do...done; while...do...done,
5584 until...do...done, ...
5585- supports environment ("global") variables (through setenv / saveenv
5586 commands) and local shell variables (through standard shell syntax
5587 "name=value"); only environment variables can be used with "run"
5588 command
wdenkf07771c2003-05-28 08:06:31 +00005589
wdenk2729af92004-05-03 20:45:30 +00005590General rules:
5591--------------
wdenkf07771c2003-05-28 08:06:31 +00005592
wdenk2729af92004-05-03 20:45:30 +00005593(1) If a command line (or an environment variable executed by a "run"
5594 command) contains several commands separated by semicolon, and
5595 one of these commands fails, then the remaining commands will be
5596 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005597
wdenk2729af92004-05-03 20:45:30 +00005598(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005599 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005600 command will cause "run" to terminate, i. e. the remaining
5601 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005602
wdenk2729af92004-05-03 20:45:30 +00005603Note for Redundant Ethernet Interfaces:
5604=======================================
wdenkf07771c2003-05-28 08:06:31 +00005605
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005606Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005607such configurations and is capable of automatic selection of a
5608"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005609
wdenk2729af92004-05-03 20:45:30 +00005610Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5611MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5612"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005613
wdenk2729af92004-05-03 20:45:30 +00005614If the network interface stores some valid MAC address (for instance
5615in SROM), this is used as default address if there is NO correspon-
5616ding setting in the environment; if the corresponding environment
5617variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005618
wdenk2729af92004-05-03 20:45:30 +00005619o If the SROM has a valid MAC address, and there is no address in the
5620 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk2729af92004-05-03 20:45:30 +00005622o If there is no valid address in the SROM, and a definition in the
5623 environment exists, then the value from the environment variable is
5624 used.
wdenkc6097192002-11-03 00:24:07 +00005625
wdenk2729af92004-05-03 20:45:30 +00005626o If both the SROM and the environment contain a MAC address, and
5627 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk2729af92004-05-03 20:45:30 +00005629o If both the SROM and the environment contain a MAC address, and the
5630 addresses differ, the value from the environment is used and a
5631 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk2729af92004-05-03 20:45:30 +00005633o If neither SROM nor the environment contain a MAC address, an error
5634 is raised.
wdenkc6097192002-11-03 00:24:07 +00005635
Ben Warrenecee9322010-04-26 11:11:46 -07005636If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005637will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005638may be skipped by setting the appropriate 'ethmacskip' environment variable.
5639The naming convention is as follows:
5640"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642Image Formats:
5643==============
wdenkc6097192002-11-03 00:24:07 +00005644
Marian Balakowicz3310c542008-03-12 12:13:13 +01005645U-Boot is capable of booting (and performing other auxiliary operations on)
5646images in two formats:
5647
5648New uImage format (FIT)
5649-----------------------
5650
5651Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5652to Flattened Device Tree). It allows the use of images with multiple
5653components (several kernels, ramdisks, etc.), with contents protected by
5654SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5655
5656
5657Old uImage format
5658-----------------
5659
5660Old image format is based on binary files which can be basically anything,
5661preceded by a special header; see the definitions in include/image.h for
5662details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5665 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005666 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5667 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5668 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005669* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005670 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5671 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005672* Compression Type (uncompressed, gzip, bzip2)
5673* Load Address
5674* Entry Point
5675* Image Name
5676* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678The header is marked by a special Magic Number, and both the header
5679and the data portions of the image are secured against corruption by
5680CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005681
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk2729af92004-05-03 20:45:30 +00005683Linux Support:
5684==============
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686Although U-Boot should support any OS or standalone application
5687easily, the main focus has always been on Linux during the design of
5688U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005689
wdenk2729af92004-05-03 20:45:30 +00005690U-Boot includes many features that so far have been part of some
5691special "boot loader" code within the Linux kernel. Also, any
5692"initrd" images to be used are no longer part of one big Linux image;
5693instead, kernel and "initrd" are separate images. This implementation
5694serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk2729af92004-05-03 20:45:30 +00005696- the same features can be used for other OS or standalone
5697 applications (for instance: using compressed images to reduce the
5698 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk2729af92004-05-03 20:45:30 +00005700- it becomes much easier to port new Linux kernel versions because
5701 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703- the same Linux kernel image can now be used with different "initrd"
5704 images; of course this also means that different kernel images can
5705 be run with the same "initrd". This makes testing easier (you don't
5706 have to build a new "zImage.initrd" Linux image when you just
5707 change a file in your "initrd"). Also, a field-upgrade of the
5708 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005709
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711Linux HOWTO:
5712============
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714Porting Linux to U-Boot based systems:
5715---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk2729af92004-05-03 20:45:30 +00005717U-Boot cannot save you from doing all the necessary modifications to
5718configure the Linux device drivers for use with your target hardware
5719(no, we don't intend to provide a full virtual machine interface to
5720Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005721
Stefan Roesea47a12b2010-04-15 16:07:28 +02005722But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724Just make sure your machine specific header file (for instance
5725include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005726Information structure as we define in include/asm-<arch>/u-boot.h,
5727and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005728as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005729
Simon Glass2eb31b12014-06-11 23:29:46 -06005730Note that U-Boot now has a driver model, a unified model for drivers.
5731If you are adding a new driver, plumb it into driver model. If there
5732is no uclass available, you are encouraged to create one. See
5733doc/driver-model.
5734
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736Configuring the Linux kernel:
5737-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739No specific requirements for U-Boot. Make sure you have some root
5740device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk2729af92004-05-03 20:45:30 +00005743Building a Linux Image:
5744-----------------------
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk2729af92004-05-03 20:45:30 +00005746With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5747not used. If you use recent kernel source, a new build target
5748"uImage" will exist which automatically builds an image usable by
5749U-Boot. Most older kernels also have support for a "pImage" target,
5750which was introduced for our predecessor project PPCBoot and uses a
5751100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk2729af92004-05-03 20:45:30 +00005753Example:
wdenkc6097192002-11-03 00:24:07 +00005754
Holger Freytherab584d62014-08-04 09:26:05 +02005755 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005756 make oldconfig
5757 make dep
5758 make uImage
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk2729af92004-05-03 20:45:30 +00005760The "uImage" build target uses a special tool (in 'tools/mkimage') to
5761encapsulate a compressed Linux kernel image with header information,
5762CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk2729af92004-05-03 20:45:30 +00005766* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768 ${CROSS_COMPILE}-objcopy -O binary \
5769 -R .note -R .comment \
5770 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk2729af92004-05-03 20:45:30 +00005772* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk2729af92004-05-03 20:45:30 +00005774 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk2729af92004-05-03 20:45:30 +00005776* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005777
wdenk2729af92004-05-03 20:45:30 +00005778 mkimage -A ppc -O linux -T kernel -C gzip \
5779 -a 0 -e 0 -n "Linux Kernel Image" \
5780 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005781
wdenk24ee89b2002-11-03 17:56:27 +00005782
wdenk2729af92004-05-03 20:45:30 +00005783The "mkimage" tool can also be used to create ramdisk images for use
5784with U-Boot, either separated from the Linux kernel image, or
5785combined into one file. "mkimage" encapsulates the images with a 64
5786byte header containing information about target architecture,
5787operating system, image type, compression method, entry points, time
5788stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005789
wdenk2729af92004-05-03 20:45:30 +00005790"mkimage" can be called in two ways: to verify existing images and
5791print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005792
wdenk2729af92004-05-03 20:45:30 +00005793In the first form (with "-l" option) mkimage lists the information
5794contained in the header of an existing U-Boot image; this includes
5795checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005796
wdenk2729af92004-05-03 20:45:30 +00005797 tools/mkimage -l image
5798 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800The second form (with "-d" option) is used to build a U-Boot image
5801from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5804 -n name -d data_file image
5805 -A ==> set architecture to 'arch'
5806 -O ==> set operating system to 'os'
5807 -T ==> set image type to 'type'
5808 -C ==> set compression type 'comp'
5809 -a ==> set load address to 'addr' (hex)
5810 -e ==> set entry point to 'ep' (hex)
5811 -n ==> set image name to 'name'
5812 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005813
wdenk69459792004-05-29 16:53:29 +00005814Right now, all Linux kernels for PowerPC systems use the same load
5815address (0x00000000), but the entry point address depends on the
5816kernel version:
wdenkc6097192002-11-03 00:24:07 +00005817
wdenk2729af92004-05-03 20:45:30 +00005818- 2.2.x kernels have the entry point at 0x0000000C,
5819- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005820
wdenk2729af92004-05-03 20:45:30 +00005821So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005822
wdenk2729af92004-05-03 20:45:30 +00005823 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5824 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005825 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005826 > examples/uImage.TQM850L
5827 Image Name: 2.4.4 kernel for TQM850L
5828 Created: Wed Jul 19 02:34:59 2000
5829 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5830 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5831 Load Address: 0x00000000
5832 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk2729af92004-05-03 20:45:30 +00005834To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk2729af92004-05-03 20:45:30 +00005836 -> tools/mkimage -l examples/uImage.TQM850L
5837 Image Name: 2.4.4 kernel for TQM850L
5838 Created: Wed Jul 19 02:34:59 2000
5839 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5840 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5841 Load Address: 0x00000000
5842 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk2729af92004-05-03 20:45:30 +00005844NOTE: for embedded systems where boot time is critical you can trade
5845speed for memory and install an UNCOMPRESSED image instead: this
5846needs more space in Flash, but boots much faster since it does not
5847need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005848
Stefan Roesea47a12b2010-04-15 16:07:28 +02005849 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005850 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5851 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005852 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005853 > examples/uImage.TQM850L-uncompressed
5854 Image Name: 2.4.4 kernel for TQM850L
5855 Created: Wed Jul 19 02:34:59 2000
5856 Image Type: PowerPC Linux Kernel Image (uncompressed)
5857 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5858 Load Address: 0x00000000
5859 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005860
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5863when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005864
wdenk2729af92004-05-03 20:45:30 +00005865 -> tools/mkimage -n 'Simple Ramdisk Image' \
5866 > -A ppc -O linux -T ramdisk -C gzip \
5867 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5868 Image Name: Simple Ramdisk Image
5869 Created: Wed Jan 12 14:01:50 2000
5870 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5871 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5872 Load Address: 0x00000000
5873 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005874
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005875The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5876option performs the converse operation of the mkimage's second form (the "-d"
5877option). Given an image built by mkimage, the dumpimage extracts a "data file"
5878from the image:
5879
5880 tools/dumpimage -i image -p position data_file
5881 -i ==> extract from the 'image' a specific 'data_file', \
5882 indexed by 'position'
5883
wdenkdb01a2e2004-04-15 23:14:49 +00005884
wdenk2729af92004-05-03 20:45:30 +00005885Installing a Linux Image:
5886-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888To downloading a U-Boot image over the serial (console) interface,
5889you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005890
wdenk2729af92004-05-03 20:45:30 +00005891 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893The 'objcopy' does not understand the information in the U-Boot
5894image header, so the resulting S-Record file will be relative to
5895address 0x00000000. To load it to a given address, you need to
5896specify the target address as 'offset' parameter with the 'loads'
5897command.
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk2729af92004-05-03 20:45:30 +00005899Example: install the image to address 0x40100000 (which on the
5900TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk2729af92004-05-03 20:45:30 +00005902 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk2729af92004-05-03 20:45:30 +00005904 .......... done
5905 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk2729af92004-05-03 20:45:30 +00005907 => loads 40100000
5908 ## Ready for S-Record download ...
5909 ~>examples/image.srec
5910 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5911 ...
5912 15989 15990 15991 15992
5913 [file transfer complete]
5914 [connected]
5915 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005916
5917
wdenk2729af92004-05-03 20:45:30 +00005918You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005919this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005920corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk2729af92004-05-03 20:45:30 +00005922 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk2729af92004-05-03 20:45:30 +00005924 ## Checking Image at 40100000 ...
5925 Image Name: 2.2.13 for initrd on TQM850L
5926 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5927 Data Size: 335725 Bytes = 327 kB = 0 MB
5928 Load Address: 00000000
5929 Entry Point: 0000000c
5930 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005931
5932
wdenk2729af92004-05-03 20:45:30 +00005933Boot Linux:
5934-----------
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk2729af92004-05-03 20:45:30 +00005936The "bootm" command is used to boot an application that is stored in
5937memory (RAM or Flash). In case of a Linux kernel image, the contents
5938of the "bootargs" environment variable is passed to the kernel as
5939parameters. You can check and modify this variable using the
5940"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005941
5942
wdenk2729af92004-05-03 20:45:30 +00005943 => printenv bootargs
5944 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005945
wdenk2729af92004-05-03 20:45:30 +00005946 => 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 +00005947
wdenk2729af92004-05-03 20:45:30 +00005948 => printenv bootargs
5949 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 +00005950
wdenk2729af92004-05-03 20:45:30 +00005951 => bootm 40020000
5952 ## Booting Linux kernel at 40020000 ...
5953 Image Name: 2.2.13 for NFS on TQM850L
5954 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5955 Data Size: 381681 Bytes = 372 kB = 0 MB
5956 Load Address: 00000000
5957 Entry Point: 0000000c
5958 Verifying Checksum ... OK
5959 Uncompressing Kernel Image ... OK
5960 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
5961 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5962 time_init: decrementer frequency = 187500000/60
5963 Calibrating delay loop... 49.77 BogoMIPS
5964 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5965 ...
wdenkc6097192002-11-03 00:24:07 +00005966
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005967If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005968the memory addresses of both the kernel and the initrd image (PPBCOOT
5969format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk2729af92004-05-03 20:45:30 +00005971 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005972
wdenk2729af92004-05-03 20:45:30 +00005973 ## Checking Image at 40100000 ...
5974 Image Name: 2.2.13 for initrd on TQM850L
5975 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5976 Data Size: 335725 Bytes = 327 kB = 0 MB
5977 Load Address: 00000000
5978 Entry Point: 0000000c
5979 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005980
wdenk2729af92004-05-03 20:45:30 +00005981 ## Checking Image at 40200000 ...
5982 Image Name: Simple Ramdisk Image
5983 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5984 Data Size: 566530 Bytes = 553 kB = 0 MB
5985 Load Address: 00000000
5986 Entry Point: 00000000
5987 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005988
wdenk2729af92004-05-03 20:45:30 +00005989 => bootm 40100000 40200000
5990 ## Booting Linux kernel at 40100000 ...
5991 Image Name: 2.2.13 for initrd on TQM850L
5992 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5993 Data Size: 335725 Bytes = 327 kB = 0 MB
5994 Load Address: 00000000
5995 Entry Point: 0000000c
5996 Verifying Checksum ... OK
5997 Uncompressing Kernel Image ... OK
5998 ## Loading RAMDisk Image at 40200000 ...
5999 Image Name: Simple Ramdisk Image
6000 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6001 Data Size: 566530 Bytes = 553 kB = 0 MB
6002 Load Address: 00000000
6003 Entry Point: 00000000
6004 Verifying Checksum ... OK
6005 Loading Ramdisk ... OK
6006 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
6007 Boot arguments: root=/dev/ram
6008 time_init: decrementer frequency = 187500000/60
6009 Calibrating delay loop... 49.77 BogoMIPS
6010 ...
6011 RAMDISK: Compressed image found at block 0
6012 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006013
wdenk2729af92004-05-03 20:45:30 +00006014 bash#
wdenkc6097192002-11-03 00:24:07 +00006015
Matthew McClintock02677682006-06-28 10:41:37 -05006016Boot Linux and pass a flat device tree:
6017-----------
6018
6019First, U-Boot must be compiled with the appropriate defines. See the section
6020titled "Linux Kernel Interface" above for a more in depth explanation. The
6021following is an example of how to start a kernel and pass an updated
6022flat device tree:
6023
6024=> print oftaddr
6025oftaddr=0x300000
6026=> print oft
6027oft=oftrees/mpc8540ads.dtb
6028=> tftp $oftaddr $oft
6029Speed: 1000, full duplex
6030Using TSEC0 device
6031TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6032Filename 'oftrees/mpc8540ads.dtb'.
6033Load address: 0x300000
6034Loading: #
6035done
6036Bytes transferred = 4106 (100a hex)
6037=> tftp $loadaddr $bootfile
6038Speed: 1000, full duplex
6039Using TSEC0 device
6040TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6041Filename 'uImage'.
6042Load address: 0x200000
6043Loading:############
6044done
6045Bytes transferred = 1029407 (fb51f hex)
6046=> print loadaddr
6047loadaddr=200000
6048=> print oftaddr
6049oftaddr=0x300000
6050=> bootm $loadaddr - $oftaddr
6051## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006052 Image Name: Linux-2.6.17-dirty
6053 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6054 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006055 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006056 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006057 Verifying Checksum ... OK
6058 Uncompressing Kernel Image ... OK
6059Booting using flat device tree at 0x300000
6060Using MPC85xx ADS machine description
6061Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6062[snip]
6063
6064
wdenk2729af92004-05-03 20:45:30 +00006065More About U-Boot Image Types:
6066------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006067
wdenk2729af92004-05-03 20:45:30 +00006068U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006069
wdenk2729af92004-05-03 20:45:30 +00006070 "Standalone Programs" are directly runnable in the environment
6071 provided by U-Boot; it is expected that (if they behave
6072 well) you can continue to work in U-Boot after return from
6073 the Standalone Program.
6074 "OS Kernel Images" are usually images of some Embedded OS which
6075 will take over control completely. Usually these programs
6076 will install their own set of exception handlers, device
6077 drivers, set up the MMU, etc. - this means, that you cannot
6078 expect to re-enter U-Boot except by resetting the CPU.
6079 "RAMDisk Images" are more or less just data blocks, and their
6080 parameters (address, size) are passed to an OS kernel that is
6081 being started.
6082 "Multi-File Images" contain several images, typically an OS
6083 (Linux) kernel image and one or more data images like
6084 RAMDisks. This construct is useful for instance when you want
6085 to boot over the network using BOOTP etc., where the boot
6086 server provides just a single image file, but you want to get
6087 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006088
wdenk2729af92004-05-03 20:45:30 +00006089 "Multi-File Images" start with a list of image sizes, each
6090 image size (in bytes) specified by an "uint32_t" in network
6091 byte order. This list is terminated by an "(uint32_t)0".
6092 Immediately after the terminating 0 follow the images, one by
6093 one, all aligned on "uint32_t" boundaries (size rounded up to
6094 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006095
wdenk2729af92004-05-03 20:45:30 +00006096 "Firmware Images" are binary images containing firmware (like
6097 U-Boot or FPGA images) which usually will be programmed to
6098 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006099
wdenk2729af92004-05-03 20:45:30 +00006100 "Script files" are command sequences that will be executed by
6101 U-Boot's command interpreter; this feature is especially
6102 useful when you configure U-Boot to use a real shell (hush)
6103 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006104
Marek Vasut44f074c2012-03-14 21:52:45 +00006105Booting the Linux zImage:
6106-------------------------
6107
6108On some platforms, it's possible to boot Linux zImage. This is done
6109using the "bootz" command. The syntax of "bootz" command is the same
6110as the syntax of "bootm" command.
6111
Tom Rini8ac28562013-05-16 11:40:11 -04006112Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006113kernel with raw initrd images. The syntax is slightly different, the
6114address of the initrd must be augmented by it's size, in the following
6115format: "<initrd addres>:<initrd size>".
6116
wdenkc6097192002-11-03 00:24:07 +00006117
wdenk2729af92004-05-03 20:45:30 +00006118Standalone HOWTO:
6119=================
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk2729af92004-05-03 20:45:30 +00006121One of the features of U-Boot is that you can dynamically load and
6122run "standalone" applications, which can use some resources of
6123U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006124
wdenk2729af92004-05-03 20:45:30 +00006125Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006126
wdenk2729af92004-05-03 20:45:30 +00006127"Hello World" Demo:
6128-------------------
wdenkc6097192002-11-03 00:24:07 +00006129
wdenk2729af92004-05-03 20:45:30 +00006130'examples/hello_world.c' contains a small "Hello World" Demo
6131application; it is automatically compiled when you build U-Boot.
6132It's configured to run at address 0x00040004, so you can play with it
6133like that:
wdenkc6097192002-11-03 00:24:07 +00006134
wdenk2729af92004-05-03 20:45:30 +00006135 => loads
6136 ## Ready for S-Record download ...
6137 ~>examples/hello_world.srec
6138 1 2 3 4 5 6 7 8 9 10 11 ...
6139 [file transfer complete]
6140 [connected]
6141 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006142
wdenk2729af92004-05-03 20:45:30 +00006143 => go 40004 Hello World! This is a test.
6144 ## Starting application at 0x00040004 ...
6145 Hello World
6146 argc = 7
6147 argv[0] = "40004"
6148 argv[1] = "Hello"
6149 argv[2] = "World!"
6150 argv[3] = "This"
6151 argv[4] = "is"
6152 argv[5] = "a"
6153 argv[6] = "test."
6154 argv[7] = "<NULL>"
6155 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006156
wdenk2729af92004-05-03 20:45:30 +00006157 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk2729af92004-05-03 20:45:30 +00006159Another example, which demonstrates how to register a CPM interrupt
6160handler with the U-Boot code, can be found in 'examples/timer.c'.
6161Here, a CPM timer is set up to generate an interrupt every second.
6162The interrupt service routine is trivial, just printing a '.'
6163character, but this is just a demo program. The application can be
6164controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk2729af92004-05-03 20:45:30 +00006166 ? - print current values og the CPM Timer registers
6167 b - enable interrupts and start timer
6168 e - stop timer and disable interrupts
6169 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk2729af92004-05-03 20:45:30 +00006171 => loads
6172 ## Ready for S-Record download ...
6173 ~>examples/timer.srec
6174 1 2 3 4 5 6 7 8 9 10 11 ...
6175 [file transfer complete]
6176 [connected]
6177 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006178
wdenk2729af92004-05-03 20:45:30 +00006179 => go 40004
6180 ## Starting application at 0x00040004 ...
6181 TIMERS=0xfff00980
6182 Using timer 1
6183 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk2729af92004-05-03 20:45:30 +00006185Hit 'b':
6186 [q, b, e, ?] Set interval 1000000 us
6187 Enabling timer
6188Hit '?':
6189 [q, b, e, ?] ........
6190 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6191Hit '?':
6192 [q, b, e, ?] .
6193 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6194Hit '?':
6195 [q, b, e, ?] .
6196 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6197Hit '?':
6198 [q, b, e, ?] .
6199 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6200Hit 'e':
6201 [q, b, e, ?] ...Stopping timer
6202Hit 'q':
6203 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006204
6205
wdenk2729af92004-05-03 20:45:30 +00006206Minicom warning:
6207================
wdenk85ec0bc2003-03-31 16:34:49 +00006208
wdenk2729af92004-05-03 20:45:30 +00006209Over time, many people have reported problems when trying to use the
6210"minicom" terminal emulation program for serial download. I (wd)
6211consider minicom to be broken, and recommend not to use it. Under
6212Unix, I recommend to use C-Kermit for general purpose use (and
6213especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006214use "cu" for S-Record download ("loads" command). See
6215http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6216for help with kermit.
6217
wdenk85ec0bc2003-03-31 16:34:49 +00006218
wdenk2729af92004-05-03 20:45:30 +00006219Nevertheless, if you absolutely want to use it try adding this
6220configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006221
wdenk2729af92004-05-03 20:45:30 +00006222 Name Program Name U/D FullScr IO-Red. Multi
6223 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6224 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006225
6226
wdenk2729af92004-05-03 20:45:30 +00006227NetBSD Notes:
6228=============
wdenkc6097192002-11-03 00:24:07 +00006229
wdenk2729af92004-05-03 20:45:30 +00006230Starting at version 0.9.2, U-Boot supports NetBSD both as host
6231(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006232
wdenk2729af92004-05-03 20:45:30 +00006233Building requires a cross environment; it is known to work on
6234NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6235need gmake since the Makefiles are not compatible with BSD make).
6236Note that the cross-powerpc package does not install include files;
6237attempting to build U-Boot will fail because <machine/ansi.h> is
6238missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006239
wdenk2729af92004-05-03 20:45:30 +00006240 # cd /usr/pkg/cross/powerpc-netbsd/include
6241 # mkdir powerpc
6242 # ln -s powerpc machine
6243 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6244 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006245
wdenk2729af92004-05-03 20:45:30 +00006246Native builds *don't* work due to incompatibilities between native
6247and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006248
wdenk2729af92004-05-03 20:45:30 +00006249Booting assumes that (the first part of) the image booted is a
6250stage-2 loader which in turn loads and then invokes the kernel
6251proper. Loader sources will eventually appear in the NetBSD source
6252tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006253meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006254
6255
wdenk2729af92004-05-03 20:45:30 +00006256Implementation Internals:
6257=========================
wdenkc6097192002-11-03 00:24:07 +00006258
wdenk2729af92004-05-03 20:45:30 +00006259The following is not intended to be a complete description of every
6260implementation detail. However, it should help to understand the
6261inner workings of U-Boot and make it easier to port it to custom
6262hardware.
wdenkc6097192002-11-03 00:24:07 +00006263
6264
wdenk2729af92004-05-03 20:45:30 +00006265Initial Stack, Global Data:
6266---------------------------
wdenkc6097192002-11-03 00:24:07 +00006267
wdenk2729af92004-05-03 20:45:30 +00006268The implementation of U-Boot is complicated by the fact that U-Boot
6269starts running out of ROM (flash memory), usually without access to
6270system RAM (because the memory controller is not initialized yet).
6271This means that we don't have writable Data or BSS segments, and BSS
6272is not initialized as zero. To be able to get a C environment working
6273at all, we have to allocate at least a minimal stack. Implementation
6274options for this are defined and restricted by the CPU used: Some CPU
6275models provide on-chip memory (like the IMMR area on MPC8xx and
6276MPC826x processors), on others (parts of) the data cache can be
6277locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006278
Wolfgang Denk218ca722008-03-26 10:40:12 +01006279 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006280 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006281
wdenk2729af92004-05-03 20:45:30 +00006282 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6283 From: "Chris Hallinan" <clh@net1plus.com>
6284 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6285 ...
wdenk43d96162003-03-06 00:02:04 +00006286
wdenk2729af92004-05-03 20:45:30 +00006287 Correct me if I'm wrong, folks, but the way I understand it
6288 is this: Using DCACHE as initial RAM for Stack, etc, does not
6289 require any physical RAM backing up the cache. The cleverness
6290 is that the cache is being used as a temporary supply of
6291 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006292 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006293 can see how this works by studying the cache architecture and
6294 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006295
wdenk2729af92004-05-03 20:45:30 +00006296 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6297 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006298 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006299 option should work for you. Using CS 4 should be fine if your
6300 board designers haven't used it for something that would
6301 cause you grief during the initial boot! It is frequently not
6302 used.
wdenk43d96162003-03-06 00:02:04 +00006303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006304 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006305 with your processor/board/system design. The default value
6306 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006307 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006308 than your SDRAM module. If you have a 64MB SDRAM module, set
6309 it above 400_0000. Just make sure your board has no resources
6310 that are supposed to respond to that address! That code in
6311 start.S has been around a while and should work as is when
6312 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006313
wdenk2729af92004-05-03 20:45:30 +00006314 -Chris Hallinan
6315 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006316
wdenk2729af92004-05-03 20:45:30 +00006317It is essential to remember this, since it has some impact on the C
6318code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006319
wdenk2729af92004-05-03 20:45:30 +00006320* Initialized global data (data segment) is read-only. Do not attempt
6321 to write it.
wdenkc6097192002-11-03 00:24:07 +00006322
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006323* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00006324 as zero data - BSS segment) at all - this is undefined, initiali-
6325 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006326
wdenk2729af92004-05-03 20:45:30 +00006327* Stack space is very limited. Avoid big data buffers or things like
6328 that.
wdenkc6097192002-11-03 00:24:07 +00006329
wdenk2729af92004-05-03 20:45:30 +00006330Having only the stack as writable memory limits means we cannot use
6331normal global data to share information beween the code. But it
6332turned out that the implementation of U-Boot can be greatly
6333simplified by making a global data structure (gd_t) available to all
6334functions. We could pass a pointer to this data as argument to _all_
6335functions, but this would bloat the code. Instead we use a feature of
6336the GCC compiler (Global Register Variables) to share the data: we
6337place a pointer (gd) to the global data into a register which we
6338reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006339
wdenk2729af92004-05-03 20:45:30 +00006340When choosing a register for such a purpose we are restricted by the
6341relevant (E)ABI specifications for the current architecture, and by
6342GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006343
wdenk2729af92004-05-03 20:45:30 +00006344For PowerPC, the following registers have specific use:
6345 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006346 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006347 R3-R4: parameter passing and return values
6348 R5-R10: parameter passing
6349 R13: small data area pointer
6350 R30: GOT pointer
6351 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006352
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006353 (U-Boot also uses R12 as internal GOT pointer. r12
6354 is a volatile register so r12 needs to be reset when
6355 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006356
Wolfgang Denke7670f62008-02-14 22:43:22 +01006357 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006358
wdenk2729af92004-05-03 20:45:30 +00006359 Note: on PPC, we could use a static initializer (since the
6360 address of the global data structure is known at compile time),
6361 but it turned out that reserving a register results in somewhat
6362 smaller code - although the code savings are not that big (on
6363 average for all boards 752 bytes for the whole U-Boot image,
6364 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006365
Robin Getzc4db3352009-08-17 15:23:02 +00006366On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006367 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6368
Robin Getzc4db3352009-08-17 15:23:02 +00006369 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006370
wdenk2729af92004-05-03 20:45:30 +00006371On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006372
wdenk2729af92004-05-03 20:45:30 +00006373 R0: function argument word/integer result
6374 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006375 R9: platform specific
6376 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006377 R11: argument (frame) pointer
6378 R12: temporary workspace
6379 R13: stack pointer
6380 R14: link register
6381 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006382
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006383 ==> U-Boot will use R9 to hold a pointer to the global data
6384
6385 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006386
Thomas Chou0df01fd32010-05-21 11:08:03 +08006387On Nios II, the ABI is documented here:
6388 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6389
6390 ==> U-Boot will use gp to hold a pointer to the global data
6391
6392 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6393 to access small data sections, so gp is free.
6394
Macpaul Linafc1ce82011-10-19 20:41:11 +00006395On NDS32, the following registers are used:
6396
6397 R0-R1: argument/return
6398 R2-R5: argument
6399 R15: temporary register for assembler
6400 R16: trampoline register
6401 R28: frame pointer (FP)
6402 R29: global pointer (GP)
6403 R30: link register (LP)
6404 R31: stack pointer (SP)
6405 PC: program counter (PC)
6406
6407 ==> U-Boot will use R10 to hold a pointer to the global data
6408
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006409NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6410or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006411
wdenk2729af92004-05-03 20:45:30 +00006412Memory Management:
6413------------------
wdenkc6097192002-11-03 00:24:07 +00006414
wdenk2729af92004-05-03 20:45:30 +00006415U-Boot runs in system state and uses physical addresses, i.e. the
6416MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006417
wdenk2729af92004-05-03 20:45:30 +00006418The available memory is mapped to fixed addresses using the memory
6419controller. In this process, a contiguous block is formed for each
6420memory type (Flash, SDRAM, SRAM), even when it consists of several
6421physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006422
wdenk2729af92004-05-03 20:45:30 +00006423U-Boot is installed in the first 128 kB of the first Flash bank (on
6424TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6425booting and sizing and initializing DRAM, the code relocates itself
6426to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006427memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006428configuration setting]. Below that, a structure with global Board
6429Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006430
wdenk2729af92004-05-03 20:45:30 +00006431Additionally, some exception handler code is copied to the low 8 kB
6432of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006433
wdenk2729af92004-05-03 20:45:30 +00006434So a typical memory configuration with 16 MB of DRAM could look like
6435this:
wdenkc6097192002-11-03 00:24:07 +00006436
wdenk2729af92004-05-03 20:45:30 +00006437 0x0000 0000 Exception Vector code
6438 :
6439 0x0000 1FFF
6440 0x0000 2000 Free for Application Use
6441 :
6442 :
wdenkc6097192002-11-03 00:24:07 +00006443
wdenk2729af92004-05-03 20:45:30 +00006444 :
6445 :
6446 0x00FB FF20 Monitor Stack (Growing downward)
6447 0x00FB FFAC Board Info Data and permanent copy of global data
6448 0x00FC 0000 Malloc Arena
6449 :
6450 0x00FD FFFF
6451 0x00FE 0000 RAM Copy of Monitor Code
6452 ... eventually: LCD or video framebuffer
6453 ... eventually: pRAM (Protected RAM - unchanged by reset)
6454 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006455
6456
wdenk2729af92004-05-03 20:45:30 +00006457System Initialization:
6458----------------------
wdenkc6097192002-11-03 00:24:07 +00006459
wdenk2729af92004-05-03 20:45:30 +00006460In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006461(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00006462configuration for CS0# this is a mirror of the onboard Flash memory.
6463To be able to re-map memory U-Boot then jumps to its link address.
6464To be able to implement the initialization code in C, a (small!)
6465initial stack is set up in the internal Dual Ported RAM (in case CPUs
6466which provide such a feature like MPC8xx or MPC8260), or in a locked
6467part of the data cache. After that, U-Boot initializes the CPU core,
6468the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006469
wdenk2729af92004-05-03 20:45:30 +00006470Next, all (potentially) available memory banks are mapped using a
6471preliminary mapping. For example, we put them on 512 MB boundaries
6472(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6473on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6474programmed for SDRAM access. Using the temporary configuration, a
6475simple memory test is run that determines the size of the SDRAM
6476banks.
wdenkc6097192002-11-03 00:24:07 +00006477
wdenk2729af92004-05-03 20:45:30 +00006478When there is more than one SDRAM bank, and the banks are of
6479different size, the largest is mapped first. For equal size, the first
6480bank (CS2#) is mapped first. The first mapping is always for address
64810x00000000, with any additional banks following immediately to create
6482contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006483
wdenk2729af92004-05-03 20:45:30 +00006484Then, the monitor installs itself at the upper end of the SDRAM area
6485and allocates memory for use by malloc() and for the global Board
6486Info data; also, the exception vector code is copied to the low RAM
6487pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006488
wdenk2729af92004-05-03 20:45:30 +00006489Only after this relocation will you have a "normal" C environment;
6490until that you are restricted in several ways, mostly because you are
6491running from ROM, and because the code will have to be relocated to a
6492new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006493
6494
wdenk2729af92004-05-03 20:45:30 +00006495U-Boot Porting Guide:
6496----------------------
wdenkc6097192002-11-03 00:24:07 +00006497
wdenk2729af92004-05-03 20:45:30 +00006498[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6499list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006500
6501
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006502int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006503{
6504 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006505
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006506 signal(SIGALRM, no_more_time);
6507 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006508
wdenk2729af92004-05-03 20:45:30 +00006509 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006510 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006511 return 0;
6512 }
6513
wdenk2729af92004-05-03 20:45:30 +00006514 Download latest U-Boot source;
6515
Wolfgang Denk06682362008-12-30 22:56:11 +01006516 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006517
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006518 if (clueless)
6519 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006520
wdenk2729af92004-05-03 20:45:30 +00006521 while (learning) {
6522 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006523 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6524 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006525 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006526 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006527 }
wdenkc6097192002-11-03 00:24:07 +00006528
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006529 if (available_money > toLocalCurrency ($2500))
6530 Buy a BDI3000;
6531 else
wdenk2729af92004-05-03 20:45:30 +00006532 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006533
6534 if (a similar board exists) { /* hopefully... */
6535 cp -a board/<similar> board/<myboard>
6536 cp include/configs/<similar>.h include/configs/<myboard>.h
6537 } else {
6538 Create your own board support subdirectory;
6539 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006540 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006541 Edit new board/<myboard> files
6542 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006543
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006544 while (!accepted) {
6545 while (!running) {
6546 do {
6547 Add / modify source code;
6548 } until (compiles);
6549 Debug;
6550 if (clueless)
6551 email("Hi, I am having problems...");
6552 }
6553 Send patch file to the U-Boot email list;
6554 if (reasonable critiques)
6555 Incorporate improvements from email list code review;
6556 else
6557 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006558 }
wdenkc6097192002-11-03 00:24:07 +00006559
wdenk2729af92004-05-03 20:45:30 +00006560 return 0;
6561}
6562
6563void no_more_time (int sig)
6564{
6565 hire_a_guru();
6566}
wdenkc6097192002-11-03 00:24:07 +00006567
6568
wdenk2729af92004-05-03 20:45:30 +00006569Coding Standards:
6570-----------------
wdenkc6097192002-11-03 00:24:07 +00006571
wdenk2729af92004-05-03 20:45:30 +00006572All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006573coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006574"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006575
Detlev Zundel2c051652006-09-01 15:39:02 +02006576Source files originating from a different project (for example the
6577MTD subsystem) are generally exempt from these guidelines and are not
6578reformated to ease subsequent migration to newer versions of those
6579sources.
6580
6581Please note that U-Boot is implemented in C (and to some small parts in
6582Assembler); no C++ is used, so please do not use C++ style comments (//)
6583in your code.
wdenk2729af92004-05-03 20:45:30 +00006584
6585Please also stick to the following formatting rules:
6586- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006587- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006588- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006589- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006590- do not add trailing empty lines to source files
6591
6592Submissions which do not conform to the standards may be returned
6593with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006594
6595
wdenk2729af92004-05-03 20:45:30 +00006596Submitting Patches:
6597-------------------
wdenkc6097192002-11-03 00:24:07 +00006598
wdenk2729af92004-05-03 20:45:30 +00006599Since the number of patches for U-Boot is growing, we need to
6600establish some rules. Submissions which do not conform to these rules
6601may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006602
Magnus Lilja0d28f342008-08-06 19:32:33 +02006603Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006604
Wolfgang Denk06682362008-12-30 22:56:11 +01006605Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6606see http://lists.denx.de/mailman/listinfo/u-boot
6607
wdenk2729af92004-05-03 20:45:30 +00006608When you send a patch, please include the following information with
6609it:
wdenkc6097192002-11-03 00:24:07 +00006610
wdenk2729af92004-05-03 20:45:30 +00006611* For bug fixes: a description of the bug and how your patch fixes
6612 this bug. Please try to include a way of demonstrating that the
6613 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006614
wdenk2729af92004-05-03 20:45:30 +00006615* For new features: a description of the feature and your
6616 implementation.
wdenkc6097192002-11-03 00:24:07 +00006617
wdenk2729af92004-05-03 20:45:30 +00006618* A CHANGELOG entry as plaintext (separate from the patch)
6619
6620* For major contributions, your entry to the CREDITS file
6621
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006622* When you add support for a new board, don't forget to add a
6623 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006624
6625* If your patch adds new configuration options, don't forget to
6626 document these in the README file.
6627
Wolfgang Denk218ca722008-03-26 10:40:12 +01006628* The patch itself. If you are using git (which is *strongly*
6629 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006630 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006631 the U-Boot mailing list, you will avoid most of the common problems
6632 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006633
Wolfgang Denk218ca722008-03-26 10:40:12 +01006634 If you cannot use git, use "diff -purN OLD NEW". If your version of
6635 diff does not support these options, then get the latest version of
6636 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006637
Wolfgang Denk218ca722008-03-26 10:40:12 +01006638 The current directory when running this command shall be the parent
6639 directory of the U-Boot source tree (i. e. please make sure that
6640 your patch includes sufficient directory information for the
6641 affected files).
6642
6643 We prefer patches as plain text. MIME attachments are discouraged,
6644 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006645
6646* If one logical set of modifications affects or creates several
6647 files, all these changes shall be submitted in a SINGLE patch file.
6648
6649* Changesets that contain different, unrelated modifications shall be
6650 submitted as SEPARATE patches, one patch per changeset.
6651
6652
6653Notes:
6654
6655* Before sending the patch, run the MAKEALL script on your patched
6656 source tree and make sure that no errors or warnings are reported
6657 for any of the boards.
6658
6659* Keep your modifications to the necessary minimum: A patch
6660 containing several unrelated changes or arbitrary reformats will be
6661 returned with a request to re-formatting / split it.
6662
6663* If you modify existing code, make sure that your new code does not
6664 add to the memory footprint of the code ;-) Small is beautiful!
6665 When adding new features, these should compile conditionally only
6666 (using #ifdef), and the resulting code with the new feature
6667 disabled must not need more memory than the old code without your
6668 modification.
wdenk90dc6702005-05-03 14:12:25 +00006669
Wolfgang Denk06682362008-12-30 22:56:11 +01006670* Remember that there is a size limit of 100 kB per message on the
6671 u-boot mailing list. Bigger patches will be moderated. If they are
6672 reasonable and not too big, they will be acknowledged. But patches
6673 bigger than the size limit should be avoided.