blob: 32c5ea66531302af1d311d5fbc94e98abdfa17ee [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 Gargb7588e32014-04-02 08:55:02 -0500684 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100685 CONFIG_ARM_ERRATA_773022
686 CONFIG_ARM_ERRATA_774769
687 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-02-26 12:28:27 +0000688
689 If set, the workarounds for these ARM errata are applied early
690 during U-Boot startup. Note that these options force the
691 workarounds to be applied; no CPU-type/version detection
692 exists, unlike the similar options in the Linux kernel. Do not
693 set these options unless they apply!
694
York Sun207774b2015-03-20 19:28:08 -0700695 COUNTER_FREQUENCY
696 Generic timer clock source frequency.
697
698 COUNTER_FREQUENCY_REAL
699 Generic timer clock source frequency if the real clock is
700 different from COUNTER_FREQUENCY, and can only be determined
701 at run time.
702
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500703 NOTE: The following can be machine specific errata. These
704 do have ability to provide rudimentary version and machine
705 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500706 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500707 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500708 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500709 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500710 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500711
Stephen Warren73c38932015-01-19 16:25:52 -0700712- Tegra SoC options:
713 CONFIG_TEGRA_SUPPORT_NON_SECURE
714
715 Support executing U-Boot in non-secure (NS) mode. Certain
716 impossible actions will be skipped if the CPU is in NS mode,
717 such as ARM architectural timer initialization.
718
wdenk5da627a2003-10-09 20:09:04 +0000719- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000720 CONFIG_CLOCKS_IN_MHZ
721
722 U-Boot stores all clock information in Hz
723 internally. For binary compatibility with older Linux
724 kernels (which expect the clocks passed in the
725 bd_info data to be in MHz) the environment variable
726 "clocks_in_mhz" can be defined so that U-Boot
727 converts clock data to MHZ before passing it to the
728 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000729 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100730 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000731 default environment.
732
wdenk5da627a2003-10-09 20:09:04 +0000733 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
734
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800735 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000736 expect it to be in bytes, others in MB.
737 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
738
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400739 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200740
741 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400742 passed using flattened device trees (based on open firmware
743 concepts).
744
745 CONFIG_OF_LIBFDT
746 * New libfdt-based support
747 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500748 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400749
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200750 OF_CPU - The proper name of the cpus node (only required for
751 MPC512X and MPC5xxx based boards).
752 OF_SOC - The proper name of the soc node (only required for
753 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200754 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600755 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200756
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200757 boards with QUICC Engines require OF_QE to set UCC MAC
758 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500759
Kumar Gala4e253132006-01-11 13:54:17 -0600760 CONFIG_OF_BOARD_SETUP
761
762 Board code has addition modification that it wants to make
763 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000764
Simon Glassc654b512014-10-23 18:58:54 -0600765 CONFIG_OF_SYSTEM_SETUP
766
767 Other code has addition modification that it wants to make
768 to the flat device tree before handing it off to the kernel.
769 This causes ft_system_setup() to be called before booting
770 the kernel.
771
Matthew McClintock02677682006-06-28 10:41:37 -0500772 CONFIG_OF_BOOT_CPU
773
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200774 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500775 param header, the default value is zero if undefined.
776
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200777 CONFIG_OF_IDE_FIXUP
778
779 U-Boot can detect if an IDE device is present or not.
780 If not, and this new config option is activated, U-Boot
781 removes the ATA node from the DTS before booting Linux,
782 so the Linux IDE driver does not probe the device and
783 crash. This is needed for buggy hardware (uc101) where
784 no pull down resistor is connected to the signal IDE5V_DD7.
785
Igor Grinberg7eb29392011-07-14 05:45:07 +0000786 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
787
788 This setting is mandatory for all boards that have only one
789 machine type and must be used to specify the machine type
790 number as it appears in the ARM machine registry
791 (see http://www.arm.linux.org.uk/developer/machines/).
792 Only boards that have multiple machine types supported
793 in a single configuration file and the machine type is
794 runtime discoverable, do not have to use this setting.
795
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100796- vxWorks boot parameters:
797
798 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700799 environments variables: bootdev, bootfile, ipaddr, netmask,
800 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100801 It loads the vxWorks image pointed bootfile.
802
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100803 Note: If a "bootargs" environment is defined, it will overwride
804 the defaults discussed just above.
805
Aneesh V2c451f72011-06-16 23:30:47 +0000806- Cache Configuration:
807 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
808 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
809 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
810
Aneesh V93bc2192011-06-16 23:30:51 +0000811- Cache Configuration for ARM:
812 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
813 controller
814 CONFIG_SYS_PL310_BASE - Physical base address of PL310
815 controller register space
816
wdenk6705d812004-08-02 23:22:59 +0000817- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200818 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000819
820 Define this if you want support for Amba PrimeCell PL010 UARTs.
821
Andreas Engel48d01922008-09-08 14:30:53 +0200822 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000823
824 Define this if you want support for Amba PrimeCell PL011 UARTs.
825
826 CONFIG_PL011_CLOCK
827
828 If you have Amba PrimeCell PL011 UARTs, set this variable to
829 the clock speed of the UARTs.
830
831 CONFIG_PL01x_PORTS
832
833 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
834 define this to a list of base addresses for each (supported)
835 port. See e.g. include/configs/versatile.h
836
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400837 CONFIG_SERIAL_HW_FLOW_CONTROL
838
839 Define this variable to enable hw flow control in serial driver.
840 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000841
wdenkc6097192002-11-03 00:24:07 +0000842- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000843 Depending on board, define exactly one serial port
844 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
845 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
846 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000847
848 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
849 port routines must be defined elsewhere
850 (i.e. serial_init(), serial_getc(), ...)
851
852 CONFIG_CFB_CONSOLE
853 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000854 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000855 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
856 (default big endian)
857 VIDEO_HW_RECTFILL graphic chip supports
858 rectangle fill
859 (cf. smiLynxEM)
860 VIDEO_HW_BITBLT graphic chip supports
861 bit-blit (cf. smiLynxEM)
862 VIDEO_VISIBLE_COLS visible pixel columns
863 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000864 VIDEO_VISIBLE_ROWS visible pixel rows
865 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000866 VIDEO_DATA_FORMAT graphic data format
867 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000868 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000869 VIDEO_KBD_INIT_FCT keyboard int fct
870 (i.e. i8042_kbd_init())
871 VIDEO_TSTC_FCT test char fct
872 (i.e. i8042_tstc)
873 VIDEO_GETC_FCT get char fct
874 (i.e. i8042_getc)
875 CONFIG_CONSOLE_CURSOR cursor drawing on/off
876 (requires blink timer
877 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200878 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000879 CONFIG_CONSOLE_TIME display time/date info in
880 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000882 CONFIG_VIDEO_LOGO display Linux logo in
883 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000884 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
885 linux_logo.h for logo.
886 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000887 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200888 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000889 the logo
890
Pali Rohár33a35bb2012-10-19 13:30:09 +0000891 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
892 a limited number of ANSI escape sequences (cursor control,
893 erase functions and limited graphics rendition control).
894
wdenk43d96162003-03-06 00:02:04 +0000895 When CONFIG_CFB_CONSOLE is defined, video console is
896 default i/o. Serial console can be forced with
897 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000898
wdenkd4ca31c2004-01-02 14:00:00 +0000899 When CONFIG_SILENT_CONSOLE is defined, all console
900 messages (by U-Boot and Linux!) can be silenced with
901 the "silent" environment variable. See
902 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000903
Heiko Schocher45ae2542013-10-22 11:06:06 +0200904 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
905 is 0x00.
906 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
907 is 0xa0.
908
wdenkc6097192002-11-03 00:24:07 +0000909- Console Baudrate:
910 CONFIG_BAUDRATE - in bps
911 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200912 CONFIG_SYS_BAUDRATE_TABLE, see below.
913 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000914
Heiko Schocherc92fac92009-01-30 12:55:38 +0100915- Console Rx buffer length
916 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
917 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100918 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100919 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
920 must be defined, to setup the maximum idle timeout for
921 the SMC.
922
Graeme Russ9558b482011-09-01 00:48:27 +0000923- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200924 Prior to the console being initialised (i.e. serial UART
925 initialised etc) all console output is silently discarded.
926 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
927 buffer any console messages prior to the console being
928 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
929 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
930 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200931 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200932 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000933
Hans de Goedea8552c72015-05-05 13:13:36 +0200934 Note that when printing the buffer a copy is made on the
935 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
936
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200937 'Sane' compilers will generate smaller code if
938 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000939
Sonny Rao046a37b2011-11-02 09:52:08 +0000940- Safe printf() functions
941 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
942 the printf() functions. These are defined in
943 include/vsprintf.h and include snprintf(), vsnprintf() and
944 so on. Code size increase is approximately 300-500 bytes.
945 If this option is not given then these functions will
946 silently discard their buffer size argument - this means
947 you are not getting any overflow checking in this case.
948
wdenkc6097192002-11-03 00:24:07 +0000949- Boot Delay: CONFIG_BOOTDELAY - in seconds
950 Delay before automatically booting the default image;
951 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000952 set to -2 to autoboot with no delay and not check for abort
953 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000954
955 See doc/README.autoboot for these options that
956 work with CONFIG_BOOTDELAY. None are required.
957 CONFIG_BOOT_RETRY_TIME
958 CONFIG_BOOT_RETRY_MIN
959 CONFIG_AUTOBOOT_KEYED
960 CONFIG_AUTOBOOT_PROMPT
961 CONFIG_AUTOBOOT_DELAY_STR
962 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000963 CONFIG_ZERO_BOOTDELAY_CHECK
964 CONFIG_RESET_TO_RETRY
965
966- Autoboot Command:
967 CONFIG_BOOTCOMMAND
968 Only needed when CONFIG_BOOTDELAY is enabled;
969 define a command string that is automatically executed
970 when no character is read on the console interface
971 within "Boot Delay" after reset.
972
973 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000974 This can be used to pass arguments to the bootm
975 command. The value of CONFIG_BOOTARGS goes into the
976 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000977
978 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000979 The value of these goes into the environment as
980 "ramboot" and "nfsboot" respectively, and can be used
981 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200982 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000983
Heiko Schochereda0ba32013-11-04 14:04:59 +0100984- Bootcount:
985 CONFIG_BOOTCOUNT_LIMIT
986 Implements a mechanism for detecting a repeating reboot
987 cycle, see:
988 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
989
990 CONFIG_BOOTCOUNT_ENV
991 If no softreset save registers are found on the hardware
992 "bootcount" is stored in the environment. To prevent a
993 saveenv on all reboots, the environment variable
994 "upgrade_available" is used. If "upgrade_available" is
995 0, "bootcount" is always 0, if "upgrade_available" is
996 1 "bootcount" is incremented in the environment.
997 So the Userspace Applikation must set the "upgrade_available"
998 and "bootcount" variable to 0, if a boot was successfully.
999
wdenkc6097192002-11-03 00:24:07 +00001000- Pre-Boot Commands:
1001 CONFIG_PREBOOT
1002
1003 When this option is #defined, the existence of the
1004 environment variable "preboot" will be checked
1005 immediately before starting the CONFIG_BOOTDELAY
1006 countdown and/or running the auto-boot command resp.
1007 entering interactive mode.
1008
1009 This feature is especially useful when "preboot" is
1010 automatically generated or modified. For an example
1011 see the LWMON board specific code: here "preboot" is
1012 modified when the user holds down a certain
1013 combination of keys on the (special) keyboard when
1014 booting the systems
1015
1016- Serial Download Echo Mode:
1017 CONFIG_LOADS_ECHO
1018 If defined to 1, all characters received during a
1019 serial download (using the "loads" command) are
1020 echoed back. This might be needed by some terminal
1021 emulations (like "cu"), but may as well just take
1022 time on others. This setting #define's the initial
1023 value of the "loads_echo" environment variable.
1024
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001025- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001026 CONFIG_KGDB_BAUDRATE
1027 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001028 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001029
1030- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001031 Monitor commands can be included or excluded
1032 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001033 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -05001034 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001035
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001036 The default command configuration includes all commands
1037 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001038
Marek Vasutb401b732014-03-05 19:58:39 +01001039 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001040 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001041 CONFIG_CMD_BDI bdinfo
1042 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1043 CONFIG_CMD_BMP * BMP support
1044 CONFIG_CMD_BSP * Board specific commands
1045 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001046 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001047 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001048 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001049 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001050 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 CONFIG_CMD_DATE * support for RTC, date/time...
1052 CONFIG_CMD_DHCP * DHCP support
1053 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001054 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1055 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1056 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1057 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001058 CONFIG_CMD_DTT * Digital Therm and Thermostat
1059 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001060 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001061 CONFIG_CMD_EEPROM * EEPROM read/write support
1062 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001063 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001064 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001065 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001066 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001067 CONFIG_CMD_EXT2 * ext2 command support
1068 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001069 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1070 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001071 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001072 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001073 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001074 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001075 CONFIG_CMD_FLASH flinfo, erase, protect
1076 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001077 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001078 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001079 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001080 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001081 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001082 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1083 CONFIG_CMD_I2C * I2C serial bus support
1084 CONFIG_CMD_IDE * IDE harddisk support
1085 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001086 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001087 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001088 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001089 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001090 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001091 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001092 CONFIG_CMD_IRQ * irqinfo
1093 CONFIG_CMD_ITEST Integer/string test of 2 values
1094 CONFIG_CMD_JFFS2 * JFFS2 Support
1095 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001096 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001097 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1098 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001099 CONFIG_CMD_LOADB loadb
1100 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001101 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001102 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001103 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001104 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001105 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001106 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001107 CONFIG_CMD_MISC Misc functions like sleep etc
1108 CONFIG_CMD_MMC * MMC memory mapped support
1109 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001110 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001111 CONFIG_CMD_NAND * NAND support
1112 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001113 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001114 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001115 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001116 CONFIG_CMD_PCI * pciinfo
1117 CONFIG_CMD_PCMCIA * PCMCIA support
1118 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1119 host
1120 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001121 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001122 CONFIG_CMD_REGINFO * Register dump
1123 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001124 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001125 CONFIG_CMD_SAVES * save S record dump
1126 CONFIG_CMD_SCSI * SCSI Support
1127 CONFIG_CMD_SDRAM * print SDRAM configuration information
1128 (requires CONFIG_CMD_I2C)
1129 CONFIG_CMD_SETGETDCR Support for DCR Register access
1130 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001131 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001132 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001133 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001134 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001135 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001136 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001137 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001138 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001139 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1140 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001141 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001142 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001143 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001144 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001145 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001146
1147 EXAMPLE: If you want all functions except of network
1148 support you can write:
1149
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001150 #include "config_cmd_all.h"
1151 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001152
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001153 Other Commands:
1154 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001155
1156 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001157 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001158 what you (and your U-Boot users) are doing. Data
1159 cache cannot be enabled on systems like the 8xx or
1160 8260 (where accesses to the IMMR region must be
1161 uncached), and it cannot be disabled on all other
1162 systems where we (mis-) use the data cache to hold an
1163 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001164
1165
1166 XXX - this list needs to get updated!
1167
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001168- Regular expression support:
1169 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001170 If this variable is defined, U-Boot is linked against
1171 the SLRE (Super Light Regular Expression) library,
1172 which adds regex support to some commands, as for
1173 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001174
Simon Glass45ba8072011-10-15 05:48:20 +00001175- Device tree:
1176 CONFIG_OF_CONTROL
1177 If this variable is defined, U-Boot will use a device tree
1178 to configure its devices, instead of relying on statically
1179 compiled #defines in the board file. This option is
1180 experimental and only available on a few boards. The device
1181 tree is available in the global data as gd->fdt_blob.
1182
Simon Glass2c0f79e2011-10-24 19:15:31 +00001183 U-Boot needs to get its device tree from somewhere. This can
1184 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001185
1186 CONFIG_OF_EMBED
1187 If this variable is defined, U-Boot will embed a device tree
1188 binary in its image. This device tree file should be in the
1189 board directory and called <soc>-<board>.dts. The binary file
1190 is then picked up in board_init_f() and made available through
1191 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001192
Simon Glass2c0f79e2011-10-24 19:15:31 +00001193 CONFIG_OF_SEPARATE
1194 If this variable is defined, U-Boot will build a device tree
1195 binary. It will be called u-boot.dtb. Architecture-specific
1196 code will locate it at run-time. Generally this works by:
1197
1198 cat u-boot.bin u-boot.dtb >image.bin
1199
1200 and in fact, U-Boot does this for you, creating a file called
1201 u-boot-dtb.bin which is useful in the common case. You can
1202 still use the individual files if you need something more
1203 exotic.
1204
wdenkc6097192002-11-03 00:24:07 +00001205- Watchdog:
1206 CONFIG_WATCHDOG
1207 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001208 support for the SoC. There must be support in the SoC
1209 specific code for a watchdog. For the 8xx and 8260
1210 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1211 register. When supported for a specific SoC is
1212 available, then no further board specific code should
1213 be needed to use it.
1214
1215 CONFIG_HW_WATCHDOG
1216 When using a watchdog circuitry external to the used
1217 SoC, then define this variable and provide board
1218 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001219
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001220 CONFIG_AT91_HW_WDT_TIMEOUT
1221 specify the timeout in seconds. default 2 seconds.
1222
stroesec1551ea2003-04-04 15:53:41 +00001223- U-Boot Version:
1224 CONFIG_VERSION_VARIABLE
1225 If this variable is defined, an environment variable
1226 named "ver" is created by U-Boot showing the U-Boot
1227 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001228 Any change to this variable will be reverted at the
1229 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001230
wdenkc6097192002-11-03 00:24:07 +00001231- Real-Time Clock:
1232
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001233 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001234 has to be selected, too. Define exactly one of the
1235 following options:
1236
1237 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1238 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001239 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001240 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001241 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001242 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001243 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001244 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001245 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001246 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001247 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001248 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001249 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1250 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001251
wdenkb37c7e52003-06-30 16:24:52 +00001252 Note that if the RTC uses I2C, then the I2C interface
1253 must also be configured. See I2C Support, below.
1254
Peter Tysere92739d2008-12-17 16:36:21 -06001255- GPIO Support:
1256 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001257
Chris Packham5dec49c2010-12-19 10:12:13 +00001258 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1259 chip-ngpio pairs that tell the PCA953X driver the number of
1260 pins supported by a particular chip.
1261
Peter Tysere92739d2008-12-17 16:36:21 -06001262 Note that if the GPIO device uses I2C, then the I2C interface
1263 must also be configured. See I2C Support, below.
1264
Simon Glassaa532332014-06-11 23:29:41 -06001265- I/O tracing:
1266 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1267 accesses and can checksum them or write a list of them out
1268 to memory. See the 'iotrace' command for details. This is
1269 useful for testing device drivers since it can confirm that
1270 the driver behaves the same way before and after a code
1271 change. Currently this is supported on sandbox and arm. To
1272 add support for your architecture, add '#include <iotrace.h>'
1273 to the bottom of arch/<arch>/include/asm/io.h and test.
1274
1275 Example output from the 'iotrace stats' command is below.
1276 Note that if the trace buffer is exhausted, the checksum will
1277 still continue to operate.
1278
1279 iotrace is enabled
1280 Start: 10000000 (buffer start address)
1281 Size: 00010000 (buffer size)
1282 Offset: 00000120 (current buffer offset)
1283 Output: 10000120 (start + offset)
1284 Count: 00000018 (number of trace records)
1285 CRC32: 9526fb66 (CRC32 of all trace records)
1286
wdenkc6097192002-11-03 00:24:07 +00001287- Timestamp Support:
1288
wdenk43d96162003-03-06 00:02:04 +00001289 When CONFIG_TIMESTAMP is selected, the timestamp
1290 (date and time) of an image is printed by image
1291 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001292 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001293
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001294- Partition Labels (disklabels) Supported:
1295 Zero or more of the following:
1296 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1297 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1298 Intel architecture, USB sticks, etc.
1299 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1300 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1301 bootloader. Note 2TB partition limit; see
1302 disk/part_efi.c
1303 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001304
Wolfgang Denk218ca722008-03-26 10:40:12 +01001305 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1306 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001307 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001308
1309- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001310 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1311 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001312
wdenk4d13cba2004-03-14 14:09:05 +00001313 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1314 be performed by calling the function
1315 ide_set_reset(int reset)
1316 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001317
1318- ATAPI Support:
1319 CONFIG_ATAPI
1320
1321 Set this to enable ATAPI support.
1322
wdenkc40b2952004-03-13 23:29:43 +00001323- LBA48 Support
1324 CONFIG_LBA48
1325
1326 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001327 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001328 Whithout these , LBA48 support uses 32bit variables and will 'only'
1329 support disks up to 2.1TB.
1330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001331 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001332 When enabled, makes the IDE subsystem use 64bit sector addresses.
1333 Default is 32bit.
1334
wdenkc6097192002-11-03 00:24:07 +00001335- SCSI Support:
1336 At the moment only there is only support for the
1337 SYM53C8XX SCSI controller; define
1338 CONFIG_SCSI_SYM53C8XX to enable it.
1339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001340 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1341 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1342 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001343 maximum numbers of LUNs, SCSI ID's and target
1344 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001345 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001346
Wolfgang Denk93e14592013-10-04 17:43:24 +02001347 The environment variable 'scsidevs' is set to the number of
1348 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001349
wdenkc6097192002-11-03 00:24:07 +00001350- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001351 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001352 Support for Intel 8254x/8257x gigabit chips.
1353
1354 CONFIG_E1000_SPI
1355 Utility code for direct access to the SPI bus on Intel 8257x.
1356 This does not do anything useful unless you set at least one
1357 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1358
1359 CONFIG_E1000_SPI_GENERIC
1360 Allow generic access to the SPI bus on the Intel 8257x, for
1361 example with the "sspi" command.
1362
1363 CONFIG_CMD_E1000
1364 Management command for E1000 devices. When used on devices
1365 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001366
wdenkc6097192002-11-03 00:24:07 +00001367 CONFIG_EEPRO100
1368 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001369 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001370 write routine for first time initialisation.
1371
1372 CONFIG_TULIP
1373 Support for Digital 2114x chips.
1374 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1375 modem chip initialisation (KS8761/QS6611).
1376
1377 CONFIG_NATSEMI
1378 Support for National dp83815 chips.
1379
1380 CONFIG_NS8382X
1381 Support for National dp8382[01] gigabit chips.
1382
wdenk45219c42003-05-12 21:50:16 +00001383- NETWORK Support (other):
1384
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001385 CONFIG_DRIVER_AT91EMAC
1386 Support for AT91RM9200 EMAC.
1387
1388 CONFIG_RMII
1389 Define this to use reduced MII inteface
1390
1391 CONFIG_DRIVER_AT91EMAC_QUIET
1392 If this defined, the driver is quiet.
1393 The driver doen't show link status messages.
1394
Rob Herringefdd7312011-12-15 11:15:49 +00001395 CONFIG_CALXEDA_XGMAC
1396 Support for the Calxeda XGMAC device
1397
Ashok3bb46d22012-10-15 06:20:47 +00001398 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001399 Support for SMSC's LAN91C96 chips.
1400
1401 CONFIG_LAN91C96_BASE
1402 Define this to hold the physical address
1403 of the LAN91C96's I/O space
1404
1405 CONFIG_LAN91C96_USE_32_BIT
1406 Define this to enable 32 bit addressing
1407
Ashok3bb46d22012-10-15 06:20:47 +00001408 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001409 Support for SMSC's LAN91C111 chip
1410
1411 CONFIG_SMC91111_BASE
1412 Define this to hold the physical address
1413 of the device (I/O space)
1414
1415 CONFIG_SMC_USE_32_BIT
1416 Define this if data bus is 32 bits
1417
1418 CONFIG_SMC_USE_IOFUNCS
1419 Define this to use i/o functions instead of macros
1420 (some hardware wont work with macros)
1421
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001422 CONFIG_DRIVER_TI_EMAC
1423 Support for davinci emac
1424
1425 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1426 Define this if you have more then 3 PHYs.
1427
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001428 CONFIG_FTGMAC100
1429 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1430
1431 CONFIG_FTGMAC100_EGIGA
1432 Define this to use GE link update with gigabit PHY.
1433 Define this if FTGMAC100 is connected to gigabit PHY.
1434 If your system has 10/100 PHY only, it might not occur
1435 wrong behavior. Because PHY usually return timeout or
1436 useless data when polling gigabit status and gigabit
1437 control registers. This behavior won't affect the
1438 correctnessof 10/100 link speed update.
1439
Mike Rapoportc2fff332009-11-11 10:03:03 +02001440 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001441 Support for SMSC's LAN911x and LAN921x chips
1442
Mike Rapoportc2fff332009-11-11 10:03:03 +02001443 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001444 Define this to hold the physical address
1445 of the device (I/O space)
1446
Mike Rapoportc2fff332009-11-11 10:03:03 +02001447 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001448 Define this if data bus is 32 bits
1449
Mike Rapoportc2fff332009-11-11 10:03:03 +02001450 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001451 Define this if data bus is 16 bits. If your processor
1452 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001453 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001454
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001455 CONFIG_SH_ETHER
1456 Support for Renesas on-chip Ethernet controller
1457
1458 CONFIG_SH_ETHER_USE_PORT
1459 Define the number of ports to be used
1460
1461 CONFIG_SH_ETHER_PHY_ADDR
1462 Define the ETH PHY's address
1463
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001464 CONFIG_SH_ETHER_CACHE_WRITEBACK
1465 If this option is set, the driver enables cache flush.
1466
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001467- PWM Support:
1468 CONFIG_PWM_IMX
1469 Support for PWM modul on the imx6.
1470
Vadim Bendebury5e124722011-10-17 08:36:14 +00001471- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001472 CONFIG_TPM
1473 Support TPM devices.
1474
Christophe Ricard0766ad22015-10-06 22:54:41 +02001475 CONFIG_TPM_TIS_INFINEON
1476 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001477 per system is supported at this time.
1478
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001479 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1480 Define the burst count bytes upper limit
1481
Dirk Eibachc01939c2013-06-26 15:55:15 +02001482 CONFIG_TPM_ATMEL_TWI
1483 Support for Atmel TWI TPM device. Requires I2C support.
1484
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001485 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001486 Support for generic parallel port TPM devices. Only one device
1487 per system is supported at this time.
1488
1489 CONFIG_TPM_TIS_BASE_ADDRESS
1490 Base address where the generic TPM device is mapped
1491 to. Contemporary x86 systems usually map it at
1492 0xfed40000.
1493
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001494 CONFIG_CMD_TPM
1495 Add tpm monitor functions.
1496 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1497 provides monitor access to authorized functions.
1498
1499 CONFIG_TPM
1500 Define this to enable the TPM support library which provides
1501 functional interfaces to some TPM commands.
1502 Requires support for a TPM device.
1503
1504 CONFIG_TPM_AUTH_SESSIONS
1505 Define this to enable authorized functions in the TPM library.
1506 Requires CONFIG_TPM and CONFIG_SHA1.
1507
wdenkc6097192002-11-03 00:24:07 +00001508- USB Support:
1509 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001510 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001511 CONFIG_USB_UHCI to enable it.
1512 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001513 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001514 storage devices.
1515 Note:
1516 Supported are USB Keyboards and USB Floppy drives
1517 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001518 MPC5200 USB requires additional defines:
1519 CONFIG_USB_CLOCK
1520 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001521 CONFIG_PSC3_USB
1522 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001523 CONFIG_USB_CONFIG
1524 for differential drivers: 0x00001000
1525 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001526 for differential drivers on PSC3: 0x00000100
1527 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001528 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001529 May be defined to allow interrupt polling
1530 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001531
Simon Glass9ab4ce22012-02-27 10:52:47 +00001532 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1533 txfilltuning field in the EHCI controller on reset.
1534
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001535 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1536 HW module registers.
1537
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001538- USB Device:
1539 Define the below if you wish to use the USB console.
1540 Once firmware is rebuilt from a serial console issue the
1541 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001542 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001543 it has found a new device. The environment variable usbtty
1544 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001545 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001546 Common Device Class Abstract Control Model serial device.
1547 If you select usbtty = gserial you should be able to enumerate
1548 a Linux host by
1549 # modprobe usbserial vendor=0xVendorID product=0xProductID
1550 else if using cdc_acm, simply setting the environment
1551 variable usbtty to be cdc_acm should suffice. The following
1552 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001553
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001554 CONFIG_USB_DEVICE
1555 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001556
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001557 CONFIG_USB_TTY
1558 Define this to have a tty type of device available to
1559 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001560
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301561 CONFIG_USBD_HS
1562 Define this to enable the high speed support for usb
1563 device and usbtty. If this feature is enabled, a routine
1564 int is_usbd_high_speed(void)
1565 also needs to be defined by the driver to dynamically poll
1566 whether the enumeration has succeded at high speed or full
1567 speed.
1568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001569 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001570 Define this if you want stdin, stdout &/or stderr to
1571 be set to usbtty.
1572
1573 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001574 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001575 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001576 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001578 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001579 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001580 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001581
Wolfgang Denk386eda02006-06-14 18:14:56 +02001582 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001583 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001584 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001585 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1586 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1587 should pretend to be a Linux device to it's target host.
1588
1589 CONFIG_USBD_MANUFACTURER
1590 Define this string as the name of your company for
1591 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001592
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001593 CONFIG_USBD_PRODUCT_NAME
1594 Define this string as the name of your product
1595 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1596
1597 CONFIG_USBD_VENDORID
1598 Define this as your assigned Vendor ID from the USB
1599 Implementors Forum. This *must* be a genuine Vendor ID
1600 to avoid polluting the USB namespace.
1601 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001602
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001603 CONFIG_USBD_PRODUCTID
1604 Define this as the unique Product ID
1605 for your device
1606 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001607
Igor Grinbergd70a5602011-12-12 12:08:35 +02001608- ULPI Layer Support:
1609 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1610 the generic ULPI layer. The generic layer accesses the ULPI PHY
1611 via the platform viewport, so you need both the genric layer and
1612 the viewport enabled. Currently only Chipidea/ARC based
1613 viewport is supported.
1614 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1615 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001616 If your ULPI phy needs a different reference clock than the
1617 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1618 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001619
1620- MMC Support:
1621 The MMC controller on the Intel PXA is supported. To
1622 enable this define CONFIG_MMC. The MMC can be
1623 accessed from the boot prompt by mapping the device
1624 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001625 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1626 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001627
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001628 CONFIG_SH_MMCIF
1629 Support for Renesas on-chip MMCIF controller
1630
1631 CONFIG_SH_MMCIF_ADDR
1632 Define the base address of MMCIF registers
1633
1634 CONFIG_SH_MMCIF_CLK
1635 Define the clock frequency for MMCIF
1636
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001637 CONFIG_GENERIC_MMC
1638 Enable the generic MMC driver
1639
1640 CONFIG_SUPPORT_EMMC_BOOT
1641 Enable some additional features of the eMMC boot partitions.
1642
1643 CONFIG_SUPPORT_EMMC_RPMB
1644 Enable the commands for reading, writing and programming the
1645 key for the Replay Protection Memory Block partition in eMMC.
1646
Tom Rinib3ba6e92013-03-14 05:32:47 +00001647- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001648 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001649 This enables the USB portion of the DFU USB class
1650
1651 CONFIG_CMD_DFU
1652 This enables the command "dfu" which is used to have
1653 U-Boot create a DFU class device via USB. This command
1654 requires that the "dfu_alt_info" environment variable be
1655 set and define the alt settings to expose to the host.
1656
1657 CONFIG_DFU_MMC
1658 This enables support for exposing (e)MMC devices via DFU.
1659
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001660 CONFIG_DFU_NAND
1661 This enables support for exposing NAND devices via DFU.
1662
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301663 CONFIG_DFU_RAM
1664 This enables support for exposing RAM via DFU.
1665 Note: DFU spec refer to non-volatile memory usage, but
1666 allow usages beyond the scope of spec - here RAM usage,
1667 one that would help mostly the developer.
1668
Heiko Schochere7e75c72013-06-12 06:05:51 +02001669 CONFIG_SYS_DFU_DATA_BUF_SIZE
1670 Dfu transfer uses a buffer before writing data to the
1671 raw storage device. Make the size (in bytes) of this buffer
1672 configurable. The size of this buffer is also configurable
1673 through the "dfu_bufsiz" environment variable.
1674
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001675 CONFIG_SYS_DFU_MAX_FILE_SIZE
1676 When updating files rather than the raw storage device,
1677 we use a static buffer to copy the file into and then write
1678 the buffer once we've been given the whole file. Define
1679 this to the maximum filesize (in bytes) for the buffer.
1680 Default is 4 MiB if undefined.
1681
Heiko Schocher001a8312014-03-18 08:09:56 +01001682 DFU_DEFAULT_POLL_TIMEOUT
1683 Poll timeout [ms], is the timeout a device can send to the
1684 host. The host must wait for this timeout before sending
1685 a subsequent DFU_GET_STATUS request to the device.
1686
1687 DFU_MANIFEST_POLL_TIMEOUT
1688 Poll timeout [ms], which the device sends to the host when
1689 entering dfuMANIFEST state. Host waits this timeout, before
1690 sending again an USB request to the device.
1691
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001692- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001693 CONFIG_USB_FUNCTION_FASTBOOT
1694 This enables the USB part of the fastboot gadget
1695
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001696 CONFIG_CMD_FASTBOOT
1697 This enables the command "fastboot" which enables the Android
1698 fastboot mode for the platform's USB device. Fastboot is a USB
1699 protocol for downloading images, flashing and device control
1700 used on Android devices.
1701 See doc/README.android-fastboot for more information.
1702
1703 CONFIG_ANDROID_BOOT_IMAGE
1704 This enables support for booting images which use the Android
1705 image format header.
1706
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001707 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001708 The fastboot protocol requires a large memory buffer for
1709 downloads. Define this to the starting RAM address to use for
1710 downloaded images.
1711
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001712 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001713 The fastboot protocol requires a large memory buffer for
1714 downloads. This buffer should be as large as possible for a
1715 platform. Define this to the size available RAM for fastboot.
1716
Steve Raed1b5ed02014-08-26 11:47:28 -07001717 CONFIG_FASTBOOT_FLASH
1718 The fastboot protocol includes a "flash" command for writing
1719 the downloaded image to a non-volatile storage device. Define
1720 this to enable the "fastboot flash" command.
1721
1722 CONFIG_FASTBOOT_FLASH_MMC_DEV
1723 The fastboot "flash" command requires additional information
1724 regarding the non-volatile storage device. Define this to
1725 the eMMC device that fastboot should use to store the image.
1726
Steve Rae0ff7e582014-12-12 15:51:54 -08001727 CONFIG_FASTBOOT_GPT_NAME
1728 The fastboot "flash" command supports writing the downloaded
1729 image to the Protective MBR and the Primary GUID Partition
1730 Table. (Additionally, this downloaded image is post-processed
1731 to generate and write the Backup GUID Partition Table.)
1732 This occurs when the specified "partition name" on the
1733 "fastboot flash" command line matches this value.
1734 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1735
wdenk6705d812004-08-02 23:22:59 +00001736- Journaling Flash filesystem support:
1737 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1738 CONFIG_JFFS2_NAND_DEV
1739 Define these for a default partition on a NAND device
1740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001741 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1742 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001743 Define these for a default partition on a NOR device
1744
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001745 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001746 Define this to create an own partition. You have to provide a
1747 function struct part_info* jffs2_part_info(int part_num)
1748
1749 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001750 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001751 to disable the command chpart. This is the default when you
1752 have not defined a custom partition
1753
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001754- FAT(File Allocation Table) filesystem write function support:
1755 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001756
1757 Define this to enable support for saving memory data as a
1758 file in FAT formatted partition.
1759
1760 This will also enable the command "fatwrite" enabling the
1761 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001762
Gabe Black84cd9322012-10-12 14:26:11 +00001763CBFS (Coreboot Filesystem) support
1764 CONFIG_CMD_CBFS
1765
1766 Define this to enable support for reading from a Coreboot
1767 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1768 and cbfsload.
1769
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301770- FAT(File Allocation Table) filesystem cluster size:
1771 CONFIG_FS_FAT_MAX_CLUSTSIZE
1772
1773 Define the max cluster size for fat operations else
1774 a default value of 65536 will be defined.
1775
wdenkc6097192002-11-03 00:24:07 +00001776- Keyboard Support:
1777 CONFIG_ISA_KEYBOARD
1778
1779 Define this to enable standard (PC-Style) keyboard
1780 support
1781
1782 CONFIG_I8042_KBD
1783 Standard PC keyboard driver with US (is default) and
1784 GERMAN key layout (switch via environment 'keymap=de') support.
1785 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1786 for cfb_console. Supports cursor blinking.
1787
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001788 CONFIG_CROS_EC_KEYB
1789 Enables a Chrome OS keyboard using the CROS_EC interface.
1790 This uses CROS_EC to communicate with a second microcontroller
1791 which provides key scans on request.
1792
wdenkc6097192002-11-03 00:24:07 +00001793- Video support:
1794 CONFIG_VIDEO
1795
1796 Define this to enable video support (for output to
1797 video).
1798
1799 CONFIG_VIDEO_CT69000
1800
1801 Enable Chips & Technologies 69000 Video chip
1802
1803 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001804 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001805 video output is selected via environment 'videoout'
1806 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1807 assumed.
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkb79a11c2004-03-25 15:14:43 +00001809 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001810 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001811 are possible:
1812 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001813 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001814
1815 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1816 -------------+---------------------------------------------
1817 8 bits | 0x301* 0x303 0x305 0x161 0x307
1818 15 bits | 0x310 0x313 0x316 0x162 0x319
1819 16 bits | 0x311 0x314 0x317 0x163 0x31A
1820 24 bits | 0x312 0x315 0x318 ? 0x31B
1821 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001822 (i.e. setenv videomode 317; saveenv; reset;)
1823
wdenkb79a11c2004-03-25 15:14:43 +00001824 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001825 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001826
1827
stroesec1551ea2003-04-04 15:53:41 +00001828 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001829 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001830 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1831 or CONFIG_VIDEO_SED13806_16BPP
1832
Timur Tabi7d3053f2011-02-15 17:09:19 -06001833 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001834 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001835 SOCs that have a DIU should define this macro to enable DIU
1836 support, and should also define these other macros:
1837
1838 CONFIG_SYS_DIU_ADDR
1839 CONFIG_VIDEO
1840 CONFIG_CMD_BMP
1841 CONFIG_CFB_CONSOLE
1842 CONFIG_VIDEO_SW_CURSOR
1843 CONFIG_VGA_AS_SINGLE_DEVICE
1844 CONFIG_VIDEO_LOGO
1845 CONFIG_VIDEO_BMP_LOGO
1846
Timur Tabiba8e76b2011-04-11 14:18:22 -05001847 The DIU driver will look for the 'video-mode' environment
1848 variable, and if defined, enable the DIU as a console during
1849 boot. See the documentation file README.video for a
1850 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001851
Simon Glass058d59b2012-12-03 13:59:47 +00001852
wdenk682011f2003-06-03 23:54:09 +00001853- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001854 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001855
wdenk8bde7f72003-06-27 21:31:46 +00001856 Define this to enable a custom keyboard support.
1857 This simply calls drv_keyboard_init() which must be
1858 defined in your board-specific files.
1859 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001860
wdenkc6097192002-11-03 00:24:07 +00001861- LCD Support: CONFIG_LCD
1862
1863 Define this to enable LCD support (for output to LCD
1864 display); also select one of the supported displays
1865 by defining one of these:
1866
Stelian Pop39cf4802008-05-09 21:57:18 +02001867 CONFIG_ATMEL_LCD:
1868
1869 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1870
wdenkfd3103b2003-11-25 16:55:19 +00001871 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001872
wdenkfd3103b2003-11-25 16:55:19 +00001873 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001874
wdenkfd3103b2003-11-25 16:55:19 +00001875 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001876
wdenkfd3103b2003-11-25 16:55:19 +00001877 NEC NL6448BC20-08. 6.5", 640x480.
1878 Active, color, single scan.
1879
1880 CONFIG_NEC_NL6448BC33_54
1881
1882 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001883 Active, color, single scan.
1884
1885 CONFIG_SHARP_16x9
1886
1887 Sharp 320x240. Active, color, single scan.
1888 It isn't 16x9, and I am not sure what it is.
1889
1890 CONFIG_SHARP_LQ64D341
1891
1892 Sharp LQ64D341 display, 640x480.
1893 Active, color, single scan.
1894
1895 CONFIG_HLD1045
1896
1897 HLD1045 display, 640x480.
1898 Active, color, single scan.
1899
1900 CONFIG_OPTREX_BW
1901
1902 Optrex CBL50840-2 NF-FW 99 22 M5
1903 or
1904 Hitachi LMG6912RPFC-00T
1905 or
1906 Hitachi SP14Q002
1907
1908 320x240. Black & white.
1909
1910 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001911 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001912
Simon Glass676d3192012-10-17 13:24:54 +00001913 CONFIG_LCD_ALIGNMENT
1914
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001915 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001916 defined then the LCD will be aligned to this value instead.
1917 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1918 here, since it is cheaper to change data cache settings on
1919 a per-section basis.
1920
Simon Glass0d89efe2012-10-17 13:24:59 +00001921 CONFIG_CONSOLE_SCROLL_LINES
1922
1923 When the console need to be scrolled, this is the number of
1924 lines to scroll by. It defaults to 1. Increasing this makes
1925 the console jump but can help speed up operation when scrolling
1926 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001927
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001928 CONFIG_LCD_ROTATION
1929
1930 Sometimes, for example if the display is mounted in portrait
1931 mode or even if it's mounted landscape but rotated by 180degree,
1932 we need to rotate our content of the display relative to the
1933 framebuffer, so that user can read the messages which are
1934 printed out.
1935 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1936 initialized with a given rotation from "vl_rot" out of
1937 "vidinfo_t" which is provided by the board specific code.
1938 The value for vl_rot is coded as following (matching to
1939 fbcon=rotate:<n> linux-kernel commandline):
1940 0 = no rotation respectively 0 degree
1941 1 = 90 degree rotation
1942 2 = 180 degree rotation
1943 3 = 270 degree rotation
1944
1945 If CONFIG_LCD_ROTATION is not defined, the console will be
1946 initialized with 0degree rotation.
1947
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001948 CONFIG_LCD_BMP_RLE8
1949
1950 Support drawing of RLE8-compressed bitmaps on the LCD.
1951
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001952 CONFIG_I2C_EDID
1953
1954 Enables an 'i2c edid' command which can read EDID
1955 information over I2C from an attached LCD display.
1956
wdenk7152b1d2003-09-05 23:19:14 +00001957- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001958
wdenk8bde7f72003-06-27 21:31:46 +00001959 If this option is set, the environment is checked for
1960 a variable "splashimage". If found, the usual display
1961 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001962 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001963 specified in "splashimage" is loaded instead. The
1964 console is redirected to the "nulldev", too. This
1965 allows for a "silent" boot where a splash screen is
1966 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001967
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001968 CONFIG_SPLASHIMAGE_GUARD
1969
1970 If this option is set, then U-Boot will prevent the environment
1971 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001972 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001973 This option is useful for targets where, due to alignment
1974 restrictions, an improperly aligned BMP image will cause a data
1975 abort. If you think you will not have problems with unaligned
1976 accesses (for example because your toolchain prevents them)
1977 there is no need to set this option.
1978
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001979 CONFIG_SPLASH_SCREEN_ALIGN
1980
1981 If this option is set the splash image can be freely positioned
1982 on the screen. Environment variable "splashpos" specifies the
1983 position as "x,y". If a positive number is given it is used as
1984 number of pixel from left/top. If a negative number is given it
1985 is used as number of pixel from right/bottom. You can also
1986 specify 'm' for centering the image.
1987
1988 Example:
1989 setenv splashpos m,m
1990 => image at center of screen
1991
1992 setenv splashpos 30,20
1993 => image at x = 30 and y = 20
1994
1995 setenv splashpos -10,m
1996 => vertically centered image
1997 at x = dspWidth - bmpWidth - 9
1998
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001999- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2000
2001 If this option is set, additionally to standard BMP
2002 images, gzipped BMP images can be displayed via the
2003 splashscreen support or the bmp command.
2004
Anatolij Gustschind5011762010-03-15 14:50:25 +01002005- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2006
2007 If this option is set, 8-bit RLE compressed BMP images
2008 can be displayed via the splashscreen support or the
2009 bmp command.
2010
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002011- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002012 CONFIG_CMD_ZIP
2013
2014 If this option is set, it would use zlib deflate method
2015 to compress the specified memory at its best effort.
2016
wdenkc29fdfc2003-08-29 20:57:53 +00002017- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002018 CONFIG_GZIP
2019
2020 Enabled by default to support gzip compressed images.
2021
wdenkc29fdfc2003-08-29 20:57:53 +00002022 CONFIG_BZIP2
2023
2024 If this option is set, support for bzip2 compressed
2025 images is included. If not, only uncompressed and gzip
2026 compressed images are supported.
2027
wdenk42d1f032003-10-15 23:53:47 +00002028 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002029 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002030 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002031
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002032 CONFIG_LZMA
2033
2034 If this option is set, support for lzma compressed
2035 images is included.
2036
2037 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2038 requires an amount of dynamic memory that is given by the
2039 formula:
2040
2041 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2042
2043 Where lc and lp stand for, respectively, Literal context bits
2044 and Literal pos bits.
2045
2046 This value is upper-bounded by 14MB in the worst case. Anyway,
2047 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2048 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2049 a very small buffer.
2050
2051 Use the lzmainfo tool to determinate the lc and lp values and
2052 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002053 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002054
Kees Cook8ef70472013-08-16 07:59:12 -07002055 CONFIG_LZO
2056
2057 If this option is set, support for LZO compressed images
2058 is included.
2059
wdenk17ea1172004-06-06 21:51:03 +00002060- MII/PHY support:
2061 CONFIG_PHY_ADDR
2062
2063 The address of PHY on MII bus.
2064
2065 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2066
2067 The clock frequency of the MII bus
2068
2069 CONFIG_PHY_GIGE
2070
2071 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002072 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002073
2074 CONFIG_PHY_RESET_DELAY
2075
2076 Some PHY like Intel LXT971A need extra delay after
2077 reset before any MII register access is possible.
2078 For such PHY, set this option to the usec delay
2079 required. (minimum 300usec for LXT971A)
2080
2081 CONFIG_PHY_CMD_DELAY (ppc4xx)
2082
2083 Some PHY like Intel LXT971A need extra delay after
2084 command issued before MII status register can be read
2085
wdenkc6097192002-11-03 00:24:07 +00002086- IP address:
2087 CONFIG_IPADDR
2088
2089 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002090 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002091 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002092 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002093
2094- Server IP address:
2095 CONFIG_SERVERIP
2096
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002098 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002099 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002100
Robin Getz97cfe862009-07-21 12:15:28 -04002101 CONFIG_KEEP_SERVERADDR
2102
2103 Keeps the server's MAC address, in the env 'serveraddr'
2104 for passing to bootargs (like Linux's netconsole option)
2105
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002106- Gateway IP address:
2107 CONFIG_GATEWAYIP
2108
2109 Defines a default value for the IP address of the
2110 default router where packets to other networks are
2111 sent to.
2112 (Environment variable "gatewayip")
2113
2114- Subnet mask:
2115 CONFIG_NETMASK
2116
2117 Defines a default value for the subnet mask (or
2118 routing prefix) which is used to determine if an IP
2119 address belongs to the local subnet or needs to be
2120 forwarded through a router.
2121 (Environment variable "netmask")
2122
David Updegraff53a5c422007-06-11 10:41:07 -05002123- Multicast TFTP Mode:
2124 CONFIG_MCAST_TFTP
2125
2126 Defines whether you want to support multicast TFTP as per
2127 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002128 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002129 driver in use must provide a function: mcast() to join/leave a
2130 multicast group.
2131
wdenkc6097192002-11-03 00:24:07 +00002132- BOOTP Recovery Mode:
2133 CONFIG_BOOTP_RANDOM_DELAY
2134
2135 If you have many targets in a network that try to
2136 boot using BOOTP, you may want to avoid that all
2137 systems send out BOOTP requests at precisely the same
2138 moment (which would happen for instance at recovery
2139 from a power failure, when all systems will try to
2140 boot, thus flooding the BOOTP server. Defining
2141 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2142 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002143 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002144
2145 1st BOOTP request: delay 0 ... 1 sec
2146 2nd BOOTP request: delay 0 ... 2 sec
2147 3rd BOOTP request: delay 0 ... 4 sec
2148 4th and following
2149 BOOTP requests: delay 0 ... 8 sec
2150
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002151 CONFIG_BOOTP_ID_CACHE_SIZE
2152
2153 BOOTP packets are uniquely identified using a 32-bit ID. The
2154 server will copy the ID from client requests to responses and
2155 U-Boot will use this to determine if it is the destination of
2156 an incoming response. Some servers will check that addresses
2157 aren't in use before handing them out (usually using an ARP
2158 ping) and therefore take up to a few hundred milliseconds to
2159 respond. Network congestion may also influence the time it
2160 takes for a response to make it back to the client. If that
2161 time is too long, U-Boot will retransmit requests. In order
2162 to allow earlier responses to still be accepted after these
2163 retransmissions, U-Boot's BOOTP client keeps a small cache of
2164 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2165 cache. The default is to keep IDs for up to four outstanding
2166 requests. Increasing this will allow U-Boot to accept offers
2167 from a BOOTP client in networks with unusually high latency.
2168
stroesefe389a82003-08-28 14:17:32 +00002169- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002170 You can fine tune the DHCP functionality by defining
2171 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002172
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002173 CONFIG_BOOTP_SUBNETMASK
2174 CONFIG_BOOTP_GATEWAY
2175 CONFIG_BOOTP_HOSTNAME
2176 CONFIG_BOOTP_NISDOMAIN
2177 CONFIG_BOOTP_BOOTPATH
2178 CONFIG_BOOTP_BOOTFILESIZE
2179 CONFIG_BOOTP_DNS
2180 CONFIG_BOOTP_DNS2
2181 CONFIG_BOOTP_SEND_HOSTNAME
2182 CONFIG_BOOTP_NTPSERVER
2183 CONFIG_BOOTP_TIMEOFFSET
2184 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002185 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002186
Wilson Callan5d110f02007-07-28 10:56:13 -04002187 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2188 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002189
Joe Hershberger2c00e092012-05-23 07:59:19 +00002190 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2191 after the configured retry count, the call will fail
2192 instead of starting over. This can be used to fail over
2193 to Link-local IP address configuration if the DHCP server
2194 is not available.
2195
stroesefe389a82003-08-28 14:17:32 +00002196 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2197 serverip from a DHCP server, it is possible that more
2198 than one DNS serverip is offered to the client.
2199 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2200 serverip will be stored in the additional environment
2201 variable "dnsip2". The first DNS serverip is always
2202 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002203 is defined.
stroesefe389a82003-08-28 14:17:32 +00002204
2205 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2206 to do a dynamic update of a DNS server. To do this, they
2207 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002208 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002209 of the "hostname" environment variable is passed as
2210 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002211
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002212 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2213
2214 A 32bit value in microseconds for a delay between
2215 receiving a "DHCP Offer" and sending the "DHCP Request".
2216 This fixes a problem with certain DHCP servers that don't
2217 respond 100% of the time to a "DHCP request". E.g. On an
2218 AT91RM9200 processor running at 180MHz, this delay needed
2219 to be *at least* 15,000 usec before a Windows Server 2003
2220 DHCP server would reply 100% of the time. I recommend at
2221 least 50,000 usec to be safe. The alternative is to hope
2222 that one of the retries will be successful but note that
2223 the DHCP timeout and retry process takes a longer than
2224 this delay.
2225
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002226 - Link-local IP address negotiation:
2227 Negotiate with other link-local clients on the local network
2228 for an address that doesn't require explicit configuration.
2229 This is especially useful if a DHCP server cannot be guaranteed
2230 to exist in all environments that the device must operate.
2231
2232 See doc/README.link-local for more information.
2233
wdenka3d991b2004-04-15 21:48:45 +00002234 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002235 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002236
2237 The device id used in CDP trigger frames.
2238
2239 CONFIG_CDP_DEVICE_ID_PREFIX
2240
2241 A two character string which is prefixed to the MAC address
2242 of the device.
2243
2244 CONFIG_CDP_PORT_ID
2245
2246 A printf format string which contains the ascii name of
2247 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002248 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002249
2250 CONFIG_CDP_CAPABILITIES
2251
2252 A 32bit integer which indicates the device capabilities;
2253 0x00000010 for a normal host which does not forwards.
2254
2255 CONFIG_CDP_VERSION
2256
2257 An ascii string containing the version of the software.
2258
2259 CONFIG_CDP_PLATFORM
2260
2261 An ascii string containing the name of the platform.
2262
2263 CONFIG_CDP_TRIGGER
2264
2265 A 32bit integer sent on the trigger.
2266
2267 CONFIG_CDP_POWER_CONSUMPTION
2268
2269 A 16bit integer containing the power consumption of the
2270 device in .1 of milliwatts.
2271
2272 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2273
2274 A byte containing the id of the VLAN.
2275
wdenkc6097192002-11-03 00:24:07 +00002276- Status LED: CONFIG_STATUS_LED
2277
2278 Several configurations allow to display the current
2279 status using a LED. For instance, the LED will blink
2280 fast while running U-Boot code, stop blinking as
2281 soon as a reply to a BOOTP request was received, and
2282 start blinking slow once the Linux kernel is running
2283 (supported by a status LED driver in the Linux
2284 kernel). Defining CONFIG_STATUS_LED enables this
2285 feature in U-Boot.
2286
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002287 Additional options:
2288
2289 CONFIG_GPIO_LED
2290 The status LED can be connected to a GPIO pin.
2291 In such cases, the gpio_led driver can be used as a
2292 status LED backend implementation. Define CONFIG_GPIO_LED
2293 to include the gpio_led driver in the U-Boot binary.
2294
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002295 CONFIG_GPIO_LED_INVERTED_TABLE
2296 Some GPIO connected LEDs may have inverted polarity in which
2297 case the GPIO high value corresponds to LED off state and
2298 GPIO low value corresponds to LED on state.
2299 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2300 with a list of GPIO LEDs that have inverted polarity.
2301
wdenkc6097192002-11-03 00:24:07 +00002302- CAN Support: CONFIG_CAN_DRIVER
2303
2304 Defining CONFIG_CAN_DRIVER enables CAN driver support
2305 on those systems that support this (optional)
2306 feature, like the TQM8xxL modules.
2307
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002308- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002309
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002310 This enable the NEW i2c subsystem, and will allow you to use
2311 i2c commands at the u-boot command line (as long as you set
2312 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2313 based realtime clock chips or other i2c devices. See
2314 common/cmd_i2c.c for a description of the command line
2315 interface.
2316
2317 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002318 - drivers/i2c/soft_i2c.c:
2319 - activate first bus with CONFIG_SYS_I2C_SOFT define
2320 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2321 for defining speed and slave address
2322 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2323 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2324 for defining speed and slave address
2325 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2326 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2327 for defining speed and slave address
2328 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2329 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2330 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002331
Heiko Schocher00f792e2012-10-24 13:48:22 +02002332 - drivers/i2c/fsl_i2c.c:
2333 - activate i2c driver with CONFIG_SYS_I2C_FSL
2334 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2335 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2336 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2337 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002338 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002339 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2340 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2341 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2342 second bus.
2343
Simon Glass1f2ba722012-10-30 07:28:53 +00002344 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002345 - activate this driver with CONFIG_SYS_I2C_TEGRA
2346 - This driver adds 4 i2c buses with a fix speed from
2347 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002348
Dirk Eibach880540d2013-04-25 02:40:01 +00002349 - drivers/i2c/ppc4xx_i2c.c
2350 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2351 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2352 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2353
tremfac96402013-09-21 18:13:35 +02002354 - drivers/i2c/i2c_mxc.c
2355 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002356 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2357 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2358 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2359 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002360 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2361 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2362 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2363 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2364 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2365 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002366 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2367 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002368 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002369 for speed, and 0 for slave.
2370
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002371 - drivers/i2c/rcar_i2c.c:
2372 - activate this driver with CONFIG_SYS_I2C_RCAR
2373 - This driver adds 4 i2c buses
2374
2375 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2376 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2377 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2378 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2379 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2380 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2381 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2382 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2383 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2384
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002385 - drivers/i2c/sh_i2c.c:
2386 - activate this driver with CONFIG_SYS_I2C_SH
2387 - This driver adds from 2 to 5 i2c buses
2388
2389 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2390 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2391 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2392 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2393 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2394 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2395 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2396 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2397 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2398 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2399 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2400 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002401 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002402
Heiko Schocher6789e842013-10-22 11:03:18 +02002403 - drivers/i2c/omap24xx_i2c.c
2404 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2405 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2406 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2407 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2408 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2409 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2410 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2411 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2412 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2413 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2414 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2415
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002416 - drivers/i2c/zynq_i2c.c
2417 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2418 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2419 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2420
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302421 - drivers/i2c/s3c24x0_i2c.c:
2422 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2423 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2424 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2425 with a fix speed from 100000 and the slave addr 0!
2426
Dirk Eibachb46226b2014-07-03 09:28:18 +02002427 - drivers/i2c/ihs_i2c.c
2428 - activate this driver with CONFIG_SYS_I2C_IHS
2429 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2430 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2431 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2432 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2433 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2434 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2435 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2436 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2437 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2438 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2439 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2440 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002441 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2442 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2443 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2444 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2445 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2446 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2447 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2448 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2449 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002450
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002451 additional defines:
2452
2453 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002454 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002455 don't use/have i2c muxes on your i2c bus, this
2456 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2457 omit this define.
2458
2459 CONFIG_SYS_I2C_DIRECT_BUS
2460 define this, if you don't use i2c muxes on your hardware.
2461 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2462 omit this define.
2463
2464 CONFIG_SYS_I2C_MAX_HOPS
2465 define how many muxes are maximal consecutively connected
2466 on one i2c bus. If you not use i2c muxes, omit this
2467 define.
2468
2469 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002470 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002471 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2472 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2473 CONFIG_SYS_NUM_I2C_BUSES = 9:
2474
2475 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2476 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2477 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2478 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2479 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2480 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2481 {1, {I2C_NULL_HOP}}, \
2482 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2483 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2484 }
2485
2486 which defines
2487 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002488 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2489 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2490 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2491 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2492 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002493 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002494 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2495 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002496
2497 If you do not have i2c muxes on your board, omit this define.
2498
Heiko Schocherea818db2013-01-29 08:53:15 +01002499- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002500
2501 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2502 provides the following compelling advantages:
2503
2504 - more than one i2c adapter is usable
2505 - approved multibus support
2506 - better i2c mux support
2507
2508 ** Please consider updating your I2C driver now. **
2509
Heiko Schocherea818db2013-01-29 08:53:15 +01002510 These enable legacy I2C serial bus commands. Defining
2511 CONFIG_HARD_I2C will include the appropriate I2C driver
2512 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002513
wdenk945af8d2003-07-16 21:53:01 +00002514 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002515 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002516 CONFIG_COMMANDS) and communicate with i2c based realtime
2517 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002518 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002519
Ben Warrenbb99ad62006-09-07 16:50:54 -04002520 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002521
wdenk945af8d2003-07-16 21:53:01 +00002522 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002523 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002525 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002526 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002528 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002529
Peter Tyser8d321b82010-04-12 22:28:21 -05002530 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002531 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002532 and so its address should therefore be cleared to 0 (See,
2533 eg, MPC823e User's Manual p.16-473). So, set
2534 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002535
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002536 CONFIG_SYS_I2C_INIT_MPC5XXX
2537
2538 When a board is reset during an i2c bus transfer
2539 chips might think that the current transfer is still
2540 in progress. Reset the slave devices by sending start
2541 commands until the slave device responds.
2542
wdenk945af8d2003-07-16 21:53:01 +00002543 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002544
Heiko Schocherea818db2013-01-29 08:53:15 +01002545 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002546 then the following macros need to be defined (examples are
2547 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002548
2549 I2C_INIT
2550
wdenkb37c7e52003-06-30 16:24:52 +00002551 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002552 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002553
wdenkba56f622004-02-06 23:19:44 +00002554 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002555
wdenkc6097192002-11-03 00:24:07 +00002556 I2C_PORT
2557
wdenk43d96162003-03-06 00:02:04 +00002558 (Only for MPC8260 CPU). The I/O port to use (the code
2559 assumes both bits are on the same port). Valid values
2560 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002561
2562 I2C_ACTIVE
2563
2564 The code necessary to make the I2C data line active
2565 (driven). If the data line is open collector, this
2566 define can be null.
2567
wdenkb37c7e52003-06-30 16:24:52 +00002568 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2569
wdenkc6097192002-11-03 00:24:07 +00002570 I2C_TRISTATE
2571
2572 The code necessary to make the I2C data line tri-stated
2573 (inactive). If the data line is open collector, this
2574 define can be null.
2575
wdenkb37c7e52003-06-30 16:24:52 +00002576 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2577
wdenkc6097192002-11-03 00:24:07 +00002578 I2C_READ
2579
York Sun472d5462013-04-01 11:29:11 -07002580 Code that returns true if the I2C data line is high,
2581 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenkb37c7e52003-06-30 16:24:52 +00002583 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2584
wdenkc6097192002-11-03 00:24:07 +00002585 I2C_SDA(bit)
2586
York Sun472d5462013-04-01 11:29:11 -07002587 If <bit> is true, sets the I2C data line high. If it
2588 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002589
wdenkb37c7e52003-06-30 16:24:52 +00002590 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002591 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002592 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002593
wdenkc6097192002-11-03 00:24:07 +00002594 I2C_SCL(bit)
2595
York Sun472d5462013-04-01 11:29:11 -07002596 If <bit> is true, sets the I2C clock line high. If it
2597 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002598
wdenkb37c7e52003-06-30 16:24:52 +00002599 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002600 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002601 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002602
wdenkc6097192002-11-03 00:24:07 +00002603 I2C_DELAY
2604
2605 This delay is invoked four times per clock cycle so this
2606 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002607 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002608 like:
2609
wdenkb37c7e52003-06-30 16:24:52 +00002610 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002611
Mike Frysinger793b5722010-07-21 13:38:02 -04002612 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2613
2614 If your arch supports the generic GPIO framework (asm/gpio.h),
2615 then you may alternatively define the two GPIOs that are to be
2616 used as SCL / SDA. Any of the previous I2C_xxx macros will
2617 have GPIO-based defaults assigned to them as appropriate.
2618
2619 You should define these to the GPIO value as given directly to
2620 the generic GPIO functions.
2621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002622 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002623
wdenk8bde7f72003-06-27 21:31:46 +00002624 When a board is reset during an i2c bus transfer
2625 chips might think that the current transfer is still
2626 in progress. On some boards it is possible to access
2627 the i2c SCLK line directly, either by using the
2628 processor pin as a GPIO or by having a second pin
2629 connected to the bus. If this option is defined a
2630 custom i2c_init_board() routine in boards/xxx/board.c
2631 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002632
Richard Retanubun26a33502010-04-12 15:08:17 -04002633 CONFIG_SYS_I2C_BOARD_LATE_INIT
2634
2635 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2636 defined a custom i2c_board_late_init() routine in
2637 boards/xxx/board.c is run AFTER the operations in i2c_init()
2638 is completed. This callpoint can be used to unreset i2c bus
2639 using CPU i2c controller register accesses for CPUs whose i2c
2640 controller provide such a method. It is called at the end of
2641 i2c_init() to allow i2c_init operations to setup the i2c bus
2642 controller on the CPU (e.g. setting bus speed & slave address).
2643
wdenk17ea1172004-06-06 21:51:03 +00002644 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2645
2646 This option enables configuration of bi_iic_fast[] flags
2647 in u-boot bd_info structure based on u-boot environment
2648 variable "i2cfast". (see also i2cfast)
2649
Ben Warrenbb99ad62006-09-07 16:50:54 -04002650 CONFIG_I2C_MULTI_BUS
2651
2652 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002653 must have a controller. At any point in time, only one bus is
2654 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002655 Note that bus numbering is zero-based.
2656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002657 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002658
2659 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002660 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002661 is set, specify a list of bus-device pairs. Otherwise, specify
2662 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002663
2664 e.g.
2665 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002666 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002667
2668 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2669
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002670 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002671 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002672
2673 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002675 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002676
2677 If defined, then this indicates the I2C bus number for DDR SPD.
2678 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002681
2682 If defined, then this indicates the I2C bus number for the RTC.
2683 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002685 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002686
2687 If defined, then this indicates the I2C bus number for the DTT.
2688 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2689
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002690 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002691
2692 If defined, specifies the I2C address of the DTT device.
2693 If not defined, then U-Boot uses predefined value for
2694 specified DTT device.
2695
Andrew Dyer2ac69852008-12-29 17:36:01 -06002696 CONFIG_SOFT_I2C_READ_REPEATED_START
2697
2698 defining this will force the i2c_read() function in
2699 the soft_i2c driver to perform an I2C repeated start
2700 between writing the address pointer and reading the
2701 data. If this define is omitted the default behaviour
2702 of doing a stop-start sequence will be used. Most I2C
2703 devices can use either method, but some require one or
2704 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002705
wdenkc6097192002-11-03 00:24:07 +00002706- SPI Support: CONFIG_SPI
2707
2708 Enables SPI driver (so far only tested with
2709 SPI EEPROM, also an instance works with Crystal A/D and
2710 D/As on the SACSng board)
2711
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002712 CONFIG_SH_SPI
2713
2714 Enables the driver for SPI controller on SuperH. Currently
2715 only SH7757 is supported.
2716
wdenkc6097192002-11-03 00:24:07 +00002717 CONFIG_SPI_X
2718
2719 Enables extended (16-bit) SPI EEPROM addressing.
2720 (symmetrical to CONFIG_I2C_X)
2721
2722 CONFIG_SOFT_SPI
2723
wdenk43d96162003-03-06 00:02:04 +00002724 Enables a software (bit-bang) SPI driver rather than
2725 using hardware support. This is a general purpose
2726 driver that only requires three general I/O port pins
2727 (two outputs, one input) to function. If this is
2728 defined, the board configuration must define several
2729 SPI configuration items (port pins to use, etc). For
2730 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002731
Ben Warren04a9e112008-01-16 22:37:35 -05002732 CONFIG_HARD_SPI
2733
2734 Enables a hardware SPI driver for general-purpose reads
2735 and writes. As with CONFIG_SOFT_SPI, the board configuration
2736 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002737 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002738 example, see include/configs/mpc8349emds.h.
2739
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002740 CONFIG_MXC_SPI
2741
2742 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002743 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002744
Heiko Schocherf659b572014-07-14 10:22:11 +02002745 CONFIG_SYS_SPI_MXC_WAIT
2746 Timeout for waiting until spi transfer completed.
2747 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2748
Matthias Fuchs01335022007-12-27 17:12:34 +01002749- FPGA Support: CONFIG_FPGA
2750
2751 Enables FPGA subsystem.
2752
2753 CONFIG_FPGA_<vendor>
2754
2755 Enables support for specific chip vendors.
2756 (ALTERA, XILINX)
2757
2758 CONFIG_FPGA_<family>
2759
2760 Enables support for FPGA family.
2761 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2762
2763 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002764
wdenk43d96162003-03-06 00:02:04 +00002765 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002766
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302767 CONFIG_CMD_FPGA_LOADMK
2768
2769 Enable support for fpga loadmk command
2770
Michal Simek67193862014-05-02 13:43:39 +02002771 CONFIG_CMD_FPGA_LOADP
2772
2773 Enable support for fpga loadp command - load partial bitstream
2774
2775 CONFIG_CMD_FPGA_LOADBP
2776
2777 Enable support for fpga loadbp command - load partial bitstream
2778 (Xilinx only)
2779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002781
wdenk8bde7f72003-06-27 21:31:46 +00002782 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002784 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002785
wdenk43d96162003-03-06 00:02:04 +00002786 Enable checks on FPGA configuration interface busy
2787 status by the configuration function. This option
2788 will require a board or device specific function to
2789 be written.
wdenkc6097192002-11-03 00:24:07 +00002790
2791 CONFIG_FPGA_DELAY
2792
2793 If defined, a function that provides delays in the FPGA
2794 configuration driver.
2795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002796 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002797 Allow Control-C to interrupt FPGA configuration
2798
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002799 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002800
wdenk43d96162003-03-06 00:02:04 +00002801 Check for configuration errors during FPGA bitfile
2802 loading. For example, abort during Virtex II
2803 configuration if the INIT_B line goes low (which
2804 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002807
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002808 Maximum time to wait for the INIT_B line to de-assert
2809 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002810 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002811 ms.
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002814
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002815 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002816 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002818 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002819
wdenk43d96162003-03-06 00:02:04 +00002820 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002821 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002822
2823- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002824 CONFIG_BUILD_TARGET
2825
2826 Some SoCs need special image types (e.g. U-Boot binary
2827 with a special header) as build targets. By defining
2828 CONFIG_BUILD_TARGET in the SoC / board header, this
2829 special image will be automatically built upon calling
2830 make / MAKEALL.
2831
wdenkc6097192002-11-03 00:24:07 +00002832 CONFIG_IDENT_STRING
2833
wdenk43d96162003-03-06 00:02:04 +00002834 If defined, this string will be added to the U-Boot
2835 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002836
2837- Vendor Parameter Protection:
2838
wdenk43d96162003-03-06 00:02:04 +00002839 U-Boot considers the values of the environment
2840 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002841 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002842 are set once by the board vendor / manufacturer, and
2843 protects these variables from casual modification by
2844 the user. Once set, these variables are read-only,
2845 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002846 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002847
2848 If CONFIG_ENV_OVERWRITE is #defined in your config
2849 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002850 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002851 these parameters.
2852
Joe Hershberger92ac5202015-05-04 14:55:14 -05002853 Alternatively, if you define _both_ an ethaddr in the
2854 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002855 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002856 which can be changed exactly ONCE by the user. [The
2857 serial# is unaffected by this, i. e. it remains
2858 read-only.]
2859
Joe Hershberger25980902012-12-11 22:16:31 -06002860 The same can be accomplished in a more flexible way
2861 for any variable by configuring the type of access
2862 to allow for those variables in the ".flags" variable
2863 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2864
wdenkc6097192002-11-03 00:24:07 +00002865- Protected RAM:
2866 CONFIG_PRAM
2867
2868 Define this variable to enable the reservation of
2869 "protected RAM", i. e. RAM which is not overwritten
2870 by U-Boot. Define CONFIG_PRAM to hold the number of
2871 kB you want to reserve for pRAM. You can overwrite
2872 this default value by defining an environment
2873 variable "pram" to the number of kB you want to
2874 reserve. Note that the board info structure will
2875 still show the full amount of RAM. If pRAM is
2876 reserved, a new environment variable "mem" will
2877 automatically be defined to hold the amount of
2878 remaining RAM in a form that can be passed as boot
2879 argument to Linux, for instance like that:
2880
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002881 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002882 saveenv
2883
2884 This way you can tell Linux not to use this memory,
2885 either, which results in a memory region that will
2886 not be affected by reboots.
2887
2888 *WARNING* If your board configuration uses automatic
2889 detection of the RAM size, you must make sure that
2890 this memory test is non-destructive. So far, the
2891 following board configurations are known to be
2892 "pRAM-clean":
2893
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002894 IVMS8, IVML24, SPD8xx, TQM8xxL,
2895 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002896 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002897
Gabe Black40fef042012-12-02 04:55:18 +00002898- Access to physical memory region (> 4GB)
2899 Some basic support is provided for operations on memory not
2900 normally accessible to U-Boot - e.g. some architectures
2901 support access to more than 4GB of memory on 32-bit
2902 machines using physical address extension or similar.
2903 Define CONFIG_PHYSMEM to access this basic support, which
2904 currently only supports clearing the memory.
2905
wdenkc6097192002-11-03 00:24:07 +00002906- Error Recovery:
2907 CONFIG_PANIC_HANG
2908
2909 Define this variable to stop the system in case of a
2910 fatal error, so that you have to reset it manually.
2911 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002912 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002913 automatically as fast as possible, but it may be
2914 useful during development since you can try to debug
2915 the conditions that lead to the situation.
2916
2917 CONFIG_NET_RETRY_COUNT
2918
wdenk43d96162003-03-06 00:02:04 +00002919 This variable defines the number of retries for
2920 network operations like ARP, RARP, TFTP, or BOOTP
2921 before giving up the operation. If not defined, a
2922 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002923
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002924 CONFIG_ARP_TIMEOUT
2925
2926 Timeout waiting for an ARP reply in milliseconds.
2927
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002928 CONFIG_NFS_TIMEOUT
2929
2930 Timeout in milliseconds used in NFS protocol.
2931 If you encounter "ERROR: Cannot umount" in nfs command,
2932 try longer timeout such as
2933 #define CONFIG_NFS_TIMEOUT 10000UL
2934
wdenkc6097192002-11-03 00:24:07 +00002935- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002936 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002937
2938 Enable auto completion of commands using TAB.
2939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002940 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002941
2942 This defines the secondary prompt string, which is
2943 printed when the command interpreter needs more input
2944 to complete a command. Usually "> ".
2945
2946 Note:
2947
wdenk8bde7f72003-06-27 21:31:46 +00002948 In the current implementation, the local variables
2949 space and global environment variables space are
2950 separated. Local variables are those you define by
2951 simply typing `name=value'. To access a local
2952 variable later on, you have write `$name' or
2953 `${name}'; to execute the contents of a variable
2954 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002955
wdenk43d96162003-03-06 00:02:04 +00002956 Global environment variables are those you use
2957 setenv/printenv to work with. To run a command stored
2958 in such a variable, you need to use the run command,
2959 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002960
2961 To store commands and special characters in a
2962 variable, please use double quotation marks
2963 surrounding the whole text of the variable, instead
2964 of the backslashes before semicolons and special
2965 symbols.
2966
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002967- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002968 CONFIG_CMDLINE_EDITING
2969
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002970 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002971 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002972
wdenka8c7c702003-12-06 19:49:23 +00002973- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002974 CONFIG_EXTRA_ENV_SETTINGS
2975
wdenk43d96162003-03-06 00:02:04 +00002976 Define this to contain any number of null terminated
2977 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002978 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002979
wdenk43d96162003-03-06 00:02:04 +00002980 For example, place something like this in your
2981 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002982
2983 #define CONFIG_EXTRA_ENV_SETTINGS \
2984 "myvar1=value1\0" \
2985 "myvar2=value2\0"
2986
wdenk43d96162003-03-06 00:02:04 +00002987 Warning: This method is based on knowledge about the
2988 internal format how the environment is stored by the
2989 U-Boot code. This is NOT an official, exported
2990 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002991 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002992 You better know what you are doing here.
2993
wdenk43d96162003-03-06 00:02:04 +00002994 Note: overly (ab)use of the default environment is
2995 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002996 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002997 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002998
Stephen Warren5e724ca2012-05-22 09:21:54 +00002999 CONFIG_ENV_VARS_UBOOT_CONFIG
3000
3001 Define this in order to add variables describing the
3002 U-Boot build configuration to the default environment.
3003 These will be named arch, cpu, board, vendor, and soc.
3004
3005 Enabling this option will cause the following to be defined:
3006
3007 - CONFIG_SYS_ARCH
3008 - CONFIG_SYS_CPU
3009 - CONFIG_SYS_BOARD
3010 - CONFIG_SYS_VENDOR
3011 - CONFIG_SYS_SOC
3012
Tom Rini7e27f892012-10-24 07:28:16 +00003013 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3014
3015 Define this in order to add variables describing certain
3016 run-time determined information about the hardware to the
3017 environment. These will be named board_name, board_rev.
3018
Simon Glass06fd8532012-11-30 13:01:17 +00003019 CONFIG_DELAY_ENVIRONMENT
3020
3021 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003022 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00003023 that so that the environment is not available until
3024 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3025 this is instead controlled by the value of
3026 /config/load-environment.
3027
Chris Packham3b10cf12015-06-19 20:25:59 +12003028- Parallel Flash support:
3029 CONFIG_SYS_NO_FLASH
3030
3031 Traditionally U-boot was run on systems with parallel NOR
3032 flash. This option is used to disable support for parallel NOR
3033 flash. This option should be defined if the board does not have
3034 parallel flash.
3035
3036 If this option is not defined one of the generic flash drivers
3037 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
3038 selected or the board must provide an implementation of the
3039 flash API (see include/flash.h).
3040
wdenka8c7c702003-12-06 19:49:23 +00003041- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003042 CONFIG_HAS_DATAFLASH
3043
wdenk8bde7f72003-06-27 21:31:46 +00003044 Defining this option enables DataFlash features and
3045 allows to read/write in Dataflash via the standard
3046 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003047
Eric Nelsonf61ec452012-01-31 10:52:08 -07003048- Serial Flash support
3049 CONFIG_CMD_SF
3050
3051 Defining this option enables SPI flash commands
3052 'sf probe/read/write/erase/update'.
3053
3054 Usage requires an initial 'probe' to define the serial
3055 flash parameters, followed by read/write/erase/update
3056 commands.
3057
3058 The following defaults may be provided by the platform
3059 to handle the common case when only a single serial
3060 flash is present on the system.
3061
3062 CONFIG_SF_DEFAULT_BUS Bus identifier
3063 CONFIG_SF_DEFAULT_CS Chip-select
3064 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3065 CONFIG_SF_DEFAULT_SPEED in Hz
3066
Simon Glass24007272012-10-08 13:16:02 +00003067 CONFIG_CMD_SF_TEST
3068
3069 Define this option to include a destructive SPI flash
3070 test ('sf test').
3071
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303072 CONFIG_SF_DUAL_FLASH Dual flash memories
3073
3074 Define this option to use dual flash support where two flash
3075 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003076 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303077
wdenk3f85ce22004-02-23 16:11:30 +00003078- SystemACE Support:
3079 CONFIG_SYSTEMACE
3080
3081 Adding this option adds support for Xilinx SystemACE
3082 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003083 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003085
3086 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003087 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003088
3089 When SystemACE support is added, the "ace" device type
3090 becomes available to the fat commands, i.e. fatls.
3091
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003092- TFTP Fixed UDP Port:
3093 CONFIG_TFTP_PORT
3094
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003095 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003096 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003097 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003098 number generator is used.
3099
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003100 Also, the environment variable tftpdstp is used to supply
3101 the TFTP UDP destination port value. If tftpdstp isn't
3102 defined, the normal port 69 is used.
3103
3104 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003105 blindly start the TFTP transfer using the pre-configured
3106 target IP address and UDP port. This has the effect of
3107 "punching through" the (Windows XP) firewall, allowing
3108 the remainder of the TFTP transfer to proceed normally.
3109 A better solution is to properly configure the firewall,
3110 but sometimes that is not allowed.
3111
Simon Glassbf36c5d2012-12-05 14:46:38 +00003112- Hashing support:
3113 CONFIG_CMD_HASH
3114
3115 This enables a generic 'hash' command which can produce
3116 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3117
3118 CONFIG_HASH_VERIFY
3119
3120 Enable the hash verify command (hash -v). This adds to code
3121 size a little.
3122
gaurav rana94e3c8c2015-02-20 12:51:46 +05303123 CONFIG_SHA1 - This option enables support of hashing using SHA1
3124 algorithm. The hash is calculated in software.
3125 CONFIG_SHA256 - This option enables support of hashing using
3126 SHA256 algorithm. The hash is calculated in software.
3127 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3128 for SHA1/SHA256 hashing.
3129 This affects the 'hash' command and also the
3130 hash_lookup_algo() function.
3131 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3132 hardware-acceleration for SHA1/SHA256 progressive hashing.
3133 Data can be streamed in a block at a time and the hashing
3134 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003135
3136 Note: There is also a sha1sum command, which should perhaps
3137 be deprecated in favour of 'hash sha1'.
3138
Robert Winklera11f1872013-07-24 17:57:06 -07003139- Freescale i.MX specific commands:
3140 CONFIG_CMD_HDMIDETECT
3141 This enables 'hdmidet' command which returns true if an
3142 HDMI monitor is detected. This command is i.MX 6 specific.
3143
3144 CONFIG_CMD_BMODE
3145 This enables the 'bmode' (bootmode) command for forcing
3146 a boot from specific media.
3147
3148 This is useful for forcing the ROM's usb downloader to
3149 activate upon a watchdog reset which is nice when iterating
3150 on U-Boot. Using the reset button or running bmode normal
3151 will set it back to normal. This command currently
3152 supports i.MX53 and i.MX6.
3153
Simon Glass19c402a2013-06-13 15:10:02 -07003154- Signing support:
3155 CONFIG_RSA
3156
3157 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003158 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003159
Ruchika Guptac937ff62015-01-23 16:01:54 +05303160 The Modular Exponentiation algorithm in RSA is implemented using
3161 driver model. So CONFIG_DM needs to be enabled by default for this
3162 library to function.
3163
Simon Glass19c402a2013-06-13 15:10:02 -07003164 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303165 option. The software based modular exponentiation is built into
3166 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003167
Heiko Schocher9e50c402014-01-25 07:27:13 +01003168- bootcount support:
3169 CONFIG_BOOTCOUNT_LIMIT
3170
3171 This enables the bootcounter support, see:
3172 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3173
3174 CONFIG_AT91SAM9XE
3175 enable special bootcounter support on at91sam9xe based boards.
3176 CONFIG_BLACKFIN
3177 enable special bootcounter support on blackfin based boards.
3178 CONFIG_SOC_DA8XX
3179 enable special bootcounter support on da850 based boards.
3180 CONFIG_BOOTCOUNT_RAM
3181 enable support for the bootcounter in RAM
3182 CONFIG_BOOTCOUNT_I2C
3183 enable support for the bootcounter on an i2c (like RTC) device.
3184 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3185 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3186 the bootcounter.
3187 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003188
wdenka8c7c702003-12-06 19:49:23 +00003189- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003190 CONFIG_SHOW_BOOT_PROGRESS
3191
wdenk43d96162003-03-06 00:02:04 +00003192 Defining this option allows to add some board-
3193 specific code (calling a user-provided function
3194 "show_boot_progress(int)") that enables you to show
3195 the system's boot progress on some display (for
3196 example, some LED's) on your board. At the moment,
3197 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003198
Simon Glass94fd1312012-09-28 08:56:37 +00003199
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003200Legacy uImage format:
3201
wdenkc6097192002-11-03 00:24:07 +00003202 Arg Where When
3203 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003204 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003205 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003206 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003207 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003208 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003209 4 common/cmd_bootm.c Image data has correct checksum
3210 -4 common/cmd_bootm.c Image is for unsupported architecture
3211 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003212 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003213 6 common/cmd_bootm.c Image Type check OK
3214 -6 common/cmd_bootm.c gunzip uncompression error
3215 -7 common/cmd_bootm.c Unimplemented compression type
3216 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003217 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003218 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003219
3220 9 common/image.c Start initial ramdisk verification
3221 -10 common/image.c Ramdisk header has bad magic number
3222 -11 common/image.c Ramdisk header has bad checksum
3223 10 common/image.c Ramdisk header is OK
3224 -12 common/image.c Ramdisk data has bad checksum
3225 11 common/image.c Ramdisk data has correct checksum
3226 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003227 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003228 13 common/image.c Start multifile image verification
3229 14 common/image.c No initial ramdisk, no multifile, continue.
3230
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003231 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003232
Stefan Roesea47a12b2010-04-15 16:07:28 +02003233 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003234 -31 post/post.c POST test failed, detected by post_output_backlog()
3235 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003236
Heiko Schocher566a4942007-06-22 19:11:54 +02003237 34 common/cmd_doc.c before loading a Image from a DOC device
3238 -35 common/cmd_doc.c Bad usage of "doc" command
3239 35 common/cmd_doc.c correct usage of "doc" command
3240 -36 common/cmd_doc.c No boot device
3241 36 common/cmd_doc.c correct boot device
3242 -37 common/cmd_doc.c Unknown Chip ID on boot device
3243 37 common/cmd_doc.c correct chip ID found, device available
3244 -38 common/cmd_doc.c Read Error on boot device
3245 38 common/cmd_doc.c reading Image header from DOC device OK
3246 -39 common/cmd_doc.c Image header has bad magic number
3247 39 common/cmd_doc.c Image header has correct magic number
3248 -40 common/cmd_doc.c Error reading Image from DOC device
3249 40 common/cmd_doc.c Image header has correct magic number
3250 41 common/cmd_ide.c before loading a Image from a IDE device
3251 -42 common/cmd_ide.c Bad usage of "ide" command
3252 42 common/cmd_ide.c correct usage of "ide" command
3253 -43 common/cmd_ide.c No boot device
3254 43 common/cmd_ide.c boot device found
3255 -44 common/cmd_ide.c Device not available
3256 44 common/cmd_ide.c Device available
3257 -45 common/cmd_ide.c wrong partition selected
3258 45 common/cmd_ide.c partition selected
3259 -46 common/cmd_ide.c Unknown partition table
3260 46 common/cmd_ide.c valid partition table found
3261 -47 common/cmd_ide.c Invalid partition type
3262 47 common/cmd_ide.c correct partition type
3263 -48 common/cmd_ide.c Error reading Image Header on boot device
3264 48 common/cmd_ide.c reading Image Header from IDE device OK
3265 -49 common/cmd_ide.c Image header has bad magic number
3266 49 common/cmd_ide.c Image header has correct magic number
3267 -50 common/cmd_ide.c Image header has bad checksum
3268 50 common/cmd_ide.c Image header has correct checksum
3269 -51 common/cmd_ide.c Error reading Image from IDE device
3270 51 common/cmd_ide.c reading Image from IDE device OK
3271 52 common/cmd_nand.c before loading a Image from a NAND device
3272 -53 common/cmd_nand.c Bad usage of "nand" command
3273 53 common/cmd_nand.c correct usage of "nand" command
3274 -54 common/cmd_nand.c No boot device
3275 54 common/cmd_nand.c boot device found
3276 -55 common/cmd_nand.c Unknown Chip ID on boot device
3277 55 common/cmd_nand.c correct chip ID found, device available
3278 -56 common/cmd_nand.c Error reading Image Header on boot device
3279 56 common/cmd_nand.c reading Image Header from NAND device OK
3280 -57 common/cmd_nand.c Image header has bad magic number
3281 57 common/cmd_nand.c Image header has correct magic number
3282 -58 common/cmd_nand.c Error reading Image from NAND device
3283 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003284
Heiko Schocher566a4942007-06-22 19:11:54 +02003285 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003286
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003287 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003288 -64 net/eth.c no Ethernet found.
3289 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003290
Heiko Schocher566a4942007-06-22 19:11:54 +02003291 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003292 80 common/cmd_net.c before calling net_loop()
3293 -81 common/cmd_net.c some error in net_loop() occurred
3294 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003295 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3296 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003297 83 common/cmd_net.c running "source" command
3298 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003299 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003300
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003301FIT uImage format:
3302
3303 Arg Where When
3304 100 common/cmd_bootm.c Kernel FIT Image has correct format
3305 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3306 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3307 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3308 102 common/cmd_bootm.c Kernel unit name specified
3309 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003310 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003311 104 common/cmd_bootm.c Got kernel subimage node offset
3312 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3313 105 common/cmd_bootm.c Kernel subimage hash verification OK
3314 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3315 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003316 -106 common/cmd_bootm.c Kernel subimage has wrong type
3317 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003318 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3319 108 common/cmd_bootm.c Got kernel subimage data/size
3320 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3321 -109 common/cmd_bootm.c Can't get kernel subimage type
3322 -110 common/cmd_bootm.c Can't get kernel subimage comp
3323 -111 common/cmd_bootm.c Can't get kernel subimage os
3324 -112 common/cmd_bootm.c Can't get kernel subimage load address
3325 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3326
3327 120 common/image.c Start initial ramdisk verification
3328 -120 common/image.c Ramdisk FIT image has incorrect format
3329 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003330 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003331 -122 common/image.c Can't get configuration for ramdisk subimage
3332 123 common/image.c Ramdisk unit name specified
3333 -124 common/image.c Can't get ramdisk subimage node offset
3334 125 common/image.c Got ramdisk subimage node offset
3335 -125 common/image.c Ramdisk subimage hash verification failed
3336 126 common/image.c Ramdisk subimage hash verification OK
3337 -126 common/image.c Ramdisk subimage for unsupported architecture
3338 127 common/image.c Architecture check OK
3339 -127 common/image.c Can't get ramdisk subimage data/size
3340 128 common/image.c Got ramdisk subimage data/size
3341 129 common/image.c Can't get ramdisk load address
3342 -129 common/image.c Got ramdisk load address
3343
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003344 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003345 131 common/cmd_doc.c FIT image format OK
3346
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003347 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003348 141 common/cmd_ide.c FIT image format OK
3349
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003350 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003351 151 common/cmd_nand.c FIT image format OK
3352
Heiko Schocher21d29f72014-05-28 11:33:33 +02003353- legacy image format:
3354 CONFIG_IMAGE_FORMAT_LEGACY
3355 enables the legacy image format support in U-Boot.
3356
3357 Default:
3358 enabled if CONFIG_FIT_SIGNATURE is not defined.
3359
3360 CONFIG_DISABLE_IMAGE_LEGACY
3361 disable the legacy image format
3362
3363 This define is introduced, as the legacy image format is
3364 enabled per default for backward compatibility.
3365
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003366- FIT image support:
3367 CONFIG_FIT
3368 Enable support for the FIT uImage format.
3369
3370 CONFIG_FIT_BEST_MATCH
3371 When no configuration is explicitly selected, default to the
3372 one whose fdt's compatibility field best matches that of
3373 U-Boot itself. A match is considered "best" if it matches the
3374 most specific compatibility entry of U-Boot's fdt's root node.
3375 The order of entries in the configuration's fdt is ignored.
3376
Simon Glass3e569a62013-06-13 15:10:00 -07003377 CONFIG_FIT_SIGNATURE
3378 This option enables signature verification of FIT uImages,
gaurav rana94e3c8c2015-02-20 12:51:46 +05303379 using a hash signed and verified using RSA. If
3380 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3381 hashing is available using hardware, RSA library will use it.
3382 See doc/uImage.FIT/signature.txt for more details.
Simon Glass3e569a62013-06-13 15:10:00 -07003383
Heiko Schocher21d29f72014-05-28 11:33:33 +02003384 WARNING: When relying on signed FIT images with required
3385 signature check the legacy image format is default
3386 disabled. If a board need legacy image format support
3387 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3388
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003389 CONFIG_FIT_DISABLE_SHA256
3390 Supporting SHA256 hashes has quite an impact on binary size.
3391 For constrained systems sha256 hash support can be disabled
3392 with this option.
3393
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003394- Standalone program support:
3395 CONFIG_STANDALONE_LOAD_ADDR
3396
Wolfgang Denk6feff892011-10-09 21:06:34 +02003397 This option defines a board specific value for the
3398 address where standalone program gets loaded, thus
3399 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003400 settings.
3401
3402- Frame Buffer Address:
3403 CONFIG_FB_ADDR
3404
3405 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003406 address for frame buffer. This is typically the case
3407 when using a graphics controller has separate video
3408 memory. U-Boot will then place the frame buffer at
3409 the given address instead of dynamically reserving it
3410 in system RAM by calling lcd_setmem(), which grabs
3411 the memory for the frame buffer depending on the
3412 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003413
3414 Please see board_init_f function.
3415
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003416- Automatic software updates via TFTP server
3417 CONFIG_UPDATE_TFTP
3418 CONFIG_UPDATE_TFTP_CNT_MAX
3419 CONFIG_UPDATE_TFTP_MSEC_MAX
3420
3421 These options enable and control the auto-update feature;
3422 for a more detailed description refer to doc/README.update.
3423
3424- MTD Support (mtdparts command, UBI support)
3425 CONFIG_MTD_DEVICE
3426
3427 Adds the MTD device infrastructure from the Linux kernel.
3428 Needed for mtdparts command support.
3429
3430 CONFIG_MTD_PARTITIONS
3431
3432 Adds the MTD partitioning infrastructure from the Linux
3433 kernel. Needed for UBI support.
3434
Joe Hershberger70c219c2013-04-08 10:32:48 +00003435- UBI support
3436 CONFIG_CMD_UBI
3437
3438 Adds commands for interacting with MTD partitions formatted
3439 with the UBI flash translation layer
3440
3441 Requires also defining CONFIG_RBTREE
3442
Joe Hershberger147162d2013-04-08 10:32:49 +00003443 CONFIG_UBI_SILENCE_MSG
3444
3445 Make the verbose messages from UBI stop printing. This leaves
3446 warnings and errors enabled.
3447
Heiko Schocherff94bc42014-06-24 10:10:04 +02003448
3449 CONFIG_MTD_UBI_WL_THRESHOLD
3450 This parameter defines the maximum difference between the highest
3451 erase counter value and the lowest erase counter value of eraseblocks
3452 of UBI devices. When this threshold is exceeded, UBI starts performing
3453 wear leveling by means of moving data from eraseblock with low erase
3454 counter to eraseblocks with high erase counter.
3455
3456 The default value should be OK for SLC NAND flashes, NOR flashes and
3457 other flashes which have eraseblock life-cycle 100000 or more.
3458 However, in case of MLC NAND flashes which typically have eraseblock
3459 life-cycle less than 10000, the threshold should be lessened (e.g.,
3460 to 128 or 256, although it does not have to be power of 2).
3461
3462 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003463
Heiko Schocherff94bc42014-06-24 10:10:04 +02003464 CONFIG_MTD_UBI_BEB_LIMIT
3465 This option specifies the maximum bad physical eraseblocks UBI
3466 expects on the MTD device (per 1024 eraseblocks). If the
3467 underlying flash does not admit of bad eraseblocks (e.g. NOR
3468 flash), this value is ignored.
3469
3470 NAND datasheets often specify the minimum and maximum NVM
3471 (Number of Valid Blocks) for the flashes' endurance lifetime.
3472 The maximum expected bad eraseblocks per 1024 eraseblocks
3473 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3474 which gives 20 for most NANDs (MaxNVB is basically the total
3475 count of eraseblocks on the chip).
3476
3477 To put it differently, if this value is 20, UBI will try to
3478 reserve about 1.9% of physical eraseblocks for bad blocks
3479 handling. And that will be 1.9% of eraseblocks on the entire
3480 NAND chip, not just the MTD partition UBI attaches. This means
3481 that if you have, say, a NAND flash chip admits maximum 40 bad
3482 eraseblocks, and it is split on two MTD partitions of the same
3483 size, UBI will reserve 40 eraseblocks when attaching a
3484 partition.
3485
3486 default: 20
3487
3488 CONFIG_MTD_UBI_FASTMAP
3489 Fastmap is a mechanism which allows attaching an UBI device
3490 in nearly constant time. Instead of scanning the whole MTD device it
3491 only has to locate a checkpoint (called fastmap) on the device.
3492 The on-flash fastmap contains all information needed to attach
3493 the device. Using fastmap makes only sense on large devices where
3494 attaching by scanning takes long. UBI will not automatically install
3495 a fastmap on old images, but you can set the UBI parameter
3496 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3497 that fastmap-enabled images are still usable with UBI implementations
3498 without fastmap support. On typical flash devices the whole fastmap
3499 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3500
3501 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3502 Set this parameter to enable fastmap automatically on images
3503 without a fastmap.
3504 default: 0
3505
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003506 CONFIG_MTD_UBI_FM_DEBUG
3507 Enable UBI fastmap debug
3508 default: 0
3509
Joe Hershberger70c219c2013-04-08 10:32:48 +00003510- UBIFS support
3511 CONFIG_CMD_UBIFS
3512
3513 Adds commands for interacting with UBI volumes formatted as
3514 UBIFS. UBIFS is read-only in u-boot.
3515
3516 Requires UBI support as well as CONFIG_LZO
3517
Joe Hershberger147162d2013-04-08 10:32:49 +00003518 CONFIG_UBIFS_SILENCE_MSG
3519
3520 Make the verbose messages from UBIFS stop printing. This leaves
3521 warnings and errors enabled.
3522
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003523- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003524 CONFIG_SPL
3525 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003526
Tom Rini95579792012-02-14 07:29:40 +00003527 CONFIG_SPL_LDSCRIPT
3528 LDSCRIPT for linking the SPL binary.
3529
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003530 CONFIG_SPL_MAX_FOOTPRINT
3531 Maximum size in memory allocated to the SPL, BSS included.
3532 When defined, the linker checks that the actual memory
3533 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003534 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003535 must not be both defined at the same time.
3536
Tom Rini95579792012-02-14 07:29:40 +00003537 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003538 Maximum size of the SPL image (text, data, rodata, and
3539 linker lists sections), BSS excluded.
3540 When defined, the linker checks that the actual size does
3541 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003542
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003543 CONFIG_SPL_TEXT_BASE
3544 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003545
Scott Wood94a45bb2012-09-20 19:05:12 -05003546 CONFIG_SPL_RELOC_TEXT_BASE
3547 Address to relocate to. If unspecified, this is equal to
3548 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3549
Tom Rini95579792012-02-14 07:29:40 +00003550 CONFIG_SPL_BSS_START_ADDR
3551 Link address for the BSS within the SPL binary.
3552
3553 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003554 Maximum size in memory allocated to the SPL BSS.
3555 When defined, the linker checks that the actual memory used
3556 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003557 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003558 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003559
3560 CONFIG_SPL_STACK
3561 Adress of the start of the stack SPL will use
3562
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003563 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3564 When defined, SPL will panic() if the image it has
3565 loaded does not have a signature.
3566 Defining this is useful when code which loads images
3567 in SPL cannot guarantee that absolutely all read errors
3568 will be caught.
3569 An example is the LPC32XX MLC NAND driver, which will
3570 consider that a completely unreadable NAND block is bad,
3571 and thus should be skipped silently.
3572
Scott Wood94a45bb2012-09-20 19:05:12 -05003573 CONFIG_SPL_RELOC_STACK
3574 Adress of the start of the stack SPL will use after
3575 relocation. If unspecified, this is equal to
3576 CONFIG_SPL_STACK.
3577
Tom Rini95579792012-02-14 07:29:40 +00003578 CONFIG_SYS_SPL_MALLOC_START
3579 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003580 When this option is set the full malloc is used in SPL and
3581 it is set up by spl_init() and before that, the simple malloc()
3582 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003583
3584 CONFIG_SYS_SPL_MALLOC_SIZE
3585 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003586
Tom Rini47f7bca2012-08-13 12:03:19 -07003587 CONFIG_SPL_FRAMEWORK
3588 Enable the SPL framework under common/. This framework
3589 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3590 NAND loading of the Linux Kernel.
3591
Tom Rini9607faf2014-03-28 12:03:39 -04003592 CONFIG_SPL_OS_BOOT
3593 Enable booting directly to an OS from SPL.
3594 See also: doc/README.falcon
3595
Tom Rini861a86f2012-08-13 11:37:56 -07003596 CONFIG_SPL_DISPLAY_PRINT
3597 For ARM, enable an optional function to print more information
3598 about the running system.
3599
Scott Wood4b919722012-09-20 16:35:21 -05003600 CONFIG_SPL_INIT_MINIMAL
3601 Arch init code should be built for a very small image
3602
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003603 CONFIG_SPL_LIBCOMMON_SUPPORT
3604 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003605
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003606 CONFIG_SPL_LIBDISK_SUPPORT
3607 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003608
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003609 CONFIG_SPL_I2C_SUPPORT
3610 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003611
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003612 CONFIG_SPL_GPIO_SUPPORT
3613 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003614
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003615 CONFIG_SPL_MMC_SUPPORT
3616 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003617
Tom Rini95579792012-02-14 07:29:40 +00003618 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3619 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003620 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003621 when the MMC is being used in raw mode.
3622
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003623 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3624 Partition on the MMC to load U-Boot from when the MMC is being
3625 used in raw mode
3626
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003627 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3628 Sector to load kernel uImage from when MMC is being
3629 used in raw mode (for Falcon mode)
3630
3631 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3632 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3633 Sector and number of sectors to load kernel argument
3634 parameters from when MMC is being used in raw mode
3635 (for falcon mode)
3636
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003637 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3638 Partition on the MMC to load U-Boot from when the MMC is being
3639 used in fs mode
3640
Tom Rini95579792012-02-14 07:29:40 +00003641 CONFIG_SPL_FAT_SUPPORT
3642 Support for fs/fat/libfat.o in SPL binary
3643
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003644 CONFIG_SPL_EXT_SUPPORT
3645 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003646
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003647 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3648 Filename to read to load U-Boot when reading from filesystem
3649
3650 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003651 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003652 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003653
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003654 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003655 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003656 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003657
Scott Wood06f60ae2012-12-06 13:33:17 +00003658 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3659 Set this for NAND SPL on PPC mpc83xx targets, so that
3660 start.S waits for the rest of the SPL to load before
3661 continuing (the hardware starts execution after just
3662 loading the first page rather than the full 4K).
3663
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303664 CONFIG_SPL_SKIP_RELOCATE
3665 Avoid SPL relocation
3666
Scott Wood6f2f01b2012-09-20 19:09:07 -05003667 CONFIG_SPL_NAND_BASE
3668 Include nand_base.c in the SPL. Requires
3669 CONFIG_SPL_NAND_DRIVERS.
3670
3671 CONFIG_SPL_NAND_DRIVERS
3672 SPL uses normal NAND drivers, not minimal drivers.
3673
3674 CONFIG_SPL_NAND_ECC
3675 Include standard software ECC in the SPL
3676
Tom Rini95579792012-02-14 07:29:40 +00003677 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003678 Support for NAND boot using simple NAND drivers that
3679 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003680
Tom Rini6dd3b562014-03-28 12:03:36 -04003681 CONFIG_SPL_MTD_SUPPORT
3682 Support for the MTD subsystem within SPL. Useful for
3683 environment on NAND support within SPL.
3684
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003685 CONFIG_SPL_NAND_RAW_ONLY
3686 Support to boot only raw u-boot.bin images. Use this only
3687 if you need to save space.
3688
Ying Zhangbb0dc102013-08-16 15:16:11 +08003689 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3690 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003691 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003692
Ying Zhang7c8eea52013-08-16 15:16:12 +08003693 CONFIG_SPL_COMMON_INIT_DDR
3694 Set for common ddr init with serial presence detect in
3695 SPL binary.
3696
Tom Rini95579792012-02-14 07:29:40 +00003697 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3698 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3699 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3700 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3701 CONFIG_SYS_NAND_ECCBYTES
3702 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003703 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003704
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303705 CONFIG_SPL_NAND_BOOT
3706 Add support NAND boot
3707
Tom Rini95579792012-02-14 07:29:40 +00003708 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003709 Location in NAND to read U-Boot from
3710
3711 CONFIG_SYS_NAND_U_BOOT_DST
3712 Location in memory to load U-Boot to
3713
3714 CONFIG_SYS_NAND_U_BOOT_SIZE
3715 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003716
3717 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003718 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003719
3720 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3721 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003722 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003723
3724 CONFIG_SPL_OMAP3_ID_NAND
3725 Support for an OMAP3-specific set of functions to return the
3726 ID and MFR of the first attached NAND chip, if present.
3727
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003728 CONFIG_SPL_SERIAL_SUPPORT
3729 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003730
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003731 CONFIG_SPL_SPI_FLASH_SUPPORT
3732 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003733
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003734 CONFIG_SPL_SPI_SUPPORT
3735 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003736
Pavel Machekc57b9532012-08-30 22:42:11 +02003737 CONFIG_SPL_RAM_DEVICE
3738 Support for running image already present in ram, in SPL binary
3739
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003740 CONFIG_SPL_LIBGENERIC_SUPPORT
3741 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003742
Ying Zhangba1bee42013-05-20 14:07:25 +08003743 CONFIG_SPL_ENV_SUPPORT
3744 Support for the environment operating in SPL binary
3745
3746 CONFIG_SPL_NET_SUPPORT
3747 Support for the net/libnet.o in SPL binary.
3748 It conflicts with SPL env from storage medium specified by
3749 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3750
Scott Wood74752ba2012-12-06 13:33:16 +00003751 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003752 Image offset to which the SPL should be padded before appending
3753 the SPL payload. By default, this is defined as
3754 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3755 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3756 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003757
Scott Woodca2fca22012-09-21 16:27:32 -05003758 CONFIG_SPL_TARGET
3759 Final target image containing SPL and payload. Some SPLs
3760 use an arch-specific makefile fragment instead, for
3761 example if more than one image needs to be produced.
3762
Simon Glass87ebee32013-05-08 08:05:59 +00003763 CONFIG_FIT_SPL_PRINT
3764 Printing information about a FIT image adds quite a bit of
3765 code to SPL. So this is normally disabled in SPL. Use this
3766 option to re-enable it. This will affect the output of the
3767 bootm command when booting a FIT image.
3768
Ying Zhang3aa29de2013-08-16 15:16:15 +08003769- TPL framework
3770 CONFIG_TPL
3771 Enable building of TPL globally.
3772
3773 CONFIG_TPL_PAD_TO
3774 Image offset to which the TPL should be padded before appending
3775 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003776 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3777 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3778 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003779
wdenkc6097192002-11-03 00:24:07 +00003780Modem Support:
3781--------------
3782
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003783[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003784
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003785- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003786 CONFIG_MODEM_SUPPORT
3787
3788- RTS/CTS Flow control enable:
3789 CONFIG_HWFLOW
3790
3791- Modem debug support:
3792 CONFIG_MODEM_SUPPORT_DEBUG
3793
wdenk43d96162003-03-06 00:02:04 +00003794 Enables debugging stuff (char screen[1024], dbg())
3795 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003796
wdenka8c7c702003-12-06 19:49:23 +00003797- Interrupt support (PPC):
3798
wdenkd4ca31c2004-01-02 14:00:00 +00003799 There are common interrupt_init() and timer_interrupt()
3800 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003801 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003802 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003803 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003804 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003805 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003806 specific handling. If board has watchdog / status_led
3807 / other_activity_monitor it works automatically from
3808 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003809
wdenkc6097192002-11-03 00:24:07 +00003810- General:
3811
wdenk43d96162003-03-06 00:02:04 +00003812 In the target system modem support is enabled when a
3813 specific key (key combination) is pressed during
3814 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003815 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003816 board_init(). Currently key_pressed() is a dummy
3817 function, returning 1 and thus enabling modem
3818 initialization.
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk43d96162003-03-06 00:02:04 +00003820 If there are no modem init strings in the
3821 environment, U-Boot proceed to autoboot; the
3822 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003823 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003824
3825 See also: doc/README.Modem
3826
Helmut Raiger9660e442011-10-20 04:19:47 +00003827Board initialization settings:
3828------------------------------
3829
3830During Initialization u-boot calls a number of board specific functions
3831to allow the preparation of board specific prerequisites, e.g. pin setup
3832before drivers are initialized. To enable these callbacks the
3833following configuration macros have to be defined. Currently this is
3834architecture specific, so please check arch/your_architecture/lib/board.c
3835typically in board_init_f() and board_init_r().
3836
3837- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3838- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3839- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3840- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003841
wdenkc6097192002-11-03 00:24:07 +00003842Configuration Settings:
3843-----------------------
3844
York Sun4d1fd7f2014-02-26 17:03:19 -08003845- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3846 Optionally it can be defined to support 64-bit memory commands.
3847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003848- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003849 undefine this when you're short of memory.
3850
Peter Tyser2fb26042009-01-27 18:03:12 -06003851- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3852 width of the commands listed in the 'help' command output.
3853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003854- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003855 prompt for user input.
3856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003857- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003858
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003859- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003860
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003861- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003862
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003863- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003864 the application (usually a Linux kernel) when it is
3865 booted
3866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003867- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003868 List of legal baudrate settings for this board.
3869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003870- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003871 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003873- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003874 If the board specific function
3875 extern int overwrite_console (void);
3876 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003877 serial port, else the settings in the environment are used.
3878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003879- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003880 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003881
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003882- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003883 Enable overwrite of previous console environment settings.
3884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003885- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003886 Begin and End addresses of the area used by the
3887 simple memory test.
3888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003889- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003890 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003892- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003893 Scratch address used by the alternate memory test
3894 You only need to set this if address zero isn't writeable
3895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003896- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3897 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003898 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003899 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003900 fixing up gd->ram_size the Linux kernel should gets passed
3901 the now "corrected" memory size and won't touch it either.
3902 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003903 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003904 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003905 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003906
3907 This option can be used as a workaround for the 440EPx/GRx
3908 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3909 be touched.
3910
3911 WARNING: Please make sure that this value is a multiple of
3912 the Linux page size (normally 4k). If this is not the case,
3913 then the end address of the Linux memory will be located at a
3914 non page size aligned address and this could cause major
3915 problems.
3916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003917- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003918 Enable temporary baudrate change while serial download
3919
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003920- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003921 Physical start address of SDRAM. _Must_ be 0 here.
3922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003923- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003924 Physical start address of Motherboard I/O (if using a
3925 Cogent motherboard)
3926
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003927- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003928 Physical start address of Flash memory.
3929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003930- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003931 Physical start address of boot monitor code (set by
3932 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003933 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003934 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003937 Size of memory reserved for monitor code, used to
3938 determine _at_compile_time_ (!) if the environment is
3939 embedded within the U-Boot image, or in a separate
3940 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003942- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003943 Size of DRAM reserved for malloc() use.
3944
Simon Glassd59476b2014-07-10 22:23:28 -06003945- CONFIG_SYS_MALLOC_F_LEN
3946 Size of the malloc() pool for use before relocation. If
3947 this is defined, then a very simple malloc() implementation
3948 will become available before relocation. The address is just
3949 below the global data, and the stack is moved down to make
3950 space.
3951
3952 This feature allocates regions with increasing addresses
3953 within the region. calloc() is supported, but realloc()
3954 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003955 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003956 U-Boot relocates itself.
3957
Simon Glasse7b14e92014-09-15 06:33:18 -06003958 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003959 at present but is fairly easy to enable for other archs.
3960
Simon Glass38687ae2014-11-10 17:16:54 -07003961- CONFIG_SYS_MALLOC_SIMPLE
3962 Provides a simple and small malloc() and calloc() for those
3963 boards which do not use the full malloc in SPL (which is
3964 enabled with CONFIG_SYS_SPL_MALLOC_START).
3965
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003966- CONFIG_SYS_NONCACHED_MEMORY:
3967 Size of non-cached memory area. This area of memory will be
3968 typically located right below the malloc() area and mapped
3969 uncached in the MMU. This is useful for drivers that would
3970 otherwise require a lot of explicit cache maintenance. For
3971 some drivers it's also impossible to properly maintain the
3972 cache. For example if the regions that need to be flushed
3973 are not a multiple of the cache-line size, *and* padding
3974 cannot be allocated between the regions to align them (i.e.
3975 if the HW requires a contiguous array of regions, and the
3976 size of each region is not cache-aligned), then a flush of
3977 one region may result in overwriting data that hardware has
3978 written to another region in the same cache-line. This can
3979 happen for example in network drivers where descriptors for
3980 buffers are typically smaller than the CPU cache-line (e.g.
3981 16 bytes vs. 32 or 64 bytes).
3982
3983 Non-cached memory is only supported on 32-bit ARM at present.
3984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003985- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003986 Normally compressed uImages are limited to an
3987 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003988 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003989 to adjust this setting to your needs.
3990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003991- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003992 Maximum size of memory mapped by the startup code of
3993 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003994 the Linux kernel (bd_info, boot arguments, FDT blob if
3995 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003996 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003997 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003998 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003999 variable "bootm_mapsize" will override the value of
4000 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4001 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004002
John Rigbyfca43cc2010-10-13 13:57:35 -06004003- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4004 Enable initrd_high functionality. If defined then the
4005 initrd_high feature is enabled and the bootm ramdisk subcommand
4006 is enabled.
4007
4008- CONFIG_SYS_BOOT_GET_CMDLINE:
4009 Enables allocating and saving kernel cmdline in space between
4010 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4011
4012- CONFIG_SYS_BOOT_GET_KBD:
4013 Enables allocating and saving a kernel copy of the bd_info in
4014 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4015
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004016- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004017 Max number of Flash memory banks
4018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004019- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004020 Max number of sectors on a Flash chip
4021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004022- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004023 Timeout for Flash erase operations (in ms)
4024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004025- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004026 Timeout for Flash write operations (in ms)
4027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004028- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004029 Timeout for Flash set sector lock bit operation (in ms)
4030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004031- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004032 Timeout for Flash clear lock bits operation (in ms)
4033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004034- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004035 If defined, hardware flash sectors protection is used
4036 instead of U-Boot software protection.
4037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004039
4040 Enable TFTP transfers directly to flash memory;
4041 without this option such a download has to be
4042 performed in two steps: (1) download to RAM, and (2)
4043 copy from RAM to flash.
4044
4045 The two-step approach is usually more reliable, since
4046 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004047 the flash, but in some situations (when system RAM is
4048 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004049 downloaded image) this option may be very useful.
4050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004051- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004052 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004053 common flash structure for storing flash geometry.
4054
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004055- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004056 This option also enables the building of the cfi_flash driver
4057 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004058
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004059- CONFIG_FLASH_CFI_MTD
4060 This option enables the building of the cfi_mtd driver
4061 in the drivers directory. The driver exports CFI flash
4062 to the MTD layer.
4063
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004064- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004065 Use buffered writes to flash.
4066
4067- CONFIG_FLASH_SPANSION_S29WS_N
4068 s29ws-n MirrorBit flash has non-standard addresses for buffered
4069 write commands.
4070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004071- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004072 If this option is defined, the common CFI flash doesn't
4073 print it's warning upon not recognized FLASH banks. This
4074 is useful, if some of the configured banks are only
4075 optionally available.
4076
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004077- CONFIG_FLASH_SHOW_PROGRESS
4078 If defined (must be an integer), print out countdown
4079 digits and dots. Recommended value: 45 (9..1) for 80
4080 column displays, 15 (3..1) for 40 column displays.
4081
Stefan Roese352ef3f2013-04-04 15:53:14 +02004082- CONFIG_FLASH_VERIFY
4083 If defined, the content of the flash (destination) is compared
4084 against the source after the write operation. An error message
4085 will be printed when the contents are not identical.
4086 Please note that this option is useless in nearly all cases,
4087 since such flash programming errors usually are detected earlier
4088 while unprotecting/erasing/programming. Please only enable
4089 this option if you really know what you are doing.
4090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004091- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004092 Defines the number of Ethernet receive buffers. On some
4093 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004094 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4095 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004096 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004097 Defaults to 4 if not defined.
4098
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004099- CONFIG_ENV_MAX_ENTRIES
4100
Wolfgang Denk071bc922010-10-27 22:48:30 +02004101 Maximum number of entries in the hash table that is used
4102 internally to store the environment settings. The default
4103 setting is supposed to be generous and should work in most
4104 cases. This setting can be used to tune behaviour; see
4105 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004106
Joe Hershberger25980902012-12-11 22:16:31 -06004107- CONFIG_ENV_FLAGS_LIST_DEFAULT
4108- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004109 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004110 calling env set. Variables can be restricted to only decimal,
4111 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4112 the variables can also be restricted to IP address or MAC address.
4113
4114 The format of the list is:
4115 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004116 access_attribute = [a|r|o|c]
4117 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004118 entry = variable_name[:attributes]
4119 list = entry[,list]
4120
4121 The type attributes are:
4122 s - String (default)
4123 d - Decimal
4124 x - Hexadecimal
4125 b - Boolean ([1yYtT|0nNfF])
4126 i - IP address
4127 m - MAC address
4128
Joe Hershberger267541f2012-12-11 22:16:34 -06004129 The access attributes are:
4130 a - Any (default)
4131 r - Read-only
4132 o - Write-once
4133 c - Change-default
4134
Joe Hershberger25980902012-12-11 22:16:31 -06004135 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4136 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004137 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004138
4139 - CONFIG_ENV_FLAGS_LIST_STATIC
4140 Define this to a list (string) to define validation that
4141 should be done if an entry is not found in the ".flags"
4142 environment variable. To override a setting in the static
4143 list, simply add an entry for the same variable name to the
4144 ".flags" variable.
4145
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004146 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4147 regular expression. This allows multiple variables to define the same
4148 flags without explicitly listing them for each variable.
4149
Joe Hershberger267541f2012-12-11 22:16:34 -06004150- CONFIG_ENV_ACCESS_IGNORE_FORCE
4151 If defined, don't allow the -f switch to env set override variable
4152 access flags.
4153
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004154- CONFIG_SYS_GENERIC_BOARD
4155 This selects the architecture-generic board system instead of the
4156 architecture-specific board files. It is intended to move boards
4157 to this new framework over time. Defining this will disable the
4158 arch/foo/lib/board.c file and use common/board_f.c and
4159 common/board_r.c instead. To use this option your architecture
Masahiro Yamada0a12e682015-03-19 19:42:51 +09004160 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4161 If you find problems enabling this option on your board please report
4162 the problem and send patches!
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004163
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004164- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4165 This is set by OMAP boards for the max time that reset should
4166 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004167 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004168
Gabe Black0d296cc2014-10-15 04:38:30 -06004169- CONFIG_USE_STDINT
4170 If stdint.h is available with your toolchain you can define this
4171 option to enable it. You can provide option 'USE_STDINT=1' when
4172 building U-Boot to enable this.
4173
wdenkc6097192002-11-03 00:24:07 +00004174The following definitions that deal with the placement and management
4175of environment data (variable area); in general, we support the
4176following configurations:
4177
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004178- CONFIG_BUILD_ENVCRC:
4179
4180 Builds up envcrc with the target environment so that external utils
4181 may easily extract it and embed it in final U-Boot images.
4182
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004183- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004184
4185 Define this if the environment is in flash memory.
4186
4187 a) The environment occupies one whole flash sector, which is
4188 "embedded" in the text segment with the U-Boot code. This
4189 happens usually with "bottom boot sector" or "top boot
4190 sector" type flash chips, which have several smaller
4191 sectors at the start or the end. For instance, such a
4192 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4193 such a case you would place the environment in one of the
4194 4 kB sectors - with U-Boot code before and after it. With
4195 "top boot sector" type flash chips, you would put the
4196 environment in one of the last sectors, leaving a gap
4197 between U-Boot and the environment.
4198
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004199 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004200
4201 Offset of environment data (variable area) to the
4202 beginning of flash memory; for instance, with bottom boot
4203 type flash chips the second sector can be used: the offset
4204 for this sector is given here.
4205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004206 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004207
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004208 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004209
4210 This is just another way to specify the start address of
4211 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004212 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004213
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004214 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004215
4216 Size of the sector containing the environment.
4217
4218
4219 b) Sometimes flash chips have few, equal sized, BIG sectors.
4220 In such a case you don't want to spend a whole sector for
4221 the environment.
4222
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004223 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004224
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004225 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004226 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004227 of this flash sector for the environment. This saves
4228 memory for the RAM copy of the environment.
4229
4230 It may also save flash memory if you decide to use this
4231 when your environment is "embedded" within U-Boot code,
4232 since then the remainder of the flash sector could be used
4233 for U-Boot code. It should be pointed out that this is
4234 STRONGLY DISCOURAGED from a robustness point of view:
4235 updating the environment in flash makes it always
4236 necessary to erase the WHOLE sector. If something goes
4237 wrong before the contents has been restored from a copy in
4238 RAM, your target system will be dead.
4239
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004240 - CONFIG_ENV_ADDR_REDUND
4241 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk43d96162003-03-06 00:02:04 +00004243 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004244 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004245 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004246 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004247
4248BE CAREFUL! Any changes to the flash layout, and some changes to the
4249source code will make it necessary to adapt <board>/u-boot.lds*
4250accordingly!
4251
4252
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004253- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004254
4255 Define this if you have some non-volatile memory device
4256 (NVRAM, battery buffered SRAM) which you want to use for the
4257 environment.
4258
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004259 - CONFIG_ENV_ADDR:
4260 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004262 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004263 want to use for environment. It is assumed that this memory
4264 can just be read and written to, without any special
4265 provision.
4266
4267BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004268in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004269console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004270U-Boot will hang.
4271
4272Please note that even with NVRAM we still use a copy of the
4273environment in RAM: we could work on NVRAM directly, but we want to
4274keep settings there always unmodified except somebody uses "saveenv"
4275to save the current settings.
4276
4277
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004278- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004279
4280 Use this if you have an EEPROM or similar serial access
4281 device and a driver for it.
4282
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004283 - CONFIG_ENV_OFFSET:
4284 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004285
4286 These two #defines specify the offset and size of the
4287 environment area within the total memory of your EEPROM.
4288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004289 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004290 If defined, specified the chip address of the EEPROM device.
4291 The default address is zero.
4292
Christian Gmeiner189d2572015-02-11 15:19:31 +01004293 - CONFIG_SYS_I2C_EEPROM_BUS:
4294 If defined, specified the i2c bus of the EEPROM device.
4295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004296 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004297 If defined, the number of bits used to address bytes in a
4298 single page in the EEPROM device. A 64 byte page, for example
4299 would require six bits.
4300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004301 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004302 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004303 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004305 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004306 The length in bytes of the EEPROM memory array address. Note
4307 that this is NOT the chip address length!
4308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004309 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004310 EEPROM chips that implement "address overflow" are ones
4311 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4312 address and the extra bits end up in the "chip address" bit
4313 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4314 byte chips.
4315
4316 Note that we consider the length of the address field to
4317 still be one byte because the extra address bits are hidden
4318 in the chip address.
4319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004320 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004321 The size in bytes of the EEPROM device.
4322
Heiko Schocher548738b2010-01-07 08:55:40 +01004323 - CONFIG_ENV_EEPROM_IS_ON_I2C
4324 define this, if you have I2C and SPI activated, and your
4325 EEPROM, which holds the environment, is on the I2C bus.
4326
4327 - CONFIG_I2C_ENV_EEPROM_BUS
4328 if you have an Environment on an EEPROM reached over
4329 I2C muxes, you can define here, how to reach this
4330 EEPROM. For example:
4331
Heiko Schocherea818db2013-01-29 08:53:15 +01004332 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004333
4334 EEPROM which holds the environment, is reached over
4335 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004336
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004337- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004338
wdenkd4ca31c2004-01-02 14:00:00 +00004339 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004340 want to use for the environment.
4341
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004342 - CONFIG_ENV_OFFSET:
4343 - CONFIG_ENV_ADDR:
4344 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004345
4346 These three #defines specify the offset and size of the
4347 environment area within the total memory of your DataFlash placed
4348 at the specified address.
4349
Wu, Joshbd83b592014-07-01 19:30:13 +08004350- CONFIG_ENV_IS_IN_SPI_FLASH:
4351
4352 Define this if you have a SPI Flash memory device which you
4353 want to use for the environment.
4354
4355 - CONFIG_ENV_OFFSET:
4356 - CONFIG_ENV_SIZE:
4357
4358 These two #defines specify the offset and size of the
4359 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4360 aligned to an erase sector boundary.
4361
4362 - CONFIG_ENV_SECT_SIZE:
4363
4364 Define the SPI flash's sector size.
4365
4366 - CONFIG_ENV_OFFSET_REDUND (optional):
4367
4368 This setting describes a second storage area of CONFIG_ENV_SIZE
4369 size used to hold a redundant copy of the environment data, so
4370 that there is a valid backup copy in case there is a power failure
4371 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4372 aligned to an erase sector boundary.
4373
4374 - CONFIG_ENV_SPI_BUS (optional):
4375 - CONFIG_ENV_SPI_CS (optional):
4376
4377 Define the SPI bus and chip select. If not defined they will be 0.
4378
4379 - CONFIG_ENV_SPI_MAX_HZ (optional):
4380
4381 Define the SPI max work clock. If not defined then use 1MHz.
4382
4383 - CONFIG_ENV_SPI_MODE (optional):
4384
4385 Define the SPI work mode. If not defined then use SPI_MODE_3.
4386
Liu Gang0a85a9e2012-03-08 00:33:20 +00004387- CONFIG_ENV_IS_IN_REMOTE:
4388
4389 Define this if you have a remote memory space which you
4390 want to use for the local device's environment.
4391
4392 - CONFIG_ENV_ADDR:
4393 - CONFIG_ENV_SIZE:
4394
4395 These two #defines specify the address and size of the
4396 environment area within the remote memory space. The
4397 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004398 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004399
4400BE CAREFUL! For some special cases, the local device can not use
4401"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004402environment stored in a remote NOR flash by SRIO or PCIE link,
4403but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004404
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004405- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004406
4407 Define this if you have a NAND device which you want to use
4408 for the environment.
4409
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004410 - CONFIG_ENV_OFFSET:
4411 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004412
4413 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004414 area within the first NAND device. CONFIG_ENV_OFFSET must be
4415 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004416
Scott Woodfdd813d2010-09-17 14:38:37 -05004417 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004418
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004419 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004420 size used to hold a redundant copy of the environment data, so
4421 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004422 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004423 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004424
Scott Woodfdd813d2010-09-17 14:38:37 -05004425 - CONFIG_ENV_RANGE (optional):
4426
4427 Specifies the length of the region in which the environment
4428 can be written. This should be a multiple of the NAND device's
4429 block size. Specifying a range with more erase blocks than
4430 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4431 the range to be avoided.
4432
4433 - CONFIG_ENV_OFFSET_OOB (optional):
4434
4435 Enables support for dynamically retrieving the offset of the
4436 environment from block zero's out-of-band data. The
4437 "nand env.oob" command can be used to record this offset.
4438 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4439 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004440
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004441- CONFIG_NAND_ENV_DST
4442
4443 Defines address in RAM to which the nand_spl code should copy the
4444 environment. If redundant environment is used, it will be copied to
4445 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4446
Joe Hershberger2b744332013-04-08 10:32:51 +00004447- CONFIG_ENV_IS_IN_UBI:
4448
4449 Define this if you have an UBI volume that you want to use for the
4450 environment. This has the benefit of wear-leveling the environment
4451 accesses, which is important on NAND.
4452
4453 - CONFIG_ENV_UBI_PART:
4454
4455 Define this to a string that is the mtd partition containing the UBI.
4456
4457 - CONFIG_ENV_UBI_VOLUME:
4458
4459 Define this to the name of the volume that you want to store the
4460 environment in.
4461
Joe Hershberger785881f2013-04-08 10:32:52 +00004462 - CONFIG_ENV_UBI_VOLUME_REDUND:
4463
4464 Define this to the name of another volume to store a second copy of
4465 the environment in. This will enable redundant environments in UBI.
4466 It is assumed that both volumes are in the same MTD partition.
4467
Joe Hershberger2b744332013-04-08 10:32:51 +00004468 - CONFIG_UBI_SILENCE_MSG
4469 - CONFIG_UBIFS_SILENCE_MSG
4470
4471 You will probably want to define these to avoid a really noisy system
4472 when storing the env in UBI.
4473
Wu, Joshd1db76f2014-06-24 17:31:03 +08004474- CONFIG_ENV_IS_IN_FAT:
4475 Define this if you want to use the FAT file system for the environment.
4476
4477 - FAT_ENV_INTERFACE:
4478
4479 Define this to a string that is the name of the block device.
4480
4481 - FAT_ENV_DEV_AND_PART:
4482
4483 Define this to a string to specify the partition of the device. It can
4484 be as following:
4485
4486 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4487 - "D:P": device D partition P. Error occurs if device D has no
4488 partition table.
4489 - "D:0": device D.
4490 - "D" or "D:": device D partition 1 if device D has partition
4491 table, or the whole device D if has no partition
4492 table.
4493 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004494 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004495 partition table then means device D.
4496
4497 - FAT_ENV_FILE:
4498
4499 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004500 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004501
4502 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004503 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004504
Stephen Warren06e4ae52013-06-11 15:14:00 -06004505- CONFIG_ENV_IS_IN_MMC:
4506
4507 Define this if you have an MMC device which you want to use for the
4508 environment.
4509
4510 - CONFIG_SYS_MMC_ENV_DEV:
4511
4512 Specifies which MMC device the environment is stored in.
4513
4514 - CONFIG_SYS_MMC_ENV_PART (optional):
4515
4516 Specifies which MMC partition the environment is stored in. If not
4517 set, defaults to partition 0, the user area. Common values might be
4518 1 (first MMC boot partition), 2 (second MMC boot partition).
4519
4520 - CONFIG_ENV_OFFSET:
4521 - CONFIG_ENV_SIZE:
4522
4523 These two #defines specify the offset and size of the environment
4524 area within the specified MMC device.
4525
Stephen Warren5c088ee2013-06-11 15:14:02 -06004526 If offset is positive (the usual case), it is treated as relative to
4527 the start of the MMC partition. If offset is negative, it is treated
4528 as relative to the end of the MMC partition. This can be useful if
4529 your board may be fitted with different MMC devices, which have
4530 different sizes for the MMC partitions, and you always want the
4531 environment placed at the very end of the partition, to leave the
4532 maximum possible space before it, to store other data.
4533
Stephen Warren06e4ae52013-06-11 15:14:00 -06004534 These two values are in units of bytes, but must be aligned to an
4535 MMC sector boundary.
4536
4537 - CONFIG_ENV_OFFSET_REDUND (optional):
4538
4539 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4540 hold a redundant copy of the environment data. This provides a
4541 valid backup copy in case the other copy is corrupted, e.g. due
4542 to a power failure during a "saveenv" operation.
4543
Stephen Warren5c088ee2013-06-11 15:14:02 -06004544 This value may also be positive or negative; this is handled in the
4545 same way as CONFIG_ENV_OFFSET.
4546
Stephen Warren06e4ae52013-06-11 15:14:00 -06004547 This value is also in units of bytes, but must also be aligned to
4548 an MMC sector boundary.
4549
4550 - CONFIG_ENV_SIZE_REDUND (optional):
4551
4552 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4553 set. If this value is set, it must be set to the same value as
4554 CONFIG_ENV_SIZE.
4555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004556- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004557
4558 Defines offset to the initial SPI buffer area in DPRAM. The
4559 area is used at an early stage (ROM part) if the environment
4560 is configured to reside in the SPI EEPROM: We need a 520 byte
4561 scratch DPRAM area. It is used between the two initialization
4562 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4563 to be a good choice since it makes it far enough from the
4564 start of the data area as well as from the stack pointer.
4565
Bruce Adlere881cb52007-11-02 13:15:42 -07004566Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004567has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004568created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004569until then to read environment variables.
4570
wdenk85ec0bc2003-03-31 16:34:49 +00004571The environment is protected by a CRC32 checksum. Before the monitor
4572is relocated into RAM, as a result of a bad CRC you will be working
4573with the compiled-in default environment - *silently*!!! [This is
4574necessary, because the first environment variable we need is the
4575"baudrate" setting for the console - if we have a bad CRC, we don't
4576have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004577
4578Note: once the monitor has been relocated, then it will complain if
4579the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004580use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004582- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004583 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004584
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004585 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004586 also needs to be defined.
4587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004588- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004589 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004590
Ron Madridf5675aa2009-02-18 14:30:44 -08004591- CONFIG_NS16550_MIN_FUNCTIONS:
4592 Define this if you desire to only have use of the NS16550_init
4593 and NS16550_putc functions for the serial driver located at
4594 drivers/serial/ns16550.c. This option is useful for saving
4595 space for already greatly restricted images, including but not
4596 limited to NAND_SPL configurations.
4597
Simon Glassb2b92f52012-11-30 13:01:18 +00004598- CONFIG_DISPLAY_BOARDINFO
4599 Display information about the board that U-Boot is running on
4600 when U-Boot starts up. The board function checkboard() is called
4601 to do this.
4602
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004603- CONFIG_DISPLAY_BOARDINFO_LATE
4604 Similar to the previous option, but display this information
4605 later, once stdio is running and output goes to the LCD, if
4606 present.
4607
Sascha Silbefeb85802013-08-11 16:40:43 +02004608- CONFIG_BOARD_SIZE_LIMIT:
4609 Maximum size of the U-Boot image. When defined, the
4610 build system checks that the actual size does not
4611 exceed it.
4612
wdenkc6097192002-11-03 00:24:07 +00004613Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004614---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004616- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004617 Cache Line Size of the CPU.
4618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004619- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004620 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004621
wdenk42d1f032003-10-15 23:53:47 +00004622 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4623 and RPXsuper) to be able to adjust the position of
4624 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004625
Timur Tabie46fedf2011-08-04 18:03:41 -05004626- CONFIG_SYS_CCSRBAR_DEFAULT:
4627 Default (power-on reset) physical address of CCSR on Freescale
4628 PowerPC SOCs.
4629
4630- CONFIG_SYS_CCSRBAR:
4631 Virtual address of CCSR. On a 32-bit build, this is typically
4632 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4633
4634 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4635 for cross-platform code that uses that macro instead.
4636
4637- CONFIG_SYS_CCSRBAR_PHYS:
4638 Physical address of CCSR. CCSR can be relocated to a new
4639 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004640 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004641 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4642 is typically relocated on 36-bit builds. It is recommended
4643 that this macro be defined via the _HIGH and _LOW macros:
4644
4645 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4646 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4647
4648- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004649 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4650 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004651 used in assembly code, so it must not contain typecasts or
4652 integer size suffixes (e.g. "ULL").
4653
4654- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4655 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4656 used in assembly code, so it must not contain typecasts or
4657 integer size suffixes (e.g. "ULL").
4658
4659- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4660 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4661 forced to a value that ensures that CCSR is not relocated.
4662
wdenk7f6c2cb2002-11-10 22:06:23 +00004663- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004664 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004665
4666 the default drive number (default value 0)
4667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004668 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004669
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004670 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004671 (default value 1)
4672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004673 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004674
wdenk43d96162003-03-06 00:02:04 +00004675 defines the offset of register from address. It
4676 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004677 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004678
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004679 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4680 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004681 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004683 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004684 fdc_hw_init() is called at the beginning of the FDC
4685 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004686 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004687 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004688
Macpaul Lin0abddf82011-04-11 20:45:32 +00004689- CONFIG_IDE_AHB:
4690 Most IDE controllers were designed to be connected with PCI
4691 interface. Only few of them were designed for AHB interface.
4692 When software is doing ATA command and data transfer to
4693 IDE devices through IDE-AHB controller, some additional
4694 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004695 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004697- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004698 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004699 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004701- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk7152b1d2003-09-05 23:19:14 +00004703 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004704 initial data and stack; please note that this must be
4705 writable memory that is working WITHOUT special
4706 initialization, i. e. you CANNOT use normal RAM which
4707 will become available only after programming the
4708 memory controller and running certain initialization
4709 sequences.
4710
4711 U-Boot uses the following memory types:
4712 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4713 - MPC824X: data cache
4714 - PPC4xx: data cache
4715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004716- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004717
4718 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4720 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004721 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004722 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004723 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4724 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4725 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004726
4727 Note:
4728 On the MPC824X (or other systems that use the data
4729 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004730 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004731 point to an otherwise UNUSED address space between
4732 the top of RAM and the start of the PCI space.
4733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004734- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004736- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004738- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004740- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004742- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004744- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004746- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004747 SDRAM timing
4748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004749- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004750 periodic timer for refresh
4751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004752- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004754- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4755 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4756 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4757 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004758 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4759
4760- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004761 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4762 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004763 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004765- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4766 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004767 Machine Mode Register and Memory Periodic Timer
4768 Prescaler definitions (SDRAM timing)
4769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004770- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004771 enable I2C microcode relocation patch (MPC8xx);
4772 define relocation offset in DPRAM [DSP2]
4773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004774- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004775 enable SMC microcode relocation patch (MPC8xx);
4776 define relocation offset in DPRAM [SMC1]
4777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004778- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004779 enable SPI microcode relocation patch (MPC8xx);
4780 define relocation offset in DPRAM [SCC4]
4781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004782- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004783 Use OSCM clock mode on MBX8xx board. Be careful,
4784 wrong setting might damage your board. Read
4785 doc/README.MBX before setting this variable!
4786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004787- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004788 Offset of the bootmode word in DPRAM used by post
4789 (Power On Self Tests). This definition overrides
4790 #define'd default value in commproc.h resp.
4791 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004793- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4794 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4795 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4796 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4797 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4798 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4799 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4800 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004801 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004802
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004803- CONFIG_PCI_DISABLE_PCIE:
4804 Disable PCI-Express on systems where it is supported but not
4805 required.
4806
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004807- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004808 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004809 Don't do any setup work, presumably because someone or
4810 something has already done it, and we don't need to do it
4811 a second time. Useful for platforms that are pre-booted
4812 by coreboot or similar.
4813
Gabor Juhos842033e2013-05-30 07:06:12 +00004814- CONFIG_PCI_INDIRECT_BRIDGE:
4815 Enable support for indirect PCI bridges.
4816
Kumar Galaa09b9b62010-12-30 12:09:53 -06004817- CONFIG_SYS_SRIO:
4818 Chip has SRIO or not
4819
4820- CONFIG_SRIO1:
4821 Board has SRIO 1 port available
4822
4823- CONFIG_SRIO2:
4824 Board has SRIO 2 port available
4825
Liu Gangc8b28152013-05-07 16:30:46 +08004826- CONFIG_SRIO_PCIE_BOOT_MASTER
4827 Board can support master function for Boot from SRIO and PCIE
4828
Kumar Galaa09b9b62010-12-30 12:09:53 -06004829- CONFIG_SYS_SRIOn_MEM_VIRT:
4830 Virtual Address of SRIO port 'n' memory region
4831
4832- CONFIG_SYS_SRIOn_MEM_PHYS:
4833 Physical Address of SRIO port 'n' memory region
4834
4835- CONFIG_SYS_SRIOn_MEM_SIZE:
4836 Size of SRIO port 'n' memory region
4837
Fabio Estevam66bd1842013-04-11 09:35:34 +00004838- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4839 Defined to tell the NAND controller that the NAND chip is using
4840 a 16 bit bus.
4841 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004842 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004843 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004844 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004845
4846- CONFIG_SYS_NDFC_EBC0_CFG
4847 Sets the EBC0_CFG register for the NDFC. If not defined
4848 a default value will be used.
4849
Ben Warrenbb99ad62006-09-07 16:50:54 -04004850- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004851 Get DDR timing information from an I2C EEPROM. Common
4852 with pluggable memory modules such as SODIMMs
4853
Ben Warrenbb99ad62006-09-07 16:50:54 -04004854 SPD_EEPROM_ADDRESS
4855 I2C address of the SPD EEPROM
4856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004857- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004858 If SPD EEPROM is on an I2C bus other than the first
4859 one, specify here. Note that the value must resolve
4860 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004861
York Sun1b3e3c42011-06-07 09:42:16 +08004862- CONFIG_SYS_DDR_RAW_TIMING
4863 Get DDR timing information from other than SPD. Common with
4864 soldered DDR chips onboard without SPD. DDR raw timing
4865 parameters are extracted from datasheet and hard-coded into
4866 header files or board specific files.
4867
York Sun6f5e1dc2011-09-16 13:21:35 -07004868- CONFIG_FSL_DDR_INTERACTIVE
4869 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4870
York Sune32d59a2015-01-06 13:18:55 -08004871- CONFIG_FSL_DDR_SYNC_REFRESH
4872 Enable sync of refresh for multiple controllers.
4873
York Sun4516ff82015-03-19 09:30:28 -07004874- CONFIG_FSL_DDR_BIST
4875 Enable built-in memory test for Freescale DDR controllers.
4876
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004877- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004878 Only for 83xx systems. If specified, then DDR should
4879 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004880
wdenkc26e4542004-04-18 10:13:26 +00004881- CONFIG_ETHER_ON_FEC[12]
4882 Define to enable FEC[12] on a 8xx series processor.
4883
4884- CONFIG_FEC[12]_PHY
4885 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004886 to the given FEC; i. e.
4887 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004888 means that the PHY with address 4 is connected to FEC1
4889
4890 When set to -1, means to probe for first available.
4891
4892- CONFIG_FEC[12]_PHY_NORXERR
4893 The PHY does not have a RXERR line (RMII only).
4894 (so program the FEC to ignore it).
4895
4896- CONFIG_RMII
4897 Enable RMII mode for all FECs.
4898 Note that this is a global option, we can't
4899 have one FEC in standard MII mode and another in RMII mode.
4900
wdenk5cf91d62004-04-23 20:32:05 +00004901- CONFIG_CRC32_VERIFY
4902 Add a verify option to the crc32 command.
4903 The syntax is:
4904
4905 => crc32 -v <address> <count> <crc32>
4906
4907 Where address/count indicate a memory area
4908 and crc32 is the correct crc32 which the
4909 area should have.
4910
wdenk56523f12004-07-11 17:40:54 +00004911- CONFIG_LOOPW
4912 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004913 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004914
stroese7b466642004-12-16 18:46:55 +00004915- CONFIG_MX_CYCLIC
4916 Add the "mdc" and "mwc" memory commands. These are cyclic
4917 "md/mw" commands.
4918 Examples:
4919
wdenkefe2a4d2004-12-16 21:44:03 +00004920 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004921 This command will print 4 bytes (10,11,12,13) each 500 ms.
4922
wdenkefe2a4d2004-12-16 21:44:03 +00004923 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004924 This command will write 12345678 to address 100 all 10 ms.
4925
wdenkefe2a4d2004-12-16 21:44:03 +00004926 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004927 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004928
wdenk8aa1a2d2005-04-04 12:44:11 +00004929- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004930 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004931 low level initializations (like setting up the memory
4932 controller) are omitted and/or U-Boot does not
4933 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004934
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004935 Normally this variable MUST NOT be defined. The only
4936 exception is when U-Boot is loaded (to RAM) by some
4937 other boot loader or by a debugger which performs
4938 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004939
Aneesh V401bb302011-07-13 05:11:07 +00004940- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004941 Modifies the behaviour of start.S when compiling a loader
4942 that is executed before the actual U-Boot. E.g. when
4943 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004944
Ying Zhang3aa29de2013-08-16 15:16:15 +08004945- CONFIG_TPL_BUILD
4946 Modifies the behaviour of start.S when compiling a loader
4947 that is executed after the SPL and before the actual U-Boot.
4948 It is loaded by the SPL.
4949
Ying Zhang5df572f2013-05-20 14:07:23 +08004950- CONFIG_SYS_MPC85XX_NO_RESETVEC
4951 Only for 85xx systems. If this variable is specified, the section
4952 .resetvec is not kept and the section .bootpg is placed in the
4953 previous 4k of the .text section.
4954
Simon Glass4213fc22013-02-24 17:33:14 +00004955- CONFIG_ARCH_MAP_SYSMEM
4956 Generally U-Boot (and in particular the md command) uses
4957 effective address. It is therefore not necessary to regard
4958 U-Boot address as virtual addresses that need to be translated
4959 to physical addresses. However, sandbox requires this, since
4960 it maintains its own little RAM buffer which contains all
4961 addressable memory. This option causes some memory accesses
4962 to be mapped through map_sysmem() / unmap_sysmem().
4963
Matthias Weisserd8834a12011-03-10 21:36:32 +00004964- CONFIG_USE_ARCH_MEMCPY
4965 CONFIG_USE_ARCH_MEMSET
4966 If these options are used a optimized version of memcpy/memset will
4967 be used if available. These functions may be faster under some
4968 conditions but may increase the binary size.
4969
Simon Glass588a13f2013-02-14 04:18:54 +00004970- CONFIG_X86_RESET_VECTOR
4971 If defined, the x86 reset vector code is included. This is not
4972 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004973
Mark Jacksonfc337052013-03-04 01:27:20 +00004974- CONFIG_SYS_MPUCLK
4975 Defines the MPU clock speed (in MHz).
4976
4977 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004978
Heiko Schocher16678eb2013-11-04 14:05:00 +01004979- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4980 Enables the RTC32K OSC on AM33xx based plattforms
4981
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004982- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4983 Option to disable subpage write in NAND driver
4984 driver that uses this:
4985 drivers/mtd/nand/davinci_nand.c
4986
Timur Tabif2717b42011-11-22 09:21:25 -06004987Freescale QE/FMAN Firmware Support:
4988-----------------------------------
4989
4990The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4991loading of "firmware", which is encoded in the QE firmware binary format.
4992This firmware often needs to be loaded during U-Boot booting, so macros
4993are used to identify the storage device (NOR flash, SPI, etc) and the address
4994within that device.
4995
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004996- CONFIG_SYS_FMAN_FW_ADDR
4997 The address in the storage device where the FMAN microcode is located. The
4998 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4999 is also specified.
5000
5001- CONFIG_SYS_QE_FW_ADDR
5002 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005003 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5004 is also specified.
5005
5006- CONFIG_SYS_QE_FMAN_FW_LENGTH
5007 The maximum possible size of the firmware. The firmware binary format
5008 has a field that specifies the actual size of the firmware, but it
5009 might not be possible to read any part of the firmware unless some
5010 local storage is allocated to hold the entire firmware first.
5011
5012- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5013 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5014 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5015 virtual address in NOR flash.
5016
5017- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5018 Specifies that QE/FMAN firmware is located in NAND flash.
5019 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5020
5021- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5022 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5023 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5024
5025- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5026 Specifies that QE/FMAN firmware is located on the primary SPI
5027 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5028
Liu Gang292dc6c2012-03-08 00:33:18 +00005029- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5030 Specifies that QE/FMAN firmware is located in the remote (master)
5031 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005032 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5033 window->master inbound window->master LAW->the ucode address in
5034 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005035
J. German Riverab940ca62014-06-23 15:15:55 -07005036Freescale Layerscape Management Complex Firmware Support:
5037---------------------------------------------------------
5038The Freescale Layerscape Management Complex (MC) supports the loading of
5039"firmware".
5040This firmware often needs to be loaded during U-Boot booting, so macros
5041are used to identify the storage device (NOR flash, SPI, etc) and the address
5042within that device.
5043
5044- CONFIG_FSL_MC_ENET
5045 Enable the MC driver for Layerscape SoCs.
5046
5047- CONFIG_SYS_LS_MC_FW_ADDR
5048 The address in the storage device where the firmware is located. The
5049 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5050 is also specified.
5051
5052- CONFIG_SYS_LS_MC_FW_LENGTH
5053 The maximum possible size of the firmware. The firmware binary format
5054 has a field that specifies the actual size of the firmware, but it
5055 might not be possible to read any part of the firmware unless some
5056 local storage is allocated to hold the entire firmware first.
5057
5058- CONFIG_SYS_LS_MC_FW_IN_NOR
5059 Specifies that MC firmware is located in NOR flash, mapped as
5060 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5061 virtual address in NOR flash.
5062
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05305063Freescale Layerscape Debug Server Support:
5064-------------------------------------------
5065The Freescale Layerscape Debug Server Support supports the loading of
5066"Debug Server firmware" and triggering SP boot-rom.
5067This firmware often needs to be loaded during U-Boot booting.
5068
5069- CONFIG_FSL_DEBUG_SERVER
5070 Enable the Debug Server for Layerscape SoCs.
5071
5072- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
5073 Define minimum DDR size required for debug server image
5074
5075- CONFIG_SYS_MEM_TOP_HIDE_MIN
5076 Define minimum DDR size to be hided from top of the DDR memory
5077
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02005078Reproducible builds
5079-------------------
5080
5081In order to achieve reproducible builds, timestamps used in the U-Boot build
5082process have to be set to a fixed value.
5083
5084This is done using the SOURCE_DATE_EPOCH environment variable.
5085SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5086option for U-Boot or an environment variable in U-Boot.
5087
5088SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5089
wdenkc6097192002-11-03 00:24:07 +00005090Building the Software:
5091======================
5092
Wolfgang Denk218ca722008-03-26 10:40:12 +01005093Building U-Boot has been tested in several native build environments
5094and in many different cross environments. Of course we cannot support
5095all possibly existing versions of cross development tools in all
5096(potentially obsolete) versions. In case of tool chain problems we
5097recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5098which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005099
Wolfgang Denk218ca722008-03-26 10:40:12 +01005100If you are not using a native environment, it is assumed that you
5101have GNU cross compiling tools available in your path. In this case,
5102you must set the environment variable CROSS_COMPILE in your shell.
5103Note that no changes to the Makefile or any other source files are
5104necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005105
Wolfgang Denk218ca722008-03-26 10:40:12 +01005106 $ CROSS_COMPILE=ppc_4xx-
5107 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005108
Peter Tyser2f8d3962009-03-13 18:54:51 -05005109Note: If you wish to generate Windows versions of the utilities in
5110 the tools directory you can use the MinGW toolchain
5111 (http://www.mingw.org). Set your HOST tools to the MinGW
5112 toolchain and execute 'make tools'. For example:
5113
5114 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5115
5116 Binaries such as tools/mkimage.exe will be created which can
5117 be executed on computers running Windows.
5118
Wolfgang Denk218ca722008-03-26 10:40:12 +01005119U-Boot is intended to be simple to build. After installing the
5120sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005121is done by typing:
5122
Holger Freytherab584d62014-08-04 09:26:05 +02005123 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005124
Holger Freytherab584d62014-08-04 09:26:05 +02005125where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005126rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005127
wdenk2729af92004-05-03 20:45:30 +00005128Note: for some board special configuration names may exist; check if
5129 additional information is available from the board vendor; for
5130 instance, the TQM823L systems are available without (standard)
5131 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005132 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005133
Holger Freytherab584d62014-08-04 09:26:05 +02005134 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005135 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005136
Holger Freytherab584d62014-08-04 09:26:05 +02005137 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005138 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk2729af92004-05-03 20:45:30 +00005140 etc.
wdenkc6097192002-11-03 00:24:07 +00005141
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk2729af92004-05-03 20:45:30 +00005143Finally, type "make all", and you should get some working U-Boot
5144images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk2729af92004-05-03 20:45:30 +00005146- "u-boot.bin" is a raw binary image
5147- "u-boot" is an image in ELF binary format
5148- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005149
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005150By default the build is performed locally and the objects are saved
5151in the source directory. One of the two methods can be used to change
5152this behavior and build U-Boot to some external directory:
5153
51541. Add O= to the make command line invocations:
5155
5156 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005157 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005158 make O=/tmp/build all
5159
Timo Ketolaadbba992014-11-06 14:39:05 +020051602. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005161
Timo Ketolaadbba992014-11-06 14:39:05 +02005162 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005163 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005164 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005165 make all
5166
Timo Ketolaadbba992014-11-06 14:39:05 +02005167Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005168variable.
5169
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171Please be aware that the Makefiles assume you are using GNU make, so
5172for instance on NetBSD you might need to use "gmake" instead of
5173native "make".
wdenkc6097192002-11-03 00:24:07 +00005174
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176If the system board that you have is not listed, then you will need
5177to port U-Boot to your hardware platform. To do this, follow these
5178steps:
wdenkc6097192002-11-03 00:24:07 +00005179
wdenk2729af92004-05-03 20:45:30 +000051801. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005181 "boards.cfg" file, using the existing entries as examples.
5182 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051832. Create a new directory to hold your board specific code. Add any
5184 files you need. In your board directory, you will need at least
5185 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51863. Create a new configuration file "include/configs/<board>.h" for
5187 your board
51883. If you're porting U-Boot to a new CPU, then also create a new
5189 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051904. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051915. Type "make", and you should get a working "u-boot.srec" file
5192 to be installed on your target system.
51936. Debug and solve any problems that might arise.
5194 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005195
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk2729af92004-05-03 20:45:30 +00005197Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5198==============================================================
wdenkc6097192002-11-03 00:24:07 +00005199
Wolfgang Denk218ca722008-03-26 10:40:12 +01005200If you have modified U-Boot sources (for instance added a new board
5201or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005202provide feedback to the other developers. The feedback normally takes
5203the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005204official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005205
Wolfgang Denk218ca722008-03-26 10:40:12 +01005206But before you submit such a patch, please verify that your modifi-
5207cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005208the supported boards compile WITHOUT ANY compiler warnings. To do so,
5209just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005210for ALL supported system. Be warned, this will take a while. You can
5211select which (cross) compiler to use by passing a `CROSS_COMPILE'
5212environment variable to the script, i. e. to use the ELDK cross tools
5213you can type
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk2729af92004-05-03 20:45:30 +00005215 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk2729af92004-05-03 20:45:30 +00005217or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005218
wdenk2729af92004-05-03 20:45:30 +00005219 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005220
Wolfgang Denk218ca722008-03-26 10:40:12 +01005221When using the MAKEALL script, the default behaviour is to build
5222U-Boot in the source directory. This location can be changed by
5223setting the BUILD_DIR environment variable. Also, for each target
5224built, the MAKEALL script saves two log files (<target>.ERR and
5225<target>.MAKEALL) in the <source dir>/LOG directory. This default
5226location can be changed by setting the MAKEALL_LOGDIR environment
5227variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005228
5229 export BUILD_DIR=/tmp/build
5230 export MAKEALL_LOGDIR=/tmp/log
5231 CROSS_COMPILE=ppc_8xx- MAKEALL
5232
Wolfgang Denk218ca722008-03-26 10:40:12 +01005233With the above settings build objects are saved in the /tmp/build,
5234log files are saved in the /tmp/log and the source tree remains clean
5235during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005236
5237
wdenk2729af92004-05-03 20:45:30 +00005238See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005239
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241Monitor Commands - Overview:
5242============================
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244go - start application at address 'addr'
5245run - run commands in an environment variable
5246bootm - boot application image from memory
5247bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005248bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005249tftpboot- boot image via network using TFTP protocol
5250 and env variables "ipaddr" and "serverip"
5251 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005252tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005253rarpboot- boot image via network using RARP/TFTP protocol
5254diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5255loads - load S-Record file over serial line
5256loadb - load binary file over serial line (kermit mode)
5257md - memory display
5258mm - memory modify (auto-incrementing)
5259nm - memory modify (constant address)
5260mw - memory write (fill)
5261cp - memory copy
5262cmp - memory compare
5263crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005264i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005265sspi - SPI utility commands
5266base - print or set address offset
5267printenv- print environment variables
5268setenv - set environment variables
5269saveenv - save environment variables to persistent storage
5270protect - enable or disable FLASH write protection
5271erase - erase FLASH memory
5272flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005273nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005274bdinfo - print Board Info structure
5275iminfo - print header information for application image
5276coninfo - print console devices and informations
5277ide - IDE sub-system
5278loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005279loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005280mtest - simple RAM test
5281icache - enable or disable instruction cache
5282dcache - enable or disable data cache
5283reset - Perform RESET of the CPU
5284echo - echo args to console
5285version - print monitor version
5286help - print online help
5287? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005288
wdenkc6097192002-11-03 00:24:07 +00005289
wdenk2729af92004-05-03 20:45:30 +00005290Monitor Commands - Detailed Description:
5291========================================
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk2729af92004-05-03 20:45:30 +00005293TODO.
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk2729af92004-05-03 20:45:30 +00005295For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005296
5297
wdenk2729af92004-05-03 20:45:30 +00005298Environment Variables:
5299======================
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301U-Boot supports user configuration using Environment Variables which
5302can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk2729af92004-05-03 20:45:30 +00005304Environment Variables are set using "setenv", printed using
5305"printenv", and saved to Flash using "saveenv". Using "setenv"
5306without a value can be used to delete a variable from the
5307environment. As long as you don't save the environment you are
5308working with an in-memory copy. In case the Flash area containing the
5309environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005310
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005311Some configuration options can be set using Environment Variables.
5312
5313List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk2729af92004-05-03 20:45:30 +00005315 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk2729af92004-05-03 20:45:30 +00005317 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk2729af92004-05-03 20:45:30 +00005319 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk2729af92004-05-03 20:45:30 +00005321 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk2729af92004-05-03 20:45:30 +00005323 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005324
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005325 bootm_low - Memory range available for image processing in the bootm
5326 command can be restricted. This variable is given as
5327 a hexadecimal number and defines lowest address allowed
5328 for use by the bootm command. See also "bootm_size"
5329 environment variable. Address defined by "bootm_low" is
5330 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005331 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5332 bootm_mapsize.
5333
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005334 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005335 This variable is given as a hexadecimal number and it
5336 defines the size of the memory region starting at base
5337 address bootm_low that is accessible by the Linux kernel
5338 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5339 as the default value if it is defined, and bootm_size is
5340 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005341
5342 bootm_size - Memory range available for image processing in the bootm
5343 command can be restricted. This variable is given as
5344 a hexadecimal number and defines the size of the region
5345 allowed for use by the bootm command. See also "bootm_low"
5346 environment variable.
5347
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005348 updatefile - Location of the software update file on a TFTP server, used
5349 by the automatic software update feature. Please refer to
5350 documentation in doc/README.update for more details.
5351
wdenk2729af92004-05-03 20:45:30 +00005352 autoload - if set to "no" (any string beginning with 'n'),
5353 "bootp" will just load perform a lookup of the
5354 configuration from the BOOTP server, but not try to
5355 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357 autostart - if set to "yes", an image loaded using the "bootp",
5358 "rarpboot", "tftpboot" or "diskboot" commands will
5359 be automatically started (by internally calling
5360 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk2729af92004-05-03 20:45:30 +00005362 If set to "no", a standalone image passed to the
5363 "bootm" command will be copied to the load address
5364 (and eventually uncompressed), but NOT be started.
5365 This can be used to load and uncompress arbitrary
5366 data.
wdenkc6097192002-11-03 00:24:07 +00005367
David A. Longa28afca2011-07-09 16:40:19 -04005368 fdt_high - if set this restricts the maximum address that the
5369 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005370 For example, if you have a system with 1 GB memory
5371 at physical address 0x10000000, while Linux kernel
5372 only recognizes the first 704 MB as low memory, you
5373 may need to set fdt_high as 0x3C000000 to have the
5374 device tree blob be copied to the maximum address
5375 of the 704 MB low memory, so that Linux kernel can
5376 access it during the boot procedure.
5377
David A. Longa28afca2011-07-09 16:40:19 -04005378 If this is set to the special value 0xFFFFFFFF then
5379 the fdt will not be copied at all on boot. For this
5380 to work it must reside in writable memory, have
5381 sufficient padding on the end of it for u-boot to
5382 add the information it needs into it, and the memory
5383 must be accessible by the kernel.
5384
Simon Glasseea63e02011-10-24 19:15:34 +00005385 fdtcontroladdr- if set this is the address of the control flattened
5386 device tree used by U-Boot when CONFIG_OF_CONTROL is
5387 defined.
5388
wdenk17ea1172004-06-06 21:51:03 +00005389 i2cfast - (PPC405GP|PPC405EP only)
5390 if set to 'y' configures Linux I2C driver for fast
5391 mode (400kHZ). This environment variable is used in
5392 initialization code. So, for changes to be effective
5393 it must be saved and board must be reset.
5394
wdenk2729af92004-05-03 20:45:30 +00005395 initrd_high - restrict positioning of initrd images:
5396 If this variable is not set, initrd images will be
5397 copied to the highest possible address in RAM; this
5398 is usually what you want since it allows for
5399 maximum initrd size. If for some reason you want to
5400 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005401 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005402 variable to a value of "no" or "off" or "0".
5403 Alternatively, you can set it to a maximum upper
5404 address to use (U-Boot will still check that it
5405 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005406
wdenk2729af92004-05-03 20:45:30 +00005407 For instance, when you have a system with 16 MB
5408 RAM, and want to reserve 4 MB from use by Linux,
5409 you can do this by adding "mem=12M" to the value of
5410 the "bootargs" variable. However, now you must make
5411 sure that the initrd image is placed in the first
5412 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416 If you set initrd_high to 0xFFFFFFFF, this is an
5417 indication to U-Boot that all addresses are legal
5418 for the Linux kernel, including addresses in flash
5419 memory. In this case U-Boot will NOT COPY the
5420 ramdisk at all. This may be useful to reduce the
5421 boot time on your system, but requires that this
5422 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005423
wdenk2729af92004-05-03 20:45:30 +00005424 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk2729af92004-05-03 20:45:30 +00005426 loadaddr - Default load address for commands like "bootp",
5427 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk2729af92004-05-03 20:45:30 +00005429 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk2729af92004-05-03 20:45:30 +00005431 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005434
wdenk2729af92004-05-03 20:45:30 +00005435 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk2729af92004-05-03 20:45:30 +00005437 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005438
Mike Frysingere2a53452011-10-02 10:01:27 +00005439 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005440
Mike Frysingere2a53452011-10-02 10:01:27 +00005441 ethact - controls which interface is currently active.
5442 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005443
Heiko Schocher48690d82010-07-20 17:45:02 +02005444 => setenv ethact FEC
5445 => ping 192.168.0.1 # traffic sent on FEC
5446 => setenv ethact SCC
5447 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005448
Matthias Fuchse1692572008-01-17 07:45:05 +01005449 ethrotate - When set to "no" U-Boot does not go through all
5450 available network interfaces.
5451 It just stays at the currently selected interface.
5452
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005453 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005454 either succeed or fail without retrying.
5455 When set to "once" the network operation will
5456 fail when all the available network interfaces
5457 are tried once without success.
5458 Useful on scripts which control the retry operation
5459 themselves.
wdenkc6097192002-11-03 00:24:07 +00005460
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005461 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005462
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005463 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005464 changing the console to be empty. If "yes" it will be
5465 made silent. If "no" it will not be made silent. If
5466 unset, then it will be made silent if the U-Boot console
5467 is silent.
5468
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005469 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005470 UDP source port.
5471
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005472 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005473 destination port instead of the Well Know Port 69.
5474
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005475 tftpblocksize - Block size to use for TFTP transfers; if not set,
5476 we use the TFTP server's default block size
5477
5478 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5479 seconds, minimum value is 1000 = 1 second). Defines
5480 when a packet is considered to be lost so it has to
5481 be retransmitted. The default is 5000 = 5 seconds.
5482 Lowering this value may make downloads succeed
5483 faster in networks with high packet loss rates or
5484 with unreliable TFTP servers.
5485
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005486 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5487 unit, minimum value = 0). Defines how many timeouts
5488 can happen during a single file transfer before that
5489 transfer is aborted. The default is 10, and 0 means
5490 'no timeouts allowed'. Increasing this value may help
5491 downloads succeed with high packet loss rates, or with
5492 unreliable TFTP servers or client hardware.
5493
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005494 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005495 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005496 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005497
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005498The following image location variables contain the location of images
5499used in booting. The "Image" column gives the role of the image and is
5500not an environment variable name. The other columns are environment
5501variable names. "File Name" gives the name of the file on a TFTP
5502server, "RAM Address" gives the location in RAM the image will be
5503loaded to, and "Flash Location" gives the image's address in NOR
5504flash or offset in NAND flash.
5505
5506*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005507boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005508boards use these variables for other purposes.
5509
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005510Image File Name RAM Address Flash Location
5511----- --------- ----------- --------------
5512u-boot u-boot u-boot_addr_r u-boot_addr
5513Linux kernel bootfile kernel_addr_r kernel_addr
5514device tree blob fdtfile fdt_addr_r fdt_addr
5515ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005516
wdenk2729af92004-05-03 20:45:30 +00005517The following environment variables may be used and automatically
5518updated by the network boot commands ("bootp" and "rarpboot"),
5519depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005520
wdenk2729af92004-05-03 20:45:30 +00005521 bootfile - see above
5522 dnsip - IP address of your Domain Name Server
5523 dnsip2 - IP address of your secondary Domain Name Server
5524 gatewayip - IP address of the Gateway (Router) to use
5525 hostname - Target hostname
5526 ipaddr - see above
5527 netmask - Subnet Mask
5528 rootpath - Pathname of the root filesystem on the NFS server
5529 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005530
wdenka3d991b2004-04-15 21:48:45 +00005531
wdenk2729af92004-05-03 20:45:30 +00005532There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk2729af92004-05-03 20:45:30 +00005534 serial# - contains hardware identification information such
5535 as type string and/or serial number
5536 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk2729af92004-05-03 20:45:30 +00005538These variables can be set only once (usually during manufacturing of
5539the board). U-Boot refuses to delete or overwrite these variables
5540once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005541
5542
wdenk2729af92004-05-03 20:45:30 +00005543Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk2729af92004-05-03 20:45:30 +00005545 ver - Contains the U-Boot version string as printed
5546 with the "version" command. This variable is
5547 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005548
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550Please note that changes to some configuration parameters may take
5551only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005552
stroesec1551ea2003-04-04 15:53:41 +00005553
Joe Hershberger170ab112012-12-11 22:16:24 -06005554Callback functions for environment variables:
5555---------------------------------------------
5556
5557For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005558when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005559be associated with arbitrary variables. On creation, overwrite, or
5560deletion, the callback will provide the opportunity for some side
5561effect to happen or for the change to be rejected.
5562
5563The callbacks are named and associated with a function using the
5564U_BOOT_ENV_CALLBACK macro in your board or driver code.
5565
5566These callbacks are associated with variables in one of two ways. The
5567static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5568in the board configuration to a string that defines a list of
5569associations. The list must be in the following format:
5570
5571 entry = variable_name[:callback_name]
5572 list = entry[,list]
5573
5574If the callback name is not specified, then the callback is deleted.
5575Spaces are also allowed anywhere in the list.
5576
5577Callbacks can also be associated by defining the ".callbacks" variable
5578with the same list format above. Any association in ".callbacks" will
5579override any association in the static list. You can define
5580CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005581".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005582
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005583If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5584regular expression. This allows multiple variables to be connected to
5585the same callback without explicitly listing them all out.
5586
Joe Hershberger170ab112012-12-11 22:16:24 -06005587
wdenk2729af92004-05-03 20:45:30 +00005588Command Line Parsing:
5589=====================
stroesec1551ea2003-04-04 15:53:41 +00005590
wdenk2729af92004-05-03 20:45:30 +00005591There are two different command line parsers available with U-Boot:
5592the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594Old, simple command line parser:
5595--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597- supports environment variables (through setenv / saveenv commands)
5598- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005599- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005600- special characters ('$', ';') can be escaped by prefixing with '\',
5601 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005602 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005603- You can also escape text by enclosing in single apostrophes, for example:
5604 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606Hush shell:
5607-----------
wdenkf07771c2003-05-28 08:06:31 +00005608
wdenk2729af92004-05-03 20:45:30 +00005609- similar to Bourne shell, with control structures like
5610 if...then...else...fi, for...do...done; while...do...done,
5611 until...do...done, ...
5612- supports environment ("global") variables (through setenv / saveenv
5613 commands) and local shell variables (through standard shell syntax
5614 "name=value"); only environment variables can be used with "run"
5615 command
wdenkf07771c2003-05-28 08:06:31 +00005616
wdenk2729af92004-05-03 20:45:30 +00005617General rules:
5618--------------
wdenkf07771c2003-05-28 08:06:31 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620(1) If a command line (or an environment variable executed by a "run"
5621 command) contains several commands separated by semicolon, and
5622 one of these commands fails, then the remaining commands will be
5623 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005626 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005627 command will cause "run" to terminate, i. e. the remaining
5628 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005629
wdenk2729af92004-05-03 20:45:30 +00005630Note for Redundant Ethernet Interfaces:
5631=======================================
wdenkf07771c2003-05-28 08:06:31 +00005632
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005633Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005634such configurations and is capable of automatic selection of a
5635"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005636
wdenk2729af92004-05-03 20:45:30 +00005637Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5638MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5639"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641If the network interface stores some valid MAC address (for instance
5642in SROM), this is used as default address if there is NO correspon-
5643ding setting in the environment; if the corresponding environment
5644variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005645
wdenk2729af92004-05-03 20:45:30 +00005646o If the SROM has a valid MAC address, and there is no address in the
5647 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649o If there is no valid address in the SROM, and a definition in the
5650 environment exists, then the value from the environment variable is
5651 used.
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk2729af92004-05-03 20:45:30 +00005653o If both the SROM and the environment contain a MAC address, and
5654 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk2729af92004-05-03 20:45:30 +00005656o If both the SROM and the environment contain a MAC address, and the
5657 addresses differ, the value from the environment is used and a
5658 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005659
wdenk2729af92004-05-03 20:45:30 +00005660o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005661 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5662 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005663
Ben Warrenecee9322010-04-26 11:11:46 -07005664If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005665will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005666may be skipped by setting the appropriate 'ethmacskip' environment variable.
5667The naming convention is as follows:
5668"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk2729af92004-05-03 20:45:30 +00005670Image Formats:
5671==============
wdenkc6097192002-11-03 00:24:07 +00005672
Marian Balakowicz3310c542008-03-12 12:13:13 +01005673U-Boot is capable of booting (and performing other auxiliary operations on)
5674images in two formats:
5675
5676New uImage format (FIT)
5677-----------------------
5678
5679Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5680to Flattened Device Tree). It allows the use of images with multiple
5681components (several kernels, ramdisks, etc.), with contents protected by
5682SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5683
5684
5685Old uImage format
5686-----------------
5687
5688Old image format is based on binary files which can be basically anything,
5689preceded by a special header; see the definitions in include/image.h for
5690details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5693 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005694 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5695 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5696 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005697* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005698 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5699 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005700* Compression Type (uncompressed, gzip, bzip2)
5701* Load Address
5702* Entry Point
5703* Image Name
5704* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk2729af92004-05-03 20:45:30 +00005706The header is marked by a special Magic Number, and both the header
5707and the data portions of the image are secured against corruption by
5708CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005709
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711Linux Support:
5712==============
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714Although U-Boot should support any OS or standalone application
5715easily, the main focus has always been on Linux during the design of
5716U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005717
wdenk2729af92004-05-03 20:45:30 +00005718U-Boot includes many features that so far have been part of some
5719special "boot loader" code within the Linux kernel. Also, any
5720"initrd" images to be used are no longer part of one big Linux image;
5721instead, kernel and "initrd" are separate images. This implementation
5722serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724- the same features can be used for other OS or standalone
5725 applications (for instance: using compressed images to reduce the
5726 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728- it becomes much easier to port new Linux kernel versions because
5729 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731- the same Linux kernel image can now be used with different "initrd"
5732 images; of course this also means that different kernel images can
5733 be run with the same "initrd". This makes testing easier (you don't
5734 have to build a new "zImage.initrd" Linux image when you just
5735 change a file in your "initrd"). Also, a field-upgrade of the
5736 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005737
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739Linux HOWTO:
5740============
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk2729af92004-05-03 20:45:30 +00005742Porting Linux to U-Boot based systems:
5743---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745U-Boot cannot save you from doing all the necessary modifications to
5746configure the Linux device drivers for use with your target hardware
5747(no, we don't intend to provide a full virtual machine interface to
5748Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005749
Stefan Roesea47a12b2010-04-15 16:07:28 +02005750But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752Just make sure your machine specific header file (for instance
5753include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005754Information structure as we define in include/asm-<arch>/u-boot.h,
5755and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005756as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005757
Simon Glass2eb31b12014-06-11 23:29:46 -06005758Note that U-Boot now has a driver model, a unified model for drivers.
5759If you are adding a new driver, plumb it into driver model. If there
5760is no uclass available, you are encouraged to create one. See
5761doc/driver-model.
5762
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764Configuring the Linux kernel:
5765-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk2729af92004-05-03 20:45:30 +00005767No specific requirements for U-Boot. Make sure you have some root
5768device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005769
wdenkc6097192002-11-03 00:24:07 +00005770
wdenk2729af92004-05-03 20:45:30 +00005771Building a Linux Image:
5772-----------------------
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk2729af92004-05-03 20:45:30 +00005774With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5775not used. If you use recent kernel source, a new build target
5776"uImage" will exist which automatically builds an image usable by
5777U-Boot. Most older kernels also have support for a "pImage" target,
5778which was introduced for our predecessor project PPCBoot and uses a
5779100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005780
wdenk2729af92004-05-03 20:45:30 +00005781Example:
wdenkc6097192002-11-03 00:24:07 +00005782
Holger Freytherab584d62014-08-04 09:26:05 +02005783 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005784 make oldconfig
5785 make dep
5786 make uImage
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk2729af92004-05-03 20:45:30 +00005788The "uImage" build target uses a special tool (in 'tools/mkimage') to
5789encapsulate a compressed Linux kernel image with header information,
5790CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk2729af92004-05-03 20:45:30 +00005794* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796 ${CROSS_COMPILE}-objcopy -O binary \
5797 -R .note -R .comment \
5798 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005801
wdenk2729af92004-05-03 20:45:30 +00005802 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk2729af92004-05-03 20:45:30 +00005804* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806 mkimage -A ppc -O linux -T kernel -C gzip \
5807 -a 0 -e 0 -n "Linux Kernel Image" \
5808 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005809
wdenk24ee89b2002-11-03 17:56:27 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811The "mkimage" tool can also be used to create ramdisk images for use
5812with U-Boot, either separated from the Linux kernel image, or
5813combined into one file. "mkimage" encapsulates the images with a 64
5814byte header containing information about target architecture,
5815operating system, image type, compression method, entry points, time
5816stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005817
wdenk2729af92004-05-03 20:45:30 +00005818"mkimage" can be called in two ways: to verify existing images and
5819print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005820
wdenk2729af92004-05-03 20:45:30 +00005821In the first form (with "-l" option) mkimage lists the information
5822contained in the header of an existing U-Boot image; this includes
5823checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005824
wdenk2729af92004-05-03 20:45:30 +00005825 tools/mkimage -l image
5826 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005827
wdenk2729af92004-05-03 20:45:30 +00005828The second form (with "-d" option) is used to build a U-Boot image
5829from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005830
wdenk2729af92004-05-03 20:45:30 +00005831 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5832 -n name -d data_file image
5833 -A ==> set architecture to 'arch'
5834 -O ==> set operating system to 'os'
5835 -T ==> set image type to 'type'
5836 -C ==> set compression type 'comp'
5837 -a ==> set load address to 'addr' (hex)
5838 -e ==> set entry point to 'ep' (hex)
5839 -n ==> set image name to 'name'
5840 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005841
wdenk69459792004-05-29 16:53:29 +00005842Right now, all Linux kernels for PowerPC systems use the same load
5843address (0x00000000), but the entry point address depends on the
5844kernel version:
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk2729af92004-05-03 20:45:30 +00005846- 2.2.x kernels have the entry point at 0x0000000C,
5847- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005848
wdenk2729af92004-05-03 20:45:30 +00005849So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk2729af92004-05-03 20:45:30 +00005851 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5852 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005853 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005854 > examples/uImage.TQM850L
5855 Image Name: 2.4.4 kernel for TQM850L
5856 Created: Wed Jul 19 02:34:59 2000
5857 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5858 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5859 Load Address: 0x00000000
5860 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005863
wdenk2729af92004-05-03 20:45:30 +00005864 -> tools/mkimage -l examples/uImage.TQM850L
5865 Image Name: 2.4.4 kernel for TQM850L
5866 Created: Wed Jul 19 02:34:59 2000
5867 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5868 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5869 Load Address: 0x00000000
5870 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005871
wdenk2729af92004-05-03 20:45:30 +00005872NOTE: for embedded systems where boot time is critical you can trade
5873speed for memory and install an UNCOMPRESSED image instead: this
5874needs more space in Flash, but boots much faster since it does not
5875need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005876
Stefan Roesea47a12b2010-04-15 16:07:28 +02005877 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005878 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5879 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005880 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005881 > examples/uImage.TQM850L-uncompressed
5882 Image Name: 2.4.4 kernel for TQM850L
5883 Created: Wed Jul 19 02:34:59 2000
5884 Image Type: PowerPC Linux Kernel Image (uncompressed)
5885 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5886 Load Address: 0x00000000
5887 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005888
wdenkc6097192002-11-03 00:24:07 +00005889
wdenk2729af92004-05-03 20:45:30 +00005890Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5891when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893 -> tools/mkimage -n 'Simple Ramdisk Image' \
5894 > -A ppc -O linux -T ramdisk -C gzip \
5895 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5896 Image Name: Simple Ramdisk Image
5897 Created: Wed Jan 12 14:01:50 2000
5898 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5899 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5900 Load Address: 0x00000000
5901 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005902
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005903The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5904option performs the converse operation of the mkimage's second form (the "-d"
5905option). Given an image built by mkimage, the dumpimage extracts a "data file"
5906from the image:
5907
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005908 tools/dumpimage -i image -T type -p position data_file
5909 -i ==> extract from the 'image' a specific 'data_file'
5910 -T ==> set image type to 'type'
5911 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005912
wdenkdb01a2e2004-04-15 23:14:49 +00005913
wdenk2729af92004-05-03 20:45:30 +00005914Installing a Linux Image:
5915-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005916
wdenk2729af92004-05-03 20:45:30 +00005917To downloading a U-Boot image over the serial (console) interface,
5918you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005919
wdenk2729af92004-05-03 20:45:30 +00005920 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005921
wdenk2729af92004-05-03 20:45:30 +00005922The 'objcopy' does not understand the information in the U-Boot
5923image header, so the resulting S-Record file will be relative to
5924address 0x00000000. To load it to a given address, you need to
5925specify the target address as 'offset' parameter with the 'loads'
5926command.
wdenkc6097192002-11-03 00:24:07 +00005927
wdenk2729af92004-05-03 20:45:30 +00005928Example: install the image to address 0x40100000 (which on the
5929TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005930
wdenk2729af92004-05-03 20:45:30 +00005931 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk2729af92004-05-03 20:45:30 +00005933 .......... done
5934 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk2729af92004-05-03 20:45:30 +00005936 => loads 40100000
5937 ## Ready for S-Record download ...
5938 ~>examples/image.srec
5939 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5940 ...
5941 15989 15990 15991 15992
5942 [file transfer complete]
5943 [connected]
5944 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005945
5946
wdenk2729af92004-05-03 20:45:30 +00005947You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005948this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005949corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005950
wdenk2729af92004-05-03 20:45:30 +00005951 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk2729af92004-05-03 20:45:30 +00005953 ## Checking Image at 40100000 ...
5954 Image Name: 2.2.13 for initrd on TQM850L
5955 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5956 Data Size: 335725 Bytes = 327 kB = 0 MB
5957 Load Address: 00000000
5958 Entry Point: 0000000c
5959 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005960
5961
wdenk2729af92004-05-03 20:45:30 +00005962Boot Linux:
5963-----------
wdenkc6097192002-11-03 00:24:07 +00005964
wdenk2729af92004-05-03 20:45:30 +00005965The "bootm" command is used to boot an application that is stored in
5966memory (RAM or Flash). In case of a Linux kernel image, the contents
5967of the "bootargs" environment variable is passed to the kernel as
5968parameters. You can check and modify this variable using the
5969"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005970
5971
wdenk2729af92004-05-03 20:45:30 +00005972 => printenv bootargs
5973 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005974
wdenk2729af92004-05-03 20:45:30 +00005975 => 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 +00005976
wdenk2729af92004-05-03 20:45:30 +00005977 => printenv bootargs
5978 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 +00005979
wdenk2729af92004-05-03 20:45:30 +00005980 => bootm 40020000
5981 ## Booting Linux kernel at 40020000 ...
5982 Image Name: 2.2.13 for NFS on TQM850L
5983 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5984 Data Size: 381681 Bytes = 372 kB = 0 MB
5985 Load Address: 00000000
5986 Entry Point: 0000000c
5987 Verifying Checksum ... OK
5988 Uncompressing Kernel Image ... OK
5989 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
5990 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5991 time_init: decrementer frequency = 187500000/60
5992 Calibrating delay loop... 49.77 BogoMIPS
5993 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5994 ...
wdenkc6097192002-11-03 00:24:07 +00005995
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005996If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005997the memory addresses of both the kernel and the initrd image (PPBCOOT
5998format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005999
wdenk2729af92004-05-03 20:45:30 +00006000 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006001
wdenk2729af92004-05-03 20:45:30 +00006002 ## Checking Image at 40100000 ...
6003 Image Name: 2.2.13 for initrd on TQM850L
6004 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6005 Data Size: 335725 Bytes = 327 kB = 0 MB
6006 Load Address: 00000000
6007 Entry Point: 0000000c
6008 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006009
wdenk2729af92004-05-03 20:45:30 +00006010 ## Checking Image at 40200000 ...
6011 Image Name: Simple Ramdisk Image
6012 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6013 Data Size: 566530 Bytes = 553 kB = 0 MB
6014 Load Address: 00000000
6015 Entry Point: 00000000
6016 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk2729af92004-05-03 20:45:30 +00006018 => bootm 40100000 40200000
6019 ## Booting Linux kernel at 40100000 ...
6020 Image Name: 2.2.13 for initrd on TQM850L
6021 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6022 Data Size: 335725 Bytes = 327 kB = 0 MB
6023 Load Address: 00000000
6024 Entry Point: 0000000c
6025 Verifying Checksum ... OK
6026 Uncompressing Kernel Image ... OK
6027 ## Loading RAMDisk Image at 40200000 ...
6028 Image Name: Simple Ramdisk Image
6029 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6030 Data Size: 566530 Bytes = 553 kB = 0 MB
6031 Load Address: 00000000
6032 Entry Point: 00000000
6033 Verifying Checksum ... OK
6034 Loading Ramdisk ... OK
6035 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
6036 Boot arguments: root=/dev/ram
6037 time_init: decrementer frequency = 187500000/60
6038 Calibrating delay loop... 49.77 BogoMIPS
6039 ...
6040 RAMDISK: Compressed image found at block 0
6041 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006042
wdenk2729af92004-05-03 20:45:30 +00006043 bash#
wdenkc6097192002-11-03 00:24:07 +00006044
Matthew McClintock02677682006-06-28 10:41:37 -05006045Boot Linux and pass a flat device tree:
6046-----------
6047
6048First, U-Boot must be compiled with the appropriate defines. See the section
6049titled "Linux Kernel Interface" above for a more in depth explanation. The
6050following is an example of how to start a kernel and pass an updated
6051flat device tree:
6052
6053=> print oftaddr
6054oftaddr=0x300000
6055=> print oft
6056oft=oftrees/mpc8540ads.dtb
6057=> tftp $oftaddr $oft
6058Speed: 1000, full duplex
6059Using TSEC0 device
6060TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6061Filename 'oftrees/mpc8540ads.dtb'.
6062Load address: 0x300000
6063Loading: #
6064done
6065Bytes transferred = 4106 (100a hex)
6066=> tftp $loadaddr $bootfile
6067Speed: 1000, full duplex
6068Using TSEC0 device
6069TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6070Filename 'uImage'.
6071Load address: 0x200000
6072Loading:############
6073done
6074Bytes transferred = 1029407 (fb51f hex)
6075=> print loadaddr
6076loadaddr=200000
6077=> print oftaddr
6078oftaddr=0x300000
6079=> bootm $loadaddr - $oftaddr
6080## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006081 Image Name: Linux-2.6.17-dirty
6082 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6083 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006084 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006085 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006086 Verifying Checksum ... OK
6087 Uncompressing Kernel Image ... OK
6088Booting using flat device tree at 0x300000
6089Using MPC85xx ADS machine description
6090Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6091[snip]
6092
6093
wdenk2729af92004-05-03 20:45:30 +00006094More About U-Boot Image Types:
6095------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006096
wdenk2729af92004-05-03 20:45:30 +00006097U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006098
wdenk2729af92004-05-03 20:45:30 +00006099 "Standalone Programs" are directly runnable in the environment
6100 provided by U-Boot; it is expected that (if they behave
6101 well) you can continue to work in U-Boot after return from
6102 the Standalone Program.
6103 "OS Kernel Images" are usually images of some Embedded OS which
6104 will take over control completely. Usually these programs
6105 will install their own set of exception handlers, device
6106 drivers, set up the MMU, etc. - this means, that you cannot
6107 expect to re-enter U-Boot except by resetting the CPU.
6108 "RAMDisk Images" are more or less just data blocks, and their
6109 parameters (address, size) are passed to an OS kernel that is
6110 being started.
6111 "Multi-File Images" contain several images, typically an OS
6112 (Linux) kernel image and one or more data images like
6113 RAMDisks. This construct is useful for instance when you want
6114 to boot over the network using BOOTP etc., where the boot
6115 server provides just a single image file, but you want to get
6116 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006117
wdenk2729af92004-05-03 20:45:30 +00006118 "Multi-File Images" start with a list of image sizes, each
6119 image size (in bytes) specified by an "uint32_t" in network
6120 byte order. This list is terminated by an "(uint32_t)0".
6121 Immediately after the terminating 0 follow the images, one by
6122 one, all aligned on "uint32_t" boundaries (size rounded up to
6123 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006124
wdenk2729af92004-05-03 20:45:30 +00006125 "Firmware Images" are binary images containing firmware (like
6126 U-Boot or FPGA images) which usually will be programmed to
6127 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006128
wdenk2729af92004-05-03 20:45:30 +00006129 "Script files" are command sequences that will be executed by
6130 U-Boot's command interpreter; this feature is especially
6131 useful when you configure U-Boot to use a real shell (hush)
6132 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006133
Marek Vasut44f074c2012-03-14 21:52:45 +00006134Booting the Linux zImage:
6135-------------------------
6136
6137On some platforms, it's possible to boot Linux zImage. This is done
6138using the "bootz" command. The syntax of "bootz" command is the same
6139as the syntax of "bootm" command.
6140
Tom Rini8ac28562013-05-16 11:40:11 -04006141Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006142kernel with raw initrd images. The syntax is slightly different, the
6143address of the initrd must be augmented by it's size, in the following
6144format: "<initrd addres>:<initrd size>".
6145
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk2729af92004-05-03 20:45:30 +00006147Standalone HOWTO:
6148=================
wdenkc6097192002-11-03 00:24:07 +00006149
wdenk2729af92004-05-03 20:45:30 +00006150One of the features of U-Boot is that you can dynamically load and
6151run "standalone" applications, which can use some resources of
6152U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006153
wdenk2729af92004-05-03 20:45:30 +00006154Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006155
wdenk2729af92004-05-03 20:45:30 +00006156"Hello World" Demo:
6157-------------------
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk2729af92004-05-03 20:45:30 +00006159'examples/hello_world.c' contains a small "Hello World" Demo
6160application; it is automatically compiled when you build U-Boot.
6161It's configured to run at address 0x00040004, so you can play with it
6162like that:
wdenkc6097192002-11-03 00:24:07 +00006163
wdenk2729af92004-05-03 20:45:30 +00006164 => loads
6165 ## Ready for S-Record download ...
6166 ~>examples/hello_world.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 Hello World! This is a test.
6173 ## Starting application at 0x00040004 ...
6174 Hello World
6175 argc = 7
6176 argv[0] = "40004"
6177 argv[1] = "Hello"
6178 argv[2] = "World!"
6179 argv[3] = "This"
6180 argv[4] = "is"
6181 argv[5] = "a"
6182 argv[6] = "test."
6183 argv[7] = "<NULL>"
6184 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006185
wdenk2729af92004-05-03 20:45:30 +00006186 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006187
wdenk2729af92004-05-03 20:45:30 +00006188Another example, which demonstrates how to register a CPM interrupt
6189handler with the U-Boot code, can be found in 'examples/timer.c'.
6190Here, a CPM timer is set up to generate an interrupt every second.
6191The interrupt service routine is trivial, just printing a '.'
6192character, but this is just a demo program. The application can be
6193controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk2729af92004-05-03 20:45:30 +00006195 ? - print current values og the CPM Timer registers
6196 b - enable interrupts and start timer
6197 e - stop timer and disable interrupts
6198 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006199
wdenk2729af92004-05-03 20:45:30 +00006200 => loads
6201 ## Ready for S-Record download ...
6202 ~>examples/timer.srec
6203 1 2 3 4 5 6 7 8 9 10 11 ...
6204 [file transfer complete]
6205 [connected]
6206 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk2729af92004-05-03 20:45:30 +00006208 => go 40004
6209 ## Starting application at 0x00040004 ...
6210 TIMERS=0xfff00980
6211 Using timer 1
6212 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006213
wdenk2729af92004-05-03 20:45:30 +00006214Hit 'b':
6215 [q, b, e, ?] Set interval 1000000 us
6216 Enabling timer
6217Hit '?':
6218 [q, b, e, ?] ........
6219 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6220Hit '?':
6221 [q, b, e, ?] .
6222 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6223Hit '?':
6224 [q, b, e, ?] .
6225 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6226Hit '?':
6227 [q, b, e, ?] .
6228 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6229Hit 'e':
6230 [q, b, e, ?] ...Stopping timer
6231Hit 'q':
6232 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006233
6234
wdenk2729af92004-05-03 20:45:30 +00006235Minicom warning:
6236================
wdenk85ec0bc2003-03-31 16:34:49 +00006237
wdenk2729af92004-05-03 20:45:30 +00006238Over time, many people have reported problems when trying to use the
6239"minicom" terminal emulation program for serial download. I (wd)
6240consider minicom to be broken, and recommend not to use it. Under
6241Unix, I recommend to use C-Kermit for general purpose use (and
6242especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006243use "cu" for S-Record download ("loads" command). See
6244http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6245for help with kermit.
6246
wdenk85ec0bc2003-03-31 16:34:49 +00006247
wdenk2729af92004-05-03 20:45:30 +00006248Nevertheless, if you absolutely want to use it try adding this
6249configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006250
wdenk2729af92004-05-03 20:45:30 +00006251 Name Program Name U/D FullScr IO-Red. Multi
6252 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6253 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006254
6255
wdenk2729af92004-05-03 20:45:30 +00006256NetBSD Notes:
6257=============
wdenkc6097192002-11-03 00:24:07 +00006258
wdenk2729af92004-05-03 20:45:30 +00006259Starting at version 0.9.2, U-Boot supports NetBSD both as host
6260(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006261
wdenk2729af92004-05-03 20:45:30 +00006262Building requires a cross environment; it is known to work on
6263NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6264need gmake since the Makefiles are not compatible with BSD make).
6265Note that the cross-powerpc package does not install include files;
6266attempting to build U-Boot will fail because <machine/ansi.h> is
6267missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006268
wdenk2729af92004-05-03 20:45:30 +00006269 # cd /usr/pkg/cross/powerpc-netbsd/include
6270 # mkdir powerpc
6271 # ln -s powerpc machine
6272 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6273 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006274
wdenk2729af92004-05-03 20:45:30 +00006275Native builds *don't* work due to incompatibilities between native
6276and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006277
wdenk2729af92004-05-03 20:45:30 +00006278Booting assumes that (the first part of) the image booted is a
6279stage-2 loader which in turn loads and then invokes the kernel
6280proper. Loader sources will eventually appear in the NetBSD source
6281tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006282meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006283
6284
wdenk2729af92004-05-03 20:45:30 +00006285Implementation Internals:
6286=========================
wdenkc6097192002-11-03 00:24:07 +00006287
wdenk2729af92004-05-03 20:45:30 +00006288The following is not intended to be a complete description of every
6289implementation detail. However, it should help to understand the
6290inner workings of U-Boot and make it easier to port it to custom
6291hardware.
wdenkc6097192002-11-03 00:24:07 +00006292
6293
wdenk2729af92004-05-03 20:45:30 +00006294Initial Stack, Global Data:
6295---------------------------
wdenkc6097192002-11-03 00:24:07 +00006296
wdenk2729af92004-05-03 20:45:30 +00006297The implementation of U-Boot is complicated by the fact that U-Boot
6298starts running out of ROM (flash memory), usually without access to
6299system RAM (because the memory controller is not initialized yet).
6300This means that we don't have writable Data or BSS segments, and BSS
6301is not initialized as zero. To be able to get a C environment working
6302at all, we have to allocate at least a minimal stack. Implementation
6303options for this are defined and restricted by the CPU used: Some CPU
6304models provide on-chip memory (like the IMMR area on MPC8xx and
6305MPC826x processors), on others (parts of) the data cache can be
6306locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006307
Wolfgang Denk218ca722008-03-26 10:40:12 +01006308 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006309 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006310
wdenk2729af92004-05-03 20:45:30 +00006311 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6312 From: "Chris Hallinan" <clh@net1plus.com>
6313 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6314 ...
wdenk43d96162003-03-06 00:02:04 +00006315
wdenk2729af92004-05-03 20:45:30 +00006316 Correct me if I'm wrong, folks, but the way I understand it
6317 is this: Using DCACHE as initial RAM for Stack, etc, does not
6318 require any physical RAM backing up the cache. The cleverness
6319 is that the cache is being used as a temporary supply of
6320 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006321 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006322 can see how this works by studying the cache architecture and
6323 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006324
wdenk2729af92004-05-03 20:45:30 +00006325 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6326 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006327 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006328 option should work for you. Using CS 4 should be fine if your
6329 board designers haven't used it for something that would
6330 cause you grief during the initial boot! It is frequently not
6331 used.
wdenk43d96162003-03-06 00:02:04 +00006332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006333 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006334 with your processor/board/system design. The default value
6335 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006336 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006337 than your SDRAM module. If you have a 64MB SDRAM module, set
6338 it above 400_0000. Just make sure your board has no resources
6339 that are supposed to respond to that address! That code in
6340 start.S has been around a while and should work as is when
6341 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006342
wdenk2729af92004-05-03 20:45:30 +00006343 -Chris Hallinan
6344 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006345
wdenk2729af92004-05-03 20:45:30 +00006346It is essential to remember this, since it has some impact on the C
6347code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006348
wdenk2729af92004-05-03 20:45:30 +00006349* Initialized global data (data segment) is read-only. Do not attempt
6350 to write it.
wdenkc6097192002-11-03 00:24:07 +00006351
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006352* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006353 as zero data - BSS segment) at all - this is undefined, initiali-
6354 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006355
wdenk2729af92004-05-03 20:45:30 +00006356* Stack space is very limited. Avoid big data buffers or things like
6357 that.
wdenkc6097192002-11-03 00:24:07 +00006358
wdenk2729af92004-05-03 20:45:30 +00006359Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006360normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006361turned out that the implementation of U-Boot can be greatly
6362simplified by making a global data structure (gd_t) available to all
6363functions. We could pass a pointer to this data as argument to _all_
6364functions, but this would bloat the code. Instead we use a feature of
6365the GCC compiler (Global Register Variables) to share the data: we
6366place a pointer (gd) to the global data into a register which we
6367reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006368
wdenk2729af92004-05-03 20:45:30 +00006369When choosing a register for such a purpose we are restricted by the
6370relevant (E)ABI specifications for the current architecture, and by
6371GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006372
wdenk2729af92004-05-03 20:45:30 +00006373For PowerPC, the following registers have specific use:
6374 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006375 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006376 R3-R4: parameter passing and return values
6377 R5-R10: parameter passing
6378 R13: small data area pointer
6379 R30: GOT pointer
6380 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006381
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006382 (U-Boot also uses R12 as internal GOT pointer. r12
6383 is a volatile register so r12 needs to be reset when
6384 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006385
Wolfgang Denke7670f62008-02-14 22:43:22 +01006386 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006387
wdenk2729af92004-05-03 20:45:30 +00006388 Note: on PPC, we could use a static initializer (since the
6389 address of the global data structure is known at compile time),
6390 but it turned out that reserving a register results in somewhat
6391 smaller code - although the code savings are not that big (on
6392 average for all boards 752 bytes for the whole U-Boot image,
6393 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006394
Robin Getzc4db3352009-08-17 15:23:02 +00006395On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006396 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6397
Robin Getzc4db3352009-08-17 15:23:02 +00006398 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006399
wdenk2729af92004-05-03 20:45:30 +00006400On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006401
wdenk2729af92004-05-03 20:45:30 +00006402 R0: function argument word/integer result
6403 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006404 R9: platform specific
6405 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006406 R11: argument (frame) pointer
6407 R12: temporary workspace
6408 R13: stack pointer
6409 R14: link register
6410 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006411
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006412 ==> U-Boot will use R9 to hold a pointer to the global data
6413
6414 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006415
Thomas Chou0df01fd2010-05-21 11:08:03 +08006416On Nios II, the ABI is documented here:
6417 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6418
6419 ==> U-Boot will use gp to hold a pointer to the global data
6420
6421 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6422 to access small data sections, so gp is free.
6423
Macpaul Linafc1ce82011-10-19 20:41:11 +00006424On NDS32, the following registers are used:
6425
6426 R0-R1: argument/return
6427 R2-R5: argument
6428 R15: temporary register for assembler
6429 R16: trampoline register
6430 R28: frame pointer (FP)
6431 R29: global pointer (GP)
6432 R30: link register (LP)
6433 R31: stack pointer (SP)
6434 PC: program counter (PC)
6435
6436 ==> U-Boot will use R10 to hold a pointer to the global data
6437
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006438NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6439or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk2729af92004-05-03 20:45:30 +00006441Memory Management:
6442------------------
wdenkc6097192002-11-03 00:24:07 +00006443
wdenk2729af92004-05-03 20:45:30 +00006444U-Boot runs in system state and uses physical addresses, i.e. the
6445MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006446
wdenk2729af92004-05-03 20:45:30 +00006447The available memory is mapped to fixed addresses using the memory
6448controller. In this process, a contiguous block is formed for each
6449memory type (Flash, SDRAM, SRAM), even when it consists of several
6450physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006451
wdenk2729af92004-05-03 20:45:30 +00006452U-Boot is installed in the first 128 kB of the first Flash bank (on
6453TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6454booting and sizing and initializing DRAM, the code relocates itself
6455to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006456memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006457configuration setting]. Below that, a structure with global Board
6458Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006459
wdenk2729af92004-05-03 20:45:30 +00006460Additionally, some exception handler code is copied to the low 8 kB
6461of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006462
wdenk2729af92004-05-03 20:45:30 +00006463So a typical memory configuration with 16 MB of DRAM could look like
6464this:
wdenkc6097192002-11-03 00:24:07 +00006465
wdenk2729af92004-05-03 20:45:30 +00006466 0x0000 0000 Exception Vector code
6467 :
6468 0x0000 1FFF
6469 0x0000 2000 Free for Application Use
6470 :
6471 :
wdenkc6097192002-11-03 00:24:07 +00006472
wdenk2729af92004-05-03 20:45:30 +00006473 :
6474 :
6475 0x00FB FF20 Monitor Stack (Growing downward)
6476 0x00FB FFAC Board Info Data and permanent copy of global data
6477 0x00FC 0000 Malloc Arena
6478 :
6479 0x00FD FFFF
6480 0x00FE 0000 RAM Copy of Monitor Code
6481 ... eventually: LCD or video framebuffer
6482 ... eventually: pRAM (Protected RAM - unchanged by reset)
6483 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006484
6485
wdenk2729af92004-05-03 20:45:30 +00006486System Initialization:
6487----------------------
wdenkc6097192002-11-03 00:24:07 +00006488
wdenk2729af92004-05-03 20:45:30 +00006489In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006490(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006491configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006492To be able to re-map memory U-Boot then jumps to its link address.
6493To be able to implement the initialization code in C, a (small!)
6494initial stack is set up in the internal Dual Ported RAM (in case CPUs
6495which provide such a feature like MPC8xx or MPC8260), or in a locked
6496part of the data cache. After that, U-Boot initializes the CPU core,
6497the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006498
wdenk2729af92004-05-03 20:45:30 +00006499Next, all (potentially) available memory banks are mapped using a
6500preliminary mapping. For example, we put them on 512 MB boundaries
6501(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6502on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6503programmed for SDRAM access. Using the temporary configuration, a
6504simple memory test is run that determines the size of the SDRAM
6505banks.
wdenkc6097192002-11-03 00:24:07 +00006506
wdenk2729af92004-05-03 20:45:30 +00006507When there is more than one SDRAM bank, and the banks are of
6508different size, the largest is mapped first. For equal size, the first
6509bank (CS2#) is mapped first. The first mapping is always for address
65100x00000000, with any additional banks following immediately to create
6511contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006512
wdenk2729af92004-05-03 20:45:30 +00006513Then, the monitor installs itself at the upper end of the SDRAM area
6514and allocates memory for use by malloc() and for the global Board
6515Info data; also, the exception vector code is copied to the low RAM
6516pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006517
wdenk2729af92004-05-03 20:45:30 +00006518Only after this relocation will you have a "normal" C environment;
6519until that you are restricted in several ways, mostly because you are
6520running from ROM, and because the code will have to be relocated to a
6521new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006522
6523
wdenk2729af92004-05-03 20:45:30 +00006524U-Boot Porting Guide:
6525----------------------
wdenkc6097192002-11-03 00:24:07 +00006526
wdenk2729af92004-05-03 20:45:30 +00006527[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6528list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006529
6530
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006531int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006532{
6533 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006534
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006535 signal(SIGALRM, no_more_time);
6536 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006537
wdenk2729af92004-05-03 20:45:30 +00006538 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006539 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006540 return 0;
6541 }
6542
wdenk2729af92004-05-03 20:45:30 +00006543 Download latest U-Boot source;
6544
Wolfgang Denk06682362008-12-30 22:56:11 +01006545 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006546
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006547 if (clueless)
6548 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006549
wdenk2729af92004-05-03 20:45:30 +00006550 while (learning) {
6551 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006552 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6553 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006554 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006555 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006556 }
wdenkc6097192002-11-03 00:24:07 +00006557
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006558 if (available_money > toLocalCurrency ($2500))
6559 Buy a BDI3000;
6560 else
wdenk2729af92004-05-03 20:45:30 +00006561 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006562
6563 if (a similar board exists) { /* hopefully... */
6564 cp -a board/<similar> board/<myboard>
6565 cp include/configs/<similar>.h include/configs/<myboard>.h
6566 } else {
6567 Create your own board support subdirectory;
6568 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006569 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006570 Edit new board/<myboard> files
6571 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006572
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006573 while (!accepted) {
6574 while (!running) {
6575 do {
6576 Add / modify source code;
6577 } until (compiles);
6578 Debug;
6579 if (clueless)
6580 email("Hi, I am having problems...");
6581 }
6582 Send patch file to the U-Boot email list;
6583 if (reasonable critiques)
6584 Incorporate improvements from email list code review;
6585 else
6586 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006587 }
wdenkc6097192002-11-03 00:24:07 +00006588
wdenk2729af92004-05-03 20:45:30 +00006589 return 0;
6590}
6591
6592void no_more_time (int sig)
6593{
6594 hire_a_guru();
6595}
wdenkc6097192002-11-03 00:24:07 +00006596
6597
wdenk2729af92004-05-03 20:45:30 +00006598Coding Standards:
6599-----------------
wdenkc6097192002-11-03 00:24:07 +00006600
wdenk2729af92004-05-03 20:45:30 +00006601All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006602coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006603"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006604
Detlev Zundel2c051652006-09-01 15:39:02 +02006605Source files originating from a different project (for example the
6606MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006607reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006608sources.
6609
6610Please note that U-Boot is implemented in C (and to some small parts in
6611Assembler); no C++ is used, so please do not use C++ style comments (//)
6612in your code.
wdenk2729af92004-05-03 20:45:30 +00006613
6614Please also stick to the following formatting rules:
6615- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006616- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006617- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006618- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006619- do not add trailing empty lines to source files
6620
6621Submissions which do not conform to the standards may be returned
6622with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006623
6624
wdenk2729af92004-05-03 20:45:30 +00006625Submitting Patches:
6626-------------------
wdenkc6097192002-11-03 00:24:07 +00006627
wdenk2729af92004-05-03 20:45:30 +00006628Since the number of patches for U-Boot is growing, we need to
6629establish some rules. Submissions which do not conform to these rules
6630may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006631
Magnus Lilja0d28f342008-08-06 19:32:33 +02006632Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006633
Wolfgang Denk06682362008-12-30 22:56:11 +01006634Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6635see http://lists.denx.de/mailman/listinfo/u-boot
6636
wdenk2729af92004-05-03 20:45:30 +00006637When you send a patch, please include the following information with
6638it:
wdenkc6097192002-11-03 00:24:07 +00006639
wdenk2729af92004-05-03 20:45:30 +00006640* For bug fixes: a description of the bug and how your patch fixes
6641 this bug. Please try to include a way of demonstrating that the
6642 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006643
wdenk2729af92004-05-03 20:45:30 +00006644* For new features: a description of the feature and your
6645 implementation.
wdenkc6097192002-11-03 00:24:07 +00006646
wdenk2729af92004-05-03 20:45:30 +00006647* A CHANGELOG entry as plaintext (separate from the patch)
6648
6649* For major contributions, your entry to the CREDITS file
6650
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006651* When you add support for a new board, don't forget to add a
6652 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006653
6654* If your patch adds new configuration options, don't forget to
6655 document these in the README file.
6656
Wolfgang Denk218ca722008-03-26 10:40:12 +01006657* The patch itself. If you are using git (which is *strongly*
6658 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006659 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006660 the U-Boot mailing list, you will avoid most of the common problems
6661 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006662
Wolfgang Denk218ca722008-03-26 10:40:12 +01006663 If you cannot use git, use "diff -purN OLD NEW". If your version of
6664 diff does not support these options, then get the latest version of
6665 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006666
Wolfgang Denk218ca722008-03-26 10:40:12 +01006667 The current directory when running this command shall be the parent
6668 directory of the U-Boot source tree (i. e. please make sure that
6669 your patch includes sufficient directory information for the
6670 affected files).
6671
6672 We prefer patches as plain text. MIME attachments are discouraged,
6673 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006674
6675* If one logical set of modifications affects or creates several
6676 files, all these changes shall be submitted in a SINGLE patch file.
6677
6678* Changesets that contain different, unrelated modifications shall be
6679 submitted as SEPARATE patches, one patch per changeset.
6680
6681
6682Notes:
6683
6684* Before sending the patch, run the MAKEALL script on your patched
6685 source tree and make sure that no errors or warnings are reported
6686 for any of the boards.
6687
6688* Keep your modifications to the necessary minimum: A patch
6689 containing several unrelated changes or arbitrary reformats will be
6690 returned with a request to re-formatting / split it.
6691
6692* If you modify existing code, make sure that your new code does not
6693 add to the memory footprint of the code ;-) Small is beautiful!
6694 When adding new features, these should compile conditionally only
6695 (using #ifdef), and the resulting code with the new feature
6696 disabled must not need more memory than the old code without your
6697 modification.
wdenk90dc6702005-05-03 14:12:25 +00006698
Wolfgang Denk06682362008-12-30 22:56:11 +01006699* Remember that there is a size limit of 100 kB per message on the
6700 u-boot mailing list. Bigger patches will be moderated. If they are
6701 reasonable and not too big, they will be acknowledged. But patches
6702 bigger than the size limit should be avoided.