blob: fefa71c0a6c5f3adf8ed437e6956227a0e502e8b [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
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass75b3c3a2014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600274
275
wdenkc6097192002-11-03 00:24:07 +0000276Configuration Options:
277----------------------
278
279Configuration depends on the combination of board and CPU type; all
280such information is kept in a configuration file
281"include/configs/<board_name>.h".
282
283Example: For a TQM823L module, all configuration settings are in
284"include/configs/TQM823L.h".
285
286
wdenk7f6c2cb2002-11-10 22:06:23 +0000287Many of the options are named exactly as the corresponding Linux
288kernel configuration options. The intention is to make it easier to
289build a config tool - later.
290
291
wdenkc6097192002-11-03 00:24:07 +0000292The following options need to be configured:
293
Kim Phillips26281142007-08-10 13:28:25 -0500294- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000295
Kim Phillips26281142007-08-10 13:28:25 -0500296- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200297
298- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100299 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000300
301- CPU Module Type: (if CONFIG_COGENT is defined)
302 Define exactly one of
303 CONFIG_CMA286_60_OLD
304--- FIXME --- not tested yet:
305 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
306 CONFIG_CMA287_23, CONFIG_CMA287_50
307
308- Motherboard Type: (if CONFIG_COGENT is defined)
309 Define exactly one of
310 CONFIG_CMA101, CONFIG_CMA102
311
312- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
313 Define one or more of
314 CONFIG_CMA302
315
316- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
317 Define one or more of
318 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200319 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000320 a "rotator" |\-/|\-/
321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
333 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000334
wdenk66ca92a2004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000342
wdenkba56f622004-02-06 23:19:44 +0000343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000349
Heiko Schocher506f3912009-03-12 07:37:15 +0100350 CONFIG_SYS_DELAYED_ICACHE
351
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
354
Kumar Gala66412c62011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000356 CONFIG_SYS_PPC64
357
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
361
Kumar Gala66412c62011-02-18 05:40:54 -0600362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala8f290842011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000373 CONFIG_SYS_PPC_E500_DEBUG_TLB
374
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
380 purpose.
381
Scott Wood33eee332012-08-14 10:14:53 +0000382 CONFIG_SYS_FSL_ERRATUM_A004510
383
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
387
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
390
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
393
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
398
399 See Freescale App Note 4493 for more information about
400 this erratum.
401
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800404 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530405
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530406 CONFIG_A008044_WORKAROUND
407 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800408 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530409
Scott Wood33eee332012-08-14 10:14:53 +0000410 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
411
412 This is the value to write into CCSR offset 0x18600
413 according to the A004510 workaround.
414
Priyanka Jain64501c62013-07-02 09:21:04 +0530415 CONFIG_SYS_FSL_DSP_DDR_ADDR
416 This value denotes start offset of DDR memory which is
417 connected exclusively to the DSP cores.
418
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530419 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
420 This value denotes start offset of M2 memory
421 which is directly connected to the DSP core.
422
Priyanka Jain64501c62013-07-02 09:21:04 +0530423 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
424 This value denotes start offset of M3 memory which is directly
425 connected to the DSP core.
426
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530427 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
428 This value denotes start offset of DSP CCSR space.
429
Priyanka Jainb1359912013-12-17 14:25:52 +0530430 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
431 Single Source Clock is clocking mode present in some of FSL SoC's.
432 In this mode, a single differential clock is used to supply
433 clocks to the sysclock, ddrclock and usbclock.
434
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530435 CONFIG_SYS_CPC_REINIT_F
436 This CONFIG is defined when the CPC is configured as SRAM at the
437 time of U-boot entry and is required to be re-initialized.
438
Tang Yuantianaade2002014-04-17 15:33:46 +0800439 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800440 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800441 supported, core will start to execute uboot when wakes up.
442
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000443- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700444 CONFIG_SYS_GENERIC_GLOBAL_DATA
445 Defines global data is initialized in generic board board_init_f().
446 If this macro is defined, global data is created and cleared in
447 generic board board_init_f(). Without this macro, architecture/board
448 should initialize global data before calling board_init_f().
449
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000450 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
451
452 Defines the endianess of the CPU. Implementation of those
453 values is arch specific.
454
York Sun5614e712013-09-30 09:22:09 -0700455 CONFIG_SYS_FSL_DDR
456 Freescale DDR driver in use. This type of DDR controller is
457 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
458 SoCs.
459
460 CONFIG_SYS_FSL_DDR_ADDR
461 Freescale DDR memory-mapped register base.
462
463 CONFIG_SYS_FSL_DDR_EMU
464 Specify emulator support for DDR. Some DDR features such as
465 deskew training are not available.
466
467 CONFIG_SYS_FSL_DDRC_GEN1
468 Freescale DDR1 controller.
469
470 CONFIG_SYS_FSL_DDRC_GEN2
471 Freescale DDR2 controller.
472
473 CONFIG_SYS_FSL_DDRC_GEN3
474 Freescale DDR3 controller.
475
York Sun34e026f2014-03-27 17:54:47 -0700476 CONFIG_SYS_FSL_DDRC_GEN4
477 Freescale DDR4 controller.
478
York Sun9ac4ffb2013-09-30 14:20:51 -0700479 CONFIG_SYS_FSL_DDRC_ARM_GEN3
480 Freescale DDR3 controller for ARM-based SoCs.
481
York Sun5614e712013-09-30 09:22:09 -0700482 CONFIG_SYS_FSL_DDR1
483 Board config to use DDR1. It can be enabled for SoCs with
484 Freescale DDR1 or DDR2 controllers, depending on the board
485 implemetation.
486
487 CONFIG_SYS_FSL_DDR2
488 Board config to use DDR2. It can be eanbeld for SoCs with
489 Freescale DDR2 or DDR3 controllers, depending on the board
490 implementation.
491
492 CONFIG_SYS_FSL_DDR3
493 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700494 Freescale DDR3 or DDR3L controllers.
495
496 CONFIG_SYS_FSL_DDR3L
497 Board config to use DDR3L. It can be enabled for SoCs with
498 DDR3L controllers.
499
500 CONFIG_SYS_FSL_DDR4
501 Board config to use DDR4. It can be enabled for SoCs with
502 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700503
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530504 CONFIG_SYS_FSL_IFC_BE
505 Defines the IFC controller register space as Big Endian
506
507 CONFIG_SYS_FSL_IFC_LE
508 Defines the IFC controller register space as Little Endian
509
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530510 CONFIG_SYS_FSL_PBL_PBI
511 It enables addition of RCW (Power on reset configuration) in built image.
512 Please refer doc/README.pblimage for more details
513
514 CONFIG_SYS_FSL_PBL_RCW
515 It adds PBI(pre-boot instructions) commands in u-boot build image.
516 PBI commands can be used to configure SoC before it starts the execution.
517 Please refer doc/README.pblimage for more details
518
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530519 CONFIG_SPL_FSL_PBL
520 It adds a target to create boot binary having SPL binary in PBI format
521 concatenated with u-boot binary.
522
York Sun4e5b1bd2014-02-10 13:59:42 -0800523 CONFIG_SYS_FSL_DDR_BE
524 Defines the DDR controller register space as Big Endian
525
526 CONFIG_SYS_FSL_DDR_LE
527 Defines the DDR controller register space as Little Endian
528
York Sun6b9e3092014-02-10 13:59:43 -0800529 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
530 Physical address from the view of DDR controllers. It is the
531 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
532 it could be different for ARM SoCs.
533
York Sun6b1e1252014-02-10 13:59:44 -0800534 CONFIG_SYS_FSL_DDR_INTLV_256B
535 DDR controller interleaving on 256-byte. This is a special
536 interleaving mode, handled by Dickens for Freescale layerscape
537 SoCs with ARM core.
538
York Sun1d71efb2014-08-01 15:51:00 -0700539 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
540 Number of controllers used as main memory.
541
542 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
543 Number of controllers used for other than main memory.
544
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530545 CONFIG_SYS_FSL_SEC_BE
546 Defines the SEC controller register space as Big Endian
547
548 CONFIG_SYS_FSL_SEC_LE
549 Defines the SEC controller register space as Little Endian
550
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100551- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200552 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553
554 Defines the Monahans run mode to oscillator
555 ratio. Valid values are 8, 16, 24, 31. The core
556 frequency is this value multiplied by 13 MHz.
557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200558 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200559
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100560 Defines the Monahans turbo mode to oscillator
561 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200562 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100563 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200564
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200565- MIPS CPU options:
566 CONFIG_SYS_INIT_SP_OFFSET
567
568 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
569 pointer. This is needed for the temporary stack before
570 relocation.
571
572 CONFIG_SYS_MIPS_CACHE_MODE
573
574 Cache operation mode for the MIPS CPU.
575 See also arch/mips/include/asm/mipsregs.h.
576 Possible values are:
577 CONF_CM_CACHABLE_NO_WA
578 CONF_CM_CACHABLE_WA
579 CONF_CM_UNCACHED
580 CONF_CM_CACHABLE_NONCOHERENT
581 CONF_CM_CACHABLE_CE
582 CONF_CM_CACHABLE_COW
583 CONF_CM_CACHABLE_CUW
584 CONF_CM_CACHABLE_ACCELERATED
585
586 CONFIG_SYS_XWAY_EBU_BOOTCFG
587
588 Special option for Lantiq XWAY SoCs for booting from NOR flash.
589 See also arch/mips/cpu/mips32/start.S.
590
591 CONFIG_XWAY_SWAP_BYTES
592
593 Enable compilation of tools/xway-swap-bytes needed for Lantiq
594 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
595 be swapped if a flash programmer is used.
596
Christian Rieschb67d8812012-02-02 00:44:39 +0000597- ARM options:
598 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
599
600 Select high exception vectors of the ARM core, e.g., do not
601 clear the V bit of the c1 register of CP15.
602
Aneesh V5356f542012-03-08 07:20:19 +0000603 CONFIG_SYS_THUMB_BUILD
604
605 Use this flag to build U-Boot using the Thumb instruction
606 set for ARM architectures. Thumb instruction set provides
607 better code density. For ARM architectures that support
608 Thumb2 this flag will result in Thumb2 code generated by
609 GCC.
610
Stephen Warrenc5d47522013-03-04 13:29:40 +0000611 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000612 CONFIG_ARM_ERRATA_742230
613 CONFIG_ARM_ERRATA_743622
614 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500615 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500616 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000617
618 If set, the workarounds for these ARM errata are applied early
619 during U-Boot startup. Note that these options force the
620 workarounds to be applied; no CPU-type/version detection
621 exists, unlike the similar options in the Linux kernel. Do not
622 set these options unless they apply!
623
Simon Glass38687ae2014-11-10 17:16:54 -0700624- Driver Model
625 Driver model is a new framework for devices in U-Boot
626 introduced in early 2014. U-Boot is being progressively
627 moved over to this. It offers a consistent device structure,
628 supports grouping devices into classes and has built-in
629 handling of platform data and device tree.
630
631 To enable transition to driver model in a relatively
632 painful fashion, each subsystem can be independently
633 switched between the legacy/ad-hoc approach and the new
634 driver model using the options below. Also, many uclass
635 interfaces include compatibility features which may be
636 removed once the conversion of that subsystem is complete.
637 As a result, the API provided by the subsystem may in fact
638 not change with driver model.
639
640 See doc/driver-model/README.txt for more information.
641
642 CONFIG_DM
643
644 Enable driver model. This brings in the core support,
645 including scanning of platform data on start-up. If
646 CONFIG_OF_CONTROL is enabled, the device tree will be
647 scanned also when available.
648
649 CONFIG_CMD_DM
650
651 Enable driver model test commands. These allow you to print
652 out the driver model tree and the uclasses.
653
654 CONFIG_DM_DEMO
655
656 Enable some demo devices and the 'demo' command. These are
657 really only useful for playing around while trying to
658 understand driver model in sandbox.
659
660 CONFIG_SPL_DM
661
662 Enable driver model in SPL. You will need to provide a
663 suitable malloc() implementation. If you are not using the
664 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
665 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
666 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
667 In most cases driver model will only allocate a few uclasses
668 and devices in SPL, so 1KB should be enable. See
669 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
670 it.
671
672 CONFIG_DM_SERIAL
673
674 Enable driver model for serial. This replaces
675 drivers/serial/serial.c with the serial uclass, which
676 implements serial_putc() etc. The uclass interface is
677 defined in include/serial.h.
678
679 CONFIG_DM_GPIO
680
681 Enable driver model for GPIO access. The standard GPIO
682 interface (gpio_get_value(), etc.) is then implemented by
683 the GPIO uclass. Drivers provide methods to query the
684 particular GPIOs that they provide. The uclass interface
685 is defined in include/asm-generic/gpio.h.
686
687 CONFIG_DM_SPI
688
689 Enable driver model for SPI. The SPI slave interface
690 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
691 the SPI uclass. Drivers provide methods to access the SPI
692 buses that they control. The uclass interface is defined in
693 include/spi.h. The existing spi_slave structure is attached
694 as 'parent data' to every slave on each bus. Slaves
695 typically use driver-private data instead of extending the
696 spi_slave structure.
697
698 CONFIG_DM_SPI_FLASH
699
700 Enable driver model for SPI flash. This SPI flash interface
701 (spi_flash_probe(), spi_flash_write(), etc.) is then
702 implemented by the SPI flash uclass. There is one standard
703 SPI flash driver which knows how to probe most chips
704 supported by U-Boot. The uclass interface is defined in
705 include/spi_flash.h, but is currently fully compatible
706 with the old interface to avoid confusion and duplication
707 during the transition parent. SPI and SPI flash must be
708 enabled together (it is not possible to use driver model
709 for one and not the other).
710
711 CONFIG_DM_CROS_EC
712
713 Enable driver model for the Chrome OS EC interface. This
714 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
715 but otherwise makes few changes. Since cros_ec also supports
716 I2C and LPC (which don't support driver model yet), a full
717 conversion is not yet possible.
718
719
720 ** Code size options: The following options are enabled by
721 default except in SPL. Enable them explicitly to get these
722 features in SPL.
723
724 CONFIG_DM_WARN
725
726 Enable the dm_warn() function. This can use up quite a bit
727 of space for its strings.
728
729 CONFIG_DM_STDIO
730
731 Enable registering a serial device with the stdio library.
732
733 CONFIG_DM_DEVICE_REMOVE
734
735 Enable removing of devices.
736
737
wdenk5da627a2003-10-09 20:09:04 +0000738- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000739 CONFIG_CLOCKS_IN_MHZ
740
741 U-Boot stores all clock information in Hz
742 internally. For binary compatibility with older Linux
743 kernels (which expect the clocks passed in the
744 bd_info data to be in MHz) the environment variable
745 "clocks_in_mhz" can be defined so that U-Boot
746 converts clock data to MHZ before passing it to the
747 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000748 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100749 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000750 default environment.
751
wdenk5da627a2003-10-09 20:09:04 +0000752 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
753
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800754 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000755 expect it to be in bytes, others in MB.
756 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
757
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400758 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200759
760 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400761 passed using flattened device trees (based on open firmware
762 concepts).
763
764 CONFIG_OF_LIBFDT
765 * New libfdt-based support
766 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500767 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400768
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200769 OF_CPU - The proper name of the cpus node (only required for
770 MPC512X and MPC5xxx based boards).
771 OF_SOC - The proper name of the soc node (only required for
772 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200773 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600774 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200775
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200776 boards with QUICC Engines require OF_QE to set UCC MAC
777 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500778
Kumar Gala4e253132006-01-11 13:54:17 -0600779 CONFIG_OF_BOARD_SETUP
780
781 Board code has addition modification that it wants to make
782 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000783
Simon Glassc654b512014-10-23 18:58:54 -0600784 CONFIG_OF_SYSTEM_SETUP
785
786 Other code has addition modification that it wants to make
787 to the flat device tree before handing it off to the kernel.
788 This causes ft_system_setup() to be called before booting
789 the kernel.
790
Matthew McClintock02677682006-06-28 10:41:37 -0500791 CONFIG_OF_BOOT_CPU
792
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200793 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500794 param header, the default value is zero if undefined.
795
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200796 CONFIG_OF_IDE_FIXUP
797
798 U-Boot can detect if an IDE device is present or not.
799 If not, and this new config option is activated, U-Boot
800 removes the ATA node from the DTS before booting Linux,
801 so the Linux IDE driver does not probe the device and
802 crash. This is needed for buggy hardware (uc101) where
803 no pull down resistor is connected to the signal IDE5V_DD7.
804
Igor Grinberg7eb29392011-07-14 05:45:07 +0000805 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
806
807 This setting is mandatory for all boards that have only one
808 machine type and must be used to specify the machine type
809 number as it appears in the ARM machine registry
810 (see http://www.arm.linux.org.uk/developer/machines/).
811 Only boards that have multiple machine types supported
812 in a single configuration file and the machine type is
813 runtime discoverable, do not have to use this setting.
814
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100815- vxWorks boot parameters:
816
817 bootvx constructs a valid bootline using the following
818 environments variables: bootfile, ipaddr, serverip, hostname.
819 It loads the vxWorks image pointed bootfile.
820
821 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
822 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
823 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
824 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
825
826 CONFIG_SYS_VXWORKS_ADD_PARAMS
827
828 Add it at the end of the bootline. E.g "u=username pw=secret"
829
830 Note: If a "bootargs" environment is defined, it will overwride
831 the defaults discussed just above.
832
Aneesh V2c451f72011-06-16 23:30:47 +0000833- Cache Configuration:
834 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
835 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
836 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
837
Aneesh V93bc2192011-06-16 23:30:51 +0000838- Cache Configuration for ARM:
839 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
840 controller
841 CONFIG_SYS_PL310_BASE - Physical base address of PL310
842 controller register space
843
wdenk6705d812004-08-02 23:22:59 +0000844- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200845 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000846
847 Define this if you want support for Amba PrimeCell PL010 UARTs.
848
Andreas Engel48d01922008-09-08 14:30:53 +0200849 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000850
851 Define this if you want support for Amba PrimeCell PL011 UARTs.
852
853 CONFIG_PL011_CLOCK
854
855 If you have Amba PrimeCell PL011 UARTs, set this variable to
856 the clock speed of the UARTs.
857
858 CONFIG_PL01x_PORTS
859
860 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
861 define this to a list of base addresses for each (supported)
862 port. See e.g. include/configs/versatile.h
863
John Rigby910f1ae2011-04-19 10:42:39 +0000864 CONFIG_PL011_SERIAL_RLCR
865
866 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
867 have separate receive and transmit line control registers. Set
868 this variable to initialize the extra register.
869
870 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
871
872 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
873 boot loader that has already initialized the UART. Define this
874 variable to flush the UART at init time.
875
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400876 CONFIG_SERIAL_HW_FLOW_CONTROL
877
878 Define this variable to enable hw flow control in serial driver.
879 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000880
wdenkc6097192002-11-03 00:24:07 +0000881- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000882 Depending on board, define exactly one serial port
883 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
884 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
885 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000886
887 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
888 port routines must be defined elsewhere
889 (i.e. serial_init(), serial_getc(), ...)
890
891 CONFIG_CFB_CONSOLE
892 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000893 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000894 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
895 (default big endian)
896 VIDEO_HW_RECTFILL graphic chip supports
897 rectangle fill
898 (cf. smiLynxEM)
899 VIDEO_HW_BITBLT graphic chip supports
900 bit-blit (cf. smiLynxEM)
901 VIDEO_VISIBLE_COLS visible pixel columns
902 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000903 VIDEO_VISIBLE_ROWS visible pixel rows
904 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000905 VIDEO_DATA_FORMAT graphic data format
906 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000907 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000908 VIDEO_KBD_INIT_FCT keyboard int fct
909 (i.e. i8042_kbd_init())
910 VIDEO_TSTC_FCT test char fct
911 (i.e. i8042_tstc)
912 VIDEO_GETC_FCT get char fct
913 (i.e. i8042_getc)
914 CONFIG_CONSOLE_CURSOR cursor drawing on/off
915 (requires blink timer
916 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200917 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000918 CONFIG_CONSOLE_TIME display time/date info in
919 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000921 CONFIG_VIDEO_LOGO display Linux logo in
922 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000923 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
924 linux_logo.h for logo.
925 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000926 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200927 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000928 the logo
929
Pali Rohár33a35bb2012-10-19 13:30:09 +0000930 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
931 a limited number of ANSI escape sequences (cursor control,
932 erase functions and limited graphics rendition control).
933
wdenk43d96162003-03-06 00:02:04 +0000934 When CONFIG_CFB_CONSOLE is defined, video console is
935 default i/o. Serial console can be forced with
936 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000937
wdenkd4ca31c2004-01-02 14:00:00 +0000938 When CONFIG_SILENT_CONSOLE is defined, all console
939 messages (by U-Boot and Linux!) can be silenced with
940 the "silent" environment variable. See
941 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000942
Heiko Schocher45ae2542013-10-22 11:06:06 +0200943 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
944 is 0x00.
945 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
946 is 0xa0.
947
wdenkc6097192002-11-03 00:24:07 +0000948- Console Baudrate:
949 CONFIG_BAUDRATE - in bps
950 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200951 CONFIG_SYS_BAUDRATE_TABLE, see below.
952 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000953
Heiko Schocherc92fac92009-01-30 12:55:38 +0100954- Console Rx buffer length
955 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
956 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100957 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100958 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
959 must be defined, to setup the maximum idle timeout for
960 the SMC.
961
Graeme Russ9558b482011-09-01 00:48:27 +0000962- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200963 Prior to the console being initialised (i.e. serial UART
964 initialised etc) all console output is silently discarded.
965 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
966 buffer any console messages prior to the console being
967 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
968 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
969 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200970 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200971 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000972
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200973 'Sane' compilers will generate smaller code if
974 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000975
Sonny Rao046a37b2011-11-02 09:52:08 +0000976- Safe printf() functions
977 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
978 the printf() functions. These are defined in
979 include/vsprintf.h and include snprintf(), vsnprintf() and
980 so on. Code size increase is approximately 300-500 bytes.
981 If this option is not given then these functions will
982 silently discard their buffer size argument - this means
983 you are not getting any overflow checking in this case.
984
wdenkc6097192002-11-03 00:24:07 +0000985- Boot Delay: CONFIG_BOOTDELAY - in seconds
986 Delay before automatically booting the default image;
987 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000988 set to -2 to autoboot with no delay and not check for abort
989 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000990
991 See doc/README.autoboot for these options that
992 work with CONFIG_BOOTDELAY. None are required.
993 CONFIG_BOOT_RETRY_TIME
994 CONFIG_BOOT_RETRY_MIN
995 CONFIG_AUTOBOOT_KEYED
996 CONFIG_AUTOBOOT_PROMPT
997 CONFIG_AUTOBOOT_DELAY_STR
998 CONFIG_AUTOBOOT_STOP_STR
999 CONFIG_AUTOBOOT_DELAY_STR2
1000 CONFIG_AUTOBOOT_STOP_STR2
1001 CONFIG_ZERO_BOOTDELAY_CHECK
1002 CONFIG_RESET_TO_RETRY
1003
1004- Autoboot Command:
1005 CONFIG_BOOTCOMMAND
1006 Only needed when CONFIG_BOOTDELAY is enabled;
1007 define a command string that is automatically executed
1008 when no character is read on the console interface
1009 within "Boot Delay" after reset.
1010
1011 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +00001012 This can be used to pass arguments to the bootm
1013 command. The value of CONFIG_BOOTARGS goes into the
1014 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001015
1016 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +00001017 The value of these goes into the environment as
1018 "ramboot" and "nfsboot" respectively, and can be used
1019 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001020 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001021
Heiko Schochereda0ba32013-11-04 14:04:59 +01001022- Bootcount:
1023 CONFIG_BOOTCOUNT_LIMIT
1024 Implements a mechanism for detecting a repeating reboot
1025 cycle, see:
1026 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1027
1028 CONFIG_BOOTCOUNT_ENV
1029 If no softreset save registers are found on the hardware
1030 "bootcount" is stored in the environment. To prevent a
1031 saveenv on all reboots, the environment variable
1032 "upgrade_available" is used. If "upgrade_available" is
1033 0, "bootcount" is always 0, if "upgrade_available" is
1034 1 "bootcount" is incremented in the environment.
1035 So the Userspace Applikation must set the "upgrade_available"
1036 and "bootcount" variable to 0, if a boot was successfully.
1037
wdenkc6097192002-11-03 00:24:07 +00001038- Pre-Boot Commands:
1039 CONFIG_PREBOOT
1040
1041 When this option is #defined, the existence of the
1042 environment variable "preboot" will be checked
1043 immediately before starting the CONFIG_BOOTDELAY
1044 countdown and/or running the auto-boot command resp.
1045 entering interactive mode.
1046
1047 This feature is especially useful when "preboot" is
1048 automatically generated or modified. For an example
1049 see the LWMON board specific code: here "preboot" is
1050 modified when the user holds down a certain
1051 combination of keys on the (special) keyboard when
1052 booting the systems
1053
1054- Serial Download Echo Mode:
1055 CONFIG_LOADS_ECHO
1056 If defined to 1, all characters received during a
1057 serial download (using the "loads" command) are
1058 echoed back. This might be needed by some terminal
1059 emulations (like "cu"), but may as well just take
1060 time on others. This setting #define's the initial
1061 value of the "loads_echo" environment variable.
1062
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001063- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001064 CONFIG_KGDB_BAUDRATE
1065 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001066 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001067
1068- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 Monitor commands can be included or excluded
1070 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001071 <config_cmd_all.h> and #undef'ing unwanted
1072 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001073 and augmenting with additional #define's
1074 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001075
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001076 The default command configuration includes all commands
1077 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001078
Marek Vasutb401b732014-03-05 19:58:39 +01001079 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001081 CONFIG_CMD_BDI bdinfo
1082 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1083 CONFIG_CMD_BMP * BMP support
1084 CONFIG_CMD_BSP * Board specific commands
1085 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001086 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001087 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001088 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001089 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001090 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001091 CONFIG_CMD_DATE * support for RTC, date/time...
1092 CONFIG_CMD_DHCP * DHCP support
1093 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001094 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1095 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1096 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1097 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001098 CONFIG_CMD_DTT * Digital Therm and Thermostat
1099 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001100 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001101 CONFIG_CMD_EEPROM * EEPROM read/write support
1102 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001103 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001104 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001105 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001106 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001107 CONFIG_CMD_EXT2 * ext2 command support
1108 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001109 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1110 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001111 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001112 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001113 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001114 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001115 CONFIG_CMD_FLASH flinfo, erase, protect
1116 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001117 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001118 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001119 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001120 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001121 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001122 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1123 CONFIG_CMD_I2C * I2C serial bus support
1124 CONFIG_CMD_IDE * IDE harddisk support
1125 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001126 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001127 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001128 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001129 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001130 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001131 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001132 CONFIG_CMD_IRQ * irqinfo
1133 CONFIG_CMD_ITEST Integer/string test of 2 values
1134 CONFIG_CMD_JFFS2 * JFFS2 Support
1135 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001136 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001137 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1138 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001139 CONFIG_CMD_LOADB loadb
1140 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001141 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001142 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001143 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001144 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001145 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001146 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001147 CONFIG_CMD_MISC Misc functions like sleep etc
1148 CONFIG_CMD_MMC * MMC memory mapped support
1149 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001150 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001151 CONFIG_CMD_NAND * NAND support
1152 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001153 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001154 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001155 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001156 CONFIG_CMD_PCI * pciinfo
1157 CONFIG_CMD_PCMCIA * PCMCIA support
1158 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1159 host
1160 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001161 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001162 CONFIG_CMD_REGINFO * Register dump
1163 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001164 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001165 CONFIG_CMD_SAVES * save S record dump
1166 CONFIG_CMD_SCSI * SCSI Support
1167 CONFIG_CMD_SDRAM * print SDRAM configuration information
1168 (requires CONFIG_CMD_I2C)
1169 CONFIG_CMD_SETGETDCR Support for DCR Register access
1170 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001171 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001172 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001173 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001174 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001175 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001176 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001177 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001178 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001179 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1180 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001181 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001182 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001183 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001184 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001185 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001186
1187 EXAMPLE: If you want all functions except of network
1188 support you can write:
1189
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001190 #include "config_cmd_all.h"
1191 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001192
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001193 Other Commands:
1194 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001195
1196 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001197 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001198 what you (and your U-Boot users) are doing. Data
1199 cache cannot be enabled on systems like the 8xx or
1200 8260 (where accesses to the IMMR region must be
1201 uncached), and it cannot be disabled on all other
1202 systems where we (mis-) use the data cache to hold an
1203 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001204
1205
1206 XXX - this list needs to get updated!
1207
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001208- Regular expression support:
1209 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001210 If this variable is defined, U-Boot is linked against
1211 the SLRE (Super Light Regular Expression) library,
1212 which adds regex support to some commands, as for
1213 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001214
Simon Glass45ba8072011-10-15 05:48:20 +00001215- Device tree:
1216 CONFIG_OF_CONTROL
1217 If this variable is defined, U-Boot will use a device tree
1218 to configure its devices, instead of relying on statically
1219 compiled #defines in the board file. This option is
1220 experimental and only available on a few boards. The device
1221 tree is available in the global data as gd->fdt_blob.
1222
Simon Glass2c0f79e2011-10-24 19:15:31 +00001223 U-Boot needs to get its device tree from somewhere. This can
1224 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001225
1226 CONFIG_OF_EMBED
1227 If this variable is defined, U-Boot will embed a device tree
1228 binary in its image. This device tree file should be in the
1229 board directory and called <soc>-<board>.dts. The binary file
1230 is then picked up in board_init_f() and made available through
1231 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001232
Simon Glass2c0f79e2011-10-24 19:15:31 +00001233 CONFIG_OF_SEPARATE
1234 If this variable is defined, U-Boot will build a device tree
1235 binary. It will be called u-boot.dtb. Architecture-specific
1236 code will locate it at run-time. Generally this works by:
1237
1238 cat u-boot.bin u-boot.dtb >image.bin
1239
1240 and in fact, U-Boot does this for you, creating a file called
1241 u-boot-dtb.bin which is useful in the common case. You can
1242 still use the individual files if you need something more
1243 exotic.
1244
wdenkc6097192002-11-03 00:24:07 +00001245- Watchdog:
1246 CONFIG_WATCHDOG
1247 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001248 support for the SoC. There must be support in the SoC
1249 specific code for a watchdog. For the 8xx and 8260
1250 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1251 register. When supported for a specific SoC is
1252 available, then no further board specific code should
1253 be needed to use it.
1254
1255 CONFIG_HW_WATCHDOG
1256 When using a watchdog circuitry external to the used
1257 SoC, then define this variable and provide board
1258 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001259
stroesec1551ea2003-04-04 15:53:41 +00001260- U-Boot Version:
1261 CONFIG_VERSION_VARIABLE
1262 If this variable is defined, an environment variable
1263 named "ver" is created by U-Boot showing the U-Boot
1264 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001265 Any change to this variable will be reverted at the
1266 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001267
wdenkc6097192002-11-03 00:24:07 +00001268- Real-Time Clock:
1269
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001270 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001271 has to be selected, too. Define exactly one of the
1272 following options:
1273
1274 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1275 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001276 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001277 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001278 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001279 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001280 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001281 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001282 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001283 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001284 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001285 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001286 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1287 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001288
wdenkb37c7e52003-06-30 16:24:52 +00001289 Note that if the RTC uses I2C, then the I2C interface
1290 must also be configured. See I2C Support, below.
1291
Peter Tysere92739d2008-12-17 16:36:21 -06001292- GPIO Support:
1293 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001294
Chris Packham5dec49c2010-12-19 10:12:13 +00001295 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1296 chip-ngpio pairs that tell the PCA953X driver the number of
1297 pins supported by a particular chip.
1298
Peter Tysere92739d2008-12-17 16:36:21 -06001299 Note that if the GPIO device uses I2C, then the I2C interface
1300 must also be configured. See I2C Support, below.
1301
Simon Glassaa532332014-06-11 23:29:41 -06001302- I/O tracing:
1303 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1304 accesses and can checksum them or write a list of them out
1305 to memory. See the 'iotrace' command for details. This is
1306 useful for testing device drivers since it can confirm that
1307 the driver behaves the same way before and after a code
1308 change. Currently this is supported on sandbox and arm. To
1309 add support for your architecture, add '#include <iotrace.h>'
1310 to the bottom of arch/<arch>/include/asm/io.h and test.
1311
1312 Example output from the 'iotrace stats' command is below.
1313 Note that if the trace buffer is exhausted, the checksum will
1314 still continue to operate.
1315
1316 iotrace is enabled
1317 Start: 10000000 (buffer start address)
1318 Size: 00010000 (buffer size)
1319 Offset: 00000120 (current buffer offset)
1320 Output: 10000120 (start + offset)
1321 Count: 00000018 (number of trace records)
1322 CRC32: 9526fb66 (CRC32 of all trace records)
1323
wdenkc6097192002-11-03 00:24:07 +00001324- Timestamp Support:
1325
wdenk43d96162003-03-06 00:02:04 +00001326 When CONFIG_TIMESTAMP is selected, the timestamp
1327 (date and time) of an image is printed by image
1328 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001329 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001330
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001331- Partition Labels (disklabels) Supported:
1332 Zero or more of the following:
1333 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1334 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1335 Intel architecture, USB sticks, etc.
1336 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1337 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1338 bootloader. Note 2TB partition limit; see
1339 disk/part_efi.c
1340 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001341
Wolfgang Denk218ca722008-03-26 10:40:12 +01001342 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1343 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001344 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001345
1346- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001347 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1348 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001349
wdenk4d13cba2004-03-14 14:09:05 +00001350 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1351 be performed by calling the function
1352 ide_set_reset(int reset)
1353 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001354
1355- ATAPI Support:
1356 CONFIG_ATAPI
1357
1358 Set this to enable ATAPI support.
1359
wdenkc40b2952004-03-13 23:29:43 +00001360- LBA48 Support
1361 CONFIG_LBA48
1362
1363 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001364 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001365 Whithout these , LBA48 support uses 32bit variables and will 'only'
1366 support disks up to 2.1TB.
1367
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001368 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001369 When enabled, makes the IDE subsystem use 64bit sector addresses.
1370 Default is 32bit.
1371
wdenkc6097192002-11-03 00:24:07 +00001372- SCSI Support:
1373 At the moment only there is only support for the
1374 SYM53C8XX SCSI controller; define
1375 CONFIG_SCSI_SYM53C8XX to enable it.
1376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001377 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1378 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1379 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001380 maximum numbers of LUNs, SCSI ID's and target
1381 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001382 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001383
Wolfgang Denk93e14592013-10-04 17:43:24 +02001384 The environment variable 'scsidevs' is set to the number of
1385 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001386
wdenkc6097192002-11-03 00:24:07 +00001387- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001388 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001389 Support for Intel 8254x/8257x gigabit chips.
1390
1391 CONFIG_E1000_SPI
1392 Utility code for direct access to the SPI bus on Intel 8257x.
1393 This does not do anything useful unless you set at least one
1394 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1395
1396 CONFIG_E1000_SPI_GENERIC
1397 Allow generic access to the SPI bus on the Intel 8257x, for
1398 example with the "sspi" command.
1399
1400 CONFIG_CMD_E1000
1401 Management command for E1000 devices. When used on devices
1402 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001403
Andre Schwarzac3315c2008-03-06 16:45:44 +01001404 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001405 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001406
wdenkc6097192002-11-03 00:24:07 +00001407 CONFIG_EEPRO100
1408 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001409 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001410 write routine for first time initialisation.
1411
1412 CONFIG_TULIP
1413 Support for Digital 2114x chips.
1414 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1415 modem chip initialisation (KS8761/QS6611).
1416
1417 CONFIG_NATSEMI
1418 Support for National dp83815 chips.
1419
1420 CONFIG_NS8382X
1421 Support for National dp8382[01] gigabit chips.
1422
wdenk45219c42003-05-12 21:50:16 +00001423- NETWORK Support (other):
1424
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001425 CONFIG_DRIVER_AT91EMAC
1426 Support for AT91RM9200 EMAC.
1427
1428 CONFIG_RMII
1429 Define this to use reduced MII inteface
1430
1431 CONFIG_DRIVER_AT91EMAC_QUIET
1432 If this defined, the driver is quiet.
1433 The driver doen't show link status messages.
1434
Rob Herringefdd7312011-12-15 11:15:49 +00001435 CONFIG_CALXEDA_XGMAC
1436 Support for the Calxeda XGMAC device
1437
Ashok3bb46d22012-10-15 06:20:47 +00001438 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001439 Support for SMSC's LAN91C96 chips.
1440
1441 CONFIG_LAN91C96_BASE
1442 Define this to hold the physical address
1443 of the LAN91C96's I/O space
1444
1445 CONFIG_LAN91C96_USE_32_BIT
1446 Define this to enable 32 bit addressing
1447
Ashok3bb46d22012-10-15 06:20:47 +00001448 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001449 Support for SMSC's LAN91C111 chip
1450
1451 CONFIG_SMC91111_BASE
1452 Define this to hold the physical address
1453 of the device (I/O space)
1454
1455 CONFIG_SMC_USE_32_BIT
1456 Define this if data bus is 32 bits
1457
1458 CONFIG_SMC_USE_IOFUNCS
1459 Define this to use i/o functions instead of macros
1460 (some hardware wont work with macros)
1461
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001462 CONFIG_DRIVER_TI_EMAC
1463 Support for davinci emac
1464
1465 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1466 Define this if you have more then 3 PHYs.
1467
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001468 CONFIG_FTGMAC100
1469 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1470
1471 CONFIG_FTGMAC100_EGIGA
1472 Define this to use GE link update with gigabit PHY.
1473 Define this if FTGMAC100 is connected to gigabit PHY.
1474 If your system has 10/100 PHY only, it might not occur
1475 wrong behavior. Because PHY usually return timeout or
1476 useless data when polling gigabit status and gigabit
1477 control registers. This behavior won't affect the
1478 correctnessof 10/100 link speed update.
1479
Mike Rapoportc2fff332009-11-11 10:03:03 +02001480 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001481 Support for SMSC's LAN911x and LAN921x chips
1482
Mike Rapoportc2fff332009-11-11 10:03:03 +02001483 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001484 Define this to hold the physical address
1485 of the device (I/O space)
1486
Mike Rapoportc2fff332009-11-11 10:03:03 +02001487 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001488 Define this if data bus is 32 bits
1489
Mike Rapoportc2fff332009-11-11 10:03:03 +02001490 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001491 Define this if data bus is 16 bits. If your processor
1492 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001493 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001494
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001495 CONFIG_SH_ETHER
1496 Support for Renesas on-chip Ethernet controller
1497
1498 CONFIG_SH_ETHER_USE_PORT
1499 Define the number of ports to be used
1500
1501 CONFIG_SH_ETHER_PHY_ADDR
1502 Define the ETH PHY's address
1503
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001504 CONFIG_SH_ETHER_CACHE_WRITEBACK
1505 If this option is set, the driver enables cache flush.
1506
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001507- PWM Support:
1508 CONFIG_PWM_IMX
1509 Support for PWM modul on the imx6.
1510
Vadim Bendebury5e124722011-10-17 08:36:14 +00001511- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001512 CONFIG_TPM
1513 Support TPM devices.
1514
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001515 CONFIG_TPM_TIS_I2C
1516 Support for i2c bus TPM devices. Only one device
1517 per system is supported at this time.
1518
1519 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1520 Define the the i2c bus number for the TPM device
1521
1522 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1523 Define the TPM's address on the i2c bus
1524
1525 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1526 Define the burst count bytes upper limit
1527
Dirk Eibachc01939c2013-06-26 15:55:15 +02001528 CONFIG_TPM_ATMEL_TWI
1529 Support for Atmel TWI TPM device. Requires I2C support.
1530
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001531 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001532 Support for generic parallel port TPM devices. Only one device
1533 per system is supported at this time.
1534
1535 CONFIG_TPM_TIS_BASE_ADDRESS
1536 Base address where the generic TPM device is mapped
1537 to. Contemporary x86 systems usually map it at
1538 0xfed40000.
1539
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001540 CONFIG_CMD_TPM
1541 Add tpm monitor functions.
1542 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1543 provides monitor access to authorized functions.
1544
1545 CONFIG_TPM
1546 Define this to enable the TPM support library which provides
1547 functional interfaces to some TPM commands.
1548 Requires support for a TPM device.
1549
1550 CONFIG_TPM_AUTH_SESSIONS
1551 Define this to enable authorized functions in the TPM library.
1552 Requires CONFIG_TPM and CONFIG_SHA1.
1553
wdenkc6097192002-11-03 00:24:07 +00001554- USB Support:
1555 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001556 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001557 CONFIG_USB_UHCI to enable it.
1558 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001559 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001560 storage devices.
1561 Note:
1562 Supported are USB Keyboards and USB Floppy drives
1563 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001564 MPC5200 USB requires additional defines:
1565 CONFIG_USB_CLOCK
1566 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001567 CONFIG_PSC3_USB
1568 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001569 CONFIG_USB_CONFIG
1570 for differential drivers: 0x00001000
1571 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001572 for differential drivers on PSC3: 0x00000100
1573 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001574 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001575 May be defined to allow interrupt polling
1576 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001577
Simon Glass9ab4ce22012-02-27 10:52:47 +00001578 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1579 txfilltuning field in the EHCI controller on reset.
1580
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001581 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1582 HW module registers.
1583
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001584- USB Device:
1585 Define the below if you wish to use the USB console.
1586 Once firmware is rebuilt from a serial console issue the
1587 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001588 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001589 it has found a new device. The environment variable usbtty
1590 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001591 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001592 Common Device Class Abstract Control Model serial device.
1593 If you select usbtty = gserial you should be able to enumerate
1594 a Linux host by
1595 # modprobe usbserial vendor=0xVendorID product=0xProductID
1596 else if using cdc_acm, simply setting the environment
1597 variable usbtty to be cdc_acm should suffice. The following
1598 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001599
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001600 CONFIG_USB_DEVICE
1601 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001602
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001603 CONFIG_USB_TTY
1604 Define this to have a tty type of device available to
1605 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001606
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301607 CONFIG_USBD_HS
1608 Define this to enable the high speed support for usb
1609 device and usbtty. If this feature is enabled, a routine
1610 int is_usbd_high_speed(void)
1611 also needs to be defined by the driver to dynamically poll
1612 whether the enumeration has succeded at high speed or full
1613 speed.
1614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001615 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001616 Define this if you want stdin, stdout &/or stderr to
1617 be set to usbtty.
1618
1619 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001620 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001621 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001622 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001624 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001625 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001627
Wolfgang Denk386eda02006-06-14 18:14:56 +02001628 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001629 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001630 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001631 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1632 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1633 should pretend to be a Linux device to it's target host.
1634
1635 CONFIG_USBD_MANUFACTURER
1636 Define this string as the name of your company for
1637 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001638
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001639 CONFIG_USBD_PRODUCT_NAME
1640 Define this string as the name of your product
1641 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1642
1643 CONFIG_USBD_VENDORID
1644 Define this as your assigned Vendor ID from the USB
1645 Implementors Forum. This *must* be a genuine Vendor ID
1646 to avoid polluting the USB namespace.
1647 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001648
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001649 CONFIG_USBD_PRODUCTID
1650 Define this as the unique Product ID
1651 for your device
1652 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001653
Igor Grinbergd70a5602011-12-12 12:08:35 +02001654- ULPI Layer Support:
1655 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1656 the generic ULPI layer. The generic layer accesses the ULPI PHY
1657 via the platform viewport, so you need both the genric layer and
1658 the viewport enabled. Currently only Chipidea/ARC based
1659 viewport is supported.
1660 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1661 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001662 If your ULPI phy needs a different reference clock than the
1663 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1664 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001665
1666- MMC Support:
1667 The MMC controller on the Intel PXA is supported. To
1668 enable this define CONFIG_MMC. The MMC can be
1669 accessed from the boot prompt by mapping the device
1670 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001671 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1672 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001673
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001674 CONFIG_SH_MMCIF
1675 Support for Renesas on-chip MMCIF controller
1676
1677 CONFIG_SH_MMCIF_ADDR
1678 Define the base address of MMCIF registers
1679
1680 CONFIG_SH_MMCIF_CLK
1681 Define the clock frequency for MMCIF
1682
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001683 CONFIG_GENERIC_MMC
1684 Enable the generic MMC driver
1685
1686 CONFIG_SUPPORT_EMMC_BOOT
1687 Enable some additional features of the eMMC boot partitions.
1688
1689 CONFIG_SUPPORT_EMMC_RPMB
1690 Enable the commands for reading, writing and programming the
1691 key for the Replay Protection Memory Block partition in eMMC.
1692
Tom Rinib3ba6e92013-03-14 05:32:47 +00001693- USB Device Firmware Update (DFU) class support:
1694 CONFIG_DFU_FUNCTION
1695 This enables the USB portion of the DFU USB class
1696
1697 CONFIG_CMD_DFU
1698 This enables the command "dfu" which is used to have
1699 U-Boot create a DFU class device via USB. This command
1700 requires that the "dfu_alt_info" environment variable be
1701 set and define the alt settings to expose to the host.
1702
1703 CONFIG_DFU_MMC
1704 This enables support for exposing (e)MMC devices via DFU.
1705
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001706 CONFIG_DFU_NAND
1707 This enables support for exposing NAND devices via DFU.
1708
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301709 CONFIG_DFU_RAM
1710 This enables support for exposing RAM via DFU.
1711 Note: DFU spec refer to non-volatile memory usage, but
1712 allow usages beyond the scope of spec - here RAM usage,
1713 one that would help mostly the developer.
1714
Heiko Schochere7e75c72013-06-12 06:05:51 +02001715 CONFIG_SYS_DFU_DATA_BUF_SIZE
1716 Dfu transfer uses a buffer before writing data to the
1717 raw storage device. Make the size (in bytes) of this buffer
1718 configurable. The size of this buffer is also configurable
1719 through the "dfu_bufsiz" environment variable.
1720
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001721 CONFIG_SYS_DFU_MAX_FILE_SIZE
1722 When updating files rather than the raw storage device,
1723 we use a static buffer to copy the file into and then write
1724 the buffer once we've been given the whole file. Define
1725 this to the maximum filesize (in bytes) for the buffer.
1726 Default is 4 MiB if undefined.
1727
Heiko Schocher001a8312014-03-18 08:09:56 +01001728 DFU_DEFAULT_POLL_TIMEOUT
1729 Poll timeout [ms], is the timeout a device can send to the
1730 host. The host must wait for this timeout before sending
1731 a subsequent DFU_GET_STATUS request to the device.
1732
1733 DFU_MANIFEST_POLL_TIMEOUT
1734 Poll timeout [ms], which the device sends to the host when
1735 entering dfuMANIFEST state. Host waits this timeout, before
1736 sending again an USB request to the device.
1737
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001738- USB Device Android Fastboot support:
1739 CONFIG_CMD_FASTBOOT
1740 This enables the command "fastboot" which enables the Android
1741 fastboot mode for the platform's USB device. Fastboot is a USB
1742 protocol for downloading images, flashing and device control
1743 used on Android devices.
1744 See doc/README.android-fastboot for more information.
1745
1746 CONFIG_ANDROID_BOOT_IMAGE
1747 This enables support for booting images which use the Android
1748 image format header.
1749
1750 CONFIG_USB_FASTBOOT_BUF_ADDR
1751 The fastboot protocol requires a large memory buffer for
1752 downloads. Define this to the starting RAM address to use for
1753 downloaded images.
1754
1755 CONFIG_USB_FASTBOOT_BUF_SIZE
1756 The fastboot protocol requires a large memory buffer for
1757 downloads. This buffer should be as large as possible for a
1758 platform. Define this to the size available RAM for fastboot.
1759
Steve Raed1b5ed02014-08-26 11:47:28 -07001760 CONFIG_FASTBOOT_FLASH
1761 The fastboot protocol includes a "flash" command for writing
1762 the downloaded image to a non-volatile storage device. Define
1763 this to enable the "fastboot flash" command.
1764
1765 CONFIG_FASTBOOT_FLASH_MMC_DEV
1766 The fastboot "flash" command requires additional information
1767 regarding the non-volatile storage device. Define this to
1768 the eMMC device that fastboot should use to store the image.
1769
Steve Rae0ff7e582014-12-12 15:51:54 -08001770 CONFIG_FASTBOOT_GPT_NAME
1771 The fastboot "flash" command supports writing the downloaded
1772 image to the Protective MBR and the Primary GUID Partition
1773 Table. (Additionally, this downloaded image is post-processed
1774 to generate and write the Backup GUID Partition Table.)
1775 This occurs when the specified "partition name" on the
1776 "fastboot flash" command line matches this value.
1777 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1778
wdenk6705d812004-08-02 23:22:59 +00001779- Journaling Flash filesystem support:
1780 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1781 CONFIG_JFFS2_NAND_DEV
1782 Define these for a default partition on a NAND device
1783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001784 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1785 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001786 Define these for a default partition on a NOR device
1787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001788 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001789 Define this to create an own partition. You have to provide a
1790 function struct part_info* jffs2_part_info(int part_num)
1791
1792 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001793 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001794 to disable the command chpart. This is the default when you
1795 have not defined a custom partition
1796
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001797- FAT(File Allocation Table) filesystem write function support:
1798 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001799
1800 Define this to enable support for saving memory data as a
1801 file in FAT formatted partition.
1802
1803 This will also enable the command "fatwrite" enabling the
1804 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001805
Gabe Black84cd9322012-10-12 14:26:11 +00001806CBFS (Coreboot Filesystem) support
1807 CONFIG_CMD_CBFS
1808
1809 Define this to enable support for reading from a Coreboot
1810 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1811 and cbfsload.
1812
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301813- FAT(File Allocation Table) filesystem cluster size:
1814 CONFIG_FS_FAT_MAX_CLUSTSIZE
1815
1816 Define the max cluster size for fat operations else
1817 a default value of 65536 will be defined.
1818
wdenkc6097192002-11-03 00:24:07 +00001819- Keyboard Support:
1820 CONFIG_ISA_KEYBOARD
1821
1822 Define this to enable standard (PC-Style) keyboard
1823 support
1824
1825 CONFIG_I8042_KBD
1826 Standard PC keyboard driver with US (is default) and
1827 GERMAN key layout (switch via environment 'keymap=de') support.
1828 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1829 for cfb_console. Supports cursor blinking.
1830
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001831 CONFIG_CROS_EC_KEYB
1832 Enables a Chrome OS keyboard using the CROS_EC interface.
1833 This uses CROS_EC to communicate with a second microcontroller
1834 which provides key scans on request.
1835
wdenkc6097192002-11-03 00:24:07 +00001836- Video support:
1837 CONFIG_VIDEO
1838
1839 Define this to enable video support (for output to
1840 video).
1841
1842 CONFIG_VIDEO_CT69000
1843
1844 Enable Chips & Technologies 69000 Video chip
1845
1846 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001847 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001848 video output is selected via environment 'videoout'
1849 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1850 assumed.
wdenkc6097192002-11-03 00:24:07 +00001851
wdenkb79a11c2004-03-25 15:14:43 +00001852 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001853 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001854 are possible:
1855 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001856 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001857
1858 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1859 -------------+---------------------------------------------
1860 8 bits | 0x301* 0x303 0x305 0x161 0x307
1861 15 bits | 0x310 0x313 0x316 0x162 0x319
1862 16 bits | 0x311 0x314 0x317 0x163 0x31A
1863 24 bits | 0x312 0x315 0x318 ? 0x31B
1864 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001865 (i.e. setenv videomode 317; saveenv; reset;)
1866
wdenkb79a11c2004-03-25 15:14:43 +00001867 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001868 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001869
1870
stroesec1551ea2003-04-04 15:53:41 +00001871 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001872 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001873 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1874 or CONFIG_VIDEO_SED13806_16BPP
1875
Timur Tabi7d3053f2011-02-15 17:09:19 -06001876 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001877 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001878 SOCs that have a DIU should define this macro to enable DIU
1879 support, and should also define these other macros:
1880
1881 CONFIG_SYS_DIU_ADDR
1882 CONFIG_VIDEO
1883 CONFIG_CMD_BMP
1884 CONFIG_CFB_CONSOLE
1885 CONFIG_VIDEO_SW_CURSOR
1886 CONFIG_VGA_AS_SINGLE_DEVICE
1887 CONFIG_VIDEO_LOGO
1888 CONFIG_VIDEO_BMP_LOGO
1889
Timur Tabiba8e76b2011-04-11 14:18:22 -05001890 The DIU driver will look for the 'video-mode' environment
1891 variable, and if defined, enable the DIU as a console during
1892 boot. See the documentation file README.video for a
1893 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001894
Simon Glass058d59b2012-12-03 13:59:47 +00001895 CONFIG_VIDEO_VGA
1896
1897 Enable the VGA video / BIOS for x86. The alternative if you
1898 are using coreboot is to use the coreboot frame buffer
1899 driver.
1900
1901
wdenk682011f2003-06-03 23:54:09 +00001902- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001903 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001904
wdenk8bde7f72003-06-27 21:31:46 +00001905 Define this to enable a custom keyboard support.
1906 This simply calls drv_keyboard_init() which must be
1907 defined in your board-specific files.
1908 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001909
wdenkc6097192002-11-03 00:24:07 +00001910- LCD Support: CONFIG_LCD
1911
1912 Define this to enable LCD support (for output to LCD
1913 display); also select one of the supported displays
1914 by defining one of these:
1915
Stelian Pop39cf4802008-05-09 21:57:18 +02001916 CONFIG_ATMEL_LCD:
1917
1918 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1919
wdenkfd3103b2003-11-25 16:55:19 +00001920 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001921
wdenkfd3103b2003-11-25 16:55:19 +00001922 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001923
wdenkfd3103b2003-11-25 16:55:19 +00001924 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001925
wdenkfd3103b2003-11-25 16:55:19 +00001926 NEC NL6448BC20-08. 6.5", 640x480.
1927 Active, color, single scan.
1928
1929 CONFIG_NEC_NL6448BC33_54
1930
1931 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001932 Active, color, single scan.
1933
1934 CONFIG_SHARP_16x9
1935
1936 Sharp 320x240. Active, color, single scan.
1937 It isn't 16x9, and I am not sure what it is.
1938
1939 CONFIG_SHARP_LQ64D341
1940
1941 Sharp LQ64D341 display, 640x480.
1942 Active, color, single scan.
1943
1944 CONFIG_HLD1045
1945
1946 HLD1045 display, 640x480.
1947 Active, color, single scan.
1948
1949 CONFIG_OPTREX_BW
1950
1951 Optrex CBL50840-2 NF-FW 99 22 M5
1952 or
1953 Hitachi LMG6912RPFC-00T
1954 or
1955 Hitachi SP14Q002
1956
1957 320x240. Black & white.
1958
1959 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001960 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001961
Simon Glass676d3192012-10-17 13:24:54 +00001962 CONFIG_LCD_ALIGNMENT
1963
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001964 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001965 defined then the LCD will be aligned to this value instead.
1966 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1967 here, since it is cheaper to change data cache settings on
1968 a per-section basis.
1969
Simon Glass0d89efe2012-10-17 13:24:59 +00001970 CONFIG_CONSOLE_SCROLL_LINES
1971
1972 When the console need to be scrolled, this is the number of
1973 lines to scroll by. It defaults to 1. Increasing this makes
1974 the console jump but can help speed up operation when scrolling
1975 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001976
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001977 CONFIG_LCD_BMP_RLE8
1978
1979 Support drawing of RLE8-compressed bitmaps on the LCD.
1980
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001981 CONFIG_I2C_EDID
1982
1983 Enables an 'i2c edid' command which can read EDID
1984 information over I2C from an attached LCD display.
1985
wdenk7152b1d2003-09-05 23:19:14 +00001986- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001987
wdenk8bde7f72003-06-27 21:31:46 +00001988 If this option is set, the environment is checked for
1989 a variable "splashimage". If found, the usual display
1990 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001991 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001992 specified in "splashimage" is loaded instead. The
1993 console is redirected to the "nulldev", too. This
1994 allows for a "silent" boot where a splash screen is
1995 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001996
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001997 CONFIG_SPLASHIMAGE_GUARD
1998
1999 If this option is set, then U-Boot will prevent the environment
2000 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05002001 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002002 This option is useful for targets where, due to alignment
2003 restrictions, an improperly aligned BMP image will cause a data
2004 abort. If you think you will not have problems with unaligned
2005 accesses (for example because your toolchain prevents them)
2006 there is no need to set this option.
2007
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002008 CONFIG_SPLASH_SCREEN_ALIGN
2009
2010 If this option is set the splash image can be freely positioned
2011 on the screen. Environment variable "splashpos" specifies the
2012 position as "x,y". If a positive number is given it is used as
2013 number of pixel from left/top. If a negative number is given it
2014 is used as number of pixel from right/bottom. You can also
2015 specify 'm' for centering the image.
2016
2017 Example:
2018 setenv splashpos m,m
2019 => image at center of screen
2020
2021 setenv splashpos 30,20
2022 => image at x = 30 and y = 20
2023
2024 setenv splashpos -10,m
2025 => vertically centered image
2026 at x = dspWidth - bmpWidth - 9
2027
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002028- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2029
2030 If this option is set, additionally to standard BMP
2031 images, gzipped BMP images can be displayed via the
2032 splashscreen support or the bmp command.
2033
Anatolij Gustschind5011762010-03-15 14:50:25 +01002034- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2035
2036 If this option is set, 8-bit RLE compressed BMP images
2037 can be displayed via the splashscreen support or the
2038 bmp command.
2039
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002040- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002041 CONFIG_CMD_ZIP
2042
2043 If this option is set, it would use zlib deflate method
2044 to compress the specified memory at its best effort.
2045
wdenkc29fdfc2003-08-29 20:57:53 +00002046- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002047 CONFIG_GZIP
2048
2049 Enabled by default to support gzip compressed images.
2050
wdenkc29fdfc2003-08-29 20:57:53 +00002051 CONFIG_BZIP2
2052
2053 If this option is set, support for bzip2 compressed
2054 images is included. If not, only uncompressed and gzip
2055 compressed images are supported.
2056
wdenk42d1f032003-10-15 23:53:47 +00002057 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002058 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002059 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002060
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002061 CONFIG_LZMA
2062
2063 If this option is set, support for lzma compressed
2064 images is included.
2065
2066 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2067 requires an amount of dynamic memory that is given by the
2068 formula:
2069
2070 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2071
2072 Where lc and lp stand for, respectively, Literal context bits
2073 and Literal pos bits.
2074
2075 This value is upper-bounded by 14MB in the worst case. Anyway,
2076 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2077 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2078 a very small buffer.
2079
2080 Use the lzmainfo tool to determinate the lc and lp values and
2081 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002082 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002083
Kees Cook8ef70472013-08-16 07:59:12 -07002084 CONFIG_LZO
2085
2086 If this option is set, support for LZO compressed images
2087 is included.
2088
wdenk17ea1172004-06-06 21:51:03 +00002089- MII/PHY support:
2090 CONFIG_PHY_ADDR
2091
2092 The address of PHY on MII bus.
2093
2094 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2095
2096 The clock frequency of the MII bus
2097
2098 CONFIG_PHY_GIGE
2099
2100 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002101 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002102
2103 CONFIG_PHY_RESET_DELAY
2104
2105 Some PHY like Intel LXT971A need extra delay after
2106 reset before any MII register access is possible.
2107 For such PHY, set this option to the usec delay
2108 required. (minimum 300usec for LXT971A)
2109
2110 CONFIG_PHY_CMD_DELAY (ppc4xx)
2111
2112 Some PHY like Intel LXT971A need extra delay after
2113 command issued before MII status register can be read
2114
wdenkc6097192002-11-03 00:24:07 +00002115- Ethernet address:
2116 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002117 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002118 CONFIG_ETH2ADDR
2119 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002120 CONFIG_ETH4ADDR
2121 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002122
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002123 Define a default value for Ethernet address to use
2124 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002125 is not determined automatically.
2126
2127- IP address:
2128 CONFIG_IPADDR
2129
2130 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002131 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002132 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002133 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002134
2135- Server IP address:
2136 CONFIG_SERVERIP
2137
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002138 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002139 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002140 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002141
Robin Getz97cfe862009-07-21 12:15:28 -04002142 CONFIG_KEEP_SERVERADDR
2143
2144 Keeps the server's MAC address, in the env 'serveraddr'
2145 for passing to bootargs (like Linux's netconsole option)
2146
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002147- Gateway IP address:
2148 CONFIG_GATEWAYIP
2149
2150 Defines a default value for the IP address of the
2151 default router where packets to other networks are
2152 sent to.
2153 (Environment variable "gatewayip")
2154
2155- Subnet mask:
2156 CONFIG_NETMASK
2157
2158 Defines a default value for the subnet mask (or
2159 routing prefix) which is used to determine if an IP
2160 address belongs to the local subnet or needs to be
2161 forwarded through a router.
2162 (Environment variable "netmask")
2163
David Updegraff53a5c422007-06-11 10:41:07 -05002164- Multicast TFTP Mode:
2165 CONFIG_MCAST_TFTP
2166
2167 Defines whether you want to support multicast TFTP as per
2168 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002169 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002170 driver in use must provide a function: mcast() to join/leave a
2171 multicast group.
2172
wdenkc6097192002-11-03 00:24:07 +00002173- BOOTP Recovery Mode:
2174 CONFIG_BOOTP_RANDOM_DELAY
2175
2176 If you have many targets in a network that try to
2177 boot using BOOTP, you may want to avoid that all
2178 systems send out BOOTP requests at precisely the same
2179 moment (which would happen for instance at recovery
2180 from a power failure, when all systems will try to
2181 boot, thus flooding the BOOTP server. Defining
2182 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2183 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002184 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002185
2186 1st BOOTP request: delay 0 ... 1 sec
2187 2nd BOOTP request: delay 0 ... 2 sec
2188 3rd BOOTP request: delay 0 ... 4 sec
2189 4th and following
2190 BOOTP requests: delay 0 ... 8 sec
2191
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002192 CONFIG_BOOTP_ID_CACHE_SIZE
2193
2194 BOOTP packets are uniquely identified using a 32-bit ID. The
2195 server will copy the ID from client requests to responses and
2196 U-Boot will use this to determine if it is the destination of
2197 an incoming response. Some servers will check that addresses
2198 aren't in use before handing them out (usually using an ARP
2199 ping) and therefore take up to a few hundred milliseconds to
2200 respond. Network congestion may also influence the time it
2201 takes for a response to make it back to the client. If that
2202 time is too long, U-Boot will retransmit requests. In order
2203 to allow earlier responses to still be accepted after these
2204 retransmissions, U-Boot's BOOTP client keeps a small cache of
2205 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2206 cache. The default is to keep IDs for up to four outstanding
2207 requests. Increasing this will allow U-Boot to accept offers
2208 from a BOOTP client in networks with unusually high latency.
2209
stroesefe389a82003-08-28 14:17:32 +00002210- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002211 You can fine tune the DHCP functionality by defining
2212 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002213
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002214 CONFIG_BOOTP_SUBNETMASK
2215 CONFIG_BOOTP_GATEWAY
2216 CONFIG_BOOTP_HOSTNAME
2217 CONFIG_BOOTP_NISDOMAIN
2218 CONFIG_BOOTP_BOOTPATH
2219 CONFIG_BOOTP_BOOTFILESIZE
2220 CONFIG_BOOTP_DNS
2221 CONFIG_BOOTP_DNS2
2222 CONFIG_BOOTP_SEND_HOSTNAME
2223 CONFIG_BOOTP_NTPSERVER
2224 CONFIG_BOOTP_TIMEOFFSET
2225 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002226 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002227
Wilson Callan5d110f02007-07-28 10:56:13 -04002228 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2229 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002230
Joe Hershberger2c00e092012-05-23 07:59:19 +00002231 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2232 after the configured retry count, the call will fail
2233 instead of starting over. This can be used to fail over
2234 to Link-local IP address configuration if the DHCP server
2235 is not available.
2236
stroesefe389a82003-08-28 14:17:32 +00002237 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2238 serverip from a DHCP server, it is possible that more
2239 than one DNS serverip is offered to the client.
2240 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2241 serverip will be stored in the additional environment
2242 variable "dnsip2". The first DNS serverip is always
2243 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002244 is defined.
stroesefe389a82003-08-28 14:17:32 +00002245
2246 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2247 to do a dynamic update of a DNS server. To do this, they
2248 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002249 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002250 of the "hostname" environment variable is passed as
2251 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002252
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002253 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2254
2255 A 32bit value in microseconds for a delay between
2256 receiving a "DHCP Offer" and sending the "DHCP Request".
2257 This fixes a problem with certain DHCP servers that don't
2258 respond 100% of the time to a "DHCP request". E.g. On an
2259 AT91RM9200 processor running at 180MHz, this delay needed
2260 to be *at least* 15,000 usec before a Windows Server 2003
2261 DHCP server would reply 100% of the time. I recommend at
2262 least 50,000 usec to be safe. The alternative is to hope
2263 that one of the retries will be successful but note that
2264 the DHCP timeout and retry process takes a longer than
2265 this delay.
2266
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002267 - Link-local IP address negotiation:
2268 Negotiate with other link-local clients on the local network
2269 for an address that doesn't require explicit configuration.
2270 This is especially useful if a DHCP server cannot be guaranteed
2271 to exist in all environments that the device must operate.
2272
2273 See doc/README.link-local for more information.
2274
wdenka3d991b2004-04-15 21:48:45 +00002275 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002276 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002277
2278 The device id used in CDP trigger frames.
2279
2280 CONFIG_CDP_DEVICE_ID_PREFIX
2281
2282 A two character string which is prefixed to the MAC address
2283 of the device.
2284
2285 CONFIG_CDP_PORT_ID
2286
2287 A printf format string which contains the ascii name of
2288 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002289 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002290
2291 CONFIG_CDP_CAPABILITIES
2292
2293 A 32bit integer which indicates the device capabilities;
2294 0x00000010 for a normal host which does not forwards.
2295
2296 CONFIG_CDP_VERSION
2297
2298 An ascii string containing the version of the software.
2299
2300 CONFIG_CDP_PLATFORM
2301
2302 An ascii string containing the name of the platform.
2303
2304 CONFIG_CDP_TRIGGER
2305
2306 A 32bit integer sent on the trigger.
2307
2308 CONFIG_CDP_POWER_CONSUMPTION
2309
2310 A 16bit integer containing the power consumption of the
2311 device in .1 of milliwatts.
2312
2313 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2314
2315 A byte containing the id of the VLAN.
2316
wdenkc6097192002-11-03 00:24:07 +00002317- Status LED: CONFIG_STATUS_LED
2318
2319 Several configurations allow to display the current
2320 status using a LED. For instance, the LED will blink
2321 fast while running U-Boot code, stop blinking as
2322 soon as a reply to a BOOTP request was received, and
2323 start blinking slow once the Linux kernel is running
2324 (supported by a status LED driver in the Linux
2325 kernel). Defining CONFIG_STATUS_LED enables this
2326 feature in U-Boot.
2327
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002328 Additional options:
2329
2330 CONFIG_GPIO_LED
2331 The status LED can be connected to a GPIO pin.
2332 In such cases, the gpio_led driver can be used as a
2333 status LED backend implementation. Define CONFIG_GPIO_LED
2334 to include the gpio_led driver in the U-Boot binary.
2335
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002336 CONFIG_GPIO_LED_INVERTED_TABLE
2337 Some GPIO connected LEDs may have inverted polarity in which
2338 case the GPIO high value corresponds to LED off state and
2339 GPIO low value corresponds to LED on state.
2340 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2341 with a list of GPIO LEDs that have inverted polarity.
2342
wdenkc6097192002-11-03 00:24:07 +00002343- CAN Support: CONFIG_CAN_DRIVER
2344
2345 Defining CONFIG_CAN_DRIVER enables CAN driver support
2346 on those systems that support this (optional)
2347 feature, like the TQM8xxL modules.
2348
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002349- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002350
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002351 This enable the NEW i2c subsystem, and will allow you to use
2352 i2c commands at the u-boot command line (as long as you set
2353 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2354 based realtime clock chips or other i2c devices. See
2355 common/cmd_i2c.c for a description of the command line
2356 interface.
2357
2358 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002359 - drivers/i2c/soft_i2c.c:
2360 - activate first bus with CONFIG_SYS_I2C_SOFT define
2361 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2362 for defining speed and slave address
2363 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2364 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2365 for defining speed and slave address
2366 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2367 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2368 for defining speed and slave address
2369 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2370 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2371 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002372
Heiko Schocher00f792e2012-10-24 13:48:22 +02002373 - drivers/i2c/fsl_i2c.c:
2374 - activate i2c driver with CONFIG_SYS_I2C_FSL
2375 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2376 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2377 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2378 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002379 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002380 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2381 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2382 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2383 second bus.
2384
Simon Glass1f2ba722012-10-30 07:28:53 +00002385 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002386 - activate this driver with CONFIG_SYS_I2C_TEGRA
2387 - This driver adds 4 i2c buses with a fix speed from
2388 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002389
Dirk Eibach880540d2013-04-25 02:40:01 +00002390 - drivers/i2c/ppc4xx_i2c.c
2391 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2392 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2393 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2394
tremfac96402013-09-21 18:13:35 +02002395 - drivers/i2c/i2c_mxc.c
2396 - activate this driver with CONFIG_SYS_I2C_MXC
2397 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2398 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2399 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2400 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2401 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2402 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002403 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002404 for speed, and 0 for slave.
2405
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002406 - drivers/i2c/rcar_i2c.c:
2407 - activate this driver with CONFIG_SYS_I2C_RCAR
2408 - This driver adds 4 i2c buses
2409
2410 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2411 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2412 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2413 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2414 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2415 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2416 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2417 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2418 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2419
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002420 - drivers/i2c/sh_i2c.c:
2421 - activate this driver with CONFIG_SYS_I2C_SH
2422 - This driver adds from 2 to 5 i2c buses
2423
2424 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2425 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2426 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2427 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2428 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2429 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2430 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2431 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2432 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2433 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2434 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2435 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002436 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002437
Heiko Schocher6789e842013-10-22 11:03:18 +02002438 - drivers/i2c/omap24xx_i2c.c
2439 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2440 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2441 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2442 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2443 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2444 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2445 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2446 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2447 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2448 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2449 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2450
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002451 - drivers/i2c/zynq_i2c.c
2452 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2453 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2454 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2455
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302456 - drivers/i2c/s3c24x0_i2c.c:
2457 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2458 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2459 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2460 with a fix speed from 100000 and the slave addr 0!
2461
Dirk Eibachb46226b2014-07-03 09:28:18 +02002462 - drivers/i2c/ihs_i2c.c
2463 - activate this driver with CONFIG_SYS_I2C_IHS
2464 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2465 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2466 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2467 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2468 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2469 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2470 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2471 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2472 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2473 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2474 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2475 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2476
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002477 additional defines:
2478
2479 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002480 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002481 don't use/have i2c muxes on your i2c bus, this
2482 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2483 omit this define.
2484
2485 CONFIG_SYS_I2C_DIRECT_BUS
2486 define this, if you don't use i2c muxes on your hardware.
2487 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2488 omit this define.
2489
2490 CONFIG_SYS_I2C_MAX_HOPS
2491 define how many muxes are maximal consecutively connected
2492 on one i2c bus. If you not use i2c muxes, omit this
2493 define.
2494
2495 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002496 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002497 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2498 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2499 CONFIG_SYS_NUM_I2C_BUSES = 9:
2500
2501 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2502 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2503 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2504 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2505 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2506 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2507 {1, {I2C_NULL_HOP}}, \
2508 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2509 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2510 }
2511
2512 which defines
2513 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002514 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2515 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2516 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2517 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2518 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002519 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002520 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2521 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002522
2523 If you do not have i2c muxes on your board, omit this define.
2524
Heiko Schocherea818db2013-01-29 08:53:15 +01002525- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002526
2527 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2528 provides the following compelling advantages:
2529
2530 - more than one i2c adapter is usable
2531 - approved multibus support
2532 - better i2c mux support
2533
2534 ** Please consider updating your I2C driver now. **
2535
Heiko Schocherea818db2013-01-29 08:53:15 +01002536 These enable legacy I2C serial bus commands. Defining
2537 CONFIG_HARD_I2C will include the appropriate I2C driver
2538 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002539
wdenk945af8d2003-07-16 21:53:01 +00002540 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002541 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002542 CONFIG_COMMANDS) and communicate with i2c based realtime
2543 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002544 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002545
Ben Warrenbb99ad62006-09-07 16:50:54 -04002546 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk945af8d2003-07-16 21:53:01 +00002548 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002549 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002550
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002551 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002552 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002554 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002555
Peter Tyser8d321b82010-04-12 22:28:21 -05002556 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002557 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002558 and so its address should therefore be cleared to 0 (See,
2559 eg, MPC823e User's Manual p.16-473). So, set
2560 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002561
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002562 CONFIG_SYS_I2C_INIT_MPC5XXX
2563
2564 When a board is reset during an i2c bus transfer
2565 chips might think that the current transfer is still
2566 in progress. Reset the slave devices by sending start
2567 commands until the slave device responds.
2568
wdenk945af8d2003-07-16 21:53:01 +00002569 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002570
Heiko Schocherea818db2013-01-29 08:53:15 +01002571 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002572 then the following macros need to be defined (examples are
2573 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002574
2575 I2C_INIT
2576
wdenkb37c7e52003-06-30 16:24:52 +00002577 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002578 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002579
wdenkba56f622004-02-06 23:19:44 +00002580 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002581
wdenkc6097192002-11-03 00:24:07 +00002582 I2C_PORT
2583
wdenk43d96162003-03-06 00:02:04 +00002584 (Only for MPC8260 CPU). The I/O port to use (the code
2585 assumes both bits are on the same port). Valid values
2586 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002587
2588 I2C_ACTIVE
2589
2590 The code necessary to make the I2C data line active
2591 (driven). If the data line is open collector, this
2592 define can be null.
2593
wdenkb37c7e52003-06-30 16:24:52 +00002594 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2595
wdenkc6097192002-11-03 00:24:07 +00002596 I2C_TRISTATE
2597
2598 The code necessary to make the I2C data line tri-stated
2599 (inactive). If the data line is open collector, this
2600 define can be null.
2601
wdenkb37c7e52003-06-30 16:24:52 +00002602 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2603
wdenkc6097192002-11-03 00:24:07 +00002604 I2C_READ
2605
York Sun472d5462013-04-01 11:29:11 -07002606 Code that returns true if the I2C data line is high,
2607 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002608
wdenkb37c7e52003-06-30 16:24:52 +00002609 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2610
wdenkc6097192002-11-03 00:24:07 +00002611 I2C_SDA(bit)
2612
York Sun472d5462013-04-01 11:29:11 -07002613 If <bit> is true, sets the I2C data line high. If it
2614 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002615
wdenkb37c7e52003-06-30 16:24:52 +00002616 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002617 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002618 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002619
wdenkc6097192002-11-03 00:24:07 +00002620 I2C_SCL(bit)
2621
York Sun472d5462013-04-01 11:29:11 -07002622 If <bit> is true, sets the I2C clock line high. If it
2623 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002624
wdenkb37c7e52003-06-30 16:24:52 +00002625 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002626 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002627 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002628
wdenkc6097192002-11-03 00:24:07 +00002629 I2C_DELAY
2630
2631 This delay is invoked four times per clock cycle so this
2632 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002633 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002634 like:
2635
wdenkb37c7e52003-06-30 16:24:52 +00002636 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002637
Mike Frysinger793b5722010-07-21 13:38:02 -04002638 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2639
2640 If your arch supports the generic GPIO framework (asm/gpio.h),
2641 then you may alternatively define the two GPIOs that are to be
2642 used as SCL / SDA. Any of the previous I2C_xxx macros will
2643 have GPIO-based defaults assigned to them as appropriate.
2644
2645 You should define these to the GPIO value as given directly to
2646 the generic GPIO functions.
2647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002648 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002649
wdenk8bde7f72003-06-27 21:31:46 +00002650 When a board is reset during an i2c bus transfer
2651 chips might think that the current transfer is still
2652 in progress. On some boards it is possible to access
2653 the i2c SCLK line directly, either by using the
2654 processor pin as a GPIO or by having a second pin
2655 connected to the bus. If this option is defined a
2656 custom i2c_init_board() routine in boards/xxx/board.c
2657 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002658
Richard Retanubun26a33502010-04-12 15:08:17 -04002659 CONFIG_SYS_I2C_BOARD_LATE_INIT
2660
2661 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2662 defined a custom i2c_board_late_init() routine in
2663 boards/xxx/board.c is run AFTER the operations in i2c_init()
2664 is completed. This callpoint can be used to unreset i2c bus
2665 using CPU i2c controller register accesses for CPUs whose i2c
2666 controller provide such a method. It is called at the end of
2667 i2c_init() to allow i2c_init operations to setup the i2c bus
2668 controller on the CPU (e.g. setting bus speed & slave address).
2669
wdenk17ea1172004-06-06 21:51:03 +00002670 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2671
2672 This option enables configuration of bi_iic_fast[] flags
2673 in u-boot bd_info structure based on u-boot environment
2674 variable "i2cfast". (see also i2cfast)
2675
Ben Warrenbb99ad62006-09-07 16:50:54 -04002676 CONFIG_I2C_MULTI_BUS
2677
2678 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002679 must have a controller. At any point in time, only one bus is
2680 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002681 Note that bus numbering is zero-based.
2682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002684
2685 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002686 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002687 is set, specify a list of bus-device pairs. Otherwise, specify
2688 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002689
2690 e.g.
2691 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002692 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002693
2694 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2695
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002696 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002697 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002698
2699 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002701 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06002702
2703 If defined, then this indicates the I2C bus number for DDR SPD.
2704 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002707
2708 If defined, then this indicates the I2C bus number for the RTC.
2709 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002711 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002712
2713 If defined, then this indicates the I2C bus number for the DTT.
2714 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002716 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002717
2718 If defined, specifies the I2C address of the DTT device.
2719 If not defined, then U-Boot uses predefined value for
2720 specified DTT device.
2721
Andrew Dyer2ac69852008-12-29 17:36:01 -06002722 CONFIG_SOFT_I2C_READ_REPEATED_START
2723
2724 defining this will force the i2c_read() function in
2725 the soft_i2c driver to perform an I2C repeated start
2726 between writing the address pointer and reading the
2727 data. If this define is omitted the default behaviour
2728 of doing a stop-start sequence will be used. Most I2C
2729 devices can use either method, but some require one or
2730 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06002731
wdenkc6097192002-11-03 00:24:07 +00002732- SPI Support: CONFIG_SPI
2733
2734 Enables SPI driver (so far only tested with
2735 SPI EEPROM, also an instance works with Crystal A/D and
2736 D/As on the SACSng board)
2737
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002738 CONFIG_SH_SPI
2739
2740 Enables the driver for SPI controller on SuperH. Currently
2741 only SH7757 is supported.
2742
wdenkc6097192002-11-03 00:24:07 +00002743 CONFIG_SPI_X
2744
2745 Enables extended (16-bit) SPI EEPROM addressing.
2746 (symmetrical to CONFIG_I2C_X)
2747
2748 CONFIG_SOFT_SPI
2749
wdenk43d96162003-03-06 00:02:04 +00002750 Enables a software (bit-bang) SPI driver rather than
2751 using hardware support. This is a general purpose
2752 driver that only requires three general I/O port pins
2753 (two outputs, one input) to function. If this is
2754 defined, the board configuration must define several
2755 SPI configuration items (port pins to use, etc). For
2756 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002757
Ben Warren04a9e112008-01-16 22:37:35 -05002758 CONFIG_HARD_SPI
2759
2760 Enables a hardware SPI driver for general-purpose reads
2761 and writes. As with CONFIG_SOFT_SPI, the board configuration
2762 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002763 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002764 example, see include/configs/mpc8349emds.h.
2765
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002766 CONFIG_MXC_SPI
2767
2768 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002769 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002770
Heiko Schocherf659b572014-07-14 10:22:11 +02002771 CONFIG_SYS_SPI_MXC_WAIT
2772 Timeout for waiting until spi transfer completed.
2773 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2774
Matthias Fuchs01335022007-12-27 17:12:34 +01002775- FPGA Support: CONFIG_FPGA
2776
2777 Enables FPGA subsystem.
2778
2779 CONFIG_FPGA_<vendor>
2780
2781 Enables support for specific chip vendors.
2782 (ALTERA, XILINX)
2783
2784 CONFIG_FPGA_<family>
2785
2786 Enables support for FPGA family.
2787 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2788
2789 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002790
wdenk43d96162003-03-06 00:02:04 +00002791 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002792
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302793 CONFIG_CMD_FPGA_LOADMK
2794
2795 Enable support for fpga loadmk command
2796
Michal Simek67193862014-05-02 13:43:39 +02002797 CONFIG_CMD_FPGA_LOADP
2798
2799 Enable support for fpga loadp command - load partial bitstream
2800
2801 CONFIG_CMD_FPGA_LOADBP
2802
2803 Enable support for fpga loadbp command - load partial bitstream
2804 (Xilinx only)
2805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk8bde7f72003-06-27 21:31:46 +00002808 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002810 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002811
wdenk43d96162003-03-06 00:02:04 +00002812 Enable checks on FPGA configuration interface busy
2813 status by the configuration function. This option
2814 will require a board or device specific function to
2815 be written.
wdenkc6097192002-11-03 00:24:07 +00002816
2817 CONFIG_FPGA_DELAY
2818
2819 If defined, a function that provides delays in the FPGA
2820 configuration driver.
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002823 Allow Control-C to interrupt FPGA configuration
2824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk43d96162003-03-06 00:02:04 +00002827 Check for configuration errors during FPGA bitfile
2828 loading. For example, abort during Virtex II
2829 configuration if the INIT_B line goes low (which
2830 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002832 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002833
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002834 Maximum time to wait for the INIT_B line to de-assert
2835 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002836 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002837 ms.
wdenkc6097192002-11-03 00:24:07 +00002838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002839 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002840
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002841 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002842 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk43d96162003-03-06 00:02:04 +00002846 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002847 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002848
2849- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002850 CONFIG_BUILD_TARGET
2851
2852 Some SoCs need special image types (e.g. U-Boot binary
2853 with a special header) as build targets. By defining
2854 CONFIG_BUILD_TARGET in the SoC / board header, this
2855 special image will be automatically built upon calling
2856 make / MAKEALL.
2857
wdenkc6097192002-11-03 00:24:07 +00002858 CONFIG_IDENT_STRING
2859
wdenk43d96162003-03-06 00:02:04 +00002860 If defined, this string will be added to the U-Boot
2861 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002862
2863- Vendor Parameter Protection:
2864
wdenk43d96162003-03-06 00:02:04 +00002865 U-Boot considers the values of the environment
2866 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002867 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002868 are set once by the board vendor / manufacturer, and
2869 protects these variables from casual modification by
2870 the user. Once set, these variables are read-only,
2871 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002872 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002873
2874 If CONFIG_ENV_OVERWRITE is #defined in your config
2875 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002876 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002877 these parameters.
2878
2879 Alternatively, if you #define _both_ CONFIG_ETHADDR
2880 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002881 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002882 which can be changed exactly ONCE by the user. [The
2883 serial# is unaffected by this, i. e. it remains
2884 read-only.]
2885
Joe Hershberger25980902012-12-11 22:16:31 -06002886 The same can be accomplished in a more flexible way
2887 for any variable by configuring the type of access
2888 to allow for those variables in the ".flags" variable
2889 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2890
wdenkc6097192002-11-03 00:24:07 +00002891- Protected RAM:
2892 CONFIG_PRAM
2893
2894 Define this variable to enable the reservation of
2895 "protected RAM", i. e. RAM which is not overwritten
2896 by U-Boot. Define CONFIG_PRAM to hold the number of
2897 kB you want to reserve for pRAM. You can overwrite
2898 this default value by defining an environment
2899 variable "pram" to the number of kB you want to
2900 reserve. Note that the board info structure will
2901 still show the full amount of RAM. If pRAM is
2902 reserved, a new environment variable "mem" will
2903 automatically be defined to hold the amount of
2904 remaining RAM in a form that can be passed as boot
2905 argument to Linux, for instance like that:
2906
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002907 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002908 saveenv
2909
2910 This way you can tell Linux not to use this memory,
2911 either, which results in a memory region that will
2912 not be affected by reboots.
2913
2914 *WARNING* If your board configuration uses automatic
2915 detection of the RAM size, you must make sure that
2916 this memory test is non-destructive. So far, the
2917 following board configurations are known to be
2918 "pRAM-clean":
2919
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002920 IVMS8, IVML24, SPD8xx, TQM8xxL,
2921 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002922 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002923
Gabe Black40fef042012-12-02 04:55:18 +00002924- Access to physical memory region (> 4GB)
2925 Some basic support is provided for operations on memory not
2926 normally accessible to U-Boot - e.g. some architectures
2927 support access to more than 4GB of memory on 32-bit
2928 machines using physical address extension or similar.
2929 Define CONFIG_PHYSMEM to access this basic support, which
2930 currently only supports clearing the memory.
2931
wdenkc6097192002-11-03 00:24:07 +00002932- Error Recovery:
2933 CONFIG_PANIC_HANG
2934
2935 Define this variable to stop the system in case of a
2936 fatal error, so that you have to reset it manually.
2937 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002938 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002939 automatically as fast as possible, but it may be
2940 useful during development since you can try to debug
2941 the conditions that lead to the situation.
2942
2943 CONFIG_NET_RETRY_COUNT
2944
wdenk43d96162003-03-06 00:02:04 +00002945 This variable defines the number of retries for
2946 network operations like ARP, RARP, TFTP, or BOOTP
2947 before giving up the operation. If not defined, a
2948 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002949
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002950 CONFIG_ARP_TIMEOUT
2951
2952 Timeout waiting for an ARP reply in milliseconds.
2953
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002954 CONFIG_NFS_TIMEOUT
2955
2956 Timeout in milliseconds used in NFS protocol.
2957 If you encounter "ERROR: Cannot umount" in nfs command,
2958 try longer timeout such as
2959 #define CONFIG_NFS_TIMEOUT 10000UL
2960
wdenkc6097192002-11-03 00:24:07 +00002961- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002962 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002963
2964 Enable auto completion of commands using TAB.
2965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002966 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002967
2968 This defines the secondary prompt string, which is
2969 printed when the command interpreter needs more input
2970 to complete a command. Usually "> ".
2971
2972 Note:
2973
wdenk8bde7f72003-06-27 21:31:46 +00002974 In the current implementation, the local variables
2975 space and global environment variables space are
2976 separated. Local variables are those you define by
2977 simply typing `name=value'. To access a local
2978 variable later on, you have write `$name' or
2979 `${name}'; to execute the contents of a variable
2980 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk43d96162003-03-06 00:02:04 +00002982 Global environment variables are those you use
2983 setenv/printenv to work with. To run a command stored
2984 in such a variable, you need to use the run command,
2985 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002986
2987 To store commands and special characters in a
2988 variable, please use double quotation marks
2989 surrounding the whole text of the variable, instead
2990 of the backslashes before semicolons and special
2991 symbols.
2992
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002993- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002994 CONFIG_CMDLINE_EDITING
2995
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002996 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002997 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002998
wdenka8c7c702003-12-06 19:49:23 +00002999- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003000 CONFIG_EXTRA_ENV_SETTINGS
3001
wdenk43d96162003-03-06 00:02:04 +00003002 Define this to contain any number of null terminated
3003 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003004 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003005
wdenk43d96162003-03-06 00:02:04 +00003006 For example, place something like this in your
3007 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003008
3009 #define CONFIG_EXTRA_ENV_SETTINGS \
3010 "myvar1=value1\0" \
3011 "myvar2=value2\0"
3012
wdenk43d96162003-03-06 00:02:04 +00003013 Warning: This method is based on knowledge about the
3014 internal format how the environment is stored by the
3015 U-Boot code. This is NOT an official, exported
3016 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003017 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003018 You better know what you are doing here.
3019
wdenk43d96162003-03-06 00:02:04 +00003020 Note: overly (ab)use of the default environment is
3021 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003022 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003023 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003024
Stephen Warren5e724ca2012-05-22 09:21:54 +00003025 CONFIG_ENV_VARS_UBOOT_CONFIG
3026
3027 Define this in order to add variables describing the
3028 U-Boot build configuration to the default environment.
3029 These will be named arch, cpu, board, vendor, and soc.
3030
3031 Enabling this option will cause the following to be defined:
3032
3033 - CONFIG_SYS_ARCH
3034 - CONFIG_SYS_CPU
3035 - CONFIG_SYS_BOARD
3036 - CONFIG_SYS_VENDOR
3037 - CONFIG_SYS_SOC
3038
Tom Rini7e27f892012-10-24 07:28:16 +00003039 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3040
3041 Define this in order to add variables describing certain
3042 run-time determined information about the hardware to the
3043 environment. These will be named board_name, board_rev.
3044
Simon Glass06fd8532012-11-30 13:01:17 +00003045 CONFIG_DELAY_ENVIRONMENT
3046
3047 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003048 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00003049 that so that the environment is not available until
3050 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3051 this is instead controlled by the value of
3052 /config/load-environment.
3053
wdenka8c7c702003-12-06 19:49:23 +00003054- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003055 CONFIG_HAS_DATAFLASH
3056
wdenk8bde7f72003-06-27 21:31:46 +00003057 Defining this option enables DataFlash features and
3058 allows to read/write in Dataflash via the standard
3059 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003060
Eric Nelsonf61ec452012-01-31 10:52:08 -07003061- Serial Flash support
3062 CONFIG_CMD_SF
3063
3064 Defining this option enables SPI flash commands
3065 'sf probe/read/write/erase/update'.
3066
3067 Usage requires an initial 'probe' to define the serial
3068 flash parameters, followed by read/write/erase/update
3069 commands.
3070
3071 The following defaults may be provided by the platform
3072 to handle the common case when only a single serial
3073 flash is present on the system.
3074
3075 CONFIG_SF_DEFAULT_BUS Bus identifier
3076 CONFIG_SF_DEFAULT_CS Chip-select
3077 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3078 CONFIG_SF_DEFAULT_SPEED in Hz
3079
Simon Glass24007272012-10-08 13:16:02 +00003080 CONFIG_CMD_SF_TEST
3081
3082 Define this option to include a destructive SPI flash
3083 test ('sf test').
3084
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303085 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3086
3087 Define this option to use the Bank addr/Extended addr
3088 support on SPI flashes which has size > 16Mbytes.
3089
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303090 CONFIG_SF_DUAL_FLASH Dual flash memories
3091
3092 Define this option to use dual flash support where two flash
3093 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003094 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303095
Heiko Schocher562f8df2014-07-18 06:07:21 +02003096 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3097 enable the W#/Vpp signal to disable writing to the status
3098 register on ST MICRON flashes like the N25Q128.
3099 The status register write enable/disable bit, combined with
3100 the W#/VPP signal provides hardware data protection for the
3101 device as follows: When the enable/disable bit is set to 1,
3102 and the W#/VPP signal is driven LOW, the status register
3103 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3104 operation will not execute. The only way to exit this
3105 hardware-protected mode is to drive W#/VPP HIGH.
3106
wdenk3f85ce22004-02-23 16:11:30 +00003107- SystemACE Support:
3108 CONFIG_SYSTEMACE
3109
3110 Adding this option adds support for Xilinx SystemACE
3111 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003112 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003113 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003114
3115 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003116 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003117
3118 When SystemACE support is added, the "ace" device type
3119 becomes available to the fat commands, i.e. fatls.
3120
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003121- TFTP Fixed UDP Port:
3122 CONFIG_TFTP_PORT
3123
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003124 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003125 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003126 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003127 number generator is used.
3128
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003129 Also, the environment variable tftpdstp is used to supply
3130 the TFTP UDP destination port value. If tftpdstp isn't
3131 defined, the normal port 69 is used.
3132
3133 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003134 blindly start the TFTP transfer using the pre-configured
3135 target IP address and UDP port. This has the effect of
3136 "punching through" the (Windows XP) firewall, allowing
3137 the remainder of the TFTP transfer to proceed normally.
3138 A better solution is to properly configure the firewall,
3139 but sometimes that is not allowed.
3140
Simon Glassbf36c5d2012-12-05 14:46:38 +00003141- Hashing support:
3142 CONFIG_CMD_HASH
3143
3144 This enables a generic 'hash' command which can produce
3145 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3146
3147 CONFIG_HASH_VERIFY
3148
3149 Enable the hash verify command (hash -v). This adds to code
3150 size a little.
3151
3152 CONFIG_SHA1 - support SHA1 hashing
3153 CONFIG_SHA256 - support SHA256 hashing
3154
3155 Note: There is also a sha1sum command, which should perhaps
3156 be deprecated in favour of 'hash sha1'.
3157
Robert Winklera11f1872013-07-24 17:57:06 -07003158- Freescale i.MX specific commands:
3159 CONFIG_CMD_HDMIDETECT
3160 This enables 'hdmidet' command which returns true if an
3161 HDMI monitor is detected. This command is i.MX 6 specific.
3162
3163 CONFIG_CMD_BMODE
3164 This enables the 'bmode' (bootmode) command for forcing
3165 a boot from specific media.
3166
3167 This is useful for forcing the ROM's usb downloader to
3168 activate upon a watchdog reset which is nice when iterating
3169 on U-Boot. Using the reset button or running bmode normal
3170 will set it back to normal. This command currently
3171 supports i.MX53 and i.MX6.
3172
Simon Glass19c402a2013-06-13 15:10:02 -07003173- Signing support:
3174 CONFIG_RSA
3175
3176 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003177 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003178
3179 The signing part is build into mkimage regardless of this
3180 option.
3181
Heiko Schocher9e50c402014-01-25 07:27:13 +01003182- bootcount support:
3183 CONFIG_BOOTCOUNT_LIMIT
3184
3185 This enables the bootcounter support, see:
3186 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3187
3188 CONFIG_AT91SAM9XE
3189 enable special bootcounter support on at91sam9xe based boards.
3190 CONFIG_BLACKFIN
3191 enable special bootcounter support on blackfin based boards.
3192 CONFIG_SOC_DA8XX
3193 enable special bootcounter support on da850 based boards.
3194 CONFIG_BOOTCOUNT_RAM
3195 enable support for the bootcounter in RAM
3196 CONFIG_BOOTCOUNT_I2C
3197 enable support for the bootcounter on an i2c (like RTC) device.
3198 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3199 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3200 the bootcounter.
3201 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003202
wdenka8c7c702003-12-06 19:49:23 +00003203- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003204 CONFIG_SHOW_BOOT_PROGRESS
3205
wdenk43d96162003-03-06 00:02:04 +00003206 Defining this option allows to add some board-
3207 specific code (calling a user-provided function
3208 "show_boot_progress(int)") that enables you to show
3209 the system's boot progress on some display (for
3210 example, some LED's) on your board. At the moment,
3211 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003212
Simon Glass3a608ca2012-02-13 13:51:19 +00003213- Detailed boot stage timing
3214 CONFIG_BOOTSTAGE
3215 Define this option to get detailed timing of each stage
3216 of the boot process.
3217
3218 CONFIG_BOOTSTAGE_USER_COUNT
3219 This is the number of available user bootstage records.
3220 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3221 a new ID will be allocated from this stash. If you exceed
3222 the limit, recording will stop.
3223
3224 CONFIG_BOOTSTAGE_REPORT
3225 Define this to print a report before boot, similar to this:
3226
3227 Timer summary in microseconds:
3228 Mark Elapsed Stage
3229 0 0 reset
3230 3,575,678 3,575,678 board_init_f start
3231 3,575,695 17 arch_cpu_init A9
3232 3,575,777 82 arch_cpu_init done
3233 3,659,598 83,821 board_init_r start
3234 3,910,375 250,777 main_loop
3235 29,916,167 26,005,792 bootm_start
3236 30,361,327 445,160 start_kernel
3237
Simon Glass2eba38c2012-09-28 08:56:39 +00003238 CONFIG_CMD_BOOTSTAGE
3239 Add a 'bootstage' command which supports printing a report
3240 and un/stashing of bootstage data.
3241
Simon Glass94fd1312012-09-28 08:56:37 +00003242 CONFIG_BOOTSTAGE_FDT
3243 Stash the bootstage information in the FDT. A root 'bootstage'
3244 node is created with each bootstage id as a child. Each child
3245 has a 'name' property and either 'mark' containing the
3246 mark time in microsecond, or 'accum' containing the
3247 accumulated time for that bootstage id in microseconds.
3248 For example:
3249
3250 bootstage {
3251 154 {
3252 name = "board_init_f";
3253 mark = <3575678>;
3254 };
3255 170 {
3256 name = "lcd";
3257 accum = <33482>;
3258 };
3259 };
3260
3261 Code in the Linux kernel can find this in /proc/devicetree.
3262
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003263Legacy uImage format:
3264
wdenkc6097192002-11-03 00:24:07 +00003265 Arg Where When
3266 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003267 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003268 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003269 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003270 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003271 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003272 4 common/cmd_bootm.c Image data has correct checksum
3273 -4 common/cmd_bootm.c Image is for unsupported architecture
3274 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003275 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003276 6 common/cmd_bootm.c Image Type check OK
3277 -6 common/cmd_bootm.c gunzip uncompression error
3278 -7 common/cmd_bootm.c Unimplemented compression type
3279 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003280 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003281 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003282
3283 9 common/image.c Start initial ramdisk verification
3284 -10 common/image.c Ramdisk header has bad magic number
3285 -11 common/image.c Ramdisk header has bad checksum
3286 10 common/image.c Ramdisk header is OK
3287 -12 common/image.c Ramdisk data has bad checksum
3288 11 common/image.c Ramdisk data has correct checksum
3289 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003290 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003291 13 common/image.c Start multifile image verification
3292 14 common/image.c No initial ramdisk, no multifile, continue.
3293
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003294 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003295
Stefan Roesea47a12b2010-04-15 16:07:28 +02003296 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003297 -31 post/post.c POST test failed, detected by post_output_backlog()
3298 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003299
Heiko Schocher566a4942007-06-22 19:11:54 +02003300 34 common/cmd_doc.c before loading a Image from a DOC device
3301 -35 common/cmd_doc.c Bad usage of "doc" command
3302 35 common/cmd_doc.c correct usage of "doc" command
3303 -36 common/cmd_doc.c No boot device
3304 36 common/cmd_doc.c correct boot device
3305 -37 common/cmd_doc.c Unknown Chip ID on boot device
3306 37 common/cmd_doc.c correct chip ID found, device available
3307 -38 common/cmd_doc.c Read Error on boot device
3308 38 common/cmd_doc.c reading Image header from DOC device OK
3309 -39 common/cmd_doc.c Image header has bad magic number
3310 39 common/cmd_doc.c Image header has correct magic number
3311 -40 common/cmd_doc.c Error reading Image from DOC device
3312 40 common/cmd_doc.c Image header has correct magic number
3313 41 common/cmd_ide.c before loading a Image from a IDE device
3314 -42 common/cmd_ide.c Bad usage of "ide" command
3315 42 common/cmd_ide.c correct usage of "ide" command
3316 -43 common/cmd_ide.c No boot device
3317 43 common/cmd_ide.c boot device found
3318 -44 common/cmd_ide.c Device not available
3319 44 common/cmd_ide.c Device available
3320 -45 common/cmd_ide.c wrong partition selected
3321 45 common/cmd_ide.c partition selected
3322 -46 common/cmd_ide.c Unknown partition table
3323 46 common/cmd_ide.c valid partition table found
3324 -47 common/cmd_ide.c Invalid partition type
3325 47 common/cmd_ide.c correct partition type
3326 -48 common/cmd_ide.c Error reading Image Header on boot device
3327 48 common/cmd_ide.c reading Image Header from IDE device OK
3328 -49 common/cmd_ide.c Image header has bad magic number
3329 49 common/cmd_ide.c Image header has correct magic number
3330 -50 common/cmd_ide.c Image header has bad checksum
3331 50 common/cmd_ide.c Image header has correct checksum
3332 -51 common/cmd_ide.c Error reading Image from IDE device
3333 51 common/cmd_ide.c reading Image from IDE device OK
3334 52 common/cmd_nand.c before loading a Image from a NAND device
3335 -53 common/cmd_nand.c Bad usage of "nand" command
3336 53 common/cmd_nand.c correct usage of "nand" command
3337 -54 common/cmd_nand.c No boot device
3338 54 common/cmd_nand.c boot device found
3339 -55 common/cmd_nand.c Unknown Chip ID on boot device
3340 55 common/cmd_nand.c correct chip ID found, device available
3341 -56 common/cmd_nand.c Error reading Image Header on boot device
3342 56 common/cmd_nand.c reading Image Header from NAND device OK
3343 -57 common/cmd_nand.c Image header has bad magic number
3344 57 common/cmd_nand.c Image header has correct magic number
3345 -58 common/cmd_nand.c Error reading Image from NAND device
3346 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003347
Heiko Schocher566a4942007-06-22 19:11:54 +02003348 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003349
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003350 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003351 -64 net/eth.c no Ethernet found.
3352 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003353
Heiko Schocher566a4942007-06-22 19:11:54 +02003354 -80 common/cmd_net.c usage wrong
3355 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003356 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003357 81 common/cmd_net.c NetLoop() back without error
3358 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3359 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003360 83 common/cmd_net.c running "source" command
3361 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003362 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003363
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003364FIT uImage format:
3365
3366 Arg Where When
3367 100 common/cmd_bootm.c Kernel FIT Image has correct format
3368 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3369 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3370 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3371 102 common/cmd_bootm.c Kernel unit name specified
3372 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003373 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003374 104 common/cmd_bootm.c Got kernel subimage node offset
3375 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3376 105 common/cmd_bootm.c Kernel subimage hash verification OK
3377 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3378 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003379 -106 common/cmd_bootm.c Kernel subimage has wrong type
3380 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003381 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3382 108 common/cmd_bootm.c Got kernel subimage data/size
3383 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3384 -109 common/cmd_bootm.c Can't get kernel subimage type
3385 -110 common/cmd_bootm.c Can't get kernel subimage comp
3386 -111 common/cmd_bootm.c Can't get kernel subimage os
3387 -112 common/cmd_bootm.c Can't get kernel subimage load address
3388 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3389
3390 120 common/image.c Start initial ramdisk verification
3391 -120 common/image.c Ramdisk FIT image has incorrect format
3392 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003393 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003394 -122 common/image.c Can't get configuration for ramdisk subimage
3395 123 common/image.c Ramdisk unit name specified
3396 -124 common/image.c Can't get ramdisk subimage node offset
3397 125 common/image.c Got ramdisk subimage node offset
3398 -125 common/image.c Ramdisk subimage hash verification failed
3399 126 common/image.c Ramdisk subimage hash verification OK
3400 -126 common/image.c Ramdisk subimage for unsupported architecture
3401 127 common/image.c Architecture check OK
3402 -127 common/image.c Can't get ramdisk subimage data/size
3403 128 common/image.c Got ramdisk subimage data/size
3404 129 common/image.c Can't get ramdisk load address
3405 -129 common/image.c Got ramdisk load address
3406
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003407 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003408 131 common/cmd_doc.c FIT image format OK
3409
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003410 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003411 141 common/cmd_ide.c FIT image format OK
3412
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003413 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003414 151 common/cmd_nand.c FIT image format OK
3415
Heiko Schocher21d29f72014-05-28 11:33:33 +02003416- legacy image format:
3417 CONFIG_IMAGE_FORMAT_LEGACY
3418 enables the legacy image format support in U-Boot.
3419
3420 Default:
3421 enabled if CONFIG_FIT_SIGNATURE is not defined.
3422
3423 CONFIG_DISABLE_IMAGE_LEGACY
3424 disable the legacy image format
3425
3426 This define is introduced, as the legacy image format is
3427 enabled per default for backward compatibility.
3428
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003429- FIT image support:
3430 CONFIG_FIT
3431 Enable support for the FIT uImage format.
3432
3433 CONFIG_FIT_BEST_MATCH
3434 When no configuration is explicitly selected, default to the
3435 one whose fdt's compatibility field best matches that of
3436 U-Boot itself. A match is considered "best" if it matches the
3437 most specific compatibility entry of U-Boot's fdt's root node.
3438 The order of entries in the configuration's fdt is ignored.
3439
Simon Glass3e569a62013-06-13 15:10:00 -07003440 CONFIG_FIT_SIGNATURE
3441 This option enables signature verification of FIT uImages,
3442 using a hash signed and verified using RSA. See
3443 doc/uImage.FIT/signature.txt for more details.
3444
Heiko Schocher21d29f72014-05-28 11:33:33 +02003445 WARNING: When relying on signed FIT images with required
3446 signature check the legacy image format is default
3447 disabled. If a board need legacy image format support
3448 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3449
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003450 CONFIG_FIT_DISABLE_SHA256
3451 Supporting SHA256 hashes has quite an impact on binary size.
3452 For constrained systems sha256 hash support can be disabled
3453 with this option.
3454
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003455- Standalone program support:
3456 CONFIG_STANDALONE_LOAD_ADDR
3457
Wolfgang Denk6feff892011-10-09 21:06:34 +02003458 This option defines a board specific value for the
3459 address where standalone program gets loaded, thus
3460 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003461 settings.
3462
3463- Frame Buffer Address:
3464 CONFIG_FB_ADDR
3465
3466 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003467 address for frame buffer. This is typically the case
3468 when using a graphics controller has separate video
3469 memory. U-Boot will then place the frame buffer at
3470 the given address instead of dynamically reserving it
3471 in system RAM by calling lcd_setmem(), which grabs
3472 the memory for the frame buffer depending on the
3473 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003474
3475 Please see board_init_f function.
3476
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003477- Automatic software updates via TFTP server
3478 CONFIG_UPDATE_TFTP
3479 CONFIG_UPDATE_TFTP_CNT_MAX
3480 CONFIG_UPDATE_TFTP_MSEC_MAX
3481
3482 These options enable and control the auto-update feature;
3483 for a more detailed description refer to doc/README.update.
3484
3485- MTD Support (mtdparts command, UBI support)
3486 CONFIG_MTD_DEVICE
3487
3488 Adds the MTD device infrastructure from the Linux kernel.
3489 Needed for mtdparts command support.
3490
3491 CONFIG_MTD_PARTITIONS
3492
3493 Adds the MTD partitioning infrastructure from the Linux
3494 kernel. Needed for UBI support.
3495
Heiko Schocherff94bc42014-06-24 10:10:04 +02003496 CONFIG_MTD_NAND_VERIFY_WRITE
3497 verify if the written data is correct reread.
3498
Joe Hershberger70c219c2013-04-08 10:32:48 +00003499- UBI support
3500 CONFIG_CMD_UBI
3501
3502 Adds commands for interacting with MTD partitions formatted
3503 with the UBI flash translation layer
3504
3505 Requires also defining CONFIG_RBTREE
3506
Joe Hershberger147162d2013-04-08 10:32:49 +00003507 CONFIG_UBI_SILENCE_MSG
3508
3509 Make the verbose messages from UBI stop printing. This leaves
3510 warnings and errors enabled.
3511
Heiko Schocherff94bc42014-06-24 10:10:04 +02003512
3513 CONFIG_MTD_UBI_WL_THRESHOLD
3514 This parameter defines the maximum difference between the highest
3515 erase counter value and the lowest erase counter value of eraseblocks
3516 of UBI devices. When this threshold is exceeded, UBI starts performing
3517 wear leveling by means of moving data from eraseblock with low erase
3518 counter to eraseblocks with high erase counter.
3519
3520 The default value should be OK for SLC NAND flashes, NOR flashes and
3521 other flashes which have eraseblock life-cycle 100000 or more.
3522 However, in case of MLC NAND flashes which typically have eraseblock
3523 life-cycle less than 10000, the threshold should be lessened (e.g.,
3524 to 128 or 256, although it does not have to be power of 2).
3525
3526 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003527
Heiko Schocherff94bc42014-06-24 10:10:04 +02003528 CONFIG_MTD_UBI_BEB_LIMIT
3529 This option specifies the maximum bad physical eraseblocks UBI
3530 expects on the MTD device (per 1024 eraseblocks). If the
3531 underlying flash does not admit of bad eraseblocks (e.g. NOR
3532 flash), this value is ignored.
3533
3534 NAND datasheets often specify the minimum and maximum NVM
3535 (Number of Valid Blocks) for the flashes' endurance lifetime.
3536 The maximum expected bad eraseblocks per 1024 eraseblocks
3537 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3538 which gives 20 for most NANDs (MaxNVB is basically the total
3539 count of eraseblocks on the chip).
3540
3541 To put it differently, if this value is 20, UBI will try to
3542 reserve about 1.9% of physical eraseblocks for bad blocks
3543 handling. And that will be 1.9% of eraseblocks on the entire
3544 NAND chip, not just the MTD partition UBI attaches. This means
3545 that if you have, say, a NAND flash chip admits maximum 40 bad
3546 eraseblocks, and it is split on two MTD partitions of the same
3547 size, UBI will reserve 40 eraseblocks when attaching a
3548 partition.
3549
3550 default: 20
3551
3552 CONFIG_MTD_UBI_FASTMAP
3553 Fastmap is a mechanism which allows attaching an UBI device
3554 in nearly constant time. Instead of scanning the whole MTD device it
3555 only has to locate a checkpoint (called fastmap) on the device.
3556 The on-flash fastmap contains all information needed to attach
3557 the device. Using fastmap makes only sense on large devices where
3558 attaching by scanning takes long. UBI will not automatically install
3559 a fastmap on old images, but you can set the UBI parameter
3560 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3561 that fastmap-enabled images are still usable with UBI implementations
3562 without fastmap support. On typical flash devices the whole fastmap
3563 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3564
3565 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3566 Set this parameter to enable fastmap automatically on images
3567 without a fastmap.
3568 default: 0
3569
Joe Hershberger70c219c2013-04-08 10:32:48 +00003570- UBIFS support
3571 CONFIG_CMD_UBIFS
3572
3573 Adds commands for interacting with UBI volumes formatted as
3574 UBIFS. UBIFS is read-only in u-boot.
3575
3576 Requires UBI support as well as CONFIG_LZO
3577
Joe Hershberger147162d2013-04-08 10:32:49 +00003578 CONFIG_UBIFS_SILENCE_MSG
3579
3580 Make the verbose messages from UBIFS stop printing. This leaves
3581 warnings and errors enabled.
3582
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003583- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003584 CONFIG_SPL
3585 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003586
Tom Rini95579792012-02-14 07:29:40 +00003587 CONFIG_SPL_LDSCRIPT
3588 LDSCRIPT for linking the SPL binary.
3589
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003590 CONFIG_SPL_MAX_FOOTPRINT
3591 Maximum size in memory allocated to the SPL, BSS included.
3592 When defined, the linker checks that the actual memory
3593 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003594 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003595 must not be both defined at the same time.
3596
Tom Rini95579792012-02-14 07:29:40 +00003597 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003598 Maximum size of the SPL image (text, data, rodata, and
3599 linker lists sections), BSS excluded.
3600 When defined, the linker checks that the actual size does
3601 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003602
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003603 CONFIG_SPL_TEXT_BASE
3604 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003605
Scott Wood94a45bb2012-09-20 19:05:12 -05003606 CONFIG_SPL_RELOC_TEXT_BASE
3607 Address to relocate to. If unspecified, this is equal to
3608 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3609
Tom Rini95579792012-02-14 07:29:40 +00003610 CONFIG_SPL_BSS_START_ADDR
3611 Link address for the BSS within the SPL binary.
3612
3613 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003614 Maximum size in memory allocated to the SPL BSS.
3615 When defined, the linker checks that the actual memory used
3616 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003617 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003618 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003619
3620 CONFIG_SPL_STACK
3621 Adress of the start of the stack SPL will use
3622
Scott Wood94a45bb2012-09-20 19:05:12 -05003623 CONFIG_SPL_RELOC_STACK
3624 Adress of the start of the stack SPL will use after
3625 relocation. If unspecified, this is equal to
3626 CONFIG_SPL_STACK.
3627
Tom Rini95579792012-02-14 07:29:40 +00003628 CONFIG_SYS_SPL_MALLOC_START
3629 Starting address of the malloc pool used in SPL.
3630
3631 CONFIG_SYS_SPL_MALLOC_SIZE
3632 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003633
Tom Rini47f7bca2012-08-13 12:03:19 -07003634 CONFIG_SPL_FRAMEWORK
3635 Enable the SPL framework under common/. This framework
3636 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3637 NAND loading of the Linux Kernel.
3638
Tom Rini9607faf2014-03-28 12:03:39 -04003639 CONFIG_SPL_OS_BOOT
3640 Enable booting directly to an OS from SPL.
3641 See also: doc/README.falcon
3642
Tom Rini861a86f2012-08-13 11:37:56 -07003643 CONFIG_SPL_DISPLAY_PRINT
3644 For ARM, enable an optional function to print more information
3645 about the running system.
3646
Scott Wood4b919722012-09-20 16:35:21 -05003647 CONFIG_SPL_INIT_MINIMAL
3648 Arch init code should be built for a very small image
3649
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003650 CONFIG_SPL_LIBCOMMON_SUPPORT
3651 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003652
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003653 CONFIG_SPL_LIBDISK_SUPPORT
3654 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003655
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003656 CONFIG_SPL_I2C_SUPPORT
3657 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003658
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003659 CONFIG_SPL_GPIO_SUPPORT
3660 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003661
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003662 CONFIG_SPL_MMC_SUPPORT
3663 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003664
Tom Rini95579792012-02-14 07:29:40 +00003665 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3666 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003667 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003668 when the MMC is being used in raw mode.
3669
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003670 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3671 Partition on the MMC to load U-Boot from when the MMC is being
3672 used in raw mode
3673
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003674 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3675 Sector to load kernel uImage from when MMC is being
3676 used in raw mode (for Falcon mode)
3677
3678 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3679 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3680 Sector and number of sectors to load kernel argument
3681 parameters from when MMC is being used in raw mode
3682 (for falcon mode)
3683
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003684 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3685 Partition on the MMC to load U-Boot from when the MMC is being
3686 used in fs mode
3687
Tom Rini95579792012-02-14 07:29:40 +00003688 CONFIG_SPL_FAT_SUPPORT
3689 Support for fs/fat/libfat.o in SPL binary
3690
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003691 CONFIG_SPL_EXT_SUPPORT
3692 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003693
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003694 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3695 Filename to read to load U-Boot when reading from filesystem
3696
3697 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003698 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003699 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003700
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003701 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003702 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003703 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003704
Scott Wood06f60ae2012-12-06 13:33:17 +00003705 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3706 Set this for NAND SPL on PPC mpc83xx targets, so that
3707 start.S waits for the rest of the SPL to load before
3708 continuing (the hardware starts execution after just
3709 loading the first page rather than the full 4K).
3710
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303711 CONFIG_SPL_SKIP_RELOCATE
3712 Avoid SPL relocation
3713
Scott Wood6f2f01b2012-09-20 19:09:07 -05003714 CONFIG_SPL_NAND_BASE
3715 Include nand_base.c in the SPL. Requires
3716 CONFIG_SPL_NAND_DRIVERS.
3717
3718 CONFIG_SPL_NAND_DRIVERS
3719 SPL uses normal NAND drivers, not minimal drivers.
3720
3721 CONFIG_SPL_NAND_ECC
3722 Include standard software ECC in the SPL
3723
Tom Rini95579792012-02-14 07:29:40 +00003724 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003725 Support for NAND boot using simple NAND drivers that
3726 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003727
Tom Rini6dd3b562014-03-28 12:03:36 -04003728 CONFIG_SPL_MTD_SUPPORT
3729 Support for the MTD subsystem within SPL. Useful for
3730 environment on NAND support within SPL.
3731
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003732 CONFIG_SPL_NAND_RAW_ONLY
3733 Support to boot only raw u-boot.bin images. Use this only
3734 if you need to save space.
3735
Ying Zhangbb0dc102013-08-16 15:16:11 +08003736 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3737 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003738 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003739
Ying Zhang7c8eea52013-08-16 15:16:12 +08003740 CONFIG_SPL_COMMON_INIT_DDR
3741 Set for common ddr init with serial presence detect in
3742 SPL binary.
3743
Tom Rini95579792012-02-14 07:29:40 +00003744 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3745 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3746 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3747 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3748 CONFIG_SYS_NAND_ECCBYTES
3749 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003750 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003751
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303752 CONFIG_SPL_NAND_BOOT
3753 Add support NAND boot
3754
Tom Rini95579792012-02-14 07:29:40 +00003755 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003756 Location in NAND to read U-Boot from
3757
3758 CONFIG_SYS_NAND_U_BOOT_DST
3759 Location in memory to load U-Boot to
3760
3761 CONFIG_SYS_NAND_U_BOOT_SIZE
3762 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003763
3764 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003765 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003766
3767 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3768 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003769 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003770
3771 CONFIG_SPL_OMAP3_ID_NAND
3772 Support for an OMAP3-specific set of functions to return the
3773 ID and MFR of the first attached NAND chip, if present.
3774
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003775 CONFIG_SPL_SERIAL_SUPPORT
3776 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003777
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003778 CONFIG_SPL_SPI_FLASH_SUPPORT
3779 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003780
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003781 CONFIG_SPL_SPI_SUPPORT
3782 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003783
Pavel Machekc57b9532012-08-30 22:42:11 +02003784 CONFIG_SPL_RAM_DEVICE
3785 Support for running image already present in ram, in SPL binary
3786
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003787 CONFIG_SPL_LIBGENERIC_SUPPORT
3788 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003789
Ying Zhangba1bee42013-05-20 14:07:25 +08003790 CONFIG_SPL_ENV_SUPPORT
3791 Support for the environment operating in SPL binary
3792
3793 CONFIG_SPL_NET_SUPPORT
3794 Support for the net/libnet.o in SPL binary.
3795 It conflicts with SPL env from storage medium specified by
3796 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3797
Scott Wood74752ba2012-12-06 13:33:16 +00003798 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003799 Image offset to which the SPL should be padded before appending
3800 the SPL payload. By default, this is defined as
3801 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3802 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3803 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003804
Scott Woodca2fca22012-09-21 16:27:32 -05003805 CONFIG_SPL_TARGET
3806 Final target image containing SPL and payload. Some SPLs
3807 use an arch-specific makefile fragment instead, for
3808 example if more than one image needs to be produced.
3809
Simon Glass87ebee32013-05-08 08:05:59 +00003810 CONFIG_FIT_SPL_PRINT
3811 Printing information about a FIT image adds quite a bit of
3812 code to SPL. So this is normally disabled in SPL. Use this
3813 option to re-enable it. This will affect the output of the
3814 bootm command when booting a FIT image.
3815
Ying Zhang3aa29de2013-08-16 15:16:15 +08003816- TPL framework
3817 CONFIG_TPL
3818 Enable building of TPL globally.
3819
3820 CONFIG_TPL_PAD_TO
3821 Image offset to which the TPL should be padded before appending
3822 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003823 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3824 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3825 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003826
wdenkc6097192002-11-03 00:24:07 +00003827Modem Support:
3828--------------
3829
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003830[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003831
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003832- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003833 CONFIG_MODEM_SUPPORT
3834
3835- RTS/CTS Flow control enable:
3836 CONFIG_HWFLOW
3837
3838- Modem debug support:
3839 CONFIG_MODEM_SUPPORT_DEBUG
3840
wdenk43d96162003-03-06 00:02:04 +00003841 Enables debugging stuff (char screen[1024], dbg())
3842 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003843
wdenka8c7c702003-12-06 19:49:23 +00003844- Interrupt support (PPC):
3845
wdenkd4ca31c2004-01-02 14:00:00 +00003846 There are common interrupt_init() and timer_interrupt()
3847 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003848 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003849 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003850 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003851 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003852 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003853 specific handling. If board has watchdog / status_led
3854 / other_activity_monitor it works automatically from
3855 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003856
wdenkc6097192002-11-03 00:24:07 +00003857- General:
3858
wdenk43d96162003-03-06 00:02:04 +00003859 In the target system modem support is enabled when a
3860 specific key (key combination) is pressed during
3861 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003862 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003863 board_init(). Currently key_pressed() is a dummy
3864 function, returning 1 and thus enabling modem
3865 initialization.
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk43d96162003-03-06 00:02:04 +00003867 If there are no modem init strings in the
3868 environment, U-Boot proceed to autoboot; the
3869 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003870 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003871
3872 See also: doc/README.Modem
3873
Helmut Raiger9660e442011-10-20 04:19:47 +00003874Board initialization settings:
3875------------------------------
3876
3877During Initialization u-boot calls a number of board specific functions
3878to allow the preparation of board specific prerequisites, e.g. pin setup
3879before drivers are initialized. To enable these callbacks the
3880following configuration macros have to be defined. Currently this is
3881architecture specific, so please check arch/your_architecture/lib/board.c
3882typically in board_init_f() and board_init_r().
3883
3884- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3885- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3886- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3887- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003888
wdenkc6097192002-11-03 00:24:07 +00003889Configuration Settings:
3890-----------------------
3891
York Sun4d1fd7f2014-02-26 17:03:19 -08003892- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3893 Optionally it can be defined to support 64-bit memory commands.
3894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003895- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003896 undefine this when you're short of memory.
3897
Peter Tyser2fb26042009-01-27 18:03:12 -06003898- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3899 width of the commands listed in the 'help' command output.
3900
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003901- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003902 prompt for user input.
3903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003904- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003905
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003906- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003908- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003910- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003911 the application (usually a Linux kernel) when it is
3912 booted
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003915 List of legal baudrate settings for this board.
3916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003917- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003918 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003919
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003920- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003921 If the board specific function
3922 extern int overwrite_console (void);
3923 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003924 serial port, else the settings in the environment are used.
3925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003927 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003928
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003929- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003930 Enable overwrite of previous console environment settings.
3931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003932- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003933 Begin and End addresses of the area used by the
3934 simple memory test.
3935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003937 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003939- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003940 Scratch address used by the alternate memory test
3941 You only need to set this if address zero isn't writeable
3942
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003943- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3944 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003945 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003946 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003947 fixing up gd->ram_size the Linux kernel should gets passed
3948 the now "corrected" memory size and won't touch it either.
3949 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003950 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003951 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003952 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003953
3954 This option can be used as a workaround for the 440EPx/GRx
3955 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3956 be touched.
3957
3958 WARNING: Please make sure that this value is a multiple of
3959 the Linux page size (normally 4k). If this is not the case,
3960 then the end address of the Linux memory will be located at a
3961 non page size aligned address and this could cause major
3962 problems.
3963
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003964- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003965 Enable temporary baudrate change while serial download
3966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003967- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003968 Physical start address of SDRAM. _Must_ be 0 here.
3969
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003970- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003971 Physical start address of Motherboard I/O (if using a
3972 Cogent motherboard)
3973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003974- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003975 Physical start address of Flash memory.
3976
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003977- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003978 Physical start address of boot monitor code (set by
3979 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003980 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003981 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003983- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003984 Size of memory reserved for monitor code, used to
3985 determine _at_compile_time_ (!) if the environment is
3986 embedded within the U-Boot image, or in a separate
3987 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003989- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003990 Size of DRAM reserved for malloc() use.
3991
Simon Glassd59476b2014-07-10 22:23:28 -06003992- CONFIG_SYS_MALLOC_F_LEN
3993 Size of the malloc() pool for use before relocation. If
3994 this is defined, then a very simple malloc() implementation
3995 will become available before relocation. The address is just
3996 below the global data, and the stack is moved down to make
3997 space.
3998
3999 This feature allocates regions with increasing addresses
4000 within the region. calloc() is supported, but realloc()
4001 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004002 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06004003 U-Boot relocates itself.
4004
Simon Glasse7b14e92014-09-15 06:33:18 -06004005 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06004006 at present but is fairly easy to enable for other archs.
4007
Simon Glass38687ae2014-11-10 17:16:54 -07004008- CONFIG_SYS_MALLOC_SIMPLE
4009 Provides a simple and small malloc() and calloc() for those
4010 boards which do not use the full malloc in SPL (which is
4011 enabled with CONFIG_SYS_SPL_MALLOC_START).
4012
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07004013- CONFIG_SYS_NONCACHED_MEMORY:
4014 Size of non-cached memory area. This area of memory will be
4015 typically located right below the malloc() area and mapped
4016 uncached in the MMU. This is useful for drivers that would
4017 otherwise require a lot of explicit cache maintenance. For
4018 some drivers it's also impossible to properly maintain the
4019 cache. For example if the regions that need to be flushed
4020 are not a multiple of the cache-line size, *and* padding
4021 cannot be allocated between the regions to align them (i.e.
4022 if the HW requires a contiguous array of regions, and the
4023 size of each region is not cache-aligned), then a flush of
4024 one region may result in overwriting data that hardware has
4025 written to another region in the same cache-line. This can
4026 happen for example in network drivers where descriptors for
4027 buffers are typically smaller than the CPU cache-line (e.g.
4028 16 bytes vs. 32 or 64 bytes).
4029
4030 Non-cached memory is only supported on 32-bit ARM at present.
4031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004032- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01004033 Normally compressed uImages are limited to an
4034 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004035 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01004036 to adjust this setting to your needs.
4037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004039 Maximum size of memory mapped by the startup code of
4040 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004041 the Linux kernel (bd_info, boot arguments, FDT blob if
4042 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004043 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004044 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004045 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004046 variable "bootm_mapsize" will override the value of
4047 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4048 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004049
John Rigbyfca43cc2010-10-13 13:57:35 -06004050- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4051 Enable initrd_high functionality. If defined then the
4052 initrd_high feature is enabled and the bootm ramdisk subcommand
4053 is enabled.
4054
4055- CONFIG_SYS_BOOT_GET_CMDLINE:
4056 Enables allocating and saving kernel cmdline in space between
4057 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4058
4059- CONFIG_SYS_BOOT_GET_KBD:
4060 Enables allocating and saving a kernel copy of the bd_info in
4061 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004063- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004064 Max number of Flash memory banks
4065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004066- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004067 Max number of sectors on a Flash chip
4068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004069- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004070 Timeout for Flash erase operations (in ms)
4071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004073 Timeout for Flash write operations (in ms)
4074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004075- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004076 Timeout for Flash set sector lock bit operation (in ms)
4077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004078- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004079 Timeout for Flash clear lock bits operation (in ms)
4080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004081- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004082 If defined, hardware flash sectors protection is used
4083 instead of U-Boot software protection.
4084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004085- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004086
4087 Enable TFTP transfers directly to flash memory;
4088 without this option such a download has to be
4089 performed in two steps: (1) download to RAM, and (2)
4090 copy from RAM to flash.
4091
4092 The two-step approach is usually more reliable, since
4093 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004094 the flash, but in some situations (when system RAM is
4095 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004096 downloaded image) this option may be very useful.
4097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004098- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004099 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004100 common flash structure for storing flash geometry.
4101
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004102- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004103 This option also enables the building of the cfi_flash driver
4104 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004105
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004106- CONFIG_FLASH_CFI_MTD
4107 This option enables the building of the cfi_mtd driver
4108 in the drivers directory. The driver exports CFI flash
4109 to the MTD layer.
4110
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004111- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004112 Use buffered writes to flash.
4113
4114- CONFIG_FLASH_SPANSION_S29WS_N
4115 s29ws-n MirrorBit flash has non-standard addresses for buffered
4116 write commands.
4117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004118- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004119 If this option is defined, the common CFI flash doesn't
4120 print it's warning upon not recognized FLASH banks. This
4121 is useful, if some of the configured banks are only
4122 optionally available.
4123
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004124- CONFIG_FLASH_SHOW_PROGRESS
4125 If defined (must be an integer), print out countdown
4126 digits and dots. Recommended value: 45 (9..1) for 80
4127 column displays, 15 (3..1) for 40 column displays.
4128
Stefan Roese352ef3f2013-04-04 15:53:14 +02004129- CONFIG_FLASH_VERIFY
4130 If defined, the content of the flash (destination) is compared
4131 against the source after the write operation. An error message
4132 will be printed when the contents are not identical.
4133 Please note that this option is useless in nearly all cases,
4134 since such flash programming errors usually are detected earlier
4135 while unprotecting/erasing/programming. Please only enable
4136 this option if you really know what you are doing.
4137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004138- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004139 Defines the number of Ethernet receive buffers. On some
4140 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004141 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4142 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004143 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004144 Defaults to 4 if not defined.
4145
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004146- CONFIG_ENV_MAX_ENTRIES
4147
Wolfgang Denk071bc922010-10-27 22:48:30 +02004148 Maximum number of entries in the hash table that is used
4149 internally to store the environment settings. The default
4150 setting is supposed to be generous and should work in most
4151 cases. This setting can be used to tune behaviour; see
4152 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004153
Joe Hershberger25980902012-12-11 22:16:31 -06004154- CONFIG_ENV_FLAGS_LIST_DEFAULT
4155- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004156 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004157 calling env set. Variables can be restricted to only decimal,
4158 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4159 the variables can also be restricted to IP address or MAC address.
4160
4161 The format of the list is:
4162 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004163 access_attribute = [a|r|o|c]
4164 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004165 entry = variable_name[:attributes]
4166 list = entry[,list]
4167
4168 The type attributes are:
4169 s - String (default)
4170 d - Decimal
4171 x - Hexadecimal
4172 b - Boolean ([1yYtT|0nNfF])
4173 i - IP address
4174 m - MAC address
4175
Joe Hershberger267541f2012-12-11 22:16:34 -06004176 The access attributes are:
4177 a - Any (default)
4178 r - Read-only
4179 o - Write-once
4180 c - Change-default
4181
Joe Hershberger25980902012-12-11 22:16:31 -06004182 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4183 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004184 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004185
4186 - CONFIG_ENV_FLAGS_LIST_STATIC
4187 Define this to a list (string) to define validation that
4188 should be done if an entry is not found in the ".flags"
4189 environment variable. To override a setting in the static
4190 list, simply add an entry for the same variable name to the
4191 ".flags" variable.
4192
Joe Hershberger267541f2012-12-11 22:16:34 -06004193- CONFIG_ENV_ACCESS_IGNORE_FORCE
4194 If defined, don't allow the -f switch to env set override variable
4195 access flags.
4196
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004197- CONFIG_SYS_GENERIC_BOARD
4198 This selects the architecture-generic board system instead of the
4199 architecture-specific board files. It is intended to move boards
4200 to this new framework over time. Defining this will disable the
4201 arch/foo/lib/board.c file and use common/board_f.c and
4202 common/board_r.c instead. To use this option your architecture
4203 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4204 its config.mk file). If you find problems enabling this option on
4205 your board please report the problem and send patches!
4206
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004207- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4208 This is set by OMAP boards for the max time that reset should
4209 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004210 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004211
Gabe Black0d296cc2014-10-15 04:38:30 -06004212- CONFIG_USE_STDINT
4213 If stdint.h is available with your toolchain you can define this
4214 option to enable it. You can provide option 'USE_STDINT=1' when
4215 building U-Boot to enable this.
4216
wdenkc6097192002-11-03 00:24:07 +00004217The following definitions that deal with the placement and management
4218of environment data (variable area); in general, we support the
4219following configurations:
4220
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004221- CONFIG_BUILD_ENVCRC:
4222
4223 Builds up envcrc with the target environment so that external utils
4224 may easily extract it and embed it in final U-Boot images.
4225
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004226- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004227
4228 Define this if the environment is in flash memory.
4229
4230 a) The environment occupies one whole flash sector, which is
4231 "embedded" in the text segment with the U-Boot code. This
4232 happens usually with "bottom boot sector" or "top boot
4233 sector" type flash chips, which have several smaller
4234 sectors at the start or the end. For instance, such a
4235 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4236 such a case you would place the environment in one of the
4237 4 kB sectors - with U-Boot code before and after it. With
4238 "top boot sector" type flash chips, you would put the
4239 environment in one of the last sectors, leaving a gap
4240 between U-Boot and the environment.
4241
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004242 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004243
4244 Offset of environment data (variable area) to the
4245 beginning of flash memory; for instance, with bottom boot
4246 type flash chips the second sector can be used: the offset
4247 for this sector is given here.
4248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004249 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004250
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004251 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004252
4253 This is just another way to specify the start address of
4254 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004255 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004256
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004257 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004258
4259 Size of the sector containing the environment.
4260
4261
4262 b) Sometimes flash chips have few, equal sized, BIG sectors.
4263 In such a case you don't want to spend a whole sector for
4264 the environment.
4265
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004266 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004267
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004268 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004269 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004270 of this flash sector for the environment. This saves
4271 memory for the RAM copy of the environment.
4272
4273 It may also save flash memory if you decide to use this
4274 when your environment is "embedded" within U-Boot code,
4275 since then the remainder of the flash sector could be used
4276 for U-Boot code. It should be pointed out that this is
4277 STRONGLY DISCOURAGED from a robustness point of view:
4278 updating the environment in flash makes it always
4279 necessary to erase the WHOLE sector. If something goes
4280 wrong before the contents has been restored from a copy in
4281 RAM, your target system will be dead.
4282
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004283 - CONFIG_ENV_ADDR_REDUND
4284 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk43d96162003-03-06 00:02:04 +00004286 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004287 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004288 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004289 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004290
4291BE CAREFUL! Any changes to the flash layout, and some changes to the
4292source code will make it necessary to adapt <board>/u-boot.lds*
4293accordingly!
4294
4295
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004296- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004297
4298 Define this if you have some non-volatile memory device
4299 (NVRAM, battery buffered SRAM) which you want to use for the
4300 environment.
4301
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004302 - CONFIG_ENV_ADDR:
4303 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004304
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004305 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004306 want to use for environment. It is assumed that this memory
4307 can just be read and written to, without any special
4308 provision.
4309
4310BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004311in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004312console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004313U-Boot will hang.
4314
4315Please note that even with NVRAM we still use a copy of the
4316environment in RAM: we could work on NVRAM directly, but we want to
4317keep settings there always unmodified except somebody uses "saveenv"
4318to save the current settings.
4319
4320
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004321- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004322
4323 Use this if you have an EEPROM or similar serial access
4324 device and a driver for it.
4325
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004326 - CONFIG_ENV_OFFSET:
4327 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004328
4329 These two #defines specify the offset and size of the
4330 environment area within the total memory of your EEPROM.
4331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004332 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004333 If defined, specified the chip address of the EEPROM device.
4334 The default address is zero.
4335
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004336 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004337 If defined, the number of bits used to address bytes in a
4338 single page in the EEPROM device. A 64 byte page, for example
4339 would require six bits.
4340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004341 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004342 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004343 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004345 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004346 The length in bytes of the EEPROM memory array address. Note
4347 that this is NOT the chip address length!
4348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004349 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004350 EEPROM chips that implement "address overflow" are ones
4351 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4352 address and the extra bits end up in the "chip address" bit
4353 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4354 byte chips.
4355
4356 Note that we consider the length of the address field to
4357 still be one byte because the extra address bits are hidden
4358 in the chip address.
4359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004360 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004361 The size in bytes of the EEPROM device.
4362
Heiko Schocher548738b2010-01-07 08:55:40 +01004363 - CONFIG_ENV_EEPROM_IS_ON_I2C
4364 define this, if you have I2C and SPI activated, and your
4365 EEPROM, which holds the environment, is on the I2C bus.
4366
4367 - CONFIG_I2C_ENV_EEPROM_BUS
4368 if you have an Environment on an EEPROM reached over
4369 I2C muxes, you can define here, how to reach this
4370 EEPROM. For example:
4371
Heiko Schocherea818db2013-01-29 08:53:15 +01004372 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004373
4374 EEPROM which holds the environment, is reached over
4375 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004376
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004377- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004378
wdenkd4ca31c2004-01-02 14:00:00 +00004379 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004380 want to use for the environment.
4381
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004382 - CONFIG_ENV_OFFSET:
4383 - CONFIG_ENV_ADDR:
4384 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004385
4386 These three #defines specify the offset and size of the
4387 environment area within the total memory of your DataFlash placed
4388 at the specified address.
4389
Wu, Joshbd83b592014-07-01 19:30:13 +08004390- CONFIG_ENV_IS_IN_SPI_FLASH:
4391
4392 Define this if you have a SPI Flash memory device which you
4393 want to use for the environment.
4394
4395 - CONFIG_ENV_OFFSET:
4396 - CONFIG_ENV_SIZE:
4397
4398 These two #defines specify the offset and size of the
4399 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4400 aligned to an erase sector boundary.
4401
4402 - CONFIG_ENV_SECT_SIZE:
4403
4404 Define the SPI flash's sector size.
4405
4406 - CONFIG_ENV_OFFSET_REDUND (optional):
4407
4408 This setting describes a second storage area of CONFIG_ENV_SIZE
4409 size used to hold a redundant copy of the environment data, so
4410 that there is a valid backup copy in case there is a power failure
4411 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4412 aligned to an erase sector boundary.
4413
4414 - CONFIG_ENV_SPI_BUS (optional):
4415 - CONFIG_ENV_SPI_CS (optional):
4416
4417 Define the SPI bus and chip select. If not defined they will be 0.
4418
4419 - CONFIG_ENV_SPI_MAX_HZ (optional):
4420
4421 Define the SPI max work clock. If not defined then use 1MHz.
4422
4423 - CONFIG_ENV_SPI_MODE (optional):
4424
4425 Define the SPI work mode. If not defined then use SPI_MODE_3.
4426
Liu Gang0a85a9e2012-03-08 00:33:20 +00004427- CONFIG_ENV_IS_IN_REMOTE:
4428
4429 Define this if you have a remote memory space which you
4430 want to use for the local device's environment.
4431
4432 - CONFIG_ENV_ADDR:
4433 - CONFIG_ENV_SIZE:
4434
4435 These two #defines specify the address and size of the
4436 environment area within the remote memory space. The
4437 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004438 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004439
4440BE CAREFUL! For some special cases, the local device can not use
4441"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004442environment stored in a remote NOR flash by SRIO or PCIE link,
4443but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004444
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004445- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004446
4447 Define this if you have a NAND device which you want to use
4448 for the environment.
4449
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004450 - CONFIG_ENV_OFFSET:
4451 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004452
4453 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004454 area within the first NAND device. CONFIG_ENV_OFFSET must be
4455 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004456
Scott Woodfdd813d2010-09-17 14:38:37 -05004457 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004458
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004459 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004460 size used to hold a redundant copy of the environment data, so
4461 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004462 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004463 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004464
Scott Woodfdd813d2010-09-17 14:38:37 -05004465 - CONFIG_ENV_RANGE (optional):
4466
4467 Specifies the length of the region in which the environment
4468 can be written. This should be a multiple of the NAND device's
4469 block size. Specifying a range with more erase blocks than
4470 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4471 the range to be avoided.
4472
4473 - CONFIG_ENV_OFFSET_OOB (optional):
4474
4475 Enables support for dynamically retrieving the offset of the
4476 environment from block zero's out-of-band data. The
4477 "nand env.oob" command can be used to record this offset.
4478 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4479 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004480
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004481- CONFIG_NAND_ENV_DST
4482
4483 Defines address in RAM to which the nand_spl code should copy the
4484 environment. If redundant environment is used, it will be copied to
4485 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4486
Joe Hershberger2b744332013-04-08 10:32:51 +00004487- CONFIG_ENV_IS_IN_UBI:
4488
4489 Define this if you have an UBI volume that you want to use for the
4490 environment. This has the benefit of wear-leveling the environment
4491 accesses, which is important on NAND.
4492
4493 - CONFIG_ENV_UBI_PART:
4494
4495 Define this to a string that is the mtd partition containing the UBI.
4496
4497 - CONFIG_ENV_UBI_VOLUME:
4498
4499 Define this to the name of the volume that you want to store the
4500 environment in.
4501
Joe Hershberger785881f2013-04-08 10:32:52 +00004502 - CONFIG_ENV_UBI_VOLUME_REDUND:
4503
4504 Define this to the name of another volume to store a second copy of
4505 the environment in. This will enable redundant environments in UBI.
4506 It is assumed that both volumes are in the same MTD partition.
4507
Joe Hershberger2b744332013-04-08 10:32:51 +00004508 - CONFIG_UBI_SILENCE_MSG
4509 - CONFIG_UBIFS_SILENCE_MSG
4510
4511 You will probably want to define these to avoid a really noisy system
4512 when storing the env in UBI.
4513
Wu, Joshd1db76f2014-06-24 17:31:03 +08004514- CONFIG_ENV_IS_IN_FAT:
4515 Define this if you want to use the FAT file system for the environment.
4516
4517 - FAT_ENV_INTERFACE:
4518
4519 Define this to a string that is the name of the block device.
4520
4521 - FAT_ENV_DEV_AND_PART:
4522
4523 Define this to a string to specify the partition of the device. It can
4524 be as following:
4525
4526 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4527 - "D:P": device D partition P. Error occurs if device D has no
4528 partition table.
4529 - "D:0": device D.
4530 - "D" or "D:": device D partition 1 if device D has partition
4531 table, or the whole device D if has no partition
4532 table.
4533 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004534 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004535 partition table then means device D.
4536
4537 - FAT_ENV_FILE:
4538
4539 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004540 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004541
4542 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004543 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004544
Stephen Warren06e4ae52013-06-11 15:14:00 -06004545- CONFIG_ENV_IS_IN_MMC:
4546
4547 Define this if you have an MMC device which you want to use for the
4548 environment.
4549
4550 - CONFIG_SYS_MMC_ENV_DEV:
4551
4552 Specifies which MMC device the environment is stored in.
4553
4554 - CONFIG_SYS_MMC_ENV_PART (optional):
4555
4556 Specifies which MMC partition the environment is stored in. If not
4557 set, defaults to partition 0, the user area. Common values might be
4558 1 (first MMC boot partition), 2 (second MMC boot partition).
4559
4560 - CONFIG_ENV_OFFSET:
4561 - CONFIG_ENV_SIZE:
4562
4563 These two #defines specify the offset and size of the environment
4564 area within the specified MMC device.
4565
Stephen Warren5c088ee2013-06-11 15:14:02 -06004566 If offset is positive (the usual case), it is treated as relative to
4567 the start of the MMC partition. If offset is negative, it is treated
4568 as relative to the end of the MMC partition. This can be useful if
4569 your board may be fitted with different MMC devices, which have
4570 different sizes for the MMC partitions, and you always want the
4571 environment placed at the very end of the partition, to leave the
4572 maximum possible space before it, to store other data.
4573
Stephen Warren06e4ae52013-06-11 15:14:00 -06004574 These two values are in units of bytes, but must be aligned to an
4575 MMC sector boundary.
4576
4577 - CONFIG_ENV_OFFSET_REDUND (optional):
4578
4579 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4580 hold a redundant copy of the environment data. This provides a
4581 valid backup copy in case the other copy is corrupted, e.g. due
4582 to a power failure during a "saveenv" operation.
4583
Stephen Warren5c088ee2013-06-11 15:14:02 -06004584 This value may also be positive or negative; this is handled in the
4585 same way as CONFIG_ENV_OFFSET.
4586
Stephen Warren06e4ae52013-06-11 15:14:00 -06004587 This value is also in units of bytes, but must also be aligned to
4588 an MMC sector boundary.
4589
4590 - CONFIG_ENV_SIZE_REDUND (optional):
4591
4592 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4593 set. If this value is set, it must be set to the same value as
4594 CONFIG_ENV_SIZE.
4595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004596- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004597
4598 Defines offset to the initial SPI buffer area in DPRAM. The
4599 area is used at an early stage (ROM part) if the environment
4600 is configured to reside in the SPI EEPROM: We need a 520 byte
4601 scratch DPRAM area. It is used between the two initialization
4602 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4603 to be a good choice since it makes it far enough from the
4604 start of the data area as well as from the stack pointer.
4605
Bruce Adlere881cb52007-11-02 13:15:42 -07004606Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004607has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004608created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004609until then to read environment variables.
4610
wdenk85ec0bc2003-03-31 16:34:49 +00004611The environment is protected by a CRC32 checksum. Before the monitor
4612is relocated into RAM, as a result of a bad CRC you will be working
4613with the compiled-in default environment - *silently*!!! [This is
4614necessary, because the first environment variable we need is the
4615"baudrate" setting for the console - if we have a bad CRC, we don't
4616have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004617
4618Note: once the monitor has been relocated, then it will complain if
4619the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004620use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004622- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004623 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004625 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004626 also needs to be defined.
4627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004628- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004629 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004630
Ron Madridf5675aa2009-02-18 14:30:44 -08004631- CONFIG_NS16550_MIN_FUNCTIONS:
4632 Define this if you desire to only have use of the NS16550_init
4633 and NS16550_putc functions for the serial driver located at
4634 drivers/serial/ns16550.c. This option is useful for saving
4635 space for already greatly restricted images, including but not
4636 limited to NAND_SPL configurations.
4637
Simon Glassb2b92f52012-11-30 13:01:18 +00004638- CONFIG_DISPLAY_BOARDINFO
4639 Display information about the board that U-Boot is running on
4640 when U-Boot starts up. The board function checkboard() is called
4641 to do this.
4642
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004643- CONFIG_DISPLAY_BOARDINFO_LATE
4644 Similar to the previous option, but display this information
4645 later, once stdio is running and output goes to the LCD, if
4646 present.
4647
Sascha Silbefeb85802013-08-11 16:40:43 +02004648- CONFIG_BOARD_SIZE_LIMIT:
4649 Maximum size of the U-Boot image. When defined, the
4650 build system checks that the actual size does not
4651 exceed it.
4652
wdenkc6097192002-11-03 00:24:07 +00004653Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004654---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004656- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004657 Cache Line Size of the CPU.
4658
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004659- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004660 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004661
wdenk42d1f032003-10-15 23:53:47 +00004662 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4663 and RPXsuper) to be able to adjust the position of
4664 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004665
Timur Tabie46fedf2011-08-04 18:03:41 -05004666- CONFIG_SYS_CCSRBAR_DEFAULT:
4667 Default (power-on reset) physical address of CCSR on Freescale
4668 PowerPC SOCs.
4669
4670- CONFIG_SYS_CCSRBAR:
4671 Virtual address of CCSR. On a 32-bit build, this is typically
4672 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4673
4674 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4675 for cross-platform code that uses that macro instead.
4676
4677- CONFIG_SYS_CCSRBAR_PHYS:
4678 Physical address of CCSR. CCSR can be relocated to a new
4679 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004680 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004681 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4682 is typically relocated on 36-bit builds. It is recommended
4683 that this macro be defined via the _HIGH and _LOW macros:
4684
4685 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4686 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4687
4688- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004689 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4690 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004691 used in assembly code, so it must not contain typecasts or
4692 integer size suffixes (e.g. "ULL").
4693
4694- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4695 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4696 used in assembly code, so it must not contain typecasts or
4697 integer size suffixes (e.g. "ULL").
4698
4699- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4700 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4701 forced to a value that ensures that CCSR is not relocated.
4702
wdenk7f6c2cb2002-11-10 22:06:23 +00004703- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004704 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004705
4706 the default drive number (default value 0)
4707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004708 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004709
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004710 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004711 (default value 1)
4712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004713 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004714
wdenk43d96162003-03-06 00:02:04 +00004715 defines the offset of register from address. It
4716 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004717 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4720 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004721 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004723 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004724 fdc_hw_init() is called at the beginning of the FDC
4725 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004726 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004727 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004728
Macpaul Lin0abddf82011-04-11 20:45:32 +00004729- CONFIG_IDE_AHB:
4730 Most IDE controllers were designed to be connected with PCI
4731 interface. Only few of them were designed for AHB interface.
4732 When software is doing ATA command and data transfer to
4733 IDE devices through IDE-AHB controller, some additional
4734 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004735 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004736
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004737- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004738 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004739 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004741- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004742
wdenk7152b1d2003-09-05 23:19:14 +00004743 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004744 initial data and stack; please note that this must be
4745 writable memory that is working WITHOUT special
4746 initialization, i. e. you CANNOT use normal RAM which
4747 will become available only after programming the
4748 memory controller and running certain initialization
4749 sequences.
4750
4751 U-Boot uses the following memory types:
4752 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4753 - MPC824X: data cache
4754 - PPC4xx: data cache
4755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004756- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004757
4758 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004759 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4760 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004761 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004762 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004763 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4764 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4765 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004766
4767 Note:
4768 On the MPC824X (or other systems that use the data
4769 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004770 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004771 point to an otherwise UNUSED address space between
4772 the top of RAM and the start of the PCI space.
4773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004774- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004775
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004776- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004778- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004780- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004782- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004784- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004786- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004787 SDRAM timing
4788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004789- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004790 periodic timer for refresh
4791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004792- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004794- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4795 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4796 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4797 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004798 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4799
4800- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004801 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4802 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004803 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004805- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4806 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004807 Machine Mode Register and Memory Periodic Timer
4808 Prescaler definitions (SDRAM timing)
4809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004810- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004811 enable I2C microcode relocation patch (MPC8xx);
4812 define relocation offset in DPRAM [DSP2]
4813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004814- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004815 enable SMC microcode relocation patch (MPC8xx);
4816 define relocation offset in DPRAM [SMC1]
4817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004818- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004819 enable SPI microcode relocation patch (MPC8xx);
4820 define relocation offset in DPRAM [SCC4]
4821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004822- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004823 Use OSCM clock mode on MBX8xx board. Be careful,
4824 wrong setting might damage your board. Read
4825 doc/README.MBX before setting this variable!
4826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004827- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004828 Offset of the bootmode word in DPRAM used by post
4829 (Power On Self Tests). This definition overrides
4830 #define'd default value in commproc.h resp.
4831 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004833- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4834 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4835 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4836 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4837 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4838 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4839 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4840 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004841 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004842
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004843- CONFIG_PCI_DISABLE_PCIE:
4844 Disable PCI-Express on systems where it is supported but not
4845 required.
4846
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004847- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004848 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004849 Don't do any setup work, presumably because someone or
4850 something has already done it, and we don't need to do it
4851 a second time. Useful for platforms that are pre-booted
4852 by coreboot or similar.
4853
Gabor Juhos842033e2013-05-30 07:06:12 +00004854- CONFIG_PCI_INDIRECT_BRIDGE:
4855 Enable support for indirect PCI bridges.
4856
Kumar Galaa09b9b62010-12-30 12:09:53 -06004857- CONFIG_SYS_SRIO:
4858 Chip has SRIO or not
4859
4860- CONFIG_SRIO1:
4861 Board has SRIO 1 port available
4862
4863- CONFIG_SRIO2:
4864 Board has SRIO 2 port available
4865
Liu Gangc8b28152013-05-07 16:30:46 +08004866- CONFIG_SRIO_PCIE_BOOT_MASTER
4867 Board can support master function for Boot from SRIO and PCIE
4868
Kumar Galaa09b9b62010-12-30 12:09:53 -06004869- CONFIG_SYS_SRIOn_MEM_VIRT:
4870 Virtual Address of SRIO port 'n' memory region
4871
4872- CONFIG_SYS_SRIOn_MEM_PHYS:
4873 Physical Address of SRIO port 'n' memory region
4874
4875- CONFIG_SYS_SRIOn_MEM_SIZE:
4876 Size of SRIO port 'n' memory region
4877
Fabio Estevam66bd1842013-04-11 09:35:34 +00004878- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4879 Defined to tell the NAND controller that the NAND chip is using
4880 a 16 bit bus.
4881 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004882 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004883 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004884 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004885
4886- CONFIG_SYS_NDFC_EBC0_CFG
4887 Sets the EBC0_CFG register for the NDFC. If not defined
4888 a default value will be used.
4889
Ben Warrenbb99ad62006-09-07 16:50:54 -04004890- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004891 Get DDR timing information from an I2C EEPROM. Common
4892 with pluggable memory modules such as SODIMMs
4893
Ben Warrenbb99ad62006-09-07 16:50:54 -04004894 SPD_EEPROM_ADDRESS
4895 I2C address of the SPD EEPROM
4896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004897- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004898 If SPD EEPROM is on an I2C bus other than the first
4899 one, specify here. Note that the value must resolve
4900 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004901
York Sun1b3e3c42011-06-07 09:42:16 +08004902- CONFIG_SYS_DDR_RAW_TIMING
4903 Get DDR timing information from other than SPD. Common with
4904 soldered DDR chips onboard without SPD. DDR raw timing
4905 parameters are extracted from datasheet and hard-coded into
4906 header files or board specific files.
4907
York Sun6f5e1dc2011-09-16 13:21:35 -07004908- CONFIG_FSL_DDR_INTERACTIVE
4909 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004911- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004912 Only for 83xx systems. If specified, then DDR should
4913 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004914
wdenkc26e4542004-04-18 10:13:26 +00004915- CONFIG_ETHER_ON_FEC[12]
4916 Define to enable FEC[12] on a 8xx series processor.
4917
4918- CONFIG_FEC[12]_PHY
4919 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004920 to the given FEC; i. e.
4921 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004922 means that the PHY with address 4 is connected to FEC1
4923
4924 When set to -1, means to probe for first available.
4925
4926- CONFIG_FEC[12]_PHY_NORXERR
4927 The PHY does not have a RXERR line (RMII only).
4928 (so program the FEC to ignore it).
4929
4930- CONFIG_RMII
4931 Enable RMII mode for all FECs.
4932 Note that this is a global option, we can't
4933 have one FEC in standard MII mode and another in RMII mode.
4934
wdenk5cf91d62004-04-23 20:32:05 +00004935- CONFIG_CRC32_VERIFY
4936 Add a verify option to the crc32 command.
4937 The syntax is:
4938
4939 => crc32 -v <address> <count> <crc32>
4940
4941 Where address/count indicate a memory area
4942 and crc32 is the correct crc32 which the
4943 area should have.
4944
wdenk56523f12004-07-11 17:40:54 +00004945- CONFIG_LOOPW
4946 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004947 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004948
stroese7b466642004-12-16 18:46:55 +00004949- CONFIG_MX_CYCLIC
4950 Add the "mdc" and "mwc" memory commands. These are cyclic
4951 "md/mw" commands.
4952 Examples:
4953
wdenkefe2a4d2004-12-16 21:44:03 +00004954 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004955 This command will print 4 bytes (10,11,12,13) each 500 ms.
4956
wdenkefe2a4d2004-12-16 21:44:03 +00004957 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004958 This command will write 12345678 to address 100 all 10 ms.
4959
wdenkefe2a4d2004-12-16 21:44:03 +00004960 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004961 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004962
wdenk8aa1a2d2005-04-04 12:44:11 +00004963- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004964 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004965 low level initializations (like setting up the memory
4966 controller) are omitted and/or U-Boot does not
4967 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004968
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004969 Normally this variable MUST NOT be defined. The only
4970 exception is when U-Boot is loaded (to RAM) by some
4971 other boot loader or by a debugger which performs
4972 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004973
Aneesh V401bb302011-07-13 05:11:07 +00004974- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004975 Modifies the behaviour of start.S when compiling a loader
4976 that is executed before the actual U-Boot. E.g. when
4977 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004978
Ying Zhang3aa29de2013-08-16 15:16:15 +08004979- CONFIG_TPL_BUILD
4980 Modifies the behaviour of start.S when compiling a loader
4981 that is executed after the SPL and before the actual U-Boot.
4982 It is loaded by the SPL.
4983
Ying Zhang5df572f2013-05-20 14:07:23 +08004984- CONFIG_SYS_MPC85XX_NO_RESETVEC
4985 Only for 85xx systems. If this variable is specified, the section
4986 .resetvec is not kept and the section .bootpg is placed in the
4987 previous 4k of the .text section.
4988
Simon Glass4213fc22013-02-24 17:33:14 +00004989- CONFIG_ARCH_MAP_SYSMEM
4990 Generally U-Boot (and in particular the md command) uses
4991 effective address. It is therefore not necessary to regard
4992 U-Boot address as virtual addresses that need to be translated
4993 to physical addresses. However, sandbox requires this, since
4994 it maintains its own little RAM buffer which contains all
4995 addressable memory. This option causes some memory accesses
4996 to be mapped through map_sysmem() / unmap_sysmem().
4997
Matthias Weisserd8834a12011-03-10 21:36:32 +00004998- CONFIG_USE_ARCH_MEMCPY
4999 CONFIG_USE_ARCH_MEMSET
5000 If these options are used a optimized version of memcpy/memset will
5001 be used if available. These functions may be faster under some
5002 conditions but may increase the binary size.
5003
Simon Glass588a13f2013-02-14 04:18:54 +00005004- CONFIG_X86_RESET_VECTOR
5005 If defined, the x86 reset vector code is included. This is not
5006 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00005007
Mark Jacksonfc337052013-03-04 01:27:20 +00005008- CONFIG_SYS_MPUCLK
5009 Defines the MPU clock speed (in MHz).
5010
5011 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00005012
Heiko Schocher16678eb2013-11-04 14:05:00 +01005013- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5014 Enables the RTC32K OSC on AM33xx based plattforms
5015
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04005016- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5017 Option to disable subpage write in NAND driver
5018 driver that uses this:
5019 drivers/mtd/nand/davinci_nand.c
5020
Timur Tabif2717b42011-11-22 09:21:25 -06005021Freescale QE/FMAN Firmware Support:
5022-----------------------------------
5023
5024The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5025loading of "firmware", which is encoded in the QE firmware binary format.
5026This firmware often needs to be loaded during U-Boot booting, so macros
5027are used to identify the storage device (NOR flash, SPI, etc) and the address
5028within that device.
5029
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005030- CONFIG_SYS_FMAN_FW_ADDR
5031 The address in the storage device where the FMAN microcode is located. The
5032 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5033 is also specified.
5034
5035- CONFIG_SYS_QE_FW_ADDR
5036 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005037 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5038 is also specified.
5039
5040- CONFIG_SYS_QE_FMAN_FW_LENGTH
5041 The maximum possible size of the firmware. The firmware binary format
5042 has a field that specifies the actual size of the firmware, but it
5043 might not be possible to read any part of the firmware unless some
5044 local storage is allocated to hold the entire firmware first.
5045
5046- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5047 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5048 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5049 virtual address in NOR flash.
5050
5051- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5052 Specifies that QE/FMAN firmware is located in NAND flash.
5053 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5054
5055- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5056 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5057 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5058
5059- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5060 Specifies that QE/FMAN firmware is located on the primary SPI
5061 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5062
Liu Gang292dc6c2012-03-08 00:33:18 +00005063- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5064 Specifies that QE/FMAN firmware is located in the remote (master)
5065 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005066 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5067 window->master inbound window->master LAW->the ucode address in
5068 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005069
J. German Riverab940ca62014-06-23 15:15:55 -07005070Freescale Layerscape Management Complex Firmware Support:
5071---------------------------------------------------------
5072The Freescale Layerscape Management Complex (MC) supports the loading of
5073"firmware".
5074This firmware often needs to be loaded during U-Boot booting, so macros
5075are used to identify the storage device (NOR flash, SPI, etc) and the address
5076within that device.
5077
5078- CONFIG_FSL_MC_ENET
5079 Enable the MC driver for Layerscape SoCs.
5080
5081- CONFIG_SYS_LS_MC_FW_ADDR
5082 The address in the storage device where the firmware is located. The
5083 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5084 is also specified.
5085
5086- CONFIG_SYS_LS_MC_FW_LENGTH
5087 The maximum possible size of the firmware. The firmware binary format
5088 has a field that specifies the actual size of the firmware, but it
5089 might not be possible to read any part of the firmware unless some
5090 local storage is allocated to hold the entire firmware first.
5091
5092- CONFIG_SYS_LS_MC_FW_IN_NOR
5093 Specifies that MC firmware is located in NOR flash, mapped as
5094 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5095 virtual address in NOR flash.
5096
wdenkc6097192002-11-03 00:24:07 +00005097Building the Software:
5098======================
5099
Wolfgang Denk218ca722008-03-26 10:40:12 +01005100Building U-Boot has been tested in several native build environments
5101and in many different cross environments. Of course we cannot support
5102all possibly existing versions of cross development tools in all
5103(potentially obsolete) versions. In case of tool chain problems we
5104recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5105which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005106
Wolfgang Denk218ca722008-03-26 10:40:12 +01005107If you are not using a native environment, it is assumed that you
5108have GNU cross compiling tools available in your path. In this case,
5109you must set the environment variable CROSS_COMPILE in your shell.
5110Note that no changes to the Makefile or any other source files are
5111necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005112
Wolfgang Denk218ca722008-03-26 10:40:12 +01005113 $ CROSS_COMPILE=ppc_4xx-
5114 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005115
Peter Tyser2f8d3962009-03-13 18:54:51 -05005116Note: If you wish to generate Windows versions of the utilities in
5117 the tools directory you can use the MinGW toolchain
5118 (http://www.mingw.org). Set your HOST tools to the MinGW
5119 toolchain and execute 'make tools'. For example:
5120
5121 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5122
5123 Binaries such as tools/mkimage.exe will be created which can
5124 be executed on computers running Windows.
5125
Wolfgang Denk218ca722008-03-26 10:40:12 +01005126U-Boot is intended to be simple to build. After installing the
5127sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005128is done by typing:
5129
Holger Freytherab584d62014-08-04 09:26:05 +02005130 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005131
Holger Freytherab584d62014-08-04 09:26:05 +02005132where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005133rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005134
wdenk2729af92004-05-03 20:45:30 +00005135Note: for some board special configuration names may exist; check if
5136 additional information is available from the board vendor; for
5137 instance, the TQM823L systems are available without (standard)
5138 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005139 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005140
Holger Freytherab584d62014-08-04 09:26:05 +02005141 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005142 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005143
Holger Freytherab584d62014-08-04 09:26:05 +02005144 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005145 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk2729af92004-05-03 20:45:30 +00005147 etc.
wdenkc6097192002-11-03 00:24:07 +00005148
wdenkc6097192002-11-03 00:24:07 +00005149
wdenk2729af92004-05-03 20:45:30 +00005150Finally, type "make all", and you should get some working U-Boot
5151images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk2729af92004-05-03 20:45:30 +00005153- "u-boot.bin" is a raw binary image
5154- "u-boot" is an image in ELF binary format
5155- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005156
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005157By default the build is performed locally and the objects are saved
5158in the source directory. One of the two methods can be used to change
5159this behavior and build U-Boot to some external directory:
5160
51611. Add O= to the make command line invocations:
5162
5163 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005164 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005165 make O=/tmp/build all
5166
Timo Ketolaadbba992014-11-06 14:39:05 +020051672. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005168
Timo Ketolaadbba992014-11-06 14:39:05 +02005169 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005170 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005171 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005172 make all
5173
Timo Ketolaadbba992014-11-06 14:39:05 +02005174Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005175variable.
5176
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178Please be aware that the Makefiles assume you are using GNU make, so
5179for instance on NetBSD you might need to use "gmake" instead of
5180native "make".
wdenkc6097192002-11-03 00:24:07 +00005181
wdenkc6097192002-11-03 00:24:07 +00005182
wdenk2729af92004-05-03 20:45:30 +00005183If the system board that you have is not listed, then you will need
5184to port U-Boot to your hardware platform. To do this, follow these
5185steps:
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +000051871. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005188 "boards.cfg" file, using the existing entries as examples.
5189 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051902. Create a new directory to hold your board specific code. Add any
5191 files you need. In your board directory, you will need at least
5192 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51933. Create a new configuration file "include/configs/<board>.h" for
5194 your board
51953. If you're porting U-Boot to a new CPU, then also create a new
5196 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051974. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051985. Type "make", and you should get a working "u-boot.srec" file
5199 to be installed on your target system.
52006. Debug and solve any problems that might arise.
5201 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005202
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5205==============================================================
wdenkc6097192002-11-03 00:24:07 +00005206
Wolfgang Denk218ca722008-03-26 10:40:12 +01005207If you have modified U-Boot sources (for instance added a new board
5208or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005209provide feedback to the other developers. The feedback normally takes
5210the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005211official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005212
Wolfgang Denk218ca722008-03-26 10:40:12 +01005213But before you submit such a patch, please verify that your modifi-
5214cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005215the supported boards compile WITHOUT ANY compiler warnings. To do so,
5216just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005217for ALL supported system. Be warned, this will take a while. You can
5218select which (cross) compiler to use by passing a `CROSS_COMPILE'
5219environment variable to the script, i. e. to use the ELDK cross tools
5220you can type
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk2729af92004-05-03 20:45:30 +00005222 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk2729af92004-05-03 20:45:30 +00005224or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005227
Wolfgang Denk218ca722008-03-26 10:40:12 +01005228When using the MAKEALL script, the default behaviour is to build
5229U-Boot in the source directory. This location can be changed by
5230setting the BUILD_DIR environment variable. Also, for each target
5231built, the MAKEALL script saves two log files (<target>.ERR and
5232<target>.MAKEALL) in the <source dir>/LOG directory. This default
5233location can be changed by setting the MAKEALL_LOGDIR environment
5234variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005235
5236 export BUILD_DIR=/tmp/build
5237 export MAKEALL_LOGDIR=/tmp/log
5238 CROSS_COMPILE=ppc_8xx- MAKEALL
5239
Wolfgang Denk218ca722008-03-26 10:40:12 +01005240With the above settings build objects are saved in the /tmp/build,
5241log files are saved in the /tmp/log and the source tree remains clean
5242during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005243
5244
wdenk2729af92004-05-03 20:45:30 +00005245See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005246
wdenkc6097192002-11-03 00:24:07 +00005247
wdenk2729af92004-05-03 20:45:30 +00005248Monitor Commands - Overview:
5249============================
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk2729af92004-05-03 20:45:30 +00005251go - start application at address 'addr'
5252run - run commands in an environment variable
5253bootm - boot application image from memory
5254bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005255bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005256tftpboot- boot image via network using TFTP protocol
5257 and env variables "ipaddr" and "serverip"
5258 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005259tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005260rarpboot- boot image via network using RARP/TFTP protocol
5261diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5262loads - load S-Record file over serial line
5263loadb - load binary file over serial line (kermit mode)
5264md - memory display
5265mm - memory modify (auto-incrementing)
5266nm - memory modify (constant address)
5267mw - memory write (fill)
5268cp - memory copy
5269cmp - memory compare
5270crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005271i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005272sspi - SPI utility commands
5273base - print or set address offset
5274printenv- print environment variables
5275setenv - set environment variables
5276saveenv - save environment variables to persistent storage
5277protect - enable or disable FLASH write protection
5278erase - erase FLASH memory
5279flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005280nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005281bdinfo - print Board Info structure
5282iminfo - print header information for application image
5283coninfo - print console devices and informations
5284ide - IDE sub-system
5285loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005286loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005287mtest - simple RAM test
5288icache - enable or disable instruction cache
5289dcache - enable or disable data cache
5290reset - Perform RESET of the CPU
5291echo - echo args to console
5292version - print monitor version
5293help - print online help
5294? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005295
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297Monitor Commands - Detailed Description:
5298========================================
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300TODO.
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk2729af92004-05-03 20:45:30 +00005302For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005303
5304
wdenk2729af92004-05-03 20:45:30 +00005305Environment Variables:
5306======================
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308U-Boot supports user configuration using Environment Variables which
5309can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk2729af92004-05-03 20:45:30 +00005311Environment Variables are set using "setenv", printed using
5312"printenv", and saved to Flash using "saveenv". Using "setenv"
5313without a value can be used to delete a variable from the
5314environment. As long as you don't save the environment you are
5315working with an in-memory copy. In case the Flash area containing the
5316environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005317
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005318Some configuration options can be set using Environment Variables.
5319
5320List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk2729af92004-05-03 20:45:30 +00005322 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005323
wdenk2729af92004-05-03 20:45:30 +00005324 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk2729af92004-05-03 20:45:30 +00005326 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk2729af92004-05-03 20:45:30 +00005330 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005331
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005332 bootm_low - Memory range available for image processing in the bootm
5333 command can be restricted. This variable is given as
5334 a hexadecimal number and defines lowest address allowed
5335 for use by the bootm command. See also "bootm_size"
5336 environment variable. Address defined by "bootm_low" is
5337 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005338 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5339 bootm_mapsize.
5340
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005341 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005342 This variable is given as a hexadecimal number and it
5343 defines the size of the memory region starting at base
5344 address bootm_low that is accessible by the Linux kernel
5345 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5346 as the default value if it is defined, and bootm_size is
5347 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005348
5349 bootm_size - Memory range available for image processing in the bootm
5350 command can be restricted. This variable is given as
5351 a hexadecimal number and defines the size of the region
5352 allowed for use by the bootm command. See also "bootm_low"
5353 environment variable.
5354
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005355 updatefile - Location of the software update file on a TFTP server, used
5356 by the automatic software update feature. Please refer to
5357 documentation in doc/README.update for more details.
5358
wdenk2729af92004-05-03 20:45:30 +00005359 autoload - if set to "no" (any string beginning with 'n'),
5360 "bootp" will just load perform a lookup of the
5361 configuration from the BOOTP server, but not try to
5362 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364 autostart - if set to "yes", an image loaded using the "bootp",
5365 "rarpboot", "tftpboot" or "diskboot" commands will
5366 be automatically started (by internally calling
5367 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 If set to "no", a standalone image passed to the
5370 "bootm" command will be copied to the load address
5371 (and eventually uncompressed), but NOT be started.
5372 This can be used to load and uncompress arbitrary
5373 data.
wdenkc6097192002-11-03 00:24:07 +00005374
David A. Longa28afca2011-07-09 16:40:19 -04005375 fdt_high - if set this restricts the maximum address that the
5376 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005377 For example, if you have a system with 1 GB memory
5378 at physical address 0x10000000, while Linux kernel
5379 only recognizes the first 704 MB as low memory, you
5380 may need to set fdt_high as 0x3C000000 to have the
5381 device tree blob be copied to the maximum address
5382 of the 704 MB low memory, so that Linux kernel can
5383 access it during the boot procedure.
5384
David A. Longa28afca2011-07-09 16:40:19 -04005385 If this is set to the special value 0xFFFFFFFF then
5386 the fdt will not be copied at all on boot. For this
5387 to work it must reside in writable memory, have
5388 sufficient padding on the end of it for u-boot to
5389 add the information it needs into it, and the memory
5390 must be accessible by the kernel.
5391
Simon Glasseea63e02011-10-24 19:15:34 +00005392 fdtcontroladdr- if set this is the address of the control flattened
5393 device tree used by U-Boot when CONFIG_OF_CONTROL is
5394 defined.
5395
wdenk17ea1172004-06-06 21:51:03 +00005396 i2cfast - (PPC405GP|PPC405EP only)
5397 if set to 'y' configures Linux I2C driver for fast
5398 mode (400kHZ). This environment variable is used in
5399 initialization code. So, for changes to be effective
5400 it must be saved and board must be reset.
5401
wdenk2729af92004-05-03 20:45:30 +00005402 initrd_high - restrict positioning of initrd images:
5403 If this variable is not set, initrd images will be
5404 copied to the highest possible address in RAM; this
5405 is usually what you want since it allows for
5406 maximum initrd size. If for some reason you want to
5407 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005408 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005409 variable to a value of "no" or "off" or "0".
5410 Alternatively, you can set it to a maximum upper
5411 address to use (U-Boot will still check that it
5412 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414 For instance, when you have a system with 16 MB
5415 RAM, and want to reserve 4 MB from use by Linux,
5416 you can do this by adding "mem=12M" to the value of
5417 the "bootargs" variable. However, now you must make
5418 sure that the initrd image is placed in the first
5419 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005420
wdenk2729af92004-05-03 20:45:30 +00005421 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423 If you set initrd_high to 0xFFFFFFFF, this is an
5424 indication to U-Boot that all addresses are legal
5425 for the Linux kernel, including addresses in flash
5426 memory. In this case U-Boot will NOT COPY the
5427 ramdisk at all. This may be useful to reduce the
5428 boot time on your system, but requires that this
5429 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005430
wdenk2729af92004-05-03 20:45:30 +00005431 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433 loadaddr - Default load address for commands like "bootp",
5434 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk2729af92004-05-03 20:45:30 +00005436 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk2729af92004-05-03 20:45:30 +00005438 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005439
wdenk2729af92004-05-03 20:45:30 +00005440 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005445
Mike Frysingere2a53452011-10-02 10:01:27 +00005446 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005447
Mike Frysingere2a53452011-10-02 10:01:27 +00005448 ethact - controls which interface is currently active.
5449 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005450
Heiko Schocher48690d82010-07-20 17:45:02 +02005451 => setenv ethact FEC
5452 => ping 192.168.0.1 # traffic sent on FEC
5453 => setenv ethact SCC
5454 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005455
Matthias Fuchse1692572008-01-17 07:45:05 +01005456 ethrotate - When set to "no" U-Boot does not go through all
5457 available network interfaces.
5458 It just stays at the currently selected interface.
5459
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005460 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005461 either succeed or fail without retrying.
5462 When set to "once" the network operation will
5463 fail when all the available network interfaces
5464 are tried once without success.
5465 Useful on scripts which control the retry operation
5466 themselves.
wdenkc6097192002-11-03 00:24:07 +00005467
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005468 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005469
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005470 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005471 changing the console to be empty. If "yes" it will be
5472 made silent. If "no" it will not be made silent. If
5473 unset, then it will be made silent if the U-Boot console
5474 is silent.
5475
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005476 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005477 UDP source port.
5478
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005479 tftpdstport - If this is set, the value is used for TFTP's UDP
5480 destination port instead of the Well Know Port 69.
5481
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005482 tftpblocksize - Block size to use for TFTP transfers; if not set,
5483 we use the TFTP server's default block size
5484
5485 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5486 seconds, minimum value is 1000 = 1 second). Defines
5487 when a packet is considered to be lost so it has to
5488 be retransmitted. The default is 5000 = 5 seconds.
5489 Lowering this value may make downloads succeed
5490 faster in networks with high packet loss rates or
5491 with unreliable TFTP servers.
5492
5493 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005494 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005495 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005496
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005497The following image location variables contain the location of images
5498used in booting. The "Image" column gives the role of the image and is
5499not an environment variable name. The other columns are environment
5500variable names. "File Name" gives the name of the file on a TFTP
5501server, "RAM Address" gives the location in RAM the image will be
5502loaded to, and "Flash Location" gives the image's address in NOR
5503flash or offset in NAND flash.
5504
5505*Note* - these variables don't have to be defined for all boards, some
5506boards currenlty use other variables for these purposes, and some
5507boards use these variables for other purposes.
5508
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005509Image File Name RAM Address Flash Location
5510----- --------- ----------- --------------
5511u-boot u-boot u-boot_addr_r u-boot_addr
5512Linux kernel bootfile kernel_addr_r kernel_addr
5513device tree blob fdtfile fdt_addr_r fdt_addr
5514ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005515
wdenk2729af92004-05-03 20:45:30 +00005516The following environment variables may be used and automatically
5517updated by the network boot commands ("bootp" and "rarpboot"),
5518depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520 bootfile - see above
5521 dnsip - IP address of your Domain Name Server
5522 dnsip2 - IP address of your secondary Domain Name Server
5523 gatewayip - IP address of the Gateway (Router) to use
5524 hostname - Target hostname
5525 ipaddr - see above
5526 netmask - Subnet Mask
5527 rootpath - Pathname of the root filesystem on the NFS server
5528 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005529
wdenka3d991b2004-04-15 21:48:45 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk2729af92004-05-03 20:45:30 +00005533 serial# - contains hardware identification information such
5534 as type string and/or serial number
5535 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk2729af92004-05-03 20:45:30 +00005537These variables can be set only once (usually during manufacturing of
5538the board). U-Boot refuses to delete or overwrite these variables
5539once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005540
5541
wdenk2729af92004-05-03 20:45:30 +00005542Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544 ver - Contains the U-Boot version string as printed
5545 with the "version" command. This variable is
5546 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005547
wdenkc6097192002-11-03 00:24:07 +00005548
wdenk2729af92004-05-03 20:45:30 +00005549Please note that changes to some configuration parameters may take
5550only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005551
stroesec1551ea2003-04-04 15:53:41 +00005552
Joe Hershberger170ab112012-12-11 22:16:24 -06005553Callback functions for environment variables:
5554---------------------------------------------
5555
5556For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005557when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005558be associated with arbitrary variables. On creation, overwrite, or
5559deletion, the callback will provide the opportunity for some side
5560effect to happen or for the change to be rejected.
5561
5562The callbacks are named and associated with a function using the
5563U_BOOT_ENV_CALLBACK macro in your board or driver code.
5564
5565These callbacks are associated with variables in one of two ways. The
5566static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5567in the board configuration to a string that defines a list of
5568associations. The list must be in the following format:
5569
5570 entry = variable_name[:callback_name]
5571 list = entry[,list]
5572
5573If the callback name is not specified, then the callback is deleted.
5574Spaces are also allowed anywhere in the list.
5575
5576Callbacks can also be associated by defining the ".callbacks" variable
5577with the same list format above. Any association in ".callbacks" will
5578override any association in the static list. You can define
5579CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005580".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005581
5582
wdenk2729af92004-05-03 20:45:30 +00005583Command Line Parsing:
5584=====================
stroesec1551ea2003-04-04 15:53:41 +00005585
wdenk2729af92004-05-03 20:45:30 +00005586There are two different command line parsers available with U-Boot:
5587the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005588
wdenk2729af92004-05-03 20:45:30 +00005589Old, simple command line parser:
5590--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592- supports environment variables (through setenv / saveenv commands)
5593- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005594- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005595- special characters ('$', ';') can be escaped by prefixing with '\',
5596 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005597 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005598- You can also escape text by enclosing in single apostrophes, for example:
5599 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601Hush shell:
5602-----------
wdenkf07771c2003-05-28 08:06:31 +00005603
wdenk2729af92004-05-03 20:45:30 +00005604- similar to Bourne shell, with control structures like
5605 if...then...else...fi, for...do...done; while...do...done,
5606 until...do...done, ...
5607- supports environment ("global") variables (through setenv / saveenv
5608 commands) and local shell variables (through standard shell syntax
5609 "name=value"); only environment variables can be used with "run"
5610 command
wdenkf07771c2003-05-28 08:06:31 +00005611
wdenk2729af92004-05-03 20:45:30 +00005612General rules:
5613--------------
wdenkf07771c2003-05-28 08:06:31 +00005614
wdenk2729af92004-05-03 20:45:30 +00005615(1) If a command line (or an environment variable executed by a "run"
5616 command) contains several commands separated by semicolon, and
5617 one of these commands fails, then the remaining commands will be
5618 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005621 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005622 command will cause "run" to terminate, i. e. the remaining
5623 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625Note for Redundant Ethernet Interfaces:
5626=======================================
wdenkf07771c2003-05-28 08:06:31 +00005627
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005628Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005629such configurations and is capable of automatic selection of a
5630"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005631
wdenk2729af92004-05-03 20:45:30 +00005632Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5633MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5634"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636If the network interface stores some valid MAC address (for instance
5637in SROM), this is used as default address if there is NO correspon-
5638ding setting in the environment; if the corresponding environment
5639variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641o If the SROM has a valid MAC address, and there is no address in the
5642 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk2729af92004-05-03 20:45:30 +00005644o If there is no valid address in the SROM, and a definition in the
5645 environment exists, then the value from the environment variable is
5646 used.
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk2729af92004-05-03 20:45:30 +00005648o If both the SROM and the environment contain a MAC address, and
5649 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005650
wdenk2729af92004-05-03 20:45:30 +00005651o If both the SROM and the environment contain a MAC address, and the
5652 addresses differ, the value from the environment is used and a
5653 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655o If neither SROM nor the environment contain a MAC address, an error
5656 is raised.
wdenkc6097192002-11-03 00:24:07 +00005657
Ben Warrenecee9322010-04-26 11:11:46 -07005658If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005659will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005660may be skipped by setting the appropriate 'ethmacskip' environment variable.
5661The naming convention is as follows:
5662"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664Image Formats:
5665==============
wdenkc6097192002-11-03 00:24:07 +00005666
Marian Balakowicz3310c542008-03-12 12:13:13 +01005667U-Boot is capable of booting (and performing other auxiliary operations on)
5668images in two formats:
5669
5670New uImage format (FIT)
5671-----------------------
5672
5673Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5674to Flattened Device Tree). It allows the use of images with multiple
5675components (several kernels, ramdisks, etc.), with contents protected by
5676SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5677
5678
5679Old uImage format
5680-----------------
5681
5682Old image format is based on binary files which can be basically anything,
5683preceded by a special header; see the definitions in include/image.h for
5684details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5687 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005688 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5689 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5690 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005691* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005692 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5693 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005694* Compression Type (uncompressed, gzip, bzip2)
5695* Load Address
5696* Entry Point
5697* Image Name
5698* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk2729af92004-05-03 20:45:30 +00005700The header is marked by a special Magic Number, and both the header
5701and the data portions of the image are secured against corruption by
5702CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005703
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705Linux Support:
5706==============
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk2729af92004-05-03 20:45:30 +00005708Although U-Boot should support any OS or standalone application
5709easily, the main focus has always been on Linux during the design of
5710U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk2729af92004-05-03 20:45:30 +00005712U-Boot includes many features that so far have been part of some
5713special "boot loader" code within the Linux kernel. Also, any
5714"initrd" images to be used are no longer part of one big Linux image;
5715instead, kernel and "initrd" are separate images. This implementation
5716serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005717
wdenk2729af92004-05-03 20:45:30 +00005718- the same features can be used for other OS or standalone
5719 applications (for instance: using compressed images to reduce the
5720 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk2729af92004-05-03 20:45:30 +00005722- it becomes much easier to port new Linux kernel versions because
5723 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk2729af92004-05-03 20:45:30 +00005725- the same Linux kernel image can now be used with different "initrd"
5726 images; of course this also means that different kernel images can
5727 be run with the same "initrd". This makes testing easier (you don't
5728 have to build a new "zImage.initrd" Linux image when you just
5729 change a file in your "initrd"). Also, a field-upgrade of the
5730 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005731
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733Linux HOWTO:
5734============
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736Porting Linux to U-Boot based systems:
5737---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739U-Boot cannot save you from doing all the necessary modifications to
5740configure the Linux device drivers for use with your target hardware
5741(no, we don't intend to provide a full virtual machine interface to
5742Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005743
Stefan Roesea47a12b2010-04-15 16:07:28 +02005744But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk2729af92004-05-03 20:45:30 +00005746Just make sure your machine specific header file (for instance
5747include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005748Information structure as we define in include/asm-<arch>/u-boot.h,
5749and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005750as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005751
Simon Glass2eb31b12014-06-11 23:29:46 -06005752Note that U-Boot now has a driver model, a unified model for drivers.
5753If you are adding a new driver, plumb it into driver model. If there
5754is no uclass available, you are encouraged to create one. See
5755doc/driver-model.
5756
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk2729af92004-05-03 20:45:30 +00005758Configuring the Linux kernel:
5759-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005760
wdenk2729af92004-05-03 20:45:30 +00005761No specific requirements for U-Boot. Make sure you have some root
5762device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk2729af92004-05-03 20:45:30 +00005765Building a Linux Image:
5766-----------------------
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5769not used. If you use recent kernel source, a new build target
5770"uImage" will exist which automatically builds an image usable by
5771U-Boot. Most older kernels also have support for a "pImage" target,
5772which was introduced for our predecessor project PPCBoot and uses a
5773100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005774
wdenk2729af92004-05-03 20:45:30 +00005775Example:
wdenkc6097192002-11-03 00:24:07 +00005776
Holger Freytherab584d62014-08-04 09:26:05 +02005777 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005778 make oldconfig
5779 make dep
5780 make uImage
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk2729af92004-05-03 20:45:30 +00005782The "uImage" build target uses a special tool (in 'tools/mkimage') to
5783encapsulate a compressed Linux kernel image with header information,
5784CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005785
wdenk2729af92004-05-03 20:45:30 +00005786* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk2729af92004-05-03 20:45:30 +00005788* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005789
wdenk2729af92004-05-03 20:45:30 +00005790 ${CROSS_COMPILE}-objcopy -O binary \
5791 -R .note -R .comment \
5792 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk2729af92004-05-03 20:45:30 +00005794* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005797
wdenk2729af92004-05-03 20:45:30 +00005798* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800 mkimage -A ppc -O linux -T kernel -C gzip \
5801 -a 0 -e 0 -n "Linux Kernel Image" \
5802 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005803
wdenk24ee89b2002-11-03 17:56:27 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805The "mkimage" tool can also be used to create ramdisk images for use
5806with U-Boot, either separated from the Linux kernel image, or
5807combined into one file. "mkimage" encapsulates the images with a 64
5808byte header containing information about target architecture,
5809operating system, image type, compression method, entry points, time
5810stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005811
wdenk2729af92004-05-03 20:45:30 +00005812"mkimage" can be called in two ways: to verify existing images and
5813print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005814
wdenk2729af92004-05-03 20:45:30 +00005815In the first form (with "-l" option) mkimage lists the information
5816contained in the header of an existing U-Boot image; this includes
5817checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005818
wdenk2729af92004-05-03 20:45:30 +00005819 tools/mkimage -l image
5820 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005821
wdenk2729af92004-05-03 20:45:30 +00005822The second form (with "-d" option) is used to build a U-Boot image
5823from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005824
wdenk2729af92004-05-03 20:45:30 +00005825 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5826 -n name -d data_file image
5827 -A ==> set architecture to 'arch'
5828 -O ==> set operating system to 'os'
5829 -T ==> set image type to 'type'
5830 -C ==> set compression type 'comp'
5831 -a ==> set load address to 'addr' (hex)
5832 -e ==> set entry point to 'ep' (hex)
5833 -n ==> set image name to 'name'
5834 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005835
wdenk69459792004-05-29 16:53:29 +00005836Right now, all Linux kernels for PowerPC systems use the same load
5837address (0x00000000), but the entry point address depends on the
5838kernel version:
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk2729af92004-05-03 20:45:30 +00005840- 2.2.x kernels have the entry point at 0x0000000C,
5841- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk2729af92004-05-03 20:45:30 +00005843So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk2729af92004-05-03 20:45:30 +00005845 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5846 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005847 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005848 > examples/uImage.TQM850L
5849 Image Name: 2.4.4 kernel for TQM850L
5850 Created: Wed Jul 19 02:34:59 2000
5851 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5852 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5853 Load Address: 0x00000000
5854 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk2729af92004-05-03 20:45:30 +00005856To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005857
wdenk2729af92004-05-03 20:45:30 +00005858 -> tools/mkimage -l examples/uImage.TQM850L
5859 Image Name: 2.4.4 kernel for TQM850L
5860 Created: Wed Jul 19 02:34:59 2000
5861 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5862 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5863 Load Address: 0x00000000
5864 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005865
wdenk2729af92004-05-03 20:45:30 +00005866NOTE: for embedded systems where boot time is critical you can trade
5867speed for memory and install an UNCOMPRESSED image instead: this
5868needs more space in Flash, but boots much faster since it does not
5869need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005870
Stefan Roesea47a12b2010-04-15 16:07:28 +02005871 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005872 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5873 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005874 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005875 > examples/uImage.TQM850L-uncompressed
5876 Image Name: 2.4.4 kernel for TQM850L
5877 Created: Wed Jul 19 02:34:59 2000
5878 Image Type: PowerPC Linux Kernel Image (uncompressed)
5879 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5880 Load Address: 0x00000000
5881 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005882
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk2729af92004-05-03 20:45:30 +00005884Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5885when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005886
wdenk2729af92004-05-03 20:45:30 +00005887 -> tools/mkimage -n 'Simple Ramdisk Image' \
5888 > -A ppc -O linux -T ramdisk -C gzip \
5889 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5890 Image Name: Simple Ramdisk Image
5891 Created: Wed Jan 12 14:01:50 2000
5892 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5893 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5894 Load Address: 0x00000000
5895 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005896
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005897The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5898option performs the converse operation of the mkimage's second form (the "-d"
5899option). Given an image built by mkimage, the dumpimage extracts a "data file"
5900from the image:
5901
5902 tools/dumpimage -i image -p position data_file
5903 -i ==> extract from the 'image' a specific 'data_file', \
5904 indexed by 'position'
5905
wdenkdb01a2e2004-04-15 23:14:49 +00005906
wdenk2729af92004-05-03 20:45:30 +00005907Installing a Linux Image:
5908-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005909
wdenk2729af92004-05-03 20:45:30 +00005910To downloading a U-Boot image over the serial (console) interface,
5911you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005912
wdenk2729af92004-05-03 20:45:30 +00005913 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005914
wdenk2729af92004-05-03 20:45:30 +00005915The 'objcopy' does not understand the information in the U-Boot
5916image header, so the resulting S-Record file will be relative to
5917address 0x00000000. To load it to a given address, you need to
5918specify the target address as 'offset' parameter with the 'loads'
5919command.
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk2729af92004-05-03 20:45:30 +00005921Example: install the image to address 0x40100000 (which on the
5922TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk2729af92004-05-03 20:45:30 +00005924 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005925
wdenk2729af92004-05-03 20:45:30 +00005926 .......... done
5927 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005928
wdenk2729af92004-05-03 20:45:30 +00005929 => loads 40100000
5930 ## Ready for S-Record download ...
5931 ~>examples/image.srec
5932 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5933 ...
5934 15989 15990 15991 15992
5935 [file transfer complete]
5936 [connected]
5937 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005938
5939
wdenk2729af92004-05-03 20:45:30 +00005940You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005941this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005942corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk2729af92004-05-03 20:45:30 +00005944 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005945
wdenk2729af92004-05-03 20:45:30 +00005946 ## Checking Image at 40100000 ...
5947 Image Name: 2.2.13 for initrd on TQM850L
5948 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5949 Data Size: 335725 Bytes = 327 kB = 0 MB
5950 Load Address: 00000000
5951 Entry Point: 0000000c
5952 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005953
5954
wdenk2729af92004-05-03 20:45:30 +00005955Boot Linux:
5956-----------
wdenkc6097192002-11-03 00:24:07 +00005957
wdenk2729af92004-05-03 20:45:30 +00005958The "bootm" command is used to boot an application that is stored in
5959memory (RAM or Flash). In case of a Linux kernel image, the contents
5960of the "bootargs" environment variable is passed to the kernel as
5961parameters. You can check and modify this variable using the
5962"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005963
5964
wdenk2729af92004-05-03 20:45:30 +00005965 => printenv bootargs
5966 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005967
wdenk2729af92004-05-03 20:45:30 +00005968 => 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 +00005969
wdenk2729af92004-05-03 20:45:30 +00005970 => printenv bootargs
5971 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 +00005972
wdenk2729af92004-05-03 20:45:30 +00005973 => bootm 40020000
5974 ## Booting Linux kernel at 40020000 ...
5975 Image Name: 2.2.13 for NFS on TQM850L
5976 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5977 Data Size: 381681 Bytes = 372 kB = 0 MB
5978 Load Address: 00000000
5979 Entry Point: 0000000c
5980 Verifying Checksum ... OK
5981 Uncompressing Kernel Image ... OK
5982 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
5983 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5984 time_init: decrementer frequency = 187500000/60
5985 Calibrating delay loop... 49.77 BogoMIPS
5986 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5987 ...
wdenkc6097192002-11-03 00:24:07 +00005988
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005989If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005990the memory addresses of both the kernel and the initrd image (PPBCOOT
5991format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk2729af92004-05-03 20:45:30 +00005993 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005994
wdenk2729af92004-05-03 20:45:30 +00005995 ## Checking Image at 40100000 ...
5996 Image Name: 2.2.13 for initrd on TQM850L
5997 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5998 Data Size: 335725 Bytes = 327 kB = 0 MB
5999 Load Address: 00000000
6000 Entry Point: 0000000c
6001 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006002
wdenk2729af92004-05-03 20:45:30 +00006003 ## Checking Image at 40200000 ...
6004 Image Name: Simple Ramdisk Image
6005 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6006 Data Size: 566530 Bytes = 553 kB = 0 MB
6007 Load Address: 00000000
6008 Entry Point: 00000000
6009 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006010
wdenk2729af92004-05-03 20:45:30 +00006011 => bootm 40100000 40200000
6012 ## Booting Linux kernel at 40100000 ...
6013 Image Name: 2.2.13 for initrd on TQM850L
6014 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6015 Data Size: 335725 Bytes = 327 kB = 0 MB
6016 Load Address: 00000000
6017 Entry Point: 0000000c
6018 Verifying Checksum ... OK
6019 Uncompressing Kernel Image ... OK
6020 ## Loading RAMDisk Image at 40200000 ...
6021 Image Name: Simple Ramdisk Image
6022 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6023 Data Size: 566530 Bytes = 553 kB = 0 MB
6024 Load Address: 00000000
6025 Entry Point: 00000000
6026 Verifying Checksum ... OK
6027 Loading Ramdisk ... OK
6028 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
6029 Boot arguments: root=/dev/ram
6030 time_init: decrementer frequency = 187500000/60
6031 Calibrating delay loop... 49.77 BogoMIPS
6032 ...
6033 RAMDISK: Compressed image found at block 0
6034 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006035
wdenk2729af92004-05-03 20:45:30 +00006036 bash#
wdenkc6097192002-11-03 00:24:07 +00006037
Matthew McClintock02677682006-06-28 10:41:37 -05006038Boot Linux and pass a flat device tree:
6039-----------
6040
6041First, U-Boot must be compiled with the appropriate defines. See the section
6042titled "Linux Kernel Interface" above for a more in depth explanation. The
6043following is an example of how to start a kernel and pass an updated
6044flat device tree:
6045
6046=> print oftaddr
6047oftaddr=0x300000
6048=> print oft
6049oft=oftrees/mpc8540ads.dtb
6050=> tftp $oftaddr $oft
6051Speed: 1000, full duplex
6052Using TSEC0 device
6053TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6054Filename 'oftrees/mpc8540ads.dtb'.
6055Load address: 0x300000
6056Loading: #
6057done
6058Bytes transferred = 4106 (100a hex)
6059=> tftp $loadaddr $bootfile
6060Speed: 1000, full duplex
6061Using TSEC0 device
6062TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6063Filename 'uImage'.
6064Load address: 0x200000
6065Loading:############
6066done
6067Bytes transferred = 1029407 (fb51f hex)
6068=> print loadaddr
6069loadaddr=200000
6070=> print oftaddr
6071oftaddr=0x300000
6072=> bootm $loadaddr - $oftaddr
6073## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006074 Image Name: Linux-2.6.17-dirty
6075 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6076 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006077 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006078 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006079 Verifying Checksum ... OK
6080 Uncompressing Kernel Image ... OK
6081Booting using flat device tree at 0x300000
6082Using MPC85xx ADS machine description
6083Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6084[snip]
6085
6086
wdenk2729af92004-05-03 20:45:30 +00006087More About U-Boot Image Types:
6088------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006089
wdenk2729af92004-05-03 20:45:30 +00006090U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006091
wdenk2729af92004-05-03 20:45:30 +00006092 "Standalone Programs" are directly runnable in the environment
6093 provided by U-Boot; it is expected that (if they behave
6094 well) you can continue to work in U-Boot after return from
6095 the Standalone Program.
6096 "OS Kernel Images" are usually images of some Embedded OS which
6097 will take over control completely. Usually these programs
6098 will install their own set of exception handlers, device
6099 drivers, set up the MMU, etc. - this means, that you cannot
6100 expect to re-enter U-Boot except by resetting the CPU.
6101 "RAMDisk Images" are more or less just data blocks, and their
6102 parameters (address, size) are passed to an OS kernel that is
6103 being started.
6104 "Multi-File Images" contain several images, typically an OS
6105 (Linux) kernel image and one or more data images like
6106 RAMDisks. This construct is useful for instance when you want
6107 to boot over the network using BOOTP etc., where the boot
6108 server provides just a single image file, but you want to get
6109 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006110
wdenk2729af92004-05-03 20:45:30 +00006111 "Multi-File Images" start with a list of image sizes, each
6112 image size (in bytes) specified by an "uint32_t" in network
6113 byte order. This list is terminated by an "(uint32_t)0".
6114 Immediately after the terminating 0 follow the images, one by
6115 one, all aligned on "uint32_t" boundaries (size rounded up to
6116 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006117
wdenk2729af92004-05-03 20:45:30 +00006118 "Firmware Images" are binary images containing firmware (like
6119 U-Boot or FPGA images) which usually will be programmed to
6120 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006121
wdenk2729af92004-05-03 20:45:30 +00006122 "Script files" are command sequences that will be executed by
6123 U-Boot's command interpreter; this feature is especially
6124 useful when you configure U-Boot to use a real shell (hush)
6125 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006126
Marek Vasut44f074c2012-03-14 21:52:45 +00006127Booting the Linux zImage:
6128-------------------------
6129
6130On some platforms, it's possible to boot Linux zImage. This is done
6131using the "bootz" command. The syntax of "bootz" command is the same
6132as the syntax of "bootm" command.
6133
Tom Rini8ac28562013-05-16 11:40:11 -04006134Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006135kernel with raw initrd images. The syntax is slightly different, the
6136address of the initrd must be augmented by it's size, in the following
6137format: "<initrd addres>:<initrd size>".
6138
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk2729af92004-05-03 20:45:30 +00006140Standalone HOWTO:
6141=================
wdenkc6097192002-11-03 00:24:07 +00006142
wdenk2729af92004-05-03 20:45:30 +00006143One of the features of U-Boot is that you can dynamically load and
6144run "standalone" applications, which can use some resources of
6145U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk2729af92004-05-03 20:45:30 +00006147Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006148
wdenk2729af92004-05-03 20:45:30 +00006149"Hello World" Demo:
6150-------------------
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk2729af92004-05-03 20:45:30 +00006152'examples/hello_world.c' contains a small "Hello World" Demo
6153application; it is automatically compiled when you build U-Boot.
6154It's configured to run at address 0x00040004, so you can play with it
6155like that:
wdenkc6097192002-11-03 00:24:07 +00006156
wdenk2729af92004-05-03 20:45:30 +00006157 => loads
6158 ## Ready for S-Record download ...
6159 ~>examples/hello_world.srec
6160 1 2 3 4 5 6 7 8 9 10 11 ...
6161 [file transfer complete]
6162 [connected]
6163 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006164
wdenk2729af92004-05-03 20:45:30 +00006165 => go 40004 Hello World! This is a test.
6166 ## Starting application at 0x00040004 ...
6167 Hello World
6168 argc = 7
6169 argv[0] = "40004"
6170 argv[1] = "Hello"
6171 argv[2] = "World!"
6172 argv[3] = "This"
6173 argv[4] = "is"
6174 argv[5] = "a"
6175 argv[6] = "test."
6176 argv[7] = "<NULL>"
6177 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006178
wdenk2729af92004-05-03 20:45:30 +00006179 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk2729af92004-05-03 20:45:30 +00006181Another example, which demonstrates how to register a CPM interrupt
6182handler with the U-Boot code, can be found in 'examples/timer.c'.
6183Here, a CPM timer is set up to generate an interrupt every second.
6184The interrupt service routine is trivial, just printing a '.'
6185character, but this is just a demo program. The application can be
6186controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006187
wdenk2729af92004-05-03 20:45:30 +00006188 ? - print current values og the CPM Timer registers
6189 b - enable interrupts and start timer
6190 e - stop timer and disable interrupts
6191 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006192
wdenk2729af92004-05-03 20:45:30 +00006193 => loads
6194 ## Ready for S-Record download ...
6195 ~>examples/timer.srec
6196 1 2 3 4 5 6 7 8 9 10 11 ...
6197 [file transfer complete]
6198 [connected]
6199 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006200
wdenk2729af92004-05-03 20:45:30 +00006201 => go 40004
6202 ## Starting application at 0x00040004 ...
6203 TIMERS=0xfff00980
6204 Using timer 1
6205 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006206
wdenk2729af92004-05-03 20:45:30 +00006207Hit 'b':
6208 [q, b, e, ?] Set interval 1000000 us
6209 Enabling timer
6210Hit '?':
6211 [q, b, e, ?] ........
6212 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6213Hit '?':
6214 [q, b, e, ?] .
6215 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6216Hit '?':
6217 [q, b, e, ?] .
6218 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6219Hit '?':
6220 [q, b, e, ?] .
6221 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6222Hit 'e':
6223 [q, b, e, ?] ...Stopping timer
6224Hit 'q':
6225 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006226
6227
wdenk2729af92004-05-03 20:45:30 +00006228Minicom warning:
6229================
wdenk85ec0bc2003-03-31 16:34:49 +00006230
wdenk2729af92004-05-03 20:45:30 +00006231Over time, many people have reported problems when trying to use the
6232"minicom" terminal emulation program for serial download. I (wd)
6233consider minicom to be broken, and recommend not to use it. Under
6234Unix, I recommend to use C-Kermit for general purpose use (and
6235especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006236use "cu" for S-Record download ("loads" command). See
6237http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6238for help with kermit.
6239
wdenk85ec0bc2003-03-31 16:34:49 +00006240
wdenk2729af92004-05-03 20:45:30 +00006241Nevertheless, if you absolutely want to use it try adding this
6242configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006243
wdenk2729af92004-05-03 20:45:30 +00006244 Name Program Name U/D FullScr IO-Red. Multi
6245 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6246 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006247
6248
wdenk2729af92004-05-03 20:45:30 +00006249NetBSD Notes:
6250=============
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk2729af92004-05-03 20:45:30 +00006252Starting at version 0.9.2, U-Boot supports NetBSD both as host
6253(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006254
wdenk2729af92004-05-03 20:45:30 +00006255Building requires a cross environment; it is known to work on
6256NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6257need gmake since the Makefiles are not compatible with BSD make).
6258Note that the cross-powerpc package does not install include files;
6259attempting to build U-Boot will fail because <machine/ansi.h> is
6260missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006261
wdenk2729af92004-05-03 20:45:30 +00006262 # cd /usr/pkg/cross/powerpc-netbsd/include
6263 # mkdir powerpc
6264 # ln -s powerpc machine
6265 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6266 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006267
wdenk2729af92004-05-03 20:45:30 +00006268Native builds *don't* work due to incompatibilities between native
6269and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk2729af92004-05-03 20:45:30 +00006271Booting assumes that (the first part of) the image booted is a
6272stage-2 loader which in turn loads and then invokes the kernel
6273proper. Loader sources will eventually appear in the NetBSD source
6274tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006275meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006276
6277
wdenk2729af92004-05-03 20:45:30 +00006278Implementation Internals:
6279=========================
wdenkc6097192002-11-03 00:24:07 +00006280
wdenk2729af92004-05-03 20:45:30 +00006281The following is not intended to be a complete description of every
6282implementation detail. However, it should help to understand the
6283inner workings of U-Boot and make it easier to port it to custom
6284hardware.
wdenkc6097192002-11-03 00:24:07 +00006285
6286
wdenk2729af92004-05-03 20:45:30 +00006287Initial Stack, Global Data:
6288---------------------------
wdenkc6097192002-11-03 00:24:07 +00006289
wdenk2729af92004-05-03 20:45:30 +00006290The implementation of U-Boot is complicated by the fact that U-Boot
6291starts running out of ROM (flash memory), usually without access to
6292system RAM (because the memory controller is not initialized yet).
6293This means that we don't have writable Data or BSS segments, and BSS
6294is not initialized as zero. To be able to get a C environment working
6295at all, we have to allocate at least a minimal stack. Implementation
6296options for this are defined and restricted by the CPU used: Some CPU
6297models provide on-chip memory (like the IMMR area on MPC8xx and
6298MPC826x processors), on others (parts of) the data cache can be
6299locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006300
Wolfgang Denk218ca722008-03-26 10:40:12 +01006301 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006302 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006303
wdenk2729af92004-05-03 20:45:30 +00006304 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6305 From: "Chris Hallinan" <clh@net1plus.com>
6306 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6307 ...
wdenk43d96162003-03-06 00:02:04 +00006308
wdenk2729af92004-05-03 20:45:30 +00006309 Correct me if I'm wrong, folks, but the way I understand it
6310 is this: Using DCACHE as initial RAM for Stack, etc, does not
6311 require any physical RAM backing up the cache. The cleverness
6312 is that the cache is being used as a temporary supply of
6313 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006314 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006315 can see how this works by studying the cache architecture and
6316 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006317
wdenk2729af92004-05-03 20:45:30 +00006318 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6319 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006320 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006321 option should work for you. Using CS 4 should be fine if your
6322 board designers haven't used it for something that would
6323 cause you grief during the initial boot! It is frequently not
6324 used.
wdenk43d96162003-03-06 00:02:04 +00006325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006326 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006327 with your processor/board/system design. The default value
6328 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006329 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006330 than your SDRAM module. If you have a 64MB SDRAM module, set
6331 it above 400_0000. Just make sure your board has no resources
6332 that are supposed to respond to that address! That code in
6333 start.S has been around a while and should work as is when
6334 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006335
wdenk2729af92004-05-03 20:45:30 +00006336 -Chris Hallinan
6337 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006338
wdenk2729af92004-05-03 20:45:30 +00006339It is essential to remember this, since it has some impact on the C
6340code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006341
wdenk2729af92004-05-03 20:45:30 +00006342* Initialized global data (data segment) is read-only. Do not attempt
6343 to write it.
wdenkc6097192002-11-03 00:24:07 +00006344
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006345* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006346 as zero data - BSS segment) at all - this is undefined, initiali-
6347 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006348
wdenk2729af92004-05-03 20:45:30 +00006349* Stack space is very limited. Avoid big data buffers or things like
6350 that.
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk2729af92004-05-03 20:45:30 +00006352Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006353normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006354turned out that the implementation of U-Boot can be greatly
6355simplified by making a global data structure (gd_t) available to all
6356functions. We could pass a pointer to this data as argument to _all_
6357functions, but this would bloat the code. Instead we use a feature of
6358the GCC compiler (Global Register Variables) to share the data: we
6359place a pointer (gd) to the global data into a register which we
6360reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006361
wdenk2729af92004-05-03 20:45:30 +00006362When choosing a register for such a purpose we are restricted by the
6363relevant (E)ABI specifications for the current architecture, and by
6364GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006365
wdenk2729af92004-05-03 20:45:30 +00006366For PowerPC, the following registers have specific use:
6367 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006368 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006369 R3-R4: parameter passing and return values
6370 R5-R10: parameter passing
6371 R13: small data area pointer
6372 R30: GOT pointer
6373 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006374
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006375 (U-Boot also uses R12 as internal GOT pointer. r12
6376 is a volatile register so r12 needs to be reset when
6377 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006378
Wolfgang Denke7670f62008-02-14 22:43:22 +01006379 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006380
wdenk2729af92004-05-03 20:45:30 +00006381 Note: on PPC, we could use a static initializer (since the
6382 address of the global data structure is known at compile time),
6383 but it turned out that reserving a register results in somewhat
6384 smaller code - although the code savings are not that big (on
6385 average for all boards 752 bytes for the whole U-Boot image,
6386 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006387
Robin Getzc4db3352009-08-17 15:23:02 +00006388On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006389 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6390
Robin Getzc4db3352009-08-17 15:23:02 +00006391 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006392
wdenk2729af92004-05-03 20:45:30 +00006393On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006394
wdenk2729af92004-05-03 20:45:30 +00006395 R0: function argument word/integer result
6396 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006397 R9: platform specific
6398 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006399 R11: argument (frame) pointer
6400 R12: temporary workspace
6401 R13: stack pointer
6402 R14: link register
6403 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006404
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006405 ==> U-Boot will use R9 to hold a pointer to the global data
6406
6407 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006408
Thomas Chou0df01fd2010-05-21 11:08:03 +08006409On Nios II, the ABI is documented here:
6410 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6411
6412 ==> U-Boot will use gp to hold a pointer to the global data
6413
6414 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6415 to access small data sections, so gp is free.
6416
Macpaul Linafc1ce82011-10-19 20:41:11 +00006417On NDS32, the following registers are used:
6418
6419 R0-R1: argument/return
6420 R2-R5: argument
6421 R15: temporary register for assembler
6422 R16: trampoline register
6423 R28: frame pointer (FP)
6424 R29: global pointer (GP)
6425 R30: link register (LP)
6426 R31: stack pointer (SP)
6427 PC: program counter (PC)
6428
6429 ==> U-Boot will use R10 to hold a pointer to the global data
6430
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006431NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6432or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006433
wdenk2729af92004-05-03 20:45:30 +00006434Memory Management:
6435------------------
wdenkc6097192002-11-03 00:24:07 +00006436
wdenk2729af92004-05-03 20:45:30 +00006437U-Boot runs in system state and uses physical addresses, i.e. the
6438MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk2729af92004-05-03 20:45:30 +00006440The available memory is mapped to fixed addresses using the memory
6441controller. In this process, a contiguous block is formed for each
6442memory type (Flash, SDRAM, SRAM), even when it consists of several
6443physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006444
wdenk2729af92004-05-03 20:45:30 +00006445U-Boot is installed in the first 128 kB of the first Flash bank (on
6446TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6447booting and sizing and initializing DRAM, the code relocates itself
6448to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006449memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006450configuration setting]. Below that, a structure with global Board
6451Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006452
wdenk2729af92004-05-03 20:45:30 +00006453Additionally, some exception handler code is copied to the low 8 kB
6454of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006455
wdenk2729af92004-05-03 20:45:30 +00006456So a typical memory configuration with 16 MB of DRAM could look like
6457this:
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk2729af92004-05-03 20:45:30 +00006459 0x0000 0000 Exception Vector code
6460 :
6461 0x0000 1FFF
6462 0x0000 2000 Free for Application Use
6463 :
6464 :
wdenkc6097192002-11-03 00:24:07 +00006465
wdenk2729af92004-05-03 20:45:30 +00006466 :
6467 :
6468 0x00FB FF20 Monitor Stack (Growing downward)
6469 0x00FB FFAC Board Info Data and permanent copy of global data
6470 0x00FC 0000 Malloc Arena
6471 :
6472 0x00FD FFFF
6473 0x00FE 0000 RAM Copy of Monitor Code
6474 ... eventually: LCD or video framebuffer
6475 ... eventually: pRAM (Protected RAM - unchanged by reset)
6476 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006477
6478
wdenk2729af92004-05-03 20:45:30 +00006479System Initialization:
6480----------------------
wdenkc6097192002-11-03 00:24:07 +00006481
wdenk2729af92004-05-03 20:45:30 +00006482In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006483(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006484configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006485To be able to re-map memory U-Boot then jumps to its link address.
6486To be able to implement the initialization code in C, a (small!)
6487initial stack is set up in the internal Dual Ported RAM (in case CPUs
6488which provide such a feature like MPC8xx or MPC8260), or in a locked
6489part of the data cache. After that, U-Boot initializes the CPU core,
6490the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006491
wdenk2729af92004-05-03 20:45:30 +00006492Next, all (potentially) available memory banks are mapped using a
6493preliminary mapping. For example, we put them on 512 MB boundaries
6494(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6495on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6496programmed for SDRAM access. Using the temporary configuration, a
6497simple memory test is run that determines the size of the SDRAM
6498banks.
wdenkc6097192002-11-03 00:24:07 +00006499
wdenk2729af92004-05-03 20:45:30 +00006500When there is more than one SDRAM bank, and the banks are of
6501different size, the largest is mapped first. For equal size, the first
6502bank (CS2#) is mapped first. The first mapping is always for address
65030x00000000, with any additional banks following immediately to create
6504contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk2729af92004-05-03 20:45:30 +00006506Then, the monitor installs itself at the upper end of the SDRAM area
6507and allocates memory for use by malloc() and for the global Board
6508Info data; also, the exception vector code is copied to the low RAM
6509pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006510
wdenk2729af92004-05-03 20:45:30 +00006511Only after this relocation will you have a "normal" C environment;
6512until that you are restricted in several ways, mostly because you are
6513running from ROM, and because the code will have to be relocated to a
6514new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006515
6516
wdenk2729af92004-05-03 20:45:30 +00006517U-Boot Porting Guide:
6518----------------------
wdenkc6097192002-11-03 00:24:07 +00006519
wdenk2729af92004-05-03 20:45:30 +00006520[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6521list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006522
6523
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006524int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006525{
6526 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006527
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006528 signal(SIGALRM, no_more_time);
6529 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006530
wdenk2729af92004-05-03 20:45:30 +00006531 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006532 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006533 return 0;
6534 }
6535
wdenk2729af92004-05-03 20:45:30 +00006536 Download latest U-Boot source;
6537
Wolfgang Denk06682362008-12-30 22:56:11 +01006538 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006539
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006540 if (clueless)
6541 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006542
wdenk2729af92004-05-03 20:45:30 +00006543 while (learning) {
6544 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006545 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6546 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006547 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006548 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006549 }
wdenkc6097192002-11-03 00:24:07 +00006550
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006551 if (available_money > toLocalCurrency ($2500))
6552 Buy a BDI3000;
6553 else
wdenk2729af92004-05-03 20:45:30 +00006554 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006555
6556 if (a similar board exists) { /* hopefully... */
6557 cp -a board/<similar> board/<myboard>
6558 cp include/configs/<similar>.h include/configs/<myboard>.h
6559 } else {
6560 Create your own board support subdirectory;
6561 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006562 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006563 Edit new board/<myboard> files
6564 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006565
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006566 while (!accepted) {
6567 while (!running) {
6568 do {
6569 Add / modify source code;
6570 } until (compiles);
6571 Debug;
6572 if (clueless)
6573 email("Hi, I am having problems...");
6574 }
6575 Send patch file to the U-Boot email list;
6576 if (reasonable critiques)
6577 Incorporate improvements from email list code review;
6578 else
6579 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006580 }
wdenkc6097192002-11-03 00:24:07 +00006581
wdenk2729af92004-05-03 20:45:30 +00006582 return 0;
6583}
6584
6585void no_more_time (int sig)
6586{
6587 hire_a_guru();
6588}
wdenkc6097192002-11-03 00:24:07 +00006589
6590
wdenk2729af92004-05-03 20:45:30 +00006591Coding Standards:
6592-----------------
wdenkc6097192002-11-03 00:24:07 +00006593
wdenk2729af92004-05-03 20:45:30 +00006594All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006595coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006596"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006597
Detlev Zundel2c051652006-09-01 15:39:02 +02006598Source files originating from a different project (for example the
6599MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006600reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006601sources.
6602
6603Please note that U-Boot is implemented in C (and to some small parts in
6604Assembler); no C++ is used, so please do not use C++ style comments (//)
6605in your code.
wdenk2729af92004-05-03 20:45:30 +00006606
6607Please also stick to the following formatting rules:
6608- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006609- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006610- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006611- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006612- do not add trailing empty lines to source files
6613
6614Submissions which do not conform to the standards may be returned
6615with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006616
6617
wdenk2729af92004-05-03 20:45:30 +00006618Submitting Patches:
6619-------------------
wdenkc6097192002-11-03 00:24:07 +00006620
wdenk2729af92004-05-03 20:45:30 +00006621Since the number of patches for U-Boot is growing, we need to
6622establish some rules. Submissions which do not conform to these rules
6623may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006624
Magnus Lilja0d28f342008-08-06 19:32:33 +02006625Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006626
Wolfgang Denk06682362008-12-30 22:56:11 +01006627Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6628see http://lists.denx.de/mailman/listinfo/u-boot
6629
wdenk2729af92004-05-03 20:45:30 +00006630When you send a patch, please include the following information with
6631it:
wdenkc6097192002-11-03 00:24:07 +00006632
wdenk2729af92004-05-03 20:45:30 +00006633* For bug fixes: a description of the bug and how your patch fixes
6634 this bug. Please try to include a way of demonstrating that the
6635 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006636
wdenk2729af92004-05-03 20:45:30 +00006637* For new features: a description of the feature and your
6638 implementation.
wdenkc6097192002-11-03 00:24:07 +00006639
wdenk2729af92004-05-03 20:45:30 +00006640* A CHANGELOG entry as plaintext (separate from the patch)
6641
6642* For major contributions, your entry to the CREDITS file
6643
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006644* When you add support for a new board, don't forget to add a
6645 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006646
6647* If your patch adds new configuration options, don't forget to
6648 document these in the README file.
6649
Wolfgang Denk218ca722008-03-26 10:40:12 +01006650* The patch itself. If you are using git (which is *strongly*
6651 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006652 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006653 the U-Boot mailing list, you will avoid most of the common problems
6654 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006655
Wolfgang Denk218ca722008-03-26 10:40:12 +01006656 If you cannot use git, use "diff -purN OLD NEW". If your version of
6657 diff does not support these options, then get the latest version of
6658 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006659
Wolfgang Denk218ca722008-03-26 10:40:12 +01006660 The current directory when running this command shall be the parent
6661 directory of the U-Boot source tree (i. e. please make sure that
6662 your patch includes sufficient directory information for the
6663 affected files).
6664
6665 We prefer patches as plain text. MIME attachments are discouraged,
6666 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006667
6668* If one logical set of modifications affects or creates several
6669 files, all these changes shall be submitted in a SINGLE patch file.
6670
6671* Changesets that contain different, unrelated modifications shall be
6672 submitted as SEPARATE patches, one patch per changeset.
6673
6674
6675Notes:
6676
6677* Before sending the patch, run the MAKEALL script on your patched
6678 source tree and make sure that no errors or warnings are reported
6679 for any of the boards.
6680
6681* Keep your modifications to the necessary minimum: A patch
6682 containing several unrelated changes or arbitrary reformats will be
6683 returned with a request to re-formatting / split it.
6684
6685* If you modify existing code, make sure that your new code does not
6686 add to the memory footprint of the code ;-) Small is beautiful!
6687 When adding new features, these should compile conditionally only
6688 (using #ifdef), and the resulting code with the new feature
6689 disabled must not need more memory than the old code without your
6690 modification.
wdenk90dc6702005-05-03 14:12:25 +00006691
Wolfgang Denk06682362008-12-30 22:56:11 +01006692* Remember that there is a size limit of 100 kB per message on the
6693 u-boot mailing list. Bigger patches will be moderated. If they are
6694 reasonable and not too big, they will be acknowledged. But patches
6695 bigger than the size limit should be avoided.