blob: 1ea397a35cadd7efcb7008e815ea13074320794c [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass75b3c3a2014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600274
275
Simon Glassdb910352015-03-03 08:03:00 -0700276Board Initialisation Flow:
277--------------------------
278
279This is the intended start-up flow for boards. This should apply for both
280SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281mostly uses a separate code path, but the funtion names and roles of each
282function are the same. Some boards or architectures may not conform to this.
283At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284
285Execution starts with start.S with three functions called during init after
286that. The purpose and limitations of each is described below.
287
288lowlevel_init():
289 - purpose: essential init to permit execution to reach board_init_f()
290 - no global_data or BSS
291 - there is no stack (ARMv7 may have one but it will soon be removed)
292 - must not set up SDRAM or use console
293 - must only do the bare minimum to allow execution to continue to
294 board_init_f()
295 - this is almost never needed
296 - return normally from this function
297
298board_init_f():
299 - purpose: set up the machine ready for running board_init_r():
300 i.e. SDRAM and serial UART
301 - global_data is available
302 - stack is in SRAM
303 - BSS is not available, so you cannot use global/static variables,
304 only stack variables and global_data
305
306 Non-SPL-specific notes:
307 - dram_init() is called to set up DRAM. If already done in SPL this
308 can do nothing
309
310 SPL-specific notes:
311 - you can override the entire board_init_f() function with your own
312 version as needed.
313 - preloader_console_init() can be called here in extremis
314 - should set up SDRAM, and anything needed to make the UART work
315 - these is no need to clear BSS, it will be done by crt0.S
316 - must return normally from this function (don't call board_init_r()
317 directly)
318
319Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320this point the stack and global_data are relocated to below
321CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322memory.
323
324board_init_r():
325 - purpose: main execution, common code
326 - global_data is available
327 - SDRAM is available
328 - BSS is available, all static/global variables can be used
329 - execution eventually continues to main_loop()
330
331 Non-SPL-specific notes:
332 - U-Boot is relocated to the top of memory and is now running from
333 there.
334
335 SPL-specific notes:
336 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337 CONFIG_SPL_STACK_R_ADDR points into SDRAM
338 - preloader_console_init() can be called here - typically this is
339 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340 spl_board_init() function containing this call
341 - loads U-Boot or (in falcon mode) Linux
342
343
344
wdenkc6097192002-11-03 00:24:07 +0000345Configuration Options:
346----------------------
347
348Configuration depends on the combination of board and CPU type; all
349such information is kept in a configuration file
350"include/configs/<board_name>.h".
351
352Example: For a TQM823L module, all configuration settings are in
353"include/configs/TQM823L.h".
354
355
wdenk7f6c2cb2002-11-10 22:06:23 +0000356Many of the options are named exactly as the corresponding Linux
357kernel configuration options. The intention is to make it easier to
358build a config tool - later.
359
360
wdenkc6097192002-11-03 00:24:07 +0000361The following options need to be configured:
362
Kim Phillips26281142007-08-10 13:28:25 -0500363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000364
Kim Phillips26281142007-08-10 13:28:25 -0500365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100368 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000369
370- CPU Module Type: (if CONFIG_COGENT is defined)
371 Define exactly one of
372 CONFIG_CMA286_60_OLD
373--- FIXME --- not tested yet:
374 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375 CONFIG_CMA287_23, CONFIG_CMA287_50
376
377- Motherboard Type: (if CONFIG_COGENT is defined)
378 Define exactly one of
379 CONFIG_CMA101, CONFIG_CMA102
380
381- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382 Define one or more of
383 CONFIG_CMA302
384
385- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386 Define one or more of
387 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200388 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000389 a "rotator" |\-/|\-/
390
Lei Wencf946c62011-02-09 18:06:58 +0530391- Marvell Family Member
392 CONFIG_SYS_MVFS - define it if you want to enable
393 multiple fs option at one time
394 for marvell soc family
395
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200396- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000401 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
402 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000403
wdenk66ca92a2004-09-28 17:59:53 +0000404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000407 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000408 See doc/README.MPC866
409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200410 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000411
wdenkba56f622004-02-06 23:19:44 +0000412 Define this to measure the actual CPU clock instead
413 of relying on the correctness of the configured
414 values. Mostly useful for board bringup to make sure
415 the PLL is locked at the intended frequency. Note
416 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200417 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000418
Heiko Schocher506f3912009-03-12 07:37:15 +0100419 CONFIG_SYS_DELAYED_ICACHE
420
421 Define this option if you want to enable the
422 ICache only when Code runs from RAM.
423
Kumar Gala66412c62011-02-18 05:40:54 -0600424- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000425 CONFIG_SYS_PPC64
426
427 Specifies that the core is a 64-bit PowerPC implementation (implements
428 the "64" category of the Power ISA). This is necessary for ePAPR
429 compliance, among other possible reasons.
430
Kumar Gala66412c62011-02-18 05:40:54 -0600431 CONFIG_SYS_FSL_TBCLK_DIV
432
433 Defines the core time base clock divider ratio compared to the
434 system clock. On most PQ3 devices this is 8, on newer QorIQ
435 devices it can be 16 or 32. The ratio varies from SoC to Soc.
436
Kumar Gala8f290842011-05-20 00:39:21 -0500437 CONFIG_SYS_FSL_PCIE_COMPAT
438
439 Defines the string to utilize when trying to match PCIe device
440 tree nodes for the given platform.
441
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000442 CONFIG_SYS_PPC_E500_DEBUG_TLB
443
444 Enables a temporary TLB entry to be used during boot to work
445 around limitations in e500v1 and e500v2 external debugger
446 support. This reduces the portions of the boot code where
447 breakpoints and single stepping do not work. The value of this
448 symbol should be set to the TLB1 entry to be used for this
449 purpose.
450
Scott Wood33eee332012-08-14 10:14:53 +0000451 CONFIG_SYS_FSL_ERRATUM_A004510
452
453 Enables a workaround for erratum A004510. If set,
454 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
455 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
456
457 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
458 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
459
460 Defines one or two SoC revisions (low 8 bits of SVR)
461 for which the A004510 workaround should be applied.
462
463 The rest of SVR is either not relevant to the decision
464 of whether the erratum is present (e.g. p2040 versus
465 p2041) or is implied by the build target, which controls
466 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
467
468 See Freescale App Note 4493 for more information about
469 this erratum.
470
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800473 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530474
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800477 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530478
Scott Wood33eee332012-08-14 10:14:53 +0000479 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
480
481 This is the value to write into CCSR offset 0x18600
482 according to the A004510 workaround.
483
Priyanka Jain64501c62013-07-02 09:21:04 +0530484 CONFIG_SYS_FSL_DSP_DDR_ADDR
485 This value denotes start offset of DDR memory which is
486 connected exclusively to the DSP cores.
487
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530488 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489 This value denotes start offset of M2 memory
490 which is directly connected to the DSP core.
491
Priyanka Jain64501c62013-07-02 09:21:04 +0530492 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
493 This value denotes start offset of M3 memory which is directly
494 connected to the DSP core.
495
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
Priyanka Jainb1359912013-12-17 14:25:52 +0530499 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500 Single Source Clock is clocking mode present in some of FSL SoC's.
501 In this mode, a single differential clock is used to supply
502 clocks to the sysclock, ddrclock and usbclock.
503
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530504 CONFIG_SYS_CPC_REINIT_F
505 This CONFIG is defined when the CPC is configured as SRAM at the
506 time of U-boot entry and is required to be re-initialized.
507
Tang Yuantianaade2002014-04-17 15:33:46 +0800508 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800509 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800510 supported, core will start to execute uboot when wakes up.
511
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000512- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700513 CONFIG_SYS_GENERIC_GLOBAL_DATA
514 Defines global data is initialized in generic board board_init_f().
515 If this macro is defined, global data is created and cleared in
516 generic board board_init_f(). Without this macro, architecture/board
517 should initialize global data before calling board_init_f().
518
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000519 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
520
521 Defines the endianess of the CPU. Implementation of those
522 values is arch specific.
523
York Sun5614e712013-09-30 09:22:09 -0700524 CONFIG_SYS_FSL_DDR
525 Freescale DDR driver in use. This type of DDR controller is
526 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
527 SoCs.
528
529 CONFIG_SYS_FSL_DDR_ADDR
530 Freescale DDR memory-mapped register base.
531
532 CONFIG_SYS_FSL_DDR_EMU
533 Specify emulator support for DDR. Some DDR features such as
534 deskew training are not available.
535
536 CONFIG_SYS_FSL_DDRC_GEN1
537 Freescale DDR1 controller.
538
539 CONFIG_SYS_FSL_DDRC_GEN2
540 Freescale DDR2 controller.
541
542 CONFIG_SYS_FSL_DDRC_GEN3
543 Freescale DDR3 controller.
544
York Sun34e026f2014-03-27 17:54:47 -0700545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
York Sun9ac4ffb2013-09-30 14:20:51 -0700548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
York Sun5614e712013-09-30 09:22:09 -0700551 CONFIG_SYS_FSL_DDR1
552 Board config to use DDR1. It can be enabled for SoCs with
553 Freescale DDR1 or DDR2 controllers, depending on the board
554 implemetation.
555
556 CONFIG_SYS_FSL_DDR2
557 Board config to use DDR2. It can be eanbeld for SoCs with
558 Freescale DDR2 or DDR3 controllers, depending on the board
559 implementation.
560
561 CONFIG_SYS_FSL_DDR3
562 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700563 Freescale DDR3 or DDR3L controllers.
564
565 CONFIG_SYS_FSL_DDR3L
566 Board config to use DDR3L. It can be enabled for SoCs with
567 DDR3L controllers.
568
569 CONFIG_SYS_FSL_DDR4
570 Board config to use DDR4. It can be enabled for SoCs with
571 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700572
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530573 CONFIG_SYS_FSL_IFC_BE
574 Defines the IFC controller register space as Big Endian
575
576 CONFIG_SYS_FSL_IFC_LE
577 Defines the IFC controller register space as Little Endian
578
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530579 CONFIG_SYS_FSL_PBL_PBI
580 It enables addition of RCW (Power on reset configuration) in built image.
581 Please refer doc/README.pblimage for more details
582
583 CONFIG_SYS_FSL_PBL_RCW
584 It adds PBI(pre-boot instructions) commands in u-boot build image.
585 PBI commands can be used to configure SoC before it starts the execution.
586 Please refer doc/README.pblimage for more details
587
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530588 CONFIG_SPL_FSL_PBL
589 It adds a target to create boot binary having SPL binary in PBI format
590 concatenated with u-boot binary.
591
York Sun4e5b1bd2014-02-10 13:59:42 -0800592 CONFIG_SYS_FSL_DDR_BE
593 Defines the DDR controller register space as Big Endian
594
595 CONFIG_SYS_FSL_DDR_LE
596 Defines the DDR controller register space as Little Endian
597
York Sun6b9e3092014-02-10 13:59:43 -0800598 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
599 Physical address from the view of DDR controllers. It is the
600 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
601 it could be different for ARM SoCs.
602
York Sun6b1e1252014-02-10 13:59:44 -0800603 CONFIG_SYS_FSL_DDR_INTLV_256B
604 DDR controller interleaving on 256-byte. This is a special
605 interleaving mode, handled by Dickens for Freescale layerscape
606 SoCs with ARM core.
607
York Sun1d71efb2014-08-01 15:51:00 -0700608 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
609 Number of controllers used as main memory.
610
611 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
612 Number of controllers used for other than main memory.
613
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530614 CONFIG_SYS_FSL_SEC_BE
615 Defines the SEC controller register space as Big Endian
616
617 CONFIG_SYS_FSL_SEC_LE
618 Defines the SEC controller register space as Little Endian
619
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100620- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100622
623 Defines the Monahans run mode to oscillator
624 ratio. Valid values are 8, 16, 24, 31. The core
625 frequency is this value multiplied by 13 MHz.
626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200628
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200631 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100632 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200633
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200634- MIPS CPU options:
635 CONFIG_SYS_INIT_SP_OFFSET
636
637 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
638 pointer. This is needed for the temporary stack before
639 relocation.
640
641 CONFIG_SYS_MIPS_CACHE_MODE
642
643 Cache operation mode for the MIPS CPU.
644 See also arch/mips/include/asm/mipsregs.h.
645 Possible values are:
646 CONF_CM_CACHABLE_NO_WA
647 CONF_CM_CACHABLE_WA
648 CONF_CM_UNCACHED
649 CONF_CM_CACHABLE_NONCOHERENT
650 CONF_CM_CACHABLE_CE
651 CONF_CM_CACHABLE_COW
652 CONF_CM_CACHABLE_CUW
653 CONF_CM_CACHABLE_ACCELERATED
654
655 CONFIG_SYS_XWAY_EBU_BOOTCFG
656
657 Special option for Lantiq XWAY SoCs for booting from NOR flash.
658 See also arch/mips/cpu/mips32/start.S.
659
660 CONFIG_XWAY_SWAP_BYTES
661
662 Enable compilation of tools/xway-swap-bytes needed for Lantiq
663 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
664 be swapped if a flash programmer is used.
665
Christian Rieschb67d8812012-02-02 00:44:39 +0000666- ARM options:
667 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668
669 Select high exception vectors of the ARM core, e.g., do not
670 clear the V bit of the c1 register of CP15.
671
Aneesh V5356f542012-03-08 07:20:19 +0000672 CONFIG_SYS_THUMB_BUILD
673
674 Use this flag to build U-Boot using the Thumb instruction
675 set for ARM architectures. Thumb instruction set provides
676 better code density. For ARM architectures that support
677 Thumb2 this flag will result in Thumb2 code generated by
678 GCC.
679
Stephen Warrenc5d47522013-03-04 13:29:40 +0000680 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500684 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500685 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000686
687 If set, the workarounds for these ARM errata are applied early
688 during U-Boot startup. Note that these options force the
689 workarounds to be applied; no CPU-type/version detection
690 exists, unlike the similar options in the Linux kernel. Do not
691 set these options unless they apply!
692
York Sun207774b2015-03-20 19:28:08 -0700693 COUNTER_FREQUENCY
694 Generic timer clock source frequency.
695
696 COUNTER_FREQUENCY_REAL
697 Generic timer clock source frequency if the real clock is
698 different from COUNTER_FREQUENCY, and can only be determined
699 at run time.
700
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500701 NOTE: The following can be machine specific errata. These
702 do have ability to provide rudimentary version and machine
703 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500704 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500705 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500706 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500707 CONFIG_ARM_ERRATA_798870
708
Stephen Warren73c38932015-01-19 16:25:52 -0700709- Tegra SoC options:
710 CONFIG_TEGRA_SUPPORT_NON_SECURE
711
712 Support executing U-Boot in non-secure (NS) mode. Certain
713 impossible actions will be skipped if the CPU is in NS mode,
714 such as ARM architectural timer initialization.
715
wdenk5da627a2003-10-09 20:09:04 +0000716- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000717 CONFIG_CLOCKS_IN_MHZ
718
719 U-Boot stores all clock information in Hz
720 internally. For binary compatibility with older Linux
721 kernels (which expect the clocks passed in the
722 bd_info data to be in MHz) the environment variable
723 "clocks_in_mhz" can be defined so that U-Boot
724 converts clock data to MHZ before passing it to the
725 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000726 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100727 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000728 default environment.
729
wdenk5da627a2003-10-09 20:09:04 +0000730 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
731
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800732 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000733 expect it to be in bytes, others in MB.
734 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
735
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400736 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200737
738 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400739 passed using flattened device trees (based on open firmware
740 concepts).
741
742 CONFIG_OF_LIBFDT
743 * New libfdt-based support
744 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500745 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400746
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200747 OF_CPU - The proper name of the cpus node (only required for
748 MPC512X and MPC5xxx based boards).
749 OF_SOC - The proper name of the soc node (only required for
750 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200751 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600752 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200753
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200754 boards with QUICC Engines require OF_QE to set UCC MAC
755 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500756
Kumar Gala4e253132006-01-11 13:54:17 -0600757 CONFIG_OF_BOARD_SETUP
758
759 Board code has addition modification that it wants to make
760 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000761
Simon Glassc654b512014-10-23 18:58:54 -0600762 CONFIG_OF_SYSTEM_SETUP
763
764 Other code has addition modification that it wants to make
765 to the flat device tree before handing it off to the kernel.
766 This causes ft_system_setup() to be called before booting
767 the kernel.
768
Matthew McClintock02677682006-06-28 10:41:37 -0500769 CONFIG_OF_BOOT_CPU
770
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200771 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500772 param header, the default value is zero if undefined.
773
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200774 CONFIG_OF_IDE_FIXUP
775
776 U-Boot can detect if an IDE device is present or not.
777 If not, and this new config option is activated, U-Boot
778 removes the ATA node from the DTS before booting Linux,
779 so the Linux IDE driver does not probe the device and
780 crash. This is needed for buggy hardware (uc101) where
781 no pull down resistor is connected to the signal IDE5V_DD7.
782
Igor Grinberg7eb29392011-07-14 05:45:07 +0000783 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
784
785 This setting is mandatory for all boards that have only one
786 machine type and must be used to specify the machine type
787 number as it appears in the ARM machine registry
788 (see http://www.arm.linux.org.uk/developer/machines/).
789 Only boards that have multiple machine types supported
790 in a single configuration file and the machine type is
791 runtime discoverable, do not have to use this setting.
792
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100793- vxWorks boot parameters:
794
795 bootvx constructs a valid bootline using the following
796 environments variables: bootfile, ipaddr, serverip, hostname.
797 It loads the vxWorks image pointed bootfile.
798
799 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
800 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
801 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
802 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
803
804 CONFIG_SYS_VXWORKS_ADD_PARAMS
805
806 Add it at the end of the bootline. E.g "u=username pw=secret"
807
808 Note: If a "bootargs" environment is defined, it will overwride
809 the defaults discussed just above.
810
Aneesh V2c451f72011-06-16 23:30:47 +0000811- Cache Configuration:
812 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
813 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
814 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
815
Aneesh V93bc2192011-06-16 23:30:51 +0000816- Cache Configuration for ARM:
817 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
818 controller
819 CONFIG_SYS_PL310_BASE - Physical base address of PL310
820 controller register space
821
wdenk6705d812004-08-02 23:22:59 +0000822- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200823 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000824
825 Define this if you want support for Amba PrimeCell PL010 UARTs.
826
Andreas Engel48d01922008-09-08 14:30:53 +0200827 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000828
829 Define this if you want support for Amba PrimeCell PL011 UARTs.
830
831 CONFIG_PL011_CLOCK
832
833 If you have Amba PrimeCell PL011 UARTs, set this variable to
834 the clock speed of the UARTs.
835
836 CONFIG_PL01x_PORTS
837
838 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
839 define this to a list of base addresses for each (supported)
840 port. See e.g. include/configs/versatile.h
841
John Rigby910f1ae2011-04-19 10:42:39 +0000842 CONFIG_PL011_SERIAL_RLCR
843
844 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
845 have separate receive and transmit line control registers. Set
846 this variable to initialize the extra register.
847
848 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
849
850 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
851 boot loader that has already initialized the UART. Define this
852 variable to flush the UART at init time.
853
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400854 CONFIG_SERIAL_HW_FLOW_CONTROL
855
856 Define this variable to enable hw flow control in serial driver.
857 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000858
wdenkc6097192002-11-03 00:24:07 +0000859- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000860 Depending on board, define exactly one serial port
861 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
862 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
863 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000864
865 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
866 port routines must be defined elsewhere
867 (i.e. serial_init(), serial_getc(), ...)
868
869 CONFIG_CFB_CONSOLE
870 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000871 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000872 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
873 (default big endian)
874 VIDEO_HW_RECTFILL graphic chip supports
875 rectangle fill
876 (cf. smiLynxEM)
877 VIDEO_HW_BITBLT graphic chip supports
878 bit-blit (cf. smiLynxEM)
879 VIDEO_VISIBLE_COLS visible pixel columns
880 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000881 VIDEO_VISIBLE_ROWS visible pixel rows
882 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000883 VIDEO_DATA_FORMAT graphic data format
884 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000885 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000886 VIDEO_KBD_INIT_FCT keyboard int fct
887 (i.e. i8042_kbd_init())
888 VIDEO_TSTC_FCT test char fct
889 (i.e. i8042_tstc)
890 VIDEO_GETC_FCT get char fct
891 (i.e. i8042_getc)
892 CONFIG_CONSOLE_CURSOR cursor drawing on/off
893 (requires blink timer
894 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200895 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000896 CONFIG_CONSOLE_TIME display time/date info in
897 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500898 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000899 CONFIG_VIDEO_LOGO display Linux logo in
900 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000901 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
902 linux_logo.h for logo.
903 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000904 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200905 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000906 the logo
907
Pali Rohár33a35bb2012-10-19 13:30:09 +0000908 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
909 a limited number of ANSI escape sequences (cursor control,
910 erase functions and limited graphics rendition control).
911
wdenk43d96162003-03-06 00:02:04 +0000912 When CONFIG_CFB_CONSOLE is defined, video console is
913 default i/o. Serial console can be forced with
914 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000915
wdenkd4ca31c2004-01-02 14:00:00 +0000916 When CONFIG_SILENT_CONSOLE is defined, all console
917 messages (by U-Boot and Linux!) can be silenced with
918 the "silent" environment variable. See
919 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000920
Heiko Schocher45ae2542013-10-22 11:06:06 +0200921 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
922 is 0x00.
923 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
924 is 0xa0.
925
wdenkc6097192002-11-03 00:24:07 +0000926- Console Baudrate:
927 CONFIG_BAUDRATE - in bps
928 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200929 CONFIG_SYS_BAUDRATE_TABLE, see below.
930 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000931
Heiko Schocherc92fac92009-01-30 12:55:38 +0100932- Console Rx buffer length
933 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
934 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100935 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100936 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
937 must be defined, to setup the maximum idle timeout for
938 the SMC.
939
Graeme Russ9558b482011-09-01 00:48:27 +0000940- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200941 Prior to the console being initialised (i.e. serial UART
942 initialised etc) all console output is silently discarded.
943 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
944 buffer any console messages prior to the console being
945 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
946 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
947 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200948 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200949 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000950
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200951 'Sane' compilers will generate smaller code if
952 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000953
Sonny Rao046a37b2011-11-02 09:52:08 +0000954- Safe printf() functions
955 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
956 the printf() functions. These are defined in
957 include/vsprintf.h and include snprintf(), vsnprintf() and
958 so on. Code size increase is approximately 300-500 bytes.
959 If this option is not given then these functions will
960 silently discard their buffer size argument - this means
961 you are not getting any overflow checking in this case.
962
wdenkc6097192002-11-03 00:24:07 +0000963- Boot Delay: CONFIG_BOOTDELAY - in seconds
964 Delay before automatically booting the default image;
965 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000966 set to -2 to autoboot with no delay and not check for abort
967 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000968
969 See doc/README.autoboot for these options that
970 work with CONFIG_BOOTDELAY. None are required.
971 CONFIG_BOOT_RETRY_TIME
972 CONFIG_BOOT_RETRY_MIN
973 CONFIG_AUTOBOOT_KEYED
974 CONFIG_AUTOBOOT_PROMPT
975 CONFIG_AUTOBOOT_DELAY_STR
976 CONFIG_AUTOBOOT_STOP_STR
977 CONFIG_AUTOBOOT_DELAY_STR2
978 CONFIG_AUTOBOOT_STOP_STR2
979 CONFIG_ZERO_BOOTDELAY_CHECK
980 CONFIG_RESET_TO_RETRY
981
982- Autoboot Command:
983 CONFIG_BOOTCOMMAND
984 Only needed when CONFIG_BOOTDELAY is enabled;
985 define a command string that is automatically executed
986 when no character is read on the console interface
987 within "Boot Delay" after reset.
988
989 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000990 This can be used to pass arguments to the bootm
991 command. The value of CONFIG_BOOTARGS goes into the
992 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000993
994 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000995 The value of these goes into the environment as
996 "ramboot" and "nfsboot" respectively, and can be used
997 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200998 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000999
Heiko Schochereda0ba32013-11-04 14:04:59 +01001000- Bootcount:
1001 CONFIG_BOOTCOUNT_LIMIT
1002 Implements a mechanism for detecting a repeating reboot
1003 cycle, see:
1004 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1005
1006 CONFIG_BOOTCOUNT_ENV
1007 If no softreset save registers are found on the hardware
1008 "bootcount" is stored in the environment. To prevent a
1009 saveenv on all reboots, the environment variable
1010 "upgrade_available" is used. If "upgrade_available" is
1011 0, "bootcount" is always 0, if "upgrade_available" is
1012 1 "bootcount" is incremented in the environment.
1013 So the Userspace Applikation must set the "upgrade_available"
1014 and "bootcount" variable to 0, if a boot was successfully.
1015
wdenkc6097192002-11-03 00:24:07 +00001016- Pre-Boot Commands:
1017 CONFIG_PREBOOT
1018
1019 When this option is #defined, the existence of the
1020 environment variable "preboot" will be checked
1021 immediately before starting the CONFIG_BOOTDELAY
1022 countdown and/or running the auto-boot command resp.
1023 entering interactive mode.
1024
1025 This feature is especially useful when "preboot" is
1026 automatically generated or modified. For an example
1027 see the LWMON board specific code: here "preboot" is
1028 modified when the user holds down a certain
1029 combination of keys on the (special) keyboard when
1030 booting the systems
1031
1032- Serial Download Echo Mode:
1033 CONFIG_LOADS_ECHO
1034 If defined to 1, all characters received during a
1035 serial download (using the "loads" command) are
1036 echoed back. This might be needed by some terminal
1037 emulations (like "cu"), but may as well just take
1038 time on others. This setting #define's the initial
1039 value of the "loads_echo" environment variable.
1040
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001041- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001042 CONFIG_KGDB_BAUDRATE
1043 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001044 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001045
1046- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001047 Monitor commands can be included or excluded
1048 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001049 <config_cmd_all.h> and #undef'ing unwanted
1050 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 and augmenting with additional #define's
1052 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001053
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001054 The default command configuration includes all commands
1055 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001056
Marek Vasutb401b732014-03-05 19:58:39 +01001057 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001058 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001059 CONFIG_CMD_BDI bdinfo
1060 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1061 CONFIG_CMD_BMP * BMP support
1062 CONFIG_CMD_BSP * Board specific commands
1063 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001064 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001065 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001066 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001067 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001068 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 CONFIG_CMD_DATE * support for RTC, date/time...
1070 CONFIG_CMD_DHCP * DHCP support
1071 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001072 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1073 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1074 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1075 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001076 CONFIG_CMD_DTT * Digital Therm and Thermostat
1077 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001078 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001079 CONFIG_CMD_EEPROM * EEPROM read/write support
1080 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001081 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001082 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001083 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001084 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001085 CONFIG_CMD_EXT2 * ext2 command support
1086 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001087 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1088 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001089 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001090 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001091 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001092 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001093 CONFIG_CMD_FLASH flinfo, erase, protect
1094 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001095 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001096 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001097 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001098 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001099 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001100 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1101 CONFIG_CMD_I2C * I2C serial bus support
1102 CONFIG_CMD_IDE * IDE harddisk support
1103 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001104 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001105 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001106 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001107 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001108 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001109 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001110 CONFIG_CMD_IRQ * irqinfo
1111 CONFIG_CMD_ITEST Integer/string test of 2 values
1112 CONFIG_CMD_JFFS2 * JFFS2 Support
1113 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001114 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001115 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1116 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001117 CONFIG_CMD_LOADB loadb
1118 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001119 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001120 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001121 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001122 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001123 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001124 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001125 CONFIG_CMD_MISC Misc functions like sleep etc
1126 CONFIG_CMD_MMC * MMC memory mapped support
1127 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001128 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001129 CONFIG_CMD_NAND * NAND support
1130 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001131 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001132 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001133 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001134 CONFIG_CMD_PCI * pciinfo
1135 CONFIG_CMD_PCMCIA * PCMCIA support
1136 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1137 host
1138 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001139 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001140 CONFIG_CMD_REGINFO * Register dump
1141 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001142 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001143 CONFIG_CMD_SAVES * save S record dump
1144 CONFIG_CMD_SCSI * SCSI Support
1145 CONFIG_CMD_SDRAM * print SDRAM configuration information
1146 (requires CONFIG_CMD_I2C)
1147 CONFIG_CMD_SETGETDCR Support for DCR Register access
1148 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001149 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001150 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001151 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001152 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001153 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001154 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001155 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001156 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001157 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1158 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001159 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001160 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001161 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001162 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001163 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001164
1165 EXAMPLE: If you want all functions except of network
1166 support you can write:
1167
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001168 #include "config_cmd_all.h"
1169 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001170
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001171 Other Commands:
1172 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001173
1174 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001175 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001176 what you (and your U-Boot users) are doing. Data
1177 cache cannot be enabled on systems like the 8xx or
1178 8260 (where accesses to the IMMR region must be
1179 uncached), and it cannot be disabled on all other
1180 systems where we (mis-) use the data cache to hold an
1181 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001182
1183
1184 XXX - this list needs to get updated!
1185
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001186- Regular expression support:
1187 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001188 If this variable is defined, U-Boot is linked against
1189 the SLRE (Super Light Regular Expression) library,
1190 which adds regex support to some commands, as for
1191 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001192
Simon Glass45ba8072011-10-15 05:48:20 +00001193- Device tree:
1194 CONFIG_OF_CONTROL
1195 If this variable is defined, U-Boot will use a device tree
1196 to configure its devices, instead of relying on statically
1197 compiled #defines in the board file. This option is
1198 experimental and only available on a few boards. The device
1199 tree is available in the global data as gd->fdt_blob.
1200
Simon Glass2c0f79e2011-10-24 19:15:31 +00001201 U-Boot needs to get its device tree from somewhere. This can
1202 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001203
1204 CONFIG_OF_EMBED
1205 If this variable is defined, U-Boot will embed a device tree
1206 binary in its image. This device tree file should be in the
1207 board directory and called <soc>-<board>.dts. The binary file
1208 is then picked up in board_init_f() and made available through
1209 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001210
Simon Glass2c0f79e2011-10-24 19:15:31 +00001211 CONFIG_OF_SEPARATE
1212 If this variable is defined, U-Boot will build a device tree
1213 binary. It will be called u-boot.dtb. Architecture-specific
1214 code will locate it at run-time. Generally this works by:
1215
1216 cat u-boot.bin u-boot.dtb >image.bin
1217
1218 and in fact, U-Boot does this for you, creating a file called
1219 u-boot-dtb.bin which is useful in the common case. You can
1220 still use the individual files if you need something more
1221 exotic.
1222
wdenkc6097192002-11-03 00:24:07 +00001223- Watchdog:
1224 CONFIG_WATCHDOG
1225 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001226 support for the SoC. There must be support in the SoC
1227 specific code for a watchdog. For the 8xx and 8260
1228 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1229 register. When supported for a specific SoC is
1230 available, then no further board specific code should
1231 be needed to use it.
1232
1233 CONFIG_HW_WATCHDOG
1234 When using a watchdog circuitry external to the used
1235 SoC, then define this variable and provide board
1236 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001237
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001238 CONFIG_AT91_HW_WDT_TIMEOUT
1239 specify the timeout in seconds. default 2 seconds.
1240
stroesec1551ea2003-04-04 15:53:41 +00001241- U-Boot Version:
1242 CONFIG_VERSION_VARIABLE
1243 If this variable is defined, an environment variable
1244 named "ver" is created by U-Boot showing the U-Boot
1245 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001246 Any change to this variable will be reverted at the
1247 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001248
wdenkc6097192002-11-03 00:24:07 +00001249- Real-Time Clock:
1250
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001251 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001252 has to be selected, too. Define exactly one of the
1253 following options:
1254
1255 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1256 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001257 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001258 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001259 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001260 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001261 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001262 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001263 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001264 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001265 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001266 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001267 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1268 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001269
wdenkb37c7e52003-06-30 16:24:52 +00001270 Note that if the RTC uses I2C, then the I2C interface
1271 must also be configured. See I2C Support, below.
1272
Peter Tysere92739d2008-12-17 16:36:21 -06001273- GPIO Support:
1274 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001275
Chris Packham5dec49c2010-12-19 10:12:13 +00001276 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1277 chip-ngpio pairs that tell the PCA953X driver the number of
1278 pins supported by a particular chip.
1279
Peter Tysere92739d2008-12-17 16:36:21 -06001280 Note that if the GPIO device uses I2C, then the I2C interface
1281 must also be configured. See I2C Support, below.
1282
Simon Glassaa532332014-06-11 23:29:41 -06001283- I/O tracing:
1284 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1285 accesses and can checksum them or write a list of them out
1286 to memory. See the 'iotrace' command for details. This is
1287 useful for testing device drivers since it can confirm that
1288 the driver behaves the same way before and after a code
1289 change. Currently this is supported on sandbox and arm. To
1290 add support for your architecture, add '#include <iotrace.h>'
1291 to the bottom of arch/<arch>/include/asm/io.h and test.
1292
1293 Example output from the 'iotrace stats' command is below.
1294 Note that if the trace buffer is exhausted, the checksum will
1295 still continue to operate.
1296
1297 iotrace is enabled
1298 Start: 10000000 (buffer start address)
1299 Size: 00010000 (buffer size)
1300 Offset: 00000120 (current buffer offset)
1301 Output: 10000120 (start + offset)
1302 Count: 00000018 (number of trace records)
1303 CRC32: 9526fb66 (CRC32 of all trace records)
1304
wdenkc6097192002-11-03 00:24:07 +00001305- Timestamp Support:
1306
wdenk43d96162003-03-06 00:02:04 +00001307 When CONFIG_TIMESTAMP is selected, the timestamp
1308 (date and time) of an image is printed by image
1309 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001310 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001311
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001312- Partition Labels (disklabels) Supported:
1313 Zero or more of the following:
1314 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1315 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1316 Intel architecture, USB sticks, etc.
1317 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1318 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1319 bootloader. Note 2TB partition limit; see
1320 disk/part_efi.c
1321 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001322
Wolfgang Denk218ca722008-03-26 10:40:12 +01001323 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1324 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001325 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001326
1327- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001328 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1329 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001330
wdenk4d13cba2004-03-14 14:09:05 +00001331 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1332 be performed by calling the function
1333 ide_set_reset(int reset)
1334 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001335
1336- ATAPI Support:
1337 CONFIG_ATAPI
1338
1339 Set this to enable ATAPI support.
1340
wdenkc40b2952004-03-13 23:29:43 +00001341- LBA48 Support
1342 CONFIG_LBA48
1343
1344 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001345 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001346 Whithout these , LBA48 support uses 32bit variables and will 'only'
1347 support disks up to 2.1TB.
1348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001349 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001350 When enabled, makes the IDE subsystem use 64bit sector addresses.
1351 Default is 32bit.
1352
wdenkc6097192002-11-03 00:24:07 +00001353- SCSI Support:
1354 At the moment only there is only support for the
1355 SYM53C8XX SCSI controller; define
1356 CONFIG_SCSI_SYM53C8XX to enable it.
1357
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001358 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1359 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1360 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001361 maximum numbers of LUNs, SCSI ID's and target
1362 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001363 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001364
Wolfgang Denk93e14592013-10-04 17:43:24 +02001365 The environment variable 'scsidevs' is set to the number of
1366 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001367
wdenkc6097192002-11-03 00:24:07 +00001368- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001369 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001370 Support for Intel 8254x/8257x gigabit chips.
1371
1372 CONFIG_E1000_SPI
1373 Utility code for direct access to the SPI bus on Intel 8257x.
1374 This does not do anything useful unless you set at least one
1375 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1376
1377 CONFIG_E1000_SPI_GENERIC
1378 Allow generic access to the SPI bus on the Intel 8257x, for
1379 example with the "sspi" command.
1380
1381 CONFIG_CMD_E1000
1382 Management command for E1000 devices. When used on devices
1383 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001384
Andre Schwarzac3315c2008-03-06 16:45:44 +01001385 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001386 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001387
wdenkc6097192002-11-03 00:24:07 +00001388 CONFIG_EEPRO100
1389 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001390 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001391 write routine for first time initialisation.
1392
1393 CONFIG_TULIP
1394 Support for Digital 2114x chips.
1395 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1396 modem chip initialisation (KS8761/QS6611).
1397
1398 CONFIG_NATSEMI
1399 Support for National dp83815 chips.
1400
1401 CONFIG_NS8382X
1402 Support for National dp8382[01] gigabit chips.
1403
wdenk45219c42003-05-12 21:50:16 +00001404- NETWORK Support (other):
1405
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001406 CONFIG_DRIVER_AT91EMAC
1407 Support for AT91RM9200 EMAC.
1408
1409 CONFIG_RMII
1410 Define this to use reduced MII inteface
1411
1412 CONFIG_DRIVER_AT91EMAC_QUIET
1413 If this defined, the driver is quiet.
1414 The driver doen't show link status messages.
1415
Rob Herringefdd7312011-12-15 11:15:49 +00001416 CONFIG_CALXEDA_XGMAC
1417 Support for the Calxeda XGMAC device
1418
Ashok3bb46d22012-10-15 06:20:47 +00001419 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001420 Support for SMSC's LAN91C96 chips.
1421
1422 CONFIG_LAN91C96_BASE
1423 Define this to hold the physical address
1424 of the LAN91C96's I/O space
1425
1426 CONFIG_LAN91C96_USE_32_BIT
1427 Define this to enable 32 bit addressing
1428
Ashok3bb46d22012-10-15 06:20:47 +00001429 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001430 Support for SMSC's LAN91C111 chip
1431
1432 CONFIG_SMC91111_BASE
1433 Define this to hold the physical address
1434 of the device (I/O space)
1435
1436 CONFIG_SMC_USE_32_BIT
1437 Define this if data bus is 32 bits
1438
1439 CONFIG_SMC_USE_IOFUNCS
1440 Define this to use i/o functions instead of macros
1441 (some hardware wont work with macros)
1442
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001443 CONFIG_DRIVER_TI_EMAC
1444 Support for davinci emac
1445
1446 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1447 Define this if you have more then 3 PHYs.
1448
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001449 CONFIG_FTGMAC100
1450 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1451
1452 CONFIG_FTGMAC100_EGIGA
1453 Define this to use GE link update with gigabit PHY.
1454 Define this if FTGMAC100 is connected to gigabit PHY.
1455 If your system has 10/100 PHY only, it might not occur
1456 wrong behavior. Because PHY usually return timeout or
1457 useless data when polling gigabit status and gigabit
1458 control registers. This behavior won't affect the
1459 correctnessof 10/100 link speed update.
1460
Mike Rapoportc2fff332009-11-11 10:03:03 +02001461 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001462 Support for SMSC's LAN911x and LAN921x chips
1463
Mike Rapoportc2fff332009-11-11 10:03:03 +02001464 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001465 Define this to hold the physical address
1466 of the device (I/O space)
1467
Mike Rapoportc2fff332009-11-11 10:03:03 +02001468 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001469 Define this if data bus is 32 bits
1470
Mike Rapoportc2fff332009-11-11 10:03:03 +02001471 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001472 Define this if data bus is 16 bits. If your processor
1473 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001474 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001475
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001476 CONFIG_SH_ETHER
1477 Support for Renesas on-chip Ethernet controller
1478
1479 CONFIG_SH_ETHER_USE_PORT
1480 Define the number of ports to be used
1481
1482 CONFIG_SH_ETHER_PHY_ADDR
1483 Define the ETH PHY's address
1484
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001485 CONFIG_SH_ETHER_CACHE_WRITEBACK
1486 If this option is set, the driver enables cache flush.
1487
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001488- PWM Support:
1489 CONFIG_PWM_IMX
1490 Support for PWM modul on the imx6.
1491
Vadim Bendebury5e124722011-10-17 08:36:14 +00001492- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001493 CONFIG_TPM
1494 Support TPM devices.
1495
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001496 CONFIG_TPM_TIS_I2C
1497 Support for i2c bus TPM devices. Only one device
1498 per system is supported at this time.
1499
1500 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1501 Define the the i2c bus number for the TPM device
1502
1503 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1504 Define the TPM's address on the i2c bus
1505
1506 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1507 Define the burst count bytes upper limit
1508
Dirk Eibachc01939c2013-06-26 15:55:15 +02001509 CONFIG_TPM_ATMEL_TWI
1510 Support for Atmel TWI TPM device. Requires I2C support.
1511
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001512 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001513 Support for generic parallel port TPM devices. Only one device
1514 per system is supported at this time.
1515
1516 CONFIG_TPM_TIS_BASE_ADDRESS
1517 Base address where the generic TPM device is mapped
1518 to. Contemporary x86 systems usually map it at
1519 0xfed40000.
1520
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001521 CONFIG_CMD_TPM
1522 Add tpm monitor functions.
1523 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1524 provides monitor access to authorized functions.
1525
1526 CONFIG_TPM
1527 Define this to enable the TPM support library which provides
1528 functional interfaces to some TPM commands.
1529 Requires support for a TPM device.
1530
1531 CONFIG_TPM_AUTH_SESSIONS
1532 Define this to enable authorized functions in the TPM library.
1533 Requires CONFIG_TPM and CONFIG_SHA1.
1534
wdenkc6097192002-11-03 00:24:07 +00001535- USB Support:
1536 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001537 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001538 CONFIG_USB_UHCI to enable it.
1539 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001540 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001541 storage devices.
1542 Note:
1543 Supported are USB Keyboards and USB Floppy drives
1544 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001545 MPC5200 USB requires additional defines:
1546 CONFIG_USB_CLOCK
1547 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001548 CONFIG_PSC3_USB
1549 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001550 CONFIG_USB_CONFIG
1551 for differential drivers: 0x00001000
1552 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001553 for differential drivers on PSC3: 0x00000100
1554 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001555 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001556 May be defined to allow interrupt polling
1557 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001558
Simon Glass9ab4ce22012-02-27 10:52:47 +00001559 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1560 txfilltuning field in the EHCI controller on reset.
1561
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001562 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1563 HW module registers.
1564
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001565- USB Device:
1566 Define the below if you wish to use the USB console.
1567 Once firmware is rebuilt from a serial console issue the
1568 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001569 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001570 it has found a new device. The environment variable usbtty
1571 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001572 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001573 Common Device Class Abstract Control Model serial device.
1574 If you select usbtty = gserial you should be able to enumerate
1575 a Linux host by
1576 # modprobe usbserial vendor=0xVendorID product=0xProductID
1577 else if using cdc_acm, simply setting the environment
1578 variable usbtty to be cdc_acm should suffice. The following
1579 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001580
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001581 CONFIG_USB_DEVICE
1582 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001583
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001584 CONFIG_USB_TTY
1585 Define this to have a tty type of device available to
1586 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001587
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301588 CONFIG_USBD_HS
1589 Define this to enable the high speed support for usb
1590 device and usbtty. If this feature is enabled, a routine
1591 int is_usbd_high_speed(void)
1592 also needs to be defined by the driver to dynamically poll
1593 whether the enumeration has succeded at high speed or full
1594 speed.
1595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001596 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001597 Define this if you want stdin, stdout &/or stderr to
1598 be set to usbtty.
1599
1600 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001601 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001602 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001603 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001605 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001606 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001607 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001608
Wolfgang Denk386eda02006-06-14 18:14:56 +02001609 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001610 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001611 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001612 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1613 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1614 should pretend to be a Linux device to it's target host.
1615
1616 CONFIG_USBD_MANUFACTURER
1617 Define this string as the name of your company for
1618 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001619
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001620 CONFIG_USBD_PRODUCT_NAME
1621 Define this string as the name of your product
1622 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1623
1624 CONFIG_USBD_VENDORID
1625 Define this as your assigned Vendor ID from the USB
1626 Implementors Forum. This *must* be a genuine Vendor ID
1627 to avoid polluting the USB namespace.
1628 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001629
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001630 CONFIG_USBD_PRODUCTID
1631 Define this as the unique Product ID
1632 for your device
1633 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001634
Igor Grinbergd70a5602011-12-12 12:08:35 +02001635- ULPI Layer Support:
1636 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1637 the generic ULPI layer. The generic layer accesses the ULPI PHY
1638 via the platform viewport, so you need both the genric layer and
1639 the viewport enabled. Currently only Chipidea/ARC based
1640 viewport is supported.
1641 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1642 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001643 If your ULPI phy needs a different reference clock than the
1644 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1645 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001646
1647- MMC Support:
1648 The MMC controller on the Intel PXA is supported. To
1649 enable this define CONFIG_MMC. The MMC can be
1650 accessed from the boot prompt by mapping the device
1651 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001652 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1653 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001654
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001655 CONFIG_SH_MMCIF
1656 Support for Renesas on-chip MMCIF controller
1657
1658 CONFIG_SH_MMCIF_ADDR
1659 Define the base address of MMCIF registers
1660
1661 CONFIG_SH_MMCIF_CLK
1662 Define the clock frequency for MMCIF
1663
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001664 CONFIG_GENERIC_MMC
1665 Enable the generic MMC driver
1666
1667 CONFIG_SUPPORT_EMMC_BOOT
1668 Enable some additional features of the eMMC boot partitions.
1669
1670 CONFIG_SUPPORT_EMMC_RPMB
1671 Enable the commands for reading, writing and programming the
1672 key for the Replay Protection Memory Block partition in eMMC.
1673
Tom Rinib3ba6e92013-03-14 05:32:47 +00001674- USB Device Firmware Update (DFU) class support:
1675 CONFIG_DFU_FUNCTION
1676 This enables the USB portion of the DFU USB class
1677
1678 CONFIG_CMD_DFU
1679 This enables the command "dfu" which is used to have
1680 U-Boot create a DFU class device via USB. This command
1681 requires that the "dfu_alt_info" environment variable be
1682 set and define the alt settings to expose to the host.
1683
1684 CONFIG_DFU_MMC
1685 This enables support for exposing (e)MMC devices via DFU.
1686
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001687 CONFIG_DFU_NAND
1688 This enables support for exposing NAND devices via DFU.
1689
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301690 CONFIG_DFU_RAM
1691 This enables support for exposing RAM via DFU.
1692 Note: DFU spec refer to non-volatile memory usage, but
1693 allow usages beyond the scope of spec - here RAM usage,
1694 one that would help mostly the developer.
1695
Heiko Schochere7e75c72013-06-12 06:05:51 +02001696 CONFIG_SYS_DFU_DATA_BUF_SIZE
1697 Dfu transfer uses a buffer before writing data to the
1698 raw storage device. Make the size (in bytes) of this buffer
1699 configurable. The size of this buffer is also configurable
1700 through the "dfu_bufsiz" environment variable.
1701
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001702 CONFIG_SYS_DFU_MAX_FILE_SIZE
1703 When updating files rather than the raw storage device,
1704 we use a static buffer to copy the file into and then write
1705 the buffer once we've been given the whole file. Define
1706 this to the maximum filesize (in bytes) for the buffer.
1707 Default is 4 MiB if undefined.
1708
Heiko Schocher001a8312014-03-18 08:09:56 +01001709 DFU_DEFAULT_POLL_TIMEOUT
1710 Poll timeout [ms], is the timeout a device can send to the
1711 host. The host must wait for this timeout before sending
1712 a subsequent DFU_GET_STATUS request to the device.
1713
1714 DFU_MANIFEST_POLL_TIMEOUT
1715 Poll timeout [ms], which the device sends to the host when
1716 entering dfuMANIFEST state. Host waits this timeout, before
1717 sending again an USB request to the device.
1718
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001719- USB Device Android Fastboot support:
1720 CONFIG_CMD_FASTBOOT
1721 This enables the command "fastboot" which enables the Android
1722 fastboot mode for the platform's USB device. Fastboot is a USB
1723 protocol for downloading images, flashing and device control
1724 used on Android devices.
1725 See doc/README.android-fastboot for more information.
1726
1727 CONFIG_ANDROID_BOOT_IMAGE
1728 This enables support for booting images which use the Android
1729 image format header.
1730
1731 CONFIG_USB_FASTBOOT_BUF_ADDR
1732 The fastboot protocol requires a large memory buffer for
1733 downloads. Define this to the starting RAM address to use for
1734 downloaded images.
1735
1736 CONFIG_USB_FASTBOOT_BUF_SIZE
1737 The fastboot protocol requires a large memory buffer for
1738 downloads. This buffer should be as large as possible for a
1739 platform. Define this to the size available RAM for fastboot.
1740
Steve Raed1b5ed02014-08-26 11:47:28 -07001741 CONFIG_FASTBOOT_FLASH
1742 The fastboot protocol includes a "flash" command for writing
1743 the downloaded image to a non-volatile storage device. Define
1744 this to enable the "fastboot flash" command.
1745
1746 CONFIG_FASTBOOT_FLASH_MMC_DEV
1747 The fastboot "flash" command requires additional information
1748 regarding the non-volatile storage device. Define this to
1749 the eMMC device that fastboot should use to store the image.
1750
Steve Rae0ff7e582014-12-12 15:51:54 -08001751 CONFIG_FASTBOOT_GPT_NAME
1752 The fastboot "flash" command supports writing the downloaded
1753 image to the Protective MBR and the Primary GUID Partition
1754 Table. (Additionally, this downloaded image is post-processed
1755 to generate and write the Backup GUID Partition Table.)
1756 This occurs when the specified "partition name" on the
1757 "fastboot flash" command line matches this value.
1758 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1759
wdenk6705d812004-08-02 23:22:59 +00001760- Journaling Flash filesystem support:
1761 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1762 CONFIG_JFFS2_NAND_DEV
1763 Define these for a default partition on a NAND device
1764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001765 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1766 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001767 Define these for a default partition on a NOR device
1768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001769 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001770 Define this to create an own partition. You have to provide a
1771 function struct part_info* jffs2_part_info(int part_num)
1772
1773 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001774 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001775 to disable the command chpart. This is the default when you
1776 have not defined a custom partition
1777
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001778- FAT(File Allocation Table) filesystem write function support:
1779 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001780
1781 Define this to enable support for saving memory data as a
1782 file in FAT formatted partition.
1783
1784 This will also enable the command "fatwrite" enabling the
1785 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001786
Gabe Black84cd9322012-10-12 14:26:11 +00001787CBFS (Coreboot Filesystem) support
1788 CONFIG_CMD_CBFS
1789
1790 Define this to enable support for reading from a Coreboot
1791 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1792 and cbfsload.
1793
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301794- FAT(File Allocation Table) filesystem cluster size:
1795 CONFIG_FS_FAT_MAX_CLUSTSIZE
1796
1797 Define the max cluster size for fat operations else
1798 a default value of 65536 will be defined.
1799
wdenkc6097192002-11-03 00:24:07 +00001800- Keyboard Support:
1801 CONFIG_ISA_KEYBOARD
1802
1803 Define this to enable standard (PC-Style) keyboard
1804 support
1805
1806 CONFIG_I8042_KBD
1807 Standard PC keyboard driver with US (is default) and
1808 GERMAN key layout (switch via environment 'keymap=de') support.
1809 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1810 for cfb_console. Supports cursor blinking.
1811
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001812 CONFIG_CROS_EC_KEYB
1813 Enables a Chrome OS keyboard using the CROS_EC interface.
1814 This uses CROS_EC to communicate with a second microcontroller
1815 which provides key scans on request.
1816
wdenkc6097192002-11-03 00:24:07 +00001817- Video support:
1818 CONFIG_VIDEO
1819
1820 Define this to enable video support (for output to
1821 video).
1822
1823 CONFIG_VIDEO_CT69000
1824
1825 Enable Chips & Technologies 69000 Video chip
1826
1827 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001828 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001829 video output is selected via environment 'videoout'
1830 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1831 assumed.
wdenkc6097192002-11-03 00:24:07 +00001832
wdenkb79a11c2004-03-25 15:14:43 +00001833 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001834 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001835 are possible:
1836 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001837 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001838
1839 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1840 -------------+---------------------------------------------
1841 8 bits | 0x301* 0x303 0x305 0x161 0x307
1842 15 bits | 0x310 0x313 0x316 0x162 0x319
1843 16 bits | 0x311 0x314 0x317 0x163 0x31A
1844 24 bits | 0x312 0x315 0x318 ? 0x31B
1845 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001846 (i.e. setenv videomode 317; saveenv; reset;)
1847
wdenkb79a11c2004-03-25 15:14:43 +00001848 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001849 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001850
1851
stroesec1551ea2003-04-04 15:53:41 +00001852 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001853 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001854 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1855 or CONFIG_VIDEO_SED13806_16BPP
1856
Timur Tabi7d3053f2011-02-15 17:09:19 -06001857 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001858 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001859 SOCs that have a DIU should define this macro to enable DIU
1860 support, and should also define these other macros:
1861
1862 CONFIG_SYS_DIU_ADDR
1863 CONFIG_VIDEO
1864 CONFIG_CMD_BMP
1865 CONFIG_CFB_CONSOLE
1866 CONFIG_VIDEO_SW_CURSOR
1867 CONFIG_VGA_AS_SINGLE_DEVICE
1868 CONFIG_VIDEO_LOGO
1869 CONFIG_VIDEO_BMP_LOGO
1870
Timur Tabiba8e76b2011-04-11 14:18:22 -05001871 The DIU driver will look for the 'video-mode' environment
1872 variable, and if defined, enable the DIU as a console during
1873 boot. See the documentation file README.video for a
1874 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001875
Simon Glass058d59b2012-12-03 13:59:47 +00001876
wdenk682011f2003-06-03 23:54:09 +00001877- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001878 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001879
wdenk8bde7f72003-06-27 21:31:46 +00001880 Define this to enable a custom keyboard support.
1881 This simply calls drv_keyboard_init() which must be
1882 defined in your board-specific files.
1883 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001884
wdenkc6097192002-11-03 00:24:07 +00001885- LCD Support: CONFIG_LCD
1886
1887 Define this to enable LCD support (for output to LCD
1888 display); also select one of the supported displays
1889 by defining one of these:
1890
Stelian Pop39cf4802008-05-09 21:57:18 +02001891 CONFIG_ATMEL_LCD:
1892
1893 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1894
wdenkfd3103b2003-11-25 16:55:19 +00001895 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001896
wdenkfd3103b2003-11-25 16:55:19 +00001897 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001898
wdenkfd3103b2003-11-25 16:55:19 +00001899 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001900
wdenkfd3103b2003-11-25 16:55:19 +00001901 NEC NL6448BC20-08. 6.5", 640x480.
1902 Active, color, single scan.
1903
1904 CONFIG_NEC_NL6448BC33_54
1905
1906 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001907 Active, color, single scan.
1908
1909 CONFIG_SHARP_16x9
1910
1911 Sharp 320x240. Active, color, single scan.
1912 It isn't 16x9, and I am not sure what it is.
1913
1914 CONFIG_SHARP_LQ64D341
1915
1916 Sharp LQ64D341 display, 640x480.
1917 Active, color, single scan.
1918
1919 CONFIG_HLD1045
1920
1921 HLD1045 display, 640x480.
1922 Active, color, single scan.
1923
1924 CONFIG_OPTREX_BW
1925
1926 Optrex CBL50840-2 NF-FW 99 22 M5
1927 or
1928 Hitachi LMG6912RPFC-00T
1929 or
1930 Hitachi SP14Q002
1931
1932 320x240. Black & white.
1933
1934 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001935 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001936
Simon Glass676d3192012-10-17 13:24:54 +00001937 CONFIG_LCD_ALIGNMENT
1938
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001939 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001940 defined then the LCD will be aligned to this value instead.
1941 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1942 here, since it is cheaper to change data cache settings on
1943 a per-section basis.
1944
Simon Glass0d89efe2012-10-17 13:24:59 +00001945 CONFIG_CONSOLE_SCROLL_LINES
1946
1947 When the console need to be scrolled, this is the number of
1948 lines to scroll by. It defaults to 1. Increasing this makes
1949 the console jump but can help speed up operation when scrolling
1950 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001951
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001952 CONFIG_LCD_ROTATION
1953
1954 Sometimes, for example if the display is mounted in portrait
1955 mode or even if it's mounted landscape but rotated by 180degree,
1956 we need to rotate our content of the display relative to the
1957 framebuffer, so that user can read the messages which are
1958 printed out.
1959 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1960 initialized with a given rotation from "vl_rot" out of
1961 "vidinfo_t" which is provided by the board specific code.
1962 The value for vl_rot is coded as following (matching to
1963 fbcon=rotate:<n> linux-kernel commandline):
1964 0 = no rotation respectively 0 degree
1965 1 = 90 degree rotation
1966 2 = 180 degree rotation
1967 3 = 270 degree rotation
1968
1969 If CONFIG_LCD_ROTATION is not defined, the console will be
1970 initialized with 0degree rotation.
1971
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001972 CONFIG_LCD_BMP_RLE8
1973
1974 Support drawing of RLE8-compressed bitmaps on the LCD.
1975
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001976 CONFIG_I2C_EDID
1977
1978 Enables an 'i2c edid' command which can read EDID
1979 information over I2C from an attached LCD display.
1980
wdenk7152b1d2003-09-05 23:19:14 +00001981- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001982
wdenk8bde7f72003-06-27 21:31:46 +00001983 If this option is set, the environment is checked for
1984 a variable "splashimage". If found, the usual display
1985 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001986 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001987 specified in "splashimage" is loaded instead. The
1988 console is redirected to the "nulldev", too. This
1989 allows for a "silent" boot where a splash screen is
1990 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001991
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001992 CONFIG_SPLASHIMAGE_GUARD
1993
1994 If this option is set, then U-Boot will prevent the environment
1995 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001996 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001997 This option is useful for targets where, due to alignment
1998 restrictions, an improperly aligned BMP image will cause a data
1999 abort. If you think you will not have problems with unaligned
2000 accesses (for example because your toolchain prevents them)
2001 there is no need to set this option.
2002
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002003 CONFIG_SPLASH_SCREEN_ALIGN
2004
2005 If this option is set the splash image can be freely positioned
2006 on the screen. Environment variable "splashpos" specifies the
2007 position as "x,y". If a positive number is given it is used as
2008 number of pixel from left/top. If a negative number is given it
2009 is used as number of pixel from right/bottom. You can also
2010 specify 'm' for centering the image.
2011
2012 Example:
2013 setenv splashpos m,m
2014 => image at center of screen
2015
2016 setenv splashpos 30,20
2017 => image at x = 30 and y = 20
2018
2019 setenv splashpos -10,m
2020 => vertically centered image
2021 at x = dspWidth - bmpWidth - 9
2022
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002023- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2024
2025 If this option is set, additionally to standard BMP
2026 images, gzipped BMP images can be displayed via the
2027 splashscreen support or the bmp command.
2028
Anatolij Gustschind5011762010-03-15 14:50:25 +01002029- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2030
2031 If this option is set, 8-bit RLE compressed BMP images
2032 can be displayed via the splashscreen support or the
2033 bmp command.
2034
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002035- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002036 CONFIG_CMD_ZIP
2037
2038 If this option is set, it would use zlib deflate method
2039 to compress the specified memory at its best effort.
2040
wdenkc29fdfc2003-08-29 20:57:53 +00002041- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002042 CONFIG_GZIP
2043
2044 Enabled by default to support gzip compressed images.
2045
wdenkc29fdfc2003-08-29 20:57:53 +00002046 CONFIG_BZIP2
2047
2048 If this option is set, support for bzip2 compressed
2049 images is included. If not, only uncompressed and gzip
2050 compressed images are supported.
2051
wdenk42d1f032003-10-15 23:53:47 +00002052 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002053 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002054 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002055
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002056 CONFIG_LZMA
2057
2058 If this option is set, support for lzma compressed
2059 images is included.
2060
2061 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2062 requires an amount of dynamic memory that is given by the
2063 formula:
2064
2065 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2066
2067 Where lc and lp stand for, respectively, Literal context bits
2068 and Literal pos bits.
2069
2070 This value is upper-bounded by 14MB in the worst case. Anyway,
2071 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2072 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2073 a very small buffer.
2074
2075 Use the lzmainfo tool to determinate the lc and lp values and
2076 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002077 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002078
Kees Cook8ef70472013-08-16 07:59:12 -07002079 CONFIG_LZO
2080
2081 If this option is set, support for LZO compressed images
2082 is included.
2083
wdenk17ea1172004-06-06 21:51:03 +00002084- MII/PHY support:
2085 CONFIG_PHY_ADDR
2086
2087 The address of PHY on MII bus.
2088
2089 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2090
2091 The clock frequency of the MII bus
2092
2093 CONFIG_PHY_GIGE
2094
2095 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002096 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002097
2098 CONFIG_PHY_RESET_DELAY
2099
2100 Some PHY like Intel LXT971A need extra delay after
2101 reset before any MII register access is possible.
2102 For such PHY, set this option to the usec delay
2103 required. (minimum 300usec for LXT971A)
2104
2105 CONFIG_PHY_CMD_DELAY (ppc4xx)
2106
2107 Some PHY like Intel LXT971A need extra delay after
2108 command issued before MII status register can be read
2109
wdenkc6097192002-11-03 00:24:07 +00002110- Ethernet address:
2111 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002112 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002113 CONFIG_ETH2ADDR
2114 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002115 CONFIG_ETH4ADDR
2116 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002117
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002118 Define a default value for Ethernet address to use
2119 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002120 is not determined automatically.
2121
2122- IP address:
2123 CONFIG_IPADDR
2124
2125 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002126 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002127 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002128 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002129
2130- Server IP address:
2131 CONFIG_SERVERIP
2132
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002133 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002134 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002135 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002136
Robin Getz97cfe862009-07-21 12:15:28 -04002137 CONFIG_KEEP_SERVERADDR
2138
2139 Keeps the server's MAC address, in the env 'serveraddr'
2140 for passing to bootargs (like Linux's netconsole option)
2141
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002142- Gateway IP address:
2143 CONFIG_GATEWAYIP
2144
2145 Defines a default value for the IP address of the
2146 default router where packets to other networks are
2147 sent to.
2148 (Environment variable "gatewayip")
2149
2150- Subnet mask:
2151 CONFIG_NETMASK
2152
2153 Defines a default value for the subnet mask (or
2154 routing prefix) which is used to determine if an IP
2155 address belongs to the local subnet or needs to be
2156 forwarded through a router.
2157 (Environment variable "netmask")
2158
David Updegraff53a5c422007-06-11 10:41:07 -05002159- Multicast TFTP Mode:
2160 CONFIG_MCAST_TFTP
2161
2162 Defines whether you want to support multicast TFTP as per
2163 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002164 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002165 driver in use must provide a function: mcast() to join/leave a
2166 multicast group.
2167
wdenkc6097192002-11-03 00:24:07 +00002168- BOOTP Recovery Mode:
2169 CONFIG_BOOTP_RANDOM_DELAY
2170
2171 If you have many targets in a network that try to
2172 boot using BOOTP, you may want to avoid that all
2173 systems send out BOOTP requests at precisely the same
2174 moment (which would happen for instance at recovery
2175 from a power failure, when all systems will try to
2176 boot, thus flooding the BOOTP server. Defining
2177 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2178 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002179 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002180
2181 1st BOOTP request: delay 0 ... 1 sec
2182 2nd BOOTP request: delay 0 ... 2 sec
2183 3rd BOOTP request: delay 0 ... 4 sec
2184 4th and following
2185 BOOTP requests: delay 0 ... 8 sec
2186
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002187 CONFIG_BOOTP_ID_CACHE_SIZE
2188
2189 BOOTP packets are uniquely identified using a 32-bit ID. The
2190 server will copy the ID from client requests to responses and
2191 U-Boot will use this to determine if it is the destination of
2192 an incoming response. Some servers will check that addresses
2193 aren't in use before handing them out (usually using an ARP
2194 ping) and therefore take up to a few hundred milliseconds to
2195 respond. Network congestion may also influence the time it
2196 takes for a response to make it back to the client. If that
2197 time is too long, U-Boot will retransmit requests. In order
2198 to allow earlier responses to still be accepted after these
2199 retransmissions, U-Boot's BOOTP client keeps a small cache of
2200 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2201 cache. The default is to keep IDs for up to four outstanding
2202 requests. Increasing this will allow U-Boot to accept offers
2203 from a BOOTP client in networks with unusually high latency.
2204
stroesefe389a82003-08-28 14:17:32 +00002205- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002206 You can fine tune the DHCP functionality by defining
2207 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002208
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002209 CONFIG_BOOTP_SUBNETMASK
2210 CONFIG_BOOTP_GATEWAY
2211 CONFIG_BOOTP_HOSTNAME
2212 CONFIG_BOOTP_NISDOMAIN
2213 CONFIG_BOOTP_BOOTPATH
2214 CONFIG_BOOTP_BOOTFILESIZE
2215 CONFIG_BOOTP_DNS
2216 CONFIG_BOOTP_DNS2
2217 CONFIG_BOOTP_SEND_HOSTNAME
2218 CONFIG_BOOTP_NTPSERVER
2219 CONFIG_BOOTP_TIMEOFFSET
2220 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002221 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002222
Wilson Callan5d110f02007-07-28 10:56:13 -04002223 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2224 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002225
Joe Hershberger2c00e092012-05-23 07:59:19 +00002226 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2227 after the configured retry count, the call will fail
2228 instead of starting over. This can be used to fail over
2229 to Link-local IP address configuration if the DHCP server
2230 is not available.
2231
stroesefe389a82003-08-28 14:17:32 +00002232 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2233 serverip from a DHCP server, it is possible that more
2234 than one DNS serverip is offered to the client.
2235 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2236 serverip will be stored in the additional environment
2237 variable "dnsip2". The first DNS serverip is always
2238 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002239 is defined.
stroesefe389a82003-08-28 14:17:32 +00002240
2241 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2242 to do a dynamic update of a DNS server. To do this, they
2243 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002244 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002245 of the "hostname" environment variable is passed as
2246 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002247
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002248 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2249
2250 A 32bit value in microseconds for a delay between
2251 receiving a "DHCP Offer" and sending the "DHCP Request".
2252 This fixes a problem with certain DHCP servers that don't
2253 respond 100% of the time to a "DHCP request". E.g. On an
2254 AT91RM9200 processor running at 180MHz, this delay needed
2255 to be *at least* 15,000 usec before a Windows Server 2003
2256 DHCP server would reply 100% of the time. I recommend at
2257 least 50,000 usec to be safe. The alternative is to hope
2258 that one of the retries will be successful but note that
2259 the DHCP timeout and retry process takes a longer than
2260 this delay.
2261
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002262 - Link-local IP address negotiation:
2263 Negotiate with other link-local clients on the local network
2264 for an address that doesn't require explicit configuration.
2265 This is especially useful if a DHCP server cannot be guaranteed
2266 to exist in all environments that the device must operate.
2267
2268 See doc/README.link-local for more information.
2269
wdenka3d991b2004-04-15 21:48:45 +00002270 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002271 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002272
2273 The device id used in CDP trigger frames.
2274
2275 CONFIG_CDP_DEVICE_ID_PREFIX
2276
2277 A two character string which is prefixed to the MAC address
2278 of the device.
2279
2280 CONFIG_CDP_PORT_ID
2281
2282 A printf format string which contains the ascii name of
2283 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002284 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002285
2286 CONFIG_CDP_CAPABILITIES
2287
2288 A 32bit integer which indicates the device capabilities;
2289 0x00000010 for a normal host which does not forwards.
2290
2291 CONFIG_CDP_VERSION
2292
2293 An ascii string containing the version of the software.
2294
2295 CONFIG_CDP_PLATFORM
2296
2297 An ascii string containing the name of the platform.
2298
2299 CONFIG_CDP_TRIGGER
2300
2301 A 32bit integer sent on the trigger.
2302
2303 CONFIG_CDP_POWER_CONSUMPTION
2304
2305 A 16bit integer containing the power consumption of the
2306 device in .1 of milliwatts.
2307
2308 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2309
2310 A byte containing the id of the VLAN.
2311
wdenkc6097192002-11-03 00:24:07 +00002312- Status LED: CONFIG_STATUS_LED
2313
2314 Several configurations allow to display the current
2315 status using a LED. For instance, the LED will blink
2316 fast while running U-Boot code, stop blinking as
2317 soon as a reply to a BOOTP request was received, and
2318 start blinking slow once the Linux kernel is running
2319 (supported by a status LED driver in the Linux
2320 kernel). Defining CONFIG_STATUS_LED enables this
2321 feature in U-Boot.
2322
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002323 Additional options:
2324
2325 CONFIG_GPIO_LED
2326 The status LED can be connected to a GPIO pin.
2327 In such cases, the gpio_led driver can be used as a
2328 status LED backend implementation. Define CONFIG_GPIO_LED
2329 to include the gpio_led driver in the U-Boot binary.
2330
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002331 CONFIG_GPIO_LED_INVERTED_TABLE
2332 Some GPIO connected LEDs may have inverted polarity in which
2333 case the GPIO high value corresponds to LED off state and
2334 GPIO low value corresponds to LED on state.
2335 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2336 with a list of GPIO LEDs that have inverted polarity.
2337
wdenkc6097192002-11-03 00:24:07 +00002338- CAN Support: CONFIG_CAN_DRIVER
2339
2340 Defining CONFIG_CAN_DRIVER enables CAN driver support
2341 on those systems that support this (optional)
2342 feature, like the TQM8xxL modules.
2343
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002344- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002345
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002346 This enable the NEW i2c subsystem, and will allow you to use
2347 i2c commands at the u-boot command line (as long as you set
2348 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2349 based realtime clock chips or other i2c devices. See
2350 common/cmd_i2c.c for a description of the command line
2351 interface.
2352
2353 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002354 - drivers/i2c/soft_i2c.c:
2355 - activate first bus with CONFIG_SYS_I2C_SOFT define
2356 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2357 for defining speed and slave address
2358 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2359 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2360 for defining speed and slave address
2361 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2362 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2363 for defining speed and slave address
2364 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2365 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2366 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002367
Heiko Schocher00f792e2012-10-24 13:48:22 +02002368 - drivers/i2c/fsl_i2c.c:
2369 - activate i2c driver with CONFIG_SYS_I2C_FSL
2370 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2371 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2372 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2373 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002374 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002375 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2376 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2377 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2378 second bus.
2379
Simon Glass1f2ba722012-10-30 07:28:53 +00002380 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002381 - activate this driver with CONFIG_SYS_I2C_TEGRA
2382 - This driver adds 4 i2c buses with a fix speed from
2383 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002384
Dirk Eibach880540d2013-04-25 02:40:01 +00002385 - drivers/i2c/ppc4xx_i2c.c
2386 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2387 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2388 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2389
tremfac96402013-09-21 18:13:35 +02002390 - drivers/i2c/i2c_mxc.c
2391 - activate this driver with CONFIG_SYS_I2C_MXC
2392 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2393 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2394 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2395 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2396 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2397 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002398 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002399 for speed, and 0 for slave.
York Sunf8cb1012015-03-20 10:20:40 -07002400 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2401 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002402
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002403 - drivers/i2c/rcar_i2c.c:
2404 - activate this driver with CONFIG_SYS_I2C_RCAR
2405 - This driver adds 4 i2c buses
2406
2407 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2408 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2409 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2410 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2411 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2412 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2413 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2414 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2415 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2416
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002417 - drivers/i2c/sh_i2c.c:
2418 - activate this driver with CONFIG_SYS_I2C_SH
2419 - This driver adds from 2 to 5 i2c buses
2420
2421 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2422 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2423 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2424 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2425 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2426 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2427 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2428 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2429 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2430 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2431 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2432 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002433 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002434
Heiko Schocher6789e842013-10-22 11:03:18 +02002435 - drivers/i2c/omap24xx_i2c.c
2436 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2437 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2438 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2439 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2440 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2441 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2442 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2443 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2445 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2446 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2447
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002448 - drivers/i2c/zynq_i2c.c
2449 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2450 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2451 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2452
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302453 - drivers/i2c/s3c24x0_i2c.c:
2454 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2455 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2456 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2457 with a fix speed from 100000 and the slave addr 0!
2458
Dirk Eibachb46226b2014-07-03 09:28:18 +02002459 - drivers/i2c/ihs_i2c.c
2460 - activate this driver with CONFIG_SYS_I2C_IHS
2461 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2462 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2463 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2464 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2465 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2466 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2467 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2468 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2469 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2470 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2471 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2472 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2473
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002474 additional defines:
2475
2476 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002477 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002478 don't use/have i2c muxes on your i2c bus, this
2479 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2480 omit this define.
2481
2482 CONFIG_SYS_I2C_DIRECT_BUS
2483 define this, if you don't use i2c muxes on your hardware.
2484 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2485 omit this define.
2486
2487 CONFIG_SYS_I2C_MAX_HOPS
2488 define how many muxes are maximal consecutively connected
2489 on one i2c bus. If you not use i2c muxes, omit this
2490 define.
2491
2492 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002493 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002494 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2495 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2496 CONFIG_SYS_NUM_I2C_BUSES = 9:
2497
2498 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2499 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2500 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2501 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2502 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2503 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2504 {1, {I2C_NULL_HOP}}, \
2505 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2506 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2507 }
2508
2509 which defines
2510 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002511 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2512 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2513 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2514 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2515 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002516 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002517 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2518 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002519
2520 If you do not have i2c muxes on your board, omit this define.
2521
Heiko Schocherea818db2013-01-29 08:53:15 +01002522- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002523
2524 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2525 provides the following compelling advantages:
2526
2527 - more than one i2c adapter is usable
2528 - approved multibus support
2529 - better i2c mux support
2530
2531 ** Please consider updating your I2C driver now. **
2532
Heiko Schocherea818db2013-01-29 08:53:15 +01002533 These enable legacy I2C serial bus commands. Defining
2534 CONFIG_HARD_I2C will include the appropriate I2C driver
2535 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk945af8d2003-07-16 21:53:01 +00002537 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002538 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002539 CONFIG_COMMANDS) and communicate with i2c based realtime
2540 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002541 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002542
Ben Warrenbb99ad62006-09-07 16:50:54 -04002543 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002544
wdenk945af8d2003-07-16 21:53:01 +00002545 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002546 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002548 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002549 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002550 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002551 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002552
Peter Tyser8d321b82010-04-12 22:28:21 -05002553 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002554 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002555 and so its address should therefore be cleared to 0 (See,
2556 eg, MPC823e User's Manual p.16-473). So, set
2557 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002558
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002559 CONFIG_SYS_I2C_INIT_MPC5XXX
2560
2561 When a board is reset during an i2c bus transfer
2562 chips might think that the current transfer is still
2563 in progress. Reset the slave devices by sending start
2564 commands until the slave device responds.
2565
wdenk945af8d2003-07-16 21:53:01 +00002566 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002567
Heiko Schocherea818db2013-01-29 08:53:15 +01002568 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002569 then the following macros need to be defined (examples are
2570 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002571
2572 I2C_INIT
2573
wdenkb37c7e52003-06-30 16:24:52 +00002574 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002575 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002576
wdenkba56f622004-02-06 23:19:44 +00002577 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002578
wdenkc6097192002-11-03 00:24:07 +00002579 I2C_PORT
2580
wdenk43d96162003-03-06 00:02:04 +00002581 (Only for MPC8260 CPU). The I/O port to use (the code
2582 assumes both bits are on the same port). Valid values
2583 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002584
2585 I2C_ACTIVE
2586
2587 The code necessary to make the I2C data line active
2588 (driven). If the data line is open collector, this
2589 define can be null.
2590
wdenkb37c7e52003-06-30 16:24:52 +00002591 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2592
wdenkc6097192002-11-03 00:24:07 +00002593 I2C_TRISTATE
2594
2595 The code necessary to make the I2C data line tri-stated
2596 (inactive). If the data line is open collector, this
2597 define can be null.
2598
wdenkb37c7e52003-06-30 16:24:52 +00002599 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2600
wdenkc6097192002-11-03 00:24:07 +00002601 I2C_READ
2602
York Sun472d5462013-04-01 11:29:11 -07002603 Code that returns true if the I2C data line is high,
2604 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002605
wdenkb37c7e52003-06-30 16:24:52 +00002606 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2607
wdenkc6097192002-11-03 00:24:07 +00002608 I2C_SDA(bit)
2609
York Sun472d5462013-04-01 11:29:11 -07002610 If <bit> is true, sets the I2C data line high. If it
2611 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002612
wdenkb37c7e52003-06-30 16:24:52 +00002613 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002614 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002615 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002616
wdenkc6097192002-11-03 00:24:07 +00002617 I2C_SCL(bit)
2618
York Sun472d5462013-04-01 11:29:11 -07002619 If <bit> is true, sets the I2C clock line high. If it
2620 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002621
wdenkb37c7e52003-06-30 16:24:52 +00002622 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002623 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002624 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002625
wdenkc6097192002-11-03 00:24:07 +00002626 I2C_DELAY
2627
2628 This delay is invoked four times per clock cycle so this
2629 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002630 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002631 like:
2632
wdenkb37c7e52003-06-30 16:24:52 +00002633 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002634
Mike Frysinger793b5722010-07-21 13:38:02 -04002635 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2636
2637 If your arch supports the generic GPIO framework (asm/gpio.h),
2638 then you may alternatively define the two GPIOs that are to be
2639 used as SCL / SDA. Any of the previous I2C_xxx macros will
2640 have GPIO-based defaults assigned to them as appropriate.
2641
2642 You should define these to the GPIO value as given directly to
2643 the generic GPIO functions.
2644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002645 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002646
wdenk8bde7f72003-06-27 21:31:46 +00002647 When a board is reset during an i2c bus transfer
2648 chips might think that the current transfer is still
2649 in progress. On some boards it is possible to access
2650 the i2c SCLK line directly, either by using the
2651 processor pin as a GPIO or by having a second pin
2652 connected to the bus. If this option is defined a
2653 custom i2c_init_board() routine in boards/xxx/board.c
2654 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002655
Richard Retanubun26a33502010-04-12 15:08:17 -04002656 CONFIG_SYS_I2C_BOARD_LATE_INIT
2657
2658 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2659 defined a custom i2c_board_late_init() routine in
2660 boards/xxx/board.c is run AFTER the operations in i2c_init()
2661 is completed. This callpoint can be used to unreset i2c bus
2662 using CPU i2c controller register accesses for CPUs whose i2c
2663 controller provide such a method. It is called at the end of
2664 i2c_init() to allow i2c_init operations to setup the i2c bus
2665 controller on the CPU (e.g. setting bus speed & slave address).
2666
wdenk17ea1172004-06-06 21:51:03 +00002667 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2668
2669 This option enables configuration of bi_iic_fast[] flags
2670 in u-boot bd_info structure based on u-boot environment
2671 variable "i2cfast". (see also i2cfast)
2672
Ben Warrenbb99ad62006-09-07 16:50:54 -04002673 CONFIG_I2C_MULTI_BUS
2674
2675 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002676 must have a controller. At any point in time, only one bus is
2677 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002678 Note that bus numbering is zero-based.
2679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002681
2682 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002683 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002684 is set, specify a list of bus-device pairs. Otherwise, specify
2685 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002686
2687 e.g.
2688 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002689 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002690
2691 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2692
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002693 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002694 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002695
2696 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2697
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002698 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002699
2700 If defined, then this indicates the I2C bus number for DDR SPD.
2701 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002704
2705 If defined, then this indicates the I2C bus number for the RTC.
2706 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002708 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002709
2710 If defined, then this indicates the I2C bus number for the DTT.
2711 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002714
2715 If defined, specifies the I2C address of the DTT device.
2716 If not defined, then U-Boot uses predefined value for
2717 specified DTT device.
2718
Andrew Dyer2ac69852008-12-29 17:36:01 -06002719 CONFIG_SOFT_I2C_READ_REPEATED_START
2720
2721 defining this will force the i2c_read() function in
2722 the soft_i2c driver to perform an I2C repeated start
2723 between writing the address pointer and reading the
2724 data. If this define is omitted the default behaviour
2725 of doing a stop-start sequence will be used. Most I2C
2726 devices can use either method, but some require one or
2727 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002728
wdenkc6097192002-11-03 00:24:07 +00002729- SPI Support: CONFIG_SPI
2730
2731 Enables SPI driver (so far only tested with
2732 SPI EEPROM, also an instance works with Crystal A/D and
2733 D/As on the SACSng board)
2734
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002735 CONFIG_SH_SPI
2736
2737 Enables the driver for SPI controller on SuperH. Currently
2738 only SH7757 is supported.
2739
wdenkc6097192002-11-03 00:24:07 +00002740 CONFIG_SPI_X
2741
2742 Enables extended (16-bit) SPI EEPROM addressing.
2743 (symmetrical to CONFIG_I2C_X)
2744
2745 CONFIG_SOFT_SPI
2746
wdenk43d96162003-03-06 00:02:04 +00002747 Enables a software (bit-bang) SPI driver rather than
2748 using hardware support. This is a general purpose
2749 driver that only requires three general I/O port pins
2750 (two outputs, one input) to function. If this is
2751 defined, the board configuration must define several
2752 SPI configuration items (port pins to use, etc). For
2753 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002754
Ben Warren04a9e112008-01-16 22:37:35 -05002755 CONFIG_HARD_SPI
2756
2757 Enables a hardware SPI driver for general-purpose reads
2758 and writes. As with CONFIG_SOFT_SPI, the board configuration
2759 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002760 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002761 example, see include/configs/mpc8349emds.h.
2762
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002763 CONFIG_MXC_SPI
2764
2765 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002766 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002767
Heiko Schocherf659b572014-07-14 10:22:11 +02002768 CONFIG_SYS_SPI_MXC_WAIT
2769 Timeout for waiting until spi transfer completed.
2770 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2771
Matthias Fuchs01335022007-12-27 17:12:34 +01002772- FPGA Support: CONFIG_FPGA
2773
2774 Enables FPGA subsystem.
2775
2776 CONFIG_FPGA_<vendor>
2777
2778 Enables support for specific chip vendors.
2779 (ALTERA, XILINX)
2780
2781 CONFIG_FPGA_<family>
2782
2783 Enables support for FPGA family.
2784 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2785
2786 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002787
wdenk43d96162003-03-06 00:02:04 +00002788 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002789
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302790 CONFIG_CMD_FPGA_LOADMK
2791
2792 Enable support for fpga loadmk command
2793
Michal Simek67193862014-05-02 13:43:39 +02002794 CONFIG_CMD_FPGA_LOADP
2795
2796 Enable support for fpga loadp command - load partial bitstream
2797
2798 CONFIG_CMD_FPGA_LOADBP
2799
2800 Enable support for fpga loadbp command - load partial bitstream
2801 (Xilinx only)
2802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002804
wdenk8bde7f72003-06-27 21:31:46 +00002805 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002808
wdenk43d96162003-03-06 00:02:04 +00002809 Enable checks on FPGA configuration interface busy
2810 status by the configuration function. This option
2811 will require a board or device specific function to
2812 be written.
wdenkc6097192002-11-03 00:24:07 +00002813
2814 CONFIG_FPGA_DELAY
2815
2816 If defined, a function that provides delays in the FPGA
2817 configuration driver.
2818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002819 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002820 Allow Control-C to interrupt FPGA configuration
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002823
wdenk43d96162003-03-06 00:02:04 +00002824 Check for configuration errors during FPGA bitfile
2825 loading. For example, abort during Virtex II
2826 configuration if the INIT_B line goes low (which
2827 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002830
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002831 Maximum time to wait for the INIT_B line to de-assert
2832 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002833 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002834 ms.
wdenkc6097192002-11-03 00:24:07 +00002835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002836 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002837
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002838 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002839 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002841 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk43d96162003-03-06 00:02:04 +00002843 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002844 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002845
2846- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002847 CONFIG_BUILD_TARGET
2848
2849 Some SoCs need special image types (e.g. U-Boot binary
2850 with a special header) as build targets. By defining
2851 CONFIG_BUILD_TARGET in the SoC / board header, this
2852 special image will be automatically built upon calling
2853 make / MAKEALL.
2854
wdenkc6097192002-11-03 00:24:07 +00002855 CONFIG_IDENT_STRING
2856
wdenk43d96162003-03-06 00:02:04 +00002857 If defined, this string will be added to the U-Boot
2858 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002859
2860- Vendor Parameter Protection:
2861
wdenk43d96162003-03-06 00:02:04 +00002862 U-Boot considers the values of the environment
2863 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002864 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002865 are set once by the board vendor / manufacturer, and
2866 protects these variables from casual modification by
2867 the user. Once set, these variables are read-only,
2868 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002869 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002870
2871 If CONFIG_ENV_OVERWRITE is #defined in your config
2872 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002873 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002874 these parameters.
2875
2876 Alternatively, if you #define _both_ CONFIG_ETHADDR
2877 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002878 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002879 which can be changed exactly ONCE by the user. [The
2880 serial# is unaffected by this, i. e. it remains
2881 read-only.]
2882
Joe Hershberger25980902012-12-11 22:16:31 -06002883 The same can be accomplished in a more flexible way
2884 for any variable by configuring the type of access
2885 to allow for those variables in the ".flags" variable
2886 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2887
wdenkc6097192002-11-03 00:24:07 +00002888- Protected RAM:
2889 CONFIG_PRAM
2890
2891 Define this variable to enable the reservation of
2892 "protected RAM", i. e. RAM which is not overwritten
2893 by U-Boot. Define CONFIG_PRAM to hold the number of
2894 kB you want to reserve for pRAM. You can overwrite
2895 this default value by defining an environment
2896 variable "pram" to the number of kB you want to
2897 reserve. Note that the board info structure will
2898 still show the full amount of RAM. If pRAM is
2899 reserved, a new environment variable "mem" will
2900 automatically be defined to hold the amount of
2901 remaining RAM in a form that can be passed as boot
2902 argument to Linux, for instance like that:
2903
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002904 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002905 saveenv
2906
2907 This way you can tell Linux not to use this memory,
2908 either, which results in a memory region that will
2909 not be affected by reboots.
2910
2911 *WARNING* If your board configuration uses automatic
2912 detection of the RAM size, you must make sure that
2913 this memory test is non-destructive. So far, the
2914 following board configurations are known to be
2915 "pRAM-clean":
2916
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002917 IVMS8, IVML24, SPD8xx, TQM8xxL,
2918 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002919 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002920
Gabe Black40fef042012-12-02 04:55:18 +00002921- Access to physical memory region (> 4GB)
2922 Some basic support is provided for operations on memory not
2923 normally accessible to U-Boot - e.g. some architectures
2924 support access to more than 4GB of memory on 32-bit
2925 machines using physical address extension or similar.
2926 Define CONFIG_PHYSMEM to access this basic support, which
2927 currently only supports clearing the memory.
2928
wdenkc6097192002-11-03 00:24:07 +00002929- Error Recovery:
2930 CONFIG_PANIC_HANG
2931
2932 Define this variable to stop the system in case of a
2933 fatal error, so that you have to reset it manually.
2934 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002935 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002936 automatically as fast as possible, but it may be
2937 useful during development since you can try to debug
2938 the conditions that lead to the situation.
2939
2940 CONFIG_NET_RETRY_COUNT
2941
wdenk43d96162003-03-06 00:02:04 +00002942 This variable defines the number of retries for
2943 network operations like ARP, RARP, TFTP, or BOOTP
2944 before giving up the operation. If not defined, a
2945 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002946
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002947 CONFIG_ARP_TIMEOUT
2948
2949 Timeout waiting for an ARP reply in milliseconds.
2950
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002951 CONFIG_NFS_TIMEOUT
2952
2953 Timeout in milliseconds used in NFS protocol.
2954 If you encounter "ERROR: Cannot umount" in nfs command,
2955 try longer timeout such as
2956 #define CONFIG_NFS_TIMEOUT 10000UL
2957
wdenkc6097192002-11-03 00:24:07 +00002958- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002959 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002960
2961 Enable auto completion of commands using TAB.
2962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002963 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002964
2965 This defines the secondary prompt string, which is
2966 printed when the command interpreter needs more input
2967 to complete a command. Usually "> ".
2968
2969 Note:
2970
wdenk8bde7f72003-06-27 21:31:46 +00002971 In the current implementation, the local variables
2972 space and global environment variables space are
2973 separated. Local variables are those you define by
2974 simply typing `name=value'. To access a local
2975 variable later on, you have write `$name' or
2976 `${name}'; to execute the contents of a variable
2977 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002978
wdenk43d96162003-03-06 00:02:04 +00002979 Global environment variables are those you use
2980 setenv/printenv to work with. To run a command stored
2981 in such a variable, you need to use the run command,
2982 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002983
2984 To store commands and special characters in a
2985 variable, please use double quotation marks
2986 surrounding the whole text of the variable, instead
2987 of the backslashes before semicolons and special
2988 symbols.
2989
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002990- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002991 CONFIG_CMDLINE_EDITING
2992
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002993 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002994 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002995
wdenka8c7c702003-12-06 19:49:23 +00002996- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002997 CONFIG_EXTRA_ENV_SETTINGS
2998
wdenk43d96162003-03-06 00:02:04 +00002999 Define this to contain any number of null terminated
3000 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003001 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003002
wdenk43d96162003-03-06 00:02:04 +00003003 For example, place something like this in your
3004 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003005
3006 #define CONFIG_EXTRA_ENV_SETTINGS \
3007 "myvar1=value1\0" \
3008 "myvar2=value2\0"
3009
wdenk43d96162003-03-06 00:02:04 +00003010 Warning: This method is based on knowledge about the
3011 internal format how the environment is stored by the
3012 U-Boot code. This is NOT an official, exported
3013 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003014 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003015 You better know what you are doing here.
3016
wdenk43d96162003-03-06 00:02:04 +00003017 Note: overly (ab)use of the default environment is
3018 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003019 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003020 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003021
Stephen Warren5e724ca2012-05-22 09:21:54 +00003022 CONFIG_ENV_VARS_UBOOT_CONFIG
3023
3024 Define this in order to add variables describing the
3025 U-Boot build configuration to the default environment.
3026 These will be named arch, cpu, board, vendor, and soc.
3027
3028 Enabling this option will cause the following to be defined:
3029
3030 - CONFIG_SYS_ARCH
3031 - CONFIG_SYS_CPU
3032 - CONFIG_SYS_BOARD
3033 - CONFIG_SYS_VENDOR
3034 - CONFIG_SYS_SOC
3035
Tom Rini7e27f892012-10-24 07:28:16 +00003036 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3037
3038 Define this in order to add variables describing certain
3039 run-time determined information about the hardware to the
3040 environment. These will be named board_name, board_rev.
3041
Simon Glass06fd8532012-11-30 13:01:17 +00003042 CONFIG_DELAY_ENVIRONMENT
3043
3044 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003045 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00003046 that so that the environment is not available until
3047 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3048 this is instead controlled by the value of
3049 /config/load-environment.
3050
wdenka8c7c702003-12-06 19:49:23 +00003051- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003052 CONFIG_HAS_DATAFLASH
3053
wdenk8bde7f72003-06-27 21:31:46 +00003054 Defining this option enables DataFlash features and
3055 allows to read/write in Dataflash via the standard
3056 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003057
Eric Nelsonf61ec452012-01-31 10:52:08 -07003058- Serial Flash support
3059 CONFIG_CMD_SF
3060
3061 Defining this option enables SPI flash commands
3062 'sf probe/read/write/erase/update'.
3063
3064 Usage requires an initial 'probe' to define the serial
3065 flash parameters, followed by read/write/erase/update
3066 commands.
3067
3068 The following defaults may be provided by the platform
3069 to handle the common case when only a single serial
3070 flash is present on the system.
3071
3072 CONFIG_SF_DEFAULT_BUS Bus identifier
3073 CONFIG_SF_DEFAULT_CS Chip-select
3074 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3075 CONFIG_SF_DEFAULT_SPEED in Hz
3076
Simon Glass24007272012-10-08 13:16:02 +00003077 CONFIG_CMD_SF_TEST
3078
3079 Define this option to include a destructive SPI flash
3080 test ('sf test').
3081
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303082 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3083
3084 Define this option to use the Bank addr/Extended addr
3085 support on SPI flashes which has size > 16Mbytes.
3086
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303087 CONFIG_SF_DUAL_FLASH Dual flash memories
3088
3089 Define this option to use dual flash support where two flash
3090 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003091 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303092
wdenk3f85ce22004-02-23 16:11:30 +00003093- SystemACE Support:
3094 CONFIG_SYSTEMACE
3095
3096 Adding this option adds support for Xilinx SystemACE
3097 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003098 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003099 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003100
3101 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003102 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003103
3104 When SystemACE support is added, the "ace" device type
3105 becomes available to the fat commands, i.e. fatls.
3106
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003107- TFTP Fixed UDP Port:
3108 CONFIG_TFTP_PORT
3109
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003110 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003111 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003112 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003113 number generator is used.
3114
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003115 Also, the environment variable tftpdstp is used to supply
3116 the TFTP UDP destination port value. If tftpdstp isn't
3117 defined, the normal port 69 is used.
3118
3119 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003120 blindly start the TFTP transfer using the pre-configured
3121 target IP address and UDP port. This has the effect of
3122 "punching through" the (Windows XP) firewall, allowing
3123 the remainder of the TFTP transfer to proceed normally.
3124 A better solution is to properly configure the firewall,
3125 but sometimes that is not allowed.
3126
Simon Glassbf36c5d2012-12-05 14:46:38 +00003127- Hashing support:
3128 CONFIG_CMD_HASH
3129
3130 This enables a generic 'hash' command which can produce
3131 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3132
3133 CONFIG_HASH_VERIFY
3134
3135 Enable the hash verify command (hash -v). This adds to code
3136 size a little.
3137
gaurav rana94e3c8c2015-02-20 12:51:46 +05303138 CONFIG_SHA1 - This option enables support of hashing using SHA1
3139 algorithm. The hash is calculated in software.
3140 CONFIG_SHA256 - This option enables support of hashing using
3141 SHA256 algorithm. The hash is calculated in software.
3142 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3143 for SHA1/SHA256 hashing.
3144 This affects the 'hash' command and also the
3145 hash_lookup_algo() function.
3146 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3147 hardware-acceleration for SHA1/SHA256 progressive hashing.
3148 Data can be streamed in a block at a time and the hashing
3149 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003150
3151 Note: There is also a sha1sum command, which should perhaps
3152 be deprecated in favour of 'hash sha1'.
3153
Robert Winklera11f1872013-07-24 17:57:06 -07003154- Freescale i.MX specific commands:
3155 CONFIG_CMD_HDMIDETECT
3156 This enables 'hdmidet' command which returns true if an
3157 HDMI monitor is detected. This command is i.MX 6 specific.
3158
3159 CONFIG_CMD_BMODE
3160 This enables the 'bmode' (bootmode) command for forcing
3161 a boot from specific media.
3162
3163 This is useful for forcing the ROM's usb downloader to
3164 activate upon a watchdog reset which is nice when iterating
3165 on U-Boot. Using the reset button or running bmode normal
3166 will set it back to normal. This command currently
3167 supports i.MX53 and i.MX6.
3168
Simon Glass19c402a2013-06-13 15:10:02 -07003169- Signing support:
3170 CONFIG_RSA
3171
3172 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003173 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003174
Ruchika Guptac937ff62015-01-23 16:01:54 +05303175 The Modular Exponentiation algorithm in RSA is implemented using
3176 driver model. So CONFIG_DM needs to be enabled by default for this
3177 library to function.
3178
Simon Glass19c402a2013-06-13 15:10:02 -07003179 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303180 option. The software based modular exponentiation is built into
3181 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003182
Heiko Schocher9e50c402014-01-25 07:27:13 +01003183- bootcount support:
3184 CONFIG_BOOTCOUNT_LIMIT
3185
3186 This enables the bootcounter support, see:
3187 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3188
3189 CONFIG_AT91SAM9XE
3190 enable special bootcounter support on at91sam9xe based boards.
3191 CONFIG_BLACKFIN
3192 enable special bootcounter support on blackfin based boards.
3193 CONFIG_SOC_DA8XX
3194 enable special bootcounter support on da850 based boards.
3195 CONFIG_BOOTCOUNT_RAM
3196 enable support for the bootcounter in RAM
3197 CONFIG_BOOTCOUNT_I2C
3198 enable support for the bootcounter on an i2c (like RTC) device.
3199 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3200 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3201 the bootcounter.
3202 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003203
wdenka8c7c702003-12-06 19:49:23 +00003204- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003205 CONFIG_SHOW_BOOT_PROGRESS
3206
wdenk43d96162003-03-06 00:02:04 +00003207 Defining this option allows to add some board-
3208 specific code (calling a user-provided function
3209 "show_boot_progress(int)") that enables you to show
3210 the system's boot progress on some display (for
3211 example, some LED's) on your board. At the moment,
3212 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003213
Simon Glass94fd1312012-09-28 08:56:37 +00003214
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003215Legacy uImage format:
3216
wdenkc6097192002-11-03 00:24:07 +00003217 Arg Where When
3218 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003219 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003220 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003221 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003222 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003223 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003224 4 common/cmd_bootm.c Image data has correct checksum
3225 -4 common/cmd_bootm.c Image is for unsupported architecture
3226 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003227 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003228 6 common/cmd_bootm.c Image Type check OK
3229 -6 common/cmd_bootm.c gunzip uncompression error
3230 -7 common/cmd_bootm.c Unimplemented compression type
3231 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003232 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003233 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003234
3235 9 common/image.c Start initial ramdisk verification
3236 -10 common/image.c Ramdisk header has bad magic number
3237 -11 common/image.c Ramdisk header has bad checksum
3238 10 common/image.c Ramdisk header is OK
3239 -12 common/image.c Ramdisk data has bad checksum
3240 11 common/image.c Ramdisk data has correct checksum
3241 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003242 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003243 13 common/image.c Start multifile image verification
3244 14 common/image.c No initial ramdisk, no multifile, continue.
3245
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003246 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003247
Stefan Roesea47a12b2010-04-15 16:07:28 +02003248 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003249 -31 post/post.c POST test failed, detected by post_output_backlog()
3250 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003251
Heiko Schocher566a4942007-06-22 19:11:54 +02003252 34 common/cmd_doc.c before loading a Image from a DOC device
3253 -35 common/cmd_doc.c Bad usage of "doc" command
3254 35 common/cmd_doc.c correct usage of "doc" command
3255 -36 common/cmd_doc.c No boot device
3256 36 common/cmd_doc.c correct boot device
3257 -37 common/cmd_doc.c Unknown Chip ID on boot device
3258 37 common/cmd_doc.c correct chip ID found, device available
3259 -38 common/cmd_doc.c Read Error on boot device
3260 38 common/cmd_doc.c reading Image header from DOC device OK
3261 -39 common/cmd_doc.c Image header has bad magic number
3262 39 common/cmd_doc.c Image header has correct magic number
3263 -40 common/cmd_doc.c Error reading Image from DOC device
3264 40 common/cmd_doc.c Image header has correct magic number
3265 41 common/cmd_ide.c before loading a Image from a IDE device
3266 -42 common/cmd_ide.c Bad usage of "ide" command
3267 42 common/cmd_ide.c correct usage of "ide" command
3268 -43 common/cmd_ide.c No boot device
3269 43 common/cmd_ide.c boot device found
3270 -44 common/cmd_ide.c Device not available
3271 44 common/cmd_ide.c Device available
3272 -45 common/cmd_ide.c wrong partition selected
3273 45 common/cmd_ide.c partition selected
3274 -46 common/cmd_ide.c Unknown partition table
3275 46 common/cmd_ide.c valid partition table found
3276 -47 common/cmd_ide.c Invalid partition type
3277 47 common/cmd_ide.c correct partition type
3278 -48 common/cmd_ide.c Error reading Image Header on boot device
3279 48 common/cmd_ide.c reading Image Header from IDE device OK
3280 -49 common/cmd_ide.c Image header has bad magic number
3281 49 common/cmd_ide.c Image header has correct magic number
3282 -50 common/cmd_ide.c Image header has bad checksum
3283 50 common/cmd_ide.c Image header has correct checksum
3284 -51 common/cmd_ide.c Error reading Image from IDE device
3285 51 common/cmd_ide.c reading Image from IDE device OK
3286 52 common/cmd_nand.c before loading a Image from a NAND device
3287 -53 common/cmd_nand.c Bad usage of "nand" command
3288 53 common/cmd_nand.c correct usage of "nand" command
3289 -54 common/cmd_nand.c No boot device
3290 54 common/cmd_nand.c boot device found
3291 -55 common/cmd_nand.c Unknown Chip ID on boot device
3292 55 common/cmd_nand.c correct chip ID found, device available
3293 -56 common/cmd_nand.c Error reading Image Header on boot device
3294 56 common/cmd_nand.c reading Image Header from NAND device OK
3295 -57 common/cmd_nand.c Image header has bad magic number
3296 57 common/cmd_nand.c Image header has correct magic number
3297 -58 common/cmd_nand.c Error reading Image from NAND device
3298 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003299
Heiko Schocher566a4942007-06-22 19:11:54 +02003300 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003301
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003302 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003303 -64 net/eth.c no Ethernet found.
3304 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003305
Heiko Schocher566a4942007-06-22 19:11:54 +02003306 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003307 80 common/cmd_net.c before calling net_loop()
3308 -81 common/cmd_net.c some error in net_loop() occurred
3309 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003310 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3311 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003312 83 common/cmd_net.c running "source" command
3313 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003314 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003315
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003316FIT uImage format:
3317
3318 Arg Where When
3319 100 common/cmd_bootm.c Kernel FIT Image has correct format
3320 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3321 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3322 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3323 102 common/cmd_bootm.c Kernel unit name specified
3324 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003325 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003326 104 common/cmd_bootm.c Got kernel subimage node offset
3327 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3328 105 common/cmd_bootm.c Kernel subimage hash verification OK
3329 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3330 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003331 -106 common/cmd_bootm.c Kernel subimage has wrong type
3332 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003333 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3334 108 common/cmd_bootm.c Got kernel subimage data/size
3335 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3336 -109 common/cmd_bootm.c Can't get kernel subimage type
3337 -110 common/cmd_bootm.c Can't get kernel subimage comp
3338 -111 common/cmd_bootm.c Can't get kernel subimage os
3339 -112 common/cmd_bootm.c Can't get kernel subimage load address
3340 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3341
3342 120 common/image.c Start initial ramdisk verification
3343 -120 common/image.c Ramdisk FIT image has incorrect format
3344 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003345 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003346 -122 common/image.c Can't get configuration for ramdisk subimage
3347 123 common/image.c Ramdisk unit name specified
3348 -124 common/image.c Can't get ramdisk subimage node offset
3349 125 common/image.c Got ramdisk subimage node offset
3350 -125 common/image.c Ramdisk subimage hash verification failed
3351 126 common/image.c Ramdisk subimage hash verification OK
3352 -126 common/image.c Ramdisk subimage for unsupported architecture
3353 127 common/image.c Architecture check OK
3354 -127 common/image.c Can't get ramdisk subimage data/size
3355 128 common/image.c Got ramdisk subimage data/size
3356 129 common/image.c Can't get ramdisk load address
3357 -129 common/image.c Got ramdisk load address
3358
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003359 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003360 131 common/cmd_doc.c FIT image format OK
3361
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003362 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003363 141 common/cmd_ide.c FIT image format OK
3364
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003365 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003366 151 common/cmd_nand.c FIT image format OK
3367
Heiko Schocher21d29f72014-05-28 11:33:33 +02003368- legacy image format:
3369 CONFIG_IMAGE_FORMAT_LEGACY
3370 enables the legacy image format support in U-Boot.
3371
3372 Default:
3373 enabled if CONFIG_FIT_SIGNATURE is not defined.
3374
3375 CONFIG_DISABLE_IMAGE_LEGACY
3376 disable the legacy image format
3377
3378 This define is introduced, as the legacy image format is
3379 enabled per default for backward compatibility.
3380
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003381- FIT image support:
3382 CONFIG_FIT
3383 Enable support for the FIT uImage format.
3384
3385 CONFIG_FIT_BEST_MATCH
3386 When no configuration is explicitly selected, default to the
3387 one whose fdt's compatibility field best matches that of
3388 U-Boot itself. A match is considered "best" if it matches the
3389 most specific compatibility entry of U-Boot's fdt's root node.
3390 The order of entries in the configuration's fdt is ignored.
3391
Simon Glass3e569a62013-06-13 15:10:00 -07003392 CONFIG_FIT_SIGNATURE
3393 This option enables signature verification of FIT uImages,
gaurav rana94e3c8c2015-02-20 12:51:46 +05303394 using a hash signed and verified using RSA. If
3395 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3396 hashing is available using hardware, RSA library will use it.
3397 See doc/uImage.FIT/signature.txt for more details.
Simon Glass3e569a62013-06-13 15:10:00 -07003398
Heiko Schocher21d29f72014-05-28 11:33:33 +02003399 WARNING: When relying on signed FIT images with required
3400 signature check the legacy image format is default
3401 disabled. If a board need legacy image format support
3402 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3403
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003404 CONFIG_FIT_DISABLE_SHA256
3405 Supporting SHA256 hashes has quite an impact on binary size.
3406 For constrained systems sha256 hash support can be disabled
3407 with this option.
3408
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003409- Standalone program support:
3410 CONFIG_STANDALONE_LOAD_ADDR
3411
Wolfgang Denk6feff892011-10-09 21:06:34 +02003412 This option defines a board specific value for the
3413 address where standalone program gets loaded, thus
3414 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003415 settings.
3416
3417- Frame Buffer Address:
3418 CONFIG_FB_ADDR
3419
3420 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003421 address for frame buffer. This is typically the case
3422 when using a graphics controller has separate video
3423 memory. U-Boot will then place the frame buffer at
3424 the given address instead of dynamically reserving it
3425 in system RAM by calling lcd_setmem(), which grabs
3426 the memory for the frame buffer depending on the
3427 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003428
3429 Please see board_init_f function.
3430
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003431- Automatic software updates via TFTP server
3432 CONFIG_UPDATE_TFTP
3433 CONFIG_UPDATE_TFTP_CNT_MAX
3434 CONFIG_UPDATE_TFTP_MSEC_MAX
3435
3436 These options enable and control the auto-update feature;
3437 for a more detailed description refer to doc/README.update.
3438
3439- MTD Support (mtdparts command, UBI support)
3440 CONFIG_MTD_DEVICE
3441
3442 Adds the MTD device infrastructure from the Linux kernel.
3443 Needed for mtdparts command support.
3444
3445 CONFIG_MTD_PARTITIONS
3446
3447 Adds the MTD partitioning infrastructure from the Linux
3448 kernel. Needed for UBI support.
3449
Joe Hershberger70c219c2013-04-08 10:32:48 +00003450- UBI support
3451 CONFIG_CMD_UBI
3452
3453 Adds commands for interacting with MTD partitions formatted
3454 with the UBI flash translation layer
3455
3456 Requires also defining CONFIG_RBTREE
3457
Joe Hershberger147162d2013-04-08 10:32:49 +00003458 CONFIG_UBI_SILENCE_MSG
3459
3460 Make the verbose messages from UBI stop printing. This leaves
3461 warnings and errors enabled.
3462
Heiko Schocherff94bc42014-06-24 10:10:04 +02003463
3464 CONFIG_MTD_UBI_WL_THRESHOLD
3465 This parameter defines the maximum difference between the highest
3466 erase counter value and the lowest erase counter value of eraseblocks
3467 of UBI devices. When this threshold is exceeded, UBI starts performing
3468 wear leveling by means of moving data from eraseblock with low erase
3469 counter to eraseblocks with high erase counter.
3470
3471 The default value should be OK for SLC NAND flashes, NOR flashes and
3472 other flashes which have eraseblock life-cycle 100000 or more.
3473 However, in case of MLC NAND flashes which typically have eraseblock
3474 life-cycle less than 10000, the threshold should be lessened (e.g.,
3475 to 128 or 256, although it does not have to be power of 2).
3476
3477 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003478
Heiko Schocherff94bc42014-06-24 10:10:04 +02003479 CONFIG_MTD_UBI_BEB_LIMIT
3480 This option specifies the maximum bad physical eraseblocks UBI
3481 expects on the MTD device (per 1024 eraseblocks). If the
3482 underlying flash does not admit of bad eraseblocks (e.g. NOR
3483 flash), this value is ignored.
3484
3485 NAND datasheets often specify the minimum and maximum NVM
3486 (Number of Valid Blocks) for the flashes' endurance lifetime.
3487 The maximum expected bad eraseblocks per 1024 eraseblocks
3488 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3489 which gives 20 for most NANDs (MaxNVB is basically the total
3490 count of eraseblocks on the chip).
3491
3492 To put it differently, if this value is 20, UBI will try to
3493 reserve about 1.9% of physical eraseblocks for bad blocks
3494 handling. And that will be 1.9% of eraseblocks on the entire
3495 NAND chip, not just the MTD partition UBI attaches. This means
3496 that if you have, say, a NAND flash chip admits maximum 40 bad
3497 eraseblocks, and it is split on two MTD partitions of the same
3498 size, UBI will reserve 40 eraseblocks when attaching a
3499 partition.
3500
3501 default: 20
3502
3503 CONFIG_MTD_UBI_FASTMAP
3504 Fastmap is a mechanism which allows attaching an UBI device
3505 in nearly constant time. Instead of scanning the whole MTD device it
3506 only has to locate a checkpoint (called fastmap) on the device.
3507 The on-flash fastmap contains all information needed to attach
3508 the device. Using fastmap makes only sense on large devices where
3509 attaching by scanning takes long. UBI will not automatically install
3510 a fastmap on old images, but you can set the UBI parameter
3511 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3512 that fastmap-enabled images are still usable with UBI implementations
3513 without fastmap support. On typical flash devices the whole fastmap
3514 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3515
3516 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3517 Set this parameter to enable fastmap automatically on images
3518 without a fastmap.
3519 default: 0
3520
Joe Hershberger70c219c2013-04-08 10:32:48 +00003521- UBIFS support
3522 CONFIG_CMD_UBIFS
3523
3524 Adds commands for interacting with UBI volumes formatted as
3525 UBIFS. UBIFS is read-only in u-boot.
3526
3527 Requires UBI support as well as CONFIG_LZO
3528
Joe Hershberger147162d2013-04-08 10:32:49 +00003529 CONFIG_UBIFS_SILENCE_MSG
3530
3531 Make the verbose messages from UBIFS stop printing. This leaves
3532 warnings and errors enabled.
3533
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003534- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003535 CONFIG_SPL
3536 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003537
Tom Rini95579792012-02-14 07:29:40 +00003538 CONFIG_SPL_LDSCRIPT
3539 LDSCRIPT for linking the SPL binary.
3540
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003541 CONFIG_SPL_MAX_FOOTPRINT
3542 Maximum size in memory allocated to the SPL, BSS included.
3543 When defined, the linker checks that the actual memory
3544 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003545 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003546 must not be both defined at the same time.
3547
Tom Rini95579792012-02-14 07:29:40 +00003548 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003549 Maximum size of the SPL image (text, data, rodata, and
3550 linker lists sections), BSS excluded.
3551 When defined, the linker checks that the actual size does
3552 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003553
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003554 CONFIG_SPL_TEXT_BASE
3555 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003556
Scott Wood94a45bb2012-09-20 19:05:12 -05003557 CONFIG_SPL_RELOC_TEXT_BASE
3558 Address to relocate to. If unspecified, this is equal to
3559 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3560
Tom Rini95579792012-02-14 07:29:40 +00003561 CONFIG_SPL_BSS_START_ADDR
3562 Link address for the BSS within the SPL binary.
3563
3564 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003565 Maximum size in memory allocated to the SPL BSS.
3566 When defined, the linker checks that the actual memory used
3567 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003568 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003569 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003570
3571 CONFIG_SPL_STACK
3572 Adress of the start of the stack SPL will use
3573
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003574 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3575 When defined, SPL will panic() if the image it has
3576 loaded does not have a signature.
3577 Defining this is useful when code which loads images
3578 in SPL cannot guarantee that absolutely all read errors
3579 will be caught.
3580 An example is the LPC32XX MLC NAND driver, which will
3581 consider that a completely unreadable NAND block is bad,
3582 and thus should be skipped silently.
3583
Scott Wood94a45bb2012-09-20 19:05:12 -05003584 CONFIG_SPL_RELOC_STACK
3585 Adress of the start of the stack SPL will use after
3586 relocation. If unspecified, this is equal to
3587 CONFIG_SPL_STACK.
3588
Tom Rini95579792012-02-14 07:29:40 +00003589 CONFIG_SYS_SPL_MALLOC_START
3590 Starting address of the malloc pool used in SPL.
3591
3592 CONFIG_SYS_SPL_MALLOC_SIZE
3593 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003594
Tom Rini47f7bca2012-08-13 12:03:19 -07003595 CONFIG_SPL_FRAMEWORK
3596 Enable the SPL framework under common/. This framework
3597 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3598 NAND loading of the Linux Kernel.
3599
Tom Rini9607faf2014-03-28 12:03:39 -04003600 CONFIG_SPL_OS_BOOT
3601 Enable booting directly to an OS from SPL.
3602 See also: doc/README.falcon
3603
Tom Rini861a86f2012-08-13 11:37:56 -07003604 CONFIG_SPL_DISPLAY_PRINT
3605 For ARM, enable an optional function to print more information
3606 about the running system.
3607
Scott Wood4b919722012-09-20 16:35:21 -05003608 CONFIG_SPL_INIT_MINIMAL
3609 Arch init code should be built for a very small image
3610
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003611 CONFIG_SPL_LIBCOMMON_SUPPORT
3612 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003613
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003614 CONFIG_SPL_LIBDISK_SUPPORT
3615 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003616
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003617 CONFIG_SPL_I2C_SUPPORT
3618 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003619
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003620 CONFIG_SPL_GPIO_SUPPORT
3621 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003622
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003623 CONFIG_SPL_MMC_SUPPORT
3624 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003625
Tom Rini95579792012-02-14 07:29:40 +00003626 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3627 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003628 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003629 when the MMC is being used in raw mode.
3630
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003631 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3632 Partition on the MMC to load U-Boot from when the MMC is being
3633 used in raw mode
3634
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003635 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3636 Sector to load kernel uImage from when MMC is being
3637 used in raw mode (for Falcon mode)
3638
3639 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3640 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3641 Sector and number of sectors to load kernel argument
3642 parameters from when MMC is being used in raw mode
3643 (for falcon mode)
3644
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003645 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3646 Partition on the MMC to load U-Boot from when the MMC is being
3647 used in fs mode
3648
Tom Rini95579792012-02-14 07:29:40 +00003649 CONFIG_SPL_FAT_SUPPORT
3650 Support for fs/fat/libfat.o in SPL binary
3651
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003652 CONFIG_SPL_EXT_SUPPORT
3653 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003654
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003655 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3656 Filename to read to load U-Boot when reading from filesystem
3657
3658 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003659 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003660 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003661
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003662 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003663 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003664 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003665
Scott Wood06f60ae2012-12-06 13:33:17 +00003666 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3667 Set this for NAND SPL on PPC mpc83xx targets, so that
3668 start.S waits for the rest of the SPL to load before
3669 continuing (the hardware starts execution after just
3670 loading the first page rather than the full 4K).
3671
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303672 CONFIG_SPL_SKIP_RELOCATE
3673 Avoid SPL relocation
3674
Scott Wood6f2f01b2012-09-20 19:09:07 -05003675 CONFIG_SPL_NAND_BASE
3676 Include nand_base.c in the SPL. Requires
3677 CONFIG_SPL_NAND_DRIVERS.
3678
3679 CONFIG_SPL_NAND_DRIVERS
3680 SPL uses normal NAND drivers, not minimal drivers.
3681
3682 CONFIG_SPL_NAND_ECC
3683 Include standard software ECC in the SPL
3684
Tom Rini95579792012-02-14 07:29:40 +00003685 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003686 Support for NAND boot using simple NAND drivers that
3687 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003688
Tom Rini6dd3b562014-03-28 12:03:36 -04003689 CONFIG_SPL_MTD_SUPPORT
3690 Support for the MTD subsystem within SPL. Useful for
3691 environment on NAND support within SPL.
3692
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003693 CONFIG_SPL_NAND_RAW_ONLY
3694 Support to boot only raw u-boot.bin images. Use this only
3695 if you need to save space.
3696
Ying Zhangbb0dc102013-08-16 15:16:11 +08003697 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3698 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003699 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003700
Ying Zhang7c8eea52013-08-16 15:16:12 +08003701 CONFIG_SPL_COMMON_INIT_DDR
3702 Set for common ddr init with serial presence detect in
3703 SPL binary.
3704
Tom Rini95579792012-02-14 07:29:40 +00003705 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3706 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3707 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3708 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3709 CONFIG_SYS_NAND_ECCBYTES
3710 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003711 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003712
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303713 CONFIG_SPL_NAND_BOOT
3714 Add support NAND boot
3715
Tom Rini95579792012-02-14 07:29:40 +00003716 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003717 Location in NAND to read U-Boot from
3718
3719 CONFIG_SYS_NAND_U_BOOT_DST
3720 Location in memory to load U-Boot to
3721
3722 CONFIG_SYS_NAND_U_BOOT_SIZE
3723 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003724
3725 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003726 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003727
3728 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3729 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003730 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003731
3732 CONFIG_SPL_OMAP3_ID_NAND
3733 Support for an OMAP3-specific set of functions to return the
3734 ID and MFR of the first attached NAND chip, if present.
3735
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003736 CONFIG_SPL_SERIAL_SUPPORT
3737 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003738
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003739 CONFIG_SPL_SPI_FLASH_SUPPORT
3740 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003741
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003742 CONFIG_SPL_SPI_SUPPORT
3743 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003744
Pavel Machekc57b9532012-08-30 22:42:11 +02003745 CONFIG_SPL_RAM_DEVICE
3746 Support for running image already present in ram, in SPL binary
3747
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003748 CONFIG_SPL_LIBGENERIC_SUPPORT
3749 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003750
Ying Zhangba1bee42013-05-20 14:07:25 +08003751 CONFIG_SPL_ENV_SUPPORT
3752 Support for the environment operating in SPL binary
3753
3754 CONFIG_SPL_NET_SUPPORT
3755 Support for the net/libnet.o in SPL binary.
3756 It conflicts with SPL env from storage medium specified by
3757 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3758
Scott Wood74752ba2012-12-06 13:33:16 +00003759 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003760 Image offset to which the SPL should be padded before appending
3761 the SPL payload. By default, this is defined as
3762 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3763 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3764 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003765
Scott Woodca2fca22012-09-21 16:27:32 -05003766 CONFIG_SPL_TARGET
3767 Final target image containing SPL and payload. Some SPLs
3768 use an arch-specific makefile fragment instead, for
3769 example if more than one image needs to be produced.
3770
Simon Glass87ebee32013-05-08 08:05:59 +00003771 CONFIG_FIT_SPL_PRINT
3772 Printing information about a FIT image adds quite a bit of
3773 code to SPL. So this is normally disabled in SPL. Use this
3774 option to re-enable it. This will affect the output of the
3775 bootm command when booting a FIT image.
3776
Ying Zhang3aa29de2013-08-16 15:16:15 +08003777- TPL framework
3778 CONFIG_TPL
3779 Enable building of TPL globally.
3780
3781 CONFIG_TPL_PAD_TO
3782 Image offset to which the TPL should be padded before appending
3783 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003784 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3785 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3786 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003787
wdenkc6097192002-11-03 00:24:07 +00003788Modem Support:
3789--------------
3790
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003791[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003792
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003793- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003794 CONFIG_MODEM_SUPPORT
3795
3796- RTS/CTS Flow control enable:
3797 CONFIG_HWFLOW
3798
3799- Modem debug support:
3800 CONFIG_MODEM_SUPPORT_DEBUG
3801
wdenk43d96162003-03-06 00:02:04 +00003802 Enables debugging stuff (char screen[1024], dbg())
3803 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003804
wdenka8c7c702003-12-06 19:49:23 +00003805- Interrupt support (PPC):
3806
wdenkd4ca31c2004-01-02 14:00:00 +00003807 There are common interrupt_init() and timer_interrupt()
3808 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003809 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003810 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003811 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003812 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003813 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003814 specific handling. If board has watchdog / status_led
3815 / other_activity_monitor it works automatically from
3816 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003817
wdenkc6097192002-11-03 00:24:07 +00003818- General:
3819
wdenk43d96162003-03-06 00:02:04 +00003820 In the target system modem support is enabled when a
3821 specific key (key combination) is pressed during
3822 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003823 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003824 board_init(). Currently key_pressed() is a dummy
3825 function, returning 1 and thus enabling modem
3826 initialization.
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk43d96162003-03-06 00:02:04 +00003828 If there are no modem init strings in the
3829 environment, U-Boot proceed to autoboot; the
3830 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003831 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003832
3833 See also: doc/README.Modem
3834
Helmut Raiger9660e442011-10-20 04:19:47 +00003835Board initialization settings:
3836------------------------------
3837
3838During Initialization u-boot calls a number of board specific functions
3839to allow the preparation of board specific prerequisites, e.g. pin setup
3840before drivers are initialized. To enable these callbacks the
3841following configuration macros have to be defined. Currently this is
3842architecture specific, so please check arch/your_architecture/lib/board.c
3843typically in board_init_f() and board_init_r().
3844
3845- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3846- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3847- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3848- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003849
wdenkc6097192002-11-03 00:24:07 +00003850Configuration Settings:
3851-----------------------
3852
York Sun4d1fd7f2014-02-26 17:03:19 -08003853- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3854 Optionally it can be defined to support 64-bit memory commands.
3855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003856- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003857 undefine this when you're short of memory.
3858
Peter Tyser2fb26042009-01-27 18:03:12 -06003859- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3860 width of the commands listed in the 'help' command output.
3861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003862- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003863 prompt for user input.
3864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003865- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003867- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003869- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003871- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003872 the application (usually a Linux kernel) when it is
3873 booted
3874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003875- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003876 List of legal baudrate settings for this board.
3877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003878- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003879 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003881- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003882 If the board specific function
3883 extern int overwrite_console (void);
3884 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003885 serial port, else the settings in the environment are used.
3886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003887- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003888 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003890- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003891 Enable overwrite of previous console environment settings.
3892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003893- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003894 Begin and End addresses of the area used by the
3895 simple memory test.
3896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003897- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003898 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003900- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003901 Scratch address used by the alternate memory test
3902 You only need to set this if address zero isn't writeable
3903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003904- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3905 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003906 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003907 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003908 fixing up gd->ram_size the Linux kernel should gets passed
3909 the now "corrected" memory size and won't touch it either.
3910 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003911 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003912 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003913 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003914
3915 This option can be used as a workaround for the 440EPx/GRx
3916 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3917 be touched.
3918
3919 WARNING: Please make sure that this value is a multiple of
3920 the Linux page size (normally 4k). If this is not the case,
3921 then the end address of the Linux memory will be located at a
3922 non page size aligned address and this could cause major
3923 problems.
3924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003925- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003926 Enable temporary baudrate change while serial download
3927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003928- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003929 Physical start address of SDRAM. _Must_ be 0 here.
3930
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003931- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003932 Physical start address of Motherboard I/O (if using a
3933 Cogent motherboard)
3934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003935- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003936 Physical start address of Flash memory.
3937
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003938- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003939 Physical start address of boot monitor code (set by
3940 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003941 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003942 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003944- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003945 Size of memory reserved for monitor code, used to
3946 determine _at_compile_time_ (!) if the environment is
3947 embedded within the U-Boot image, or in a separate
3948 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003949
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003950- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003951 Size of DRAM reserved for malloc() use.
3952
Simon Glassd59476b2014-07-10 22:23:28 -06003953- CONFIG_SYS_MALLOC_F_LEN
3954 Size of the malloc() pool for use before relocation. If
3955 this is defined, then a very simple malloc() implementation
3956 will become available before relocation. The address is just
3957 below the global data, and the stack is moved down to make
3958 space.
3959
3960 This feature allocates regions with increasing addresses
3961 within the region. calloc() is supported, but realloc()
3962 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003963 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003964 U-Boot relocates itself.
3965
Simon Glasse7b14e92014-09-15 06:33:18 -06003966 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003967 at present but is fairly easy to enable for other archs.
3968
Simon Glass38687ae2014-11-10 17:16:54 -07003969- CONFIG_SYS_MALLOC_SIMPLE
3970 Provides a simple and small malloc() and calloc() for those
3971 boards which do not use the full malloc in SPL (which is
3972 enabled with CONFIG_SYS_SPL_MALLOC_START).
3973
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003974- CONFIG_SYS_NONCACHED_MEMORY:
3975 Size of non-cached memory area. This area of memory will be
3976 typically located right below the malloc() area and mapped
3977 uncached in the MMU. This is useful for drivers that would
3978 otherwise require a lot of explicit cache maintenance. For
3979 some drivers it's also impossible to properly maintain the
3980 cache. For example if the regions that need to be flushed
3981 are not a multiple of the cache-line size, *and* padding
3982 cannot be allocated between the regions to align them (i.e.
3983 if the HW requires a contiguous array of regions, and the
3984 size of each region is not cache-aligned), then a flush of
3985 one region may result in overwriting data that hardware has
3986 written to another region in the same cache-line. This can
3987 happen for example in network drivers where descriptors for
3988 buffers are typically smaller than the CPU cache-line (e.g.
3989 16 bytes vs. 32 or 64 bytes).
3990
3991 Non-cached memory is only supported on 32-bit ARM at present.
3992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003993- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003994 Normally compressed uImages are limited to an
3995 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003996 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003997 to adjust this setting to your needs.
3998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003999- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004000 Maximum size of memory mapped by the startup code of
4001 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004002 the Linux kernel (bd_info, boot arguments, FDT blob if
4003 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004004 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004005 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004006 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004007 variable "bootm_mapsize" will override the value of
4008 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4009 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004010
John Rigbyfca43cc2010-10-13 13:57:35 -06004011- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4012 Enable initrd_high functionality. If defined then the
4013 initrd_high feature is enabled and the bootm ramdisk subcommand
4014 is enabled.
4015
4016- CONFIG_SYS_BOOT_GET_CMDLINE:
4017 Enables allocating and saving kernel cmdline in space between
4018 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4019
4020- CONFIG_SYS_BOOT_GET_KBD:
4021 Enables allocating and saving a kernel copy of the bd_info in
4022 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4023
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004024- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004025 Max number of Flash memory banks
4026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004027- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004028 Max number of sectors on a Flash chip
4029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004030- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004031 Timeout for Flash erase operations (in ms)
4032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004033- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004034 Timeout for Flash write operations (in ms)
4035
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004036- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004037 Timeout for Flash set sector lock bit operation (in ms)
4038
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004039- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004040 Timeout for Flash clear lock bits operation (in ms)
4041
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004042- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004043 If defined, hardware flash sectors protection is used
4044 instead of U-Boot software protection.
4045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004046- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004047
4048 Enable TFTP transfers directly to flash memory;
4049 without this option such a download has to be
4050 performed in two steps: (1) download to RAM, and (2)
4051 copy from RAM to flash.
4052
4053 The two-step approach is usually more reliable, since
4054 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004055 the flash, but in some situations (when system RAM is
4056 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004057 downloaded image) this option may be very useful.
4058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004059- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004060 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004061 common flash structure for storing flash geometry.
4062
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004063- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004064 This option also enables the building of the cfi_flash driver
4065 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004066
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004067- CONFIG_FLASH_CFI_MTD
4068 This option enables the building of the cfi_mtd driver
4069 in the drivers directory. The driver exports CFI flash
4070 to the MTD layer.
4071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004073 Use buffered writes to flash.
4074
4075- CONFIG_FLASH_SPANSION_S29WS_N
4076 s29ws-n MirrorBit flash has non-standard addresses for buffered
4077 write commands.
4078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004079- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004080 If this option is defined, the common CFI flash doesn't
4081 print it's warning upon not recognized FLASH banks. This
4082 is useful, if some of the configured banks are only
4083 optionally available.
4084
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004085- CONFIG_FLASH_SHOW_PROGRESS
4086 If defined (must be an integer), print out countdown
4087 digits and dots. Recommended value: 45 (9..1) for 80
4088 column displays, 15 (3..1) for 40 column displays.
4089
Stefan Roese352ef3f2013-04-04 15:53:14 +02004090- CONFIG_FLASH_VERIFY
4091 If defined, the content of the flash (destination) is compared
4092 against the source after the write operation. An error message
4093 will be printed when the contents are not identical.
4094 Please note that this option is useless in nearly all cases,
4095 since such flash programming errors usually are detected earlier
4096 while unprotecting/erasing/programming. Please only enable
4097 this option if you really know what you are doing.
4098
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004099- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004100 Defines the number of Ethernet receive buffers. On some
4101 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004102 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4103 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004104 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004105 Defaults to 4 if not defined.
4106
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004107- CONFIG_ENV_MAX_ENTRIES
4108
Wolfgang Denk071bc922010-10-27 22:48:30 +02004109 Maximum number of entries in the hash table that is used
4110 internally to store the environment settings. The default
4111 setting is supposed to be generous and should work in most
4112 cases. This setting can be used to tune behaviour; see
4113 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004114
Joe Hershberger25980902012-12-11 22:16:31 -06004115- CONFIG_ENV_FLAGS_LIST_DEFAULT
4116- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004117 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004118 calling env set. Variables can be restricted to only decimal,
4119 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4120 the variables can also be restricted to IP address or MAC address.
4121
4122 The format of the list is:
4123 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004124 access_attribute = [a|r|o|c]
4125 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004126 entry = variable_name[:attributes]
4127 list = entry[,list]
4128
4129 The type attributes are:
4130 s - String (default)
4131 d - Decimal
4132 x - Hexadecimal
4133 b - Boolean ([1yYtT|0nNfF])
4134 i - IP address
4135 m - MAC address
4136
Joe Hershberger267541f2012-12-11 22:16:34 -06004137 The access attributes are:
4138 a - Any (default)
4139 r - Read-only
4140 o - Write-once
4141 c - Change-default
4142
Joe Hershberger25980902012-12-11 22:16:31 -06004143 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4144 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004145 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004146
4147 - CONFIG_ENV_FLAGS_LIST_STATIC
4148 Define this to a list (string) to define validation that
4149 should be done if an entry is not found in the ".flags"
4150 environment variable. To override a setting in the static
4151 list, simply add an entry for the same variable name to the
4152 ".flags" variable.
4153
Joe Hershberger267541f2012-12-11 22:16:34 -06004154- CONFIG_ENV_ACCESS_IGNORE_FORCE
4155 If defined, don't allow the -f switch to env set override variable
4156 access flags.
4157
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004158- CONFIG_SYS_GENERIC_BOARD
4159 This selects the architecture-generic board system instead of the
4160 architecture-specific board files. It is intended to move boards
4161 to this new framework over time. Defining this will disable the
4162 arch/foo/lib/board.c file and use common/board_f.c and
4163 common/board_r.c instead. To use this option your architecture
Masahiro Yamada0a12e682015-03-19 19:42:51 +09004164 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4165 If you find problems enabling this option on your board please report
4166 the problem and send patches!
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004167
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004168- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4169 This is set by OMAP boards for the max time that reset should
4170 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004171 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004172
Gabe Black0d296cc2014-10-15 04:38:30 -06004173- CONFIG_USE_STDINT
4174 If stdint.h is available with your toolchain you can define this
4175 option to enable it. You can provide option 'USE_STDINT=1' when
4176 building U-Boot to enable this.
4177
wdenkc6097192002-11-03 00:24:07 +00004178The following definitions that deal with the placement and management
4179of environment data (variable area); in general, we support the
4180following configurations:
4181
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004182- CONFIG_BUILD_ENVCRC:
4183
4184 Builds up envcrc with the target environment so that external utils
4185 may easily extract it and embed it in final U-Boot images.
4186
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004187- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004188
4189 Define this if the environment is in flash memory.
4190
4191 a) The environment occupies one whole flash sector, which is
4192 "embedded" in the text segment with the U-Boot code. This
4193 happens usually with "bottom boot sector" or "top boot
4194 sector" type flash chips, which have several smaller
4195 sectors at the start or the end. For instance, such a
4196 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4197 such a case you would place the environment in one of the
4198 4 kB sectors - with U-Boot code before and after it. With
4199 "top boot sector" type flash chips, you would put the
4200 environment in one of the last sectors, leaving a gap
4201 between U-Boot and the environment.
4202
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004203 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004204
4205 Offset of environment data (variable area) to the
4206 beginning of flash memory; for instance, with bottom boot
4207 type flash chips the second sector can be used: the offset
4208 for this sector is given here.
4209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004210 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004211
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004212 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004213
4214 This is just another way to specify the start address of
4215 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004216 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004217
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004218 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004219
4220 Size of the sector containing the environment.
4221
4222
4223 b) Sometimes flash chips have few, equal sized, BIG sectors.
4224 In such a case you don't want to spend a whole sector for
4225 the environment.
4226
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004227 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004228
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004229 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004230 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004231 of this flash sector for the environment. This saves
4232 memory for the RAM copy of the environment.
4233
4234 It may also save flash memory if you decide to use this
4235 when your environment is "embedded" within U-Boot code,
4236 since then the remainder of the flash sector could be used
4237 for U-Boot code. It should be pointed out that this is
4238 STRONGLY DISCOURAGED from a robustness point of view:
4239 updating the environment in flash makes it always
4240 necessary to erase the WHOLE sector. If something goes
4241 wrong before the contents has been restored from a copy in
4242 RAM, your target system will be dead.
4243
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004244 - CONFIG_ENV_ADDR_REDUND
4245 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004246
wdenk43d96162003-03-06 00:02:04 +00004247 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004248 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004249 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004250 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004251
4252BE CAREFUL! Any changes to the flash layout, and some changes to the
4253source code will make it necessary to adapt <board>/u-boot.lds*
4254accordingly!
4255
4256
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004257- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004258
4259 Define this if you have some non-volatile memory device
4260 (NVRAM, battery buffered SRAM) which you want to use for the
4261 environment.
4262
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004263 - CONFIG_ENV_ADDR:
4264 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004265
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004266 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004267 want to use for environment. It is assumed that this memory
4268 can just be read and written to, without any special
4269 provision.
4270
4271BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004272in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004273console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004274U-Boot will hang.
4275
4276Please note that even with NVRAM we still use a copy of the
4277environment in RAM: we could work on NVRAM directly, but we want to
4278keep settings there always unmodified except somebody uses "saveenv"
4279to save the current settings.
4280
4281
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004282- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004283
4284 Use this if you have an EEPROM or similar serial access
4285 device and a driver for it.
4286
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004287 - CONFIG_ENV_OFFSET:
4288 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004289
4290 These two #defines specify the offset and size of the
4291 environment area within the total memory of your EEPROM.
4292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004293 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004294 If defined, specified the chip address of the EEPROM device.
4295 The default address is zero.
4296
Christian Gmeiner189d2572015-02-11 15:19:31 +01004297 - CONFIG_SYS_I2C_EEPROM_BUS:
4298 If defined, specified the i2c bus of the EEPROM device.
4299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004300 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004301 If defined, the number of bits used to address bytes in a
4302 single page in the EEPROM device. A 64 byte page, for example
4303 would require six bits.
4304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004305 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004306 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004307 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004309 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004310 The length in bytes of the EEPROM memory array address. Note
4311 that this is NOT the chip address length!
4312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004313 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004314 EEPROM chips that implement "address overflow" are ones
4315 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4316 address and the extra bits end up in the "chip address" bit
4317 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4318 byte chips.
4319
4320 Note that we consider the length of the address field to
4321 still be one byte because the extra address bits are hidden
4322 in the chip address.
4323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004324 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004325 The size in bytes of the EEPROM device.
4326
Heiko Schocher548738b2010-01-07 08:55:40 +01004327 - CONFIG_ENV_EEPROM_IS_ON_I2C
4328 define this, if you have I2C and SPI activated, and your
4329 EEPROM, which holds the environment, is on the I2C bus.
4330
4331 - CONFIG_I2C_ENV_EEPROM_BUS
4332 if you have an Environment on an EEPROM reached over
4333 I2C muxes, you can define here, how to reach this
4334 EEPROM. For example:
4335
Heiko Schocherea818db2013-01-29 08:53:15 +01004336 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004337
4338 EEPROM which holds the environment, is reached over
4339 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004340
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004341- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004342
wdenkd4ca31c2004-01-02 14:00:00 +00004343 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004344 want to use for the environment.
4345
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004346 - CONFIG_ENV_OFFSET:
4347 - CONFIG_ENV_ADDR:
4348 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004349
4350 These three #defines specify the offset and size of the
4351 environment area within the total memory of your DataFlash placed
4352 at the specified address.
4353
Wu, Joshbd83b592014-07-01 19:30:13 +08004354- CONFIG_ENV_IS_IN_SPI_FLASH:
4355
4356 Define this if you have a SPI Flash memory device which you
4357 want to use for the environment.
4358
4359 - CONFIG_ENV_OFFSET:
4360 - CONFIG_ENV_SIZE:
4361
4362 These two #defines specify the offset and size of the
4363 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4364 aligned to an erase sector boundary.
4365
4366 - CONFIG_ENV_SECT_SIZE:
4367
4368 Define the SPI flash's sector size.
4369
4370 - CONFIG_ENV_OFFSET_REDUND (optional):
4371
4372 This setting describes a second storage area of CONFIG_ENV_SIZE
4373 size used to hold a redundant copy of the environment data, so
4374 that there is a valid backup copy in case there is a power failure
4375 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4376 aligned to an erase sector boundary.
4377
4378 - CONFIG_ENV_SPI_BUS (optional):
4379 - CONFIG_ENV_SPI_CS (optional):
4380
4381 Define the SPI bus and chip select. If not defined they will be 0.
4382
4383 - CONFIG_ENV_SPI_MAX_HZ (optional):
4384
4385 Define the SPI max work clock. If not defined then use 1MHz.
4386
4387 - CONFIG_ENV_SPI_MODE (optional):
4388
4389 Define the SPI work mode. If not defined then use SPI_MODE_3.
4390
Liu Gang0a85a9e2012-03-08 00:33:20 +00004391- CONFIG_ENV_IS_IN_REMOTE:
4392
4393 Define this if you have a remote memory space which you
4394 want to use for the local device's environment.
4395
4396 - CONFIG_ENV_ADDR:
4397 - CONFIG_ENV_SIZE:
4398
4399 These two #defines specify the address and size of the
4400 environment area within the remote memory space. The
4401 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004402 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004403
4404BE CAREFUL! For some special cases, the local device can not use
4405"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004406environment stored in a remote NOR flash by SRIO or PCIE link,
4407but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004408
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004409- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004410
4411 Define this if you have a NAND device which you want to use
4412 for the environment.
4413
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004414 - CONFIG_ENV_OFFSET:
4415 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004416
4417 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004418 area within the first NAND device. CONFIG_ENV_OFFSET must be
4419 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004420
Scott Woodfdd813d2010-09-17 14:38:37 -05004421 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004422
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004423 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004424 size used to hold a redundant copy of the environment data, so
4425 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004426 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004427 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004428
Scott Woodfdd813d2010-09-17 14:38:37 -05004429 - CONFIG_ENV_RANGE (optional):
4430
4431 Specifies the length of the region in which the environment
4432 can be written. This should be a multiple of the NAND device's
4433 block size. Specifying a range with more erase blocks than
4434 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4435 the range to be avoided.
4436
4437 - CONFIG_ENV_OFFSET_OOB (optional):
4438
4439 Enables support for dynamically retrieving the offset of the
4440 environment from block zero's out-of-band data. The
4441 "nand env.oob" command can be used to record this offset.
4442 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4443 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004444
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004445- CONFIG_NAND_ENV_DST
4446
4447 Defines address in RAM to which the nand_spl code should copy the
4448 environment. If redundant environment is used, it will be copied to
4449 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4450
Joe Hershberger2b744332013-04-08 10:32:51 +00004451- CONFIG_ENV_IS_IN_UBI:
4452
4453 Define this if you have an UBI volume that you want to use for the
4454 environment. This has the benefit of wear-leveling the environment
4455 accesses, which is important on NAND.
4456
4457 - CONFIG_ENV_UBI_PART:
4458
4459 Define this to a string that is the mtd partition containing the UBI.
4460
4461 - CONFIG_ENV_UBI_VOLUME:
4462
4463 Define this to the name of the volume that you want to store the
4464 environment in.
4465
Joe Hershberger785881f2013-04-08 10:32:52 +00004466 - CONFIG_ENV_UBI_VOLUME_REDUND:
4467
4468 Define this to the name of another volume to store a second copy of
4469 the environment in. This will enable redundant environments in UBI.
4470 It is assumed that both volumes are in the same MTD partition.
4471
Joe Hershberger2b744332013-04-08 10:32:51 +00004472 - CONFIG_UBI_SILENCE_MSG
4473 - CONFIG_UBIFS_SILENCE_MSG
4474
4475 You will probably want to define these to avoid a really noisy system
4476 when storing the env in UBI.
4477
Wu, Joshd1db76f2014-06-24 17:31:03 +08004478- CONFIG_ENV_IS_IN_FAT:
4479 Define this if you want to use the FAT file system for the environment.
4480
4481 - FAT_ENV_INTERFACE:
4482
4483 Define this to a string that is the name of the block device.
4484
4485 - FAT_ENV_DEV_AND_PART:
4486
4487 Define this to a string to specify the partition of the device. It can
4488 be as following:
4489
4490 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4491 - "D:P": device D partition P. Error occurs if device D has no
4492 partition table.
4493 - "D:0": device D.
4494 - "D" or "D:": device D partition 1 if device D has partition
4495 table, or the whole device D if has no partition
4496 table.
4497 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004498 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004499 partition table then means device D.
4500
4501 - FAT_ENV_FILE:
4502
4503 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004504 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004505
4506 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004507 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004508
Stephen Warren06e4ae52013-06-11 15:14:00 -06004509- CONFIG_ENV_IS_IN_MMC:
4510
4511 Define this if you have an MMC device which you want to use for the
4512 environment.
4513
4514 - CONFIG_SYS_MMC_ENV_DEV:
4515
4516 Specifies which MMC device the environment is stored in.
4517
4518 - CONFIG_SYS_MMC_ENV_PART (optional):
4519
4520 Specifies which MMC partition the environment is stored in. If not
4521 set, defaults to partition 0, the user area. Common values might be
4522 1 (first MMC boot partition), 2 (second MMC boot partition).
4523
4524 - CONFIG_ENV_OFFSET:
4525 - CONFIG_ENV_SIZE:
4526
4527 These two #defines specify the offset and size of the environment
4528 area within the specified MMC device.
4529
Stephen Warren5c088ee2013-06-11 15:14:02 -06004530 If offset is positive (the usual case), it is treated as relative to
4531 the start of the MMC partition. If offset is negative, it is treated
4532 as relative to the end of the MMC partition. This can be useful if
4533 your board may be fitted with different MMC devices, which have
4534 different sizes for the MMC partitions, and you always want the
4535 environment placed at the very end of the partition, to leave the
4536 maximum possible space before it, to store other data.
4537
Stephen Warren06e4ae52013-06-11 15:14:00 -06004538 These two values are in units of bytes, but must be aligned to an
4539 MMC sector boundary.
4540
4541 - CONFIG_ENV_OFFSET_REDUND (optional):
4542
4543 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4544 hold a redundant copy of the environment data. This provides a
4545 valid backup copy in case the other copy is corrupted, e.g. due
4546 to a power failure during a "saveenv" operation.
4547
Stephen Warren5c088ee2013-06-11 15:14:02 -06004548 This value may also be positive or negative; this is handled in the
4549 same way as CONFIG_ENV_OFFSET.
4550
Stephen Warren06e4ae52013-06-11 15:14:00 -06004551 This value is also in units of bytes, but must also be aligned to
4552 an MMC sector boundary.
4553
4554 - CONFIG_ENV_SIZE_REDUND (optional):
4555
4556 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4557 set. If this value is set, it must be set to the same value as
4558 CONFIG_ENV_SIZE.
4559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004560- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004561
4562 Defines offset to the initial SPI buffer area in DPRAM. The
4563 area is used at an early stage (ROM part) if the environment
4564 is configured to reside in the SPI EEPROM: We need a 520 byte
4565 scratch DPRAM area. It is used between the two initialization
4566 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4567 to be a good choice since it makes it far enough from the
4568 start of the data area as well as from the stack pointer.
4569
Bruce Adlere881cb52007-11-02 13:15:42 -07004570Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004571has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004572created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004573until then to read environment variables.
4574
wdenk85ec0bc2003-03-31 16:34:49 +00004575The environment is protected by a CRC32 checksum. Before the monitor
4576is relocated into RAM, as a result of a bad CRC you will be working
4577with the compiled-in default environment - *silently*!!! [This is
4578necessary, because the first environment variable we need is the
4579"baudrate" setting for the console - if we have a bad CRC, we don't
4580have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004581
4582Note: once the monitor has been relocated, then it will complain if
4583the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004584use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004586- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004587 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004588
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004589 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004590 also needs to be defined.
4591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004592- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004593 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004594
Ron Madridf5675aa2009-02-18 14:30:44 -08004595- CONFIG_NS16550_MIN_FUNCTIONS:
4596 Define this if you desire to only have use of the NS16550_init
4597 and NS16550_putc functions for the serial driver located at
4598 drivers/serial/ns16550.c. This option is useful for saving
4599 space for already greatly restricted images, including but not
4600 limited to NAND_SPL configurations.
4601
Simon Glassb2b92f52012-11-30 13:01:18 +00004602- CONFIG_DISPLAY_BOARDINFO
4603 Display information about the board that U-Boot is running on
4604 when U-Boot starts up. The board function checkboard() is called
4605 to do this.
4606
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004607- CONFIG_DISPLAY_BOARDINFO_LATE
4608 Similar to the previous option, but display this information
4609 later, once stdio is running and output goes to the LCD, if
4610 present.
4611
Sascha Silbefeb85802013-08-11 16:40:43 +02004612- CONFIG_BOARD_SIZE_LIMIT:
4613 Maximum size of the U-Boot image. When defined, the
4614 build system checks that the actual size does not
4615 exceed it.
4616
wdenkc6097192002-11-03 00:24:07 +00004617Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004618---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004620- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004621 Cache Line Size of the CPU.
4622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004623- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004624 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004625
wdenk42d1f032003-10-15 23:53:47 +00004626 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4627 and RPXsuper) to be able to adjust the position of
4628 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004629
Timur Tabie46fedf2011-08-04 18:03:41 -05004630- CONFIG_SYS_CCSRBAR_DEFAULT:
4631 Default (power-on reset) physical address of CCSR on Freescale
4632 PowerPC SOCs.
4633
4634- CONFIG_SYS_CCSRBAR:
4635 Virtual address of CCSR. On a 32-bit build, this is typically
4636 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4637
4638 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4639 for cross-platform code that uses that macro instead.
4640
4641- CONFIG_SYS_CCSRBAR_PHYS:
4642 Physical address of CCSR. CCSR can be relocated to a new
4643 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004644 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004645 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4646 is typically relocated on 36-bit builds. It is recommended
4647 that this macro be defined via the _HIGH and _LOW macros:
4648
4649 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4650 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4651
4652- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004653 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4654 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004655 used in assembly code, so it must not contain typecasts or
4656 integer size suffixes (e.g. "ULL").
4657
4658- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4659 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4660 used in assembly code, so it must not contain typecasts or
4661 integer size suffixes (e.g. "ULL").
4662
4663- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4664 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4665 forced to a value that ensures that CCSR is not relocated.
4666
wdenk7f6c2cb2002-11-10 22:06:23 +00004667- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004668 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004669
4670 the default drive number (default value 0)
4671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004672 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004673
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004674 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004675 (default value 1)
4676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004677 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004678
wdenk43d96162003-03-06 00:02:04 +00004679 defines the offset of register from address. It
4680 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004681 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004683 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4684 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004685 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004687 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004688 fdc_hw_init() is called at the beginning of the FDC
4689 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004690 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004691 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004692
Macpaul Lin0abddf82011-04-11 20:45:32 +00004693- CONFIG_IDE_AHB:
4694 Most IDE controllers were designed to be connected with PCI
4695 interface. Only few of them were designed for AHB interface.
4696 When software is doing ATA command and data transfer to
4697 IDE devices through IDE-AHB controller, some additional
4698 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004699 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004701- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004702 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004703 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004705- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk7152b1d2003-09-05 23:19:14 +00004707 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004708 initial data and stack; please note that this must be
4709 writable memory that is working WITHOUT special
4710 initialization, i. e. you CANNOT use normal RAM which
4711 will become available only after programming the
4712 memory controller and running certain initialization
4713 sequences.
4714
4715 U-Boot uses the following memory types:
4716 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4717 - MPC824X: data cache
4718 - PPC4xx: data cache
4719
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004720- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004721
4722 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004723 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4724 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004725 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004726 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004727 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4728 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4729 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004730
4731 Note:
4732 On the MPC824X (or other systems that use the data
4733 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004734 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004735 point to an otherwise UNUSED address space between
4736 the top of RAM and the start of the PCI space.
4737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004738- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004740- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004742- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004744- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004746- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004748- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004750- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004751 SDRAM timing
4752
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004753- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004754 periodic timer for refresh
4755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004756- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004758- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4759 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4760 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4761 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004762 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4763
4764- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004765 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4766 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004767 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004769- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4770 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004771 Machine Mode Register and Memory Periodic Timer
4772 Prescaler definitions (SDRAM timing)
4773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004774- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004775 enable I2C microcode relocation patch (MPC8xx);
4776 define relocation offset in DPRAM [DSP2]
4777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004778- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004779 enable SMC microcode relocation patch (MPC8xx);
4780 define relocation offset in DPRAM [SMC1]
4781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004782- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004783 enable SPI microcode relocation patch (MPC8xx);
4784 define relocation offset in DPRAM [SCC4]
4785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004786- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004787 Use OSCM clock mode on MBX8xx board. Be careful,
4788 wrong setting might damage your board. Read
4789 doc/README.MBX before setting this variable!
4790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004791- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004792 Offset of the bootmode word in DPRAM used by post
4793 (Power On Self Tests). This definition overrides
4794 #define'd default value in commproc.h resp.
4795 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004797- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4798 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4799 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4800 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4801 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4802 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4803 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4804 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004805 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004806
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004807- CONFIG_PCI_DISABLE_PCIE:
4808 Disable PCI-Express on systems where it is supported but not
4809 required.
4810
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004811- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004812 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004813 Don't do any setup work, presumably because someone or
4814 something has already done it, and we don't need to do it
4815 a second time. Useful for platforms that are pre-booted
4816 by coreboot or similar.
4817
Gabor Juhos842033e2013-05-30 07:06:12 +00004818- CONFIG_PCI_INDIRECT_BRIDGE:
4819 Enable support for indirect PCI bridges.
4820
Kumar Galaa09b9b62010-12-30 12:09:53 -06004821- CONFIG_SYS_SRIO:
4822 Chip has SRIO or not
4823
4824- CONFIG_SRIO1:
4825 Board has SRIO 1 port available
4826
4827- CONFIG_SRIO2:
4828 Board has SRIO 2 port available
4829
Liu Gangc8b28152013-05-07 16:30:46 +08004830- CONFIG_SRIO_PCIE_BOOT_MASTER
4831 Board can support master function for Boot from SRIO and PCIE
4832
Kumar Galaa09b9b62010-12-30 12:09:53 -06004833- CONFIG_SYS_SRIOn_MEM_VIRT:
4834 Virtual Address of SRIO port 'n' memory region
4835
4836- CONFIG_SYS_SRIOn_MEM_PHYS:
4837 Physical Address of SRIO port 'n' memory region
4838
4839- CONFIG_SYS_SRIOn_MEM_SIZE:
4840 Size of SRIO port 'n' memory region
4841
Fabio Estevam66bd1842013-04-11 09:35:34 +00004842- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4843 Defined to tell the NAND controller that the NAND chip is using
4844 a 16 bit bus.
4845 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004846 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004847 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004848 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004849
4850- CONFIG_SYS_NDFC_EBC0_CFG
4851 Sets the EBC0_CFG register for the NDFC. If not defined
4852 a default value will be used.
4853
Ben Warrenbb99ad62006-09-07 16:50:54 -04004854- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004855 Get DDR timing information from an I2C EEPROM. Common
4856 with pluggable memory modules such as SODIMMs
4857
Ben Warrenbb99ad62006-09-07 16:50:54 -04004858 SPD_EEPROM_ADDRESS
4859 I2C address of the SPD EEPROM
4860
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004861- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004862 If SPD EEPROM is on an I2C bus other than the first
4863 one, specify here. Note that the value must resolve
4864 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004865
York Sun1b3e3c42011-06-07 09:42:16 +08004866- CONFIG_SYS_DDR_RAW_TIMING
4867 Get DDR timing information from other than SPD. Common with
4868 soldered DDR chips onboard without SPD. DDR raw timing
4869 parameters are extracted from datasheet and hard-coded into
4870 header files or board specific files.
4871
York Sun6f5e1dc2011-09-16 13:21:35 -07004872- CONFIG_FSL_DDR_INTERACTIVE
4873 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4874
York Sune32d59a2015-01-06 13:18:55 -08004875- CONFIG_FSL_DDR_SYNC_REFRESH
4876 Enable sync of refresh for multiple controllers.
4877
York Sun4516ff82015-03-19 09:30:28 -07004878- CONFIG_FSL_DDR_BIST
4879 Enable built-in memory test for Freescale DDR controllers.
4880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004881- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004882 Only for 83xx systems. If specified, then DDR should
4883 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004884
wdenkc26e4542004-04-18 10:13:26 +00004885- CONFIG_ETHER_ON_FEC[12]
4886 Define to enable FEC[12] on a 8xx series processor.
4887
4888- CONFIG_FEC[12]_PHY
4889 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004890 to the given FEC; i. e.
4891 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004892 means that the PHY with address 4 is connected to FEC1
4893
4894 When set to -1, means to probe for first available.
4895
4896- CONFIG_FEC[12]_PHY_NORXERR
4897 The PHY does not have a RXERR line (RMII only).
4898 (so program the FEC to ignore it).
4899
4900- CONFIG_RMII
4901 Enable RMII mode for all FECs.
4902 Note that this is a global option, we can't
4903 have one FEC in standard MII mode and another in RMII mode.
4904
wdenk5cf91d62004-04-23 20:32:05 +00004905- CONFIG_CRC32_VERIFY
4906 Add a verify option to the crc32 command.
4907 The syntax is:
4908
4909 => crc32 -v <address> <count> <crc32>
4910
4911 Where address/count indicate a memory area
4912 and crc32 is the correct crc32 which the
4913 area should have.
4914
wdenk56523f12004-07-11 17:40:54 +00004915- CONFIG_LOOPW
4916 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004917 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004918
stroese7b466642004-12-16 18:46:55 +00004919- CONFIG_MX_CYCLIC
4920 Add the "mdc" and "mwc" memory commands. These are cyclic
4921 "md/mw" commands.
4922 Examples:
4923
wdenkefe2a4d2004-12-16 21:44:03 +00004924 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004925 This command will print 4 bytes (10,11,12,13) each 500 ms.
4926
wdenkefe2a4d2004-12-16 21:44:03 +00004927 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004928 This command will write 12345678 to address 100 all 10 ms.
4929
wdenkefe2a4d2004-12-16 21:44:03 +00004930 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004931 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004932
wdenk8aa1a2d2005-04-04 12:44:11 +00004933- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004934 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004935 low level initializations (like setting up the memory
4936 controller) are omitted and/or U-Boot does not
4937 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004938
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004939 Normally this variable MUST NOT be defined. The only
4940 exception is when U-Boot is loaded (to RAM) by some
4941 other boot loader or by a debugger which performs
4942 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004943
Aneesh V401bb302011-07-13 05:11:07 +00004944- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004945 Modifies the behaviour of start.S when compiling a loader
4946 that is executed before the actual U-Boot. E.g. when
4947 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004948
Ying Zhang3aa29de2013-08-16 15:16:15 +08004949- CONFIG_TPL_BUILD
4950 Modifies the behaviour of start.S when compiling a loader
4951 that is executed after the SPL and before the actual U-Boot.
4952 It is loaded by the SPL.
4953
Ying Zhang5df572f2013-05-20 14:07:23 +08004954- CONFIG_SYS_MPC85XX_NO_RESETVEC
4955 Only for 85xx systems. If this variable is specified, the section
4956 .resetvec is not kept and the section .bootpg is placed in the
4957 previous 4k of the .text section.
4958
Simon Glass4213fc22013-02-24 17:33:14 +00004959- CONFIG_ARCH_MAP_SYSMEM
4960 Generally U-Boot (and in particular the md command) uses
4961 effective address. It is therefore not necessary to regard
4962 U-Boot address as virtual addresses that need to be translated
4963 to physical addresses. However, sandbox requires this, since
4964 it maintains its own little RAM buffer which contains all
4965 addressable memory. This option causes some memory accesses
4966 to be mapped through map_sysmem() / unmap_sysmem().
4967
Matthias Weisserd8834a12011-03-10 21:36:32 +00004968- CONFIG_USE_ARCH_MEMCPY
4969 CONFIG_USE_ARCH_MEMSET
4970 If these options are used a optimized version of memcpy/memset will
4971 be used if available. These functions may be faster under some
4972 conditions but may increase the binary size.
4973
Simon Glass588a13f2013-02-14 04:18:54 +00004974- CONFIG_X86_RESET_VECTOR
4975 If defined, the x86 reset vector code is included. This is not
4976 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004977
Mark Jacksonfc337052013-03-04 01:27:20 +00004978- CONFIG_SYS_MPUCLK
4979 Defines the MPU clock speed (in MHz).
4980
4981 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004982
Heiko Schocher16678eb2013-11-04 14:05:00 +01004983- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4984 Enables the RTC32K OSC on AM33xx based plattforms
4985
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004986- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4987 Option to disable subpage write in NAND driver
4988 driver that uses this:
4989 drivers/mtd/nand/davinci_nand.c
4990
Timur Tabif2717b42011-11-22 09:21:25 -06004991Freescale QE/FMAN Firmware Support:
4992-----------------------------------
4993
4994The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4995loading of "firmware", which is encoded in the QE firmware binary format.
4996This firmware often needs to be loaded during U-Boot booting, so macros
4997are used to identify the storage device (NOR flash, SPI, etc) and the address
4998within that device.
4999
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005000- CONFIG_SYS_FMAN_FW_ADDR
5001 The address in the storage device where the FMAN microcode is located. The
5002 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5003 is also specified.
5004
5005- CONFIG_SYS_QE_FW_ADDR
5006 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005007 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5008 is also specified.
5009
5010- CONFIG_SYS_QE_FMAN_FW_LENGTH
5011 The maximum possible size of the firmware. The firmware binary format
5012 has a field that specifies the actual size of the firmware, but it
5013 might not be possible to read any part of the firmware unless some
5014 local storage is allocated to hold the entire firmware first.
5015
5016- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5017 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5018 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5019 virtual address in NOR flash.
5020
5021- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5022 Specifies that QE/FMAN firmware is located in NAND flash.
5023 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5024
5025- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5026 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5027 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5028
5029- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5030 Specifies that QE/FMAN firmware is located on the primary SPI
5031 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5032
Liu Gang292dc6c2012-03-08 00:33:18 +00005033- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5034 Specifies that QE/FMAN firmware is located in the remote (master)
5035 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005036 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5037 window->master inbound window->master LAW->the ucode address in
5038 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005039
J. German Riverab940ca62014-06-23 15:15:55 -07005040Freescale Layerscape Management Complex Firmware Support:
5041---------------------------------------------------------
5042The Freescale Layerscape Management Complex (MC) supports the loading of
5043"firmware".
5044This firmware often needs to be loaded during U-Boot booting, so macros
5045are used to identify the storage device (NOR flash, SPI, etc) and the address
5046within that device.
5047
5048- CONFIG_FSL_MC_ENET
5049 Enable the MC driver for Layerscape SoCs.
5050
5051- CONFIG_SYS_LS_MC_FW_ADDR
5052 The address in the storage device where the firmware is located. The
5053 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5054 is also specified.
5055
5056- CONFIG_SYS_LS_MC_FW_LENGTH
5057 The maximum possible size of the firmware. The firmware binary format
5058 has a field that specifies the actual size of the firmware, but it
5059 might not be possible to read any part of the firmware unless some
5060 local storage is allocated to hold the entire firmware first.
5061
5062- CONFIG_SYS_LS_MC_FW_IN_NOR
5063 Specifies that MC firmware is located in NOR flash, mapped as
5064 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5065 virtual address in NOR flash.
5066
wdenkc6097192002-11-03 00:24:07 +00005067Building the Software:
5068======================
5069
Wolfgang Denk218ca722008-03-26 10:40:12 +01005070Building U-Boot has been tested in several native build environments
5071and in many different cross environments. Of course we cannot support
5072all possibly existing versions of cross development tools in all
5073(potentially obsolete) versions. In case of tool chain problems we
5074recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5075which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005076
Wolfgang Denk218ca722008-03-26 10:40:12 +01005077If you are not using a native environment, it is assumed that you
5078have GNU cross compiling tools available in your path. In this case,
5079you must set the environment variable CROSS_COMPILE in your shell.
5080Note that no changes to the Makefile or any other source files are
5081necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005082
Wolfgang Denk218ca722008-03-26 10:40:12 +01005083 $ CROSS_COMPILE=ppc_4xx-
5084 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005085
Peter Tyser2f8d3962009-03-13 18:54:51 -05005086Note: If you wish to generate Windows versions of the utilities in
5087 the tools directory you can use the MinGW toolchain
5088 (http://www.mingw.org). Set your HOST tools to the MinGW
5089 toolchain and execute 'make tools'. For example:
5090
5091 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5092
5093 Binaries such as tools/mkimage.exe will be created which can
5094 be executed on computers running Windows.
5095
Wolfgang Denk218ca722008-03-26 10:40:12 +01005096U-Boot is intended to be simple to build. After installing the
5097sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005098is done by typing:
5099
Holger Freytherab584d62014-08-04 09:26:05 +02005100 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005101
Holger Freytherab584d62014-08-04 09:26:05 +02005102where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005103rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005104
wdenk2729af92004-05-03 20:45:30 +00005105Note: for some board special configuration names may exist; check if
5106 additional information is available from the board vendor; for
5107 instance, the TQM823L systems are available without (standard)
5108 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005109 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005110
Holger Freytherab584d62014-08-04 09:26:05 +02005111 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005112 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005113
Holger Freytherab584d62014-08-04 09:26:05 +02005114 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005115 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk2729af92004-05-03 20:45:30 +00005117 etc.
wdenkc6097192002-11-03 00:24:07 +00005118
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk2729af92004-05-03 20:45:30 +00005120Finally, type "make all", and you should get some working U-Boot
5121images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123- "u-boot.bin" is a raw binary image
5124- "u-boot" is an image in ELF binary format
5125- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005126
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005127By default the build is performed locally and the objects are saved
5128in the source directory. One of the two methods can be used to change
5129this behavior and build U-Boot to some external directory:
5130
51311. Add O= to the make command line invocations:
5132
5133 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005134 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005135 make O=/tmp/build all
5136
Timo Ketolaadbba992014-11-06 14:39:05 +020051372. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005138
Timo Ketolaadbba992014-11-06 14:39:05 +02005139 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005140 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005141 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005142 make all
5143
Timo Ketolaadbba992014-11-06 14:39:05 +02005144Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005145variable.
5146
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148Please be aware that the Makefiles assume you are using GNU make, so
5149for instance on NetBSD you might need to use "gmake" instead of
5150native "make".
wdenkc6097192002-11-03 00:24:07 +00005151
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk2729af92004-05-03 20:45:30 +00005153If the system board that you have is not listed, then you will need
5154to port U-Boot to your hardware platform. To do this, follow these
5155steps:
wdenkc6097192002-11-03 00:24:07 +00005156
wdenk2729af92004-05-03 20:45:30 +000051571. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005158 "boards.cfg" file, using the existing entries as examples.
5159 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051602. Create a new directory to hold your board specific code. Add any
5161 files you need. In your board directory, you will need at least
5162 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51633. Create a new configuration file "include/configs/<board>.h" for
5164 your board
51653. If you're porting U-Boot to a new CPU, then also create a new
5166 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051674. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051685. Type "make", and you should get a working "u-boot.srec" file
5169 to be installed on your target system.
51706. Debug and solve any problems that might arise.
5171 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005172
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk2729af92004-05-03 20:45:30 +00005174Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5175==============================================================
wdenkc6097192002-11-03 00:24:07 +00005176
Wolfgang Denk218ca722008-03-26 10:40:12 +01005177If you have modified U-Boot sources (for instance added a new board
5178or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005179provide feedback to the other developers. The feedback normally takes
5180the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005181official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005182
Wolfgang Denk218ca722008-03-26 10:40:12 +01005183But before you submit such a patch, please verify that your modifi-
5184cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005185the supported boards compile WITHOUT ANY compiler warnings. To do so,
5186just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005187for ALL supported system. Be warned, this will take a while. You can
5188select which (cross) compiler to use by passing a `CROSS_COMPILE'
5189environment variable to the script, i. e. to use the ELDK cross tools
5190you can type
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk2729af92004-05-03 20:45:30 +00005194or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005195
wdenk2729af92004-05-03 20:45:30 +00005196 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005197
Wolfgang Denk218ca722008-03-26 10:40:12 +01005198When using the MAKEALL script, the default behaviour is to build
5199U-Boot in the source directory. This location can be changed by
5200setting the BUILD_DIR environment variable. Also, for each target
5201built, the MAKEALL script saves two log files (<target>.ERR and
5202<target>.MAKEALL) in the <source dir>/LOG directory. This default
5203location can be changed by setting the MAKEALL_LOGDIR environment
5204variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005205
5206 export BUILD_DIR=/tmp/build
5207 export MAKEALL_LOGDIR=/tmp/log
5208 CROSS_COMPILE=ppc_8xx- MAKEALL
5209
Wolfgang Denk218ca722008-03-26 10:40:12 +01005210With the above settings build objects are saved in the /tmp/build,
5211log files are saved in the /tmp/log and the source tree remains clean
5212during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005213
5214
wdenk2729af92004-05-03 20:45:30 +00005215See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005216
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk2729af92004-05-03 20:45:30 +00005218Monitor Commands - Overview:
5219============================
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk2729af92004-05-03 20:45:30 +00005221go - start application at address 'addr'
5222run - run commands in an environment variable
5223bootm - boot application image from memory
5224bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005225bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005226tftpboot- boot image via network using TFTP protocol
5227 and env variables "ipaddr" and "serverip"
5228 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005229tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005230rarpboot- boot image via network using RARP/TFTP protocol
5231diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5232loads - load S-Record file over serial line
5233loadb - load binary file over serial line (kermit mode)
5234md - memory display
5235mm - memory modify (auto-incrementing)
5236nm - memory modify (constant address)
5237mw - memory write (fill)
5238cp - memory copy
5239cmp - memory compare
5240crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005241i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005242sspi - SPI utility commands
5243base - print or set address offset
5244printenv- print environment variables
5245setenv - set environment variables
5246saveenv - save environment variables to persistent storage
5247protect - enable or disable FLASH write protection
5248erase - erase FLASH memory
5249flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005250nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005251bdinfo - print Board Info structure
5252iminfo - print header information for application image
5253coninfo - print console devices and informations
5254ide - IDE sub-system
5255loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005256loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005257mtest - simple RAM test
5258icache - enable or disable instruction cache
5259dcache - enable or disable data cache
5260reset - Perform RESET of the CPU
5261echo - echo args to console
5262version - print monitor version
5263help - print online help
5264? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005265
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk2729af92004-05-03 20:45:30 +00005267Monitor Commands - Detailed Description:
5268========================================
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk2729af92004-05-03 20:45:30 +00005270TODO.
wdenkc6097192002-11-03 00:24:07 +00005271
wdenk2729af92004-05-03 20:45:30 +00005272For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005273
5274
wdenk2729af92004-05-03 20:45:30 +00005275Environment Variables:
5276======================
wdenkc6097192002-11-03 00:24:07 +00005277
wdenk2729af92004-05-03 20:45:30 +00005278U-Boot supports user configuration using Environment Variables which
5279can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk2729af92004-05-03 20:45:30 +00005281Environment Variables are set using "setenv", printed using
5282"printenv", and saved to Flash using "saveenv". Using "setenv"
5283without a value can be used to delete a variable from the
5284environment. As long as you don't save the environment you are
5285working with an in-memory copy. In case the Flash area containing the
5286environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005287
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005288Some configuration options can be set using Environment Variables.
5289
5290List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk2729af92004-05-03 20:45:30 +00005292 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk2729af92004-05-03 20:45:30 +00005296 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk2729af92004-05-03 20:45:30 +00005298 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005301
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005302 bootm_low - Memory range available for image processing in the bootm
5303 command can be restricted. This variable is given as
5304 a hexadecimal number and defines lowest address allowed
5305 for use by the bootm command. See also "bootm_size"
5306 environment variable. Address defined by "bootm_low" is
5307 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005308 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5309 bootm_mapsize.
5310
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005311 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005312 This variable is given as a hexadecimal number and it
5313 defines the size of the memory region starting at base
5314 address bootm_low that is accessible by the Linux kernel
5315 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5316 as the default value if it is defined, and bootm_size is
5317 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005318
5319 bootm_size - Memory range available for image processing in the bootm
5320 command can be restricted. This variable is given as
5321 a hexadecimal number and defines the size of the region
5322 allowed for use by the bootm command. See also "bootm_low"
5323 environment variable.
5324
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005325 updatefile - Location of the software update file on a TFTP server, used
5326 by the automatic software update feature. Please refer to
5327 documentation in doc/README.update for more details.
5328
wdenk2729af92004-05-03 20:45:30 +00005329 autoload - if set to "no" (any string beginning with 'n'),
5330 "bootp" will just load perform a lookup of the
5331 configuration from the BOOTP server, but not try to
5332 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk2729af92004-05-03 20:45:30 +00005334 autostart - if set to "yes", an image loaded using the "bootp",
5335 "rarpboot", "tftpboot" or "diskboot" commands will
5336 be automatically started (by internally calling
5337 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk2729af92004-05-03 20:45:30 +00005339 If set to "no", a standalone image passed to the
5340 "bootm" command will be copied to the load address
5341 (and eventually uncompressed), but NOT be started.
5342 This can be used to load and uncompress arbitrary
5343 data.
wdenkc6097192002-11-03 00:24:07 +00005344
David A. Longa28afca2011-07-09 16:40:19 -04005345 fdt_high - if set this restricts the maximum address that the
5346 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005347 For example, if you have a system with 1 GB memory
5348 at physical address 0x10000000, while Linux kernel
5349 only recognizes the first 704 MB as low memory, you
5350 may need to set fdt_high as 0x3C000000 to have the
5351 device tree blob be copied to the maximum address
5352 of the 704 MB low memory, so that Linux kernel can
5353 access it during the boot procedure.
5354
David A. Longa28afca2011-07-09 16:40:19 -04005355 If this is set to the special value 0xFFFFFFFF then
5356 the fdt will not be copied at all on boot. For this
5357 to work it must reside in writable memory, have
5358 sufficient padding on the end of it for u-boot to
5359 add the information it needs into it, and the memory
5360 must be accessible by the kernel.
5361
Simon Glasseea63e02011-10-24 19:15:34 +00005362 fdtcontroladdr- if set this is the address of the control flattened
5363 device tree used by U-Boot when CONFIG_OF_CONTROL is
5364 defined.
5365
wdenk17ea1172004-06-06 21:51:03 +00005366 i2cfast - (PPC405GP|PPC405EP only)
5367 if set to 'y' configures Linux I2C driver for fast
5368 mode (400kHZ). This environment variable is used in
5369 initialization code. So, for changes to be effective
5370 it must be saved and board must be reset.
5371
wdenk2729af92004-05-03 20:45:30 +00005372 initrd_high - restrict positioning of initrd images:
5373 If this variable is not set, initrd images will be
5374 copied to the highest possible address in RAM; this
5375 is usually what you want since it allows for
5376 maximum initrd size. If for some reason you want to
5377 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005378 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005379 variable to a value of "no" or "off" or "0".
5380 Alternatively, you can set it to a maximum upper
5381 address to use (U-Boot will still check that it
5382 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384 For instance, when you have a system with 16 MB
5385 RAM, and want to reserve 4 MB from use by Linux,
5386 you can do this by adding "mem=12M" to the value of
5387 the "bootargs" variable. However, now you must make
5388 sure that the initrd image is placed in the first
5389 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk2729af92004-05-03 20:45:30 +00005391 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005392
wdenk2729af92004-05-03 20:45:30 +00005393 If you set initrd_high to 0xFFFFFFFF, this is an
5394 indication to U-Boot that all addresses are legal
5395 for the Linux kernel, including addresses in flash
5396 memory. In this case U-Boot will NOT COPY the
5397 ramdisk at all. This may be useful to reduce the
5398 boot time on your system, but requires that this
5399 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005402
wdenk2729af92004-05-03 20:45:30 +00005403 loadaddr - Default load address for commands like "bootp",
5404 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk2729af92004-05-03 20:45:30 +00005406 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk2729af92004-05-03 20:45:30 +00005408 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005409
wdenk2729af92004-05-03 20:45:30 +00005410 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk2729af92004-05-03 20:45:30 +00005412 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005415
Mike Frysingere2a53452011-10-02 10:01:27 +00005416 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005417
Mike Frysingere2a53452011-10-02 10:01:27 +00005418 ethact - controls which interface is currently active.
5419 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005420
Heiko Schocher48690d82010-07-20 17:45:02 +02005421 => setenv ethact FEC
5422 => ping 192.168.0.1 # traffic sent on FEC
5423 => setenv ethact SCC
5424 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005425
Matthias Fuchse1692572008-01-17 07:45:05 +01005426 ethrotate - When set to "no" U-Boot does not go through all
5427 available network interfaces.
5428 It just stays at the currently selected interface.
5429
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005430 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005431 either succeed or fail without retrying.
5432 When set to "once" the network operation will
5433 fail when all the available network interfaces
5434 are tried once without success.
5435 Useful on scripts which control the retry operation
5436 themselves.
wdenkc6097192002-11-03 00:24:07 +00005437
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005438 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005439
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005440 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005441 changing the console to be empty. If "yes" it will be
5442 made silent. If "no" it will not be made silent. If
5443 unset, then it will be made silent if the U-Boot console
5444 is silent.
5445
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005446 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005447 UDP source port.
5448
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005449 tftpdstport - If this is set, the value is used for TFTP's UDP
5450 destination port instead of the Well Know Port 69.
5451
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005452 tftpblocksize - Block size to use for TFTP transfers; if not set,
5453 we use the TFTP server's default block size
5454
5455 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5456 seconds, minimum value is 1000 = 1 second). Defines
5457 when a packet is considered to be lost so it has to
5458 be retransmitted. The default is 5000 = 5 seconds.
5459 Lowering this value may make downloads succeed
5460 faster in networks with high packet loss rates or
5461 with unreliable TFTP servers.
5462
5463 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005464 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005465 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005466
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005467The following image location variables contain the location of images
5468used in booting. The "Image" column gives the role of the image and is
5469not an environment variable name. The other columns are environment
5470variable names. "File Name" gives the name of the file on a TFTP
5471server, "RAM Address" gives the location in RAM the image will be
5472loaded to, and "Flash Location" gives the image's address in NOR
5473flash or offset in NAND flash.
5474
5475*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005476boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005477boards use these variables for other purposes.
5478
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005479Image File Name RAM Address Flash Location
5480----- --------- ----------- --------------
5481u-boot u-boot u-boot_addr_r u-boot_addr
5482Linux kernel bootfile kernel_addr_r kernel_addr
5483device tree blob fdtfile fdt_addr_r fdt_addr
5484ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005485
wdenk2729af92004-05-03 20:45:30 +00005486The following environment variables may be used and automatically
5487updated by the network boot commands ("bootp" and "rarpboot"),
5488depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005489
wdenk2729af92004-05-03 20:45:30 +00005490 bootfile - see above
5491 dnsip - IP address of your Domain Name Server
5492 dnsip2 - IP address of your secondary Domain Name Server
5493 gatewayip - IP address of the Gateway (Router) to use
5494 hostname - Target hostname
5495 ipaddr - see above
5496 netmask - Subnet Mask
5497 rootpath - Pathname of the root filesystem on the NFS server
5498 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005499
wdenka3d991b2004-04-15 21:48:45 +00005500
wdenk2729af92004-05-03 20:45:30 +00005501There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503 serial# - contains hardware identification information such
5504 as type string and/or serial number
5505 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk2729af92004-05-03 20:45:30 +00005507These variables can be set only once (usually during manufacturing of
5508the board). U-Boot refuses to delete or overwrite these variables
5509once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005510
5511
wdenk2729af92004-05-03 20:45:30 +00005512Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk2729af92004-05-03 20:45:30 +00005514 ver - Contains the U-Boot version string as printed
5515 with the "version" command. This variable is
5516 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005517
wdenkc6097192002-11-03 00:24:07 +00005518
wdenk2729af92004-05-03 20:45:30 +00005519Please note that changes to some configuration parameters may take
5520only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005521
stroesec1551ea2003-04-04 15:53:41 +00005522
Joe Hershberger170ab112012-12-11 22:16:24 -06005523Callback functions for environment variables:
5524---------------------------------------------
5525
5526For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005527when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005528be associated with arbitrary variables. On creation, overwrite, or
5529deletion, the callback will provide the opportunity for some side
5530effect to happen or for the change to be rejected.
5531
5532The callbacks are named and associated with a function using the
5533U_BOOT_ENV_CALLBACK macro in your board or driver code.
5534
5535These callbacks are associated with variables in one of two ways. The
5536static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5537in the board configuration to a string that defines a list of
5538associations. The list must be in the following format:
5539
5540 entry = variable_name[:callback_name]
5541 list = entry[,list]
5542
5543If the callback name is not specified, then the callback is deleted.
5544Spaces are also allowed anywhere in the list.
5545
5546Callbacks can also be associated by defining the ".callbacks" variable
5547with the same list format above. Any association in ".callbacks" will
5548override any association in the static list. You can define
5549CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005550".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005551
5552
wdenk2729af92004-05-03 20:45:30 +00005553Command Line Parsing:
5554=====================
stroesec1551ea2003-04-04 15:53:41 +00005555
wdenk2729af92004-05-03 20:45:30 +00005556There are two different command line parsers available with U-Boot:
5557the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005558
wdenk2729af92004-05-03 20:45:30 +00005559Old, simple command line parser:
5560--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk2729af92004-05-03 20:45:30 +00005562- supports environment variables (through setenv / saveenv commands)
5563- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005564- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005565- special characters ('$', ';') can be escaped by prefixing with '\',
5566 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005567 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005568- You can also escape text by enclosing in single apostrophes, for example:
5569 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571Hush shell:
5572-----------
wdenkf07771c2003-05-28 08:06:31 +00005573
wdenk2729af92004-05-03 20:45:30 +00005574- similar to Bourne shell, with control structures like
5575 if...then...else...fi, for...do...done; while...do...done,
5576 until...do...done, ...
5577- supports environment ("global") variables (through setenv / saveenv
5578 commands) and local shell variables (through standard shell syntax
5579 "name=value"); only environment variables can be used with "run"
5580 command
wdenkf07771c2003-05-28 08:06:31 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582General rules:
5583--------------
wdenkf07771c2003-05-28 08:06:31 +00005584
wdenk2729af92004-05-03 20:45:30 +00005585(1) If a command line (or an environment variable executed by a "run"
5586 command) contains several commands separated by semicolon, and
5587 one of these commands fails, then the remaining commands will be
5588 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005589
wdenk2729af92004-05-03 20:45:30 +00005590(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005591 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005592 command will cause "run" to terminate, i. e. the remaining
5593 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005594
wdenk2729af92004-05-03 20:45:30 +00005595Note for Redundant Ethernet Interfaces:
5596=======================================
wdenkf07771c2003-05-28 08:06:31 +00005597
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005598Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005599such configurations and is capable of automatic selection of a
5600"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005601
wdenk2729af92004-05-03 20:45:30 +00005602Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5603MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5604"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606If the network interface stores some valid MAC address (for instance
5607in SROM), this is used as default address if there is NO correspon-
5608ding setting in the environment; if the corresponding environment
5609variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611o If the SROM has a valid MAC address, and there is no address in the
5612 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk2729af92004-05-03 20:45:30 +00005614o If there is no valid address in the SROM, and a definition in the
5615 environment exists, then the value from the environment variable is
5616 used.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk2729af92004-05-03 20:45:30 +00005618o If both the SROM and the environment contain a MAC address, and
5619 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005620
wdenk2729af92004-05-03 20:45:30 +00005621o If both the SROM and the environment contain a MAC address, and the
5622 addresses differ, the value from the environment is used and a
5623 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625o If neither SROM nor the environment contain a MAC address, an error
5626 is raised.
wdenkc6097192002-11-03 00:24:07 +00005627
Ben Warrenecee9322010-04-26 11:11:46 -07005628If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005629will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005630may be skipped by setting the appropriate 'ethmacskip' environment variable.
5631The naming convention is as follows:
5632"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005633
wdenk2729af92004-05-03 20:45:30 +00005634Image Formats:
5635==============
wdenkc6097192002-11-03 00:24:07 +00005636
Marian Balakowicz3310c542008-03-12 12:13:13 +01005637U-Boot is capable of booting (and performing other auxiliary operations on)
5638images in two formats:
5639
5640New uImage format (FIT)
5641-----------------------
5642
5643Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5644to Flattened Device Tree). It allows the use of images with multiple
5645components (several kernels, ramdisks, etc.), with contents protected by
5646SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5647
5648
5649Old uImage format
5650-----------------
5651
5652Old image format is based on binary files which can be basically anything,
5653preceded by a special header; see the definitions in include/image.h for
5654details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk2729af92004-05-03 20:45:30 +00005656* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5657 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005658 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5659 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5660 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005661* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005662 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5663 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005664* Compression Type (uncompressed, gzip, bzip2)
5665* Load Address
5666* Entry Point
5667* Image Name
5668* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk2729af92004-05-03 20:45:30 +00005670The header is marked by a special Magic Number, and both the header
5671and the data portions of the image are secured against corruption by
5672CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005673
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk2729af92004-05-03 20:45:30 +00005675Linux Support:
5676==============
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678Although U-Boot should support any OS or standalone application
5679easily, the main focus has always been on Linux during the design of
5680U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005681
wdenk2729af92004-05-03 20:45:30 +00005682U-Boot includes many features that so far have been part of some
5683special "boot loader" code within the Linux kernel. Also, any
5684"initrd" images to be used are no longer part of one big Linux image;
5685instead, kernel and "initrd" are separate images. This implementation
5686serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk2729af92004-05-03 20:45:30 +00005688- the same features can be used for other OS or standalone
5689 applications (for instance: using compressed images to reduce the
5690 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692- it becomes much easier to port new Linux kernel versions because
5693 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk2729af92004-05-03 20:45:30 +00005695- the same Linux kernel image can now be used with different "initrd"
5696 images; of course this also means that different kernel images can
5697 be run with the same "initrd". This makes testing easier (you don't
5698 have to build a new "zImage.initrd" Linux image when you just
5699 change a file in your "initrd"). Also, a field-upgrade of the
5700 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005701
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703Linux HOWTO:
5704============
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk2729af92004-05-03 20:45:30 +00005706Porting Linux to U-Boot based systems:
5707---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk2729af92004-05-03 20:45:30 +00005709U-Boot cannot save you from doing all the necessary modifications to
5710configure the Linux device drivers for use with your target hardware
5711(no, we don't intend to provide a full virtual machine interface to
5712Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005713
Stefan Roesea47a12b2010-04-15 16:07:28 +02005714But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk2729af92004-05-03 20:45:30 +00005716Just make sure your machine specific header file (for instance
5717include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005718Information structure as we define in include/asm-<arch>/u-boot.h,
5719and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005720as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005721
Simon Glass2eb31b12014-06-11 23:29:46 -06005722Note that U-Boot now has a driver model, a unified model for drivers.
5723If you are adding a new driver, plumb it into driver model. If there
5724is no uclass available, you are encouraged to create one. See
5725doc/driver-model.
5726
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728Configuring the Linux kernel:
5729-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731No specific requirements for U-Boot. Make sure you have some root
5732device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005733
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk2729af92004-05-03 20:45:30 +00005735Building a Linux Image:
5736-----------------------
wdenkc6097192002-11-03 00:24:07 +00005737
wdenk2729af92004-05-03 20:45:30 +00005738With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5739not used. If you use recent kernel source, a new build target
5740"uImage" will exist which automatically builds an image usable by
5741U-Boot. Most older kernels also have support for a "pImage" target,
5742which was introduced for our predecessor project PPCBoot and uses a
5743100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745Example:
wdenkc6097192002-11-03 00:24:07 +00005746
Holger Freytherab584d62014-08-04 09:26:05 +02005747 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005748 make oldconfig
5749 make dep
5750 make uImage
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752The "uImage" build target uses a special tool (in 'tools/mkimage') to
5753encapsulate a compressed Linux kernel image with header information,
5754CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk2729af92004-05-03 20:45:30 +00005756* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk2729af92004-05-03 20:45:30 +00005758* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk2729af92004-05-03 20:45:30 +00005760 ${CROSS_COMPILE}-objcopy -O binary \
5761 -R .note -R .comment \
5762 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk2729af92004-05-03 20:45:30 +00005766 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005769
wdenk2729af92004-05-03 20:45:30 +00005770 mkimage -A ppc -O linux -T kernel -C gzip \
5771 -a 0 -e 0 -n "Linux Kernel Image" \
5772 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005773
wdenk24ee89b2002-11-03 17:56:27 +00005774
wdenk2729af92004-05-03 20:45:30 +00005775The "mkimage" tool can also be used to create ramdisk images for use
5776with U-Boot, either separated from the Linux kernel image, or
5777combined into one file. "mkimage" encapsulates the images with a 64
5778byte header containing information about target architecture,
5779operating system, image type, compression method, entry points, time
5780stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005781
wdenk2729af92004-05-03 20:45:30 +00005782"mkimage" can be called in two ways: to verify existing images and
5783print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005784
wdenk2729af92004-05-03 20:45:30 +00005785In the first form (with "-l" option) mkimage lists the information
5786contained in the header of an existing U-Boot image; this includes
5787checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005788
wdenk2729af92004-05-03 20:45:30 +00005789 tools/mkimage -l image
5790 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792The second form (with "-d" option) is used to build a U-Boot image
5793from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005794
wdenk2729af92004-05-03 20:45:30 +00005795 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5796 -n name -d data_file image
5797 -A ==> set architecture to 'arch'
5798 -O ==> set operating system to 'os'
5799 -T ==> set image type to 'type'
5800 -C ==> set compression type 'comp'
5801 -a ==> set load address to 'addr' (hex)
5802 -e ==> set entry point to 'ep' (hex)
5803 -n ==> set image name to 'name'
5804 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005805
wdenk69459792004-05-29 16:53:29 +00005806Right now, all Linux kernels for PowerPC systems use the same load
5807address (0x00000000), but the entry point address depends on the
5808kernel version:
wdenkc6097192002-11-03 00:24:07 +00005809
wdenk2729af92004-05-03 20:45:30 +00005810- 2.2.x kernels have the entry point at 0x0000000C,
5811- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk2729af92004-05-03 20:45:30 +00005813So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005814
wdenk2729af92004-05-03 20:45:30 +00005815 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5816 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005817 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005818 > examples/uImage.TQM850L
5819 Image Name: 2.4.4 kernel for TQM850L
5820 Created: Wed Jul 19 02:34:59 2000
5821 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5822 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5823 Load Address: 0x00000000
5824 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005825
wdenk2729af92004-05-03 20:45:30 +00005826To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk2729af92004-05-03 20:45:30 +00005828 -> tools/mkimage -l examples/uImage.TQM850L
5829 Image Name: 2.4.4 kernel for TQM850L
5830 Created: Wed Jul 19 02:34:59 2000
5831 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5832 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5833 Load Address: 0x00000000
5834 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk2729af92004-05-03 20:45:30 +00005836NOTE: for embedded systems where boot time is critical you can trade
5837speed for memory and install an UNCOMPRESSED image instead: this
5838needs more space in Flash, but boots much faster since it does not
5839need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005840
Stefan Roesea47a12b2010-04-15 16:07:28 +02005841 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005842 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5843 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005844 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005845 > examples/uImage.TQM850L-uncompressed
5846 Image Name: 2.4.4 kernel for TQM850L
5847 Created: Wed Jul 19 02:34:59 2000
5848 Image Type: PowerPC Linux Kernel Image (uncompressed)
5849 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5850 Load Address: 0x00000000
5851 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005852
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk2729af92004-05-03 20:45:30 +00005854Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5855when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005856
wdenk2729af92004-05-03 20:45:30 +00005857 -> tools/mkimage -n 'Simple Ramdisk Image' \
5858 > -A ppc -O linux -T ramdisk -C gzip \
5859 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5860 Image Name: Simple Ramdisk Image
5861 Created: Wed Jan 12 14:01:50 2000
5862 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5863 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5864 Load Address: 0x00000000
5865 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005866
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005867The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5868option performs the converse operation of the mkimage's second form (the "-d"
5869option). Given an image built by mkimage, the dumpimage extracts a "data file"
5870from the image:
5871
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005872 tools/dumpimage -i image -T type -p position data_file
5873 -i ==> extract from the 'image' a specific 'data_file'
5874 -T ==> set image type to 'type'
5875 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005876
wdenkdb01a2e2004-04-15 23:14:49 +00005877
wdenk2729af92004-05-03 20:45:30 +00005878Installing a Linux Image:
5879-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005880
wdenk2729af92004-05-03 20:45:30 +00005881To downloading a U-Boot image over the serial (console) interface,
5882you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005883
wdenk2729af92004-05-03 20:45:30 +00005884 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005885
wdenk2729af92004-05-03 20:45:30 +00005886The 'objcopy' does not understand the information in the U-Boot
5887image header, so the resulting S-Record file will be relative to
5888address 0x00000000. To load it to a given address, you need to
5889specify the target address as 'offset' parameter with the 'loads'
5890command.
wdenkc6097192002-11-03 00:24:07 +00005891
wdenk2729af92004-05-03 20:45:30 +00005892Example: install the image to address 0x40100000 (which on the
5893TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk2729af92004-05-03 20:45:30 +00005895 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk2729af92004-05-03 20:45:30 +00005897 .......... done
5898 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk2729af92004-05-03 20:45:30 +00005900 => loads 40100000
5901 ## Ready for S-Record download ...
5902 ~>examples/image.srec
5903 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5904 ...
5905 15989 15990 15991 15992
5906 [file transfer complete]
5907 [connected]
5908 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005909
5910
wdenk2729af92004-05-03 20:45:30 +00005911You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005912this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005913corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005914
wdenk2729af92004-05-03 20:45:30 +00005915 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005916
wdenk2729af92004-05-03 20:45:30 +00005917 ## Checking Image at 40100000 ...
5918 Image Name: 2.2.13 for initrd on TQM850L
5919 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5920 Data Size: 335725 Bytes = 327 kB = 0 MB
5921 Load Address: 00000000
5922 Entry Point: 0000000c
5923 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005924
5925
wdenk2729af92004-05-03 20:45:30 +00005926Boot Linux:
5927-----------
wdenkc6097192002-11-03 00:24:07 +00005928
wdenk2729af92004-05-03 20:45:30 +00005929The "bootm" command is used to boot an application that is stored in
5930memory (RAM or Flash). In case of a Linux kernel image, the contents
5931of the "bootargs" environment variable is passed to the kernel as
5932parameters. You can check and modify this variable using the
5933"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005934
5935
wdenk2729af92004-05-03 20:45:30 +00005936 => printenv bootargs
5937 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk2729af92004-05-03 20:45:30 +00005939 => 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 +00005940
wdenk2729af92004-05-03 20:45:30 +00005941 => printenv bootargs
5942 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 +00005943
wdenk2729af92004-05-03 20:45:30 +00005944 => bootm 40020000
5945 ## Booting Linux kernel at 40020000 ...
5946 Image Name: 2.2.13 for NFS on TQM850L
5947 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5948 Data Size: 381681 Bytes = 372 kB = 0 MB
5949 Load Address: 00000000
5950 Entry Point: 0000000c
5951 Verifying Checksum ... OK
5952 Uncompressing Kernel Image ... OK
5953 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
5954 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5955 time_init: decrementer frequency = 187500000/60
5956 Calibrating delay loop... 49.77 BogoMIPS
5957 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5958 ...
wdenkc6097192002-11-03 00:24:07 +00005959
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005960If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005961the memory addresses of both the kernel and the initrd image (PPBCOOT
5962format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk2729af92004-05-03 20:45:30 +00005964 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk2729af92004-05-03 20:45:30 +00005966 ## Checking Image at 40100000 ...
5967 Image Name: 2.2.13 for initrd on TQM850L
5968 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5969 Data Size: 335725 Bytes = 327 kB = 0 MB
5970 Load Address: 00000000
5971 Entry Point: 0000000c
5972 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk2729af92004-05-03 20:45:30 +00005974 ## Checking Image at 40200000 ...
5975 Image Name: Simple Ramdisk Image
5976 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5977 Data Size: 566530 Bytes = 553 kB = 0 MB
5978 Load Address: 00000000
5979 Entry Point: 00000000
5980 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk2729af92004-05-03 20:45:30 +00005982 => bootm 40100000 40200000
5983 ## Booting Linux kernel at 40100000 ...
5984 Image Name: 2.2.13 for initrd on TQM850L
5985 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5986 Data Size: 335725 Bytes = 327 kB = 0 MB
5987 Load Address: 00000000
5988 Entry Point: 0000000c
5989 Verifying Checksum ... OK
5990 Uncompressing Kernel Image ... OK
5991 ## Loading RAMDisk Image at 40200000 ...
5992 Image Name: Simple Ramdisk Image
5993 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5994 Data Size: 566530 Bytes = 553 kB = 0 MB
5995 Load Address: 00000000
5996 Entry Point: 00000000
5997 Verifying Checksum ... OK
5998 Loading Ramdisk ... OK
5999 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
6000 Boot arguments: root=/dev/ram
6001 time_init: decrementer frequency = 187500000/60
6002 Calibrating delay loop... 49.77 BogoMIPS
6003 ...
6004 RAMDISK: Compressed image found at block 0
6005 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk2729af92004-05-03 20:45:30 +00006007 bash#
wdenkc6097192002-11-03 00:24:07 +00006008
Matthew McClintock02677682006-06-28 10:41:37 -05006009Boot Linux and pass a flat device tree:
6010-----------
6011
6012First, U-Boot must be compiled with the appropriate defines. See the section
6013titled "Linux Kernel Interface" above for a more in depth explanation. The
6014following is an example of how to start a kernel and pass an updated
6015flat device tree:
6016
6017=> print oftaddr
6018oftaddr=0x300000
6019=> print oft
6020oft=oftrees/mpc8540ads.dtb
6021=> tftp $oftaddr $oft
6022Speed: 1000, full duplex
6023Using TSEC0 device
6024TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6025Filename 'oftrees/mpc8540ads.dtb'.
6026Load address: 0x300000
6027Loading: #
6028done
6029Bytes transferred = 4106 (100a hex)
6030=> tftp $loadaddr $bootfile
6031Speed: 1000, full duplex
6032Using TSEC0 device
6033TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6034Filename 'uImage'.
6035Load address: 0x200000
6036Loading:############
6037done
6038Bytes transferred = 1029407 (fb51f hex)
6039=> print loadaddr
6040loadaddr=200000
6041=> print oftaddr
6042oftaddr=0x300000
6043=> bootm $loadaddr - $oftaddr
6044## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006045 Image Name: Linux-2.6.17-dirty
6046 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6047 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006048 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006049 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006050 Verifying Checksum ... OK
6051 Uncompressing Kernel Image ... OK
6052Booting using flat device tree at 0x300000
6053Using MPC85xx ADS machine description
6054Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6055[snip]
6056
6057
wdenk2729af92004-05-03 20:45:30 +00006058More About U-Boot Image Types:
6059------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006060
wdenk2729af92004-05-03 20:45:30 +00006061U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006062
wdenk2729af92004-05-03 20:45:30 +00006063 "Standalone Programs" are directly runnable in the environment
6064 provided by U-Boot; it is expected that (if they behave
6065 well) you can continue to work in U-Boot after return from
6066 the Standalone Program.
6067 "OS Kernel Images" are usually images of some Embedded OS which
6068 will take over control completely. Usually these programs
6069 will install their own set of exception handlers, device
6070 drivers, set up the MMU, etc. - this means, that you cannot
6071 expect to re-enter U-Boot except by resetting the CPU.
6072 "RAMDisk Images" are more or less just data blocks, and their
6073 parameters (address, size) are passed to an OS kernel that is
6074 being started.
6075 "Multi-File Images" contain several images, typically an OS
6076 (Linux) kernel image and one or more data images like
6077 RAMDisks. This construct is useful for instance when you want
6078 to boot over the network using BOOTP etc., where the boot
6079 server provides just a single image file, but you want to get
6080 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006081
wdenk2729af92004-05-03 20:45:30 +00006082 "Multi-File Images" start with a list of image sizes, each
6083 image size (in bytes) specified by an "uint32_t" in network
6084 byte order. This list is terminated by an "(uint32_t)0".
6085 Immediately after the terminating 0 follow the images, one by
6086 one, all aligned on "uint32_t" boundaries (size rounded up to
6087 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006088
wdenk2729af92004-05-03 20:45:30 +00006089 "Firmware Images" are binary images containing firmware (like
6090 U-Boot or FPGA images) which usually will be programmed to
6091 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006092
wdenk2729af92004-05-03 20:45:30 +00006093 "Script files" are command sequences that will be executed by
6094 U-Boot's command interpreter; this feature is especially
6095 useful when you configure U-Boot to use a real shell (hush)
6096 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006097
Marek Vasut44f074c2012-03-14 21:52:45 +00006098Booting the Linux zImage:
6099-------------------------
6100
6101On some platforms, it's possible to boot Linux zImage. This is done
6102using the "bootz" command. The syntax of "bootz" command is the same
6103as the syntax of "bootm" command.
6104
Tom Rini8ac28562013-05-16 11:40:11 -04006105Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006106kernel with raw initrd images. The syntax is slightly different, the
6107address of the initrd must be augmented by it's size, in the following
6108format: "<initrd addres>:<initrd size>".
6109
wdenkc6097192002-11-03 00:24:07 +00006110
wdenk2729af92004-05-03 20:45:30 +00006111Standalone HOWTO:
6112=================
wdenkc6097192002-11-03 00:24:07 +00006113
wdenk2729af92004-05-03 20:45:30 +00006114One of the features of U-Boot is that you can dynamically load and
6115run "standalone" applications, which can use some resources of
6116U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006117
wdenk2729af92004-05-03 20:45:30 +00006118Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006119
wdenk2729af92004-05-03 20:45:30 +00006120"Hello World" Demo:
6121-------------------
wdenkc6097192002-11-03 00:24:07 +00006122
wdenk2729af92004-05-03 20:45:30 +00006123'examples/hello_world.c' contains a small "Hello World" Demo
6124application; it is automatically compiled when you build U-Boot.
6125It's configured to run at address 0x00040004, so you can play with it
6126like that:
wdenkc6097192002-11-03 00:24:07 +00006127
wdenk2729af92004-05-03 20:45:30 +00006128 => loads
6129 ## Ready for S-Record download ...
6130 ~>examples/hello_world.srec
6131 1 2 3 4 5 6 7 8 9 10 11 ...
6132 [file transfer complete]
6133 [connected]
6134 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006135
wdenk2729af92004-05-03 20:45:30 +00006136 => go 40004 Hello World! This is a test.
6137 ## Starting application at 0x00040004 ...
6138 Hello World
6139 argc = 7
6140 argv[0] = "40004"
6141 argv[1] = "Hello"
6142 argv[2] = "World!"
6143 argv[3] = "This"
6144 argv[4] = "is"
6145 argv[5] = "a"
6146 argv[6] = "test."
6147 argv[7] = "<NULL>"
6148 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006149
wdenk2729af92004-05-03 20:45:30 +00006150 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk2729af92004-05-03 20:45:30 +00006152Another example, which demonstrates how to register a CPM interrupt
6153handler with the U-Boot code, can be found in 'examples/timer.c'.
6154Here, a CPM timer is set up to generate an interrupt every second.
6155The interrupt service routine is trivial, just printing a '.'
6156character, but this is just a demo program. The application can be
6157controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk2729af92004-05-03 20:45:30 +00006159 ? - print current values og the CPM Timer registers
6160 b - enable interrupts and start timer
6161 e - stop timer and disable interrupts
6162 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006163
wdenk2729af92004-05-03 20:45:30 +00006164 => loads
6165 ## Ready for S-Record download ...
6166 ~>examples/timer.srec
6167 1 2 3 4 5 6 7 8 9 10 11 ...
6168 [file transfer complete]
6169 [connected]
6170 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006171
wdenk2729af92004-05-03 20:45:30 +00006172 => go 40004
6173 ## Starting application at 0x00040004 ...
6174 TIMERS=0xfff00980
6175 Using timer 1
6176 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006177
wdenk2729af92004-05-03 20:45:30 +00006178Hit 'b':
6179 [q, b, e, ?] Set interval 1000000 us
6180 Enabling timer
6181Hit '?':
6182 [q, b, e, ?] ........
6183 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6184Hit '?':
6185 [q, b, e, ?] .
6186 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6187Hit '?':
6188 [q, b, e, ?] .
6189 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6190Hit '?':
6191 [q, b, e, ?] .
6192 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6193Hit 'e':
6194 [q, b, e, ?] ...Stopping timer
6195Hit 'q':
6196 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006197
6198
wdenk2729af92004-05-03 20:45:30 +00006199Minicom warning:
6200================
wdenk85ec0bc2003-03-31 16:34:49 +00006201
wdenk2729af92004-05-03 20:45:30 +00006202Over time, many people have reported problems when trying to use the
6203"minicom" terminal emulation program for serial download. I (wd)
6204consider minicom to be broken, and recommend not to use it. Under
6205Unix, I recommend to use C-Kermit for general purpose use (and
6206especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006207use "cu" for S-Record download ("loads" command). See
6208http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6209for help with kermit.
6210
wdenk85ec0bc2003-03-31 16:34:49 +00006211
wdenk2729af92004-05-03 20:45:30 +00006212Nevertheless, if you absolutely want to use it try adding this
6213configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006214
wdenk2729af92004-05-03 20:45:30 +00006215 Name Program Name U/D FullScr IO-Red. Multi
6216 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6217 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006218
6219
wdenk2729af92004-05-03 20:45:30 +00006220NetBSD Notes:
6221=============
wdenkc6097192002-11-03 00:24:07 +00006222
wdenk2729af92004-05-03 20:45:30 +00006223Starting at version 0.9.2, U-Boot supports NetBSD both as host
6224(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006225
wdenk2729af92004-05-03 20:45:30 +00006226Building requires a cross environment; it is known to work on
6227NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6228need gmake since the Makefiles are not compatible with BSD make).
6229Note that the cross-powerpc package does not install include files;
6230attempting to build U-Boot will fail because <machine/ansi.h> is
6231missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006232
wdenk2729af92004-05-03 20:45:30 +00006233 # cd /usr/pkg/cross/powerpc-netbsd/include
6234 # mkdir powerpc
6235 # ln -s powerpc machine
6236 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6237 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk2729af92004-05-03 20:45:30 +00006239Native builds *don't* work due to incompatibilities between native
6240and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006241
wdenk2729af92004-05-03 20:45:30 +00006242Booting assumes that (the first part of) the image booted is a
6243stage-2 loader which in turn loads and then invokes the kernel
6244proper. Loader sources will eventually appear in the NetBSD source
6245tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006246meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006247
6248
wdenk2729af92004-05-03 20:45:30 +00006249Implementation Internals:
6250=========================
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk2729af92004-05-03 20:45:30 +00006252The following is not intended to be a complete description of every
6253implementation detail. However, it should help to understand the
6254inner workings of U-Boot and make it easier to port it to custom
6255hardware.
wdenkc6097192002-11-03 00:24:07 +00006256
6257
wdenk2729af92004-05-03 20:45:30 +00006258Initial Stack, Global Data:
6259---------------------------
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk2729af92004-05-03 20:45:30 +00006261The implementation of U-Boot is complicated by the fact that U-Boot
6262starts running out of ROM (flash memory), usually without access to
6263system RAM (because the memory controller is not initialized yet).
6264This means that we don't have writable Data or BSS segments, and BSS
6265is not initialized as zero. To be able to get a C environment working
6266at all, we have to allocate at least a minimal stack. Implementation
6267options for this are defined and restricted by the CPU used: Some CPU
6268models provide on-chip memory (like the IMMR area on MPC8xx and
6269MPC826x processors), on others (parts of) the data cache can be
6270locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006271
Wolfgang Denk218ca722008-03-26 10:40:12 +01006272 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006273 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006274
wdenk2729af92004-05-03 20:45:30 +00006275 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6276 From: "Chris Hallinan" <clh@net1plus.com>
6277 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6278 ...
wdenk43d96162003-03-06 00:02:04 +00006279
wdenk2729af92004-05-03 20:45:30 +00006280 Correct me if I'm wrong, folks, but the way I understand it
6281 is this: Using DCACHE as initial RAM for Stack, etc, does not
6282 require any physical RAM backing up the cache. The cleverness
6283 is that the cache is being used as a temporary supply of
6284 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006285 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006286 can see how this works by studying the cache architecture and
6287 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006288
wdenk2729af92004-05-03 20:45:30 +00006289 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6290 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006291 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006292 option should work for you. Using CS 4 should be fine if your
6293 board designers haven't used it for something that would
6294 cause you grief during the initial boot! It is frequently not
6295 used.
wdenk43d96162003-03-06 00:02:04 +00006296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006297 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006298 with your processor/board/system design. The default value
6299 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006300 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006301 than your SDRAM module. If you have a 64MB SDRAM module, set
6302 it above 400_0000. Just make sure your board has no resources
6303 that are supposed to respond to that address! That code in
6304 start.S has been around a while and should work as is when
6305 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006306
wdenk2729af92004-05-03 20:45:30 +00006307 -Chris Hallinan
6308 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006309
wdenk2729af92004-05-03 20:45:30 +00006310It is essential to remember this, since it has some impact on the C
6311code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006312
wdenk2729af92004-05-03 20:45:30 +00006313* Initialized global data (data segment) is read-only. Do not attempt
6314 to write it.
wdenkc6097192002-11-03 00:24:07 +00006315
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006316* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006317 as zero data - BSS segment) at all - this is undefined, initiali-
6318 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006319
wdenk2729af92004-05-03 20:45:30 +00006320* Stack space is very limited. Avoid big data buffers or things like
6321 that.
wdenkc6097192002-11-03 00:24:07 +00006322
wdenk2729af92004-05-03 20:45:30 +00006323Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006324normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006325turned out that the implementation of U-Boot can be greatly
6326simplified by making a global data structure (gd_t) available to all
6327functions. We could pass a pointer to this data as argument to _all_
6328functions, but this would bloat the code. Instead we use a feature of
6329the GCC compiler (Global Register Variables) to share the data: we
6330place a pointer (gd) to the global data into a register which we
6331reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006332
wdenk2729af92004-05-03 20:45:30 +00006333When choosing a register for such a purpose we are restricted by the
6334relevant (E)ABI specifications for the current architecture, and by
6335GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006336
wdenk2729af92004-05-03 20:45:30 +00006337For PowerPC, the following registers have specific use:
6338 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006339 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006340 R3-R4: parameter passing and return values
6341 R5-R10: parameter passing
6342 R13: small data area pointer
6343 R30: GOT pointer
6344 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006345
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006346 (U-Boot also uses R12 as internal GOT pointer. r12
6347 is a volatile register so r12 needs to be reset when
6348 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006349
Wolfgang Denke7670f62008-02-14 22:43:22 +01006350 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk2729af92004-05-03 20:45:30 +00006352 Note: on PPC, we could use a static initializer (since the
6353 address of the global data structure is known at compile time),
6354 but it turned out that reserving a register results in somewhat
6355 smaller code - although the code savings are not that big (on
6356 average for all boards 752 bytes for the whole U-Boot image,
6357 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006358
Robin Getzc4db3352009-08-17 15:23:02 +00006359On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006360 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6361
Robin Getzc4db3352009-08-17 15:23:02 +00006362 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006363
wdenk2729af92004-05-03 20:45:30 +00006364On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006365
wdenk2729af92004-05-03 20:45:30 +00006366 R0: function argument word/integer result
6367 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006368 R9: platform specific
6369 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006370 R11: argument (frame) pointer
6371 R12: temporary workspace
6372 R13: stack pointer
6373 R14: link register
6374 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006375
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006376 ==> U-Boot will use R9 to hold a pointer to the global data
6377
6378 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006379
Thomas Chou0df01fd2010-05-21 11:08:03 +08006380On Nios II, the ABI is documented here:
6381 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6382
6383 ==> U-Boot will use gp to hold a pointer to the global data
6384
6385 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6386 to access small data sections, so gp is free.
6387
Macpaul Linafc1ce82011-10-19 20:41:11 +00006388On NDS32, the following registers are used:
6389
6390 R0-R1: argument/return
6391 R2-R5: argument
6392 R15: temporary register for assembler
6393 R16: trampoline register
6394 R28: frame pointer (FP)
6395 R29: global pointer (GP)
6396 R30: link register (LP)
6397 R31: stack pointer (SP)
6398 PC: program counter (PC)
6399
6400 ==> U-Boot will use R10 to hold a pointer to the global data
6401
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006402NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6403or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006404
wdenk2729af92004-05-03 20:45:30 +00006405Memory Management:
6406------------------
wdenkc6097192002-11-03 00:24:07 +00006407
wdenk2729af92004-05-03 20:45:30 +00006408U-Boot runs in system state and uses physical addresses, i.e. the
6409MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk2729af92004-05-03 20:45:30 +00006411The available memory is mapped to fixed addresses using the memory
6412controller. In this process, a contiguous block is formed for each
6413memory type (Flash, SDRAM, SRAM), even when it consists of several
6414physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006415
wdenk2729af92004-05-03 20:45:30 +00006416U-Boot is installed in the first 128 kB of the first Flash bank (on
6417TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6418booting and sizing and initializing DRAM, the code relocates itself
6419to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006420memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006421configuration setting]. Below that, a structure with global Board
6422Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006423
wdenk2729af92004-05-03 20:45:30 +00006424Additionally, some exception handler code is copied to the low 8 kB
6425of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006426
wdenk2729af92004-05-03 20:45:30 +00006427So a typical memory configuration with 16 MB of DRAM could look like
6428this:
wdenkc6097192002-11-03 00:24:07 +00006429
wdenk2729af92004-05-03 20:45:30 +00006430 0x0000 0000 Exception Vector code
6431 :
6432 0x0000 1FFF
6433 0x0000 2000 Free for Application Use
6434 :
6435 :
wdenkc6097192002-11-03 00:24:07 +00006436
wdenk2729af92004-05-03 20:45:30 +00006437 :
6438 :
6439 0x00FB FF20 Monitor Stack (Growing downward)
6440 0x00FB FFAC Board Info Data and permanent copy of global data
6441 0x00FC 0000 Malloc Arena
6442 :
6443 0x00FD FFFF
6444 0x00FE 0000 RAM Copy of Monitor Code
6445 ... eventually: LCD or video framebuffer
6446 ... eventually: pRAM (Protected RAM - unchanged by reset)
6447 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006448
6449
wdenk2729af92004-05-03 20:45:30 +00006450System Initialization:
6451----------------------
wdenkc6097192002-11-03 00:24:07 +00006452
wdenk2729af92004-05-03 20:45:30 +00006453In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006454(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006455configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006456To be able to re-map memory U-Boot then jumps to its link address.
6457To be able to implement the initialization code in C, a (small!)
6458initial stack is set up in the internal Dual Ported RAM (in case CPUs
6459which provide such a feature like MPC8xx or MPC8260), or in a locked
6460part of the data cache. After that, U-Boot initializes the CPU core,
6461the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006462
wdenk2729af92004-05-03 20:45:30 +00006463Next, all (potentially) available memory banks are mapped using a
6464preliminary mapping. For example, we put them on 512 MB boundaries
6465(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6466on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6467programmed for SDRAM access. Using the temporary configuration, a
6468simple memory test is run that determines the size of the SDRAM
6469banks.
wdenkc6097192002-11-03 00:24:07 +00006470
wdenk2729af92004-05-03 20:45:30 +00006471When there is more than one SDRAM bank, and the banks are of
6472different size, the largest is mapped first. For equal size, the first
6473bank (CS2#) is mapped first. The first mapping is always for address
64740x00000000, with any additional banks following immediately to create
6475contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006476
wdenk2729af92004-05-03 20:45:30 +00006477Then, the monitor installs itself at the upper end of the SDRAM area
6478and allocates memory for use by malloc() and for the global Board
6479Info data; also, the exception vector code is copied to the low RAM
6480pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006481
wdenk2729af92004-05-03 20:45:30 +00006482Only after this relocation will you have a "normal" C environment;
6483until that you are restricted in several ways, mostly because you are
6484running from ROM, and because the code will have to be relocated to a
6485new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006486
6487
wdenk2729af92004-05-03 20:45:30 +00006488U-Boot Porting Guide:
6489----------------------
wdenkc6097192002-11-03 00:24:07 +00006490
wdenk2729af92004-05-03 20:45:30 +00006491[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6492list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006493
6494
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006495int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006496{
6497 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006498
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006499 signal(SIGALRM, no_more_time);
6500 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006501
wdenk2729af92004-05-03 20:45:30 +00006502 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006503 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006504 return 0;
6505 }
6506
wdenk2729af92004-05-03 20:45:30 +00006507 Download latest U-Boot source;
6508
Wolfgang Denk06682362008-12-30 22:56:11 +01006509 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006510
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006511 if (clueless)
6512 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006513
wdenk2729af92004-05-03 20:45:30 +00006514 while (learning) {
6515 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006516 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6517 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006518 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006519 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006520 }
wdenkc6097192002-11-03 00:24:07 +00006521
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006522 if (available_money > toLocalCurrency ($2500))
6523 Buy a BDI3000;
6524 else
wdenk2729af92004-05-03 20:45:30 +00006525 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006526
6527 if (a similar board exists) { /* hopefully... */
6528 cp -a board/<similar> board/<myboard>
6529 cp include/configs/<similar>.h include/configs/<myboard>.h
6530 } else {
6531 Create your own board support subdirectory;
6532 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006533 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006534 Edit new board/<myboard> files
6535 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006536
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006537 while (!accepted) {
6538 while (!running) {
6539 do {
6540 Add / modify source code;
6541 } until (compiles);
6542 Debug;
6543 if (clueless)
6544 email("Hi, I am having problems...");
6545 }
6546 Send patch file to the U-Boot email list;
6547 if (reasonable critiques)
6548 Incorporate improvements from email list code review;
6549 else
6550 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006551 }
wdenkc6097192002-11-03 00:24:07 +00006552
wdenk2729af92004-05-03 20:45:30 +00006553 return 0;
6554}
6555
6556void no_more_time (int sig)
6557{
6558 hire_a_guru();
6559}
wdenkc6097192002-11-03 00:24:07 +00006560
6561
wdenk2729af92004-05-03 20:45:30 +00006562Coding Standards:
6563-----------------
wdenkc6097192002-11-03 00:24:07 +00006564
wdenk2729af92004-05-03 20:45:30 +00006565All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006566coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006567"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006568
Detlev Zundel2c051652006-09-01 15:39:02 +02006569Source files originating from a different project (for example the
6570MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006571reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006572sources.
6573
6574Please note that U-Boot is implemented in C (and to some small parts in
6575Assembler); no C++ is used, so please do not use C++ style comments (//)
6576in your code.
wdenk2729af92004-05-03 20:45:30 +00006577
6578Please also stick to the following formatting rules:
6579- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006580- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006581- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006582- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006583- do not add trailing empty lines to source files
6584
6585Submissions which do not conform to the standards may be returned
6586with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006587
6588
wdenk2729af92004-05-03 20:45:30 +00006589Submitting Patches:
6590-------------------
wdenkc6097192002-11-03 00:24:07 +00006591
wdenk2729af92004-05-03 20:45:30 +00006592Since the number of patches for U-Boot is growing, we need to
6593establish some rules. Submissions which do not conform to these rules
6594may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006595
Magnus Lilja0d28f342008-08-06 19:32:33 +02006596Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006597
Wolfgang Denk06682362008-12-30 22:56:11 +01006598Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6599see http://lists.denx.de/mailman/listinfo/u-boot
6600
wdenk2729af92004-05-03 20:45:30 +00006601When you send a patch, please include the following information with
6602it:
wdenkc6097192002-11-03 00:24:07 +00006603
wdenk2729af92004-05-03 20:45:30 +00006604* For bug fixes: a description of the bug and how your patch fixes
6605 this bug. Please try to include a way of demonstrating that the
6606 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006607
wdenk2729af92004-05-03 20:45:30 +00006608* For new features: a description of the feature and your
6609 implementation.
wdenkc6097192002-11-03 00:24:07 +00006610
wdenk2729af92004-05-03 20:45:30 +00006611* A CHANGELOG entry as plaintext (separate from the patch)
6612
6613* For major contributions, your entry to the CREDITS file
6614
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006615* When you add support for a new board, don't forget to add a
6616 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006617
6618* If your patch adds new configuration options, don't forget to
6619 document these in the README file.
6620
Wolfgang Denk218ca722008-03-26 10:40:12 +01006621* The patch itself. If you are using git (which is *strongly*
6622 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006623 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006624 the U-Boot mailing list, you will avoid most of the common problems
6625 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006626
Wolfgang Denk218ca722008-03-26 10:40:12 +01006627 If you cannot use git, use "diff -purN OLD NEW". If your version of
6628 diff does not support these options, then get the latest version of
6629 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006630
Wolfgang Denk218ca722008-03-26 10:40:12 +01006631 The current directory when running this command shall be the parent
6632 directory of the U-Boot source tree (i. e. please make sure that
6633 your patch includes sufficient directory information for the
6634 affected files).
6635
6636 We prefer patches as plain text. MIME attachments are discouraged,
6637 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006638
6639* If one logical set of modifications affects or creates several
6640 files, all these changes shall be submitted in a SINGLE patch file.
6641
6642* Changesets that contain different, unrelated modifications shall be
6643 submitted as SEPARATE patches, one patch per changeset.
6644
6645
6646Notes:
6647
6648* Before sending the patch, run the MAKEALL script on your patched
6649 source tree and make sure that no errors or warnings are reported
6650 for any of the boards.
6651
6652* Keep your modifications to the necessary minimum: A patch
6653 containing several unrelated changes or arbitrary reformats will be
6654 returned with a request to re-formatting / split it.
6655
6656* If you modify existing code, make sure that your new code does not
6657 add to the memory footprint of the code ;-) Small is beautiful!
6658 When adding new features, these should compile conditionally only
6659 (using #ifdef), and the resulting code with the new feature
6660 disabled must not need more memory than the old code without your
6661 modification.
wdenk90dc6702005-05-03 14:12:25 +00006662
Wolfgang Denk06682362008-12-30 22:56:11 +01006663* Remember that there is a size limit of 100 kB per message on the
6664 u-boot mailing list. Bigger patches will be moderated. If they are
6665 reasonable and not too big, they will be acknowledged. But patches
6666 bigger than the size limit should be avoided.