blob: 604f0fa78e5141839e29e8d855a2932f537b3f69 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200255configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000256
257Example: For a TQM823L module type:
258
259 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000264directory according to the instructions in cogent/README.
265
266
Simon Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530275See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk7f6c2cb2002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Gala66412c62011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala8f290842011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood33eee332012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530412 CONFIG_A008044_WORKAROUND
413 Enables a workaround for T1040/T1042 erratum A008044. It is only
414 requred during NAND boot and valid for Rev 1.0 SoC revision
415
Scott Wood33eee332012-08-14 10:14:53 +0000416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Priyanka Jain64501c62013-07-02 09:21:04 +0530421 CONFIG_SYS_FSL_DSP_DDR_ADDR
422 This value denotes start offset of DDR memory which is
423 connected exclusively to the DSP cores.
424
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
Priyanka Jain64501c62013-07-02 09:21:04 +0530429 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430 This value denotes start offset of M3 memory which is directly
431 connected to the DSP core.
432
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530433 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434 This value denotes start offset of DSP CCSR space.
435
Priyanka Jainb1359912013-12-17 14:25:52 +0530436 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437 Single Source Clock is clocking mode present in some of FSL SoC's.
438 In this mode, a single differential clock is used to supply
439 clocks to the sysclock, ddrclock and usbclock.
440
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530441 CONFIG_SYS_CPC_REINIT_F
442 This CONFIG is defined when the CPC is configured as SRAM at the
443 time of U-boot entry and is required to be re-initialized.
444
Tang Yuantianaade2002014-04-17 15:33:46 +0800445 CONFIG_DEEP_SLEEP
446 Inidcates this SoC supports deep sleep feature. If deep sleep is
447 supported, core will start to execute uboot when wakes up.
448
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000449- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700450 CONFIG_SYS_GENERIC_GLOBAL_DATA
451 Defines global data is initialized in generic board board_init_f().
452 If this macro is defined, global data is created and cleared in
453 generic board board_init_f(). Without this macro, architecture/board
454 should initialize global data before calling board_init_f().
455
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000456 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458 Defines the endianess of the CPU. Implementation of those
459 values is arch specific.
460
York Sun5614e712013-09-30 09:22:09 -0700461 CONFIG_SYS_FSL_DDR
462 Freescale DDR driver in use. This type of DDR controller is
463 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464 SoCs.
465
466 CONFIG_SYS_FSL_DDR_ADDR
467 Freescale DDR memory-mapped register base.
468
469 CONFIG_SYS_FSL_DDR_EMU
470 Specify emulator support for DDR. Some DDR features such as
471 deskew training are not available.
472
473 CONFIG_SYS_FSL_DDRC_GEN1
474 Freescale DDR1 controller.
475
476 CONFIG_SYS_FSL_DDRC_GEN2
477 Freescale DDR2 controller.
478
479 CONFIG_SYS_FSL_DDRC_GEN3
480 Freescale DDR3 controller.
481
York Sun34e026f2014-03-27 17:54:47 -0700482 CONFIG_SYS_FSL_DDRC_GEN4
483 Freescale DDR4 controller.
484
York Sun9ac4ffb2013-09-30 14:20:51 -0700485 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486 Freescale DDR3 controller for ARM-based SoCs.
487
York Sun5614e712013-09-30 09:22:09 -0700488 CONFIG_SYS_FSL_DDR1
489 Board config to use DDR1. It can be enabled for SoCs with
490 Freescale DDR1 or DDR2 controllers, depending on the board
491 implemetation.
492
493 CONFIG_SYS_FSL_DDR2
494 Board config to use DDR2. It can be eanbeld for SoCs with
495 Freescale DDR2 or DDR3 controllers, depending on the board
496 implementation.
497
498 CONFIG_SYS_FSL_DDR3
499 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700500 Freescale DDR3 or DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR3L
503 Board config to use DDR3L. It can be enabled for SoCs with
504 DDR3L controllers.
505
506 CONFIG_SYS_FSL_DDR4
507 Board config to use DDR4. It can be enabled for SoCs with
508 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700509
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530510 CONFIG_SYS_FSL_IFC_BE
511 Defines the IFC controller register space as Big Endian
512
513 CONFIG_SYS_FSL_IFC_LE
514 Defines the IFC controller register space as Little Endian
515
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530516 CONFIG_SYS_FSL_PBL_PBI
517 It enables addition of RCW (Power on reset configuration) in built image.
518 Please refer doc/README.pblimage for more details
519
520 CONFIG_SYS_FSL_PBL_RCW
521 It adds PBI(pre-boot instructions) commands in u-boot build image.
522 PBI commands can be used to configure SoC before it starts the execution.
523 Please refer doc/README.pblimage for more details
524
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530525 CONFIG_SPL_FSL_PBL
526 It adds a target to create boot binary having SPL binary in PBI format
527 concatenated with u-boot binary.
528
York Sun4e5b1bd2014-02-10 13:59:42 -0800529 CONFIG_SYS_FSL_DDR_BE
530 Defines the DDR controller register space as Big Endian
531
532 CONFIG_SYS_FSL_DDR_LE
533 Defines the DDR controller register space as Little Endian
534
York Sun6b9e3092014-02-10 13:59:43 -0800535 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536 Physical address from the view of DDR controllers. It is the
537 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
538 it could be different for ARM SoCs.
539
York Sun6b1e1252014-02-10 13:59:44 -0800540 CONFIG_SYS_FSL_DDR_INTLV_256B
541 DDR controller interleaving on 256-byte. This is a special
542 interleaving mode, handled by Dickens for Freescale layerscape
543 SoCs with ARM core.
544
York Sun1d71efb2014-08-01 15:51:00 -0700545 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546 Number of controllers used as main memory.
547
548 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549 Number of controllers used for other than main memory.
550
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530551 CONFIG_SYS_FSL_SEC_BE
552 Defines the SEC controller register space as Big Endian
553
554 CONFIG_SYS_FSL_SEC_LE
555 Defines the SEC controller register space as Little Endian
556
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100557- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200558 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100559
560 Defines the Monahans run mode to oscillator
561 ratio. Valid values are 8, 16, 24, 31. The core
562 frequency is this value multiplied by 13 MHz.
563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200564 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200565
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100566 Defines the Monahans turbo mode to oscillator
567 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200568 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100569 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200570
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200571- MIPS CPU options:
572 CONFIG_SYS_INIT_SP_OFFSET
573
574 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
575 pointer. This is needed for the temporary stack before
576 relocation.
577
578 CONFIG_SYS_MIPS_CACHE_MODE
579
580 Cache operation mode for the MIPS CPU.
581 See also arch/mips/include/asm/mipsregs.h.
582 Possible values are:
583 CONF_CM_CACHABLE_NO_WA
584 CONF_CM_CACHABLE_WA
585 CONF_CM_UNCACHED
586 CONF_CM_CACHABLE_NONCOHERENT
587 CONF_CM_CACHABLE_CE
588 CONF_CM_CACHABLE_COW
589 CONF_CM_CACHABLE_CUW
590 CONF_CM_CACHABLE_ACCELERATED
591
592 CONFIG_SYS_XWAY_EBU_BOOTCFG
593
594 Special option for Lantiq XWAY SoCs for booting from NOR flash.
595 See also arch/mips/cpu/mips32/start.S.
596
597 CONFIG_XWAY_SWAP_BYTES
598
599 Enable compilation of tools/xway-swap-bytes needed for Lantiq
600 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
601 be swapped if a flash programmer is used.
602
Christian Rieschb67d8812012-02-02 00:44:39 +0000603- ARM options:
604 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
605
606 Select high exception vectors of the ARM core, e.g., do not
607 clear the V bit of the c1 register of CP15.
608
Aneesh V5356f542012-03-08 07:20:19 +0000609 CONFIG_SYS_THUMB_BUILD
610
611 Use this flag to build U-Boot using the Thumb instruction
612 set for ARM architectures. Thumb instruction set provides
613 better code density. For ARM architectures that support
614 Thumb2 this flag will result in Thumb2 code generated by
615 GCC.
616
Stephen Warrenc5d47522013-03-04 13:29:40 +0000617 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000618 CONFIG_ARM_ERRATA_742230
619 CONFIG_ARM_ERRATA_743622
620 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500621 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500622 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000623
624 If set, the workarounds for these ARM errata are applied early
625 during U-Boot startup. Note that these options force the
626 workarounds to be applied; no CPU-type/version detection
627 exists, unlike the similar options in the Linux kernel. Do not
628 set these options unless they apply!
629
Simon Glass38687ae2014-11-10 17:16:54 -0700630- Driver Model
631 Driver model is a new framework for devices in U-Boot
632 introduced in early 2014. U-Boot is being progressively
633 moved over to this. It offers a consistent device structure,
634 supports grouping devices into classes and has built-in
635 handling of platform data and device tree.
636
637 To enable transition to driver model in a relatively
638 painful fashion, each subsystem can be independently
639 switched between the legacy/ad-hoc approach and the new
640 driver model using the options below. Also, many uclass
641 interfaces include compatibility features which may be
642 removed once the conversion of that subsystem is complete.
643 As a result, the API provided by the subsystem may in fact
644 not change with driver model.
645
646 See doc/driver-model/README.txt for more information.
647
648 CONFIG_DM
649
650 Enable driver model. This brings in the core support,
651 including scanning of platform data on start-up. If
652 CONFIG_OF_CONTROL is enabled, the device tree will be
653 scanned also when available.
654
655 CONFIG_CMD_DM
656
657 Enable driver model test commands. These allow you to print
658 out the driver model tree and the uclasses.
659
660 CONFIG_DM_DEMO
661
662 Enable some demo devices and the 'demo' command. These are
663 really only useful for playing around while trying to
664 understand driver model in sandbox.
665
666 CONFIG_SPL_DM
667
668 Enable driver model in SPL. You will need to provide a
669 suitable malloc() implementation. If you are not using the
670 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
671 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
672 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
673 In most cases driver model will only allocate a few uclasses
674 and devices in SPL, so 1KB should be enable. See
675 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
676 it.
677
678 CONFIG_DM_SERIAL
679
680 Enable driver model for serial. This replaces
681 drivers/serial/serial.c with the serial uclass, which
682 implements serial_putc() etc. The uclass interface is
683 defined in include/serial.h.
684
685 CONFIG_DM_GPIO
686
687 Enable driver model for GPIO access. The standard GPIO
688 interface (gpio_get_value(), etc.) is then implemented by
689 the GPIO uclass. Drivers provide methods to query the
690 particular GPIOs that they provide. The uclass interface
691 is defined in include/asm-generic/gpio.h.
692
693 CONFIG_DM_SPI
694
695 Enable driver model for SPI. The SPI slave interface
696 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
697 the SPI uclass. Drivers provide methods to access the SPI
698 buses that they control. The uclass interface is defined in
699 include/spi.h. The existing spi_slave structure is attached
700 as 'parent data' to every slave on each bus. Slaves
701 typically use driver-private data instead of extending the
702 spi_slave structure.
703
704 CONFIG_DM_SPI_FLASH
705
706 Enable driver model for SPI flash. This SPI flash interface
707 (spi_flash_probe(), spi_flash_write(), etc.) is then
708 implemented by the SPI flash uclass. There is one standard
709 SPI flash driver which knows how to probe most chips
710 supported by U-Boot. The uclass interface is defined in
711 include/spi_flash.h, but is currently fully compatible
712 with the old interface to avoid confusion and duplication
713 during the transition parent. SPI and SPI flash must be
714 enabled together (it is not possible to use driver model
715 for one and not the other).
716
717 CONFIG_DM_CROS_EC
718
719 Enable driver model for the Chrome OS EC interface. This
720 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
721 but otherwise makes few changes. Since cros_ec also supports
722 I2C and LPC (which don't support driver model yet), a full
723 conversion is not yet possible.
724
725
726 ** Code size options: The following options are enabled by
727 default except in SPL. Enable them explicitly to get these
728 features in SPL.
729
730 CONFIG_DM_WARN
731
732 Enable the dm_warn() function. This can use up quite a bit
733 of space for its strings.
734
735 CONFIG_DM_STDIO
736
737 Enable registering a serial device with the stdio library.
738
739 CONFIG_DM_DEVICE_REMOVE
740
741 Enable removing of devices.
742
743
wdenk5da627a2003-10-09 20:09:04 +0000744- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_CLOCKS_IN_MHZ
746
747 U-Boot stores all clock information in Hz
748 internally. For binary compatibility with older Linux
749 kernels (which expect the clocks passed in the
750 bd_info data to be in MHz) the environment variable
751 "clocks_in_mhz" can be defined so that U-Boot
752 converts clock data to MHZ before passing it to the
753 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000754 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100755 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000756 default environment.
757
wdenk5da627a2003-10-09 20:09:04 +0000758 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
759
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200760 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000761 expect it to be in bytes, others in MB.
762 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
763
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400764 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200765
766 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400767 passed using flattened device trees (based on open firmware
768 concepts).
769
770 CONFIG_OF_LIBFDT
771 * New libfdt-based support
772 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500773 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400774
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200775 OF_CPU - The proper name of the cpus node (only required for
776 MPC512X and MPC5xxx based boards).
777 OF_SOC - The proper name of the soc node (only required for
778 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200779 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600780 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200781
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200782 boards with QUICC Engines require OF_QE to set UCC MAC
783 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500784
Kumar Gala4e253132006-01-11 13:54:17 -0600785 CONFIG_OF_BOARD_SETUP
786
787 Board code has addition modification that it wants to make
788 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000789
Simon Glassc654b512014-10-23 18:58:54 -0600790 CONFIG_OF_SYSTEM_SETUP
791
792 Other code has addition modification that it wants to make
793 to the flat device tree before handing it off to the kernel.
794 This causes ft_system_setup() to be called before booting
795 the kernel.
796
Matthew McClintock02677682006-06-28 10:41:37 -0500797 CONFIG_OF_BOOT_CPU
798
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200799 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500800 param header, the default value is zero if undefined.
801
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200802 CONFIG_OF_IDE_FIXUP
803
804 U-Boot can detect if an IDE device is present or not.
805 If not, and this new config option is activated, U-Boot
806 removes the ATA node from the DTS before booting Linux,
807 so the Linux IDE driver does not probe the device and
808 crash. This is needed for buggy hardware (uc101) where
809 no pull down resistor is connected to the signal IDE5V_DD7.
810
Igor Grinberg7eb29392011-07-14 05:45:07 +0000811 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
812
813 This setting is mandatory for all boards that have only one
814 machine type and must be used to specify the machine type
815 number as it appears in the ARM machine registry
816 (see http://www.arm.linux.org.uk/developer/machines/).
817 Only boards that have multiple machine types supported
818 in a single configuration file and the machine type is
819 runtime discoverable, do not have to use this setting.
820
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100821- vxWorks boot parameters:
822
823 bootvx constructs a valid bootline using the following
824 environments variables: bootfile, ipaddr, serverip, hostname.
825 It loads the vxWorks image pointed bootfile.
826
827 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
828 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
829 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
830 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
831
832 CONFIG_SYS_VXWORKS_ADD_PARAMS
833
834 Add it at the end of the bootline. E.g "u=username pw=secret"
835
836 Note: If a "bootargs" environment is defined, it will overwride
837 the defaults discussed just above.
838
Aneesh V2c451f72011-06-16 23:30:47 +0000839- Cache Configuration:
840 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
841 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
842 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
843
Aneesh V93bc2192011-06-16 23:30:51 +0000844- Cache Configuration for ARM:
845 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
846 controller
847 CONFIG_SYS_PL310_BASE - Physical base address of PL310
848 controller register space
849
wdenk6705d812004-08-02 23:22:59 +0000850- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200851 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000852
853 Define this if you want support for Amba PrimeCell PL010 UARTs.
854
Andreas Engel48d01922008-09-08 14:30:53 +0200855 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000856
857 Define this if you want support for Amba PrimeCell PL011 UARTs.
858
859 CONFIG_PL011_CLOCK
860
861 If you have Amba PrimeCell PL011 UARTs, set this variable to
862 the clock speed of the UARTs.
863
864 CONFIG_PL01x_PORTS
865
866 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
867 define this to a list of base addresses for each (supported)
868 port. See e.g. include/configs/versatile.h
869
John Rigby910f1ae2011-04-19 10:42:39 +0000870 CONFIG_PL011_SERIAL_RLCR
871
872 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
873 have separate receive and transmit line control registers. Set
874 this variable to initialize the extra register.
875
876 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
877
878 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
879 boot loader that has already initialized the UART. Define this
880 variable to flush the UART at init time.
881
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400882 CONFIG_SERIAL_HW_FLOW_CONTROL
883
884 Define this variable to enable hw flow control in serial driver.
885 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000886
wdenkc6097192002-11-03 00:24:07 +0000887- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000888 Depending on board, define exactly one serial port
889 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
890 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
891 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000892
893 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
894 port routines must be defined elsewhere
895 (i.e. serial_init(), serial_getc(), ...)
896
897 CONFIG_CFB_CONSOLE
898 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000899 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000900 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
901 (default big endian)
902 VIDEO_HW_RECTFILL graphic chip supports
903 rectangle fill
904 (cf. smiLynxEM)
905 VIDEO_HW_BITBLT graphic chip supports
906 bit-blit (cf. smiLynxEM)
907 VIDEO_VISIBLE_COLS visible pixel columns
908 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000909 VIDEO_VISIBLE_ROWS visible pixel rows
910 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000911 VIDEO_DATA_FORMAT graphic data format
912 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000913 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000914 VIDEO_KBD_INIT_FCT keyboard int fct
915 (i.e. i8042_kbd_init())
916 VIDEO_TSTC_FCT test char fct
917 (i.e. i8042_tstc)
918 VIDEO_GETC_FCT get char fct
919 (i.e. i8042_getc)
920 CONFIG_CONSOLE_CURSOR cursor drawing on/off
921 (requires blink timer
922 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200923 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000924 CONFIG_CONSOLE_TIME display time/date info in
925 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500926 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000927 CONFIG_VIDEO_LOGO display Linux logo in
928 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000929 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
930 linux_logo.h for logo.
931 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000932 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200933 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000934 the logo
935
Pali Rohár33a35bb2012-10-19 13:30:09 +0000936 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
937 a limited number of ANSI escape sequences (cursor control,
938 erase functions and limited graphics rendition control).
939
wdenk43d96162003-03-06 00:02:04 +0000940 When CONFIG_CFB_CONSOLE is defined, video console is
941 default i/o. Serial console can be forced with
942 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000943
wdenkd4ca31c2004-01-02 14:00:00 +0000944 When CONFIG_SILENT_CONSOLE is defined, all console
945 messages (by U-Boot and Linux!) can be silenced with
946 the "silent" environment variable. See
947 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000948
Heiko Schocher45ae2542013-10-22 11:06:06 +0200949 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
950 is 0x00.
951 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
952 is 0xa0.
953
wdenkc6097192002-11-03 00:24:07 +0000954- Console Baudrate:
955 CONFIG_BAUDRATE - in bps
956 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200957 CONFIG_SYS_BAUDRATE_TABLE, see below.
958 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000959
Heiko Schocherc92fac92009-01-30 12:55:38 +0100960- Console Rx buffer length
961 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
962 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100963 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100964 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
965 must be defined, to setup the maximum idle timeout for
966 the SMC.
967
Graeme Russ9558b482011-09-01 00:48:27 +0000968- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200969 Prior to the console being initialised (i.e. serial UART
970 initialised etc) all console output is silently discarded.
971 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
972 buffer any console messages prior to the console being
973 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
974 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
975 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200976 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200977 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000978
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200979 'Sane' compilers will generate smaller code if
980 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000981
Sonny Rao046a37b2011-11-02 09:52:08 +0000982- Safe printf() functions
983 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
984 the printf() functions. These are defined in
985 include/vsprintf.h and include snprintf(), vsnprintf() and
986 so on. Code size increase is approximately 300-500 bytes.
987 If this option is not given then these functions will
988 silently discard their buffer size argument - this means
989 you are not getting any overflow checking in this case.
990
wdenkc6097192002-11-03 00:24:07 +0000991- Boot Delay: CONFIG_BOOTDELAY - in seconds
992 Delay before automatically booting the default image;
993 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000994 set to -2 to autoboot with no delay and not check for abort
995 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000996
997 See doc/README.autoboot for these options that
998 work with CONFIG_BOOTDELAY. None are required.
999 CONFIG_BOOT_RETRY_TIME
1000 CONFIG_BOOT_RETRY_MIN
1001 CONFIG_AUTOBOOT_KEYED
1002 CONFIG_AUTOBOOT_PROMPT
1003 CONFIG_AUTOBOOT_DELAY_STR
1004 CONFIG_AUTOBOOT_STOP_STR
1005 CONFIG_AUTOBOOT_DELAY_STR2
1006 CONFIG_AUTOBOOT_STOP_STR2
1007 CONFIG_ZERO_BOOTDELAY_CHECK
1008 CONFIG_RESET_TO_RETRY
1009
1010- Autoboot Command:
1011 CONFIG_BOOTCOMMAND
1012 Only needed when CONFIG_BOOTDELAY is enabled;
1013 define a command string that is automatically executed
1014 when no character is read on the console interface
1015 within "Boot Delay" after reset.
1016
1017 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +00001018 This can be used to pass arguments to the bootm
1019 command. The value of CONFIG_BOOTARGS goes into the
1020 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001021
1022 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +00001023 The value of these goes into the environment as
1024 "ramboot" and "nfsboot" respectively, and can be used
1025 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001026 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001027
Heiko Schochereda0ba32013-11-04 14:04:59 +01001028- Bootcount:
1029 CONFIG_BOOTCOUNT_LIMIT
1030 Implements a mechanism for detecting a repeating reboot
1031 cycle, see:
1032 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1033
1034 CONFIG_BOOTCOUNT_ENV
1035 If no softreset save registers are found on the hardware
1036 "bootcount" is stored in the environment. To prevent a
1037 saveenv on all reboots, the environment variable
1038 "upgrade_available" is used. If "upgrade_available" is
1039 0, "bootcount" is always 0, if "upgrade_available" is
1040 1 "bootcount" is incremented in the environment.
1041 So the Userspace Applikation must set the "upgrade_available"
1042 and "bootcount" variable to 0, if a boot was successfully.
1043
wdenkc6097192002-11-03 00:24:07 +00001044- Pre-Boot Commands:
1045 CONFIG_PREBOOT
1046
1047 When this option is #defined, the existence of the
1048 environment variable "preboot" will be checked
1049 immediately before starting the CONFIG_BOOTDELAY
1050 countdown and/or running the auto-boot command resp.
1051 entering interactive mode.
1052
1053 This feature is especially useful when "preboot" is
1054 automatically generated or modified. For an example
1055 see the LWMON board specific code: here "preboot" is
1056 modified when the user holds down a certain
1057 combination of keys on the (special) keyboard when
1058 booting the systems
1059
1060- Serial Download Echo Mode:
1061 CONFIG_LOADS_ECHO
1062 If defined to 1, all characters received during a
1063 serial download (using the "loads" command) are
1064 echoed back. This might be needed by some terminal
1065 emulations (like "cu"), but may as well just take
1066 time on others. This setting #define's the initial
1067 value of the "loads_echo" environment variable.
1068
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001070 CONFIG_KGDB_BAUDRATE
1071 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001073
1074- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001075 Monitor commands can be included or excluded
1076 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001077 <config_cmd_all.h> and #undef'ing unwanted
1078 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001079 and augmenting with additional #define's
1080 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001081
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001082 The default command configuration includes all commands
1083 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001084
Marek Vasutb401b732014-03-05 19:58:39 +01001085 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001086 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001087 CONFIG_CMD_BDI bdinfo
1088 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1089 CONFIG_CMD_BMP * BMP support
1090 CONFIG_CMD_BSP * Board specific commands
1091 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001092 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001093 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001094 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001095 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001096 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001097 CONFIG_CMD_DATE * support for RTC, date/time...
1098 CONFIG_CMD_DHCP * DHCP support
1099 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001100 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1101 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1102 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1103 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001104 CONFIG_CMD_DTT * Digital Therm and Thermostat
1105 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001106 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001107 CONFIG_CMD_EEPROM * EEPROM read/write support
1108 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001109 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001110 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001111 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001112 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001113 CONFIG_CMD_EXT2 * ext2 command support
1114 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001115 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1116 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001117 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001118 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001119 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001120 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001121 CONFIG_CMD_FLASH flinfo, erase, protect
1122 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001123 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001124 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001125 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001126 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001127 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001128 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1129 CONFIG_CMD_I2C * I2C serial bus support
1130 CONFIG_CMD_IDE * IDE harddisk support
1131 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001132 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001133 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001134 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001135 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001136 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001137 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001138 CONFIG_CMD_IRQ * irqinfo
1139 CONFIG_CMD_ITEST Integer/string test of 2 values
1140 CONFIG_CMD_JFFS2 * JFFS2 Support
1141 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001142 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001143 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1144 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001145 CONFIG_CMD_LOADB loadb
1146 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001147 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001148 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001149 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001150 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001151 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001152 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001153 CONFIG_CMD_MISC Misc functions like sleep etc
1154 CONFIG_CMD_MMC * MMC memory mapped support
1155 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001156 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001157 CONFIG_CMD_NAND * NAND support
1158 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001159 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001160 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001161 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001162 CONFIG_CMD_PCI * pciinfo
1163 CONFIG_CMD_PCMCIA * PCMCIA support
1164 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1165 host
1166 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001167 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001168 CONFIG_CMD_REGINFO * Register dump
1169 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001170 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001171 CONFIG_CMD_SAVES * save S record dump
1172 CONFIG_CMD_SCSI * SCSI Support
1173 CONFIG_CMD_SDRAM * print SDRAM configuration information
1174 (requires CONFIG_CMD_I2C)
1175 CONFIG_CMD_SETGETDCR Support for DCR Register access
1176 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001177 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001178 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001179 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001180 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001181 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001182 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001183 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001184 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001185 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1186 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001187 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001188 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001189 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001190 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001191 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001192
1193 EXAMPLE: If you want all functions except of network
1194 support you can write:
1195
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001196 #include "config_cmd_all.h"
1197 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001198
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001199 Other Commands:
1200 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001201
1202 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001203 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001204 what you (and your U-Boot users) are doing. Data
1205 cache cannot be enabled on systems like the 8xx or
1206 8260 (where accesses to the IMMR region must be
1207 uncached), and it cannot be disabled on all other
1208 systems where we (mis-) use the data cache to hold an
1209 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001210
1211
1212 XXX - this list needs to get updated!
1213
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001214- Regular expression support:
1215 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001216 If this variable is defined, U-Boot is linked against
1217 the SLRE (Super Light Regular Expression) library,
1218 which adds regex support to some commands, as for
1219 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001220
Simon Glass45ba8072011-10-15 05:48:20 +00001221- Device tree:
1222 CONFIG_OF_CONTROL
1223 If this variable is defined, U-Boot will use a device tree
1224 to configure its devices, instead of relying on statically
1225 compiled #defines in the board file. This option is
1226 experimental and only available on a few boards. The device
1227 tree is available in the global data as gd->fdt_blob.
1228
Simon Glass2c0f79e2011-10-24 19:15:31 +00001229 U-Boot needs to get its device tree from somewhere. This can
1230 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001231
1232 CONFIG_OF_EMBED
1233 If this variable is defined, U-Boot will embed a device tree
1234 binary in its image. This device tree file should be in the
1235 board directory and called <soc>-<board>.dts. The binary file
1236 is then picked up in board_init_f() and made available through
1237 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001238
Simon Glass2c0f79e2011-10-24 19:15:31 +00001239 CONFIG_OF_SEPARATE
1240 If this variable is defined, U-Boot will build a device tree
1241 binary. It will be called u-boot.dtb. Architecture-specific
1242 code will locate it at run-time. Generally this works by:
1243
1244 cat u-boot.bin u-boot.dtb >image.bin
1245
1246 and in fact, U-Boot does this for you, creating a file called
1247 u-boot-dtb.bin which is useful in the common case. You can
1248 still use the individual files if you need something more
1249 exotic.
1250
wdenkc6097192002-11-03 00:24:07 +00001251- Watchdog:
1252 CONFIG_WATCHDOG
1253 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001254 support for the SoC. There must be support in the SoC
1255 specific code for a watchdog. For the 8xx and 8260
1256 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1257 register. When supported for a specific SoC is
1258 available, then no further board specific code should
1259 be needed to use it.
1260
1261 CONFIG_HW_WATCHDOG
1262 When using a watchdog circuitry external to the used
1263 SoC, then define this variable and provide board
1264 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001265
stroesec1551ea2003-04-04 15:53:41 +00001266- U-Boot Version:
1267 CONFIG_VERSION_VARIABLE
1268 If this variable is defined, an environment variable
1269 named "ver" is created by U-Boot showing the U-Boot
1270 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001271 Any change to this variable will be reverted at the
1272 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001273
wdenkc6097192002-11-03 00:24:07 +00001274- Real-Time Clock:
1275
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001276 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001277 has to be selected, too. Define exactly one of the
1278 following options:
1279
1280 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1281 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001282 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001283 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001284 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001285 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001286 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001287 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001288 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001289 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001290 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001291 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001292 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1293 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkb37c7e52003-06-30 16:24:52 +00001295 Note that if the RTC uses I2C, then the I2C interface
1296 must also be configured. See I2C Support, below.
1297
Peter Tysere92739d2008-12-17 16:36:21 -06001298- GPIO Support:
1299 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001300
Chris Packham5dec49c2010-12-19 10:12:13 +00001301 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1302 chip-ngpio pairs that tell the PCA953X driver the number of
1303 pins supported by a particular chip.
1304
Peter Tysere92739d2008-12-17 16:36:21 -06001305 Note that if the GPIO device uses I2C, then the I2C interface
1306 must also be configured. See I2C Support, below.
1307
Simon Glassaa532332014-06-11 23:29:41 -06001308- I/O tracing:
1309 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1310 accesses and can checksum them or write a list of them out
1311 to memory. See the 'iotrace' command for details. This is
1312 useful for testing device drivers since it can confirm that
1313 the driver behaves the same way before and after a code
1314 change. Currently this is supported on sandbox and arm. To
1315 add support for your architecture, add '#include <iotrace.h>'
1316 to the bottom of arch/<arch>/include/asm/io.h and test.
1317
1318 Example output from the 'iotrace stats' command is below.
1319 Note that if the trace buffer is exhausted, the checksum will
1320 still continue to operate.
1321
1322 iotrace is enabled
1323 Start: 10000000 (buffer start address)
1324 Size: 00010000 (buffer size)
1325 Offset: 00000120 (current buffer offset)
1326 Output: 10000120 (start + offset)
1327 Count: 00000018 (number of trace records)
1328 CRC32: 9526fb66 (CRC32 of all trace records)
1329
wdenkc6097192002-11-03 00:24:07 +00001330- Timestamp Support:
1331
wdenk43d96162003-03-06 00:02:04 +00001332 When CONFIG_TIMESTAMP is selected, the timestamp
1333 (date and time) of an image is printed by image
1334 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001335 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001336
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001337- Partition Labels (disklabels) Supported:
1338 Zero or more of the following:
1339 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1340 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1341 Intel architecture, USB sticks, etc.
1342 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1343 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1344 bootloader. Note 2TB partition limit; see
1345 disk/part_efi.c
1346 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001347
Wolfgang Denk218ca722008-03-26 10:40:12 +01001348 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1349 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001350 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001351
1352- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001353 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1354 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001355
wdenk4d13cba2004-03-14 14:09:05 +00001356 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1357 be performed by calling the function
1358 ide_set_reset(int reset)
1359 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001360
1361- ATAPI Support:
1362 CONFIG_ATAPI
1363
1364 Set this to enable ATAPI support.
1365
wdenkc40b2952004-03-13 23:29:43 +00001366- LBA48 Support
1367 CONFIG_LBA48
1368
1369 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001370 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001371 Whithout these , LBA48 support uses 32bit variables and will 'only'
1372 support disks up to 2.1TB.
1373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001374 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001375 When enabled, makes the IDE subsystem use 64bit sector addresses.
1376 Default is 32bit.
1377
wdenkc6097192002-11-03 00:24:07 +00001378- SCSI Support:
1379 At the moment only there is only support for the
1380 SYM53C8XX SCSI controller; define
1381 CONFIG_SCSI_SYM53C8XX to enable it.
1382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001383 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1384 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1385 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001386 maximum numbers of LUNs, SCSI ID's and target
1387 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001388 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001389
Wolfgang Denk93e14592013-10-04 17:43:24 +02001390 The environment variable 'scsidevs' is set to the number of
1391 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001392
wdenkc6097192002-11-03 00:24:07 +00001393- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001394 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001395 Support for Intel 8254x/8257x gigabit chips.
1396
1397 CONFIG_E1000_SPI
1398 Utility code for direct access to the SPI bus on Intel 8257x.
1399 This does not do anything useful unless you set at least one
1400 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1401
1402 CONFIG_E1000_SPI_GENERIC
1403 Allow generic access to the SPI bus on the Intel 8257x, for
1404 example with the "sspi" command.
1405
1406 CONFIG_CMD_E1000
1407 Management command for E1000 devices. When used on devices
1408 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001409
Andre Schwarzac3315c2008-03-06 16:45:44 +01001410 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001411 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001412
wdenkc6097192002-11-03 00:24:07 +00001413 CONFIG_EEPRO100
1414 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001415 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001416 write routine for first time initialisation.
1417
1418 CONFIG_TULIP
1419 Support for Digital 2114x chips.
1420 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1421 modem chip initialisation (KS8761/QS6611).
1422
1423 CONFIG_NATSEMI
1424 Support for National dp83815 chips.
1425
1426 CONFIG_NS8382X
1427 Support for National dp8382[01] gigabit chips.
1428
wdenk45219c42003-05-12 21:50:16 +00001429- NETWORK Support (other):
1430
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001431 CONFIG_DRIVER_AT91EMAC
1432 Support for AT91RM9200 EMAC.
1433
1434 CONFIG_RMII
1435 Define this to use reduced MII inteface
1436
1437 CONFIG_DRIVER_AT91EMAC_QUIET
1438 If this defined, the driver is quiet.
1439 The driver doen't show link status messages.
1440
Rob Herringefdd7312011-12-15 11:15:49 +00001441 CONFIG_CALXEDA_XGMAC
1442 Support for the Calxeda XGMAC device
1443
Ashok3bb46d22012-10-15 06:20:47 +00001444 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001445 Support for SMSC's LAN91C96 chips.
1446
1447 CONFIG_LAN91C96_BASE
1448 Define this to hold the physical address
1449 of the LAN91C96's I/O space
1450
1451 CONFIG_LAN91C96_USE_32_BIT
1452 Define this to enable 32 bit addressing
1453
Ashok3bb46d22012-10-15 06:20:47 +00001454 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001455 Support for SMSC's LAN91C111 chip
1456
1457 CONFIG_SMC91111_BASE
1458 Define this to hold the physical address
1459 of the device (I/O space)
1460
1461 CONFIG_SMC_USE_32_BIT
1462 Define this if data bus is 32 bits
1463
1464 CONFIG_SMC_USE_IOFUNCS
1465 Define this to use i/o functions instead of macros
1466 (some hardware wont work with macros)
1467
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001468 CONFIG_DRIVER_TI_EMAC
1469 Support for davinci emac
1470
1471 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1472 Define this if you have more then 3 PHYs.
1473
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001474 CONFIG_FTGMAC100
1475 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1476
1477 CONFIG_FTGMAC100_EGIGA
1478 Define this to use GE link update with gigabit PHY.
1479 Define this if FTGMAC100 is connected to gigabit PHY.
1480 If your system has 10/100 PHY only, it might not occur
1481 wrong behavior. Because PHY usually return timeout or
1482 useless data when polling gigabit status and gigabit
1483 control registers. This behavior won't affect the
1484 correctnessof 10/100 link speed update.
1485
Mike Rapoportc2fff332009-11-11 10:03:03 +02001486 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001487 Support for SMSC's LAN911x and LAN921x chips
1488
Mike Rapoportc2fff332009-11-11 10:03:03 +02001489 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001490 Define this to hold the physical address
1491 of the device (I/O space)
1492
Mike Rapoportc2fff332009-11-11 10:03:03 +02001493 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001494 Define this if data bus is 32 bits
1495
Mike Rapoportc2fff332009-11-11 10:03:03 +02001496 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001497 Define this if data bus is 16 bits. If your processor
1498 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001499 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001500
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001501 CONFIG_SH_ETHER
1502 Support for Renesas on-chip Ethernet controller
1503
1504 CONFIG_SH_ETHER_USE_PORT
1505 Define the number of ports to be used
1506
1507 CONFIG_SH_ETHER_PHY_ADDR
1508 Define the ETH PHY's address
1509
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001510 CONFIG_SH_ETHER_CACHE_WRITEBACK
1511 If this option is set, the driver enables cache flush.
1512
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001513- PWM Support:
1514 CONFIG_PWM_IMX
1515 Support for PWM modul on the imx6.
1516
Vadim Bendebury5e124722011-10-17 08:36:14 +00001517- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001518 CONFIG_TPM
1519 Support TPM devices.
1520
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001521 CONFIG_TPM_TIS_I2C
1522 Support for i2c bus TPM devices. Only one device
1523 per system is supported at this time.
1524
1525 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1526 Define the the i2c bus number for the TPM device
1527
1528 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1529 Define the TPM's address on the i2c bus
1530
1531 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1532 Define the burst count bytes upper limit
1533
Dirk Eibachc01939c2013-06-26 15:55:15 +02001534 CONFIG_TPM_ATMEL_TWI
1535 Support for Atmel TWI TPM device. Requires I2C support.
1536
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001537 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001538 Support for generic parallel port TPM devices. Only one device
1539 per system is supported at this time.
1540
1541 CONFIG_TPM_TIS_BASE_ADDRESS
1542 Base address where the generic TPM device is mapped
1543 to. Contemporary x86 systems usually map it at
1544 0xfed40000.
1545
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001546 CONFIG_CMD_TPM
1547 Add tpm monitor functions.
1548 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1549 provides monitor access to authorized functions.
1550
1551 CONFIG_TPM
1552 Define this to enable the TPM support library which provides
1553 functional interfaces to some TPM commands.
1554 Requires support for a TPM device.
1555
1556 CONFIG_TPM_AUTH_SESSIONS
1557 Define this to enable authorized functions in the TPM library.
1558 Requires CONFIG_TPM and CONFIG_SHA1.
1559
wdenkc6097192002-11-03 00:24:07 +00001560- USB Support:
1561 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001562 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001563 CONFIG_USB_UHCI to enable it.
1564 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001565 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001566 storage devices.
1567 Note:
1568 Supported are USB Keyboards and USB Floppy drives
1569 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001570 MPC5200 USB requires additional defines:
1571 CONFIG_USB_CLOCK
1572 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001573 CONFIG_PSC3_USB
1574 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001575 CONFIG_USB_CONFIG
1576 for differential drivers: 0x00001000
1577 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001578 for differential drivers on PSC3: 0x00000100
1579 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001580 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001581 May be defined to allow interrupt polling
1582 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001583
Simon Glass9ab4ce22012-02-27 10:52:47 +00001584 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1585 txfilltuning field in the EHCI controller on reset.
1586
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001587 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1588 HW module registers.
1589
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001590- USB Device:
1591 Define the below if you wish to use the USB console.
1592 Once firmware is rebuilt from a serial console issue the
1593 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001594 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001595 it has found a new device. The environment variable usbtty
1596 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001597 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001598 Common Device Class Abstract Control Model serial device.
1599 If you select usbtty = gserial you should be able to enumerate
1600 a Linux host by
1601 # modprobe usbserial vendor=0xVendorID product=0xProductID
1602 else if using cdc_acm, simply setting the environment
1603 variable usbtty to be cdc_acm should suffice. The following
1604 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001605
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001606 CONFIG_USB_DEVICE
1607 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001608
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001609 CONFIG_USB_TTY
1610 Define this to have a tty type of device available to
1611 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001612
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301613 CONFIG_USBD_HS
1614 Define this to enable the high speed support for usb
1615 device and usbtty. If this feature is enabled, a routine
1616 int is_usbd_high_speed(void)
1617 also needs to be defined by the driver to dynamically poll
1618 whether the enumeration has succeded at high speed or full
1619 speed.
1620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001621 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001622 Define this if you want stdin, stdout &/or stderr to
1623 be set to usbtty.
1624
1625 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001627 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001628 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001630 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001631 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001632 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001633
Wolfgang Denk386eda02006-06-14 18:14:56 +02001634 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001635 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001636 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001637 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1638 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1639 should pretend to be a Linux device to it's target host.
1640
1641 CONFIG_USBD_MANUFACTURER
1642 Define this string as the name of your company for
1643 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001644
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001645 CONFIG_USBD_PRODUCT_NAME
1646 Define this string as the name of your product
1647 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1648
1649 CONFIG_USBD_VENDORID
1650 Define this as your assigned Vendor ID from the USB
1651 Implementors Forum. This *must* be a genuine Vendor ID
1652 to avoid polluting the USB namespace.
1653 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001654
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001655 CONFIG_USBD_PRODUCTID
1656 Define this as the unique Product ID
1657 for your device
1658 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001659
Igor Grinbergd70a5602011-12-12 12:08:35 +02001660- ULPI Layer Support:
1661 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1662 the generic ULPI layer. The generic layer accesses the ULPI PHY
1663 via the platform viewport, so you need both the genric layer and
1664 the viewport enabled. Currently only Chipidea/ARC based
1665 viewport is supported.
1666 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1667 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001668 If your ULPI phy needs a different reference clock than the
1669 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1670 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001671
1672- MMC Support:
1673 The MMC controller on the Intel PXA is supported. To
1674 enable this define CONFIG_MMC. The MMC can be
1675 accessed from the boot prompt by mapping the device
1676 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001677 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1678 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001679
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001680 CONFIG_SH_MMCIF
1681 Support for Renesas on-chip MMCIF controller
1682
1683 CONFIG_SH_MMCIF_ADDR
1684 Define the base address of MMCIF registers
1685
1686 CONFIG_SH_MMCIF_CLK
1687 Define the clock frequency for MMCIF
1688
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001689 CONFIG_GENERIC_MMC
1690 Enable the generic MMC driver
1691
1692 CONFIG_SUPPORT_EMMC_BOOT
1693 Enable some additional features of the eMMC boot partitions.
1694
1695 CONFIG_SUPPORT_EMMC_RPMB
1696 Enable the commands for reading, writing and programming the
1697 key for the Replay Protection Memory Block partition in eMMC.
1698
Tom Rinib3ba6e92013-03-14 05:32:47 +00001699- USB Device Firmware Update (DFU) class support:
1700 CONFIG_DFU_FUNCTION
1701 This enables the USB portion of the DFU USB class
1702
1703 CONFIG_CMD_DFU
1704 This enables the command "dfu" which is used to have
1705 U-Boot create a DFU class device via USB. This command
1706 requires that the "dfu_alt_info" environment variable be
1707 set and define the alt settings to expose to the host.
1708
1709 CONFIG_DFU_MMC
1710 This enables support for exposing (e)MMC devices via DFU.
1711
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001712 CONFIG_DFU_NAND
1713 This enables support for exposing NAND devices via DFU.
1714
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301715 CONFIG_DFU_RAM
1716 This enables support for exposing RAM via DFU.
1717 Note: DFU spec refer to non-volatile memory usage, but
1718 allow usages beyond the scope of spec - here RAM usage,
1719 one that would help mostly the developer.
1720
Heiko Schochere7e75c72013-06-12 06:05:51 +02001721 CONFIG_SYS_DFU_DATA_BUF_SIZE
1722 Dfu transfer uses a buffer before writing data to the
1723 raw storage device. Make the size (in bytes) of this buffer
1724 configurable. The size of this buffer is also configurable
1725 through the "dfu_bufsiz" environment variable.
1726
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001727 CONFIG_SYS_DFU_MAX_FILE_SIZE
1728 When updating files rather than the raw storage device,
1729 we use a static buffer to copy the file into and then write
1730 the buffer once we've been given the whole file. Define
1731 this to the maximum filesize (in bytes) for the buffer.
1732 Default is 4 MiB if undefined.
1733
Heiko Schocher001a8312014-03-18 08:09:56 +01001734 DFU_DEFAULT_POLL_TIMEOUT
1735 Poll timeout [ms], is the timeout a device can send to the
1736 host. The host must wait for this timeout before sending
1737 a subsequent DFU_GET_STATUS request to the device.
1738
1739 DFU_MANIFEST_POLL_TIMEOUT
1740 Poll timeout [ms], which the device sends to the host when
1741 entering dfuMANIFEST state. Host waits this timeout, before
1742 sending again an USB request to the device.
1743
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001744- USB Device Android Fastboot support:
1745 CONFIG_CMD_FASTBOOT
1746 This enables the command "fastboot" which enables the Android
1747 fastboot mode for the platform's USB device. Fastboot is a USB
1748 protocol for downloading images, flashing and device control
1749 used on Android devices.
1750 See doc/README.android-fastboot for more information.
1751
1752 CONFIG_ANDROID_BOOT_IMAGE
1753 This enables support for booting images which use the Android
1754 image format header.
1755
1756 CONFIG_USB_FASTBOOT_BUF_ADDR
1757 The fastboot protocol requires a large memory buffer for
1758 downloads. Define this to the starting RAM address to use for
1759 downloaded images.
1760
1761 CONFIG_USB_FASTBOOT_BUF_SIZE
1762 The fastboot protocol requires a large memory buffer for
1763 downloads. This buffer should be as large as possible for a
1764 platform. Define this to the size available RAM for fastboot.
1765
Steve Raed1b5ed02014-08-26 11:47:28 -07001766 CONFIG_FASTBOOT_FLASH
1767 The fastboot protocol includes a "flash" command for writing
1768 the downloaded image to a non-volatile storage device. Define
1769 this to enable the "fastboot flash" command.
1770
1771 CONFIG_FASTBOOT_FLASH_MMC_DEV
1772 The fastboot "flash" command requires additional information
1773 regarding the non-volatile storage device. Define this to
1774 the eMMC device that fastboot should use to store the image.
1775
Steve Rae0ff7e582014-12-12 15:51:54 -08001776 CONFIG_FASTBOOT_GPT_NAME
1777 The fastboot "flash" command supports writing the downloaded
1778 image to the Protective MBR and the Primary GUID Partition
1779 Table. (Additionally, this downloaded image is post-processed
1780 to generate and write the Backup GUID Partition Table.)
1781 This occurs when the specified "partition name" on the
1782 "fastboot flash" command line matches this value.
1783 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1784
wdenk6705d812004-08-02 23:22:59 +00001785- Journaling Flash filesystem support:
1786 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1787 CONFIG_JFFS2_NAND_DEV
1788 Define these for a default partition on a NAND device
1789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001790 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1791 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001792 Define these for a default partition on a NOR device
1793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001794 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001795 Define this to create an own partition. You have to provide a
1796 function struct part_info* jffs2_part_info(int part_num)
1797
1798 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001799 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001800 to disable the command chpart. This is the default when you
1801 have not defined a custom partition
1802
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001803- FAT(File Allocation Table) filesystem write function support:
1804 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001805
1806 Define this to enable support for saving memory data as a
1807 file in FAT formatted partition.
1808
1809 This will also enable the command "fatwrite" enabling the
1810 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001811
Gabe Black84cd9322012-10-12 14:26:11 +00001812CBFS (Coreboot Filesystem) support
1813 CONFIG_CMD_CBFS
1814
1815 Define this to enable support for reading from a Coreboot
1816 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1817 and cbfsload.
1818
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301819- FAT(File Allocation Table) filesystem cluster size:
1820 CONFIG_FS_FAT_MAX_CLUSTSIZE
1821
1822 Define the max cluster size for fat operations else
1823 a default value of 65536 will be defined.
1824
wdenkc6097192002-11-03 00:24:07 +00001825- Keyboard Support:
1826 CONFIG_ISA_KEYBOARD
1827
1828 Define this to enable standard (PC-Style) keyboard
1829 support
1830
1831 CONFIG_I8042_KBD
1832 Standard PC keyboard driver with US (is default) and
1833 GERMAN key layout (switch via environment 'keymap=de') support.
1834 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1835 for cfb_console. Supports cursor blinking.
1836
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001837 CONFIG_CROS_EC_KEYB
1838 Enables a Chrome OS keyboard using the CROS_EC interface.
1839 This uses CROS_EC to communicate with a second microcontroller
1840 which provides key scans on request.
1841
wdenkc6097192002-11-03 00:24:07 +00001842- Video support:
1843 CONFIG_VIDEO
1844
1845 Define this to enable video support (for output to
1846 video).
1847
1848 CONFIG_VIDEO_CT69000
1849
1850 Enable Chips & Technologies 69000 Video chip
1851
1852 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001853 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001854 video output is selected via environment 'videoout'
1855 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1856 assumed.
wdenkc6097192002-11-03 00:24:07 +00001857
wdenkb79a11c2004-03-25 15:14:43 +00001858 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001859 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001860 are possible:
1861 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001862 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001863
1864 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1865 -------------+---------------------------------------------
1866 8 bits | 0x301* 0x303 0x305 0x161 0x307
1867 15 bits | 0x310 0x313 0x316 0x162 0x319
1868 16 bits | 0x311 0x314 0x317 0x163 0x31A
1869 24 bits | 0x312 0x315 0x318 ? 0x31B
1870 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001871 (i.e. setenv videomode 317; saveenv; reset;)
1872
wdenkb79a11c2004-03-25 15:14:43 +00001873 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001874 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001875
1876
stroesec1551ea2003-04-04 15:53:41 +00001877 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001878 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001879 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1880 or CONFIG_VIDEO_SED13806_16BPP
1881
Timur Tabi7d3053f2011-02-15 17:09:19 -06001882 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001883 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001884 SOCs that have a DIU should define this macro to enable DIU
1885 support, and should also define these other macros:
1886
1887 CONFIG_SYS_DIU_ADDR
1888 CONFIG_VIDEO
1889 CONFIG_CMD_BMP
1890 CONFIG_CFB_CONSOLE
1891 CONFIG_VIDEO_SW_CURSOR
1892 CONFIG_VGA_AS_SINGLE_DEVICE
1893 CONFIG_VIDEO_LOGO
1894 CONFIG_VIDEO_BMP_LOGO
1895
Timur Tabiba8e76b2011-04-11 14:18:22 -05001896 The DIU driver will look for the 'video-mode' environment
1897 variable, and if defined, enable the DIU as a console during
1898 boot. See the documentation file README.video for a
1899 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001900
Simon Glass058d59b2012-12-03 13:59:47 +00001901 CONFIG_VIDEO_VGA
1902
1903 Enable the VGA video / BIOS for x86. The alternative if you
1904 are using coreboot is to use the coreboot frame buffer
1905 driver.
1906
1907
wdenk682011f2003-06-03 23:54:09 +00001908- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001909 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001910
wdenk8bde7f72003-06-27 21:31:46 +00001911 Define this to enable a custom keyboard support.
1912 This simply calls drv_keyboard_init() which must be
1913 defined in your board-specific files.
1914 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001915
wdenkc6097192002-11-03 00:24:07 +00001916- LCD Support: CONFIG_LCD
1917
1918 Define this to enable LCD support (for output to LCD
1919 display); also select one of the supported displays
1920 by defining one of these:
1921
Stelian Pop39cf4802008-05-09 21:57:18 +02001922 CONFIG_ATMEL_LCD:
1923
1924 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1925
wdenkfd3103b2003-11-25 16:55:19 +00001926 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001927
wdenkfd3103b2003-11-25 16:55:19 +00001928 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001929
wdenkfd3103b2003-11-25 16:55:19 +00001930 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001931
wdenkfd3103b2003-11-25 16:55:19 +00001932 NEC NL6448BC20-08. 6.5", 640x480.
1933 Active, color, single scan.
1934
1935 CONFIG_NEC_NL6448BC33_54
1936
1937 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001938 Active, color, single scan.
1939
1940 CONFIG_SHARP_16x9
1941
1942 Sharp 320x240. Active, color, single scan.
1943 It isn't 16x9, and I am not sure what it is.
1944
1945 CONFIG_SHARP_LQ64D341
1946
1947 Sharp LQ64D341 display, 640x480.
1948 Active, color, single scan.
1949
1950 CONFIG_HLD1045
1951
1952 HLD1045 display, 640x480.
1953 Active, color, single scan.
1954
1955 CONFIG_OPTREX_BW
1956
1957 Optrex CBL50840-2 NF-FW 99 22 M5
1958 or
1959 Hitachi LMG6912RPFC-00T
1960 or
1961 Hitachi SP14Q002
1962
1963 320x240. Black & white.
1964
1965 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001966 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001967
Simon Glass676d3192012-10-17 13:24:54 +00001968 CONFIG_LCD_ALIGNMENT
1969
1970 Normally the LCD is page-aligned (tyically 4KB). If this is
1971 defined then the LCD will be aligned to this value instead.
1972 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1973 here, since it is cheaper to change data cache settings on
1974 a per-section basis.
1975
Simon Glass0d89efe2012-10-17 13:24:59 +00001976 CONFIG_CONSOLE_SCROLL_LINES
1977
1978 When the console need to be scrolled, this is the number of
1979 lines to scroll by. It defaults to 1. Increasing this makes
1980 the console jump but can help speed up operation when scrolling
1981 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001982
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001983 CONFIG_LCD_BMP_RLE8
1984
1985 Support drawing of RLE8-compressed bitmaps on the LCD.
1986
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001987 CONFIG_I2C_EDID
1988
1989 Enables an 'i2c edid' command which can read EDID
1990 information over I2C from an attached LCD display.
1991
wdenk7152b1d2003-09-05 23:19:14 +00001992- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001993
wdenk8bde7f72003-06-27 21:31:46 +00001994 If this option is set, the environment is checked for
1995 a variable "splashimage". If found, the usual display
1996 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001997 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001998 specified in "splashimage" is loaded instead. The
1999 console is redirected to the "nulldev", too. This
2000 allows for a "silent" boot where a splash screen is
2001 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00002002
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002003 CONFIG_SPLASHIMAGE_GUARD
2004
2005 If this option is set, then U-Boot will prevent the environment
2006 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05002007 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002008 This option is useful for targets where, due to alignment
2009 restrictions, an improperly aligned BMP image will cause a data
2010 abort. If you think you will not have problems with unaligned
2011 accesses (for example because your toolchain prevents them)
2012 there is no need to set this option.
2013
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002014 CONFIG_SPLASH_SCREEN_ALIGN
2015
2016 If this option is set the splash image can be freely positioned
2017 on the screen. Environment variable "splashpos" specifies the
2018 position as "x,y". If a positive number is given it is used as
2019 number of pixel from left/top. If a negative number is given it
2020 is used as number of pixel from right/bottom. You can also
2021 specify 'm' for centering the image.
2022
2023 Example:
2024 setenv splashpos m,m
2025 => image at center of screen
2026
2027 setenv splashpos 30,20
2028 => image at x = 30 and y = 20
2029
2030 setenv splashpos -10,m
2031 => vertically centered image
2032 at x = dspWidth - bmpWidth - 9
2033
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002034- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2035
2036 If this option is set, additionally to standard BMP
2037 images, gzipped BMP images can be displayed via the
2038 splashscreen support or the bmp command.
2039
Anatolij Gustschind5011762010-03-15 14:50:25 +01002040- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2041
2042 If this option is set, 8-bit RLE compressed BMP images
2043 can be displayed via the splashscreen support or the
2044 bmp command.
2045
Lei Wenf2b96df2012-09-28 04:26:47 +00002046- Do compresssing for memory range:
2047 CONFIG_CMD_ZIP
2048
2049 If this option is set, it would use zlib deflate method
2050 to compress the specified memory at its best effort.
2051
wdenkc29fdfc2003-08-29 20:57:53 +00002052- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002053 CONFIG_GZIP
2054
2055 Enabled by default to support gzip compressed images.
2056
wdenkc29fdfc2003-08-29 20:57:53 +00002057 CONFIG_BZIP2
2058
2059 If this option is set, support for bzip2 compressed
2060 images is included. If not, only uncompressed and gzip
2061 compressed images are supported.
2062
wdenk42d1f032003-10-15 23:53:47 +00002063 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002064 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002065 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002066
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002067 CONFIG_LZMA
2068
2069 If this option is set, support for lzma compressed
2070 images is included.
2071
2072 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2073 requires an amount of dynamic memory that is given by the
2074 formula:
2075
2076 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2077
2078 Where lc and lp stand for, respectively, Literal context bits
2079 and Literal pos bits.
2080
2081 This value is upper-bounded by 14MB in the worst case. Anyway,
2082 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2083 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2084 a very small buffer.
2085
2086 Use the lzmainfo tool to determinate the lc and lp values and
2087 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002088 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002089
Kees Cook8ef70472013-08-16 07:59:12 -07002090 CONFIG_LZO
2091
2092 If this option is set, support for LZO compressed images
2093 is included.
2094
wdenk17ea1172004-06-06 21:51:03 +00002095- MII/PHY support:
2096 CONFIG_PHY_ADDR
2097
2098 The address of PHY on MII bus.
2099
2100 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2101
2102 The clock frequency of the MII bus
2103
2104 CONFIG_PHY_GIGE
2105
2106 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002107 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002108
2109 CONFIG_PHY_RESET_DELAY
2110
2111 Some PHY like Intel LXT971A need extra delay after
2112 reset before any MII register access is possible.
2113 For such PHY, set this option to the usec delay
2114 required. (minimum 300usec for LXT971A)
2115
2116 CONFIG_PHY_CMD_DELAY (ppc4xx)
2117
2118 Some PHY like Intel LXT971A need extra delay after
2119 command issued before MII status register can be read
2120
wdenkc6097192002-11-03 00:24:07 +00002121- Ethernet address:
2122 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002123 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002124 CONFIG_ETH2ADDR
2125 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002126 CONFIG_ETH4ADDR
2127 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002128
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002129 Define a default value for Ethernet address to use
2130 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002131 is not determined automatically.
2132
2133- IP address:
2134 CONFIG_IPADDR
2135
2136 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002137 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002138 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002139 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002140
2141- Server IP address:
2142 CONFIG_SERVERIP
2143
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002145 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002146 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002147
Robin Getz97cfe862009-07-21 12:15:28 -04002148 CONFIG_KEEP_SERVERADDR
2149
2150 Keeps the server's MAC address, in the env 'serveraddr'
2151 for passing to bootargs (like Linux's netconsole option)
2152
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002153- Gateway IP address:
2154 CONFIG_GATEWAYIP
2155
2156 Defines a default value for the IP address of the
2157 default router where packets to other networks are
2158 sent to.
2159 (Environment variable "gatewayip")
2160
2161- Subnet mask:
2162 CONFIG_NETMASK
2163
2164 Defines a default value for the subnet mask (or
2165 routing prefix) which is used to determine if an IP
2166 address belongs to the local subnet or needs to be
2167 forwarded through a router.
2168 (Environment variable "netmask")
2169
David Updegraff53a5c422007-06-11 10:41:07 -05002170- Multicast TFTP Mode:
2171 CONFIG_MCAST_TFTP
2172
2173 Defines whether you want to support multicast TFTP as per
2174 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002175 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002176 driver in use must provide a function: mcast() to join/leave a
2177 multicast group.
2178
wdenkc6097192002-11-03 00:24:07 +00002179- BOOTP Recovery Mode:
2180 CONFIG_BOOTP_RANDOM_DELAY
2181
2182 If you have many targets in a network that try to
2183 boot using BOOTP, you may want to avoid that all
2184 systems send out BOOTP requests at precisely the same
2185 moment (which would happen for instance at recovery
2186 from a power failure, when all systems will try to
2187 boot, thus flooding the BOOTP server. Defining
2188 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2189 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002190 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002191
2192 1st BOOTP request: delay 0 ... 1 sec
2193 2nd BOOTP request: delay 0 ... 2 sec
2194 3rd BOOTP request: delay 0 ... 4 sec
2195 4th and following
2196 BOOTP requests: delay 0 ... 8 sec
2197
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002198 CONFIG_BOOTP_ID_CACHE_SIZE
2199
2200 BOOTP packets are uniquely identified using a 32-bit ID. The
2201 server will copy the ID from client requests to responses and
2202 U-Boot will use this to determine if it is the destination of
2203 an incoming response. Some servers will check that addresses
2204 aren't in use before handing them out (usually using an ARP
2205 ping) and therefore take up to a few hundred milliseconds to
2206 respond. Network congestion may also influence the time it
2207 takes for a response to make it back to the client. If that
2208 time is too long, U-Boot will retransmit requests. In order
2209 to allow earlier responses to still be accepted after these
2210 retransmissions, U-Boot's BOOTP client keeps a small cache of
2211 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2212 cache. The default is to keep IDs for up to four outstanding
2213 requests. Increasing this will allow U-Boot to accept offers
2214 from a BOOTP client in networks with unusually high latency.
2215
stroesefe389a82003-08-28 14:17:32 +00002216- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002217 You can fine tune the DHCP functionality by defining
2218 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002219
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002220 CONFIG_BOOTP_SUBNETMASK
2221 CONFIG_BOOTP_GATEWAY
2222 CONFIG_BOOTP_HOSTNAME
2223 CONFIG_BOOTP_NISDOMAIN
2224 CONFIG_BOOTP_BOOTPATH
2225 CONFIG_BOOTP_BOOTFILESIZE
2226 CONFIG_BOOTP_DNS
2227 CONFIG_BOOTP_DNS2
2228 CONFIG_BOOTP_SEND_HOSTNAME
2229 CONFIG_BOOTP_NTPSERVER
2230 CONFIG_BOOTP_TIMEOFFSET
2231 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002232 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002233
Wilson Callan5d110f02007-07-28 10:56:13 -04002234 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2235 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002236
Joe Hershberger2c00e092012-05-23 07:59:19 +00002237 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2238 after the configured retry count, the call will fail
2239 instead of starting over. This can be used to fail over
2240 to Link-local IP address configuration if the DHCP server
2241 is not available.
2242
stroesefe389a82003-08-28 14:17:32 +00002243 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2244 serverip from a DHCP server, it is possible that more
2245 than one DNS serverip is offered to the client.
2246 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2247 serverip will be stored in the additional environment
2248 variable "dnsip2". The first DNS serverip is always
2249 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002250 is defined.
stroesefe389a82003-08-28 14:17:32 +00002251
2252 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2253 to do a dynamic update of a DNS server. To do this, they
2254 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002255 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002256 of the "hostname" environment variable is passed as
2257 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002258
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002259 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2260
2261 A 32bit value in microseconds for a delay between
2262 receiving a "DHCP Offer" and sending the "DHCP Request".
2263 This fixes a problem with certain DHCP servers that don't
2264 respond 100% of the time to a "DHCP request". E.g. On an
2265 AT91RM9200 processor running at 180MHz, this delay needed
2266 to be *at least* 15,000 usec before a Windows Server 2003
2267 DHCP server would reply 100% of the time. I recommend at
2268 least 50,000 usec to be safe. The alternative is to hope
2269 that one of the retries will be successful but note that
2270 the DHCP timeout and retry process takes a longer than
2271 this delay.
2272
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002273 - Link-local IP address negotiation:
2274 Negotiate with other link-local clients on the local network
2275 for an address that doesn't require explicit configuration.
2276 This is especially useful if a DHCP server cannot be guaranteed
2277 to exist in all environments that the device must operate.
2278
2279 See doc/README.link-local for more information.
2280
wdenka3d991b2004-04-15 21:48:45 +00002281 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002282 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002283
2284 The device id used in CDP trigger frames.
2285
2286 CONFIG_CDP_DEVICE_ID_PREFIX
2287
2288 A two character string which is prefixed to the MAC address
2289 of the device.
2290
2291 CONFIG_CDP_PORT_ID
2292
2293 A printf format string which contains the ascii name of
2294 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002295 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002296
2297 CONFIG_CDP_CAPABILITIES
2298
2299 A 32bit integer which indicates the device capabilities;
2300 0x00000010 for a normal host which does not forwards.
2301
2302 CONFIG_CDP_VERSION
2303
2304 An ascii string containing the version of the software.
2305
2306 CONFIG_CDP_PLATFORM
2307
2308 An ascii string containing the name of the platform.
2309
2310 CONFIG_CDP_TRIGGER
2311
2312 A 32bit integer sent on the trigger.
2313
2314 CONFIG_CDP_POWER_CONSUMPTION
2315
2316 A 16bit integer containing the power consumption of the
2317 device in .1 of milliwatts.
2318
2319 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2320
2321 A byte containing the id of the VLAN.
2322
wdenkc6097192002-11-03 00:24:07 +00002323- Status LED: CONFIG_STATUS_LED
2324
2325 Several configurations allow to display the current
2326 status using a LED. For instance, the LED will blink
2327 fast while running U-Boot code, stop blinking as
2328 soon as a reply to a BOOTP request was received, and
2329 start blinking slow once the Linux kernel is running
2330 (supported by a status LED driver in the Linux
2331 kernel). Defining CONFIG_STATUS_LED enables this
2332 feature in U-Boot.
2333
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002334 Additional options:
2335
2336 CONFIG_GPIO_LED
2337 The status LED can be connected to a GPIO pin.
2338 In such cases, the gpio_led driver can be used as a
2339 status LED backend implementation. Define CONFIG_GPIO_LED
2340 to include the gpio_led driver in the U-Boot binary.
2341
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002342 CONFIG_GPIO_LED_INVERTED_TABLE
2343 Some GPIO connected LEDs may have inverted polarity in which
2344 case the GPIO high value corresponds to LED off state and
2345 GPIO low value corresponds to LED on state.
2346 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2347 with a list of GPIO LEDs that have inverted polarity.
2348
wdenkc6097192002-11-03 00:24:07 +00002349- CAN Support: CONFIG_CAN_DRIVER
2350
2351 Defining CONFIG_CAN_DRIVER enables CAN driver support
2352 on those systems that support this (optional)
2353 feature, like the TQM8xxL modules.
2354
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002355- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002356
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002357 This enable the NEW i2c subsystem, and will allow you to use
2358 i2c commands at the u-boot command line (as long as you set
2359 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2360 based realtime clock chips or other i2c devices. See
2361 common/cmd_i2c.c for a description of the command line
2362 interface.
2363
2364 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002365 - drivers/i2c/soft_i2c.c:
2366 - activate first bus with CONFIG_SYS_I2C_SOFT define
2367 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2368 for defining speed and slave address
2369 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2370 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2371 for defining speed and slave address
2372 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2373 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2374 for defining speed and slave address
2375 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2376 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2377 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002378
Heiko Schocher00f792e2012-10-24 13:48:22 +02002379 - drivers/i2c/fsl_i2c.c:
2380 - activate i2c driver with CONFIG_SYS_I2C_FSL
2381 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2382 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2383 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2384 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002385 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002386 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2387 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2388 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2389 second bus.
2390
Simon Glass1f2ba722012-10-30 07:28:53 +00002391 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002392 - activate this driver with CONFIG_SYS_I2C_TEGRA
2393 - This driver adds 4 i2c buses with a fix speed from
2394 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002395
Dirk Eibach880540d2013-04-25 02:40:01 +00002396 - drivers/i2c/ppc4xx_i2c.c
2397 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2398 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2399 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2400
tremfac96402013-09-21 18:13:35 +02002401 - drivers/i2c/i2c_mxc.c
2402 - activate this driver with CONFIG_SYS_I2C_MXC
2403 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2404 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2405 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2406 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2407 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2408 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2409 If thoses defines are not set, default value is 100000
2410 for speed, and 0 for slave.
2411
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002412 - drivers/i2c/rcar_i2c.c:
2413 - activate this driver with CONFIG_SYS_I2C_RCAR
2414 - This driver adds 4 i2c buses
2415
2416 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2417 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2418 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2419 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2420 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2421 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2422 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2423 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2424 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2425
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002426 - drivers/i2c/sh_i2c.c:
2427 - activate this driver with CONFIG_SYS_I2C_SH
2428 - This driver adds from 2 to 5 i2c buses
2429
2430 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2431 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2432 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2433 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2434 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2435 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2436 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2437 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2438 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2439 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2440 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2441 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2442 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2443
Heiko Schocher6789e842013-10-22 11:03:18 +02002444 - drivers/i2c/omap24xx_i2c.c
2445 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2446 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2447 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2448 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2449 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2450 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2451 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2452 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2453 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2454 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2455 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2456
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002457 - drivers/i2c/zynq_i2c.c
2458 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2459 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2460 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2461
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302462 - drivers/i2c/s3c24x0_i2c.c:
2463 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2464 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2465 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2466 with a fix speed from 100000 and the slave addr 0!
2467
Dirk Eibachb46226b2014-07-03 09:28:18 +02002468 - drivers/i2c/ihs_i2c.c
2469 - activate this driver with CONFIG_SYS_I2C_IHS
2470 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2471 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2472 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2473 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2474 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2475 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2476 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2477 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2478 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2479 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2480 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2481 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2482
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002483 additional defines:
2484
2485 CONFIG_SYS_NUM_I2C_BUSES
2486 Hold the number of i2c busses you want to use. If you
2487 don't use/have i2c muxes on your i2c bus, this
2488 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2489 omit this define.
2490
2491 CONFIG_SYS_I2C_DIRECT_BUS
2492 define this, if you don't use i2c muxes on your hardware.
2493 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2494 omit this define.
2495
2496 CONFIG_SYS_I2C_MAX_HOPS
2497 define how many muxes are maximal consecutively connected
2498 on one i2c bus. If you not use i2c muxes, omit this
2499 define.
2500
2501 CONFIG_SYS_I2C_BUSES
2502 hold a list of busses you want to use, only used if
2503 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2504 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2505 CONFIG_SYS_NUM_I2C_BUSES = 9:
2506
2507 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2508 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2509 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2510 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2511 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2512 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2513 {1, {I2C_NULL_HOP}}, \
2514 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2515 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2516 }
2517
2518 which defines
2519 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002520 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2521 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2522 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2523 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2524 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002525 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002526 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2527 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002528
2529 If you do not have i2c muxes on your board, omit this define.
2530
Heiko Schocherea818db2013-01-29 08:53:15 +01002531- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002532
2533 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2534 provides the following compelling advantages:
2535
2536 - more than one i2c adapter is usable
2537 - approved multibus support
2538 - better i2c mux support
2539
2540 ** Please consider updating your I2C driver now. **
2541
Heiko Schocherea818db2013-01-29 08:53:15 +01002542 These enable legacy I2C serial bus commands. Defining
2543 CONFIG_HARD_I2C will include the appropriate I2C driver
2544 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002545
wdenk945af8d2003-07-16 21:53:01 +00002546 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002547 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002548 CONFIG_COMMANDS) and communicate with i2c based realtime
2549 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002550 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002551
Ben Warrenbb99ad62006-09-07 16:50:54 -04002552 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002553
wdenk945af8d2003-07-16 21:53:01 +00002554 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002555 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002556
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002557 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002558 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002559 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002560 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002561
Peter Tyser8d321b82010-04-12 22:28:21 -05002562 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002563 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002564 and so its address should therefore be cleared to 0 (See,
2565 eg, MPC823e User's Manual p.16-473). So, set
2566 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002567
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002568 CONFIG_SYS_I2C_INIT_MPC5XXX
2569
2570 When a board is reset during an i2c bus transfer
2571 chips might think that the current transfer is still
2572 in progress. Reset the slave devices by sending start
2573 commands until the slave device responds.
2574
wdenk945af8d2003-07-16 21:53:01 +00002575 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002576
Heiko Schocherea818db2013-01-29 08:53:15 +01002577 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002578 then the following macros need to be defined (examples are
2579 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002580
2581 I2C_INIT
2582
wdenkb37c7e52003-06-30 16:24:52 +00002583 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002584 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002585
wdenkba56f622004-02-06 23:19:44 +00002586 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002587
wdenkc6097192002-11-03 00:24:07 +00002588 I2C_PORT
2589
wdenk43d96162003-03-06 00:02:04 +00002590 (Only for MPC8260 CPU). The I/O port to use (the code
2591 assumes both bits are on the same port). Valid values
2592 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002593
2594 I2C_ACTIVE
2595
2596 The code necessary to make the I2C data line active
2597 (driven). If the data line is open collector, this
2598 define can be null.
2599
wdenkb37c7e52003-06-30 16:24:52 +00002600 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2601
wdenkc6097192002-11-03 00:24:07 +00002602 I2C_TRISTATE
2603
2604 The code necessary to make the I2C data line tri-stated
2605 (inactive). If the data line is open collector, this
2606 define can be null.
2607
wdenkb37c7e52003-06-30 16:24:52 +00002608 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2609
wdenkc6097192002-11-03 00:24:07 +00002610 I2C_READ
2611
York Sun472d5462013-04-01 11:29:11 -07002612 Code that returns true if the I2C data line is high,
2613 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002614
wdenkb37c7e52003-06-30 16:24:52 +00002615 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2616
wdenkc6097192002-11-03 00:24:07 +00002617 I2C_SDA(bit)
2618
York Sun472d5462013-04-01 11:29:11 -07002619 If <bit> is true, sets the I2C data line high. If it
2620 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002621
wdenkb37c7e52003-06-30 16:24:52 +00002622 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002623 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002624 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002625
wdenkc6097192002-11-03 00:24:07 +00002626 I2C_SCL(bit)
2627
York Sun472d5462013-04-01 11:29:11 -07002628 If <bit> is true, sets the I2C clock line high. If it
2629 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002630
wdenkb37c7e52003-06-30 16:24:52 +00002631 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002632 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002633 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002634
wdenkc6097192002-11-03 00:24:07 +00002635 I2C_DELAY
2636
2637 This delay is invoked four times per clock cycle so this
2638 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002639 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002640 like:
2641
wdenkb37c7e52003-06-30 16:24:52 +00002642 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002643
Mike Frysinger793b5722010-07-21 13:38:02 -04002644 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2645
2646 If your arch supports the generic GPIO framework (asm/gpio.h),
2647 then you may alternatively define the two GPIOs that are to be
2648 used as SCL / SDA. Any of the previous I2C_xxx macros will
2649 have GPIO-based defaults assigned to them as appropriate.
2650
2651 You should define these to the GPIO value as given directly to
2652 the generic GPIO functions.
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002655
wdenk8bde7f72003-06-27 21:31:46 +00002656 When a board is reset during an i2c bus transfer
2657 chips might think that the current transfer is still
2658 in progress. On some boards it is possible to access
2659 the i2c SCLK line directly, either by using the
2660 processor pin as a GPIO or by having a second pin
2661 connected to the bus. If this option is defined a
2662 custom i2c_init_board() routine in boards/xxx/board.c
2663 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002664
Richard Retanubun26a33502010-04-12 15:08:17 -04002665 CONFIG_SYS_I2C_BOARD_LATE_INIT
2666
2667 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2668 defined a custom i2c_board_late_init() routine in
2669 boards/xxx/board.c is run AFTER the operations in i2c_init()
2670 is completed. This callpoint can be used to unreset i2c bus
2671 using CPU i2c controller register accesses for CPUs whose i2c
2672 controller provide such a method. It is called at the end of
2673 i2c_init() to allow i2c_init operations to setup the i2c bus
2674 controller on the CPU (e.g. setting bus speed & slave address).
2675
wdenk17ea1172004-06-06 21:51:03 +00002676 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2677
2678 This option enables configuration of bi_iic_fast[] flags
2679 in u-boot bd_info structure based on u-boot environment
2680 variable "i2cfast". (see also i2cfast)
2681
Ben Warrenbb99ad62006-09-07 16:50:54 -04002682 CONFIG_I2C_MULTI_BUS
2683
2684 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002685 must have a controller. At any point in time, only one bus is
2686 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002687 Note that bus numbering is zero-based.
2688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002689 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002690
2691 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002692 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002693 is set, specify a list of bus-device pairs. Otherwise, specify
2694 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002695
2696 e.g.
2697 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002698 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002699
2700 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2701
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002702 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002704
2705 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002707 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002708
2709 If defined, then this indicates the I2C bus number for DDR SPD.
2710 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002713
2714 If defined, then this indicates the I2C bus number for the RTC.
2715 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2716
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002717 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002718
2719 If defined, then this indicates the I2C bus number for the DTT.
2720 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002723
2724 If defined, specifies the I2C address of the DTT device.
2725 If not defined, then U-Boot uses predefined value for
2726 specified DTT device.
2727
Andrew Dyer2ac69852008-12-29 17:36:01 -06002728 CONFIG_SOFT_I2C_READ_REPEATED_START
2729
2730 defining this will force the i2c_read() function in
2731 the soft_i2c driver to perform an I2C repeated start
2732 between writing the address pointer and reading the
2733 data. If this define is omitted the default behaviour
2734 of doing a stop-start sequence will be used. Most I2C
2735 devices can use either method, but some require one or
2736 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002737
wdenkc6097192002-11-03 00:24:07 +00002738- SPI Support: CONFIG_SPI
2739
2740 Enables SPI driver (so far only tested with
2741 SPI EEPROM, also an instance works with Crystal A/D and
2742 D/As on the SACSng board)
2743
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002744 CONFIG_SH_SPI
2745
2746 Enables the driver for SPI controller on SuperH. Currently
2747 only SH7757 is supported.
2748
wdenkc6097192002-11-03 00:24:07 +00002749 CONFIG_SPI_X
2750
2751 Enables extended (16-bit) SPI EEPROM addressing.
2752 (symmetrical to CONFIG_I2C_X)
2753
2754 CONFIG_SOFT_SPI
2755
wdenk43d96162003-03-06 00:02:04 +00002756 Enables a software (bit-bang) SPI driver rather than
2757 using hardware support. This is a general purpose
2758 driver that only requires three general I/O port pins
2759 (two outputs, one input) to function. If this is
2760 defined, the board configuration must define several
2761 SPI configuration items (port pins to use, etc). For
2762 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002763
Ben Warren04a9e112008-01-16 22:37:35 -05002764 CONFIG_HARD_SPI
2765
2766 Enables a hardware SPI driver for general-purpose reads
2767 and writes. As with CONFIG_SOFT_SPI, the board configuration
2768 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002769 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002770 example, see include/configs/mpc8349emds.h.
2771
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002772 CONFIG_MXC_SPI
2773
2774 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002775 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002776
Heiko Schocherf659b572014-07-14 10:22:11 +02002777 CONFIG_SYS_SPI_MXC_WAIT
2778 Timeout for waiting until spi transfer completed.
2779 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2780
Matthias Fuchs01335022007-12-27 17:12:34 +01002781- FPGA Support: CONFIG_FPGA
2782
2783 Enables FPGA subsystem.
2784
2785 CONFIG_FPGA_<vendor>
2786
2787 Enables support for specific chip vendors.
2788 (ALTERA, XILINX)
2789
2790 CONFIG_FPGA_<family>
2791
2792 Enables support for FPGA family.
2793 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2794
2795 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002796
wdenk43d96162003-03-06 00:02:04 +00002797 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002798
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302799 CONFIG_CMD_FPGA_LOADMK
2800
2801 Enable support for fpga loadmk command
2802
Michal Simek67193862014-05-02 13:43:39 +02002803 CONFIG_CMD_FPGA_LOADP
2804
2805 Enable support for fpga loadp command - load partial bitstream
2806
2807 CONFIG_CMD_FPGA_LOADBP
2808
2809 Enable support for fpga loadbp command - load partial bitstream
2810 (Xilinx only)
2811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002812 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002813
wdenk8bde7f72003-06-27 21:31:46 +00002814 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002816 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002817
wdenk43d96162003-03-06 00:02:04 +00002818 Enable checks on FPGA configuration interface busy
2819 status by the configuration function. This option
2820 will require a board or device specific function to
2821 be written.
wdenkc6097192002-11-03 00:24:07 +00002822
2823 CONFIG_FPGA_DELAY
2824
2825 If defined, a function that provides delays in the FPGA
2826 configuration driver.
2827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002829 Allow Control-C to interrupt FPGA configuration
2830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk43d96162003-03-06 00:02:04 +00002833 Check for configuration errors during FPGA bitfile
2834 loading. For example, abort during Virtex II
2835 configuration if the INIT_B line goes low (which
2836 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002838 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002839
wdenk43d96162003-03-06 00:02:04 +00002840 Maximum time to wait for the INIT_B line to deassert
2841 after PROB_B has been deasserted during a Virtex II
2842 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002843 ms.
wdenkc6097192002-11-03 00:24:07 +00002844
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002845 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002846
wdenk43d96162003-03-06 00:02:04 +00002847 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002848 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002851
wdenk43d96162003-03-06 00:02:04 +00002852 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002853 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002854
2855- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002856 CONFIG_BUILD_TARGET
2857
2858 Some SoCs need special image types (e.g. U-Boot binary
2859 with a special header) as build targets. By defining
2860 CONFIG_BUILD_TARGET in the SoC / board header, this
2861 special image will be automatically built upon calling
2862 make / MAKEALL.
2863
wdenkc6097192002-11-03 00:24:07 +00002864 CONFIG_IDENT_STRING
2865
wdenk43d96162003-03-06 00:02:04 +00002866 If defined, this string will be added to the U-Boot
2867 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002868
2869- Vendor Parameter Protection:
2870
wdenk43d96162003-03-06 00:02:04 +00002871 U-Boot considers the values of the environment
2872 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002873 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002874 are set once by the board vendor / manufacturer, and
2875 protects these variables from casual modification by
2876 the user. Once set, these variables are read-only,
2877 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002878 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002879
2880 If CONFIG_ENV_OVERWRITE is #defined in your config
2881 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002882 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002883 these parameters.
2884
2885 Alternatively, if you #define _both_ CONFIG_ETHADDR
2886 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002887 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002888 which can be changed exactly ONCE by the user. [The
2889 serial# is unaffected by this, i. e. it remains
2890 read-only.]
2891
Joe Hershberger25980902012-12-11 22:16:31 -06002892 The same can be accomplished in a more flexible way
2893 for any variable by configuring the type of access
2894 to allow for those variables in the ".flags" variable
2895 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2896
wdenkc6097192002-11-03 00:24:07 +00002897- Protected RAM:
2898 CONFIG_PRAM
2899
2900 Define this variable to enable the reservation of
2901 "protected RAM", i. e. RAM which is not overwritten
2902 by U-Boot. Define CONFIG_PRAM to hold the number of
2903 kB you want to reserve for pRAM. You can overwrite
2904 this default value by defining an environment
2905 variable "pram" to the number of kB you want to
2906 reserve. Note that the board info structure will
2907 still show the full amount of RAM. If pRAM is
2908 reserved, a new environment variable "mem" will
2909 automatically be defined to hold the amount of
2910 remaining RAM in a form that can be passed as boot
2911 argument to Linux, for instance like that:
2912
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002913 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002914 saveenv
2915
2916 This way you can tell Linux not to use this memory,
2917 either, which results in a memory region that will
2918 not be affected by reboots.
2919
2920 *WARNING* If your board configuration uses automatic
2921 detection of the RAM size, you must make sure that
2922 this memory test is non-destructive. So far, the
2923 following board configurations are known to be
2924 "pRAM-clean":
2925
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002926 IVMS8, IVML24, SPD8xx, TQM8xxL,
2927 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002928 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002929
Gabe Black40fef042012-12-02 04:55:18 +00002930- Access to physical memory region (> 4GB)
2931 Some basic support is provided for operations on memory not
2932 normally accessible to U-Boot - e.g. some architectures
2933 support access to more than 4GB of memory on 32-bit
2934 machines using physical address extension or similar.
2935 Define CONFIG_PHYSMEM to access this basic support, which
2936 currently only supports clearing the memory.
2937
wdenkc6097192002-11-03 00:24:07 +00002938- Error Recovery:
2939 CONFIG_PANIC_HANG
2940
2941 Define this variable to stop the system in case of a
2942 fatal error, so that you have to reset it manually.
2943 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002944 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002945 automatically as fast as possible, but it may be
2946 useful during development since you can try to debug
2947 the conditions that lead to the situation.
2948
2949 CONFIG_NET_RETRY_COUNT
2950
wdenk43d96162003-03-06 00:02:04 +00002951 This variable defines the number of retries for
2952 network operations like ARP, RARP, TFTP, or BOOTP
2953 before giving up the operation. If not defined, a
2954 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002955
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002956 CONFIG_ARP_TIMEOUT
2957
2958 Timeout waiting for an ARP reply in milliseconds.
2959
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002960 CONFIG_NFS_TIMEOUT
2961
2962 Timeout in milliseconds used in NFS protocol.
2963 If you encounter "ERROR: Cannot umount" in nfs command,
2964 try longer timeout such as
2965 #define CONFIG_NFS_TIMEOUT 10000UL
2966
wdenkc6097192002-11-03 00:24:07 +00002967- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002968 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002969
2970 Enable auto completion of commands using TAB.
2971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002973
2974 This defines the secondary prompt string, which is
2975 printed when the command interpreter needs more input
2976 to complete a command. Usually "> ".
2977
2978 Note:
2979
wdenk8bde7f72003-06-27 21:31:46 +00002980 In the current implementation, the local variables
2981 space and global environment variables space are
2982 separated. Local variables are those you define by
2983 simply typing `name=value'. To access a local
2984 variable later on, you have write `$name' or
2985 `${name}'; to execute the contents of a variable
2986 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002987
wdenk43d96162003-03-06 00:02:04 +00002988 Global environment variables are those you use
2989 setenv/printenv to work with. To run a command stored
2990 in such a variable, you need to use the run command,
2991 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002992
2993 To store commands and special characters in a
2994 variable, please use double quotation marks
2995 surrounding the whole text of the variable, instead
2996 of the backslashes before semicolons and special
2997 symbols.
2998
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002999- Commandline Editing and History:
3000 CONFIG_CMDLINE_EDITING
3001
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003002 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02003003 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02003004
wdenka8c7c702003-12-06 19:49:23 +00003005- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003006 CONFIG_EXTRA_ENV_SETTINGS
3007
wdenk43d96162003-03-06 00:02:04 +00003008 Define this to contain any number of null terminated
3009 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003010 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003011
wdenk43d96162003-03-06 00:02:04 +00003012 For example, place something like this in your
3013 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003014
3015 #define CONFIG_EXTRA_ENV_SETTINGS \
3016 "myvar1=value1\0" \
3017 "myvar2=value2\0"
3018
wdenk43d96162003-03-06 00:02:04 +00003019 Warning: This method is based on knowledge about the
3020 internal format how the environment is stored by the
3021 U-Boot code. This is NOT an official, exported
3022 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003023 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003024 You better know what you are doing here.
3025
wdenk43d96162003-03-06 00:02:04 +00003026 Note: overly (ab)use of the default environment is
3027 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003028 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003029 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003030
Stephen Warren5e724ca2012-05-22 09:21:54 +00003031 CONFIG_ENV_VARS_UBOOT_CONFIG
3032
3033 Define this in order to add variables describing the
3034 U-Boot build configuration to the default environment.
3035 These will be named arch, cpu, board, vendor, and soc.
3036
3037 Enabling this option will cause the following to be defined:
3038
3039 - CONFIG_SYS_ARCH
3040 - CONFIG_SYS_CPU
3041 - CONFIG_SYS_BOARD
3042 - CONFIG_SYS_VENDOR
3043 - CONFIG_SYS_SOC
3044
Tom Rini7e27f892012-10-24 07:28:16 +00003045 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3046
3047 Define this in order to add variables describing certain
3048 run-time determined information about the hardware to the
3049 environment. These will be named board_name, board_rev.
3050
Simon Glass06fd8532012-11-30 13:01:17 +00003051 CONFIG_DELAY_ENVIRONMENT
3052
3053 Normally the environment is loaded when the board is
3054 intialised so that it is available to U-Boot. This inhibits
3055 that so that the environment is not available until
3056 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3057 this is instead controlled by the value of
3058 /config/load-environment.
3059
wdenka8c7c702003-12-06 19:49:23 +00003060- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003061 CONFIG_HAS_DATAFLASH
3062
wdenk8bde7f72003-06-27 21:31:46 +00003063 Defining this option enables DataFlash features and
3064 allows to read/write in Dataflash via the standard
3065 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003066
Eric Nelsonf61ec452012-01-31 10:52:08 -07003067- Serial Flash support
3068 CONFIG_CMD_SF
3069
3070 Defining this option enables SPI flash commands
3071 'sf probe/read/write/erase/update'.
3072
3073 Usage requires an initial 'probe' to define the serial
3074 flash parameters, followed by read/write/erase/update
3075 commands.
3076
3077 The following defaults may be provided by the platform
3078 to handle the common case when only a single serial
3079 flash is present on the system.
3080
3081 CONFIG_SF_DEFAULT_BUS Bus identifier
3082 CONFIG_SF_DEFAULT_CS Chip-select
3083 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3084 CONFIG_SF_DEFAULT_SPEED in Hz
3085
Simon Glass24007272012-10-08 13:16:02 +00003086 CONFIG_CMD_SF_TEST
3087
3088 Define this option to include a destructive SPI flash
3089 test ('sf test').
3090
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303091 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3092
3093 Define this option to use the Bank addr/Extended addr
3094 support on SPI flashes which has size > 16Mbytes.
3095
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303096 CONFIG_SF_DUAL_FLASH Dual flash memories
3097
3098 Define this option to use dual flash support where two flash
3099 memories can be connected with a given cs line.
3100 currently Xilinx Zynq qspi support these type of connections.
3101
Heiko Schocher562f8df2014-07-18 06:07:21 +02003102 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3103 enable the W#/Vpp signal to disable writing to the status
3104 register on ST MICRON flashes like the N25Q128.
3105 The status register write enable/disable bit, combined with
3106 the W#/VPP signal provides hardware data protection for the
3107 device as follows: When the enable/disable bit is set to 1,
3108 and the W#/VPP signal is driven LOW, the status register
3109 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3110 operation will not execute. The only way to exit this
3111 hardware-protected mode is to drive W#/VPP HIGH.
3112
wdenk3f85ce22004-02-23 16:11:30 +00003113- SystemACE Support:
3114 CONFIG_SYSTEMACE
3115
3116 Adding this option adds support for Xilinx SystemACE
3117 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003118 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003120
3121 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003122 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003123
3124 When SystemACE support is added, the "ace" device type
3125 becomes available to the fat commands, i.e. fatls.
3126
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003127- TFTP Fixed UDP Port:
3128 CONFIG_TFTP_PORT
3129
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003130 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003131 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003132 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003133 number generator is used.
3134
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003135 Also, the environment variable tftpdstp is used to supply
3136 the TFTP UDP destination port value. If tftpdstp isn't
3137 defined, the normal port 69 is used.
3138
3139 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003140 blindly start the TFTP transfer using the pre-configured
3141 target IP address and UDP port. This has the effect of
3142 "punching through" the (Windows XP) firewall, allowing
3143 the remainder of the TFTP transfer to proceed normally.
3144 A better solution is to properly configure the firewall,
3145 but sometimes that is not allowed.
3146
Simon Glassbf36c5d2012-12-05 14:46:38 +00003147- Hashing support:
3148 CONFIG_CMD_HASH
3149
3150 This enables a generic 'hash' command which can produce
3151 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3152
3153 CONFIG_HASH_VERIFY
3154
3155 Enable the hash verify command (hash -v). This adds to code
3156 size a little.
3157
3158 CONFIG_SHA1 - support SHA1 hashing
3159 CONFIG_SHA256 - support SHA256 hashing
3160
3161 Note: There is also a sha1sum command, which should perhaps
3162 be deprecated in favour of 'hash sha1'.
3163
Robert Winklera11f1872013-07-24 17:57:06 -07003164- Freescale i.MX specific commands:
3165 CONFIG_CMD_HDMIDETECT
3166 This enables 'hdmidet' command which returns true if an
3167 HDMI monitor is detected. This command is i.MX 6 specific.
3168
3169 CONFIG_CMD_BMODE
3170 This enables the 'bmode' (bootmode) command for forcing
3171 a boot from specific media.
3172
3173 This is useful for forcing the ROM's usb downloader to
3174 activate upon a watchdog reset which is nice when iterating
3175 on U-Boot. Using the reset button or running bmode normal
3176 will set it back to normal. This command currently
3177 supports i.MX53 and i.MX6.
3178
Simon Glass19c402a2013-06-13 15:10:02 -07003179- Signing support:
3180 CONFIG_RSA
3181
3182 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003183 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003184
3185 The signing part is build into mkimage regardless of this
3186 option.
3187
Heiko Schocher9e50c402014-01-25 07:27:13 +01003188- bootcount support:
3189 CONFIG_BOOTCOUNT_LIMIT
3190
3191 This enables the bootcounter support, see:
3192 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3193
3194 CONFIG_AT91SAM9XE
3195 enable special bootcounter support on at91sam9xe based boards.
3196 CONFIG_BLACKFIN
3197 enable special bootcounter support on blackfin based boards.
3198 CONFIG_SOC_DA8XX
3199 enable special bootcounter support on da850 based boards.
3200 CONFIG_BOOTCOUNT_RAM
3201 enable support for the bootcounter in RAM
3202 CONFIG_BOOTCOUNT_I2C
3203 enable support for the bootcounter on an i2c (like RTC) device.
3204 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3205 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3206 the bootcounter.
3207 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003208
wdenka8c7c702003-12-06 19:49:23 +00003209- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003210 CONFIG_SHOW_BOOT_PROGRESS
3211
wdenk43d96162003-03-06 00:02:04 +00003212 Defining this option allows to add some board-
3213 specific code (calling a user-provided function
3214 "show_boot_progress(int)") that enables you to show
3215 the system's boot progress on some display (for
3216 example, some LED's) on your board. At the moment,
3217 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003218
Simon Glass3a608ca2012-02-13 13:51:19 +00003219- Detailed boot stage timing
3220 CONFIG_BOOTSTAGE
3221 Define this option to get detailed timing of each stage
3222 of the boot process.
3223
3224 CONFIG_BOOTSTAGE_USER_COUNT
3225 This is the number of available user bootstage records.
3226 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3227 a new ID will be allocated from this stash. If you exceed
3228 the limit, recording will stop.
3229
3230 CONFIG_BOOTSTAGE_REPORT
3231 Define this to print a report before boot, similar to this:
3232
3233 Timer summary in microseconds:
3234 Mark Elapsed Stage
3235 0 0 reset
3236 3,575,678 3,575,678 board_init_f start
3237 3,575,695 17 arch_cpu_init A9
3238 3,575,777 82 arch_cpu_init done
3239 3,659,598 83,821 board_init_r start
3240 3,910,375 250,777 main_loop
3241 29,916,167 26,005,792 bootm_start
3242 30,361,327 445,160 start_kernel
3243
Simon Glass2eba38c2012-09-28 08:56:39 +00003244 CONFIG_CMD_BOOTSTAGE
3245 Add a 'bootstage' command which supports printing a report
3246 and un/stashing of bootstage data.
3247
Simon Glass94fd1312012-09-28 08:56:37 +00003248 CONFIG_BOOTSTAGE_FDT
3249 Stash the bootstage information in the FDT. A root 'bootstage'
3250 node is created with each bootstage id as a child. Each child
3251 has a 'name' property and either 'mark' containing the
3252 mark time in microsecond, or 'accum' containing the
3253 accumulated time for that bootstage id in microseconds.
3254 For example:
3255
3256 bootstage {
3257 154 {
3258 name = "board_init_f";
3259 mark = <3575678>;
3260 };
3261 170 {
3262 name = "lcd";
3263 accum = <33482>;
3264 };
3265 };
3266
3267 Code in the Linux kernel can find this in /proc/devicetree.
3268
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003269Legacy uImage format:
3270
wdenkc6097192002-11-03 00:24:07 +00003271 Arg Where When
3272 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003273 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003274 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003275 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003276 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003277 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003278 4 common/cmd_bootm.c Image data has correct checksum
3279 -4 common/cmd_bootm.c Image is for unsupported architecture
3280 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003281 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003282 6 common/cmd_bootm.c Image Type check OK
3283 -6 common/cmd_bootm.c gunzip uncompression error
3284 -7 common/cmd_bootm.c Unimplemented compression type
3285 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003286 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003287 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003288
3289 9 common/image.c Start initial ramdisk verification
3290 -10 common/image.c Ramdisk header has bad magic number
3291 -11 common/image.c Ramdisk header has bad checksum
3292 10 common/image.c Ramdisk header is OK
3293 -12 common/image.c Ramdisk data has bad checksum
3294 11 common/image.c Ramdisk data has correct checksum
3295 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003296 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003297 13 common/image.c Start multifile image verification
3298 14 common/image.c No initial ramdisk, no multifile, continue.
3299
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003300 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003301
Stefan Roesea47a12b2010-04-15 16:07:28 +02003302 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00003303 -31 post/post.c POST test failed, detected by post_output_backlog()
3304 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003305
Heiko Schocher566a4942007-06-22 19:11:54 +02003306 34 common/cmd_doc.c before loading a Image from a DOC device
3307 -35 common/cmd_doc.c Bad usage of "doc" command
3308 35 common/cmd_doc.c correct usage of "doc" command
3309 -36 common/cmd_doc.c No boot device
3310 36 common/cmd_doc.c correct boot device
3311 -37 common/cmd_doc.c Unknown Chip ID on boot device
3312 37 common/cmd_doc.c correct chip ID found, device available
3313 -38 common/cmd_doc.c Read Error on boot device
3314 38 common/cmd_doc.c reading Image header from DOC device OK
3315 -39 common/cmd_doc.c Image header has bad magic number
3316 39 common/cmd_doc.c Image header has correct magic number
3317 -40 common/cmd_doc.c Error reading Image from DOC device
3318 40 common/cmd_doc.c Image header has correct magic number
3319 41 common/cmd_ide.c before loading a Image from a IDE device
3320 -42 common/cmd_ide.c Bad usage of "ide" command
3321 42 common/cmd_ide.c correct usage of "ide" command
3322 -43 common/cmd_ide.c No boot device
3323 43 common/cmd_ide.c boot device found
3324 -44 common/cmd_ide.c Device not available
3325 44 common/cmd_ide.c Device available
3326 -45 common/cmd_ide.c wrong partition selected
3327 45 common/cmd_ide.c partition selected
3328 -46 common/cmd_ide.c Unknown partition table
3329 46 common/cmd_ide.c valid partition table found
3330 -47 common/cmd_ide.c Invalid partition type
3331 47 common/cmd_ide.c correct partition type
3332 -48 common/cmd_ide.c Error reading Image Header on boot device
3333 48 common/cmd_ide.c reading Image Header from IDE device OK
3334 -49 common/cmd_ide.c Image header has bad magic number
3335 49 common/cmd_ide.c Image header has correct magic number
3336 -50 common/cmd_ide.c Image header has bad checksum
3337 50 common/cmd_ide.c Image header has correct checksum
3338 -51 common/cmd_ide.c Error reading Image from IDE device
3339 51 common/cmd_ide.c reading Image from IDE device OK
3340 52 common/cmd_nand.c before loading a Image from a NAND device
3341 -53 common/cmd_nand.c Bad usage of "nand" command
3342 53 common/cmd_nand.c correct usage of "nand" command
3343 -54 common/cmd_nand.c No boot device
3344 54 common/cmd_nand.c boot device found
3345 -55 common/cmd_nand.c Unknown Chip ID on boot device
3346 55 common/cmd_nand.c correct chip ID found, device available
3347 -56 common/cmd_nand.c Error reading Image Header on boot device
3348 56 common/cmd_nand.c reading Image Header from NAND device OK
3349 -57 common/cmd_nand.c Image header has bad magic number
3350 57 common/cmd_nand.c Image header has correct magic number
3351 -58 common/cmd_nand.c Error reading Image from NAND device
3352 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003353
Heiko Schocher566a4942007-06-22 19:11:54 +02003354 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003355
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003356 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003357 -64 net/eth.c no Ethernet found.
3358 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003359
Heiko Schocher566a4942007-06-22 19:11:54 +02003360 -80 common/cmd_net.c usage wrong
3361 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003362 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003363 81 common/cmd_net.c NetLoop() back without error
3364 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3365 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003366 83 common/cmd_net.c running "source" command
3367 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003368 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003369
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003370FIT uImage format:
3371
3372 Arg Where When
3373 100 common/cmd_bootm.c Kernel FIT Image has correct format
3374 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3375 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3376 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3377 102 common/cmd_bootm.c Kernel unit name specified
3378 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003379 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003380 104 common/cmd_bootm.c Got kernel subimage node offset
3381 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3382 105 common/cmd_bootm.c Kernel subimage hash verification OK
3383 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3384 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003385 -106 common/cmd_bootm.c Kernel subimage has wrong type
3386 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003387 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3388 108 common/cmd_bootm.c Got kernel subimage data/size
3389 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3390 -109 common/cmd_bootm.c Can't get kernel subimage type
3391 -110 common/cmd_bootm.c Can't get kernel subimage comp
3392 -111 common/cmd_bootm.c Can't get kernel subimage os
3393 -112 common/cmd_bootm.c Can't get kernel subimage load address
3394 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3395
3396 120 common/image.c Start initial ramdisk verification
3397 -120 common/image.c Ramdisk FIT image has incorrect format
3398 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003399 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003400 -122 common/image.c Can't get configuration for ramdisk subimage
3401 123 common/image.c Ramdisk unit name specified
3402 -124 common/image.c Can't get ramdisk subimage node offset
3403 125 common/image.c Got ramdisk subimage node offset
3404 -125 common/image.c Ramdisk subimage hash verification failed
3405 126 common/image.c Ramdisk subimage hash verification OK
3406 -126 common/image.c Ramdisk subimage for unsupported architecture
3407 127 common/image.c Architecture check OK
3408 -127 common/image.c Can't get ramdisk subimage data/size
3409 128 common/image.c Got ramdisk subimage data/size
3410 129 common/image.c Can't get ramdisk load address
3411 -129 common/image.c Got ramdisk load address
3412
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003413 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003414 131 common/cmd_doc.c FIT image format OK
3415
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003416 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003417 141 common/cmd_ide.c FIT image format OK
3418
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003419 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003420 151 common/cmd_nand.c FIT image format OK
3421
Heiko Schocher21d29f72014-05-28 11:33:33 +02003422- legacy image format:
3423 CONFIG_IMAGE_FORMAT_LEGACY
3424 enables the legacy image format support in U-Boot.
3425
3426 Default:
3427 enabled if CONFIG_FIT_SIGNATURE is not defined.
3428
3429 CONFIG_DISABLE_IMAGE_LEGACY
3430 disable the legacy image format
3431
3432 This define is introduced, as the legacy image format is
3433 enabled per default for backward compatibility.
3434
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003435- FIT image support:
3436 CONFIG_FIT
3437 Enable support for the FIT uImage format.
3438
3439 CONFIG_FIT_BEST_MATCH
3440 When no configuration is explicitly selected, default to the
3441 one whose fdt's compatibility field best matches that of
3442 U-Boot itself. A match is considered "best" if it matches the
3443 most specific compatibility entry of U-Boot's fdt's root node.
3444 The order of entries in the configuration's fdt is ignored.
3445
Simon Glass3e569a62013-06-13 15:10:00 -07003446 CONFIG_FIT_SIGNATURE
3447 This option enables signature verification of FIT uImages,
3448 using a hash signed and verified using RSA. See
3449 doc/uImage.FIT/signature.txt for more details.
3450
Heiko Schocher21d29f72014-05-28 11:33:33 +02003451 WARNING: When relying on signed FIT images with required
3452 signature check the legacy image format is default
3453 disabled. If a board need legacy image format support
3454 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3455
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003456 CONFIG_FIT_DISABLE_SHA256
3457 Supporting SHA256 hashes has quite an impact on binary size.
3458 For constrained systems sha256 hash support can be disabled
3459 with this option.
3460
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003461- Standalone program support:
3462 CONFIG_STANDALONE_LOAD_ADDR
3463
Wolfgang Denk6feff892011-10-09 21:06:34 +02003464 This option defines a board specific value for the
3465 address where standalone program gets loaded, thus
3466 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003467 settings.
3468
3469- Frame Buffer Address:
3470 CONFIG_FB_ADDR
3471
3472 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003473 address for frame buffer. This is typically the case
3474 when using a graphics controller has separate video
3475 memory. U-Boot will then place the frame buffer at
3476 the given address instead of dynamically reserving it
3477 in system RAM by calling lcd_setmem(), which grabs
3478 the memory for the frame buffer depending on the
3479 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003480
3481 Please see board_init_f function.
3482
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003483- Automatic software updates via TFTP server
3484 CONFIG_UPDATE_TFTP
3485 CONFIG_UPDATE_TFTP_CNT_MAX
3486 CONFIG_UPDATE_TFTP_MSEC_MAX
3487
3488 These options enable and control the auto-update feature;
3489 for a more detailed description refer to doc/README.update.
3490
3491- MTD Support (mtdparts command, UBI support)
3492 CONFIG_MTD_DEVICE
3493
3494 Adds the MTD device infrastructure from the Linux kernel.
3495 Needed for mtdparts command support.
3496
3497 CONFIG_MTD_PARTITIONS
3498
3499 Adds the MTD partitioning infrastructure from the Linux
3500 kernel. Needed for UBI support.
3501
Heiko Schocherff94bc42014-06-24 10:10:04 +02003502 CONFIG_MTD_NAND_VERIFY_WRITE
3503 verify if the written data is correct reread.
3504
Joe Hershberger70c219c2013-04-08 10:32:48 +00003505- UBI support
3506 CONFIG_CMD_UBI
3507
3508 Adds commands for interacting with MTD partitions formatted
3509 with the UBI flash translation layer
3510
3511 Requires also defining CONFIG_RBTREE
3512
Joe Hershberger147162d2013-04-08 10:32:49 +00003513 CONFIG_UBI_SILENCE_MSG
3514
3515 Make the verbose messages from UBI stop printing. This leaves
3516 warnings and errors enabled.
3517
Heiko Schocherff94bc42014-06-24 10:10:04 +02003518
3519 CONFIG_MTD_UBI_WL_THRESHOLD
3520 This parameter defines the maximum difference between the highest
3521 erase counter value and the lowest erase counter value of eraseblocks
3522 of UBI devices. When this threshold is exceeded, UBI starts performing
3523 wear leveling by means of moving data from eraseblock with low erase
3524 counter to eraseblocks with high erase counter.
3525
3526 The default value should be OK for SLC NAND flashes, NOR flashes and
3527 other flashes which have eraseblock life-cycle 100000 or more.
3528 However, in case of MLC NAND flashes which typically have eraseblock
3529 life-cycle less than 10000, the threshold should be lessened (e.g.,
3530 to 128 or 256, although it does not have to be power of 2).
3531
3532 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003533
Heiko Schocherff94bc42014-06-24 10:10:04 +02003534 CONFIG_MTD_UBI_BEB_LIMIT
3535 This option specifies the maximum bad physical eraseblocks UBI
3536 expects on the MTD device (per 1024 eraseblocks). If the
3537 underlying flash does not admit of bad eraseblocks (e.g. NOR
3538 flash), this value is ignored.
3539
3540 NAND datasheets often specify the minimum and maximum NVM
3541 (Number of Valid Blocks) for the flashes' endurance lifetime.
3542 The maximum expected bad eraseblocks per 1024 eraseblocks
3543 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3544 which gives 20 for most NANDs (MaxNVB is basically the total
3545 count of eraseblocks on the chip).
3546
3547 To put it differently, if this value is 20, UBI will try to
3548 reserve about 1.9% of physical eraseblocks for bad blocks
3549 handling. And that will be 1.9% of eraseblocks on the entire
3550 NAND chip, not just the MTD partition UBI attaches. This means
3551 that if you have, say, a NAND flash chip admits maximum 40 bad
3552 eraseblocks, and it is split on two MTD partitions of the same
3553 size, UBI will reserve 40 eraseblocks when attaching a
3554 partition.
3555
3556 default: 20
3557
3558 CONFIG_MTD_UBI_FASTMAP
3559 Fastmap is a mechanism which allows attaching an UBI device
3560 in nearly constant time. Instead of scanning the whole MTD device it
3561 only has to locate a checkpoint (called fastmap) on the device.
3562 The on-flash fastmap contains all information needed to attach
3563 the device. Using fastmap makes only sense on large devices where
3564 attaching by scanning takes long. UBI will not automatically install
3565 a fastmap on old images, but you can set the UBI parameter
3566 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3567 that fastmap-enabled images are still usable with UBI implementations
3568 without fastmap support. On typical flash devices the whole fastmap
3569 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3570
3571 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3572 Set this parameter to enable fastmap automatically on images
3573 without a fastmap.
3574 default: 0
3575
Joe Hershberger70c219c2013-04-08 10:32:48 +00003576- UBIFS support
3577 CONFIG_CMD_UBIFS
3578
3579 Adds commands for interacting with UBI volumes formatted as
3580 UBIFS. UBIFS is read-only in u-boot.
3581
3582 Requires UBI support as well as CONFIG_LZO
3583
Joe Hershberger147162d2013-04-08 10:32:49 +00003584 CONFIG_UBIFS_SILENCE_MSG
3585
3586 Make the verbose messages from UBIFS stop printing. This leaves
3587 warnings and errors enabled.
3588
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003589- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003590 CONFIG_SPL
3591 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003592
Tom Rini95579792012-02-14 07:29:40 +00003593 CONFIG_SPL_LDSCRIPT
3594 LDSCRIPT for linking the SPL binary.
3595
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003596 CONFIG_SPL_MAX_FOOTPRINT
3597 Maximum size in memory allocated to the SPL, BSS included.
3598 When defined, the linker checks that the actual memory
3599 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003600 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003601 must not be both defined at the same time.
3602
Tom Rini95579792012-02-14 07:29:40 +00003603 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003604 Maximum size of the SPL image (text, data, rodata, and
3605 linker lists sections), BSS excluded.
3606 When defined, the linker checks that the actual size does
3607 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003608
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003609 CONFIG_SPL_TEXT_BASE
3610 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003611
Scott Wood94a45bb2012-09-20 19:05:12 -05003612 CONFIG_SPL_RELOC_TEXT_BASE
3613 Address to relocate to. If unspecified, this is equal to
3614 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3615
Tom Rini95579792012-02-14 07:29:40 +00003616 CONFIG_SPL_BSS_START_ADDR
3617 Link address for the BSS within the SPL binary.
3618
3619 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003620 Maximum size in memory allocated to the SPL BSS.
3621 When defined, the linker checks that the actual memory used
3622 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003623 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003624 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003625
3626 CONFIG_SPL_STACK
3627 Adress of the start of the stack SPL will use
3628
Scott Wood94a45bb2012-09-20 19:05:12 -05003629 CONFIG_SPL_RELOC_STACK
3630 Adress of the start of the stack SPL will use after
3631 relocation. If unspecified, this is equal to
3632 CONFIG_SPL_STACK.
3633
Tom Rini95579792012-02-14 07:29:40 +00003634 CONFIG_SYS_SPL_MALLOC_START
3635 Starting address of the malloc pool used in SPL.
3636
3637 CONFIG_SYS_SPL_MALLOC_SIZE
3638 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003639
Tom Rini47f7bca2012-08-13 12:03:19 -07003640 CONFIG_SPL_FRAMEWORK
3641 Enable the SPL framework under common/. This framework
3642 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3643 NAND loading of the Linux Kernel.
3644
Tom Rini9607faf2014-03-28 12:03:39 -04003645 CONFIG_SPL_OS_BOOT
3646 Enable booting directly to an OS from SPL.
3647 See also: doc/README.falcon
3648
Tom Rini861a86f2012-08-13 11:37:56 -07003649 CONFIG_SPL_DISPLAY_PRINT
3650 For ARM, enable an optional function to print more information
3651 about the running system.
3652
Scott Wood4b919722012-09-20 16:35:21 -05003653 CONFIG_SPL_INIT_MINIMAL
3654 Arch init code should be built for a very small image
3655
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003656 CONFIG_SPL_LIBCOMMON_SUPPORT
3657 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003658
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003659 CONFIG_SPL_LIBDISK_SUPPORT
3660 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003661
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003662 CONFIG_SPL_I2C_SUPPORT
3663 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003664
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003665 CONFIG_SPL_GPIO_SUPPORT
3666 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003667
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003668 CONFIG_SPL_MMC_SUPPORT
3669 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003670
Tom Rini95579792012-02-14 07:29:40 +00003671 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3672 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003673 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003674 when the MMC is being used in raw mode.
3675
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003676 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3677 Partition on the MMC to load U-Boot from when the MMC is being
3678 used in raw mode
3679
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003680 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3681 Sector to load kernel uImage from when MMC is being
3682 used in raw mode (for Falcon mode)
3683
3684 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3685 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3686 Sector and number of sectors to load kernel argument
3687 parameters from when MMC is being used in raw mode
3688 (for falcon mode)
3689
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003690 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3691 Partition on the MMC to load U-Boot from when the MMC is being
3692 used in fs mode
3693
Tom Rini95579792012-02-14 07:29:40 +00003694 CONFIG_SPL_FAT_SUPPORT
3695 Support for fs/fat/libfat.o in SPL binary
3696
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003697 CONFIG_SPL_EXT_SUPPORT
3698 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003699
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003700 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3701 Filename to read to load U-Boot when reading from filesystem
3702
3703 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003704 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003705 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003706
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003707 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003708 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003709 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003710
Scott Wood06f60ae2012-12-06 13:33:17 +00003711 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3712 Set this for NAND SPL on PPC mpc83xx targets, so that
3713 start.S waits for the rest of the SPL to load before
3714 continuing (the hardware starts execution after just
3715 loading the first page rather than the full 4K).
3716
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303717 CONFIG_SPL_SKIP_RELOCATE
3718 Avoid SPL relocation
3719
Scott Wood6f2f01b2012-09-20 19:09:07 -05003720 CONFIG_SPL_NAND_BASE
3721 Include nand_base.c in the SPL. Requires
3722 CONFIG_SPL_NAND_DRIVERS.
3723
3724 CONFIG_SPL_NAND_DRIVERS
3725 SPL uses normal NAND drivers, not minimal drivers.
3726
3727 CONFIG_SPL_NAND_ECC
3728 Include standard software ECC in the SPL
3729
Tom Rini95579792012-02-14 07:29:40 +00003730 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003731 Support for NAND boot using simple NAND drivers that
3732 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003733
Tom Rini6dd3b562014-03-28 12:03:36 -04003734 CONFIG_SPL_MTD_SUPPORT
3735 Support for the MTD subsystem within SPL. Useful for
3736 environment on NAND support within SPL.
3737
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003738 CONFIG_SPL_NAND_RAW_ONLY
3739 Support to boot only raw u-boot.bin images. Use this only
3740 if you need to save space.
3741
Ying Zhangbb0dc102013-08-16 15:16:11 +08003742 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3743 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003744 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003745
Ying Zhang7c8eea52013-08-16 15:16:12 +08003746 CONFIG_SPL_COMMON_INIT_DDR
3747 Set for common ddr init with serial presence detect in
3748 SPL binary.
3749
Tom Rini95579792012-02-14 07:29:40 +00003750 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3751 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3752 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3753 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3754 CONFIG_SYS_NAND_ECCBYTES
3755 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003756 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003757
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303758 CONFIG_SPL_NAND_BOOT
3759 Add support NAND boot
3760
Tom Rini95579792012-02-14 07:29:40 +00003761 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003762 Location in NAND to read U-Boot from
3763
3764 CONFIG_SYS_NAND_U_BOOT_DST
3765 Location in memory to load U-Boot to
3766
3767 CONFIG_SYS_NAND_U_BOOT_SIZE
3768 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003769
3770 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003771 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003772
3773 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3774 Define this if you need to first read the OOB and then the
3775 data. This is used for example on davinci plattforms.
3776
3777 CONFIG_SPL_OMAP3_ID_NAND
3778 Support for an OMAP3-specific set of functions to return the
3779 ID and MFR of the first attached NAND chip, if present.
3780
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003781 CONFIG_SPL_SERIAL_SUPPORT
3782 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003783
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003784 CONFIG_SPL_SPI_FLASH_SUPPORT
3785 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003786
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003787 CONFIG_SPL_SPI_SUPPORT
3788 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003789
Pavel Machekc57b9532012-08-30 22:42:11 +02003790 CONFIG_SPL_RAM_DEVICE
3791 Support for running image already present in ram, in SPL binary
3792
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003793 CONFIG_SPL_LIBGENERIC_SUPPORT
3794 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003795
Ying Zhangba1bee42013-05-20 14:07:25 +08003796 CONFIG_SPL_ENV_SUPPORT
3797 Support for the environment operating in SPL binary
3798
3799 CONFIG_SPL_NET_SUPPORT
3800 Support for the net/libnet.o in SPL binary.
3801 It conflicts with SPL env from storage medium specified by
3802 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3803
Scott Wood74752ba2012-12-06 13:33:16 +00003804 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003805 Image offset to which the SPL should be padded before appending
3806 the SPL payload. By default, this is defined as
3807 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3808 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3809 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003810
Scott Woodca2fca22012-09-21 16:27:32 -05003811 CONFIG_SPL_TARGET
3812 Final target image containing SPL and payload. Some SPLs
3813 use an arch-specific makefile fragment instead, for
3814 example if more than one image needs to be produced.
3815
Simon Glass87ebee32013-05-08 08:05:59 +00003816 CONFIG_FIT_SPL_PRINT
3817 Printing information about a FIT image adds quite a bit of
3818 code to SPL. So this is normally disabled in SPL. Use this
3819 option to re-enable it. This will affect the output of the
3820 bootm command when booting a FIT image.
3821
Ying Zhang3aa29de2013-08-16 15:16:15 +08003822- TPL framework
3823 CONFIG_TPL
3824 Enable building of TPL globally.
3825
3826 CONFIG_TPL_PAD_TO
3827 Image offset to which the TPL should be padded before appending
3828 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003829 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3830 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3831 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003832
wdenkc6097192002-11-03 00:24:07 +00003833Modem Support:
3834--------------
3835
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003836[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003837
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003838- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003839 CONFIG_MODEM_SUPPORT
3840
3841- RTS/CTS Flow control enable:
3842 CONFIG_HWFLOW
3843
3844- Modem debug support:
3845 CONFIG_MODEM_SUPPORT_DEBUG
3846
wdenk43d96162003-03-06 00:02:04 +00003847 Enables debugging stuff (char screen[1024], dbg())
3848 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003849
wdenka8c7c702003-12-06 19:49:23 +00003850- Interrupt support (PPC):
3851
wdenkd4ca31c2004-01-02 14:00:00 +00003852 There are common interrupt_init() and timer_interrupt()
3853 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003854 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003855 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003856 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003857 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003858 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003859 specific handling. If board has watchdog / status_led
3860 / other_activity_monitor it works automatically from
3861 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003862
wdenkc6097192002-11-03 00:24:07 +00003863- General:
3864
wdenk43d96162003-03-06 00:02:04 +00003865 In the target system modem support is enabled when a
3866 specific key (key combination) is pressed during
3867 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003868 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003869 board_init(). Currently key_pressed() is a dummy
3870 function, returning 1 and thus enabling modem
3871 initialization.
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk43d96162003-03-06 00:02:04 +00003873 If there are no modem init strings in the
3874 environment, U-Boot proceed to autoboot; the
3875 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003876 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003877
3878 See also: doc/README.Modem
3879
Helmut Raiger9660e442011-10-20 04:19:47 +00003880Board initialization settings:
3881------------------------------
3882
3883During Initialization u-boot calls a number of board specific functions
3884to allow the preparation of board specific prerequisites, e.g. pin setup
3885before drivers are initialized. To enable these callbacks the
3886following configuration macros have to be defined. Currently this is
3887architecture specific, so please check arch/your_architecture/lib/board.c
3888typically in board_init_f() and board_init_r().
3889
3890- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3891- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3892- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3893- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003894
wdenkc6097192002-11-03 00:24:07 +00003895Configuration Settings:
3896-----------------------
3897
York Sun4d1fd7f2014-02-26 17:03:19 -08003898- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3899 Optionally it can be defined to support 64-bit memory commands.
3900
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003901- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003902 undefine this when you're short of memory.
3903
Peter Tyser2fb26042009-01-27 18:03:12 -06003904- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3905 width of the commands listed in the 'help' command output.
3906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003908 prompt for user input.
3909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003910- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003912- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003917 the application (usually a Linux kernel) when it is
3918 booted
3919
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003920- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003921 List of legal baudrate settings for this board.
3922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003923- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003924 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003927 If the board specific function
3928 extern int overwrite_console (void);
3929 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003930 serial port, else the settings in the environment are used.
3931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003932- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003933 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003935- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003936 Enable overwrite of previous console environment settings.
3937
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003938- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003939 Begin and End addresses of the area used by the
3940 simple memory test.
3941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003942- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003943 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003944
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003945- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003946 Scratch address used by the alternate memory test
3947 You only need to set this if address zero isn't writeable
3948
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003949- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3950 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003951 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003952 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003953 fixing up gd->ram_size the Linux kernel should gets passed
3954 the now "corrected" memory size and won't touch it either.
3955 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003956 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003957 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003958 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003959
3960 This option can be used as a workaround for the 440EPx/GRx
3961 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3962 be touched.
3963
3964 WARNING: Please make sure that this value is a multiple of
3965 the Linux page size (normally 4k). If this is not the case,
3966 then the end address of the Linux memory will be located at a
3967 non page size aligned address and this could cause major
3968 problems.
3969
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003970- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003971 Enable temporary baudrate change while serial download
3972
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003973- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003974 Physical start address of SDRAM. _Must_ be 0 here.
3975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003976- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003977 Physical start address of Motherboard I/O (if using a
3978 Cogent motherboard)
3979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003980- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003981 Physical start address of Flash memory.
3982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003983- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003984 Physical start address of boot monitor code (set by
3985 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003986 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003987 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003989- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003990 Size of memory reserved for monitor code, used to
3991 determine _at_compile_time_ (!) if the environment is
3992 embedded within the U-Boot image, or in a separate
3993 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003995- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003996 Size of DRAM reserved for malloc() use.
3997
Simon Glassd59476b2014-07-10 22:23:28 -06003998- CONFIG_SYS_MALLOC_F_LEN
3999 Size of the malloc() pool for use before relocation. If
4000 this is defined, then a very simple malloc() implementation
4001 will become available before relocation. The address is just
4002 below the global data, and the stack is moved down to make
4003 space.
4004
4005 This feature allocates regions with increasing addresses
4006 within the region. calloc() is supported, but realloc()
4007 is not available. free() is supported but does nothing.
4008 The memory will be freed (or in fact just forgotton) when
4009 U-Boot relocates itself.
4010
Simon Glasse7b14e92014-09-15 06:33:18 -06004011 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06004012 at present but is fairly easy to enable for other archs.
4013
Simon Glass38687ae2014-11-10 17:16:54 -07004014- CONFIG_SYS_MALLOC_SIMPLE
4015 Provides a simple and small malloc() and calloc() for those
4016 boards which do not use the full malloc in SPL (which is
4017 enabled with CONFIG_SYS_SPL_MALLOC_START).
4018
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07004019- CONFIG_SYS_NONCACHED_MEMORY:
4020 Size of non-cached memory area. This area of memory will be
4021 typically located right below the malloc() area and mapped
4022 uncached in the MMU. This is useful for drivers that would
4023 otherwise require a lot of explicit cache maintenance. For
4024 some drivers it's also impossible to properly maintain the
4025 cache. For example if the regions that need to be flushed
4026 are not a multiple of the cache-line size, *and* padding
4027 cannot be allocated between the regions to align them (i.e.
4028 if the HW requires a contiguous array of regions, and the
4029 size of each region is not cache-aligned), then a flush of
4030 one region may result in overwriting data that hardware has
4031 written to another region in the same cache-line. This can
4032 happen for example in network drivers where descriptors for
4033 buffers are typically smaller than the CPU cache-line (e.g.
4034 16 bytes vs. 32 or 64 bytes).
4035
4036 Non-cached memory is only supported on 32-bit ARM at present.
4037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01004039 Normally compressed uImages are limited to an
4040 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004041 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01004042 to adjust this setting to your needs.
4043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004044- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004045 Maximum size of memory mapped by the startup code of
4046 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004047 the Linux kernel (bd_info, boot arguments, FDT blob if
4048 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004049 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004050 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004051 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004052 variable "bootm_mapsize" will override the value of
4053 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4054 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004055
John Rigbyfca43cc2010-10-13 13:57:35 -06004056- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4057 Enable initrd_high functionality. If defined then the
4058 initrd_high feature is enabled and the bootm ramdisk subcommand
4059 is enabled.
4060
4061- CONFIG_SYS_BOOT_GET_CMDLINE:
4062 Enables allocating and saving kernel cmdline in space between
4063 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4064
4065- CONFIG_SYS_BOOT_GET_KBD:
4066 Enables allocating and saving a kernel copy of the bd_info in
4067 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004069- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004070 Max number of Flash memory banks
4071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004073 Max number of sectors on a Flash chip
4074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004075- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004076 Timeout for Flash erase operations (in ms)
4077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004078- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004079 Timeout for Flash write operations (in ms)
4080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004081- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004082 Timeout for Flash set sector lock bit operation (in ms)
4083
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004084- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004085 Timeout for Flash clear lock bits operation (in ms)
4086
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004087- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004088 If defined, hardware flash sectors protection is used
4089 instead of U-Boot software protection.
4090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004091- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004092
4093 Enable TFTP transfers directly to flash memory;
4094 without this option such a download has to be
4095 performed in two steps: (1) download to RAM, and (2)
4096 copy from RAM to flash.
4097
4098 The two-step approach is usually more reliable, since
4099 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004100 the flash, but in some situations (when system RAM is
4101 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004102 downloaded image) this option may be very useful.
4103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004104- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004105 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004106 common flash structure for storing flash geometry.
4107
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004108- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004109 This option also enables the building of the cfi_flash driver
4110 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004111
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004112- CONFIG_FLASH_CFI_MTD
4113 This option enables the building of the cfi_mtd driver
4114 in the drivers directory. The driver exports CFI flash
4115 to the MTD layer.
4116
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004117- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004118 Use buffered writes to flash.
4119
4120- CONFIG_FLASH_SPANSION_S29WS_N
4121 s29ws-n MirrorBit flash has non-standard addresses for buffered
4122 write commands.
4123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004124- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004125 If this option is defined, the common CFI flash doesn't
4126 print it's warning upon not recognized FLASH banks. This
4127 is useful, if some of the configured banks are only
4128 optionally available.
4129
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004130- CONFIG_FLASH_SHOW_PROGRESS
4131 If defined (must be an integer), print out countdown
4132 digits and dots. Recommended value: 45 (9..1) for 80
4133 column displays, 15 (3..1) for 40 column displays.
4134
Stefan Roese352ef3f2013-04-04 15:53:14 +02004135- CONFIG_FLASH_VERIFY
4136 If defined, the content of the flash (destination) is compared
4137 against the source after the write operation. An error message
4138 will be printed when the contents are not identical.
4139 Please note that this option is useless in nearly all cases,
4140 since such flash programming errors usually are detected earlier
4141 while unprotecting/erasing/programming. Please only enable
4142 this option if you really know what you are doing.
4143
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004144- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004145 Defines the number of Ethernet receive buffers. On some
4146 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004147 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4148 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004149 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004150 Defaults to 4 if not defined.
4151
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004152- CONFIG_ENV_MAX_ENTRIES
4153
Wolfgang Denk071bc922010-10-27 22:48:30 +02004154 Maximum number of entries in the hash table that is used
4155 internally to store the environment settings. The default
4156 setting is supposed to be generous and should work in most
4157 cases. This setting can be used to tune behaviour; see
4158 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004159
Joe Hershberger25980902012-12-11 22:16:31 -06004160- CONFIG_ENV_FLAGS_LIST_DEFAULT
4161- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004162 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004163 calling env set. Variables can be restricted to only decimal,
4164 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4165 the variables can also be restricted to IP address or MAC address.
4166
4167 The format of the list is:
4168 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06004169 access_atribute = [a|r|o|c]
4170 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004171 entry = variable_name[:attributes]
4172 list = entry[,list]
4173
4174 The type attributes are:
4175 s - String (default)
4176 d - Decimal
4177 x - Hexadecimal
4178 b - Boolean ([1yYtT|0nNfF])
4179 i - IP address
4180 m - MAC address
4181
Joe Hershberger267541f2012-12-11 22:16:34 -06004182 The access attributes are:
4183 a - Any (default)
4184 r - Read-only
4185 o - Write-once
4186 c - Change-default
4187
Joe Hershberger25980902012-12-11 22:16:31 -06004188 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4189 Define this to a list (string) to define the ".flags"
4190 envirnoment variable in the default or embedded environment.
4191
4192 - CONFIG_ENV_FLAGS_LIST_STATIC
4193 Define this to a list (string) to define validation that
4194 should be done if an entry is not found in the ".flags"
4195 environment variable. To override a setting in the static
4196 list, simply add an entry for the same variable name to the
4197 ".flags" variable.
4198
Joe Hershberger267541f2012-12-11 22:16:34 -06004199- CONFIG_ENV_ACCESS_IGNORE_FORCE
4200 If defined, don't allow the -f switch to env set override variable
4201 access flags.
4202
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004203- CONFIG_SYS_GENERIC_BOARD
4204 This selects the architecture-generic board system instead of the
4205 architecture-specific board files. It is intended to move boards
4206 to this new framework over time. Defining this will disable the
4207 arch/foo/lib/board.c file and use common/board_f.c and
4208 common/board_r.c instead. To use this option your architecture
4209 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4210 its config.mk file). If you find problems enabling this option on
4211 your board please report the problem and send patches!
4212
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004213- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4214 This is set by OMAP boards for the max time that reset should
4215 be asserted. See doc/README.omap-reset-time for details on how
4216 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004217
Gabe Black0d296cc2014-10-15 04:38:30 -06004218- CONFIG_USE_STDINT
4219 If stdint.h is available with your toolchain you can define this
4220 option to enable it. You can provide option 'USE_STDINT=1' when
4221 building U-Boot to enable this.
4222
wdenkc6097192002-11-03 00:24:07 +00004223The following definitions that deal with the placement and management
4224of environment data (variable area); in general, we support the
4225following configurations:
4226
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004227- CONFIG_BUILD_ENVCRC:
4228
4229 Builds up envcrc with the target environment so that external utils
4230 may easily extract it and embed it in final U-Boot images.
4231
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004232- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004233
4234 Define this if the environment is in flash memory.
4235
4236 a) The environment occupies one whole flash sector, which is
4237 "embedded" in the text segment with the U-Boot code. This
4238 happens usually with "bottom boot sector" or "top boot
4239 sector" type flash chips, which have several smaller
4240 sectors at the start or the end. For instance, such a
4241 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4242 such a case you would place the environment in one of the
4243 4 kB sectors - with U-Boot code before and after it. With
4244 "top boot sector" type flash chips, you would put the
4245 environment in one of the last sectors, leaving a gap
4246 between U-Boot and the environment.
4247
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004248 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004249
4250 Offset of environment data (variable area) to the
4251 beginning of flash memory; for instance, with bottom boot
4252 type flash chips the second sector can be used: the offset
4253 for this sector is given here.
4254
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004255 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004256
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004257 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004258
4259 This is just another way to specify the start address of
4260 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004261 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004262
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004263 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004264
4265 Size of the sector containing the environment.
4266
4267
4268 b) Sometimes flash chips have few, equal sized, BIG sectors.
4269 In such a case you don't want to spend a whole sector for
4270 the environment.
4271
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004272 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004273
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004274 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004275 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004276 of this flash sector for the environment. This saves
4277 memory for the RAM copy of the environment.
4278
4279 It may also save flash memory if you decide to use this
4280 when your environment is "embedded" within U-Boot code,
4281 since then the remainder of the flash sector could be used
4282 for U-Boot code. It should be pointed out that this is
4283 STRONGLY DISCOURAGED from a robustness point of view:
4284 updating the environment in flash makes it always
4285 necessary to erase the WHOLE sector. If something goes
4286 wrong before the contents has been restored from a copy in
4287 RAM, your target system will be dead.
4288
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004289 - CONFIG_ENV_ADDR_REDUND
4290 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk43d96162003-03-06 00:02:04 +00004292 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004293 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004294 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004295 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004296
4297BE CAREFUL! Any changes to the flash layout, and some changes to the
4298source code will make it necessary to adapt <board>/u-boot.lds*
4299accordingly!
4300
4301
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004302- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004303
4304 Define this if you have some non-volatile memory device
4305 (NVRAM, battery buffered SRAM) which you want to use for the
4306 environment.
4307
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004308 - CONFIG_ENV_ADDR:
4309 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004310
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004311 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004312 want to use for environment. It is assumed that this memory
4313 can just be read and written to, without any special
4314 provision.
4315
4316BE CAREFUL! The first access to the environment happens quite early
4317in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004318console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004319U-Boot will hang.
4320
4321Please note that even with NVRAM we still use a copy of the
4322environment in RAM: we could work on NVRAM directly, but we want to
4323keep settings there always unmodified except somebody uses "saveenv"
4324to save the current settings.
4325
4326
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004327- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004328
4329 Use this if you have an EEPROM or similar serial access
4330 device and a driver for it.
4331
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004332 - CONFIG_ENV_OFFSET:
4333 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004334
4335 These two #defines specify the offset and size of the
4336 environment area within the total memory of your EEPROM.
4337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004338 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004339 If defined, specified the chip address of the EEPROM device.
4340 The default address is zero.
4341
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004342 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004343 If defined, the number of bits used to address bytes in a
4344 single page in the EEPROM device. A 64 byte page, for example
4345 would require six bits.
4346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004347 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004348 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004349 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004351 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004352 The length in bytes of the EEPROM memory array address. Note
4353 that this is NOT the chip address length!
4354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004355 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004356 EEPROM chips that implement "address overflow" are ones
4357 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4358 address and the extra bits end up in the "chip address" bit
4359 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4360 byte chips.
4361
4362 Note that we consider the length of the address field to
4363 still be one byte because the extra address bits are hidden
4364 in the chip address.
4365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004366 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004367 The size in bytes of the EEPROM device.
4368
Heiko Schocher548738b2010-01-07 08:55:40 +01004369 - CONFIG_ENV_EEPROM_IS_ON_I2C
4370 define this, if you have I2C and SPI activated, and your
4371 EEPROM, which holds the environment, is on the I2C bus.
4372
4373 - CONFIG_I2C_ENV_EEPROM_BUS
4374 if you have an Environment on an EEPROM reached over
4375 I2C muxes, you can define here, how to reach this
4376 EEPROM. For example:
4377
Heiko Schocherea818db2013-01-29 08:53:15 +01004378 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004379
4380 EEPROM which holds the environment, is reached over
4381 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004382
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004383- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004384
wdenkd4ca31c2004-01-02 14:00:00 +00004385 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004386 want to use for the environment.
4387
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004388 - CONFIG_ENV_OFFSET:
4389 - CONFIG_ENV_ADDR:
4390 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004391
4392 These three #defines specify the offset and size of the
4393 environment area within the total memory of your DataFlash placed
4394 at the specified address.
4395
Wu, Joshbd83b592014-07-01 19:30:13 +08004396- CONFIG_ENV_IS_IN_SPI_FLASH:
4397
4398 Define this if you have a SPI Flash memory device which you
4399 want to use for the environment.
4400
4401 - CONFIG_ENV_OFFSET:
4402 - CONFIG_ENV_SIZE:
4403
4404 These two #defines specify the offset and size of the
4405 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4406 aligned to an erase sector boundary.
4407
4408 - CONFIG_ENV_SECT_SIZE:
4409
4410 Define the SPI flash's sector size.
4411
4412 - CONFIG_ENV_OFFSET_REDUND (optional):
4413
4414 This setting describes a second storage area of CONFIG_ENV_SIZE
4415 size used to hold a redundant copy of the environment data, so
4416 that there is a valid backup copy in case there is a power failure
4417 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4418 aligned to an erase sector boundary.
4419
4420 - CONFIG_ENV_SPI_BUS (optional):
4421 - CONFIG_ENV_SPI_CS (optional):
4422
4423 Define the SPI bus and chip select. If not defined they will be 0.
4424
4425 - CONFIG_ENV_SPI_MAX_HZ (optional):
4426
4427 Define the SPI max work clock. If not defined then use 1MHz.
4428
4429 - CONFIG_ENV_SPI_MODE (optional):
4430
4431 Define the SPI work mode. If not defined then use SPI_MODE_3.
4432
Liu Gang0a85a9e2012-03-08 00:33:20 +00004433- CONFIG_ENV_IS_IN_REMOTE:
4434
4435 Define this if you have a remote memory space which you
4436 want to use for the local device's environment.
4437
4438 - CONFIG_ENV_ADDR:
4439 - CONFIG_ENV_SIZE:
4440
4441 These two #defines specify the address and size of the
4442 environment area within the remote memory space. The
4443 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004444 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004445
4446BE CAREFUL! For some special cases, the local device can not use
4447"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004448environment stored in a remote NOR flash by SRIO or PCIE link,
4449but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004450
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004451- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004452
4453 Define this if you have a NAND device which you want to use
4454 for the environment.
4455
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004456 - CONFIG_ENV_OFFSET:
4457 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004458
4459 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004460 area within the first NAND device. CONFIG_ENV_OFFSET must be
4461 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004462
Scott Woodfdd813d2010-09-17 14:38:37 -05004463 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004464
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004465 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004466 size used to hold a redundant copy of the environment data, so
4467 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004468 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004469 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004470
Scott Woodfdd813d2010-09-17 14:38:37 -05004471 - CONFIG_ENV_RANGE (optional):
4472
4473 Specifies the length of the region in which the environment
4474 can be written. This should be a multiple of the NAND device's
4475 block size. Specifying a range with more erase blocks than
4476 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4477 the range to be avoided.
4478
4479 - CONFIG_ENV_OFFSET_OOB (optional):
4480
4481 Enables support for dynamically retrieving the offset of the
4482 environment from block zero's out-of-band data. The
4483 "nand env.oob" command can be used to record this offset.
4484 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4485 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004486
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004487- CONFIG_NAND_ENV_DST
4488
4489 Defines address in RAM to which the nand_spl code should copy the
4490 environment. If redundant environment is used, it will be copied to
4491 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4492
Joe Hershberger2b744332013-04-08 10:32:51 +00004493- CONFIG_ENV_IS_IN_UBI:
4494
4495 Define this if you have an UBI volume that you want to use for the
4496 environment. This has the benefit of wear-leveling the environment
4497 accesses, which is important on NAND.
4498
4499 - CONFIG_ENV_UBI_PART:
4500
4501 Define this to a string that is the mtd partition containing the UBI.
4502
4503 - CONFIG_ENV_UBI_VOLUME:
4504
4505 Define this to the name of the volume that you want to store the
4506 environment in.
4507
Joe Hershberger785881f2013-04-08 10:32:52 +00004508 - CONFIG_ENV_UBI_VOLUME_REDUND:
4509
4510 Define this to the name of another volume to store a second copy of
4511 the environment in. This will enable redundant environments in UBI.
4512 It is assumed that both volumes are in the same MTD partition.
4513
Joe Hershberger2b744332013-04-08 10:32:51 +00004514 - CONFIG_UBI_SILENCE_MSG
4515 - CONFIG_UBIFS_SILENCE_MSG
4516
4517 You will probably want to define these to avoid a really noisy system
4518 when storing the env in UBI.
4519
Wu, Joshd1db76f2014-06-24 17:31:03 +08004520- CONFIG_ENV_IS_IN_FAT:
4521 Define this if you want to use the FAT file system for the environment.
4522
4523 - FAT_ENV_INTERFACE:
4524
4525 Define this to a string that is the name of the block device.
4526
4527 - FAT_ENV_DEV_AND_PART:
4528
4529 Define this to a string to specify the partition of the device. It can
4530 be as following:
4531
4532 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4533 - "D:P": device D partition P. Error occurs if device D has no
4534 partition table.
4535 - "D:0": device D.
4536 - "D" or "D:": device D partition 1 if device D has partition
4537 table, or the whole device D if has no partition
4538 table.
4539 - "D:auto": first partition in device D with bootable flag set.
4540 If none, first valid paratition in device D. If no
4541 partition table then means device D.
4542
4543 - FAT_ENV_FILE:
4544
4545 It's a string of the FAT file name. This file use to store the
4546 envrionment.
4547
4548 - CONFIG_FAT_WRITE:
4549 This should be defined. Otherwise it cannot save the envrionment file.
4550
Stephen Warren06e4ae52013-06-11 15:14:00 -06004551- CONFIG_ENV_IS_IN_MMC:
4552
4553 Define this if you have an MMC device which you want to use for the
4554 environment.
4555
4556 - CONFIG_SYS_MMC_ENV_DEV:
4557
4558 Specifies which MMC device the environment is stored in.
4559
4560 - CONFIG_SYS_MMC_ENV_PART (optional):
4561
4562 Specifies which MMC partition the environment is stored in. If not
4563 set, defaults to partition 0, the user area. Common values might be
4564 1 (first MMC boot partition), 2 (second MMC boot partition).
4565
4566 - CONFIG_ENV_OFFSET:
4567 - CONFIG_ENV_SIZE:
4568
4569 These two #defines specify the offset and size of the environment
4570 area within the specified MMC device.
4571
Stephen Warren5c088ee2013-06-11 15:14:02 -06004572 If offset is positive (the usual case), it is treated as relative to
4573 the start of the MMC partition. If offset is negative, it is treated
4574 as relative to the end of the MMC partition. This can be useful if
4575 your board may be fitted with different MMC devices, which have
4576 different sizes for the MMC partitions, and you always want the
4577 environment placed at the very end of the partition, to leave the
4578 maximum possible space before it, to store other data.
4579
Stephen Warren06e4ae52013-06-11 15:14:00 -06004580 These two values are in units of bytes, but must be aligned to an
4581 MMC sector boundary.
4582
4583 - CONFIG_ENV_OFFSET_REDUND (optional):
4584
4585 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4586 hold a redundant copy of the environment data. This provides a
4587 valid backup copy in case the other copy is corrupted, e.g. due
4588 to a power failure during a "saveenv" operation.
4589
Stephen Warren5c088ee2013-06-11 15:14:02 -06004590 This value may also be positive or negative; this is handled in the
4591 same way as CONFIG_ENV_OFFSET.
4592
Stephen Warren06e4ae52013-06-11 15:14:00 -06004593 This value is also in units of bytes, but must also be aligned to
4594 an MMC sector boundary.
4595
4596 - CONFIG_ENV_SIZE_REDUND (optional):
4597
4598 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4599 set. If this value is set, it must be set to the same value as
4600 CONFIG_ENV_SIZE.
4601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004602- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004603
4604 Defines offset to the initial SPI buffer area in DPRAM. The
4605 area is used at an early stage (ROM part) if the environment
4606 is configured to reside in the SPI EEPROM: We need a 520 byte
4607 scratch DPRAM area. It is used between the two initialization
4608 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4609 to be a good choice since it makes it far enough from the
4610 start of the data area as well as from the stack pointer.
4611
Bruce Adlere881cb52007-11-02 13:15:42 -07004612Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004613has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004614created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004615until then to read environment variables.
4616
wdenk85ec0bc2003-03-31 16:34:49 +00004617The environment is protected by a CRC32 checksum. Before the monitor
4618is relocated into RAM, as a result of a bad CRC you will be working
4619with the compiled-in default environment - *silently*!!! [This is
4620necessary, because the first environment variable we need is the
4621"baudrate" setting for the console - if we have a bad CRC, we don't
4622have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004623
4624Note: once the monitor has been relocated, then it will complain if
4625the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004626use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004628- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004629 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004631 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004632 also needs to be defined.
4633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004634- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004635 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004636
Ron Madridf5675aa2009-02-18 14:30:44 -08004637- CONFIG_NS16550_MIN_FUNCTIONS:
4638 Define this if you desire to only have use of the NS16550_init
4639 and NS16550_putc functions for the serial driver located at
4640 drivers/serial/ns16550.c. This option is useful for saving
4641 space for already greatly restricted images, including but not
4642 limited to NAND_SPL configurations.
4643
Simon Glassb2b92f52012-11-30 13:01:18 +00004644- CONFIG_DISPLAY_BOARDINFO
4645 Display information about the board that U-Boot is running on
4646 when U-Boot starts up. The board function checkboard() is called
4647 to do this.
4648
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004649- CONFIG_DISPLAY_BOARDINFO_LATE
4650 Similar to the previous option, but display this information
4651 later, once stdio is running and output goes to the LCD, if
4652 present.
4653
Sascha Silbefeb85802013-08-11 16:40:43 +02004654- CONFIG_BOARD_SIZE_LIMIT:
4655 Maximum size of the U-Boot image. When defined, the
4656 build system checks that the actual size does not
4657 exceed it.
4658
wdenkc6097192002-11-03 00:24:07 +00004659Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004660---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004662- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004663 Cache Line Size of the CPU.
4664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004665- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004666 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004667
wdenk42d1f032003-10-15 23:53:47 +00004668 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4669 and RPXsuper) to be able to adjust the position of
4670 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004671
Timur Tabie46fedf2011-08-04 18:03:41 -05004672- CONFIG_SYS_CCSRBAR_DEFAULT:
4673 Default (power-on reset) physical address of CCSR on Freescale
4674 PowerPC SOCs.
4675
4676- CONFIG_SYS_CCSRBAR:
4677 Virtual address of CCSR. On a 32-bit build, this is typically
4678 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4679
4680 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4681 for cross-platform code that uses that macro instead.
4682
4683- CONFIG_SYS_CCSRBAR_PHYS:
4684 Physical address of CCSR. CCSR can be relocated to a new
4685 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004686 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004687 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4688 is typically relocated on 36-bit builds. It is recommended
4689 that this macro be defined via the _HIGH and _LOW macros:
4690
4691 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4692 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4693
4694- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004695 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4696 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004697 used in assembly code, so it must not contain typecasts or
4698 integer size suffixes (e.g. "ULL").
4699
4700- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4701 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4702 used in assembly code, so it must not contain typecasts or
4703 integer size suffixes (e.g. "ULL").
4704
4705- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4706 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4707 forced to a value that ensures that CCSR is not relocated.
4708
wdenk7f6c2cb2002-11-10 22:06:23 +00004709- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004710 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004711
4712 the default drive number (default value 0)
4713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004714 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004715
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004716 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004717 (default value 1)
4718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004720
wdenk43d96162003-03-06 00:02:04 +00004721 defines the offset of register from address. It
4722 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004723 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004725 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4726 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004727 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004729 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004730 fdc_hw_init() is called at the beginning of the FDC
4731 setup. fdc_hw_init() must be provided by the board
4732 source code. It is used to make hardware dependant
4733 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004734
Macpaul Lin0abddf82011-04-11 20:45:32 +00004735- CONFIG_IDE_AHB:
4736 Most IDE controllers were designed to be connected with PCI
4737 interface. Only few of them were designed for AHB interface.
4738 When software is doing ATA command and data transfer to
4739 IDE devices through IDE-AHB controller, some additional
4740 registers accessing to these kind of IDE-AHB controller
4741 is requierd.
4742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004743- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004744 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004745 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004747- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk7152b1d2003-09-05 23:19:14 +00004749 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004750 initial data and stack; please note that this must be
4751 writable memory that is working WITHOUT special
4752 initialization, i. e. you CANNOT use normal RAM which
4753 will become available only after programming the
4754 memory controller and running certain initialization
4755 sequences.
4756
4757 U-Boot uses the following memory types:
4758 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4759 - MPC824X: data cache
4760 - PPC4xx: data cache
4761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004762- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004763
4764 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004765 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4766 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004767 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004768 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004769 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4770 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4771 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004772
4773 Note:
4774 On the MPC824X (or other systems that use the data
4775 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004776 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004777 point to an otherwise UNUSED address space between
4778 the top of RAM and the start of the PCI space.
4779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004780- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004782- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004784- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004786- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004788- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004790- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004792- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004793 SDRAM timing
4794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004795- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004796 periodic timer for refresh
4797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004798- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004800- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4801 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4802 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4803 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004804 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4805
4806- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004807 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4808 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004809 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004811- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4812 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004813 Machine Mode Register and Memory Periodic Timer
4814 Prescaler definitions (SDRAM timing)
4815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004816- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004817 enable I2C microcode relocation patch (MPC8xx);
4818 define relocation offset in DPRAM [DSP2]
4819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004820- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004821 enable SMC microcode relocation patch (MPC8xx);
4822 define relocation offset in DPRAM [SMC1]
4823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004824- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004825 enable SPI microcode relocation patch (MPC8xx);
4826 define relocation offset in DPRAM [SCC4]
4827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004828- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004829 Use OSCM clock mode on MBX8xx board. Be careful,
4830 wrong setting might damage your board. Read
4831 doc/README.MBX before setting this variable!
4832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004833- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004834 Offset of the bootmode word in DPRAM used by post
4835 (Power On Self Tests). This definition overrides
4836 #define'd default value in commproc.h resp.
4837 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004839- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4840 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4841 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4842 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4843 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4844 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4845 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4846 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004847 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004848
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004849- CONFIG_PCI_DISABLE_PCIE:
4850 Disable PCI-Express on systems where it is supported but not
4851 required.
4852
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004853- CONFIG_PCI_ENUM_ONLY
4854 Only scan through and get the devices on the busses.
4855 Don't do any setup work, presumably because someone or
4856 something has already done it, and we don't need to do it
4857 a second time. Useful for platforms that are pre-booted
4858 by coreboot or similar.
4859
Gabor Juhos842033e2013-05-30 07:06:12 +00004860- CONFIG_PCI_INDIRECT_BRIDGE:
4861 Enable support for indirect PCI bridges.
4862
Kumar Galaa09b9b62010-12-30 12:09:53 -06004863- CONFIG_SYS_SRIO:
4864 Chip has SRIO or not
4865
4866- CONFIG_SRIO1:
4867 Board has SRIO 1 port available
4868
4869- CONFIG_SRIO2:
4870 Board has SRIO 2 port available
4871
Liu Gangc8b28152013-05-07 16:30:46 +08004872- CONFIG_SRIO_PCIE_BOOT_MASTER
4873 Board can support master function for Boot from SRIO and PCIE
4874
Kumar Galaa09b9b62010-12-30 12:09:53 -06004875- CONFIG_SYS_SRIOn_MEM_VIRT:
4876 Virtual Address of SRIO port 'n' memory region
4877
4878- CONFIG_SYS_SRIOn_MEM_PHYS:
4879 Physical Address of SRIO port 'n' memory region
4880
4881- CONFIG_SYS_SRIOn_MEM_SIZE:
4882 Size of SRIO port 'n' memory region
4883
Fabio Estevam66bd1842013-04-11 09:35:34 +00004884- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4885 Defined to tell the NAND controller that the NAND chip is using
4886 a 16 bit bus.
4887 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004888 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004889 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004890 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004891
4892- CONFIG_SYS_NDFC_EBC0_CFG
4893 Sets the EBC0_CFG register for the NDFC. If not defined
4894 a default value will be used.
4895
Ben Warrenbb99ad62006-09-07 16:50:54 -04004896- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004897 Get DDR timing information from an I2C EEPROM. Common
4898 with pluggable memory modules such as SODIMMs
4899
Ben Warrenbb99ad62006-09-07 16:50:54 -04004900 SPD_EEPROM_ADDRESS
4901 I2C address of the SPD EEPROM
4902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004903- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004904 If SPD EEPROM is on an I2C bus other than the first
4905 one, specify here. Note that the value must resolve
4906 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004907
York Sun1b3e3c42011-06-07 09:42:16 +08004908- CONFIG_SYS_DDR_RAW_TIMING
4909 Get DDR timing information from other than SPD. Common with
4910 soldered DDR chips onboard without SPD. DDR raw timing
4911 parameters are extracted from datasheet and hard-coded into
4912 header files or board specific files.
4913
York Sun6f5e1dc2011-09-16 13:21:35 -07004914- CONFIG_FSL_DDR_INTERACTIVE
4915 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004917- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004918 Only for 83xx systems. If specified, then DDR should
4919 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004920
wdenkc26e4542004-04-18 10:13:26 +00004921- CONFIG_ETHER_ON_FEC[12]
4922 Define to enable FEC[12] on a 8xx series processor.
4923
4924- CONFIG_FEC[12]_PHY
4925 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004926 to the given FEC; i. e.
4927 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004928 means that the PHY with address 4 is connected to FEC1
4929
4930 When set to -1, means to probe for first available.
4931
4932- CONFIG_FEC[12]_PHY_NORXERR
4933 The PHY does not have a RXERR line (RMII only).
4934 (so program the FEC to ignore it).
4935
4936- CONFIG_RMII
4937 Enable RMII mode for all FECs.
4938 Note that this is a global option, we can't
4939 have one FEC in standard MII mode and another in RMII mode.
4940
wdenk5cf91d62004-04-23 20:32:05 +00004941- CONFIG_CRC32_VERIFY
4942 Add a verify option to the crc32 command.
4943 The syntax is:
4944
4945 => crc32 -v <address> <count> <crc32>
4946
4947 Where address/count indicate a memory area
4948 and crc32 is the correct crc32 which the
4949 area should have.
4950
wdenk56523f12004-07-11 17:40:54 +00004951- CONFIG_LOOPW
4952 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004953 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004954
stroese7b466642004-12-16 18:46:55 +00004955- CONFIG_MX_CYCLIC
4956 Add the "mdc" and "mwc" memory commands. These are cyclic
4957 "md/mw" commands.
4958 Examples:
4959
wdenkefe2a4d2004-12-16 21:44:03 +00004960 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004961 This command will print 4 bytes (10,11,12,13) each 500 ms.
4962
wdenkefe2a4d2004-12-16 21:44:03 +00004963 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004964 This command will write 12345678 to address 100 all 10 ms.
4965
wdenkefe2a4d2004-12-16 21:44:03 +00004966 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004967 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004968
wdenk8aa1a2d2005-04-04 12:44:11 +00004969- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004970 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004971 low level initializations (like setting up the memory
4972 controller) are omitted and/or U-Boot does not
4973 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004974
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004975 Normally this variable MUST NOT be defined. The only
4976 exception is when U-Boot is loaded (to RAM) by some
4977 other boot loader or by a debugger which performs
4978 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004979
Aneesh V401bb302011-07-13 05:11:07 +00004980- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004981 Modifies the behaviour of start.S when compiling a loader
4982 that is executed before the actual U-Boot. E.g. when
4983 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004984
Ying Zhang3aa29de2013-08-16 15:16:15 +08004985- CONFIG_TPL_BUILD
4986 Modifies the behaviour of start.S when compiling a loader
4987 that is executed after the SPL and before the actual U-Boot.
4988 It is loaded by the SPL.
4989
Ying Zhang5df572f2013-05-20 14:07:23 +08004990- CONFIG_SYS_MPC85XX_NO_RESETVEC
4991 Only for 85xx systems. If this variable is specified, the section
4992 .resetvec is not kept and the section .bootpg is placed in the
4993 previous 4k of the .text section.
4994
Simon Glass4213fc22013-02-24 17:33:14 +00004995- CONFIG_ARCH_MAP_SYSMEM
4996 Generally U-Boot (and in particular the md command) uses
4997 effective address. It is therefore not necessary to regard
4998 U-Boot address as virtual addresses that need to be translated
4999 to physical addresses. However, sandbox requires this, since
5000 it maintains its own little RAM buffer which contains all
5001 addressable memory. This option causes some memory accesses
5002 to be mapped through map_sysmem() / unmap_sysmem().
5003
Matthias Weisserd8834a12011-03-10 21:36:32 +00005004- CONFIG_USE_ARCH_MEMCPY
5005 CONFIG_USE_ARCH_MEMSET
5006 If these options are used a optimized version of memcpy/memset will
5007 be used if available. These functions may be faster under some
5008 conditions but may increase the binary size.
5009
Simon Glass588a13f2013-02-14 04:18:54 +00005010- CONFIG_X86_RESET_VECTOR
5011 If defined, the x86 reset vector code is included. This is not
5012 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00005013
Mark Jacksonfc337052013-03-04 01:27:20 +00005014- CONFIG_SYS_MPUCLK
5015 Defines the MPU clock speed (in MHz).
5016
5017 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00005018
Heiko Schocher16678eb2013-11-04 14:05:00 +01005019- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5020 Enables the RTC32K OSC on AM33xx based plattforms
5021
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04005022- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5023 Option to disable subpage write in NAND driver
5024 driver that uses this:
5025 drivers/mtd/nand/davinci_nand.c
5026
Timur Tabif2717b42011-11-22 09:21:25 -06005027Freescale QE/FMAN Firmware Support:
5028-----------------------------------
5029
5030The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5031loading of "firmware", which is encoded in the QE firmware binary format.
5032This firmware often needs to be loaded during U-Boot booting, so macros
5033are used to identify the storage device (NOR flash, SPI, etc) and the address
5034within that device.
5035
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005036- CONFIG_SYS_FMAN_FW_ADDR
5037 The address in the storage device where the FMAN microcode is located. The
5038 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5039 is also specified.
5040
5041- CONFIG_SYS_QE_FW_ADDR
5042 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005043 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5044 is also specified.
5045
5046- CONFIG_SYS_QE_FMAN_FW_LENGTH
5047 The maximum possible size of the firmware. The firmware binary format
5048 has a field that specifies the actual size of the firmware, but it
5049 might not be possible to read any part of the firmware unless some
5050 local storage is allocated to hold the entire firmware first.
5051
5052- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5053 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5054 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5055 virtual address in NOR flash.
5056
5057- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5058 Specifies that QE/FMAN firmware is located in NAND flash.
5059 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5060
5061- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5062 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5063 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5064
5065- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5066 Specifies that QE/FMAN firmware is located on the primary SPI
5067 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5068
Liu Gang292dc6c2012-03-08 00:33:18 +00005069- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5070 Specifies that QE/FMAN firmware is located in the remote (master)
5071 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005072 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5073 window->master inbound window->master LAW->the ucode address in
5074 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005075
J. German Riverab940ca62014-06-23 15:15:55 -07005076Freescale Layerscape Management Complex Firmware Support:
5077---------------------------------------------------------
5078The Freescale Layerscape Management Complex (MC) supports the loading of
5079"firmware".
5080This firmware often needs to be loaded during U-Boot booting, so macros
5081are used to identify the storage device (NOR flash, SPI, etc) and the address
5082within that device.
5083
5084- CONFIG_FSL_MC_ENET
5085 Enable the MC driver for Layerscape SoCs.
5086
5087- CONFIG_SYS_LS_MC_FW_ADDR
5088 The address in the storage device where the firmware is located. The
5089 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5090 is also specified.
5091
5092- CONFIG_SYS_LS_MC_FW_LENGTH
5093 The maximum possible size of the firmware. The firmware binary format
5094 has a field that specifies the actual size of the firmware, but it
5095 might not be possible to read any part of the firmware unless some
5096 local storage is allocated to hold the entire firmware first.
5097
5098- CONFIG_SYS_LS_MC_FW_IN_NOR
5099 Specifies that MC firmware is located in NOR flash, mapped as
5100 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5101 virtual address in NOR flash.
5102
wdenkc6097192002-11-03 00:24:07 +00005103Building the Software:
5104======================
5105
Wolfgang Denk218ca722008-03-26 10:40:12 +01005106Building U-Boot has been tested in several native build environments
5107and in many different cross environments. Of course we cannot support
5108all possibly existing versions of cross development tools in all
5109(potentially obsolete) versions. In case of tool chain problems we
5110recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5111which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005112
Wolfgang Denk218ca722008-03-26 10:40:12 +01005113If you are not using a native environment, it is assumed that you
5114have GNU cross compiling tools available in your path. In this case,
5115you must set the environment variable CROSS_COMPILE in your shell.
5116Note that no changes to the Makefile or any other source files are
5117necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005118
Wolfgang Denk218ca722008-03-26 10:40:12 +01005119 $ CROSS_COMPILE=ppc_4xx-
5120 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005121
Peter Tyser2f8d3962009-03-13 18:54:51 -05005122Note: If you wish to generate Windows versions of the utilities in
5123 the tools directory you can use the MinGW toolchain
5124 (http://www.mingw.org). Set your HOST tools to the MinGW
5125 toolchain and execute 'make tools'. For example:
5126
5127 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5128
5129 Binaries such as tools/mkimage.exe will be created which can
5130 be executed on computers running Windows.
5131
Wolfgang Denk218ca722008-03-26 10:40:12 +01005132U-Boot is intended to be simple to build. After installing the
5133sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005134is done by typing:
5135
Holger Freytherab584d62014-08-04 09:26:05 +02005136 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005137
Holger Freytherab584d62014-08-04 09:26:05 +02005138where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005139rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005140
wdenk2729af92004-05-03 20:45:30 +00005141Note: for some board special configuration names may exist; check if
5142 additional information is available from the board vendor; for
5143 instance, the TQM823L systems are available without (standard)
5144 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005145 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005146
Holger Freytherab584d62014-08-04 09:26:05 +02005147 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005148 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005149
Holger Freytherab584d62014-08-04 09:26:05 +02005150 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005151 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk2729af92004-05-03 20:45:30 +00005153 etc.
wdenkc6097192002-11-03 00:24:07 +00005154
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156Finally, type "make all", and you should get some working U-Boot
5157images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159- "u-boot.bin" is a raw binary image
5160- "u-boot" is an image in ELF binary format
5161- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005162
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005163By default the build is performed locally and the objects are saved
5164in the source directory. One of the two methods can be used to change
5165this behavior and build U-Boot to some external directory:
5166
51671. Add O= to the make command line invocations:
5168
5169 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005170 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005171 make O=/tmp/build all
5172
Timo Ketolaadbba992014-11-06 14:39:05 +020051732. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005174
Timo Ketolaadbba992014-11-06 14:39:05 +02005175 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005176 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005177 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005178 make all
5179
Timo Ketolaadbba992014-11-06 14:39:05 +02005180Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005181variable.
5182
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk2729af92004-05-03 20:45:30 +00005184Please be aware that the Makefiles assume you are using GNU make, so
5185for instance on NetBSD you might need to use "gmake" instead of
5186native "make".
wdenkc6097192002-11-03 00:24:07 +00005187
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk2729af92004-05-03 20:45:30 +00005189If the system board that you have is not listed, then you will need
5190to port U-Boot to your hardware platform. To do this, follow these
5191steps:
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk2729af92004-05-03 20:45:30 +000051931. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005194 "boards.cfg" file, using the existing entries as examples.
5195 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051962. Create a new directory to hold your board specific code. Add any
5197 files you need. In your board directory, you will need at least
5198 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51993. Create a new configuration file "include/configs/<board>.h" for
5200 your board
52013. If you're porting U-Boot to a new CPU, then also create a new
5202 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020052034. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000052045. Type "make", and you should get a working "u-boot.srec" file
5205 to be installed on your target system.
52066. Debug and solve any problems that might arise.
5207 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005208
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk2729af92004-05-03 20:45:30 +00005210Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5211==============================================================
wdenkc6097192002-11-03 00:24:07 +00005212
Wolfgang Denk218ca722008-03-26 10:40:12 +01005213If you have modified U-Boot sources (for instance added a new board
5214or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005215provide feedback to the other developers. The feedback normally takes
5216the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005217official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005218
Wolfgang Denk218ca722008-03-26 10:40:12 +01005219But before you submit such a patch, please verify that your modifi-
5220cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005221the supported boards compile WITHOUT ANY compiler warnings. To do so,
5222just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005223for ALL supported system. Be warned, this will take a while. You can
5224select which (cross) compiler to use by passing a `CROSS_COMPILE'
5225environment variable to the script, i. e. to use the ELDK cross tools
5226you can type
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk2729af92004-05-03 20:45:30 +00005228 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk2729af92004-05-03 20:45:30 +00005232 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005233
Wolfgang Denk218ca722008-03-26 10:40:12 +01005234When using the MAKEALL script, the default behaviour is to build
5235U-Boot in the source directory. This location can be changed by
5236setting the BUILD_DIR environment variable. Also, for each target
5237built, the MAKEALL script saves two log files (<target>.ERR and
5238<target>.MAKEALL) in the <source dir>/LOG directory. This default
5239location can be changed by setting the MAKEALL_LOGDIR environment
5240variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005241
5242 export BUILD_DIR=/tmp/build
5243 export MAKEALL_LOGDIR=/tmp/log
5244 CROSS_COMPILE=ppc_8xx- MAKEALL
5245
Wolfgang Denk218ca722008-03-26 10:40:12 +01005246With the above settings build objects are saved in the /tmp/build,
5247log files are saved in the /tmp/log and the source tree remains clean
5248during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005249
5250
wdenk2729af92004-05-03 20:45:30 +00005251See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005252
wdenkc6097192002-11-03 00:24:07 +00005253
wdenk2729af92004-05-03 20:45:30 +00005254Monitor Commands - Overview:
5255============================
wdenkc6097192002-11-03 00:24:07 +00005256
wdenk2729af92004-05-03 20:45:30 +00005257go - start application at address 'addr'
5258run - run commands in an environment variable
5259bootm - boot application image from memory
5260bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005261bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005262tftpboot- boot image via network using TFTP protocol
5263 and env variables "ipaddr" and "serverip"
5264 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005265tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005266rarpboot- boot image via network using RARP/TFTP protocol
5267diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5268loads - load S-Record file over serial line
5269loadb - load binary file over serial line (kermit mode)
5270md - memory display
5271mm - memory modify (auto-incrementing)
5272nm - memory modify (constant address)
5273mw - memory write (fill)
5274cp - memory copy
5275cmp - memory compare
5276crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005277i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005278sspi - SPI utility commands
5279base - print or set address offset
5280printenv- print environment variables
5281setenv - set environment variables
5282saveenv - save environment variables to persistent storage
5283protect - enable or disable FLASH write protection
5284erase - erase FLASH memory
5285flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005286nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005287bdinfo - print Board Info structure
5288iminfo - print header information for application image
5289coninfo - print console devices and informations
5290ide - IDE sub-system
5291loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005292loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005293mtest - simple RAM test
5294icache - enable or disable instruction cache
5295dcache - enable or disable data cache
5296reset - Perform RESET of the CPU
5297echo - echo args to console
5298version - print monitor version
5299help - print online help
5300? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005301
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk2729af92004-05-03 20:45:30 +00005303Monitor Commands - Detailed Description:
5304========================================
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk2729af92004-05-03 20:45:30 +00005306TODO.
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005309
5310
wdenk2729af92004-05-03 20:45:30 +00005311Environment Variables:
5312======================
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314U-Boot supports user configuration using Environment Variables which
5315can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk2729af92004-05-03 20:45:30 +00005317Environment Variables are set using "setenv", printed using
5318"printenv", and saved to Flash using "saveenv". Using "setenv"
5319without a value can be used to delete a variable from the
5320environment. As long as you don't save the environment you are
5321working with an in-memory copy. In case the Flash area containing the
5322environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005323
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005324Some configuration options can be set using Environment Variables.
5325
5326List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk2729af92004-05-03 20:45:30 +00005330 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005331
wdenk2729af92004-05-03 20:45:30 +00005332 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk2729af92004-05-03 20:45:30 +00005334 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk2729af92004-05-03 20:45:30 +00005336 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005337
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005338 bootm_low - Memory range available for image processing in the bootm
5339 command can be restricted. This variable is given as
5340 a hexadecimal number and defines lowest address allowed
5341 for use by the bootm command. See also "bootm_size"
5342 environment variable. Address defined by "bootm_low" is
5343 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005344 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5345 bootm_mapsize.
5346
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005347 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005348 This variable is given as a hexadecimal number and it
5349 defines the size of the memory region starting at base
5350 address bootm_low that is accessible by the Linux kernel
5351 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5352 as the default value if it is defined, and bootm_size is
5353 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005354
5355 bootm_size - Memory range available for image processing in the bootm
5356 command can be restricted. This variable is given as
5357 a hexadecimal number and defines the size of the region
5358 allowed for use by the bootm command. See also "bootm_low"
5359 environment variable.
5360
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005361 updatefile - Location of the software update file on a TFTP server, used
5362 by the automatic software update feature. Please refer to
5363 documentation in doc/README.update for more details.
5364
wdenk2729af92004-05-03 20:45:30 +00005365 autoload - if set to "no" (any string beginning with 'n'),
5366 "bootp" will just load perform a lookup of the
5367 configuration from the BOOTP server, but not try to
5368 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk2729af92004-05-03 20:45:30 +00005370 autostart - if set to "yes", an image loaded using the "bootp",
5371 "rarpboot", "tftpboot" or "diskboot" commands will
5372 be automatically started (by internally calling
5373 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375 If set to "no", a standalone image passed to the
5376 "bootm" command will be copied to the load address
5377 (and eventually uncompressed), but NOT be started.
5378 This can be used to load and uncompress arbitrary
5379 data.
wdenkc6097192002-11-03 00:24:07 +00005380
David A. Longa28afca2011-07-09 16:40:19 -04005381 fdt_high - if set this restricts the maximum address that the
5382 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005383 For example, if you have a system with 1 GB memory
5384 at physical address 0x10000000, while Linux kernel
5385 only recognizes the first 704 MB as low memory, you
5386 may need to set fdt_high as 0x3C000000 to have the
5387 device tree blob be copied to the maximum address
5388 of the 704 MB low memory, so that Linux kernel can
5389 access it during the boot procedure.
5390
David A. Longa28afca2011-07-09 16:40:19 -04005391 If this is set to the special value 0xFFFFFFFF then
5392 the fdt will not be copied at all on boot. For this
5393 to work it must reside in writable memory, have
5394 sufficient padding on the end of it for u-boot to
5395 add the information it needs into it, and the memory
5396 must be accessible by the kernel.
5397
Simon Glasseea63e02011-10-24 19:15:34 +00005398 fdtcontroladdr- if set this is the address of the control flattened
5399 device tree used by U-Boot when CONFIG_OF_CONTROL is
5400 defined.
5401
wdenk17ea1172004-06-06 21:51:03 +00005402 i2cfast - (PPC405GP|PPC405EP only)
5403 if set to 'y' configures Linux I2C driver for fast
5404 mode (400kHZ). This environment variable is used in
5405 initialization code. So, for changes to be effective
5406 it must be saved and board must be reset.
5407
wdenk2729af92004-05-03 20:45:30 +00005408 initrd_high - restrict positioning of initrd images:
5409 If this variable is not set, initrd images will be
5410 copied to the highest possible address in RAM; this
5411 is usually what you want since it allows for
5412 maximum initrd size. If for some reason you want to
5413 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005414 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005415 variable to a value of "no" or "off" or "0".
5416 Alternatively, you can set it to a maximum upper
5417 address to use (U-Boot will still check that it
5418 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk2729af92004-05-03 20:45:30 +00005420 For instance, when you have a system with 16 MB
5421 RAM, and want to reserve 4 MB from use by Linux,
5422 you can do this by adding "mem=12M" to the value of
5423 the "bootargs" variable. However, now you must make
5424 sure that the initrd image is placed in the first
5425 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005426
wdenk2729af92004-05-03 20:45:30 +00005427 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk2729af92004-05-03 20:45:30 +00005429 If you set initrd_high to 0xFFFFFFFF, this is an
5430 indication to U-Boot that all addresses are legal
5431 for the Linux kernel, including addresses in flash
5432 memory. In this case U-Boot will NOT COPY the
5433 ramdisk at all. This may be useful to reduce the
5434 boot time on your system, but requires that this
5435 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005436
wdenk2729af92004-05-03 20:45:30 +00005437 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk2729af92004-05-03 20:45:30 +00005439 loadaddr - Default load address for commands like "bootp",
5440 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk2729af92004-05-03 20:45:30 +00005448 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk2729af92004-05-03 20:45:30 +00005450 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005451
Mike Frysingere2a53452011-10-02 10:01:27 +00005452 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005453
Mike Frysingere2a53452011-10-02 10:01:27 +00005454 ethact - controls which interface is currently active.
5455 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005456
Heiko Schocher48690d82010-07-20 17:45:02 +02005457 => setenv ethact FEC
5458 => ping 192.168.0.1 # traffic sent on FEC
5459 => setenv ethact SCC
5460 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005461
Matthias Fuchse1692572008-01-17 07:45:05 +01005462 ethrotate - When set to "no" U-Boot does not go through all
5463 available network interfaces.
5464 It just stays at the currently selected interface.
5465
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005466 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005467 either succeed or fail without retrying.
5468 When set to "once" the network operation will
5469 fail when all the available network interfaces
5470 are tried once without success.
5471 Useful on scripts which control the retry operation
5472 themselves.
wdenkc6097192002-11-03 00:24:07 +00005473
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005474 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005475
Simon Glass8d51aac2013-07-16 20:10:00 -07005476 silent_linux - If set then linux will be told to boot silently, by
5477 changing the console to be empty. If "yes" it will be
5478 made silent. If "no" it will not be made silent. If
5479 unset, then it will be made silent if the U-Boot console
5480 is silent.
5481
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005482 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005483 UDP source port.
5484
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005485 tftpdstport - If this is set, the value is used for TFTP's UDP
5486 destination port instead of the Well Know Port 69.
5487
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005488 tftpblocksize - Block size to use for TFTP transfers; if not set,
5489 we use the TFTP server's default block size
5490
5491 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5492 seconds, minimum value is 1000 = 1 second). Defines
5493 when a packet is considered to be lost so it has to
5494 be retransmitted. The default is 5000 = 5 seconds.
5495 Lowering this value may make downloads succeed
5496 faster in networks with high packet loss rates or
5497 with unreliable TFTP servers.
5498
5499 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005500 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005501 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005502
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005503The following image location variables contain the location of images
5504used in booting. The "Image" column gives the role of the image and is
5505not an environment variable name. The other columns are environment
5506variable names. "File Name" gives the name of the file on a TFTP
5507server, "RAM Address" gives the location in RAM the image will be
5508loaded to, and "Flash Location" gives the image's address in NOR
5509flash or offset in NAND flash.
5510
5511*Note* - these variables don't have to be defined for all boards, some
5512boards currenlty use other variables for these purposes, and some
5513boards use these variables for other purposes.
5514
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005515Image File Name RAM Address Flash Location
5516----- --------- ----------- --------------
5517u-boot u-boot u-boot_addr_r u-boot_addr
5518Linux kernel bootfile kernel_addr_r kernel_addr
5519device tree blob fdtfile fdt_addr_r fdt_addr
5520ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005521
wdenk2729af92004-05-03 20:45:30 +00005522The following environment variables may be used and automatically
5523updated by the network boot commands ("bootp" and "rarpboot"),
5524depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005525
wdenk2729af92004-05-03 20:45:30 +00005526 bootfile - see above
5527 dnsip - IP address of your Domain Name Server
5528 dnsip2 - IP address of your secondary Domain Name Server
5529 gatewayip - IP address of the Gateway (Router) to use
5530 hostname - Target hostname
5531 ipaddr - see above
5532 netmask - Subnet Mask
5533 rootpath - Pathname of the root filesystem on the NFS server
5534 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005535
wdenka3d991b2004-04-15 21:48:45 +00005536
wdenk2729af92004-05-03 20:45:30 +00005537There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539 serial# - contains hardware identification information such
5540 as type string and/or serial number
5541 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk2729af92004-05-03 20:45:30 +00005543These variables can be set only once (usually during manufacturing of
5544the board). U-Boot refuses to delete or overwrite these variables
5545once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005546
5547
wdenk2729af92004-05-03 20:45:30 +00005548Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550 ver - Contains the U-Boot version string as printed
5551 with the "version" command. This variable is
5552 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005553
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk2729af92004-05-03 20:45:30 +00005555Please note that changes to some configuration parameters may take
5556only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005557
stroesec1551ea2003-04-04 15:53:41 +00005558
Joe Hershberger170ab112012-12-11 22:16:24 -06005559Callback functions for environment variables:
5560---------------------------------------------
5561
5562For some environment variables, the behavior of u-boot needs to change
5563when their values are changed. This functionailty allows functions to
5564be associated with arbitrary variables. On creation, overwrite, or
5565deletion, the callback will provide the opportunity for some side
5566effect to happen or for the change to be rejected.
5567
5568The callbacks are named and associated with a function using the
5569U_BOOT_ENV_CALLBACK macro in your board or driver code.
5570
5571These callbacks are associated with variables in one of two ways. The
5572static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5573in the board configuration to a string that defines a list of
5574associations. The list must be in the following format:
5575
5576 entry = variable_name[:callback_name]
5577 list = entry[,list]
5578
5579If the callback name is not specified, then the callback is deleted.
5580Spaces are also allowed anywhere in the list.
5581
5582Callbacks can also be associated by defining the ".callbacks" variable
5583with the same list format above. Any association in ".callbacks" will
5584override any association in the static list. You can define
5585CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5586".callbacks" envirnoment variable in the default or embedded environment.
5587
5588
wdenk2729af92004-05-03 20:45:30 +00005589Command Line Parsing:
5590=====================
stroesec1551ea2003-04-04 15:53:41 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592There are two different command line parsers available with U-Boot:
5593the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005594
wdenk2729af92004-05-03 20:45:30 +00005595Old, simple command line parser:
5596--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005597
wdenk2729af92004-05-03 20:45:30 +00005598- supports environment variables (through setenv / saveenv commands)
5599- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005600- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005601- special characters ('$', ';') can be escaped by prefixing with '\',
5602 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005603 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005604- You can also escape text by enclosing in single apostrophes, for example:
5605 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk2729af92004-05-03 20:45:30 +00005607Hush shell:
5608-----------
wdenkf07771c2003-05-28 08:06:31 +00005609
wdenk2729af92004-05-03 20:45:30 +00005610- similar to Bourne shell, with control structures like
5611 if...then...else...fi, for...do...done; while...do...done,
5612 until...do...done, ...
5613- supports environment ("global") variables (through setenv / saveenv
5614 commands) and local shell variables (through standard shell syntax
5615 "name=value"); only environment variables can be used with "run"
5616 command
wdenkf07771c2003-05-28 08:06:31 +00005617
wdenk2729af92004-05-03 20:45:30 +00005618General rules:
5619--------------
wdenkf07771c2003-05-28 08:06:31 +00005620
wdenk2729af92004-05-03 20:45:30 +00005621(1) If a command line (or an environment variable executed by a "run"
5622 command) contains several commands separated by semicolon, and
5623 one of these commands fails, then the remaining commands will be
5624 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005625
wdenk2729af92004-05-03 20:45:30 +00005626(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005627 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005628 command will cause "run" to terminate, i. e. the remaining
5629 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631Note for Redundant Ethernet Interfaces:
5632=======================================
wdenkf07771c2003-05-28 08:06:31 +00005633
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005634Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005635such configurations and is capable of automatic selection of a
5636"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005637
wdenk2729af92004-05-03 20:45:30 +00005638Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5639MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5640"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642If the network interface stores some valid MAC address (for instance
5643in SROM), this is used as default address if there is NO correspon-
5644ding setting in the environment; if the corresponding environment
5645variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647o If the SROM has a valid MAC address, and there is no address in the
5648 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk2729af92004-05-03 20:45:30 +00005650o If there is no valid address in the SROM, and a definition in the
5651 environment exists, then the value from the environment variable is
5652 used.
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk2729af92004-05-03 20:45:30 +00005654o If both the SROM and the environment contain a MAC address, and
5655 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk2729af92004-05-03 20:45:30 +00005657o If both the SROM and the environment contain a MAC address, and the
5658 addresses differ, the value from the environment is used and a
5659 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk2729af92004-05-03 20:45:30 +00005661o If neither SROM nor the environment contain a MAC address, an error
5662 is raised.
wdenkc6097192002-11-03 00:24:07 +00005663
Ben Warrenecee9322010-04-26 11:11:46 -07005664If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005665will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005666may be skipped by setting the appropriate 'ethmacskip' environment variable.
5667The naming convention is as follows:
5668"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk2729af92004-05-03 20:45:30 +00005670Image Formats:
5671==============
wdenkc6097192002-11-03 00:24:07 +00005672
Marian Balakowicz3310c542008-03-12 12:13:13 +01005673U-Boot is capable of booting (and performing other auxiliary operations on)
5674images in two formats:
5675
5676New uImage format (FIT)
5677-----------------------
5678
5679Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5680to Flattened Device Tree). It allows the use of images with multiple
5681components (several kernels, ramdisks, etc.), with contents protected by
5682SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5683
5684
5685Old uImage format
5686-----------------
5687
5688Old image format is based on binary files which can be basically anything,
5689preceded by a special header; see the definitions in include/image.h for
5690details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5693 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005694 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5695 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5696 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005697* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005698 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5699 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005700* Compression Type (uncompressed, gzip, bzip2)
5701* Load Address
5702* Entry Point
5703* Image Name
5704* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk2729af92004-05-03 20:45:30 +00005706The header is marked by a special Magic Number, and both the header
5707and the data portions of the image are secured against corruption by
5708CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005709
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711Linux Support:
5712==============
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714Although U-Boot should support any OS or standalone application
5715easily, the main focus has always been on Linux during the design of
5716U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005717
wdenk2729af92004-05-03 20:45:30 +00005718U-Boot includes many features that so far have been part of some
5719special "boot loader" code within the Linux kernel. Also, any
5720"initrd" images to be used are no longer part of one big Linux image;
5721instead, kernel and "initrd" are separate images. This implementation
5722serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724- the same features can be used for other OS or standalone
5725 applications (for instance: using compressed images to reduce the
5726 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728- it becomes much easier to port new Linux kernel versions because
5729 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731- the same Linux kernel image can now be used with different "initrd"
5732 images; of course this also means that different kernel images can
5733 be run with the same "initrd". This makes testing easier (you don't
5734 have to build a new "zImage.initrd" Linux image when you just
5735 change a file in your "initrd"). Also, a field-upgrade of the
5736 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005737
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739Linux HOWTO:
5740============
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk2729af92004-05-03 20:45:30 +00005742Porting Linux to U-Boot based systems:
5743---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745U-Boot cannot save you from doing all the necessary modifications to
5746configure the Linux device drivers for use with your target hardware
5747(no, we don't intend to provide a full virtual machine interface to
5748Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005749
Stefan Roesea47a12b2010-04-15 16:07:28 +02005750But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752Just make sure your machine specific header file (for instance
5753include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005754Information structure as we define in include/asm-<arch>/u-boot.h,
5755and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005756as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005757
Simon Glass2eb31b12014-06-11 23:29:46 -06005758Note that U-Boot now has a driver model, a unified model for drivers.
5759If you are adding a new driver, plumb it into driver model. If there
5760is no uclass available, you are encouraged to create one. See
5761doc/driver-model.
5762
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764Configuring the Linux kernel:
5765-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk2729af92004-05-03 20:45:30 +00005767No specific requirements for U-Boot. Make sure you have some root
5768device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005769
wdenkc6097192002-11-03 00:24:07 +00005770
wdenk2729af92004-05-03 20:45:30 +00005771Building a Linux Image:
5772-----------------------
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk2729af92004-05-03 20:45:30 +00005774With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5775not used. If you use recent kernel source, a new build target
5776"uImage" will exist which automatically builds an image usable by
5777U-Boot. Most older kernels also have support for a "pImage" target,
5778which was introduced for our predecessor project PPCBoot and uses a
5779100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005780
wdenk2729af92004-05-03 20:45:30 +00005781Example:
wdenkc6097192002-11-03 00:24:07 +00005782
Holger Freytherab584d62014-08-04 09:26:05 +02005783 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005784 make oldconfig
5785 make dep
5786 make uImage
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk2729af92004-05-03 20:45:30 +00005788The "uImage" build target uses a special tool (in 'tools/mkimage') to
5789encapsulate a compressed Linux kernel image with header information,
5790CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk2729af92004-05-03 20:45:30 +00005794* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796 ${CROSS_COMPILE}-objcopy -O binary \
5797 -R .note -R .comment \
5798 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005801
wdenk2729af92004-05-03 20:45:30 +00005802 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk2729af92004-05-03 20:45:30 +00005804* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806 mkimage -A ppc -O linux -T kernel -C gzip \
5807 -a 0 -e 0 -n "Linux Kernel Image" \
5808 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005809
wdenk24ee89b2002-11-03 17:56:27 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811The "mkimage" tool can also be used to create ramdisk images for use
5812with U-Boot, either separated from the Linux kernel image, or
5813combined into one file. "mkimage" encapsulates the images with a 64
5814byte header containing information about target architecture,
5815operating system, image type, compression method, entry points, time
5816stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005817
wdenk2729af92004-05-03 20:45:30 +00005818"mkimage" can be called in two ways: to verify existing images and
5819print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005820
wdenk2729af92004-05-03 20:45:30 +00005821In the first form (with "-l" option) mkimage lists the information
5822contained in the header of an existing U-Boot image; this includes
5823checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005824
wdenk2729af92004-05-03 20:45:30 +00005825 tools/mkimage -l image
5826 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005827
wdenk2729af92004-05-03 20:45:30 +00005828The second form (with "-d" option) is used to build a U-Boot image
5829from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005830
wdenk2729af92004-05-03 20:45:30 +00005831 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5832 -n name -d data_file image
5833 -A ==> set architecture to 'arch'
5834 -O ==> set operating system to 'os'
5835 -T ==> set image type to 'type'
5836 -C ==> set compression type 'comp'
5837 -a ==> set load address to 'addr' (hex)
5838 -e ==> set entry point to 'ep' (hex)
5839 -n ==> set image name to 'name'
5840 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005841
wdenk69459792004-05-29 16:53:29 +00005842Right now, all Linux kernels for PowerPC systems use the same load
5843address (0x00000000), but the entry point address depends on the
5844kernel version:
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk2729af92004-05-03 20:45:30 +00005846- 2.2.x kernels have the entry point at 0x0000000C,
5847- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005848
wdenk2729af92004-05-03 20:45:30 +00005849So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk2729af92004-05-03 20:45:30 +00005851 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5852 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005853 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005854 > examples/uImage.TQM850L
5855 Image Name: 2.4.4 kernel for TQM850L
5856 Created: Wed Jul 19 02:34:59 2000
5857 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5858 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5859 Load Address: 0x00000000
5860 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005863
wdenk2729af92004-05-03 20:45:30 +00005864 -> tools/mkimage -l examples/uImage.TQM850L
5865 Image Name: 2.4.4 kernel for TQM850L
5866 Created: Wed Jul 19 02:34:59 2000
5867 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5868 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5869 Load Address: 0x00000000
5870 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005871
wdenk2729af92004-05-03 20:45:30 +00005872NOTE: for embedded systems where boot time is critical you can trade
5873speed for memory and install an UNCOMPRESSED image instead: this
5874needs more space in Flash, but boots much faster since it does not
5875need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005876
Stefan Roesea47a12b2010-04-15 16:07:28 +02005877 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005878 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5879 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005880 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005881 > examples/uImage.TQM850L-uncompressed
5882 Image Name: 2.4.4 kernel for TQM850L
5883 Created: Wed Jul 19 02:34:59 2000
5884 Image Type: PowerPC Linux Kernel Image (uncompressed)
5885 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5886 Load Address: 0x00000000
5887 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005888
wdenkc6097192002-11-03 00:24:07 +00005889
wdenk2729af92004-05-03 20:45:30 +00005890Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5891when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893 -> tools/mkimage -n 'Simple Ramdisk Image' \
5894 > -A ppc -O linux -T ramdisk -C gzip \
5895 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5896 Image Name: Simple Ramdisk Image
5897 Created: Wed Jan 12 14:01:50 2000
5898 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5899 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5900 Load Address: 0x00000000
5901 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005902
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005903The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5904option performs the converse operation of the mkimage's second form (the "-d"
5905option). Given an image built by mkimage, the dumpimage extracts a "data file"
5906from the image:
5907
5908 tools/dumpimage -i image -p position data_file
5909 -i ==> extract from the 'image' a specific 'data_file', \
5910 indexed by 'position'
5911
wdenkdb01a2e2004-04-15 23:14:49 +00005912
wdenk2729af92004-05-03 20:45:30 +00005913Installing a Linux Image:
5914-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005915
wdenk2729af92004-05-03 20:45:30 +00005916To downloading a U-Boot image over the serial (console) interface,
5917you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005918
wdenk2729af92004-05-03 20:45:30 +00005919 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005920
wdenk2729af92004-05-03 20:45:30 +00005921The 'objcopy' does not understand the information in the U-Boot
5922image header, so the resulting S-Record file will be relative to
5923address 0x00000000. To load it to a given address, you need to
5924specify the target address as 'offset' parameter with the 'loads'
5925command.
wdenkc6097192002-11-03 00:24:07 +00005926
wdenk2729af92004-05-03 20:45:30 +00005927Example: install the image to address 0x40100000 (which on the
5928TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005929
wdenk2729af92004-05-03 20:45:30 +00005930 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk2729af92004-05-03 20:45:30 +00005932 .......... done
5933 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk2729af92004-05-03 20:45:30 +00005935 => loads 40100000
5936 ## Ready for S-Record download ...
5937 ~>examples/image.srec
5938 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5939 ...
5940 15989 15990 15991 15992
5941 [file transfer complete]
5942 [connected]
5943 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005944
5945
wdenk2729af92004-05-03 20:45:30 +00005946You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005947this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005948corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005949
wdenk2729af92004-05-03 20:45:30 +00005950 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk2729af92004-05-03 20:45:30 +00005952 ## Checking Image at 40100000 ...
5953 Image Name: 2.2.13 for initrd on TQM850L
5954 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5955 Data Size: 335725 Bytes = 327 kB = 0 MB
5956 Load Address: 00000000
5957 Entry Point: 0000000c
5958 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005959
5960
wdenk2729af92004-05-03 20:45:30 +00005961Boot Linux:
5962-----------
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk2729af92004-05-03 20:45:30 +00005964The "bootm" command is used to boot an application that is stored in
5965memory (RAM or Flash). In case of a Linux kernel image, the contents
5966of the "bootargs" environment variable is passed to the kernel as
5967parameters. You can check and modify this variable using the
5968"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005969
5970
wdenk2729af92004-05-03 20:45:30 +00005971 => printenv bootargs
5972 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk2729af92004-05-03 20:45:30 +00005974 => 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 +00005975
wdenk2729af92004-05-03 20:45:30 +00005976 => printenv bootargs
5977 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 +00005978
wdenk2729af92004-05-03 20:45:30 +00005979 => bootm 40020000
5980 ## Booting Linux kernel at 40020000 ...
5981 Image Name: 2.2.13 for NFS on TQM850L
5982 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5983 Data Size: 381681 Bytes = 372 kB = 0 MB
5984 Load Address: 00000000
5985 Entry Point: 0000000c
5986 Verifying Checksum ... OK
5987 Uncompressing Kernel Image ... OK
5988 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
5989 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5990 time_init: decrementer frequency = 187500000/60
5991 Calibrating delay loop... 49.77 BogoMIPS
5992 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5993 ...
wdenkc6097192002-11-03 00:24:07 +00005994
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005995If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005996the memory addresses of both the kernel and the initrd image (PPBCOOT
5997format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk2729af92004-05-03 20:45:30 +00005999 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk2729af92004-05-03 20:45:30 +00006001 ## Checking Image at 40100000 ...
6002 Image Name: 2.2.13 for initrd on TQM850L
6003 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6004 Data Size: 335725 Bytes = 327 kB = 0 MB
6005 Load Address: 00000000
6006 Entry Point: 0000000c
6007 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk2729af92004-05-03 20:45:30 +00006009 ## Checking Image at 40200000 ...
6010 Image Name: Simple Ramdisk Image
6011 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6012 Data Size: 566530 Bytes = 553 kB = 0 MB
6013 Load Address: 00000000
6014 Entry Point: 00000000
6015 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006016
wdenk2729af92004-05-03 20:45:30 +00006017 => bootm 40100000 40200000
6018 ## Booting Linux kernel at 40100000 ...
6019 Image Name: 2.2.13 for initrd on TQM850L
6020 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6021 Data Size: 335725 Bytes = 327 kB = 0 MB
6022 Load Address: 00000000
6023 Entry Point: 0000000c
6024 Verifying Checksum ... OK
6025 Uncompressing Kernel Image ... OK
6026 ## Loading RAMDisk Image at 40200000 ...
6027 Image Name: Simple Ramdisk Image
6028 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6029 Data Size: 566530 Bytes = 553 kB = 0 MB
6030 Load Address: 00000000
6031 Entry Point: 00000000
6032 Verifying Checksum ... OK
6033 Loading Ramdisk ... OK
6034 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
6035 Boot arguments: root=/dev/ram
6036 time_init: decrementer frequency = 187500000/60
6037 Calibrating delay loop... 49.77 BogoMIPS
6038 ...
6039 RAMDISK: Compressed image found at block 0
6040 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk2729af92004-05-03 20:45:30 +00006042 bash#
wdenkc6097192002-11-03 00:24:07 +00006043
Matthew McClintock02677682006-06-28 10:41:37 -05006044Boot Linux and pass a flat device tree:
6045-----------
6046
6047First, U-Boot must be compiled with the appropriate defines. See the section
6048titled "Linux Kernel Interface" above for a more in depth explanation. The
6049following is an example of how to start a kernel and pass an updated
6050flat device tree:
6051
6052=> print oftaddr
6053oftaddr=0x300000
6054=> print oft
6055oft=oftrees/mpc8540ads.dtb
6056=> tftp $oftaddr $oft
6057Speed: 1000, full duplex
6058Using TSEC0 device
6059TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6060Filename 'oftrees/mpc8540ads.dtb'.
6061Load address: 0x300000
6062Loading: #
6063done
6064Bytes transferred = 4106 (100a hex)
6065=> tftp $loadaddr $bootfile
6066Speed: 1000, full duplex
6067Using TSEC0 device
6068TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6069Filename 'uImage'.
6070Load address: 0x200000
6071Loading:############
6072done
6073Bytes transferred = 1029407 (fb51f hex)
6074=> print loadaddr
6075loadaddr=200000
6076=> print oftaddr
6077oftaddr=0x300000
6078=> bootm $loadaddr - $oftaddr
6079## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006080 Image Name: Linux-2.6.17-dirty
6081 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6082 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006083 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006084 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006085 Verifying Checksum ... OK
6086 Uncompressing Kernel Image ... OK
6087Booting using flat device tree at 0x300000
6088Using MPC85xx ADS machine description
6089Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6090[snip]
6091
6092
wdenk2729af92004-05-03 20:45:30 +00006093More About U-Boot Image Types:
6094------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006095
wdenk2729af92004-05-03 20:45:30 +00006096U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006097
wdenk2729af92004-05-03 20:45:30 +00006098 "Standalone Programs" are directly runnable in the environment
6099 provided by U-Boot; it is expected that (if they behave
6100 well) you can continue to work in U-Boot after return from
6101 the Standalone Program.
6102 "OS Kernel Images" are usually images of some Embedded OS which
6103 will take over control completely. Usually these programs
6104 will install their own set of exception handlers, device
6105 drivers, set up the MMU, etc. - this means, that you cannot
6106 expect to re-enter U-Boot except by resetting the CPU.
6107 "RAMDisk Images" are more or less just data blocks, and their
6108 parameters (address, size) are passed to an OS kernel that is
6109 being started.
6110 "Multi-File Images" contain several images, typically an OS
6111 (Linux) kernel image and one or more data images like
6112 RAMDisks. This construct is useful for instance when you want
6113 to boot over the network using BOOTP etc., where the boot
6114 server provides just a single image file, but you want to get
6115 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006116
wdenk2729af92004-05-03 20:45:30 +00006117 "Multi-File Images" start with a list of image sizes, each
6118 image size (in bytes) specified by an "uint32_t" in network
6119 byte order. This list is terminated by an "(uint32_t)0".
6120 Immediately after the terminating 0 follow the images, one by
6121 one, all aligned on "uint32_t" boundaries (size rounded up to
6122 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006123
wdenk2729af92004-05-03 20:45:30 +00006124 "Firmware Images" are binary images containing firmware (like
6125 U-Boot or FPGA images) which usually will be programmed to
6126 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006127
wdenk2729af92004-05-03 20:45:30 +00006128 "Script files" are command sequences that will be executed by
6129 U-Boot's command interpreter; this feature is especially
6130 useful when you configure U-Boot to use a real shell (hush)
6131 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006132
Marek Vasut44f074c2012-03-14 21:52:45 +00006133Booting the Linux zImage:
6134-------------------------
6135
6136On some platforms, it's possible to boot Linux zImage. This is done
6137using the "bootz" command. The syntax of "bootz" command is the same
6138as the syntax of "bootm" command.
6139
Tom Rini8ac28562013-05-16 11:40:11 -04006140Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006141kernel with raw initrd images. The syntax is slightly different, the
6142address of the initrd must be augmented by it's size, in the following
6143format: "<initrd addres>:<initrd size>".
6144
wdenkc6097192002-11-03 00:24:07 +00006145
wdenk2729af92004-05-03 20:45:30 +00006146Standalone HOWTO:
6147=================
wdenkc6097192002-11-03 00:24:07 +00006148
wdenk2729af92004-05-03 20:45:30 +00006149One of the features of U-Boot is that you can dynamically load and
6150run "standalone" applications, which can use some resources of
6151U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006152
wdenk2729af92004-05-03 20:45:30 +00006153Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk2729af92004-05-03 20:45:30 +00006155"Hello World" Demo:
6156-------------------
wdenkc6097192002-11-03 00:24:07 +00006157
wdenk2729af92004-05-03 20:45:30 +00006158'examples/hello_world.c' contains a small "Hello World" Demo
6159application; it is automatically compiled when you build U-Boot.
6160It's configured to run at address 0x00040004, so you can play with it
6161like that:
wdenkc6097192002-11-03 00:24:07 +00006162
wdenk2729af92004-05-03 20:45:30 +00006163 => loads
6164 ## Ready for S-Record download ...
6165 ~>examples/hello_world.srec
6166 1 2 3 4 5 6 7 8 9 10 11 ...
6167 [file transfer complete]
6168 [connected]
6169 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk2729af92004-05-03 20:45:30 +00006171 => go 40004 Hello World! This is a test.
6172 ## Starting application at 0x00040004 ...
6173 Hello World
6174 argc = 7
6175 argv[0] = "40004"
6176 argv[1] = "Hello"
6177 argv[2] = "World!"
6178 argv[3] = "This"
6179 argv[4] = "is"
6180 argv[5] = "a"
6181 argv[6] = "test."
6182 argv[7] = "<NULL>"
6183 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk2729af92004-05-03 20:45:30 +00006185 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006186
wdenk2729af92004-05-03 20:45:30 +00006187Another example, which demonstrates how to register a CPM interrupt
6188handler with the U-Boot code, can be found in 'examples/timer.c'.
6189Here, a CPM timer is set up to generate an interrupt every second.
6190The interrupt service routine is trivial, just printing a '.'
6191character, but this is just a demo program. The application can be
6192controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006193
wdenk2729af92004-05-03 20:45:30 +00006194 ? - print current values og the CPM Timer registers
6195 b - enable interrupts and start timer
6196 e - stop timer and disable interrupts
6197 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006198
wdenk2729af92004-05-03 20:45:30 +00006199 => loads
6200 ## Ready for S-Record download ...
6201 ~>examples/timer.srec
6202 1 2 3 4 5 6 7 8 9 10 11 ...
6203 [file transfer complete]
6204 [connected]
6205 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006206
wdenk2729af92004-05-03 20:45:30 +00006207 => go 40004
6208 ## Starting application at 0x00040004 ...
6209 TIMERS=0xfff00980
6210 Using timer 1
6211 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006212
wdenk2729af92004-05-03 20:45:30 +00006213Hit 'b':
6214 [q, b, e, ?] Set interval 1000000 us
6215 Enabling timer
6216Hit '?':
6217 [q, b, e, ?] ........
6218 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6219Hit '?':
6220 [q, b, e, ?] .
6221 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6222Hit '?':
6223 [q, b, e, ?] .
6224 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6225Hit '?':
6226 [q, b, e, ?] .
6227 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6228Hit 'e':
6229 [q, b, e, ?] ...Stopping timer
6230Hit 'q':
6231 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006232
6233
wdenk2729af92004-05-03 20:45:30 +00006234Minicom warning:
6235================
wdenk85ec0bc2003-03-31 16:34:49 +00006236
wdenk2729af92004-05-03 20:45:30 +00006237Over time, many people have reported problems when trying to use the
6238"minicom" terminal emulation program for serial download. I (wd)
6239consider minicom to be broken, and recommend not to use it. Under
6240Unix, I recommend to use C-Kermit for general purpose use (and
6241especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006242use "cu" for S-Record download ("loads" command). See
6243http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6244for help with kermit.
6245
wdenk85ec0bc2003-03-31 16:34:49 +00006246
wdenk2729af92004-05-03 20:45:30 +00006247Nevertheless, if you absolutely want to use it try adding this
6248configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006249
wdenk2729af92004-05-03 20:45:30 +00006250 Name Program Name U/D FullScr IO-Red. Multi
6251 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6252 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006253
6254
wdenk2729af92004-05-03 20:45:30 +00006255NetBSD Notes:
6256=============
wdenkc6097192002-11-03 00:24:07 +00006257
wdenk2729af92004-05-03 20:45:30 +00006258Starting at version 0.9.2, U-Boot supports NetBSD both as host
6259(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk2729af92004-05-03 20:45:30 +00006261Building requires a cross environment; it is known to work on
6262NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6263need gmake since the Makefiles are not compatible with BSD make).
6264Note that the cross-powerpc package does not install include files;
6265attempting to build U-Boot will fail because <machine/ansi.h> is
6266missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006267
wdenk2729af92004-05-03 20:45:30 +00006268 # cd /usr/pkg/cross/powerpc-netbsd/include
6269 # mkdir powerpc
6270 # ln -s powerpc machine
6271 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6272 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk2729af92004-05-03 20:45:30 +00006274Native builds *don't* work due to incompatibilities between native
6275and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk2729af92004-05-03 20:45:30 +00006277Booting assumes that (the first part of) the image booted is a
6278stage-2 loader which in turn loads and then invokes the kernel
6279proper. Loader sources will eventually appear in the NetBSD source
6280tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006281meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006282
6283
wdenk2729af92004-05-03 20:45:30 +00006284Implementation Internals:
6285=========================
wdenkc6097192002-11-03 00:24:07 +00006286
wdenk2729af92004-05-03 20:45:30 +00006287The following is not intended to be a complete description of every
6288implementation detail. However, it should help to understand the
6289inner workings of U-Boot and make it easier to port it to custom
6290hardware.
wdenkc6097192002-11-03 00:24:07 +00006291
6292
wdenk2729af92004-05-03 20:45:30 +00006293Initial Stack, Global Data:
6294---------------------------
wdenkc6097192002-11-03 00:24:07 +00006295
wdenk2729af92004-05-03 20:45:30 +00006296The implementation of U-Boot is complicated by the fact that U-Boot
6297starts running out of ROM (flash memory), usually without access to
6298system RAM (because the memory controller is not initialized yet).
6299This means that we don't have writable Data or BSS segments, and BSS
6300is not initialized as zero. To be able to get a C environment working
6301at all, we have to allocate at least a minimal stack. Implementation
6302options for this are defined and restricted by the CPU used: Some CPU
6303models provide on-chip memory (like the IMMR area on MPC8xx and
6304MPC826x processors), on others (parts of) the data cache can be
6305locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006306
Wolfgang Denk218ca722008-03-26 10:40:12 +01006307 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006308 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006309
wdenk2729af92004-05-03 20:45:30 +00006310 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6311 From: "Chris Hallinan" <clh@net1plus.com>
6312 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6313 ...
wdenk43d96162003-03-06 00:02:04 +00006314
wdenk2729af92004-05-03 20:45:30 +00006315 Correct me if I'm wrong, folks, but the way I understand it
6316 is this: Using DCACHE as initial RAM for Stack, etc, does not
6317 require any physical RAM backing up the cache. The cleverness
6318 is that the cache is being used as a temporary supply of
6319 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006320 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006321 can see how this works by studying the cache architecture and
6322 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006323
wdenk2729af92004-05-03 20:45:30 +00006324 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6325 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006326 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006327 option should work for you. Using CS 4 should be fine if your
6328 board designers haven't used it for something that would
6329 cause you grief during the initial boot! It is frequently not
6330 used.
wdenk43d96162003-03-06 00:02:04 +00006331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006332 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006333 with your processor/board/system design. The default value
6334 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006335 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006336 than your SDRAM module. If you have a 64MB SDRAM module, set
6337 it above 400_0000. Just make sure your board has no resources
6338 that are supposed to respond to that address! That code in
6339 start.S has been around a while and should work as is when
6340 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006341
wdenk2729af92004-05-03 20:45:30 +00006342 -Chris Hallinan
6343 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006344
wdenk2729af92004-05-03 20:45:30 +00006345It is essential to remember this, since it has some impact on the C
6346code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006347
wdenk2729af92004-05-03 20:45:30 +00006348* Initialized global data (data segment) is read-only. Do not attempt
6349 to write it.
wdenkc6097192002-11-03 00:24:07 +00006350
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006351* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00006352 as zero data - BSS segment) at all - this is undefined, initiali-
6353 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006354
wdenk2729af92004-05-03 20:45:30 +00006355* Stack space is very limited. Avoid big data buffers or things like
6356 that.
wdenkc6097192002-11-03 00:24:07 +00006357
wdenk2729af92004-05-03 20:45:30 +00006358Having only the stack as writable memory limits means we cannot use
6359normal global data to share information beween the code. But it
6360turned out that the implementation of U-Boot can be greatly
6361simplified by making a global data structure (gd_t) available to all
6362functions. We could pass a pointer to this data as argument to _all_
6363functions, but this would bloat the code. Instead we use a feature of
6364the GCC compiler (Global Register Variables) to share the data: we
6365place a pointer (gd) to the global data into a register which we
6366reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006367
wdenk2729af92004-05-03 20:45:30 +00006368When choosing a register for such a purpose we are restricted by the
6369relevant (E)ABI specifications for the current architecture, and by
6370GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006371
wdenk2729af92004-05-03 20:45:30 +00006372For PowerPC, the following registers have specific use:
6373 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006374 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006375 R3-R4: parameter passing and return values
6376 R5-R10: parameter passing
6377 R13: small data area pointer
6378 R30: GOT pointer
6379 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006380
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006381 (U-Boot also uses R12 as internal GOT pointer. r12
6382 is a volatile register so r12 needs to be reset when
6383 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006384
Wolfgang Denke7670f62008-02-14 22:43:22 +01006385 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006386
wdenk2729af92004-05-03 20:45:30 +00006387 Note: on PPC, we could use a static initializer (since the
6388 address of the global data structure is known at compile time),
6389 but it turned out that reserving a register results in somewhat
6390 smaller code - although the code savings are not that big (on
6391 average for all boards 752 bytes for the whole U-Boot image,
6392 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006393
Robin Getzc4db3352009-08-17 15:23:02 +00006394On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006395 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6396
Robin Getzc4db3352009-08-17 15:23:02 +00006397 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006398
wdenk2729af92004-05-03 20:45:30 +00006399On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk2729af92004-05-03 20:45:30 +00006401 R0: function argument word/integer result
6402 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006403 R9: platform specific
6404 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006405 R11: argument (frame) pointer
6406 R12: temporary workspace
6407 R13: stack pointer
6408 R14: link register
6409 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006410
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006411 ==> U-Boot will use R9 to hold a pointer to the global data
6412
6413 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006414
Thomas Chou0df01fd32010-05-21 11:08:03 +08006415On Nios II, the ABI is documented here:
6416 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6417
6418 ==> U-Boot will use gp to hold a pointer to the global data
6419
6420 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6421 to access small data sections, so gp is free.
6422
Macpaul Linafc1ce82011-10-19 20:41:11 +00006423On NDS32, the following registers are used:
6424
6425 R0-R1: argument/return
6426 R2-R5: argument
6427 R15: temporary register for assembler
6428 R16: trampoline register
6429 R28: frame pointer (FP)
6430 R29: global pointer (GP)
6431 R30: link register (LP)
6432 R31: stack pointer (SP)
6433 PC: program counter (PC)
6434
6435 ==> U-Boot will use R10 to hold a pointer to the global data
6436
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006437NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6438or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk2729af92004-05-03 20:45:30 +00006440Memory Management:
6441------------------
wdenkc6097192002-11-03 00:24:07 +00006442
wdenk2729af92004-05-03 20:45:30 +00006443U-Boot runs in system state and uses physical addresses, i.e. the
6444MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006445
wdenk2729af92004-05-03 20:45:30 +00006446The available memory is mapped to fixed addresses using the memory
6447controller. In this process, a contiguous block is formed for each
6448memory type (Flash, SDRAM, SRAM), even when it consists of several
6449physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006450
wdenk2729af92004-05-03 20:45:30 +00006451U-Boot is installed in the first 128 kB of the first Flash bank (on
6452TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6453booting and sizing and initializing DRAM, the code relocates itself
6454to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006455memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006456configuration setting]. Below that, a structure with global Board
6457Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk2729af92004-05-03 20:45:30 +00006459Additionally, some exception handler code is copied to the low 8 kB
6460of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006461
wdenk2729af92004-05-03 20:45:30 +00006462So a typical memory configuration with 16 MB of DRAM could look like
6463this:
wdenkc6097192002-11-03 00:24:07 +00006464
wdenk2729af92004-05-03 20:45:30 +00006465 0x0000 0000 Exception Vector code
6466 :
6467 0x0000 1FFF
6468 0x0000 2000 Free for Application Use
6469 :
6470 :
wdenkc6097192002-11-03 00:24:07 +00006471
wdenk2729af92004-05-03 20:45:30 +00006472 :
6473 :
6474 0x00FB FF20 Monitor Stack (Growing downward)
6475 0x00FB FFAC Board Info Data and permanent copy of global data
6476 0x00FC 0000 Malloc Arena
6477 :
6478 0x00FD FFFF
6479 0x00FE 0000 RAM Copy of Monitor Code
6480 ... eventually: LCD or video framebuffer
6481 ... eventually: pRAM (Protected RAM - unchanged by reset)
6482 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006483
6484
wdenk2729af92004-05-03 20:45:30 +00006485System Initialization:
6486----------------------
wdenkc6097192002-11-03 00:24:07 +00006487
wdenk2729af92004-05-03 20:45:30 +00006488In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006489(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00006490configuration for CS0# this is a mirror of the onboard Flash memory.
6491To be able to re-map memory U-Boot then jumps to its link address.
6492To be able to implement the initialization code in C, a (small!)
6493initial stack is set up in the internal Dual Ported RAM (in case CPUs
6494which provide such a feature like MPC8xx or MPC8260), or in a locked
6495part of the data cache. After that, U-Boot initializes the CPU core,
6496the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006497
wdenk2729af92004-05-03 20:45:30 +00006498Next, all (potentially) available memory banks are mapped using a
6499preliminary mapping. For example, we put them on 512 MB boundaries
6500(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6501on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6502programmed for SDRAM access. Using the temporary configuration, a
6503simple memory test is run that determines the size of the SDRAM
6504banks.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk2729af92004-05-03 20:45:30 +00006506When there is more than one SDRAM bank, and the banks are of
6507different size, the largest is mapped first. For equal size, the first
6508bank (CS2#) is mapped first. The first mapping is always for address
65090x00000000, with any additional banks following immediately to create
6510contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006511
wdenk2729af92004-05-03 20:45:30 +00006512Then, the monitor installs itself at the upper end of the SDRAM area
6513and allocates memory for use by malloc() and for the global Board
6514Info data; also, the exception vector code is copied to the low RAM
6515pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006516
wdenk2729af92004-05-03 20:45:30 +00006517Only after this relocation will you have a "normal" C environment;
6518until that you are restricted in several ways, mostly because you are
6519running from ROM, and because the code will have to be relocated to a
6520new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006521
6522
wdenk2729af92004-05-03 20:45:30 +00006523U-Boot Porting Guide:
6524----------------------
wdenkc6097192002-11-03 00:24:07 +00006525
wdenk2729af92004-05-03 20:45:30 +00006526[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6527list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006528
6529
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006530int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006531{
6532 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006533
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006534 signal(SIGALRM, no_more_time);
6535 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006536
wdenk2729af92004-05-03 20:45:30 +00006537 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006538 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006539 return 0;
6540 }
6541
wdenk2729af92004-05-03 20:45:30 +00006542 Download latest U-Boot source;
6543
Wolfgang Denk06682362008-12-30 22:56:11 +01006544 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006545
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006546 if (clueless)
6547 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006548
wdenk2729af92004-05-03 20:45:30 +00006549 while (learning) {
6550 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006551 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6552 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006553 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006554 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006555 }
wdenkc6097192002-11-03 00:24:07 +00006556
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006557 if (available_money > toLocalCurrency ($2500))
6558 Buy a BDI3000;
6559 else
wdenk2729af92004-05-03 20:45:30 +00006560 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006561
6562 if (a similar board exists) { /* hopefully... */
6563 cp -a board/<similar> board/<myboard>
6564 cp include/configs/<similar>.h include/configs/<myboard>.h
6565 } else {
6566 Create your own board support subdirectory;
6567 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006568 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006569 Edit new board/<myboard> files
6570 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006571
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006572 while (!accepted) {
6573 while (!running) {
6574 do {
6575 Add / modify source code;
6576 } until (compiles);
6577 Debug;
6578 if (clueless)
6579 email("Hi, I am having problems...");
6580 }
6581 Send patch file to the U-Boot email list;
6582 if (reasonable critiques)
6583 Incorporate improvements from email list code review;
6584 else
6585 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006586 }
wdenkc6097192002-11-03 00:24:07 +00006587
wdenk2729af92004-05-03 20:45:30 +00006588 return 0;
6589}
6590
6591void no_more_time (int sig)
6592{
6593 hire_a_guru();
6594}
wdenkc6097192002-11-03 00:24:07 +00006595
6596
wdenk2729af92004-05-03 20:45:30 +00006597Coding Standards:
6598-----------------
wdenkc6097192002-11-03 00:24:07 +00006599
wdenk2729af92004-05-03 20:45:30 +00006600All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006601coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006602"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006603
Detlev Zundel2c051652006-09-01 15:39:02 +02006604Source files originating from a different project (for example the
6605MTD subsystem) are generally exempt from these guidelines and are not
6606reformated to ease subsequent migration to newer versions of those
6607sources.
6608
6609Please note that U-Boot is implemented in C (and to some small parts in
6610Assembler); no C++ is used, so please do not use C++ style comments (//)
6611in your code.
wdenk2729af92004-05-03 20:45:30 +00006612
6613Please also stick to the following formatting rules:
6614- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006615- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006616- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006617- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006618- do not add trailing empty lines to source files
6619
6620Submissions which do not conform to the standards may be returned
6621with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006622
6623
wdenk2729af92004-05-03 20:45:30 +00006624Submitting Patches:
6625-------------------
wdenkc6097192002-11-03 00:24:07 +00006626
wdenk2729af92004-05-03 20:45:30 +00006627Since the number of patches for U-Boot is growing, we need to
6628establish some rules. Submissions which do not conform to these rules
6629may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006630
Magnus Lilja0d28f342008-08-06 19:32:33 +02006631Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006632
Wolfgang Denk06682362008-12-30 22:56:11 +01006633Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6634see http://lists.denx.de/mailman/listinfo/u-boot
6635
wdenk2729af92004-05-03 20:45:30 +00006636When you send a patch, please include the following information with
6637it:
wdenkc6097192002-11-03 00:24:07 +00006638
wdenk2729af92004-05-03 20:45:30 +00006639* For bug fixes: a description of the bug and how your patch fixes
6640 this bug. Please try to include a way of demonstrating that the
6641 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006642
wdenk2729af92004-05-03 20:45:30 +00006643* For new features: a description of the feature and your
6644 implementation.
wdenkc6097192002-11-03 00:24:07 +00006645
wdenk2729af92004-05-03 20:45:30 +00006646* A CHANGELOG entry as plaintext (separate from the patch)
6647
6648* For major contributions, your entry to the CREDITS file
6649
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006650* When you add support for a new board, don't forget to add a
6651 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006652
6653* If your patch adds new configuration options, don't forget to
6654 document these in the README file.
6655
Wolfgang Denk218ca722008-03-26 10:40:12 +01006656* The patch itself. If you are using git (which is *strongly*
6657 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006658 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006659 the U-Boot mailing list, you will avoid most of the common problems
6660 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006661
Wolfgang Denk218ca722008-03-26 10:40:12 +01006662 If you cannot use git, use "diff -purN OLD NEW". If your version of
6663 diff does not support these options, then get the latest version of
6664 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006665
Wolfgang Denk218ca722008-03-26 10:40:12 +01006666 The current directory when running this command shall be the parent
6667 directory of the U-Boot source tree (i. e. please make sure that
6668 your patch includes sufficient directory information for the
6669 affected files).
6670
6671 We prefer patches as plain text. MIME attachments are discouraged,
6672 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006673
6674* If one logical set of modifications affects or creates several
6675 files, all these changes shall be submitted in a SINGLE patch file.
6676
6677* Changesets that contain different, unrelated modifications shall be
6678 submitted as SEPARATE patches, one patch per changeset.
6679
6680
6681Notes:
6682
6683* Before sending the patch, run the MAKEALL script on your patched
6684 source tree and make sure that no errors or warnings are reported
6685 for any of the boards.
6686
6687* Keep your modifications to the necessary minimum: A patch
6688 containing several unrelated changes or arbitrary reformats will be
6689 returned with a request to re-formatting / split it.
6690
6691* If you modify existing code, make sure that your new code does not
6692 add to the memory footprint of the code ;-) Small is beautiful!
6693 When adding new features, these should compile conditionally only
6694 (using #ifdef), and the resulting code with the new feature
6695 disabled must not need more memory than the old code without your
6696 modification.
wdenk90dc6702005-05-03 14:12:25 +00006697
Wolfgang Denk06682362008-12-30 22:56:11 +01006698* Remember that there is a size limit of 100 kB per message on the
6699 u-boot mailing list. Bigger patches will be moderated. If they are
6700 reasonable and not too big, they will be acknowledged. But patches
6701 bigger than the size limit should be avoided.