blob: a0b6c89ae579ce8903c7c3b955801d675cab24ff [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-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 Denk1234ce72013-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
wdenkce4832c2004-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 ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-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
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-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 Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500184 /cpu CPU specific files
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-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-VILLARD03836942008-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 Freyther7ba4e572014-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 Freyther7ba4e572014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-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 Glass53552c92014-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 Teki287314f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600274
275
Simon Glassd8711af2015-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000364
Kim Phillips203fee32007-08-10 13:28:25 -0500365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200388 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000389 a "rotator" |\-/|\-/
390
Lei Wen20014762011-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200396- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000407 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000408 See doc/README.MPC866
409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200410 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000411
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200417 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000418
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600424- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Kushwahaa6a30622012-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 Wood80806962012-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 Kushwahad324f472013-04-16 13:27:44 +0530471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800473 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530474
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800477 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530478
Scott Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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 Yuantiana7364af2014-04-17 15:33:46 +0800508 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800509 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800510 supported, core will start to execute uboot when wakes up.
511
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000512- Generic CPU options:
York Sun021d2022014-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 Schwierzeckd8a49ca2012-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 Sunf0626592013-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 Sun2896cb72014-03-27 17:54:47 -0700545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
York Sun461c9392013-09-30 14:20:51 -0700548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
York Sunf0626592013-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 Sun2896cb72014-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 Sunf0626592013-09-30 09:22:09 -0700572
Prabhakar Kushwaha62908c22014-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 Kushwaha950f2f72014-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 Kushwaha2c27f122014-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 Sun29647ab2014-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 Sun3a0916d2014-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 Sunc459ae62014-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 Sun79a779b2014-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 Guptabb7143b2014-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 Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100620- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-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-VILLARD03836942008-10-16 15:01:15 +0200627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200628
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200631 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100632 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200633
Daniel Schwierzeckd52a6232011-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 Riesch48c2d6d2012-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 Vb8e40802012-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 Warrenc63c3502013-03-04 13:29:40 +0000680 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500684 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100685 CONFIG_ARM_ERRATA_773022
686 CONFIG_ARM_ERRATA_774769
687 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-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 Sun77a10972015-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 Menonaa0294e2015-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 Menon3f445112015-03-09 17:12:01 -0500706 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500707 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500708 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500709 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500710 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500711
Stephen Warren8d1fb312015-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000733 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
734
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800735 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400739 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200740
741 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500748 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400749
Marcel Ziswilerb29bc712009-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 Denk27a5b0b2005-10-13 01:45:54 +0200754 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600755 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200756
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200757 boards with QUICC Engines require OF_QE to set UCC MAC
758 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500759
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000764
Simon Glass6c0be912014-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 McClintockefae4ca2006-06-28 10:41:37 -0500772 CONFIG_OF_BOOT_CPU
773
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200774 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500775 param header, the default value is zero if undefined.
776
Heiko Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-11-03 22:13:47 +0100796- vxWorks boot parameters:
797
798 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700799 environments variables: bootdev, bootfile, ipaddr, netmask,
800 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100801 It loads the vxWorks image pointed bootfile.
802
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100803 Note: If a "bootargs" environment is defined, it will overwride
804 the defaults discussed just above.
805
Aneesh V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000817- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200818 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000819
820 Define this if you want support for Amba PrimeCell PL010 UARTs.
821
Andreas Engel0813b122008-09-08 14:30:53 +0200822 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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, Muralidharancbc08882014-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
wdenkda04a8b2004-08-02 23:22:59 +0000841
wdenkc6097192002-11-03 00:24:07 +0000842- Console Interface:
wdenk4a5c8a72003-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 Denkf6e50a42011-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)
wdenk544e9732004-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)
wdenk544e9732004-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)
wdenkc6097192002-11-03 00:24:07 +0000875 CONFIG_VIDEO_LOGO display Linux logo in
876 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000877 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
878 linux_logo.h for logo.
879 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000880 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200881 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000882 the logo
883
Pali Rohár4a57da32012-10-19 13:30:09 +0000884 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
885 a limited number of ANSI escape sequences (cursor control,
886 erase functions and limited graphics rendition control).
887
wdenk4a5c8a72003-03-06 00:02:04 +0000888 When CONFIG_CFB_CONSOLE is defined, video console is
889 default i/o. Serial console can be forced with
890 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000891
wdenk1ebf41e2004-01-02 14:00:00 +0000892 When CONFIG_SILENT_CONSOLE is defined, all console
893 messages (by U-Boot and Linux!) can be silenced with
894 the "silent" environment variable. See
895 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000896
Heiko Schocher62759562013-10-22 11:06:06 +0200897 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
898 is 0x00.
899 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
900 is 0xa0.
901
wdenkc6097192002-11-03 00:24:07 +0000902- Console Baudrate:
903 CONFIG_BAUDRATE - in bps
904 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200905 CONFIG_SYS_BAUDRATE_TABLE, see below.
906 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000907
Heiko Schocher327480a2009-01-30 12:55:38 +0100908- Console Rx buffer length
909 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
910 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100911 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100912 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
913 must be defined, to setup the maximum idle timeout for
914 the SMC.
915
Graeme Russ3c28f482011-09-01 00:48:27 +0000916- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200917 Prior to the console being initialised (i.e. serial UART
918 initialised etc) all console output is silently discarded.
919 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
920 buffer any console messages prior to the console being
921 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
922 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
923 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200924 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200925 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000926
Hans de Goedee355da02015-05-05 13:13:36 +0200927 Note that when printing the buffer a copy is made on the
928 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
929
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200930 'Sane' compilers will generate smaller code if
931 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000932
Sonny Raocd55bde2011-11-02 09:52:08 +0000933- Safe printf() functions
934 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
935 the printf() functions. These are defined in
936 include/vsprintf.h and include snprintf(), vsnprintf() and
937 so on. Code size increase is approximately 300-500 bytes.
938 If this option is not given then these functions will
939 silently discard their buffer size argument - this means
940 you are not getting any overflow checking in this case.
941
wdenkc6097192002-11-03 00:24:07 +0000942- Boot Delay: CONFIG_BOOTDELAY - in seconds
943 Delay before automatically booting the default image;
944 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000945 set to -2 to autoboot with no delay and not check for abort
946 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000947
948 See doc/README.autoboot for these options that
949 work with CONFIG_BOOTDELAY. None are required.
950 CONFIG_BOOT_RETRY_TIME
951 CONFIG_BOOT_RETRY_MIN
952 CONFIG_AUTOBOOT_KEYED
953 CONFIG_AUTOBOOT_PROMPT
954 CONFIG_AUTOBOOT_DELAY_STR
955 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000956 CONFIG_ZERO_BOOTDELAY_CHECK
957 CONFIG_RESET_TO_RETRY
958
959- Autoboot Command:
960 CONFIG_BOOTCOMMAND
961 Only needed when CONFIG_BOOTDELAY is enabled;
962 define a command string that is automatically executed
963 when no character is read on the console interface
964 within "Boot Delay" after reset.
965
966 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000967 This can be used to pass arguments to the bootm
968 command. The value of CONFIG_BOOTARGS goes into the
969 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000970
971 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000972 The value of these goes into the environment as
973 "ramboot" and "nfsboot" respectively, and can be used
974 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200975 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000976
Heiko Schocher040c5c32013-11-04 14:04:59 +0100977- Bootcount:
978 CONFIG_BOOTCOUNT_LIMIT
979 Implements a mechanism for detecting a repeating reboot
980 cycle, see:
981 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
982
983 CONFIG_BOOTCOUNT_ENV
984 If no softreset save registers are found on the hardware
985 "bootcount" is stored in the environment. To prevent a
986 saveenv on all reboots, the environment variable
987 "upgrade_available" is used. If "upgrade_available" is
988 0, "bootcount" is always 0, if "upgrade_available" is
989 1 "bootcount" is incremented in the environment.
990 So the Userspace Applikation must set the "upgrade_available"
991 and "bootcount" variable to 0, if a boot was successfully.
992
wdenkc6097192002-11-03 00:24:07 +0000993- Pre-Boot Commands:
994 CONFIG_PREBOOT
995
996 When this option is #defined, the existence of the
997 environment variable "preboot" will be checked
998 immediately before starting the CONFIG_BOOTDELAY
999 countdown and/or running the auto-boot command resp.
1000 entering interactive mode.
1001
1002 This feature is especially useful when "preboot" is
1003 automatically generated or modified. For an example
1004 see the LWMON board specific code: here "preboot" is
1005 modified when the user holds down a certain
1006 combination of keys on the (special) keyboard when
1007 booting the systems
1008
1009- Serial Download Echo Mode:
1010 CONFIG_LOADS_ECHO
1011 If defined to 1, all characters received during a
1012 serial download (using the "loads" command) are
1013 echoed back. This might be needed by some terminal
1014 emulations (like "cu"), but may as well just take
1015 time on others. This setting #define's the initial
1016 value of the "loads_echo" environment variable.
1017
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001019 CONFIG_KGDB_BAUDRATE
1020 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001021 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001022
1023- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001024 Monitor commands can be included or excluded
1025 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001026 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -05001027 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001028
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001029 The default command configuration includes all commands
1030 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001031
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001032 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001033 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001034 CONFIG_CMD_BDI bdinfo
1035 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1036 CONFIG_CMD_BMP * BMP support
1037 CONFIG_CMD_BSP * Board specific commands
1038 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001039 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001040 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001041 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001042 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001043 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001044 CONFIG_CMD_DATE * support for RTC, date/time...
1045 CONFIG_CMD_DHCP * DHCP support
1046 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001047 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1048 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1049 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1050 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001051 CONFIG_CMD_DTT * Digital Therm and Thermostat
1052 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001053 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001054 CONFIG_CMD_EEPROM * EEPROM read/write support
1055 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001056 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001057 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001058 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001059 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001060 CONFIG_CMD_EXT2 * ext2 command support
1061 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001062 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1063 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001064 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001065 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001066 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001067 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001068 CONFIG_CMD_FLASH flinfo, erase, protect
1069 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001070 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001071 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001072 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001073 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001074 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001075 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1076 CONFIG_CMD_I2C * I2C serial bus support
1077 CONFIG_CMD_IDE * IDE harddisk support
1078 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001079 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001080 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001081 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001082 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001083 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001084 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001085 CONFIG_CMD_IRQ * irqinfo
1086 CONFIG_CMD_ITEST Integer/string test of 2 values
1087 CONFIG_CMD_JFFS2 * JFFS2 Support
1088 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001089 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001090 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1091 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001092 CONFIG_CMD_LOADB loadb
1093 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001094 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001095 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001096 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001097 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001098 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001099 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001100 CONFIG_CMD_MISC Misc functions like sleep etc
1101 CONFIG_CMD_MMC * MMC memory mapped support
1102 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001103 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001104 CONFIG_CMD_NAND * NAND support
1105 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001106 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001107 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001108 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001109 CONFIG_CMD_PCI * pciinfo
1110 CONFIG_CMD_PCMCIA * PCMCIA support
1111 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1112 host
1113 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001114 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001115 CONFIG_CMD_REGINFO * Register dump
1116 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001117 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001118 CONFIG_CMD_SAVES * save S record dump
1119 CONFIG_CMD_SCSI * SCSI Support
1120 CONFIG_CMD_SDRAM * print SDRAM configuration information
1121 (requires CONFIG_CMD_I2C)
1122 CONFIG_CMD_SETGETDCR Support for DCR Register access
1123 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001124 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001125 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001126 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001127 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001128 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001129 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001130 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001131 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001132 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1133 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001134 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001135 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001136 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001137 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001138 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001139
1140 EXAMPLE: If you want all functions except of network
1141 support you can write:
1142
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001143 #include "config_cmd_all.h"
1144 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001145
Gerald Van Barend6abef42007-03-31 12:23:51 -04001146 Other Commands:
1147 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001148
1149 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001150 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001151 what you (and your U-Boot users) are doing. Data
1152 cache cannot be enabled on systems like the 8xx or
1153 8260 (where accesses to the IMMR region must be
1154 uncached), and it cannot be disabled on all other
1155 systems where we (mis-) use the data cache to hold an
1156 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001157
1158
1159 XXX - this list needs to get updated!
1160
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001161- Regular expression support:
1162 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001163 If this variable is defined, U-Boot is linked against
1164 the SLRE (Super Light Regular Expression) library,
1165 which adds regex support to some commands, as for
1166 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001167
Simon Glass3d686442011-10-15 05:48:20 +00001168- Device tree:
1169 CONFIG_OF_CONTROL
1170 If this variable is defined, U-Boot will use a device tree
1171 to configure its devices, instead of relying on statically
1172 compiled #defines in the board file. This option is
1173 experimental and only available on a few boards. The device
1174 tree is available in the global data as gd->fdt_blob.
1175
Simon Glass5cb34db2011-10-24 19:15:31 +00001176 U-Boot needs to get its device tree from somewhere. This can
1177 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001178
1179 CONFIG_OF_EMBED
1180 If this variable is defined, U-Boot will embed a device tree
1181 binary in its image. This device tree file should be in the
1182 board directory and called <soc>-<board>.dts. The binary file
1183 is then picked up in board_init_f() and made available through
1184 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001185
Simon Glass5cb34db2011-10-24 19:15:31 +00001186 CONFIG_OF_SEPARATE
1187 If this variable is defined, U-Boot will build a device tree
1188 binary. It will be called u-boot.dtb. Architecture-specific
1189 code will locate it at run-time. Generally this works by:
1190
1191 cat u-boot.bin u-boot.dtb >image.bin
1192
1193 and in fact, U-Boot does this for you, creating a file called
1194 u-boot-dtb.bin which is useful in the common case. You can
1195 still use the individual files if you need something more
1196 exotic.
1197
wdenkc6097192002-11-03 00:24:07 +00001198- Watchdog:
1199 CONFIG_WATCHDOG
1200 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001201 support for the SoC. There must be support in the SoC
1202 specific code for a watchdog. For the 8xx and 8260
1203 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1204 register. When supported for a specific SoC is
1205 available, then no further board specific code should
1206 be needed to use it.
1207
1208 CONFIG_HW_WATCHDOG
1209 When using a watchdog circuitry external to the used
1210 SoC, then define this variable and provide board
1211 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001212
Heiko Schocher735326c2015-01-21 08:38:22 +01001213 CONFIG_AT91_HW_WDT_TIMEOUT
1214 specify the timeout in seconds. default 2 seconds.
1215
stroeseb9c17c52003-04-04 15:53:41 +00001216- U-Boot Version:
1217 CONFIG_VERSION_VARIABLE
1218 If this variable is defined, an environment variable
1219 named "ver" is created by U-Boot showing the U-Boot
1220 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001221 Any change to this variable will be reverted at the
1222 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001223
wdenkc6097192002-11-03 00:24:07 +00001224- Real-Time Clock:
1225
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001226 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001227 has to be selected, too. Define exactly one of the
1228 following options:
1229
1230 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1231 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001232 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001233 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001234 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001235 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001236 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001237 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001238 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001239 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001240 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001241 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001242 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1243 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001244
wdenkb9bbd242003-06-30 16:24:52 +00001245 Note that if the RTC uses I2C, then the I2C interface
1246 must also be configured. See I2C Support, below.
1247
Peter Tyser9902e422008-12-17 16:36:21 -06001248- GPIO Support:
1249 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001250
Chris Packham9b383202010-12-19 10:12:13 +00001251 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1252 chip-ngpio pairs that tell the PCA953X driver the number of
1253 pins supported by a particular chip.
1254
Peter Tyser9902e422008-12-17 16:36:21 -06001255 Note that if the GPIO device uses I2C, then the I2C interface
1256 must also be configured. See I2C Support, below.
1257
Simon Glass4dc47ca2014-06-11 23:29:41 -06001258- I/O tracing:
1259 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1260 accesses and can checksum them or write a list of them out
1261 to memory. See the 'iotrace' command for details. This is
1262 useful for testing device drivers since it can confirm that
1263 the driver behaves the same way before and after a code
1264 change. Currently this is supported on sandbox and arm. To
1265 add support for your architecture, add '#include <iotrace.h>'
1266 to the bottom of arch/<arch>/include/asm/io.h and test.
1267
1268 Example output from the 'iotrace stats' command is below.
1269 Note that if the trace buffer is exhausted, the checksum will
1270 still continue to operate.
1271
1272 iotrace is enabled
1273 Start: 10000000 (buffer start address)
1274 Size: 00010000 (buffer size)
1275 Offset: 00000120 (current buffer offset)
1276 Output: 10000120 (start + offset)
1277 Count: 00000018 (number of trace records)
1278 CRC32: 9526fb66 (CRC32 of all trace records)
1279
wdenkc6097192002-11-03 00:24:07 +00001280- Timestamp Support:
1281
wdenk4a5c8a72003-03-06 00:02:04 +00001282 When CONFIG_TIMESTAMP is selected, the timestamp
1283 (date and time) of an image is printed by image
1284 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001285 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001286
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001287- Partition Labels (disklabels) Supported:
1288 Zero or more of the following:
1289 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1290 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1291 Intel architecture, USB sticks, etc.
1292 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1293 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1294 bootloader. Note 2TB partition limit; see
1295 disk/part_efi.c
1296 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001297
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001298 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1299 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001300 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001301
1302- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001303 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1304 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001305
wdenk369d43d2004-03-14 14:09:05 +00001306 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1307 be performed by calling the function
1308 ide_set_reset(int reset)
1309 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001310
1311- ATAPI Support:
1312 CONFIG_ATAPI
1313
1314 Set this to enable ATAPI support.
1315
wdenkf602aa02004-03-13 23:29:43 +00001316- LBA48 Support
1317 CONFIG_LBA48
1318
1319 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001320 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001321 Whithout these , LBA48 support uses 32bit variables and will 'only'
1322 support disks up to 2.1TB.
1323
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001324 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001325 When enabled, makes the IDE subsystem use 64bit sector addresses.
1326 Default is 32bit.
1327
wdenkc6097192002-11-03 00:24:07 +00001328- SCSI Support:
1329 At the moment only there is only support for the
1330 SYM53C8XX SCSI controller; define
1331 CONFIG_SCSI_SYM53C8XX to enable it.
1332
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001333 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1334 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1335 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001336 maximum numbers of LUNs, SCSI ID's and target
1337 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001338 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001339
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001340 The environment variable 'scsidevs' is set to the number of
1341 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001342
wdenkc6097192002-11-03 00:24:07 +00001343- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001344 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001345 Support for Intel 8254x/8257x gigabit chips.
1346
1347 CONFIG_E1000_SPI
1348 Utility code for direct access to the SPI bus on Intel 8257x.
1349 This does not do anything useful unless you set at least one
1350 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1351
1352 CONFIG_E1000_SPI_GENERIC
1353 Allow generic access to the SPI bus on the Intel 8257x, for
1354 example with the "sspi" command.
1355
1356 CONFIG_CMD_E1000
1357 Management command for E1000 devices. When used on devices
1358 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001359
wdenkc6097192002-11-03 00:24:07 +00001360 CONFIG_EEPRO100
1361 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001362 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001363 write routine for first time initialisation.
1364
1365 CONFIG_TULIP
1366 Support for Digital 2114x chips.
1367 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1368 modem chip initialisation (KS8761/QS6611).
1369
1370 CONFIG_NATSEMI
1371 Support for National dp83815 chips.
1372
1373 CONFIG_NS8382X
1374 Support for National dp8382[01] gigabit chips.
1375
wdenkaa603362003-05-12 21:50:16 +00001376- NETWORK Support (other):
1377
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001378 CONFIG_DRIVER_AT91EMAC
1379 Support for AT91RM9200 EMAC.
1380
1381 CONFIG_RMII
1382 Define this to use reduced MII inteface
1383
1384 CONFIG_DRIVER_AT91EMAC_QUIET
1385 If this defined, the driver is quiet.
1386 The driver doen't show link status messages.
1387
Rob Herringc9830dc2011-12-15 11:15:49 +00001388 CONFIG_CALXEDA_XGMAC
1389 Support for the Calxeda XGMAC device
1390
Ashok93fb8722012-10-15 06:20:47 +00001391 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001392 Support for SMSC's LAN91C96 chips.
1393
1394 CONFIG_LAN91C96_BASE
1395 Define this to hold the physical address
1396 of the LAN91C96's I/O space
1397
1398 CONFIG_LAN91C96_USE_32_BIT
1399 Define this to enable 32 bit addressing
1400
Ashok93fb8722012-10-15 06:20:47 +00001401 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001402 Support for SMSC's LAN91C111 chip
1403
1404 CONFIG_SMC91111_BASE
1405 Define this to hold the physical address
1406 of the device (I/O space)
1407
1408 CONFIG_SMC_USE_32_BIT
1409 Define this if data bus is 32 bits
1410
1411 CONFIG_SMC_USE_IOFUNCS
1412 Define this to use i/o functions instead of macros
1413 (some hardware wont work with macros)
1414
Heiko Schocher7d037f72011-11-15 10:00:04 -05001415 CONFIG_DRIVER_TI_EMAC
1416 Support for davinci emac
1417
1418 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1419 Define this if you have more then 3 PHYs.
1420
Macpaul Lin199c6252010-12-21 16:59:46 +08001421 CONFIG_FTGMAC100
1422 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1423
1424 CONFIG_FTGMAC100_EGIGA
1425 Define this to use GE link update with gigabit PHY.
1426 Define this if FTGMAC100 is connected to gigabit PHY.
1427 If your system has 10/100 PHY only, it might not occur
1428 wrong behavior. Because PHY usually return timeout or
1429 useless data when polling gigabit status and gigabit
1430 control registers. This behavior won't affect the
1431 correctnessof 10/100 link speed update.
1432
Mike Rapoportf4761af2009-11-11 10:03:03 +02001433 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001434 Support for SMSC's LAN911x and LAN921x chips
1435
Mike Rapoportf4761af2009-11-11 10:03:03 +02001436 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001437 Define this to hold the physical address
1438 of the device (I/O space)
1439
Mike Rapoportf4761af2009-11-11 10:03:03 +02001440 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001441 Define this if data bus is 32 bits
1442
Mike Rapoportf4761af2009-11-11 10:03:03 +02001443 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001444 Define this if data bus is 16 bits. If your processor
1445 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001446 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001447
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001448 CONFIG_SH_ETHER
1449 Support for Renesas on-chip Ethernet controller
1450
1451 CONFIG_SH_ETHER_USE_PORT
1452 Define the number of ports to be used
1453
1454 CONFIG_SH_ETHER_PHY_ADDR
1455 Define the ETH PHY's address
1456
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001457 CONFIG_SH_ETHER_CACHE_WRITEBACK
1458 If this option is set, the driver enables cache flush.
1459
Heiko Schocher2b387762014-07-18 06:07:19 +02001460- PWM Support:
1461 CONFIG_PWM_IMX
1462 Support for PWM modul on the imx6.
1463
Vadim Bendeburydac69642011-10-17 08:36:14 +00001464- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001465 CONFIG_TPM
1466 Support TPM devices.
1467
Christophe Ricard8759ff82015-10-06 22:54:41 +02001468 CONFIG_TPM_TIS_INFINEON
1469 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001470 per system is supported at this time.
1471
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001472 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1473 Define the burst count bytes upper limit
1474
Dirk Eibach20489092013-06-26 15:55:15 +02001475 CONFIG_TPM_ATMEL_TWI
1476 Support for Atmel TWI TPM device. Requires I2C support.
1477
Che-liang Chiouacea5702013-04-12 11:04:34 +00001478 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001479 Support for generic parallel port TPM devices. Only one device
1480 per system is supported at this time.
1481
1482 CONFIG_TPM_TIS_BASE_ADDRESS
1483 Base address where the generic TPM device is mapped
1484 to. Contemporary x86 systems usually map it at
1485 0xfed40000.
1486
Reinhard Pfau4fece432013-06-26 15:55:13 +02001487 CONFIG_CMD_TPM
1488 Add tpm monitor functions.
1489 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1490 provides monitor access to authorized functions.
1491
1492 CONFIG_TPM
1493 Define this to enable the TPM support library which provides
1494 functional interfaces to some TPM commands.
1495 Requires support for a TPM device.
1496
1497 CONFIG_TPM_AUTH_SESSIONS
1498 Define this to enable authorized functions in the TPM library.
1499 Requires CONFIG_TPM and CONFIG_SHA1.
1500
wdenkc6097192002-11-03 00:24:07 +00001501- USB Support:
1502 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001503 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001504 CONFIG_USB_UHCI to enable it.
1505 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001506 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001507 storage devices.
1508 Note:
1509 Supported are USB Keyboards and USB Floppy drives
1510 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001511 MPC5200 USB requires additional defines:
1512 CONFIG_USB_CLOCK
1513 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001514 CONFIG_PSC3_USB
1515 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001516 CONFIG_USB_CONFIG
1517 for differential drivers: 0x00001000
1518 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001519 for differential drivers on PSC3: 0x00000100
1520 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001521 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001522 May be defined to allow interrupt polling
1523 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001524
Simon Glass5978cdb2012-02-27 10:52:47 +00001525 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1526 txfilltuning field in the EHCI controller on reset.
1527
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001528 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1529 HW module registers.
1530
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001531- USB Device:
1532 Define the below if you wish to use the USB console.
1533 Once firmware is rebuilt from a serial console issue the
1534 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001535 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001536 it has found a new device. The environment variable usbtty
1537 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001538 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001539 Common Device Class Abstract Control Model serial device.
1540 If you select usbtty = gserial you should be able to enumerate
1541 a Linux host by
1542 # modprobe usbserial vendor=0xVendorID product=0xProductID
1543 else if using cdc_acm, simply setting the environment
1544 variable usbtty to be cdc_acm should suffice. The following
1545 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001546
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001547 CONFIG_USB_DEVICE
1548 Define this to build a UDC device
1549
1550 CONFIG_USB_TTY
1551 Define this to have a tty type of device available to
1552 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001553
Vipin KUMARbdb17702012-03-26 15:38:06 +05301554 CONFIG_USBD_HS
1555 Define this to enable the high speed support for usb
1556 device and usbtty. If this feature is enabled, a routine
1557 int is_usbd_high_speed(void)
1558 also needs to be defined by the driver to dynamically poll
1559 whether the enumeration has succeded at high speed or full
1560 speed.
1561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001562 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001563 Define this if you want stdin, stdout &/or stderr to
1564 be set to usbtty.
1565
1566 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001567 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001568 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001569 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001571 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001572 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001573 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001574
Wolfgang Denke2601822006-06-14 18:14:56 +02001575 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001576 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001577 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001578 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1579 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1580 should pretend to be a Linux device to it's target host.
1581
1582 CONFIG_USBD_MANUFACTURER
1583 Define this string as the name of your company for
1584 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001585
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001586 CONFIG_USBD_PRODUCT_NAME
1587 Define this string as the name of your product
1588 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001589
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001590 CONFIG_USBD_VENDORID
1591 Define this as your assigned Vendor ID from the USB
1592 Implementors Forum. This *must* be a genuine Vendor ID
1593 to avoid polluting the USB namespace.
1594 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001595
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001596 CONFIG_USBD_PRODUCTID
1597 Define this as the unique Product ID
1598 for your device
1599 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001600
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001601- ULPI Layer Support:
1602 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1603 the generic ULPI layer. The generic layer accesses the ULPI PHY
1604 via the platform viewport, so you need both the genric layer and
1605 the viewport enabled. Currently only Chipidea/ARC based
1606 viewport is supported.
1607 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1608 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001609 If your ULPI phy needs a different reference clock than the
1610 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1611 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001612
wdenk7a428cc2003-06-15 22:40:42 +00001613- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001614 The MMC controller on the Intel PXA is supported. To
1615 enable this define CONFIG_MMC. The MMC can be
1616 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001617 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001618 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1619 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001620
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001621 CONFIG_SH_MMCIF
1622 Support for Renesas on-chip MMCIF controller
1623
1624 CONFIG_SH_MMCIF_ADDR
1625 Define the base address of MMCIF registers
1626
1627 CONFIG_SH_MMCIF_CLK
1628 Define the clock frequency for MMCIF
1629
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001630 CONFIG_GENERIC_MMC
1631 Enable the generic MMC driver
1632
1633 CONFIG_SUPPORT_EMMC_BOOT
1634 Enable some additional features of the eMMC boot partitions.
1635
1636 CONFIG_SUPPORT_EMMC_RPMB
1637 Enable the commands for reading, writing and programming the
1638 key for the Replay Protection Memory Block partition in eMMC.
1639
Tom Rini58a8d322013-03-14 05:32:47 +00001640- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001641 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001642 This enables the USB portion of the DFU USB class
1643
1644 CONFIG_CMD_DFU
1645 This enables the command "dfu" which is used to have
1646 U-Boot create a DFU class device via USB. This command
1647 requires that the "dfu_alt_info" environment variable be
1648 set and define the alt settings to expose to the host.
1649
1650 CONFIG_DFU_MMC
1651 This enables support for exposing (e)MMC devices via DFU.
1652
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001653 CONFIG_DFU_NAND
1654 This enables support for exposing NAND devices via DFU.
1655
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301656 CONFIG_DFU_RAM
1657 This enables support for exposing RAM via DFU.
1658 Note: DFU spec refer to non-volatile memory usage, but
1659 allow usages beyond the scope of spec - here RAM usage,
1660 one that would help mostly the developer.
1661
Heiko Schochera2f831e2013-06-12 06:05:51 +02001662 CONFIG_SYS_DFU_DATA_BUF_SIZE
1663 Dfu transfer uses a buffer before writing data to the
1664 raw storage device. Make the size (in bytes) of this buffer
1665 configurable. The size of this buffer is also configurable
1666 through the "dfu_bufsiz" environment variable.
1667
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001668 CONFIG_SYS_DFU_MAX_FILE_SIZE
1669 When updating files rather than the raw storage device,
1670 we use a static buffer to copy the file into and then write
1671 the buffer once we've been given the whole file. Define
1672 this to the maximum filesize (in bytes) for the buffer.
1673 Default is 4 MiB if undefined.
1674
Heiko Schochere1ba1512014-03-18 08:09:56 +01001675 DFU_DEFAULT_POLL_TIMEOUT
1676 Poll timeout [ms], is the timeout a device can send to the
1677 host. The host must wait for this timeout before sending
1678 a subsequent DFU_GET_STATUS request to the device.
1679
1680 DFU_MANIFEST_POLL_TIMEOUT
1681 Poll timeout [ms], which the device sends to the host when
1682 entering dfuMANIFEST state. Host waits this timeout, before
1683 sending again an USB request to the device.
1684
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001685- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001686 CONFIG_USB_FUNCTION_FASTBOOT
1687 This enables the USB part of the fastboot gadget
1688
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001689 CONFIG_CMD_FASTBOOT
1690 This enables the command "fastboot" which enables the Android
1691 fastboot mode for the platform's USB device. Fastboot is a USB
1692 protocol for downloading images, flashing and device control
1693 used on Android devices.
1694 See doc/README.android-fastboot for more information.
1695
1696 CONFIG_ANDROID_BOOT_IMAGE
1697 This enables support for booting images which use the Android
1698 image format header.
1699
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001700 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001701 The fastboot protocol requires a large memory buffer for
1702 downloads. Define this to the starting RAM address to use for
1703 downloaded images.
1704
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001705 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001706 The fastboot protocol requires a large memory buffer for
1707 downloads. This buffer should be as large as possible for a
1708 platform. Define this to the size available RAM for fastboot.
1709
Steve Raebfb9ba42014-08-26 11:47:28 -07001710 CONFIG_FASTBOOT_FLASH
1711 The fastboot protocol includes a "flash" command for writing
1712 the downloaded image to a non-volatile storage device. Define
1713 this to enable the "fastboot flash" command.
1714
1715 CONFIG_FASTBOOT_FLASH_MMC_DEV
1716 The fastboot "flash" command requires additional information
1717 regarding the non-volatile storage device. Define this to
1718 the eMMC device that fastboot should use to store the image.
1719
Steve Rae7d059342014-12-12 15:51:54 -08001720 CONFIG_FASTBOOT_GPT_NAME
1721 The fastboot "flash" command supports writing the downloaded
1722 image to the Protective MBR and the Primary GUID Partition
1723 Table. (Additionally, this downloaded image is post-processed
1724 to generate and write the Backup GUID Partition Table.)
1725 This occurs when the specified "partition name" on the
1726 "fastboot flash" command line matches this value.
1727 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1728
wdenkda04a8b2004-08-02 23:22:59 +00001729- Journaling Flash filesystem support:
1730 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1731 CONFIG_JFFS2_NAND_DEV
1732 Define these for a default partition on a NAND device
1733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001734 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1735 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001736 Define these for a default partition on a NOR device
1737
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001738 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001739 Define this to create an own partition. You have to provide a
1740 function struct part_info* jffs2_part_info(int part_num)
1741
1742 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001743 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001744 to disable the command chpart. This is the default when you
1745 have not defined a custom partition
1746
Donggeun Kim8f814002011-10-24 21:15:28 +00001747- FAT(File Allocation Table) filesystem write function support:
1748 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001749
1750 Define this to enable support for saving memory data as a
1751 file in FAT formatted partition.
1752
1753 This will also enable the command "fatwrite" enabling the
1754 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001755
Gabe Black7f8574c2012-10-12 14:26:11 +00001756CBFS (Coreboot Filesystem) support
1757 CONFIG_CMD_CBFS
1758
1759 Define this to enable support for reading from a Coreboot
1760 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1761 and cbfsload.
1762
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301763- FAT(File Allocation Table) filesystem cluster size:
1764 CONFIG_FS_FAT_MAX_CLUSTSIZE
1765
1766 Define the max cluster size for fat operations else
1767 a default value of 65536 will be defined.
1768
wdenkc6097192002-11-03 00:24:07 +00001769- Keyboard Support:
1770 CONFIG_ISA_KEYBOARD
1771
1772 Define this to enable standard (PC-Style) keyboard
1773 support
1774
1775 CONFIG_I8042_KBD
1776 Standard PC keyboard driver with US (is default) and
1777 GERMAN key layout (switch via environment 'keymap=de') support.
1778 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1779 for cfb_console. Supports cursor blinking.
1780
1781- Video support:
1782 CONFIG_VIDEO
1783
1784 Define this to enable video support (for output to
1785 video).
1786
1787 CONFIG_VIDEO_CT69000
1788
1789 Enable Chips & Technologies 69000 Video chip
1790
1791 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001792 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001793 video output is selected via environment 'videoout'
1794 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1795 assumed.
wdenkc6097192002-11-03 00:24:07 +00001796
wdenkd3602132004-03-25 15:14:43 +00001797 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001798 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001799 are possible:
1800 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001801 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001802
1803 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1804 -------------+---------------------------------------------
1805 8 bits | 0x301* 0x303 0x305 0x161 0x307
1806 15 bits | 0x310 0x313 0x316 0x162 0x319
1807 16 bits | 0x311 0x314 0x317 0x163 0x31A
1808 24 bits | 0x312 0x315 0x318 ? 0x31B
1809 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001810 (i.e. setenv videomode 317; saveenv; reset;)
1811
wdenkd3602132004-03-25 15:14:43 +00001812 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001813 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001814
1815
stroeseb9c17c52003-04-04 15:53:41 +00001816 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001817 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001818 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1819 or CONFIG_VIDEO_SED13806_16BPP
1820
Timur Tabi020edd22011-02-15 17:09:19 -06001821 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001822 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001823 SOCs that have a DIU should define this macro to enable DIU
1824 support, and should also define these other macros:
1825
1826 CONFIG_SYS_DIU_ADDR
1827 CONFIG_VIDEO
1828 CONFIG_CMD_BMP
1829 CONFIG_CFB_CONSOLE
1830 CONFIG_VIDEO_SW_CURSOR
1831 CONFIG_VGA_AS_SINGLE_DEVICE
1832 CONFIG_VIDEO_LOGO
1833 CONFIG_VIDEO_BMP_LOGO
1834
Timur Tabi32f709e2011-04-11 14:18:22 -05001835 The DIU driver will look for the 'video-mode' environment
1836 variable, and if defined, enable the DIU as a console during
1837 boot. See the documentation file README.video for a
1838 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001839
Simon Glass54df8ce2012-12-03 13:59:47 +00001840
wdenk4e112c12003-06-03 23:54:09 +00001841- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001842 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001843
wdenk57b2d802003-06-27 21:31:46 +00001844 Define this to enable a custom keyboard support.
1845 This simply calls drv_keyboard_init() which must be
1846 defined in your board-specific files.
1847 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001848
wdenkc6097192002-11-03 00:24:07 +00001849- LCD Support: CONFIG_LCD
1850
1851 Define this to enable LCD support (for output to LCD
1852 display); also select one of the supported displays
1853 by defining one of these:
1854
Stelian Popf6f86652008-05-09 21:57:18 +02001855 CONFIG_ATMEL_LCD:
1856
1857 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1858
wdenkc0d54ae2003-11-25 16:55:19 +00001859 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001860
wdenkc0d54ae2003-11-25 16:55:19 +00001861 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001862
wdenkc0d54ae2003-11-25 16:55:19 +00001863 CONFIG_NEC_NL6448BC20
1864
1865 NEC NL6448BC20-08. 6.5", 640x480.
1866 Active, color, single scan.
1867
1868 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001869
wdenkc0d54ae2003-11-25 16:55:19 +00001870 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001871 Active, color, single scan.
1872
1873 CONFIG_SHARP_16x9
1874
1875 Sharp 320x240. Active, color, single scan.
1876 It isn't 16x9, and I am not sure what it is.
1877
1878 CONFIG_SHARP_LQ64D341
1879
1880 Sharp LQ64D341 display, 640x480.
1881 Active, color, single scan.
1882
1883 CONFIG_HLD1045
1884
1885 HLD1045 display, 640x480.
1886 Active, color, single scan.
1887
1888 CONFIG_OPTREX_BW
1889
1890 Optrex CBL50840-2 NF-FW 99 22 M5
1891 or
1892 Hitachi LMG6912RPFC-00T
1893 or
1894 Hitachi SP14Q002
1895
1896 320x240. Black & white.
1897
1898 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001899 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001900
Simon Glass599a4df2012-10-17 13:24:54 +00001901 CONFIG_LCD_ALIGNMENT
1902
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001903 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001904 defined then the LCD will be aligned to this value instead.
1905 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1906 here, since it is cheaper to change data cache settings on
1907 a per-section basis.
1908
Simon Glassaf3e2802012-10-17 13:24:59 +00001909 CONFIG_CONSOLE_SCROLL_LINES
1910
1911 When the console need to be scrolled, this is the number of
1912 lines to scroll by. It defaults to 1. Increasing this makes
1913 the console jump but can help speed up operation when scrolling
1914 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001915
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001916 CONFIG_LCD_ROTATION
1917
1918 Sometimes, for example if the display is mounted in portrait
1919 mode or even if it's mounted landscape but rotated by 180degree,
1920 we need to rotate our content of the display relative to the
1921 framebuffer, so that user can read the messages which are
1922 printed out.
1923 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1924 initialized with a given rotation from "vl_rot" out of
1925 "vidinfo_t" which is provided by the board specific code.
1926 The value for vl_rot is coded as following (matching to
1927 fbcon=rotate:<n> linux-kernel commandline):
1928 0 = no rotation respectively 0 degree
1929 1 = 90 degree rotation
1930 2 = 180 degree rotation
1931 3 = 270 degree rotation
1932
1933 If CONFIG_LCD_ROTATION is not defined, the console will be
1934 initialized with 0degree rotation.
1935
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001936 CONFIG_LCD_BMP_RLE8
1937
1938 Support drawing of RLE8-compressed bitmaps on the LCD.
1939
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001940 CONFIG_I2C_EDID
1941
1942 Enables an 'i2c edid' command which can read EDID
1943 information over I2C from an attached LCD display.
1944
wdenkeb20ad32003-09-05 23:19:14 +00001945- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001946
wdenk57b2d802003-06-27 21:31:46 +00001947 If this option is set, the environment is checked for
1948 a variable "splashimage". If found, the usual display
1949 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001950 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001951 specified in "splashimage" is loaded instead. The
1952 console is redirected to the "nulldev", too. This
1953 allows for a "silent" boot where a splash screen is
1954 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001955
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001956 CONFIG_SPLASHIMAGE_GUARD
1957
1958 If this option is set, then U-Boot will prevent the environment
1959 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001960 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001961 This option is useful for targets where, due to alignment
1962 restrictions, an improperly aligned BMP image will cause a data
1963 abort. If you think you will not have problems with unaligned
1964 accesses (for example because your toolchain prevents them)
1965 there is no need to set this option.
1966
Matthias Weisser53884182009-07-09 16:07:30 +02001967 CONFIG_SPLASH_SCREEN_ALIGN
1968
1969 If this option is set the splash image can be freely positioned
1970 on the screen. Environment variable "splashpos" specifies the
1971 position as "x,y". If a positive number is given it is used as
1972 number of pixel from left/top. If a negative number is given it
1973 is used as number of pixel from right/bottom. You can also
1974 specify 'm' for centering the image.
1975
1976 Example:
1977 setenv splashpos m,m
1978 => image at center of screen
1979
1980 setenv splashpos 30,20
1981 => image at x = 30 and y = 20
1982
1983 setenv splashpos -10,m
1984 => vertically centered image
1985 at x = dspWidth - bmpWidth - 9
1986
Stefan Roesed9d97742005-09-22 09:04:17 +02001987- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1988
1989 If this option is set, additionally to standard BMP
1990 images, gzipped BMP images can be displayed via the
1991 splashscreen support or the bmp command.
1992
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001993- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1994
1995 If this option is set, 8-bit RLE compressed BMP images
1996 can be displayed via the splashscreen support or the
1997 bmp command.
1998
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001999- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002000 CONFIG_CMD_ZIP
2001
2002 If this option is set, it would use zlib deflate method
2003 to compress the specified memory at its best effort.
2004
wdenk710e3502003-08-29 20:57:53 +00002005- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002006 CONFIG_GZIP
2007
2008 Enabled by default to support gzip compressed images.
2009
wdenk710e3502003-08-29 20:57:53 +00002010 CONFIG_BZIP2
2011
2012 If this option is set, support for bzip2 compressed
2013 images is included. If not, only uncompressed and gzip
2014 compressed images are supported.
2015
wdenk9c53f402003-10-15 23:53:47 +00002016 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002017 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002018 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002019
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002020 CONFIG_LZMA
2021
2022 If this option is set, support for lzma compressed
2023 images is included.
2024
2025 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2026 requires an amount of dynamic memory that is given by the
2027 formula:
2028
2029 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2030
2031 Where lc and lp stand for, respectively, Literal context bits
2032 and Literal pos bits.
2033
2034 This value is upper-bounded by 14MB in the worst case. Anyway,
2035 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2036 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2037 a very small buffer.
2038
2039 Use the lzmainfo tool to determinate the lc and lp values and
2040 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002041 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002042
Kees Cook5b06e642013-08-16 07:59:12 -07002043 CONFIG_LZO
2044
2045 If this option is set, support for LZO compressed images
2046 is included.
2047
wdenk0e2bd9c2004-06-06 21:51:03 +00002048- MII/PHY support:
2049 CONFIG_PHY_ADDR
2050
2051 The address of PHY on MII bus.
2052
2053 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2054
2055 The clock frequency of the MII bus
2056
2057 CONFIG_PHY_GIGE
2058
2059 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002060 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002061
2062 CONFIG_PHY_RESET_DELAY
2063
2064 Some PHY like Intel LXT971A need extra delay after
2065 reset before any MII register access is possible.
2066 For such PHY, set this option to the usec delay
2067 required. (minimum 300usec for LXT971A)
2068
2069 CONFIG_PHY_CMD_DELAY (ppc4xx)
2070
2071 Some PHY like Intel LXT971A need extra delay after
2072 command issued before MII status register can be read
2073
wdenkc6097192002-11-03 00:24:07 +00002074- IP address:
2075 CONFIG_IPADDR
2076
2077 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002078 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002079 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002080 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002081
2082- Server IP address:
2083 CONFIG_SERVERIP
2084
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002085 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002086 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002087 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002088
Robin Getz470a6d42009-07-21 12:15:28 -04002089 CONFIG_KEEP_SERVERADDR
2090
2091 Keeps the server's MAC address, in the env 'serveraddr'
2092 for passing to bootargs (like Linux's netconsole option)
2093
Wolfgang Denk26da2992011-10-26 10:21:22 +00002094- Gateway IP address:
2095 CONFIG_GATEWAYIP
2096
2097 Defines a default value for the IP address of the
2098 default router where packets to other networks are
2099 sent to.
2100 (Environment variable "gatewayip")
2101
2102- Subnet mask:
2103 CONFIG_NETMASK
2104
2105 Defines a default value for the subnet mask (or
2106 routing prefix) which is used to determine if an IP
2107 address belongs to the local subnet or needs to be
2108 forwarded through a router.
2109 (Environment variable "netmask")
2110
David Updegraff7280da72007-06-11 10:41:07 -05002111- Multicast TFTP Mode:
2112 CONFIG_MCAST_TFTP
2113
2114 Defines whether you want to support multicast TFTP as per
2115 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002116 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002117 driver in use must provide a function: mcast() to join/leave a
2118 multicast group.
2119
wdenkc6097192002-11-03 00:24:07 +00002120- BOOTP Recovery Mode:
2121 CONFIG_BOOTP_RANDOM_DELAY
2122
2123 If you have many targets in a network that try to
2124 boot using BOOTP, you may want to avoid that all
2125 systems send out BOOTP requests at precisely the same
2126 moment (which would happen for instance at recovery
2127 from a power failure, when all systems will try to
2128 boot, thus flooding the BOOTP server. Defining
2129 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2130 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002131 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002132
2133 1st BOOTP request: delay 0 ... 1 sec
2134 2nd BOOTP request: delay 0 ... 2 sec
2135 3rd BOOTP request: delay 0 ... 4 sec
2136 4th and following
2137 BOOTP requests: delay 0 ... 8 sec
2138
Thierry Reding8977cda2014-08-19 10:21:24 +02002139 CONFIG_BOOTP_ID_CACHE_SIZE
2140
2141 BOOTP packets are uniquely identified using a 32-bit ID. The
2142 server will copy the ID from client requests to responses and
2143 U-Boot will use this to determine if it is the destination of
2144 an incoming response. Some servers will check that addresses
2145 aren't in use before handing them out (usually using an ARP
2146 ping) and therefore take up to a few hundred milliseconds to
2147 respond. Network congestion may also influence the time it
2148 takes for a response to make it back to the client. If that
2149 time is too long, U-Boot will retransmit requests. In order
2150 to allow earlier responses to still be accepted after these
2151 retransmissions, U-Boot's BOOTP client keeps a small cache of
2152 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2153 cache. The default is to keep IDs for up to four outstanding
2154 requests. Increasing this will allow U-Boot to accept offers
2155 from a BOOTP client in networks with unusually high latency.
2156
stroesee0aadfb2003-08-28 14:17:32 +00002157- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002158 You can fine tune the DHCP functionality by defining
2159 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002160
Jon Loeliger5336a762007-07-09 22:08:34 -05002161 CONFIG_BOOTP_SUBNETMASK
2162 CONFIG_BOOTP_GATEWAY
2163 CONFIG_BOOTP_HOSTNAME
2164 CONFIG_BOOTP_NISDOMAIN
2165 CONFIG_BOOTP_BOOTPATH
2166 CONFIG_BOOTP_BOOTFILESIZE
2167 CONFIG_BOOTP_DNS
2168 CONFIG_BOOTP_DNS2
2169 CONFIG_BOOTP_SEND_HOSTNAME
2170 CONFIG_BOOTP_NTPSERVER
2171 CONFIG_BOOTP_TIMEOFFSET
2172 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002173 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002174
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002175 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2176 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002177
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002178 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2179 after the configured retry count, the call will fail
2180 instead of starting over. This can be used to fail over
2181 to Link-local IP address configuration if the DHCP server
2182 is not available.
2183
stroesee0aadfb2003-08-28 14:17:32 +00002184 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2185 serverip from a DHCP server, it is possible that more
2186 than one DNS serverip is offered to the client.
2187 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2188 serverip will be stored in the additional environment
2189 variable "dnsip2". The first DNS serverip is always
2190 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002191 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002192
2193 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2194 to do a dynamic update of a DNS server. To do this, they
2195 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002196 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002197 of the "hostname" environment variable is passed as
2198 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002199
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002200 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2201
2202 A 32bit value in microseconds for a delay between
2203 receiving a "DHCP Offer" and sending the "DHCP Request".
2204 This fixes a problem with certain DHCP servers that don't
2205 respond 100% of the time to a "DHCP request". E.g. On an
2206 AT91RM9200 processor running at 180MHz, this delay needed
2207 to be *at least* 15,000 usec before a Windows Server 2003
2208 DHCP server would reply 100% of the time. I recommend at
2209 least 50,000 usec to be safe. The alternative is to hope
2210 that one of the retries will be successful but note that
2211 the DHCP timeout and retry process takes a longer than
2212 this delay.
2213
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002214 - Link-local IP address negotiation:
2215 Negotiate with other link-local clients on the local network
2216 for an address that doesn't require explicit configuration.
2217 This is especially useful if a DHCP server cannot be guaranteed
2218 to exist in all environments that the device must operate.
2219
2220 See doc/README.link-local for more information.
2221
wdenk145d2c12004-04-15 21:48:45 +00002222 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002223 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002224
2225 The device id used in CDP trigger frames.
2226
2227 CONFIG_CDP_DEVICE_ID_PREFIX
2228
2229 A two character string which is prefixed to the MAC address
2230 of the device.
2231
2232 CONFIG_CDP_PORT_ID
2233
2234 A printf format string which contains the ascii name of
2235 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002236 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002237
2238 CONFIG_CDP_CAPABILITIES
2239
2240 A 32bit integer which indicates the device capabilities;
2241 0x00000010 for a normal host which does not forwards.
2242
2243 CONFIG_CDP_VERSION
2244
2245 An ascii string containing the version of the software.
2246
2247 CONFIG_CDP_PLATFORM
2248
2249 An ascii string containing the name of the platform.
2250
2251 CONFIG_CDP_TRIGGER
2252
2253 A 32bit integer sent on the trigger.
2254
2255 CONFIG_CDP_POWER_CONSUMPTION
2256
2257 A 16bit integer containing the power consumption of the
2258 device in .1 of milliwatts.
2259
2260 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2261
2262 A byte containing the id of the VLAN.
2263
wdenkc6097192002-11-03 00:24:07 +00002264- Status LED: CONFIG_STATUS_LED
2265
2266 Several configurations allow to display the current
2267 status using a LED. For instance, the LED will blink
2268 fast while running U-Boot code, stop blinking as
2269 soon as a reply to a BOOTP request was received, and
2270 start blinking slow once the Linux kernel is running
2271 (supported by a status LED driver in the Linux
2272 kernel). Defining CONFIG_STATUS_LED enables this
2273 feature in U-Boot.
2274
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002275 Additional options:
2276
2277 CONFIG_GPIO_LED
2278 The status LED can be connected to a GPIO pin.
2279 In such cases, the gpio_led driver can be used as a
2280 status LED backend implementation. Define CONFIG_GPIO_LED
2281 to include the gpio_led driver in the U-Boot binary.
2282
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002283 CONFIG_GPIO_LED_INVERTED_TABLE
2284 Some GPIO connected LEDs may have inverted polarity in which
2285 case the GPIO high value corresponds to LED off state and
2286 GPIO low value corresponds to LED on state.
2287 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2288 with a list of GPIO LEDs that have inverted polarity.
2289
wdenkc6097192002-11-03 00:24:07 +00002290- CAN Support: CONFIG_CAN_DRIVER
2291
2292 Defining CONFIG_CAN_DRIVER enables CAN driver support
2293 on those systems that support this (optional)
2294 feature, like the TQM8xxL modules.
2295
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002296- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002297
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002298 This enable the NEW i2c subsystem, and will allow you to use
2299 i2c commands at the u-boot command line (as long as you set
2300 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2301 based realtime clock chips or other i2c devices. See
2302 common/cmd_i2c.c for a description of the command line
2303 interface.
2304
2305 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002306 - drivers/i2c/soft_i2c.c:
2307 - activate first bus with CONFIG_SYS_I2C_SOFT define
2308 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2309 for defining speed and slave address
2310 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2311 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2312 for defining speed and slave address
2313 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2314 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2315 for defining speed and slave address
2316 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2317 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2318 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002319
Heiko Schocherf2850742012-10-24 13:48:22 +02002320 - drivers/i2c/fsl_i2c.c:
2321 - activate i2c driver with CONFIG_SYS_I2C_FSL
2322 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2323 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2324 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2325 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002326 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002327 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2328 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2329 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2330 second bus.
2331
Simon Glass026fefb2012-10-30 07:28:53 +00002332 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002333 - activate this driver with CONFIG_SYS_I2C_TEGRA
2334 - This driver adds 4 i2c buses with a fix speed from
2335 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002336
Dirk Eibach42b204f2013-04-25 02:40:01 +00002337 - drivers/i2c/ppc4xx_i2c.c
2338 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2339 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2340 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2341
trema49f40a2013-09-21 18:13:35 +02002342 - drivers/i2c/i2c_mxc.c
2343 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002344 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2345 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2346 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2347 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002348 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2349 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2350 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2351 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2352 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2353 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002354 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2355 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002356 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002357 for speed, and 0 for slave.
2358
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002359 - drivers/i2c/rcar_i2c.c:
2360 - activate this driver with CONFIG_SYS_I2C_RCAR
2361 - This driver adds 4 i2c buses
2362
2363 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2364 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2365 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2366 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2367 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2368 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2369 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2370 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2371 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2372
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002373 - drivers/i2c/sh_i2c.c:
2374 - activate this driver with CONFIG_SYS_I2C_SH
2375 - This driver adds from 2 to 5 i2c buses
2376
2377 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2378 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2379 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2380 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2381 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2382 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2383 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2384 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2385 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2386 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2387 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2388 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002389 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002390
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002391 - drivers/i2c/omap24xx_i2c.c
2392 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2393 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2394 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2395 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2396 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2397 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2398 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2399 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2400 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2401 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2402 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2403
Heiko Schocher465819a2013-11-08 07:30:53 +01002404 - drivers/i2c/zynq_i2c.c
2405 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2406 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2407 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2408
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302409 - drivers/i2c/s3c24x0_i2c.c:
2410 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2411 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2412 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2413 with a fix speed from 100000 and the slave addr 0!
2414
Dirk Eibachb9577432014-07-03 09:28:18 +02002415 - drivers/i2c/ihs_i2c.c
2416 - activate this driver with CONFIG_SYS_I2C_IHS
2417 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2418 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2419 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2420 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2421 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2422 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2423 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2424 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2425 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2426 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2427 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2428 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002429 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2430 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2431 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2432 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2433 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2434 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2435 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2436 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2437 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002438
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002439 additional defines:
2440
2441 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002442 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002443 don't use/have i2c muxes on your i2c bus, this
2444 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2445 omit this define.
2446
2447 CONFIG_SYS_I2C_DIRECT_BUS
2448 define this, if you don't use i2c muxes on your hardware.
2449 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2450 omit this define.
2451
2452 CONFIG_SYS_I2C_MAX_HOPS
2453 define how many muxes are maximal consecutively connected
2454 on one i2c bus. If you not use i2c muxes, omit this
2455 define.
2456
2457 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002458 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002459 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2460 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2461 CONFIG_SYS_NUM_I2C_BUSES = 9:
2462
2463 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2464 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2465 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2466 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2467 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2468 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2469 {1, {I2C_NULL_HOP}}, \
2470 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2471 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2472 }
2473
2474 which defines
2475 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002476 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2477 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2478 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2479 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2480 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002481 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002482 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2483 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002484
2485 If you do not have i2c muxes on your board, omit this define.
2486
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002487- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002488
2489 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2490 provides the following compelling advantages:
2491
2492 - more than one i2c adapter is usable
2493 - approved multibus support
2494 - better i2c mux support
2495
2496 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002497
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002498 These enable legacy I2C serial bus commands. Defining
2499 CONFIG_HARD_I2C will include the appropriate I2C driver
2500 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002501
wdenk21136db2003-07-16 21:53:01 +00002502 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002503 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002504 CONFIG_COMMANDS) and communicate with i2c based realtime
2505 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002506 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002507
Ben Warren45657152006-09-07 16:50:54 -04002508 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002509
wdenk21136db2003-07-16 21:53:01 +00002510 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002511 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002513 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002514 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002515 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002516 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002517
Peter Tysere4d1abc2010-04-12 22:28:21 -05002518 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002519 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002520 and so its address should therefore be cleared to 0 (See,
2521 eg, MPC823e User's Manual p.16-473). So, set
2522 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002523
Eric Millbrandt12990a42009-09-03 08:09:44 -05002524 CONFIG_SYS_I2C_INIT_MPC5XXX
2525
2526 When a board is reset during an i2c bus transfer
2527 chips might think that the current transfer is still
2528 in progress. Reset the slave devices by sending start
2529 commands until the slave device responds.
2530
wdenk21136db2003-07-16 21:53:01 +00002531 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002532
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002533 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002534 then the following macros need to be defined (examples are
2535 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002536
2537 I2C_INIT
2538
wdenkb9bbd242003-06-30 16:24:52 +00002539 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002540 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002541
wdenk544e9732004-02-06 23:19:44 +00002542 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002543
wdenkc6097192002-11-03 00:24:07 +00002544 I2C_PORT
2545
wdenk4a5c8a72003-03-06 00:02:04 +00002546 (Only for MPC8260 CPU). The I/O port to use (the code
2547 assumes both bits are on the same port). Valid values
2548 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002549
2550 I2C_ACTIVE
2551
2552 The code necessary to make the I2C data line active
2553 (driven). If the data line is open collector, this
2554 define can be null.
2555
wdenkb9bbd242003-06-30 16:24:52 +00002556 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2557
wdenkc6097192002-11-03 00:24:07 +00002558 I2C_TRISTATE
2559
2560 The code necessary to make the I2C data line tri-stated
2561 (inactive). If the data line is open collector, this
2562 define can be null.
2563
wdenkb9bbd242003-06-30 16:24:52 +00002564 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2565
wdenkc6097192002-11-03 00:24:07 +00002566 I2C_READ
2567
York Sun4a598092013-04-01 11:29:11 -07002568 Code that returns true if the I2C data line is high,
2569 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002570
wdenkb9bbd242003-06-30 16:24:52 +00002571 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2572
wdenkc6097192002-11-03 00:24:07 +00002573 I2C_SDA(bit)
2574
York Sun4a598092013-04-01 11:29:11 -07002575 If <bit> is true, sets the I2C data line high. If it
2576 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002577
wdenkb9bbd242003-06-30 16:24:52 +00002578 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002579 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002580 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002581
wdenkc6097192002-11-03 00:24:07 +00002582 I2C_SCL(bit)
2583
York Sun4a598092013-04-01 11:29:11 -07002584 If <bit> is true, sets the I2C clock line high. If it
2585 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002586
wdenkb9bbd242003-06-30 16:24:52 +00002587 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002588 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002589 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002590
wdenkc6097192002-11-03 00:24:07 +00002591 I2C_DELAY
2592
2593 This delay is invoked four times per clock cycle so this
2594 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002595 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002596 like:
2597
wdenkb9bbd242003-06-30 16:24:52 +00002598 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002599
Mike Frysingeree12d542010-07-21 13:38:02 -04002600 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2601
2602 If your arch supports the generic GPIO framework (asm/gpio.h),
2603 then you may alternatively define the two GPIOs that are to be
2604 used as SCL / SDA. Any of the previous I2C_xxx macros will
2605 have GPIO-based defaults assigned to them as appropriate.
2606
2607 You should define these to the GPIO value as given directly to
2608 the generic GPIO functions.
2609
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002610 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002611
wdenk57b2d802003-06-27 21:31:46 +00002612 When a board is reset during an i2c bus transfer
2613 chips might think that the current transfer is still
2614 in progress. On some boards it is possible to access
2615 the i2c SCLK line directly, either by using the
2616 processor pin as a GPIO or by having a second pin
2617 connected to the bus. If this option is defined a
2618 custom i2c_init_board() routine in boards/xxx/board.c
2619 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002620
Richard Retanubundf0149c2010-04-12 15:08:17 -04002621 CONFIG_SYS_I2C_BOARD_LATE_INIT
2622
2623 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2624 defined a custom i2c_board_late_init() routine in
2625 boards/xxx/board.c is run AFTER the operations in i2c_init()
2626 is completed. This callpoint can be used to unreset i2c bus
2627 using CPU i2c controller register accesses for CPUs whose i2c
2628 controller provide such a method. It is called at the end of
2629 i2c_init() to allow i2c_init operations to setup the i2c bus
2630 controller on the CPU (e.g. setting bus speed & slave address).
2631
wdenk0e2bd9c2004-06-06 21:51:03 +00002632 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2633
2634 This option enables configuration of bi_iic_fast[] flags
2635 in u-boot bd_info structure based on u-boot environment
2636 variable "i2cfast". (see also i2cfast)
2637
Ben Warren45657152006-09-07 16:50:54 -04002638 CONFIG_I2C_MULTI_BUS
2639
2640 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002641 must have a controller. At any point in time, only one bus is
2642 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002643 Note that bus numbering is zero-based.
2644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002645 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002646
2647 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002648 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002649 is set, specify a list of bus-device pairs. Otherwise, specify
2650 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002651
2652 e.g.
2653 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002654 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002655
2656 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2657
Wolfgang Denk092ae952011-10-26 10:21:21 +00002658 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002659 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002660
2661 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002663 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002664
2665 If defined, then this indicates the I2C bus number for DDR SPD.
2666 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2667
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002668 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002669
2670 If defined, then this indicates the I2C bus number for the RTC.
2671 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2672
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002673 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002674
2675 If defined, then this indicates the I2C bus number for the DTT.
2676 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002678 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002679
2680 If defined, specifies the I2C address of the DTT device.
2681 If not defined, then U-Boot uses predefined value for
2682 specified DTT device.
2683
Andrew Dyer58c41f92008-12-29 17:36:01 -06002684 CONFIG_SOFT_I2C_READ_REPEATED_START
2685
2686 defining this will force the i2c_read() function in
2687 the soft_i2c driver to perform an I2C repeated start
2688 between writing the address pointer and reading the
2689 data. If this define is omitted the default behaviour
2690 of doing a stop-start sequence will be used. Most I2C
2691 devices can use either method, but some require one or
2692 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002693
wdenkc6097192002-11-03 00:24:07 +00002694- SPI Support: CONFIG_SPI
2695
2696 Enables SPI driver (so far only tested with
2697 SPI EEPROM, also an instance works with Crystal A/D and
2698 D/As on the SACSng board)
2699
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002700 CONFIG_SH_SPI
2701
2702 Enables the driver for SPI controller on SuperH. Currently
2703 only SH7757 is supported.
2704
wdenkc6097192002-11-03 00:24:07 +00002705 CONFIG_SPI_X
2706
2707 Enables extended (16-bit) SPI EEPROM addressing.
2708 (symmetrical to CONFIG_I2C_X)
2709
2710 CONFIG_SOFT_SPI
2711
wdenk4a5c8a72003-03-06 00:02:04 +00002712 Enables a software (bit-bang) SPI driver rather than
2713 using hardware support. This is a general purpose
2714 driver that only requires three general I/O port pins
2715 (two outputs, one input) to function. If this is
2716 defined, the board configuration must define several
2717 SPI configuration items (port pins to use, etc). For
2718 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002719
Ben Warren7efe9272008-01-16 22:37:35 -05002720 CONFIG_HARD_SPI
2721
2722 Enables a hardware SPI driver for general-purpose reads
2723 and writes. As with CONFIG_SOFT_SPI, the board configuration
2724 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002725 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002726 example, see include/configs/mpc8349emds.h.
2727
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002728 CONFIG_MXC_SPI
2729
2730 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002731 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002732
Heiko Schocherb77c8882014-07-14 10:22:11 +02002733 CONFIG_SYS_SPI_MXC_WAIT
2734 Timeout for waiting until spi transfer completed.
2735 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2736
Matthias Fuchsa4400872007-12-27 17:12:34 +01002737- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002738
Matthias Fuchsa4400872007-12-27 17:12:34 +01002739 Enables FPGA subsystem.
2740
2741 CONFIG_FPGA_<vendor>
2742
2743 Enables support for specific chip vendors.
2744 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002745
Matthias Fuchsa4400872007-12-27 17:12:34 +01002746 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002747
Matthias Fuchsa4400872007-12-27 17:12:34 +01002748 Enables support for FPGA family.
2749 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2750
2751 CONFIG_FPGA_COUNT
2752
2753 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002754
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302755 CONFIG_CMD_FPGA_LOADMK
2756
2757 Enable support for fpga loadmk command
2758
Michal Simek64c70982014-05-02 13:43:39 +02002759 CONFIG_CMD_FPGA_LOADP
2760
2761 Enable support for fpga loadp command - load partial bitstream
2762
2763 CONFIG_CMD_FPGA_LOADBP
2764
2765 Enable support for fpga loadbp command - load partial bitstream
2766 (Xilinx only)
2767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002768 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002769
wdenk57b2d802003-06-27 21:31:46 +00002770 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002772 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002773
wdenk4a5c8a72003-03-06 00:02:04 +00002774 Enable checks on FPGA configuration interface busy
2775 status by the configuration function. This option
2776 will require a board or device specific function to
2777 be written.
wdenkc6097192002-11-03 00:24:07 +00002778
2779 CONFIG_FPGA_DELAY
2780
2781 If defined, a function that provides delays in the FPGA
2782 configuration driver.
2783
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002784 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002785 Allow Control-C to interrupt FPGA configuration
2786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002787 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002788
wdenk4a5c8a72003-03-06 00:02:04 +00002789 Check for configuration errors during FPGA bitfile
2790 loading. For example, abort during Virtex II
2791 configuration if the INIT_B line goes low (which
2792 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002794 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002795
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002796 Maximum time to wait for the INIT_B line to de-assert
2797 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002798 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002799 ms.
wdenkc6097192002-11-03 00:24:07 +00002800
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002801 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002802
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002803 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002804 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002806 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk4a5c8a72003-03-06 00:02:04 +00002808 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002809 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002810
2811- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002812 CONFIG_BUILD_TARGET
2813
2814 Some SoCs need special image types (e.g. U-Boot binary
2815 with a special header) as build targets. By defining
2816 CONFIG_BUILD_TARGET in the SoC / board header, this
2817 special image will be automatically built upon calling
2818 make / MAKEALL.
2819
wdenkc6097192002-11-03 00:24:07 +00002820 CONFIG_IDENT_STRING
2821
wdenk4a5c8a72003-03-06 00:02:04 +00002822 If defined, this string will be added to the U-Boot
2823 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002824
2825- Vendor Parameter Protection:
2826
wdenk4a5c8a72003-03-06 00:02:04 +00002827 U-Boot considers the values of the environment
2828 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002829 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002830 are set once by the board vendor / manufacturer, and
2831 protects these variables from casual modification by
2832 the user. Once set, these variables are read-only,
2833 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002834 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002835
2836 If CONFIG_ENV_OVERWRITE is #defined in your config
2837 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002838 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002839 these parameters.
2840
Joe Hershberger76f353e2015-05-04 14:55:14 -05002841 Alternatively, if you define _both_ an ethaddr in the
2842 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002843 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002844 which can be changed exactly ONCE by the user. [The
2845 serial# is unaffected by this, i. e. it remains
2846 read-only.]
2847
Joe Hershberger71497d02012-12-11 22:16:31 -06002848 The same can be accomplished in a more flexible way
2849 for any variable by configuring the type of access
2850 to allow for those variables in the ".flags" variable
2851 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2852
wdenkc6097192002-11-03 00:24:07 +00002853- Protected RAM:
2854 CONFIG_PRAM
2855
2856 Define this variable to enable the reservation of
2857 "protected RAM", i. e. RAM which is not overwritten
2858 by U-Boot. Define CONFIG_PRAM to hold the number of
2859 kB you want to reserve for pRAM. You can overwrite
2860 this default value by defining an environment
2861 variable "pram" to the number of kB you want to
2862 reserve. Note that the board info structure will
2863 still show the full amount of RAM. If pRAM is
2864 reserved, a new environment variable "mem" will
2865 automatically be defined to hold the amount of
2866 remaining RAM in a form that can be passed as boot
2867 argument to Linux, for instance like that:
2868
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002869 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002870 saveenv
2871
2872 This way you can tell Linux not to use this memory,
2873 either, which results in a memory region that will
2874 not be affected by reboots.
2875
2876 *WARNING* If your board configuration uses automatic
2877 detection of the RAM size, you must make sure that
2878 this memory test is non-destructive. So far, the
2879 following board configurations are known to be
2880 "pRAM-clean":
2881
Wolfgang Denk90326762012-10-24 02:36:15 +00002882 IVMS8, IVML24, SPD8xx, TQM8xxL,
2883 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002884 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002885
Gabe Blacka2f3a932012-12-02 04:55:18 +00002886- Access to physical memory region (> 4GB)
2887 Some basic support is provided for operations on memory not
2888 normally accessible to U-Boot - e.g. some architectures
2889 support access to more than 4GB of memory on 32-bit
2890 machines using physical address extension or similar.
2891 Define CONFIG_PHYSMEM to access this basic support, which
2892 currently only supports clearing the memory.
2893
wdenkc6097192002-11-03 00:24:07 +00002894- Error Recovery:
2895 CONFIG_PANIC_HANG
2896
2897 Define this variable to stop the system in case of a
2898 fatal error, so that you have to reset it manually.
2899 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002900 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002901 automatically as fast as possible, but it may be
2902 useful during development since you can try to debug
2903 the conditions that lead to the situation.
2904
2905 CONFIG_NET_RETRY_COUNT
2906
wdenk4a5c8a72003-03-06 00:02:04 +00002907 This variable defines the number of retries for
2908 network operations like ARP, RARP, TFTP, or BOOTP
2909 before giving up the operation. If not defined, a
2910 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002911
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002912 CONFIG_ARP_TIMEOUT
2913
2914 Timeout waiting for an ARP reply in milliseconds.
2915
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002916 CONFIG_NFS_TIMEOUT
2917
2918 Timeout in milliseconds used in NFS protocol.
2919 If you encounter "ERROR: Cannot umount" in nfs command,
2920 try longer timeout such as
2921 #define CONFIG_NFS_TIMEOUT 10000UL
2922
wdenkc6097192002-11-03 00:24:07 +00002923- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002924 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002925
2926 Enable auto completion of commands using TAB.
2927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002928 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002929
2930 This defines the secondary prompt string, which is
2931 printed when the command interpreter needs more input
2932 to complete a command. Usually "> ".
2933
2934 Note:
2935
wdenk57b2d802003-06-27 21:31:46 +00002936 In the current implementation, the local variables
2937 space and global environment variables space are
2938 separated. Local variables are those you define by
2939 simply typing `name=value'. To access a local
2940 variable later on, you have write `$name' or
2941 `${name}'; to execute the contents of a variable
2942 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk4a5c8a72003-03-06 00:02:04 +00002944 Global environment variables are those you use
2945 setenv/printenv to work with. To run a command stored
2946 in such a variable, you need to use the run command,
2947 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002948
2949 To store commands and special characters in a
2950 variable, please use double quotation marks
2951 surrounding the whole text of the variable, instead
2952 of the backslashes before semicolons and special
2953 symbols.
2954
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002955- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002956 CONFIG_CMDLINE_EDITING
2957
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002958 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002959 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002960
wdenkc0aa5c52003-12-06 19:49:23 +00002961- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002962 CONFIG_EXTRA_ENV_SETTINGS
2963
wdenk4a5c8a72003-03-06 00:02:04 +00002964 Define this to contain any number of null terminated
2965 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002966 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002967
wdenk4a5c8a72003-03-06 00:02:04 +00002968 For example, place something like this in your
2969 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002970
2971 #define CONFIG_EXTRA_ENV_SETTINGS \
2972 "myvar1=value1\0" \
2973 "myvar2=value2\0"
2974
wdenk4a5c8a72003-03-06 00:02:04 +00002975 Warning: This method is based on knowledge about the
2976 internal format how the environment is stored by the
2977 U-Boot code. This is NOT an official, exported
2978 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002979 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002980 You better know what you are doing here.
2981
wdenk4a5c8a72003-03-06 00:02:04 +00002982 Note: overly (ab)use of the default environment is
2983 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002984 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002985 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002986
Stephen Warren1465d5f2012-05-22 09:21:54 +00002987 CONFIG_ENV_VARS_UBOOT_CONFIG
2988
2989 Define this in order to add variables describing the
2990 U-Boot build configuration to the default environment.
2991 These will be named arch, cpu, board, vendor, and soc.
2992
2993 Enabling this option will cause the following to be defined:
2994
2995 - CONFIG_SYS_ARCH
2996 - CONFIG_SYS_CPU
2997 - CONFIG_SYS_BOARD
2998 - CONFIG_SYS_VENDOR
2999 - CONFIG_SYS_SOC
3000
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003001 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3002
3003 Define this in order to add variables describing certain
3004 run-time determined information about the hardware to the
3005 environment. These will be named board_name, board_rev.
3006
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003007 CONFIG_DELAY_ENVIRONMENT
3008
3009 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003010 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003011 that so that the environment is not available until
3012 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3013 this is instead controlled by the value of
3014 /config/load-environment.
3015
Chris Packham2216ddb2015-06-19 20:25:59 +12003016- Parallel Flash support:
3017 CONFIG_SYS_NO_FLASH
3018
3019 Traditionally U-boot was run on systems with parallel NOR
3020 flash. This option is used to disable support for parallel NOR
3021 flash. This option should be defined if the board does not have
3022 parallel flash.
3023
3024 If this option is not defined one of the generic flash drivers
3025 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
3026 selected or the board must provide an implementation of the
3027 flash API (see include/flash.h).
3028
wdenkc0aa5c52003-12-06 19:49:23 +00003029- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003030 CONFIG_HAS_DATAFLASH
3031
wdenk57b2d802003-06-27 21:31:46 +00003032 Defining this option enables DataFlash features and
3033 allows to read/write in Dataflash via the standard
3034 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003035
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003036- Serial Flash support
3037 CONFIG_CMD_SF
3038
3039 Defining this option enables SPI flash commands
3040 'sf probe/read/write/erase/update'.
3041
3042 Usage requires an initial 'probe' to define the serial
3043 flash parameters, followed by read/write/erase/update
3044 commands.
3045
3046 The following defaults may be provided by the platform
3047 to handle the common case when only a single serial
3048 flash is present on the system.
3049
3050 CONFIG_SF_DEFAULT_BUS Bus identifier
3051 CONFIG_SF_DEFAULT_CS Chip-select
3052 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3053 CONFIG_SF_DEFAULT_SPEED in Hz
3054
Simon Glass4b5545e2012-10-08 13:16:02 +00003055 CONFIG_CMD_SF_TEST
3056
3057 Define this option to include a destructive SPI flash
3058 test ('sf test').
3059
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303060 CONFIG_SF_DUAL_FLASH Dual flash memories
3061
3062 Define this option to use dual flash support where two flash
3063 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003064 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303065
wdenkef893942004-02-23 16:11:30 +00003066- SystemACE Support:
3067 CONFIG_SYSTEMACE
3068
3069 Adding this option adds support for Xilinx SystemACE
3070 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003071 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003073
3074 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003075 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003076
3077 When SystemACE support is added, the "ace" device type
3078 becomes available to the fat commands, i.e. fatls.
3079
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003080- TFTP Fixed UDP Port:
3081 CONFIG_TFTP_PORT
3082
Wolfgang Denk227b5192005-09-24 23:25:46 +02003083 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003084 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003085 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003086 number generator is used.
3087
Wolfgang Denk227b5192005-09-24 23:25:46 +02003088 Also, the environment variable tftpdstp is used to supply
3089 the TFTP UDP destination port value. If tftpdstp isn't
3090 defined, the normal port 69 is used.
3091
3092 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003093 blindly start the TFTP transfer using the pre-configured
3094 target IP address and UDP port. This has the effect of
3095 "punching through" the (Windows XP) firewall, allowing
3096 the remainder of the TFTP transfer to proceed normally.
3097 A better solution is to properly configure the firewall,
3098 but sometimes that is not allowed.
3099
Simon Glass058bb8d2012-12-05 14:46:38 +00003100- Hashing support:
3101 CONFIG_CMD_HASH
3102
3103 This enables a generic 'hash' command which can produce
3104 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3105
3106 CONFIG_HASH_VERIFY
3107
3108 Enable the hash verify command (hash -v). This adds to code
3109 size a little.
3110
gaurav ranaef201592015-02-20 12:51:46 +05303111 CONFIG_SHA1 - This option enables support of hashing using SHA1
3112 algorithm. The hash is calculated in software.
3113 CONFIG_SHA256 - This option enables support of hashing using
3114 SHA256 algorithm. The hash is calculated in software.
3115 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3116 for SHA1/SHA256 hashing.
3117 This affects the 'hash' command and also the
3118 hash_lookup_algo() function.
3119 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3120 hardware-acceleration for SHA1/SHA256 progressive hashing.
3121 Data can be streamed in a block at a time and the hashing
3122 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003123
3124 Note: There is also a sha1sum command, which should perhaps
3125 be deprecated in favour of 'hash sha1'.
3126
Robert Winkler765ccf42013-07-24 17:57:06 -07003127- Freescale i.MX specific commands:
3128 CONFIG_CMD_HDMIDETECT
3129 This enables 'hdmidet' command which returns true if an
3130 HDMI monitor is detected. This command is i.MX 6 specific.
3131
3132 CONFIG_CMD_BMODE
3133 This enables the 'bmode' (bootmode) command for forcing
3134 a boot from specific media.
3135
3136 This is useful for forcing the ROM's usb downloader to
3137 activate upon a watchdog reset which is nice when iterating
3138 on U-Boot. Using the reset button or running bmode normal
3139 will set it back to normal. This command currently
3140 supports i.MX53 and i.MX6.
3141
Simon Glass35191a32013-06-13 15:10:02 -07003142- Signing support:
3143 CONFIG_RSA
3144
3145 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003146 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003147
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303148 The Modular Exponentiation algorithm in RSA is implemented using
3149 driver model. So CONFIG_DM needs to be enabled by default for this
3150 library to function.
3151
Simon Glass35191a32013-06-13 15:10:02 -07003152 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303153 option. The software based modular exponentiation is built into
3154 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003155
Heiko Schocher443ca402014-01-25 07:27:13 +01003156- bootcount support:
3157 CONFIG_BOOTCOUNT_LIMIT
3158
3159 This enables the bootcounter support, see:
3160 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3161
3162 CONFIG_AT91SAM9XE
3163 enable special bootcounter support on at91sam9xe based boards.
3164 CONFIG_BLACKFIN
3165 enable special bootcounter support on blackfin based boards.
3166 CONFIG_SOC_DA8XX
3167 enable special bootcounter support on da850 based boards.
3168 CONFIG_BOOTCOUNT_RAM
3169 enable support for the bootcounter in RAM
3170 CONFIG_BOOTCOUNT_I2C
3171 enable support for the bootcounter on an i2c (like RTC) device.
3172 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3173 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3174 the bootcounter.
3175 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003176
wdenkc0aa5c52003-12-06 19:49:23 +00003177- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003178 CONFIG_SHOW_BOOT_PROGRESS
3179
wdenk4a5c8a72003-03-06 00:02:04 +00003180 Defining this option allows to add some board-
3181 specific code (calling a user-provided function
3182 "show_boot_progress(int)") that enables you to show
3183 the system's boot progress on some display (for
3184 example, some LED's) on your board. At the moment,
3185 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003186
Simon Glass0fa36a42012-09-28 08:56:37 +00003187
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003188Legacy uImage format:
3189
wdenkc6097192002-11-03 00:24:07 +00003190 Arg Where When
3191 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003192 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003193 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003194 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003195 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003196 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003197 4 common/cmd_bootm.c Image data has correct checksum
3198 -4 common/cmd_bootm.c Image is for unsupported architecture
3199 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003200 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003201 6 common/cmd_bootm.c Image Type check OK
3202 -6 common/cmd_bootm.c gunzip uncompression error
3203 -7 common/cmd_bootm.c Unimplemented compression type
3204 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003205 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003206 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003207
3208 9 common/image.c Start initial ramdisk verification
3209 -10 common/image.c Ramdisk header has bad magic number
3210 -11 common/image.c Ramdisk header has bad checksum
3211 10 common/image.c Ramdisk header is OK
3212 -12 common/image.c Ramdisk data has bad checksum
3213 11 common/image.c Ramdisk data has correct checksum
3214 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003215 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003216 13 common/image.c Start multifile image verification
3217 14 common/image.c No initial ramdisk, no multifile, continue.
3218
Wolfgang Denk092ae952011-10-26 10:21:21 +00003219 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003220
Stefan Roese88fbf932010-04-15 16:07:28 +02003221 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003222 -31 post/post.c POST test failed, detected by post_output_backlog()
3223 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003224
Heiko Schocher633e03a2007-06-22 19:11:54 +02003225 34 common/cmd_doc.c before loading a Image from a DOC device
3226 -35 common/cmd_doc.c Bad usage of "doc" command
3227 35 common/cmd_doc.c correct usage of "doc" command
3228 -36 common/cmd_doc.c No boot device
3229 36 common/cmd_doc.c correct boot device
3230 -37 common/cmd_doc.c Unknown Chip ID on boot device
3231 37 common/cmd_doc.c correct chip ID found, device available
3232 -38 common/cmd_doc.c Read Error on boot device
3233 38 common/cmd_doc.c reading Image header from DOC device OK
3234 -39 common/cmd_doc.c Image header has bad magic number
3235 39 common/cmd_doc.c Image header has correct magic number
3236 -40 common/cmd_doc.c Error reading Image from DOC device
3237 40 common/cmd_doc.c Image header has correct magic number
3238 41 common/cmd_ide.c before loading a Image from a IDE device
3239 -42 common/cmd_ide.c Bad usage of "ide" command
3240 42 common/cmd_ide.c correct usage of "ide" command
3241 -43 common/cmd_ide.c No boot device
3242 43 common/cmd_ide.c boot device found
3243 -44 common/cmd_ide.c Device not available
3244 44 common/cmd_ide.c Device available
3245 -45 common/cmd_ide.c wrong partition selected
3246 45 common/cmd_ide.c partition selected
3247 -46 common/cmd_ide.c Unknown partition table
3248 46 common/cmd_ide.c valid partition table found
3249 -47 common/cmd_ide.c Invalid partition type
3250 47 common/cmd_ide.c correct partition type
3251 -48 common/cmd_ide.c Error reading Image Header on boot device
3252 48 common/cmd_ide.c reading Image Header from IDE device OK
3253 -49 common/cmd_ide.c Image header has bad magic number
3254 49 common/cmd_ide.c Image header has correct magic number
3255 -50 common/cmd_ide.c Image header has bad checksum
3256 50 common/cmd_ide.c Image header has correct checksum
3257 -51 common/cmd_ide.c Error reading Image from IDE device
3258 51 common/cmd_ide.c reading Image from IDE device OK
3259 52 common/cmd_nand.c before loading a Image from a NAND device
3260 -53 common/cmd_nand.c Bad usage of "nand" command
3261 53 common/cmd_nand.c correct usage of "nand" command
3262 -54 common/cmd_nand.c No boot device
3263 54 common/cmd_nand.c boot device found
3264 -55 common/cmd_nand.c Unknown Chip ID on boot device
3265 55 common/cmd_nand.c correct chip ID found, device available
3266 -56 common/cmd_nand.c Error reading Image Header on boot device
3267 56 common/cmd_nand.c reading Image Header from NAND device OK
3268 -57 common/cmd_nand.c Image header has bad magic number
3269 57 common/cmd_nand.c Image header has correct magic number
3270 -58 common/cmd_nand.c Error reading Image from NAND device
3271 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003272
Heiko Schocher633e03a2007-06-22 19:11:54 +02003273 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003274
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003275 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003276 -64 net/eth.c no Ethernet found.
3277 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003278
Heiko Schocher633e03a2007-06-22 19:11:54 +02003279 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003280 80 common/cmd_net.c before calling net_loop()
3281 -81 common/cmd_net.c some error in net_loop() occurred
3282 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003283 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3284 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003285 83 common/cmd_net.c running "source" command
3286 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003287 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003288
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003289FIT uImage format:
3290
3291 Arg Where When
3292 100 common/cmd_bootm.c Kernel FIT Image has correct format
3293 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3294 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3295 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3296 102 common/cmd_bootm.c Kernel unit name specified
3297 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003298 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003299 104 common/cmd_bootm.c Got kernel subimage node offset
3300 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3301 105 common/cmd_bootm.c Kernel subimage hash verification OK
3302 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3303 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003304 -106 common/cmd_bootm.c Kernel subimage has wrong type
3305 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003306 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3307 108 common/cmd_bootm.c Got kernel subimage data/size
3308 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3309 -109 common/cmd_bootm.c Can't get kernel subimage type
3310 -110 common/cmd_bootm.c Can't get kernel subimage comp
3311 -111 common/cmd_bootm.c Can't get kernel subimage os
3312 -112 common/cmd_bootm.c Can't get kernel subimage load address
3313 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3314
3315 120 common/image.c Start initial ramdisk verification
3316 -120 common/image.c Ramdisk FIT image has incorrect format
3317 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003318 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003319 -122 common/image.c Can't get configuration for ramdisk subimage
3320 123 common/image.c Ramdisk unit name specified
3321 -124 common/image.c Can't get ramdisk subimage node offset
3322 125 common/image.c Got ramdisk subimage node offset
3323 -125 common/image.c Ramdisk subimage hash verification failed
3324 126 common/image.c Ramdisk subimage hash verification OK
3325 -126 common/image.c Ramdisk subimage for unsupported architecture
3326 127 common/image.c Architecture check OK
3327 -127 common/image.c Can't get ramdisk subimage data/size
3328 128 common/image.c Got ramdisk subimage data/size
3329 129 common/image.c Can't get ramdisk load address
3330 -129 common/image.c Got ramdisk load address
3331
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003332 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003333 131 common/cmd_doc.c FIT image format OK
3334
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003335 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003336 141 common/cmd_ide.c FIT image format OK
3337
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003338 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003339 151 common/cmd_nand.c FIT image format OK
3340
Heiko Schocher515eb122014-05-28 11:33:33 +02003341- legacy image format:
3342 CONFIG_IMAGE_FORMAT_LEGACY
3343 enables the legacy image format support in U-Boot.
3344
3345 Default:
3346 enabled if CONFIG_FIT_SIGNATURE is not defined.
3347
3348 CONFIG_DISABLE_IMAGE_LEGACY
3349 disable the legacy image format
3350
3351 This define is introduced, as the legacy image format is
3352 enabled per default for backward compatibility.
3353
Gabe Blackd572e162012-10-25 16:31:10 +00003354- FIT image support:
3355 CONFIG_FIT
3356 Enable support for the FIT uImage format.
3357
3358 CONFIG_FIT_BEST_MATCH
3359 When no configuration is explicitly selected, default to the
3360 one whose fdt's compatibility field best matches that of
3361 U-Boot itself. A match is considered "best" if it matches the
3362 most specific compatibility entry of U-Boot's fdt's root node.
3363 The order of entries in the configuration's fdt is ignored.
3364
Simon Glass58fe7e52013-06-13 15:10:00 -07003365 CONFIG_FIT_SIGNATURE
3366 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303367 using a hash signed and verified using RSA. If
3368 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3369 hashing is available using hardware, RSA library will use it.
3370 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003371
Heiko Schocher515eb122014-05-28 11:33:33 +02003372 WARNING: When relying on signed FIT images with required
3373 signature check the legacy image format is default
3374 disabled. If a board need legacy image format support
3375 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3376
Dirk Eibach88919ca2014-07-03 09:28:26 +02003377 CONFIG_FIT_DISABLE_SHA256
3378 Supporting SHA256 hashes has quite an impact on binary size.
3379 For constrained systems sha256 hash support can be disabled
3380 with this option.
3381
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003382- Standalone program support:
3383 CONFIG_STANDALONE_LOAD_ADDR
3384
Wolfgang Denk23f78482011-10-09 21:06:34 +02003385 This option defines a board specific value for the
3386 address where standalone program gets loaded, thus
3387 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003388 settings.
3389
3390- Frame Buffer Address:
3391 CONFIG_FB_ADDR
3392
3393 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003394 address for frame buffer. This is typically the case
3395 when using a graphics controller has separate video
3396 memory. U-Boot will then place the frame buffer at
3397 the given address instead of dynamically reserving it
3398 in system RAM by calling lcd_setmem(), which grabs
3399 the memory for the frame buffer depending on the
3400 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003401
3402 Please see board_init_f function.
3403
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003404- Automatic software updates via TFTP server
3405 CONFIG_UPDATE_TFTP
3406 CONFIG_UPDATE_TFTP_CNT_MAX
3407 CONFIG_UPDATE_TFTP_MSEC_MAX
3408
3409 These options enable and control the auto-update feature;
3410 for a more detailed description refer to doc/README.update.
3411
3412- MTD Support (mtdparts command, UBI support)
3413 CONFIG_MTD_DEVICE
3414
3415 Adds the MTD device infrastructure from the Linux kernel.
3416 Needed for mtdparts command support.
3417
3418 CONFIG_MTD_PARTITIONS
3419
3420 Adds the MTD partitioning infrastructure from the Linux
3421 kernel. Needed for UBI support.
3422
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003423- UBI support
3424 CONFIG_CMD_UBI
3425
3426 Adds commands for interacting with MTD partitions formatted
3427 with the UBI flash translation layer
3428
3429 Requires also defining CONFIG_RBTREE
3430
Joe Hershberger47550fc2013-04-08 10:32:49 +00003431 CONFIG_UBI_SILENCE_MSG
3432
3433 Make the verbose messages from UBI stop printing. This leaves
3434 warnings and errors enabled.
3435
Heiko Schocherf5895d12014-06-24 10:10:04 +02003436
3437 CONFIG_MTD_UBI_WL_THRESHOLD
3438 This parameter defines the maximum difference between the highest
3439 erase counter value and the lowest erase counter value of eraseblocks
3440 of UBI devices. When this threshold is exceeded, UBI starts performing
3441 wear leveling by means of moving data from eraseblock with low erase
3442 counter to eraseblocks with high erase counter.
3443
3444 The default value should be OK for SLC NAND flashes, NOR flashes and
3445 other flashes which have eraseblock life-cycle 100000 or more.
3446 However, in case of MLC NAND flashes which typically have eraseblock
3447 life-cycle less than 10000, the threshold should be lessened (e.g.,
3448 to 128 or 256, although it does not have to be power of 2).
3449
3450 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003451
Heiko Schocherf5895d12014-06-24 10:10:04 +02003452 CONFIG_MTD_UBI_BEB_LIMIT
3453 This option specifies the maximum bad physical eraseblocks UBI
3454 expects on the MTD device (per 1024 eraseblocks). If the
3455 underlying flash does not admit of bad eraseblocks (e.g. NOR
3456 flash), this value is ignored.
3457
3458 NAND datasheets often specify the minimum and maximum NVM
3459 (Number of Valid Blocks) for the flashes' endurance lifetime.
3460 The maximum expected bad eraseblocks per 1024 eraseblocks
3461 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3462 which gives 20 for most NANDs (MaxNVB is basically the total
3463 count of eraseblocks on the chip).
3464
3465 To put it differently, if this value is 20, UBI will try to
3466 reserve about 1.9% of physical eraseblocks for bad blocks
3467 handling. And that will be 1.9% of eraseblocks on the entire
3468 NAND chip, not just the MTD partition UBI attaches. This means
3469 that if you have, say, a NAND flash chip admits maximum 40 bad
3470 eraseblocks, and it is split on two MTD partitions of the same
3471 size, UBI will reserve 40 eraseblocks when attaching a
3472 partition.
3473
3474 default: 20
3475
3476 CONFIG_MTD_UBI_FASTMAP
3477 Fastmap is a mechanism which allows attaching an UBI device
3478 in nearly constant time. Instead of scanning the whole MTD device it
3479 only has to locate a checkpoint (called fastmap) on the device.
3480 The on-flash fastmap contains all information needed to attach
3481 the device. Using fastmap makes only sense on large devices where
3482 attaching by scanning takes long. UBI will not automatically install
3483 a fastmap on old images, but you can set the UBI parameter
3484 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3485 that fastmap-enabled images are still usable with UBI implementations
3486 without fastmap support. On typical flash devices the whole fastmap
3487 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3488
3489 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3490 Set this parameter to enable fastmap automatically on images
3491 without a fastmap.
3492 default: 0
3493
Heiko Schocher94b66de2015-10-22 06:19:21 +02003494 CONFIG_MTD_UBI_FM_DEBUG
3495 Enable UBI fastmap debug
3496 default: 0
3497
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003498- UBIFS support
3499 CONFIG_CMD_UBIFS
3500
3501 Adds commands for interacting with UBI volumes formatted as
3502 UBIFS. UBIFS is read-only in u-boot.
3503
3504 Requires UBI support as well as CONFIG_LZO
3505
Joe Hershberger47550fc2013-04-08 10:32:49 +00003506 CONFIG_UBIFS_SILENCE_MSG
3507
3508 Make the verbose messages from UBIFS stop printing. This leaves
3509 warnings and errors enabled.
3510
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003511- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003512 CONFIG_SPL
3513 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003514
Tom Rini36853852012-02-14 07:29:40 +00003515 CONFIG_SPL_LDSCRIPT
3516 LDSCRIPT for linking the SPL binary.
3517
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003518 CONFIG_SPL_MAX_FOOTPRINT
3519 Maximum size in memory allocated to the SPL, BSS included.
3520 When defined, the linker checks that the actual memory
3521 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003522 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003523 must not be both defined at the same time.
3524
Tom Rini36853852012-02-14 07:29:40 +00003525 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003526 Maximum size of the SPL image (text, data, rodata, and
3527 linker lists sections), BSS excluded.
3528 When defined, the linker checks that the actual size does
3529 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003530
Wolfgang Denk825223d2011-09-11 21:24:09 +02003531 CONFIG_SPL_TEXT_BASE
3532 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003533
Scott Woodc4f0d002012-09-20 19:05:12 -05003534 CONFIG_SPL_RELOC_TEXT_BASE
3535 Address to relocate to. If unspecified, this is equal to
3536 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3537
Tom Rini36853852012-02-14 07:29:40 +00003538 CONFIG_SPL_BSS_START_ADDR
3539 Link address for the BSS within the SPL binary.
3540
3541 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003542 Maximum size in memory allocated to the SPL BSS.
3543 When defined, the linker checks that the actual memory used
3544 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003545 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003546 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003547
3548 CONFIG_SPL_STACK
3549 Adress of the start of the stack SPL will use
3550
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003551 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3552 When defined, SPL will panic() if the image it has
3553 loaded does not have a signature.
3554 Defining this is useful when code which loads images
3555 in SPL cannot guarantee that absolutely all read errors
3556 will be caught.
3557 An example is the LPC32XX MLC NAND driver, which will
3558 consider that a completely unreadable NAND block is bad,
3559 and thus should be skipped silently.
3560
Scott Woodc4f0d002012-09-20 19:05:12 -05003561 CONFIG_SPL_RELOC_STACK
3562 Adress of the start of the stack SPL will use after
3563 relocation. If unspecified, this is equal to
3564 CONFIG_SPL_STACK.
3565
Tom Rini36853852012-02-14 07:29:40 +00003566 CONFIG_SYS_SPL_MALLOC_START
3567 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003568 When this option is set the full malloc is used in SPL and
3569 it is set up by spl_init() and before that, the simple malloc()
3570 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003571
3572 CONFIG_SYS_SPL_MALLOC_SIZE
3573 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003574
Tom Rini28591df2012-08-13 12:03:19 -07003575 CONFIG_SPL_FRAMEWORK
3576 Enable the SPL framework under common/. This framework
3577 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3578 NAND loading of the Linux Kernel.
3579
Tom Rinic2b76002014-03-28 12:03:39 -04003580 CONFIG_SPL_OS_BOOT
3581 Enable booting directly to an OS from SPL.
3582 See also: doc/README.falcon
3583
Tom Rinife3b0c72012-08-13 11:37:56 -07003584 CONFIG_SPL_DISPLAY_PRINT
3585 For ARM, enable an optional function to print more information
3586 about the running system.
3587
Scott Wood7c810902012-09-20 16:35:21 -05003588 CONFIG_SPL_INIT_MINIMAL
3589 Arch init code should be built for a very small image
3590
Wolfgang Denk825223d2011-09-11 21:24:09 +02003591 CONFIG_SPL_LIBCOMMON_SUPPORT
3592 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003593
Wolfgang Denk825223d2011-09-11 21:24:09 +02003594 CONFIG_SPL_LIBDISK_SUPPORT
3595 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003596
Wolfgang Denk825223d2011-09-11 21:24:09 +02003597 CONFIG_SPL_I2C_SUPPORT
3598 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003599
Wolfgang Denk825223d2011-09-11 21:24:09 +02003600 CONFIG_SPL_GPIO_SUPPORT
3601 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003602
Wolfgang Denk825223d2011-09-11 21:24:09 +02003603 CONFIG_SPL_MMC_SUPPORT
3604 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003605
Tom Rini36853852012-02-14 07:29:40 +00003606 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3607 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003608 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003609 when the MMC is being used in raw mode.
3610
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003611 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3612 Partition on the MMC to load U-Boot from when the MMC is being
3613 used in raw mode
3614
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003615 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3616 Sector to load kernel uImage from when MMC is being
3617 used in raw mode (for Falcon mode)
3618
3619 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3620 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3621 Sector and number of sectors to load kernel argument
3622 parameters from when MMC is being used in raw mode
3623 (for falcon mode)
3624
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003625 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3626 Partition on the MMC to load U-Boot from when the MMC is being
3627 used in fs mode
3628
Tom Rini36853852012-02-14 07:29:40 +00003629 CONFIG_SPL_FAT_SUPPORT
3630 Support for fs/fat/libfat.o in SPL binary
3631
Guillaume GARDET5065b712014-10-15 17:53:13 +02003632 CONFIG_SPL_EXT_SUPPORT
3633 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003634
Guillaume GARDET5065b712014-10-15 17:53:13 +02003635 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3636 Filename to read to load U-Boot when reading from filesystem
3637
3638 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003639 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003640 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003641
Guillaume GARDET5065b712014-10-15 17:53:13 +02003642 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003643 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003644 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003645
Scott Wood2b36fbb2012-12-06 13:33:17 +00003646 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3647 Set this for NAND SPL on PPC mpc83xx targets, so that
3648 start.S waits for the rest of the SPL to load before
3649 continuing (the hardware starts execution after just
3650 loading the first page rather than the full 4K).
3651
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303652 CONFIG_SPL_SKIP_RELOCATE
3653 Avoid SPL relocation
3654
Scott Woodc352a0c2012-09-20 19:09:07 -05003655 CONFIG_SPL_NAND_BASE
3656 Include nand_base.c in the SPL. Requires
3657 CONFIG_SPL_NAND_DRIVERS.
3658
3659 CONFIG_SPL_NAND_DRIVERS
3660 SPL uses normal NAND drivers, not minimal drivers.
3661
3662 CONFIG_SPL_NAND_ECC
3663 Include standard software ECC in the SPL
3664
Tom Rini36853852012-02-14 07:29:40 +00003665 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003666 Support for NAND boot using simple NAND drivers that
3667 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003668
Tom Rini543c9f12014-03-28 12:03:36 -04003669 CONFIG_SPL_MTD_SUPPORT
3670 Support for the MTD subsystem within SPL. Useful for
3671 environment on NAND support within SPL.
3672
Heiko Schochercf000272014-10-31 08:31:00 +01003673 CONFIG_SPL_NAND_RAW_ONLY
3674 Support to boot only raw u-boot.bin images. Use this only
3675 if you need to save space.
3676
Ying Zhang9ff70262013-08-16 15:16:11 +08003677 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3678 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003679 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003680
Ying Zhangdfb2b152013-08-16 15:16:12 +08003681 CONFIG_SPL_COMMON_INIT_DDR
3682 Set for common ddr init with serial presence detect in
3683 SPL binary.
3684
Tom Rini36853852012-02-14 07:29:40 +00003685 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3686 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3687 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3688 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3689 CONFIG_SYS_NAND_ECCBYTES
3690 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003691 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003692
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303693 CONFIG_SPL_NAND_BOOT
3694 Add support NAND boot
3695
Tom Rini36853852012-02-14 07:29:40 +00003696 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003697 Location in NAND to read U-Boot from
3698
3699 CONFIG_SYS_NAND_U_BOOT_DST
3700 Location in memory to load U-Boot to
3701
3702 CONFIG_SYS_NAND_U_BOOT_SIZE
3703 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003704
3705 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003706 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003707
3708 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3709 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003710 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003711
3712 CONFIG_SPL_OMAP3_ID_NAND
3713 Support for an OMAP3-specific set of functions to return the
3714 ID and MFR of the first attached NAND chip, if present.
3715
Wolfgang Denk825223d2011-09-11 21:24:09 +02003716 CONFIG_SPL_SERIAL_SUPPORT
3717 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003718
Wolfgang Denk825223d2011-09-11 21:24:09 +02003719 CONFIG_SPL_SPI_FLASH_SUPPORT
3720 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003721
Wolfgang Denk825223d2011-09-11 21:24:09 +02003722 CONFIG_SPL_SPI_SUPPORT
3723 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003724
Pavel Machekde997252012-08-30 22:42:11 +02003725 CONFIG_SPL_RAM_DEVICE
3726 Support for running image already present in ram, in SPL binary
3727
Wolfgang Denk825223d2011-09-11 21:24:09 +02003728 CONFIG_SPL_LIBGENERIC_SUPPORT
3729 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003730
Ying Zhang602f7d32013-05-20 14:07:25 +08003731 CONFIG_SPL_ENV_SUPPORT
3732 Support for the environment operating in SPL binary
3733
3734 CONFIG_SPL_NET_SUPPORT
3735 Support for the net/libnet.o in SPL binary.
3736 It conflicts with SPL env from storage medium specified by
3737 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3738
Scott Woodeb7bd972012-12-06 13:33:16 +00003739 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003740 Image offset to which the SPL should be padded before appending
3741 the SPL payload. By default, this is defined as
3742 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3743 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3744 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003745
Scott Woodf147eb72012-09-21 16:27:32 -05003746 CONFIG_SPL_TARGET
3747 Final target image containing SPL and payload. Some SPLs
3748 use an arch-specific makefile fragment instead, for
3749 example if more than one image needs to be produced.
3750
Simon Glass82d94532013-05-08 08:05:59 +00003751 CONFIG_FIT_SPL_PRINT
3752 Printing information about a FIT image adds quite a bit of
3753 code to SPL. So this is normally disabled in SPL. Use this
3754 option to re-enable it. This will affect the output of the
3755 bootm command when booting a FIT image.
3756
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003757- TPL framework
3758 CONFIG_TPL
3759 Enable building of TPL globally.
3760
3761 CONFIG_TPL_PAD_TO
3762 Image offset to which the TPL should be padded before appending
3763 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003764 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3765 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3766 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003767
wdenkc6097192002-11-03 00:24:07 +00003768Modem Support:
3769--------------
3770
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003771[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003772
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003773- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003774 CONFIG_MODEM_SUPPORT
3775
3776- RTS/CTS Flow control enable:
3777 CONFIG_HWFLOW
3778
3779- Modem debug support:
3780 CONFIG_MODEM_SUPPORT_DEBUG
3781
wdenk4a5c8a72003-03-06 00:02:04 +00003782 Enables debugging stuff (char screen[1024], dbg())
3783 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003784
wdenkc0aa5c52003-12-06 19:49:23 +00003785- Interrupt support (PPC):
3786
wdenk1ebf41e2004-01-02 14:00:00 +00003787 There are common interrupt_init() and timer_interrupt()
3788 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003789 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003790 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003791 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003792 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003793 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003794 specific handling. If board has watchdog / status_led
3795 / other_activity_monitor it works automatically from
3796 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003797
wdenkc6097192002-11-03 00:24:07 +00003798- General:
3799
wdenk4a5c8a72003-03-06 00:02:04 +00003800 In the target system modem support is enabled when a
3801 specific key (key combination) is pressed during
3802 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003803 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003804 board_init(). Currently key_pressed() is a dummy
3805 function, returning 1 and thus enabling modem
3806 initialization.
wdenkc6097192002-11-03 00:24:07 +00003807
wdenk4a5c8a72003-03-06 00:02:04 +00003808 If there are no modem init strings in the
3809 environment, U-Boot proceed to autoboot; the
3810 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003811 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003812
3813 See also: doc/README.Modem
3814
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003815Board initialization settings:
3816------------------------------
3817
3818During Initialization u-boot calls a number of board specific functions
3819to allow the preparation of board specific prerequisites, e.g. pin setup
3820before drivers are initialized. To enable these callbacks the
3821following configuration macros have to be defined. Currently this is
3822architecture specific, so please check arch/your_architecture/lib/board.c
3823typically in board_init_f() and board_init_r().
3824
3825- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3826- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3827- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3828- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003829
wdenkc6097192002-11-03 00:24:07 +00003830Configuration Settings:
3831-----------------------
3832
York Sun6c480012014-02-26 17:03:19 -08003833- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3834 Optionally it can be defined to support 64-bit memory commands.
3835
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003836- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003837 undefine this when you're short of memory.
3838
Peter Tyserdfb72b82009-01-27 18:03:12 -06003839- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3840 width of the commands listed in the 'help' command output.
3841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003842- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003843 prompt for user input.
3844
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003845- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003847- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003850
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003851- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003852 the application (usually a Linux kernel) when it is
3853 booted
3854
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003855- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003856 List of legal baudrate settings for this board.
3857
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003858- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003859 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003860
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003861- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003862 If the board specific function
3863 extern int overwrite_console (void);
3864 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003865 serial port, else the settings in the environment are used.
3866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003867- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003868 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003870- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003871 Enable overwrite of previous console environment settings.
3872
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003873- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003874 Begin and End addresses of the area used by the
3875 simple memory test.
3876
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003877- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003878 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003880- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003881 Scratch address used by the alternate memory test
3882 You only need to set this if address zero isn't writeable
3883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003884- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3885 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003886 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003887 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003888 fixing up gd->ram_size the Linux kernel should gets passed
3889 the now "corrected" memory size and won't touch it either.
3890 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003891 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003892 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003893 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003894
3895 This option can be used as a workaround for the 440EPx/GRx
3896 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3897 be touched.
3898
3899 WARNING: Please make sure that this value is a multiple of
3900 the Linux page size (normally 4k). If this is not the case,
3901 then the end address of the Linux memory will be located at a
3902 non page size aligned address and this could cause major
3903 problems.
3904
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003905- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003906 Enable temporary baudrate change while serial download
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003909 Physical start address of SDRAM. _Must_ be 0 here.
3910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003911- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003912 Physical start address of Motherboard I/O (if using a
3913 Cogent motherboard)
3914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003916 Physical start address of Flash memory.
3917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003918- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003919 Physical start address of boot monitor code (set by
3920 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003921 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003922 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003924- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003925 Size of memory reserved for monitor code, used to
3926 determine _at_compile_time_ (!) if the environment is
3927 embedded within the U-Boot image, or in a separate
3928 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003930- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003931 Size of DRAM reserved for malloc() use.
3932
Simon Glass863e4042014-07-10 22:23:28 -06003933- CONFIG_SYS_MALLOC_F_LEN
3934 Size of the malloc() pool for use before relocation. If
3935 this is defined, then a very simple malloc() implementation
3936 will become available before relocation. The address is just
3937 below the global data, and the stack is moved down to make
3938 space.
3939
3940 This feature allocates regions with increasing addresses
3941 within the region. calloc() is supported, but realloc()
3942 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003943 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003944 U-Boot relocates itself.
3945
Simon Glasse997f752014-09-15 06:33:18 -06003946 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003947 at present but is fairly easy to enable for other archs.
3948
Simon Glass9fa901b2014-11-10 17:16:54 -07003949- CONFIG_SYS_MALLOC_SIMPLE
3950 Provides a simple and small malloc() and calloc() for those
3951 boards which do not use the full malloc in SPL (which is
3952 enabled with CONFIG_SYS_SPL_MALLOC_START).
3953
Thierry Redingc97d9742014-12-09 22:25:22 -07003954- CONFIG_SYS_NONCACHED_MEMORY:
3955 Size of non-cached memory area. This area of memory will be
3956 typically located right below the malloc() area and mapped
3957 uncached in the MMU. This is useful for drivers that would
3958 otherwise require a lot of explicit cache maintenance. For
3959 some drivers it's also impossible to properly maintain the
3960 cache. For example if the regions that need to be flushed
3961 are not a multiple of the cache-line size, *and* padding
3962 cannot be allocated between the regions to align them (i.e.
3963 if the HW requires a contiguous array of regions, and the
3964 size of each region is not cache-aligned), then a flush of
3965 one region may result in overwriting data that hardware has
3966 written to another region in the same cache-line. This can
3967 happen for example in network drivers where descriptors for
3968 buffers are typically smaller than the CPU cache-line (e.g.
3969 16 bytes vs. 32 or 64 bytes).
3970
3971 Non-cached memory is only supported on 32-bit ARM at present.
3972
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003973- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003974 Normally compressed uImages are limited to an
3975 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003976 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003977 to adjust this setting to your needs.
3978
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003979- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003980 Maximum size of memory mapped by the startup code of
3981 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003982 the Linux kernel (bd_info, boot arguments, FDT blob if
3983 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003984 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003985 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003986 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003987 variable "bootm_mapsize" will override the value of
3988 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3989 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003990
John Rigbyeea8e692010-10-13 13:57:35 -06003991- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3992 Enable initrd_high functionality. If defined then the
3993 initrd_high feature is enabled and the bootm ramdisk subcommand
3994 is enabled.
3995
3996- CONFIG_SYS_BOOT_GET_CMDLINE:
3997 Enables allocating and saving kernel cmdline in space between
3998 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3999
4000- CONFIG_SYS_BOOT_GET_KBD:
4001 Enables allocating and saving a kernel copy of the bd_info in
4002 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004004- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004005 Max number of Flash memory banks
4006
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004007- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004008 Max number of sectors on a Flash chip
4009
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004010- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004011 Timeout for Flash erase operations (in ms)
4012
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004013- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004014 Timeout for Flash write operations (in ms)
4015
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004016- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004017 Timeout for Flash set sector lock bit operation (in ms)
4018
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004019- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004020 Timeout for Flash clear lock bits operation (in ms)
4021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004022- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004023 If defined, hardware flash sectors protection is used
4024 instead of U-Boot software protection.
4025
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004026- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004027
4028 Enable TFTP transfers directly to flash memory;
4029 without this option such a download has to be
4030 performed in two steps: (1) download to RAM, and (2)
4031 copy from RAM to flash.
4032
4033 The two-step approach is usually more reliable, since
4034 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004035 the flash, but in some situations (when system RAM is
4036 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004037 downloaded image) this option may be very useful.
4038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004039- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004040 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004041 common flash structure for storing flash geometry.
4042
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004043- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004044 This option also enables the building of the cfi_flash driver
4045 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004046
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004047- CONFIG_FLASH_CFI_MTD
4048 This option enables the building of the cfi_mtd driver
4049 in the drivers directory. The driver exports CFI flash
4050 to the MTD layer.
4051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004052- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004053 Use buffered writes to flash.
4054
4055- CONFIG_FLASH_SPANSION_S29WS_N
4056 s29ws-n MirrorBit flash has non-standard addresses for buffered
4057 write commands.
4058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004059- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004060 If this option is defined, the common CFI flash doesn't
4061 print it's warning upon not recognized FLASH banks. This
4062 is useful, if some of the configured banks are only
4063 optionally available.
4064
Jerry Van Barenaae73572008-03-08 13:48:01 -05004065- CONFIG_FLASH_SHOW_PROGRESS
4066 If defined (must be an integer), print out countdown
4067 digits and dots. Recommended value: 45 (9..1) for 80
4068 column displays, 15 (3..1) for 40 column displays.
4069
Stefan Roesed20cba52013-04-04 15:53:14 +02004070- CONFIG_FLASH_VERIFY
4071 If defined, the content of the flash (destination) is compared
4072 against the source after the write operation. An error message
4073 will be printed when the contents are not identical.
4074 Please note that this option is useless in nearly all cases,
4075 since such flash programming errors usually are detected earlier
4076 while unprotecting/erasing/programming. Please only enable
4077 this option if you really know what you are doing.
4078
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004079- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004080 Defines the number of Ethernet receive buffers. On some
4081 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004082 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4083 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004084 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004085 Defaults to 4 if not defined.
4086
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004087- CONFIG_ENV_MAX_ENTRIES
4088
Wolfgang Denk1136f692010-10-27 22:48:30 +02004089 Maximum number of entries in the hash table that is used
4090 internally to store the environment settings. The default
4091 setting is supposed to be generous and should work in most
4092 cases. This setting can be used to tune behaviour; see
4093 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004094
Joe Hershberger71497d02012-12-11 22:16:31 -06004095- CONFIG_ENV_FLAGS_LIST_DEFAULT
4096- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004097 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004098 calling env set. Variables can be restricted to only decimal,
4099 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4100 the variables can also be restricted to IP address or MAC address.
4101
4102 The format of the list is:
4103 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004104 access_attribute = [a|r|o|c]
4105 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004106 entry = variable_name[:attributes]
4107 list = entry[,list]
4108
4109 The type attributes are:
4110 s - String (default)
4111 d - Decimal
4112 x - Hexadecimal
4113 b - Boolean ([1yYtT|0nNfF])
4114 i - IP address
4115 m - MAC address
4116
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004117 The access attributes are:
4118 a - Any (default)
4119 r - Read-only
4120 o - Write-once
4121 c - Change-default
4122
Joe Hershberger71497d02012-12-11 22:16:31 -06004123 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4124 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004125 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004126
4127 - CONFIG_ENV_FLAGS_LIST_STATIC
4128 Define this to a list (string) to define validation that
4129 should be done if an entry is not found in the ".flags"
4130 environment variable. To override a setting in the static
4131 list, simply add an entry for the same variable name to the
4132 ".flags" variable.
4133
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004134 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4135 regular expression. This allows multiple variables to define the same
4136 flags without explicitly listing them for each variable.
4137
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004138- CONFIG_ENV_ACCESS_IGNORE_FORCE
4139 If defined, don't allow the -f switch to env set override variable
4140 access flags.
4141
Simon Glass66828322013-03-08 13:45:27 +00004142- CONFIG_SYS_GENERIC_BOARD
4143 This selects the architecture-generic board system instead of the
4144 architecture-specific board files. It is intended to move boards
4145 to this new framework over time. Defining this will disable the
4146 arch/foo/lib/board.c file and use common/board_f.c and
4147 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004148 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4149 If you find problems enabling this option on your board please report
4150 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004151
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004152- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4153 This is set by OMAP boards for the max time that reset should
4154 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004155 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004156
Gabe Black3687fe42014-10-15 04:38:30 -06004157- CONFIG_USE_STDINT
4158 If stdint.h is available with your toolchain you can define this
4159 option to enable it. You can provide option 'USE_STDINT=1' when
4160 building U-Boot to enable this.
4161
wdenkc6097192002-11-03 00:24:07 +00004162The following definitions that deal with the placement and management
4163of environment data (variable area); in general, we support the
4164following configurations:
4165
Mike Frysinger63b8f122011-07-08 10:44:25 +00004166- CONFIG_BUILD_ENVCRC:
4167
4168 Builds up envcrc with the target environment so that external utils
4169 may easily extract it and embed it in final U-Boot images.
4170
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004171- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004172
4173 Define this if the environment is in flash memory.
4174
4175 a) The environment occupies one whole flash sector, which is
4176 "embedded" in the text segment with the U-Boot code. This
4177 happens usually with "bottom boot sector" or "top boot
4178 sector" type flash chips, which have several smaller
4179 sectors at the start or the end. For instance, such a
4180 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4181 such a case you would place the environment in one of the
4182 4 kB sectors - with U-Boot code before and after it. With
4183 "top boot sector" type flash chips, you would put the
4184 environment in one of the last sectors, leaving a gap
4185 between U-Boot and the environment.
4186
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004187 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004188
4189 Offset of environment data (variable area) to the
4190 beginning of flash memory; for instance, with bottom boot
4191 type flash chips the second sector can be used: the offset
4192 for this sector is given here.
4193
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004194 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004195
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004196 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004197
4198 This is just another way to specify the start address of
4199 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004200 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004201
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004202 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004203
4204 Size of the sector containing the environment.
4205
4206
4207 b) Sometimes flash chips have few, equal sized, BIG sectors.
4208 In such a case you don't want to spend a whole sector for
4209 the environment.
4210
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004211 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004212
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004213 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004214 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004215 of this flash sector for the environment. This saves
4216 memory for the RAM copy of the environment.
4217
4218 It may also save flash memory if you decide to use this
4219 when your environment is "embedded" within U-Boot code,
4220 since then the remainder of the flash sector could be used
4221 for U-Boot code. It should be pointed out that this is
4222 STRONGLY DISCOURAGED from a robustness point of view:
4223 updating the environment in flash makes it always
4224 necessary to erase the WHOLE sector. If something goes
4225 wrong before the contents has been restored from a copy in
4226 RAM, your target system will be dead.
4227
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004228 - CONFIG_ENV_ADDR_REDUND
4229 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004230
wdenk4a5c8a72003-03-06 00:02:04 +00004231 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004232 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004233 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004234 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004235
4236BE CAREFUL! Any changes to the flash layout, and some changes to the
4237source code will make it necessary to adapt <board>/u-boot.lds*
4238accordingly!
4239
4240
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004241- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004242
4243 Define this if you have some non-volatile memory device
4244 (NVRAM, battery buffered SRAM) which you want to use for the
4245 environment.
4246
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004247 - CONFIG_ENV_ADDR:
4248 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004249
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004250 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004251 want to use for environment. It is assumed that this memory
4252 can just be read and written to, without any special
4253 provision.
4254
4255BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004256in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004257console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004258U-Boot will hang.
4259
4260Please note that even with NVRAM we still use a copy of the
4261environment in RAM: we could work on NVRAM directly, but we want to
4262keep settings there always unmodified except somebody uses "saveenv"
4263to save the current settings.
4264
4265
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004266- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004267
4268 Use this if you have an EEPROM or similar serial access
4269 device and a driver for it.
4270
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004271 - CONFIG_ENV_OFFSET:
4272 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004273
4274 These two #defines specify the offset and size of the
4275 environment area within the total memory of your EEPROM.
4276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004277 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004278 If defined, specified the chip address of the EEPROM device.
4279 The default address is zero.
4280
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004281 - CONFIG_SYS_I2C_EEPROM_BUS:
4282 If defined, specified the i2c bus of the EEPROM device.
4283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004284 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004285 If defined, the number of bits used to address bytes in a
4286 single page in the EEPROM device. A 64 byte page, for example
4287 would require six bits.
4288
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004289 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004290 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004291 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004293 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004294 The length in bytes of the EEPROM memory array address. Note
4295 that this is NOT the chip address length!
4296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004297 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004298 EEPROM chips that implement "address overflow" are ones
4299 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4300 address and the extra bits end up in the "chip address" bit
4301 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4302 byte chips.
4303
4304 Note that we consider the length of the address field to
4305 still be one byte because the extra address bits are hidden
4306 in the chip address.
4307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004308 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004309 The size in bytes of the EEPROM device.
4310
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004311 - CONFIG_ENV_EEPROM_IS_ON_I2C
4312 define this, if you have I2C and SPI activated, and your
4313 EEPROM, which holds the environment, is on the I2C bus.
4314
4315 - CONFIG_I2C_ENV_EEPROM_BUS
4316 if you have an Environment on an EEPROM reached over
4317 I2C muxes, you can define here, how to reach this
4318 EEPROM. For example:
4319
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004320 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004321
4322 EEPROM which holds the environment, is reached over
4323 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004324
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004325- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004326
wdenk1ebf41e2004-01-02 14:00:00 +00004327 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004328 want to use for the environment.
4329
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004330 - CONFIG_ENV_OFFSET:
4331 - CONFIG_ENV_ADDR:
4332 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004333
4334 These three #defines specify the offset and size of the
4335 environment area within the total memory of your DataFlash placed
4336 at the specified address.
4337
Wu, Josh76db7bf2014-07-01 19:30:13 +08004338- CONFIG_ENV_IS_IN_SPI_FLASH:
4339
4340 Define this if you have a SPI Flash memory device which you
4341 want to use for the environment.
4342
4343 - CONFIG_ENV_OFFSET:
4344 - CONFIG_ENV_SIZE:
4345
4346 These two #defines specify the offset and size of the
4347 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4348 aligned to an erase sector boundary.
4349
4350 - CONFIG_ENV_SECT_SIZE:
4351
4352 Define the SPI flash's sector size.
4353
4354 - CONFIG_ENV_OFFSET_REDUND (optional):
4355
4356 This setting describes a second storage area of CONFIG_ENV_SIZE
4357 size used to hold a redundant copy of the environment data, so
4358 that there is a valid backup copy in case there is a power failure
4359 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4360 aligned to an erase sector boundary.
4361
4362 - CONFIG_ENV_SPI_BUS (optional):
4363 - CONFIG_ENV_SPI_CS (optional):
4364
4365 Define the SPI bus and chip select. If not defined they will be 0.
4366
4367 - CONFIG_ENV_SPI_MAX_HZ (optional):
4368
4369 Define the SPI max work clock. If not defined then use 1MHz.
4370
4371 - CONFIG_ENV_SPI_MODE (optional):
4372
4373 Define the SPI work mode. If not defined then use SPI_MODE_3.
4374
Liu Gang85bcd732012-03-08 00:33:20 +00004375- CONFIG_ENV_IS_IN_REMOTE:
4376
4377 Define this if you have a remote memory space which you
4378 want to use for the local device's environment.
4379
4380 - CONFIG_ENV_ADDR:
4381 - CONFIG_ENV_SIZE:
4382
4383 These two #defines specify the address and size of the
4384 environment area within the remote memory space. The
4385 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004386 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004387
4388BE CAREFUL! For some special cases, the local device can not use
4389"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004390environment stored in a remote NOR flash by SRIO or PCIE link,
4391but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004392
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004393- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004394
4395 Define this if you have a NAND device which you want to use
4396 for the environment.
4397
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004398 - CONFIG_ENV_OFFSET:
4399 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004400
4401 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004402 area within the first NAND device. CONFIG_ENV_OFFSET must be
4403 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004404
Scott Wood08239322010-09-17 14:38:37 -05004405 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004406
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004407 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004408 size used to hold a redundant copy of the environment data, so
4409 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004410 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004411 aligned to an erase block boundary.
4412
4413 - CONFIG_ENV_RANGE (optional):
4414
4415 Specifies the length of the region in which the environment
4416 can be written. This should be a multiple of the NAND device's
4417 block size. Specifying a range with more erase blocks than
4418 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4419 the range to be avoided.
4420
4421 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004422
Scott Wood08239322010-09-17 14:38:37 -05004423 Enables support for dynamically retrieving the offset of the
4424 environment from block zero's out-of-band data. The
4425 "nand env.oob" command can be used to record this offset.
4426 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4427 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004428
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004429- CONFIG_NAND_ENV_DST
4430
4431 Defines address in RAM to which the nand_spl code should copy the
4432 environment. If redundant environment is used, it will be copied to
4433 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4434
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004435- CONFIG_ENV_IS_IN_UBI:
4436
4437 Define this if you have an UBI volume that you want to use for the
4438 environment. This has the benefit of wear-leveling the environment
4439 accesses, which is important on NAND.
4440
4441 - CONFIG_ENV_UBI_PART:
4442
4443 Define this to a string that is the mtd partition containing the UBI.
4444
4445 - CONFIG_ENV_UBI_VOLUME:
4446
4447 Define this to the name of the volume that you want to store the
4448 environment in.
4449
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004450 - CONFIG_ENV_UBI_VOLUME_REDUND:
4451
4452 Define this to the name of another volume to store a second copy of
4453 the environment in. This will enable redundant environments in UBI.
4454 It is assumed that both volumes are in the same MTD partition.
4455
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004456 - CONFIG_UBI_SILENCE_MSG
4457 - CONFIG_UBIFS_SILENCE_MSG
4458
4459 You will probably want to define these to avoid a really noisy system
4460 when storing the env in UBI.
4461
Wu, Josha7d0c872014-06-24 17:31:03 +08004462- CONFIG_ENV_IS_IN_FAT:
4463 Define this if you want to use the FAT file system for the environment.
4464
4465 - FAT_ENV_INTERFACE:
4466
4467 Define this to a string that is the name of the block device.
4468
4469 - FAT_ENV_DEV_AND_PART:
4470
4471 Define this to a string to specify the partition of the device. It can
4472 be as following:
4473
4474 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4475 - "D:P": device D partition P. Error occurs if device D has no
4476 partition table.
4477 - "D:0": device D.
4478 - "D" or "D:": device D partition 1 if device D has partition
4479 table, or the whole device D if has no partition
4480 table.
4481 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004482 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004483 partition table then means device D.
4484
4485 - FAT_ENV_FILE:
4486
4487 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004488 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004489
4490 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004491 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004492
Stephen Warreneedcacd2013-06-11 15:14:00 -06004493- CONFIG_ENV_IS_IN_MMC:
4494
4495 Define this if you have an MMC device which you want to use for the
4496 environment.
4497
4498 - CONFIG_SYS_MMC_ENV_DEV:
4499
4500 Specifies which MMC device the environment is stored in.
4501
4502 - CONFIG_SYS_MMC_ENV_PART (optional):
4503
4504 Specifies which MMC partition the environment is stored in. If not
4505 set, defaults to partition 0, the user area. Common values might be
4506 1 (first MMC boot partition), 2 (second MMC boot partition).
4507
4508 - CONFIG_ENV_OFFSET:
4509 - CONFIG_ENV_SIZE:
4510
4511 These two #defines specify the offset and size of the environment
4512 area within the specified MMC device.
4513
Stephen Warren24dc2032013-06-11 15:14:02 -06004514 If offset is positive (the usual case), it is treated as relative to
4515 the start of the MMC partition. If offset is negative, it is treated
4516 as relative to the end of the MMC partition. This can be useful if
4517 your board may be fitted with different MMC devices, which have
4518 different sizes for the MMC partitions, and you always want the
4519 environment placed at the very end of the partition, to leave the
4520 maximum possible space before it, to store other data.
4521
Stephen Warreneedcacd2013-06-11 15:14:00 -06004522 These two values are in units of bytes, but must be aligned to an
4523 MMC sector boundary.
4524
4525 - CONFIG_ENV_OFFSET_REDUND (optional):
4526
4527 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4528 hold a redundant copy of the environment data. This provides a
4529 valid backup copy in case the other copy is corrupted, e.g. due
4530 to a power failure during a "saveenv" operation.
4531
Stephen Warren24dc2032013-06-11 15:14:02 -06004532 This value may also be positive or negative; this is handled in the
4533 same way as CONFIG_ENV_OFFSET.
4534
Stephen Warreneedcacd2013-06-11 15:14:00 -06004535 This value is also in units of bytes, but must also be aligned to
4536 an MMC sector boundary.
4537
4538 - CONFIG_ENV_SIZE_REDUND (optional):
4539
4540 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4541 set. If this value is set, it must be set to the same value as
4542 CONFIG_ENV_SIZE.
4543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004544- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004545
4546 Defines offset to the initial SPI buffer area in DPRAM. The
4547 area is used at an early stage (ROM part) if the environment
4548 is configured to reside in the SPI EEPROM: We need a 520 byte
4549 scratch DPRAM area. It is used between the two initialization
4550 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4551 to be a good choice since it makes it far enough from the
4552 start of the data area as well as from the stack pointer.
4553
Bruce Adleredecc942007-11-02 13:15:42 -07004554Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004555has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004556created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004557until then to read environment variables.
4558
wdenk8dba0502003-03-31 16:34:49 +00004559The environment is protected by a CRC32 checksum. Before the monitor
4560is relocated into RAM, as a result of a bad CRC you will be working
4561with the compiled-in default environment - *silently*!!! [This is
4562necessary, because the first environment variable we need is the
4563"baudrate" setting for the console - if we have a bad CRC, we don't
4564have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004565
4566Note: once the monitor has been relocated, then it will complain if
4567the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004568use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004570- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004571 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004573 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004574 also needs to be defined.
4575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004576- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004577 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004578
Ron Madriddfa028a2009-02-18 14:30:44 -08004579- CONFIG_NS16550_MIN_FUNCTIONS:
4580 Define this if you desire to only have use of the NS16550_init
4581 and NS16550_putc functions for the serial driver located at
4582 drivers/serial/ns16550.c. This option is useful for saving
4583 space for already greatly restricted images, including but not
4584 limited to NAND_SPL configurations.
4585
Simon Glass28a9e332012-11-30 13:01:18 +00004586- CONFIG_DISPLAY_BOARDINFO
4587 Display information about the board that U-Boot is running on
4588 when U-Boot starts up. The board function checkboard() is called
4589 to do this.
4590
Simon Glasse8822012012-11-30 13:01:19 +00004591- CONFIG_DISPLAY_BOARDINFO_LATE
4592 Similar to the previous option, but display this information
4593 later, once stdio is running and output goes to the LCD, if
4594 present.
4595
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004596- CONFIG_BOARD_SIZE_LIMIT:
4597 Maximum size of the U-Boot image. When defined, the
4598 build system checks that the actual size does not
4599 exceed it.
4600
wdenkc6097192002-11-03 00:24:07 +00004601Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004602---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004603
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004604- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004605 Cache Line Size of the CPU.
4606
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004607- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004608 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004609
wdenk9c53f402003-10-15 23:53:47 +00004610 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4611 and RPXsuper) to be able to adjust the position of
4612 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004613
Timur Tabid8f341c2011-08-04 18:03:41 -05004614- CONFIG_SYS_CCSRBAR_DEFAULT:
4615 Default (power-on reset) physical address of CCSR on Freescale
4616 PowerPC SOCs.
4617
4618- CONFIG_SYS_CCSRBAR:
4619 Virtual address of CCSR. On a 32-bit build, this is typically
4620 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4621
4622 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4623 for cross-platform code that uses that macro instead.
4624
4625- CONFIG_SYS_CCSRBAR_PHYS:
4626 Physical address of CCSR. CCSR can be relocated to a new
4627 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004628 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004629 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4630 is typically relocated on 36-bit builds. It is recommended
4631 that this macro be defined via the _HIGH and _LOW macros:
4632
4633 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4634 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4635
4636- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004637 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4638 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004639 used in assembly code, so it must not contain typecasts or
4640 integer size suffixes (e.g. "ULL").
4641
4642- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4643 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4644 used in assembly code, so it must not contain typecasts or
4645 integer size suffixes (e.g. "ULL").
4646
4647- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4648 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4649 forced to a value that ensures that CCSR is not relocated.
4650
wdenk1272e232002-11-10 22:06:23 +00004651- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004652 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004653
4654 the default drive number (default value 0)
4655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004656 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004657
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004658 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004659 (default value 1)
4660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004661 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004662
wdenk4a5c8a72003-03-06 00:02:04 +00004663 defines the offset of register from address. It
4664 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004665 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004667 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4668 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004669 default value.
wdenk1272e232002-11-10 22:06:23 +00004670
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004672 fdc_hw_init() is called at the beginning of the FDC
4673 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004674 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004675 initializations.
wdenk1272e232002-11-10 22:06:23 +00004676
Macpaul Lind1e49942011-04-11 20:45:32 +00004677- CONFIG_IDE_AHB:
4678 Most IDE controllers were designed to be connected with PCI
4679 interface. Only few of them were designed for AHB interface.
4680 When software is doing ATA command and data transfer to
4681 IDE devices through IDE-AHB controller, some additional
4682 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004683 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004685- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004686 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004687 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004688
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004689- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004690
wdenkeb20ad32003-09-05 23:19:14 +00004691 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004692 initial data and stack; please note that this must be
4693 writable memory that is working WITHOUT special
4694 initialization, i. e. you CANNOT use normal RAM which
4695 will become available only after programming the
4696 memory controller and running certain initialization
4697 sequences.
4698
4699 U-Boot uses the following memory types:
4700 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4701 - MPC824X: data cache
4702 - PPC4xx: data cache
4703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004705
4706 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004707 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4708 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004709 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004710 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004711 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4712 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4713 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004714
4715 Note:
4716 On the MPC824X (or other systems that use the data
4717 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004718 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004719 point to an otherwise UNUSED address space between
4720 the top of RAM and the start of the PCI space.
4721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004722- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004723
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004724- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004725
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004726- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004728- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004730- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004731
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004732- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004734- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004735 SDRAM timing
4736
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004737- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004738 periodic timer for refresh
4739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004740- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004741
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004742- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4743 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4744 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4745 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004746 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4747
4748- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004749 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4750 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004751 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004753- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4754 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004755 Machine Mode Register and Memory Periodic Timer
4756 Prescaler definitions (SDRAM timing)
4757
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004758- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004759 enable I2C microcode relocation patch (MPC8xx);
4760 define relocation offset in DPRAM [DSP2]
4761
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004762- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004763 enable SMC microcode relocation patch (MPC8xx);
4764 define relocation offset in DPRAM [SMC1]
4765
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004766- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004767 enable SPI microcode relocation patch (MPC8xx);
4768 define relocation offset in DPRAM [SCC4]
4769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004770- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004771 Use OSCM clock mode on MBX8xx board. Be careful,
4772 wrong setting might damage your board. Read
4773 doc/README.MBX before setting this variable!
4774
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004775- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004776 Offset of the bootmode word in DPRAM used by post
4777 (Power On Self Tests). This definition overrides
4778 #define'd default value in commproc.h resp.
4779 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004781- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4782 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4783 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4784 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4785 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4786 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4787 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4788 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004789 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004790
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004791- CONFIG_PCI_DISABLE_PCIE:
4792 Disable PCI-Express on systems where it is supported but not
4793 required.
4794
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004795- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004796 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004797 Don't do any setup work, presumably because someone or
4798 something has already done it, and we don't need to do it
4799 a second time. Useful for platforms that are pre-booted
4800 by coreboot or similar.
4801
Gabor Juhosb4458732013-05-30 07:06:12 +00004802- CONFIG_PCI_INDIRECT_BRIDGE:
4803 Enable support for indirect PCI bridges.
4804
Kumar Gala8975d7a2010-12-30 12:09:53 -06004805- CONFIG_SYS_SRIO:
4806 Chip has SRIO or not
4807
4808- CONFIG_SRIO1:
4809 Board has SRIO 1 port available
4810
4811- CONFIG_SRIO2:
4812 Board has SRIO 2 port available
4813
Liu Gang27afb9c2013-05-07 16:30:46 +08004814- CONFIG_SRIO_PCIE_BOOT_MASTER
4815 Board can support master function for Boot from SRIO and PCIE
4816
Kumar Gala8975d7a2010-12-30 12:09:53 -06004817- CONFIG_SYS_SRIOn_MEM_VIRT:
4818 Virtual Address of SRIO port 'n' memory region
4819
4820- CONFIG_SYS_SRIOn_MEM_PHYS:
4821 Physical Address of SRIO port 'n' memory region
4822
4823- CONFIG_SYS_SRIOn_MEM_SIZE:
4824 Size of SRIO port 'n' memory region
4825
Fabio Estevamf17e8782013-04-11 09:35:34 +00004826- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4827 Defined to tell the NAND controller that the NAND chip is using
4828 a 16 bit bus.
4829 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004830 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004831 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004832 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004833
4834- CONFIG_SYS_NDFC_EBC0_CFG
4835 Sets the EBC0_CFG register for the NDFC. If not defined
4836 a default value will be used.
4837
Ben Warren45657152006-09-07 16:50:54 -04004838- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004839 Get DDR timing information from an I2C EEPROM. Common
4840 with pluggable memory modules such as SODIMMs
4841
Ben Warren45657152006-09-07 16:50:54 -04004842 SPD_EEPROM_ADDRESS
4843 I2C address of the SPD EEPROM
4844
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004845- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004846 If SPD EEPROM is on an I2C bus other than the first
4847 one, specify here. Note that the value must resolve
4848 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004849
York Sune73cc042011-06-07 09:42:16 +08004850- CONFIG_SYS_DDR_RAW_TIMING
4851 Get DDR timing information from other than SPD. Common with
4852 soldered DDR chips onboard without SPD. DDR raw timing
4853 parameters are extracted from datasheet and hard-coded into
4854 header files or board specific files.
4855
York Sunbd495cf2011-09-16 13:21:35 -07004856- CONFIG_FSL_DDR_INTERACTIVE
4857 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4858
York Sun8ced0502015-01-06 13:18:55 -08004859- CONFIG_FSL_DDR_SYNC_REFRESH
4860 Enable sync of refresh for multiple controllers.
4861
York Sunb6a35f82015-03-19 09:30:28 -07004862- CONFIG_FSL_DDR_BIST
4863 Enable built-in memory test for Freescale DDR controllers.
4864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004865- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004866 Only for 83xx systems. If specified, then DDR should
4867 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004868
wdenk6203e402004-04-18 10:13:26 +00004869- CONFIG_ETHER_ON_FEC[12]
4870 Define to enable FEC[12] on a 8xx series processor.
4871
4872- CONFIG_FEC[12]_PHY
4873 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004874 to the given FEC; i. e.
4875 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004876 means that the PHY with address 4 is connected to FEC1
4877
4878 When set to -1, means to probe for first available.
4879
4880- CONFIG_FEC[12]_PHY_NORXERR
4881 The PHY does not have a RXERR line (RMII only).
4882 (so program the FEC to ignore it).
4883
4884- CONFIG_RMII
4885 Enable RMII mode for all FECs.
4886 Note that this is a global option, we can't
4887 have one FEC in standard MII mode and another in RMII mode.
4888
wdenk20c98a62004-04-23 20:32:05 +00004889- CONFIG_CRC32_VERIFY
4890 Add a verify option to the crc32 command.
4891 The syntax is:
4892
4893 => crc32 -v <address> <count> <crc32>
4894
4895 Where address/count indicate a memory area
4896 and crc32 is the correct crc32 which the
4897 area should have.
4898
wdenk64519362004-07-11 17:40:54 +00004899- CONFIG_LOOPW
4900 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004901 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004902
stroesecc3af832004-12-16 18:46:55 +00004903- CONFIG_MX_CYCLIC
4904 Add the "mdc" and "mwc" memory commands. These are cyclic
4905 "md/mw" commands.
4906 Examples:
4907
wdenk07d7e6b2004-12-16 21:44:03 +00004908 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004909 This command will print 4 bytes (10,11,12,13) each 500 ms.
4910
wdenk07d7e6b2004-12-16 21:44:03 +00004911 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004912 This command will write 12345678 to address 100 all 10 ms.
4913
wdenk07d7e6b2004-12-16 21:44:03 +00004914 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004915 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004916
wdenk3d3d99f2005-04-04 12:44:11 +00004917- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004918 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004919 low level initializations (like setting up the memory
4920 controller) are omitted and/or U-Boot does not
4921 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004922
Wolfgang Denk302141d2010-11-27 23:30:56 +01004923 Normally this variable MUST NOT be defined. The only
4924 exception is when U-Boot is loaded (to RAM) by some
4925 other boot loader or by a debugger which performs
4926 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004927
Aneesh V552a3192011-07-13 05:11:07 +00004928- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004929 Modifies the behaviour of start.S when compiling a loader
4930 that is executed before the actual U-Boot. E.g. when
4931 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004932
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004933- CONFIG_TPL_BUILD
4934 Modifies the behaviour of start.S when compiling a loader
4935 that is executed after the SPL and before the actual U-Boot.
4936 It is loaded by the SPL.
4937
Ying Zhang0d4f5442013-05-20 14:07:23 +08004938- CONFIG_SYS_MPC85XX_NO_RESETVEC
4939 Only for 85xx systems. If this variable is specified, the section
4940 .resetvec is not kept and the section .bootpg is placed in the
4941 previous 4k of the .text section.
4942
Simon Glass17dabf02013-02-24 17:33:14 +00004943- CONFIG_ARCH_MAP_SYSMEM
4944 Generally U-Boot (and in particular the md command) uses
4945 effective address. It is therefore not necessary to regard
4946 U-Boot address as virtual addresses that need to be translated
4947 to physical addresses. However, sandbox requires this, since
4948 it maintains its own little RAM buffer which contains all
4949 addressable memory. This option causes some memory accesses
4950 to be mapped through map_sysmem() / unmap_sysmem().
4951
Matthias Weisser93416c12011-03-10 21:36:32 +00004952- CONFIG_USE_ARCH_MEMCPY
4953 CONFIG_USE_ARCH_MEMSET
4954 If these options are used a optimized version of memcpy/memset will
4955 be used if available. These functions may be faster under some
4956 conditions but may increase the binary size.
4957
Simon Glassbfb59802013-02-14 04:18:54 +00004958- CONFIG_X86_RESET_VECTOR
4959 If defined, the x86 reset vector code is included. This is not
4960 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004961
Mark Jackson52b003c2013-03-04 01:27:20 +00004962- CONFIG_SYS_MPUCLK
4963 Defines the MPU clock speed (in MHz).
4964
4965 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004966
Heiko Schocher2233e462013-11-04 14:05:00 +01004967- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4968 Enables the RTC32K OSC on AM33xx based plattforms
4969
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004970- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4971 Option to disable subpage write in NAND driver
4972 driver that uses this:
4973 drivers/mtd/nand/davinci_nand.c
4974
Timur Tabi275f4bb2011-11-22 09:21:25 -06004975Freescale QE/FMAN Firmware Support:
4976-----------------------------------
4977
4978The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4979loading of "firmware", which is encoded in the QE firmware binary format.
4980This firmware often needs to be loaded during U-Boot booting, so macros
4981are used to identify the storage device (NOR flash, SPI, etc) and the address
4982within that device.
4983
Zhao Qiang83a90842014-03-21 16:21:44 +08004984- CONFIG_SYS_FMAN_FW_ADDR
4985 The address in the storage device where the FMAN microcode is located. The
4986 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4987 is also specified.
4988
4989- CONFIG_SYS_QE_FW_ADDR
4990 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004991 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4992 is also specified.
4993
4994- CONFIG_SYS_QE_FMAN_FW_LENGTH
4995 The maximum possible size of the firmware. The firmware binary format
4996 has a field that specifies the actual size of the firmware, but it
4997 might not be possible to read any part of the firmware unless some
4998 local storage is allocated to hold the entire firmware first.
4999
5000- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5001 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5002 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5003 virtual address in NOR flash.
5004
5005- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5006 Specifies that QE/FMAN firmware is located in NAND flash.
5007 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5008
5009- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5010 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5011 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5012
5013- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5014 Specifies that QE/FMAN firmware is located on the primary SPI
5015 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5016
Liu Gang1e084582012-03-08 00:33:18 +00005017- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5018 Specifies that QE/FMAN firmware is located in the remote (master)
5019 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005020 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5021 window->master inbound window->master LAW->the ucode address in
5022 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005023
J. German Rivera8ff14b72014-06-23 15:15:55 -07005024Freescale Layerscape Management Complex Firmware Support:
5025---------------------------------------------------------
5026The Freescale Layerscape Management Complex (MC) supports the loading of
5027"firmware".
5028This firmware often needs to be loaded during U-Boot booting, so macros
5029are used to identify the storage device (NOR flash, SPI, etc) and the address
5030within that device.
5031
5032- CONFIG_FSL_MC_ENET
5033 Enable the MC driver for Layerscape SoCs.
5034
5035- CONFIG_SYS_LS_MC_FW_ADDR
5036 The address in the storage device where the firmware is located. The
5037 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5038 is also specified.
5039
5040- CONFIG_SYS_LS_MC_FW_LENGTH
5041 The maximum possible size of the firmware. The firmware binary format
5042 has a field that specifies the actual size of the firmware, but it
5043 might not be possible to read any part of the firmware unless some
5044 local storage is allocated to hold the entire firmware first.
5045
5046- CONFIG_SYS_LS_MC_FW_IN_NOR
5047 Specifies that MC firmware is located in NOR flash, mapped as
5048 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5049 virtual address in NOR flash.
5050
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05305051Freescale Layerscape Debug Server Support:
5052-------------------------------------------
5053The Freescale Layerscape Debug Server Support supports the loading of
5054"Debug Server firmware" and triggering SP boot-rom.
5055This firmware often needs to be loaded during U-Boot booting.
5056
5057- CONFIG_FSL_DEBUG_SERVER
5058 Enable the Debug Server for Layerscape SoCs.
5059
5060- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
5061 Define minimum DDR size required for debug server image
5062
5063- CONFIG_SYS_MEM_TOP_HIDE_MIN
5064 Define minimum DDR size to be hided from top of the DDR memory
5065
Paul Kocialkowski7b917022015-07-26 18:48:15 +02005066Reproducible builds
5067-------------------
5068
5069In order to achieve reproducible builds, timestamps used in the U-Boot build
5070process have to be set to a fixed value.
5071
5072This is done using the SOURCE_DATE_EPOCH environment variable.
5073SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5074option for U-Boot or an environment variable in U-Boot.
5075
5076SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5077
wdenkc6097192002-11-03 00:24:07 +00005078Building the Software:
5079======================
5080
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005081Building U-Boot has been tested in several native build environments
5082and in many different cross environments. Of course we cannot support
5083all possibly existing versions of cross development tools in all
5084(potentially obsolete) versions. In case of tool chain problems we
5085recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5086which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005087
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005088If you are not using a native environment, it is assumed that you
5089have GNU cross compiling tools available in your path. In this case,
5090you must set the environment variable CROSS_COMPILE in your shell.
5091Note that no changes to the Makefile or any other source files are
5092necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005093
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005094 $ CROSS_COMPILE=ppc_4xx-
5095 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005096
Peter Tyserb06976d2009-03-13 18:54:51 -05005097Note: If you wish to generate Windows versions of the utilities in
5098 the tools directory you can use the MinGW toolchain
5099 (http://www.mingw.org). Set your HOST tools to the MinGW
5100 toolchain and execute 'make tools'. For example:
5101
5102 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5103
5104 Binaries such as tools/mkimage.exe will be created which can
5105 be executed on computers running Windows.
5106
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005107U-Boot is intended to be simple to build. After installing the
5108sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005109is done by typing:
5110
Holger Freyther7ba4e572014-08-04 09:26:05 +02005111 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005112
Holger Freyther7ba4e572014-08-04 09:26:05 +02005113where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005114rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116Note: for some board special configuration names may exist; check if
5117 additional information is available from the board vendor; for
5118 instance, the TQM823L systems are available without (standard)
5119 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005120 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005121
Holger Freyther7ba4e572014-08-04 09:26:05 +02005122 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005123 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005124
Holger Freyther7ba4e572014-08-04 09:26:05 +02005125 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005126 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128 etc.
wdenkc6097192002-11-03 00:24:07 +00005129
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk6c59edc2004-05-03 20:45:30 +00005131Finally, type "make all", and you should get some working U-Boot
5132images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134- "u-boot.bin" is a raw binary image
5135- "u-boot" is an image in ELF binary format
5136- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005137
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005138By default the build is performed locally and the objects are saved
5139in the source directory. One of the two methods can be used to change
5140this behavior and build U-Boot to some external directory:
5141
51421. Add O= to the make command line invocations:
5143
5144 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005145 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005146 make O=/tmp/build all
5147
Timo Ketolac8c67602014-11-06 14:39:05 +020051482. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005149
Timo Ketolac8c67602014-11-06 14:39:05 +02005150 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005151 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005152 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005153 make all
5154
Timo Ketolac8c67602014-11-06 14:39:05 +02005155Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005156variable.
5157
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159Please be aware that the Makefiles assume you are using GNU make, so
5160for instance on NetBSD you might need to use "gmake" instead of
5161native "make".
wdenkc6097192002-11-03 00:24:07 +00005162
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164If the system board that you have is not listed, then you will need
5165to port U-Boot to your hardware platform. To do this, follow these
5166steps:
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +000051681. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005169 "boards.cfg" file, using the existing entries as examples.
5170 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000051712. Create a new directory to hold your board specific code. Add any
5172 files you need. In your board directory, you will need at least
5173 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51743. Create a new configuration file "include/configs/<board>.h" for
5175 your board
51763. If you're porting U-Boot to a new CPU, then also create a new
5177 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051784. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051795. Type "make", and you should get a working "u-boot.srec" file
5180 to be installed on your target system.
51816. Debug and solve any problems that might arise.
5182 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005183
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk6c59edc2004-05-03 20:45:30 +00005185Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5186==============================================================
wdenkc6097192002-11-03 00:24:07 +00005187
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005188If you have modified U-Boot sources (for instance added a new board
5189or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005190provide feedback to the other developers. The feedback normally takes
5191the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005192official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005193
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005194But before you submit such a patch, please verify that your modifi-
5195cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005196the supported boards compile WITHOUT ANY compiler warnings. To do so,
5197just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005198for ALL supported system. Be warned, this will take a while. You can
5199select which (cross) compiler to use by passing a `CROSS_COMPILE'
5200environment variable to the script, i. e. to use the ELDK cross tools
5201you can type
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005208
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005209When using the MAKEALL script, the default behaviour is to build
5210U-Boot in the source directory. This location can be changed by
5211setting the BUILD_DIR environment variable. Also, for each target
5212built, the MAKEALL script saves two log files (<target>.ERR and
5213<target>.MAKEALL) in the <source dir>/LOG directory. This default
5214location can be changed by setting the MAKEALL_LOGDIR environment
5215variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005216
5217 export BUILD_DIR=/tmp/build
5218 export MAKEALL_LOGDIR=/tmp/log
5219 CROSS_COMPILE=ppc_8xx- MAKEALL
5220
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005221With the above settings build objects are saved in the /tmp/build,
5222log files are saved in the /tmp/log and the source tree remains clean
5223during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005224
5225
wdenk6c59edc2004-05-03 20:45:30 +00005226See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005227
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229Monitor Commands - Overview:
5230============================
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232go - start application at address 'addr'
5233run - run commands in an environment variable
5234bootm - boot application image from memory
5235bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005236bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005237tftpboot- boot image via network using TFTP protocol
5238 and env variables "ipaddr" and "serverip"
5239 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005240tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005241rarpboot- boot image via network using RARP/TFTP protocol
5242diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5243loads - load S-Record file over serial line
5244loadb - load binary file over serial line (kermit mode)
5245md - memory display
5246mm - memory modify (auto-incrementing)
5247nm - memory modify (constant address)
5248mw - memory write (fill)
5249cp - memory copy
5250cmp - memory compare
5251crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005252i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005253sspi - SPI utility commands
5254base - print or set address offset
5255printenv- print environment variables
5256setenv - set environment variables
5257saveenv - save environment variables to persistent storage
5258protect - enable or disable FLASH write protection
5259erase - erase FLASH memory
5260flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005261nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005262bdinfo - print Board Info structure
5263iminfo - print header information for application image
5264coninfo - print console devices and informations
5265ide - IDE sub-system
5266loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005267loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005268mtest - simple RAM test
5269icache - enable or disable instruction cache
5270dcache - enable or disable data cache
5271reset - Perform RESET of the CPU
5272echo - echo args to console
5273version - print monitor version
5274help - print online help
5275? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005276
wdenkc6097192002-11-03 00:24:07 +00005277
wdenk6c59edc2004-05-03 20:45:30 +00005278Monitor Commands - Detailed Description:
5279========================================
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281TODO.
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005284
5285
wdenk6c59edc2004-05-03 20:45:30 +00005286Environment Variables:
5287======================
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289U-Boot supports user configuration using Environment Variables which
5290can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292Environment Variables are set using "setenv", printed using
5293"printenv", and saved to Flash using "saveenv". Using "setenv"
5294without a value can be used to delete a variable from the
5295environment. As long as you don't save the environment you are
5296working with an in-memory copy. In case the Flash area containing the
5297environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005298
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005299Some configuration options can be set using Environment Variables.
5300
5301List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk6c59edc2004-05-03 20:45:30 +00005305 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005312
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005313 bootm_low - Memory range available for image processing in the bootm
5314 command can be restricted. This variable is given as
5315 a hexadecimal number and defines lowest address allowed
5316 for use by the bootm command. See also "bootm_size"
5317 environment variable. Address defined by "bootm_low" is
5318 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005319 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5320 bootm_mapsize.
5321
Wolfgang Denk092ae952011-10-26 10:21:21 +00005322 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005323 This variable is given as a hexadecimal number and it
5324 defines the size of the memory region starting at base
5325 address bootm_low that is accessible by the Linux kernel
5326 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5327 as the default value if it is defined, and bootm_size is
5328 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005329
5330 bootm_size - Memory range available for image processing in the bootm
5331 command can be restricted. This variable is given as
5332 a hexadecimal number and defines the size of the region
5333 allowed for use by the bootm command. See also "bootm_low"
5334 environment variable.
5335
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005336 updatefile - Location of the software update file on a TFTP server, used
5337 by the automatic software update feature. Please refer to
5338 documentation in doc/README.update for more details.
5339
wdenk6c59edc2004-05-03 20:45:30 +00005340 autoload - if set to "no" (any string beginning with 'n'),
5341 "bootp" will just load perform a lookup of the
5342 configuration from the BOOTP server, but not try to
5343 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345 autostart - if set to "yes", an image loaded using the "bootp",
5346 "rarpboot", "tftpboot" or "diskboot" commands will
5347 be automatically started (by internally calling
5348 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350 If set to "no", a standalone image passed to the
5351 "bootm" command will be copied to the load address
5352 (and eventually uncompressed), but NOT be started.
5353 This can be used to load and uncompress arbitrary
5354 data.
wdenkc6097192002-11-03 00:24:07 +00005355
David A. Longd558a4e2011-07-09 16:40:19 -04005356 fdt_high - if set this restricts the maximum address that the
5357 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005358 For example, if you have a system with 1 GB memory
5359 at physical address 0x10000000, while Linux kernel
5360 only recognizes the first 704 MB as low memory, you
5361 may need to set fdt_high as 0x3C000000 to have the
5362 device tree blob be copied to the maximum address
5363 of the 704 MB low memory, so that Linux kernel can
5364 access it during the boot procedure.
5365
David A. Longd558a4e2011-07-09 16:40:19 -04005366 If this is set to the special value 0xFFFFFFFF then
5367 the fdt will not be copied at all on boot. For this
5368 to work it must reside in writable memory, have
5369 sufficient padding on the end of it for u-boot to
5370 add the information it needs into it, and the memory
5371 must be accessible by the kernel.
5372
Simon Glassdc6fa642011-10-24 19:15:34 +00005373 fdtcontroladdr- if set this is the address of the control flattened
5374 device tree used by U-Boot when CONFIG_OF_CONTROL is
5375 defined.
5376
wdenk0e2bd9c2004-06-06 21:51:03 +00005377 i2cfast - (PPC405GP|PPC405EP only)
5378 if set to 'y' configures Linux I2C driver for fast
5379 mode (400kHZ). This environment variable is used in
5380 initialization code. So, for changes to be effective
5381 it must be saved and board must be reset.
5382
wdenk6c59edc2004-05-03 20:45:30 +00005383 initrd_high - restrict positioning of initrd images:
5384 If this variable is not set, initrd images will be
5385 copied to the highest possible address in RAM; this
5386 is usually what you want since it allows for
5387 maximum initrd size. If for some reason you want to
5388 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005389 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005390 variable to a value of "no" or "off" or "0".
5391 Alternatively, you can set it to a maximum upper
5392 address to use (U-Boot will still check that it
5393 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk6c59edc2004-05-03 20:45:30 +00005395 For instance, when you have a system with 16 MB
5396 RAM, and want to reserve 4 MB from use by Linux,
5397 you can do this by adding "mem=12M" to the value of
5398 the "bootargs" variable. However, now you must make
5399 sure that the initrd image is placed in the first
5400 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk6c59edc2004-05-03 20:45:30 +00005402 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404 If you set initrd_high to 0xFFFFFFFF, this is an
5405 indication to U-Boot that all addresses are legal
5406 for the Linux kernel, including addresses in flash
5407 memory. In this case U-Boot will NOT COPY the
5408 ramdisk at all. This may be useful to reduce the
5409 boot time on your system, but requires that this
5410 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk6c59edc2004-05-03 20:45:30 +00005414 loadaddr - Default load address for commands like "bootp",
5415 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005418
wdenk6c59edc2004-05-03 20:45:30 +00005419 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005420
wdenk6c59edc2004-05-03 20:45:30 +00005421 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005424
wdenk6c59edc2004-05-03 20:45:30 +00005425 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005426
Mike Frysingera23230c2011-10-02 10:01:27 +00005427 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005428
Mike Frysingera23230c2011-10-02 10:01:27 +00005429 ethact - controls which interface is currently active.
5430 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005431
Heiko Schocherc5e84052010-07-20 17:45:02 +02005432 => setenv ethact FEC
5433 => ping 192.168.0.1 # traffic sent on FEC
5434 => setenv ethact SCC
5435 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005436
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005437 ethrotate - When set to "no" U-Boot does not go through all
5438 available network interfaces.
5439 It just stays at the currently selected interface.
5440
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005441 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005442 either succeed or fail without retrying.
5443 When set to "once" the network operation will
5444 fail when all the available network interfaces
5445 are tried once without success.
5446 Useful on scripts which control the retry operation
5447 themselves.
wdenkc6097192002-11-03 00:24:07 +00005448
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005449 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005450
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005451 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005452 changing the console to be empty. If "yes" it will be
5453 made silent. If "no" it will not be made silent. If
5454 unset, then it will be made silent if the U-Boot console
5455 is silent.
5456
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005457 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005458 UDP source port.
5459
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005460 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005461 destination port instead of the Well Know Port 69.
5462
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005463 tftpblocksize - Block size to use for TFTP transfers; if not set,
5464 we use the TFTP server's default block size
5465
5466 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5467 seconds, minimum value is 1000 = 1 second). Defines
5468 when a packet is considered to be lost so it has to
5469 be retransmitted. The default is 5000 = 5 seconds.
5470 Lowering this value may make downloads succeed
5471 faster in networks with high packet loss rates or
5472 with unreliable TFTP servers.
5473
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005474 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5475 unit, minimum value = 0). Defines how many timeouts
5476 can happen during a single file transfer before that
5477 transfer is aborted. The default is 10, and 0 means
5478 'no timeouts allowed'. Increasing this value may help
5479 downloads succeed with high packet loss rates, or with
5480 unreliable TFTP servers or client hardware.
5481
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005482 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005483 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005484 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005485
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005486The following image location variables contain the location of images
5487used in booting. The "Image" column gives the role of the image and is
5488not an environment variable name. The other columns are environment
5489variable names. "File Name" gives the name of the file on a TFTP
5490server, "RAM Address" gives the location in RAM the image will be
5491loaded to, and "Flash Location" gives the image's address in NOR
5492flash or offset in NAND flash.
5493
5494*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005495boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005496boards use these variables for other purposes.
5497
Wolfgang Denk092ae952011-10-26 10:21:21 +00005498Image File Name RAM Address Flash Location
5499----- --------- ----------- --------------
5500u-boot u-boot u-boot_addr_r u-boot_addr
5501Linux kernel bootfile kernel_addr_r kernel_addr
5502device tree blob fdtfile fdt_addr_r fdt_addr
5503ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005504
wdenk6c59edc2004-05-03 20:45:30 +00005505The following environment variables may be used and automatically
5506updated by the network boot commands ("bootp" and "rarpboot"),
5507depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509 bootfile - see above
5510 dnsip - IP address of your Domain Name Server
5511 dnsip2 - IP address of your secondary Domain Name Server
5512 gatewayip - IP address of the Gateway (Router) to use
5513 hostname - Target hostname
5514 ipaddr - see above
5515 netmask - Subnet Mask
5516 rootpath - Pathname of the root filesystem on the NFS server
5517 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005518
wdenk145d2c12004-04-15 21:48:45 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005521
wdenk6c59edc2004-05-03 20:45:30 +00005522 serial# - contains hardware identification information such
5523 as type string and/or serial number
5524 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526These variables can be set only once (usually during manufacturing of
5527the board). U-Boot refuses to delete or overwrite these variables
5528once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005529
5530
wdenk6c59edc2004-05-03 20:45:30 +00005531Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533 ver - Contains the U-Boot version string as printed
5534 with the "version" command. This variable is
5535 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005536
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk6c59edc2004-05-03 20:45:30 +00005538Please note that changes to some configuration parameters may take
5539only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005540
stroeseb9c17c52003-04-04 15:53:41 +00005541
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005542Callback functions for environment variables:
5543---------------------------------------------
5544
5545For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005546when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005547be associated with arbitrary variables. On creation, overwrite, or
5548deletion, the callback will provide the opportunity for some side
5549effect to happen or for the change to be rejected.
5550
5551The callbacks are named and associated with a function using the
5552U_BOOT_ENV_CALLBACK macro in your board or driver code.
5553
5554These callbacks are associated with variables in one of two ways. The
5555static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5556in the board configuration to a string that defines a list of
5557associations. The list must be in the following format:
5558
5559 entry = variable_name[:callback_name]
5560 list = entry[,list]
5561
5562If the callback name is not specified, then the callback is deleted.
5563Spaces are also allowed anywhere in the list.
5564
5565Callbacks can also be associated by defining the ".callbacks" variable
5566with the same list format above. Any association in ".callbacks" will
5567override any association in the static list. You can define
5568CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005569".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005570
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005571If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5572regular expression. This allows multiple variables to be connected to
5573the same callback without explicitly listing them all out.
5574
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005575
wdenk6c59edc2004-05-03 20:45:30 +00005576Command Line Parsing:
5577=====================
stroeseb9c17c52003-04-04 15:53:41 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579There are two different command line parsers available with U-Boot:
5580the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582Old, simple command line parser:
5583--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005584
wdenk6c59edc2004-05-03 20:45:30 +00005585- supports environment variables (through setenv / saveenv commands)
5586- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005587- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005588- special characters ('$', ';') can be escaped by prefixing with '\',
5589 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005590 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005591- You can also escape text by enclosing in single apostrophes, for example:
5592 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk6c59edc2004-05-03 20:45:30 +00005594Hush shell:
5595-----------
wdenkf4688a22003-05-28 08:06:31 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597- similar to Bourne shell, with control structures like
5598 if...then...else...fi, for...do...done; while...do...done,
5599 until...do...done, ...
5600- supports environment ("global") variables (through setenv / saveenv
5601 commands) and local shell variables (through standard shell syntax
5602 "name=value"); only environment variables can be used with "run"
5603 command
wdenkf4688a22003-05-28 08:06:31 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605General rules:
5606--------------
wdenkf4688a22003-05-28 08:06:31 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608(1) If a command line (or an environment variable executed by a "run"
5609 command) contains several commands separated by semicolon, and
5610 one of these commands fails, then the remaining commands will be
5611 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005614 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005615 command will cause "run" to terminate, i. e. the remaining
5616 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618Note for Redundant Ethernet Interfaces:
5619=======================================
wdenkf4688a22003-05-28 08:06:31 +00005620
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005621Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005622such configurations and is capable of automatic selection of a
5623"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5626MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5627"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629If the network interface stores some valid MAC address (for instance
5630in SROM), this is used as default address if there is NO correspon-
5631ding setting in the environment; if the corresponding environment
5632variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005633
wdenk6c59edc2004-05-03 20:45:30 +00005634o If the SROM has a valid MAC address, and there is no address in the
5635 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637o If there is no valid address in the SROM, and a definition in the
5638 environment exists, then the value from the environment variable is
5639 used.
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641o If both the SROM and the environment contain a MAC address, and
5642 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644o If both the SROM and the environment contain a MAC address, and the
5645 addresses differ, the value from the environment is used and a
5646 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005649 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5650 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005651
Ben Warren6db991a2010-04-26 11:11:46 -07005652If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005653will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005654may be skipped by setting the appropriate 'ethmacskip' environment variable.
5655The naming convention is as follows:
5656"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658Image Formats:
5659==============
wdenkc6097192002-11-03 00:24:07 +00005660
Marian Balakowicz18710b82008-03-12 12:13:13 +01005661U-Boot is capable of booting (and performing other auxiliary operations on)
5662images in two formats:
5663
5664New uImage format (FIT)
5665-----------------------
5666
5667Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5668to Flattened Device Tree). It allows the use of images with multiple
5669components (several kernels, ramdisks, etc.), with contents protected by
5670SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5671
5672
5673Old uImage format
5674-----------------
5675
5676Old image format is based on binary files which can be basically anything,
5677preceded by a special header; see the definitions in include/image.h for
5678details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005679
wdenk6c59edc2004-05-03 20:45:30 +00005680* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5681 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005682 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5683 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5684 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005685* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005686 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5687 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005688* Compression Type (uncompressed, gzip, bzip2)
5689* Load Address
5690* Entry Point
5691* Image Name
5692* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694The header is marked by a special Magic Number, and both the header
5695and the data portions of the image are secured against corruption by
5696CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005697
wdenkc6097192002-11-03 00:24:07 +00005698
wdenk6c59edc2004-05-03 20:45:30 +00005699Linux Support:
5700==============
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702Although U-Boot should support any OS or standalone application
5703easily, the main focus has always been on Linux during the design of
5704U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706U-Boot includes many features that so far have been part of some
5707special "boot loader" code within the Linux kernel. Also, any
5708"initrd" images to be used are no longer part of one big Linux image;
5709instead, kernel and "initrd" are separate images. This implementation
5710serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk6c59edc2004-05-03 20:45:30 +00005712- the same features can be used for other OS or standalone
5713 applications (for instance: using compressed images to reduce the
5714 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk6c59edc2004-05-03 20:45:30 +00005716- it becomes much easier to port new Linux kernel versions because
5717 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719- the same Linux kernel image can now be used with different "initrd"
5720 images; of course this also means that different kernel images can
5721 be run with the same "initrd". This makes testing easier (you don't
5722 have to build a new "zImage.initrd" Linux image when you just
5723 change a file in your "initrd"). Also, a field-upgrade of the
5724 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005725
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727Linux HOWTO:
5728============
wdenkc6097192002-11-03 00:24:07 +00005729
wdenk6c59edc2004-05-03 20:45:30 +00005730Porting Linux to U-Boot based systems:
5731---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733U-Boot cannot save you from doing all the necessary modifications to
5734configure the Linux device drivers for use with your target hardware
5735(no, we don't intend to provide a full virtual machine interface to
5736Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005737
Stefan Roese88fbf932010-04-15 16:07:28 +02005738But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk6c59edc2004-05-03 20:45:30 +00005740Just make sure your machine specific header file (for instance
5741include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005742Information structure as we define in include/asm-<arch>/u-boot.h,
5743and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005744as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005745
Simon Glassd097e592014-06-11 23:29:46 -06005746Note that U-Boot now has a driver model, a unified model for drivers.
5747If you are adding a new driver, plumb it into driver model. If there
5748is no uclass available, you are encouraged to create one. See
5749doc/driver-model.
5750
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk6c59edc2004-05-03 20:45:30 +00005752Configuring the Linux kernel:
5753-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755No specific requirements for U-Boot. Make sure you have some root
5756device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005757
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk6c59edc2004-05-03 20:45:30 +00005759Building a Linux Image:
5760-----------------------
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5763not used. If you use recent kernel source, a new build target
5764"uImage" will exist which automatically builds an image usable by
5765U-Boot. Most older kernels also have support for a "pImage" target,
5766which was introduced for our predecessor project PPCBoot and uses a
5767100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769Example:
wdenkc6097192002-11-03 00:24:07 +00005770
Holger Freyther7ba4e572014-08-04 09:26:05 +02005771 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005772 make oldconfig
5773 make dep
5774 make uImage
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk6c59edc2004-05-03 20:45:30 +00005776The "uImage" build target uses a special tool (in 'tools/mkimage') to
5777encapsulate a compressed Linux kernel image with header information,
5778CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005779
wdenk6c59edc2004-05-03 20:45:30 +00005780* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk6c59edc2004-05-03 20:45:30 +00005782* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784 ${CROSS_COMPILE}-objcopy -O binary \
5785 -R .note -R .comment \
5786 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794 mkimage -A ppc -O linux -T kernel -C gzip \
5795 -a 0 -e 0 -n "Linux Kernel Image" \
5796 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005797
wdenkc6097192002-11-03 00:24:07 +00005798
wdenk6c59edc2004-05-03 20:45:30 +00005799The "mkimage" tool can also be used to create ramdisk images for use
5800with U-Boot, either separated from the Linux kernel image, or
5801combined into one file. "mkimage" encapsulates the images with a 64
5802byte header containing information about target architecture,
5803operating system, image type, compression method, entry points, time
5804stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806"mkimage" can be called in two ways: to verify existing images and
5807print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809In the first form (with "-l" option) mkimage lists the information
5810contained in the header of an existing U-Boot image; this includes
5811checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813 tools/mkimage -l image
5814 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816The second form (with "-d" option) is used to build a U-Boot image
5817from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005818
wdenk6c59edc2004-05-03 20:45:30 +00005819 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5820 -n name -d data_file image
5821 -A ==> set architecture to 'arch'
5822 -O ==> set operating system to 'os'
5823 -T ==> set image type to 'type'
5824 -C ==> set compression type 'comp'
5825 -a ==> set load address to 'addr' (hex)
5826 -e ==> set entry point to 'ep' (hex)
5827 -n ==> set image name to 'name'
5828 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005829
wdenkcd914452004-05-29 16:53:29 +00005830Right now, all Linux kernels for PowerPC systems use the same load
5831address (0x00000000), but the entry point address depends on the
5832kernel version:
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk6c59edc2004-05-03 20:45:30 +00005834- 2.2.x kernels have the entry point at 0x0000000C,
5835- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005836
wdenk6c59edc2004-05-03 20:45:30 +00005837So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005838
wdenk6c59edc2004-05-03 20:45:30 +00005839 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5840 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005841 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005842 > examples/uImage.TQM850L
5843 Image Name: 2.4.4 kernel for TQM850L
5844 Created: Wed Jul 19 02:34:59 2000
5845 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5846 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5847 Load Address: 0x00000000
5848 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005849
wdenk6c59edc2004-05-03 20:45:30 +00005850To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk6c59edc2004-05-03 20:45:30 +00005852 -> tools/mkimage -l examples/uImage.TQM850L
5853 Image Name: 2.4.4 kernel for TQM850L
5854 Created: Wed Jul 19 02:34:59 2000
5855 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5856 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5857 Load Address: 0x00000000
5858 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005859
wdenk6c59edc2004-05-03 20:45:30 +00005860NOTE: for embedded systems where boot time is critical you can trade
5861speed for memory and install an UNCOMPRESSED image instead: this
5862needs more space in Flash, but boots much faster since it does not
5863need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005864
Stefan Roese88fbf932010-04-15 16:07:28 +02005865 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005866 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5867 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005868 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005869 > examples/uImage.TQM850L-uncompressed
5870 Image Name: 2.4.4 kernel for TQM850L
5871 Created: Wed Jul 19 02:34:59 2000
5872 Image Type: PowerPC Linux Kernel Image (uncompressed)
5873 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5874 Load Address: 0x00000000
5875 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005876
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk6c59edc2004-05-03 20:45:30 +00005878Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5879when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881 -> tools/mkimage -n 'Simple Ramdisk Image' \
5882 > -A ppc -O linux -T ramdisk -C gzip \
5883 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5884 Image Name: Simple Ramdisk Image
5885 Created: Wed Jan 12 14:01:50 2000
5886 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5887 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5888 Load Address: 0x00000000
5889 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005890
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005891The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5892option performs the converse operation of the mkimage's second form (the "-d"
5893option). Given an image built by mkimage, the dumpimage extracts a "data file"
5894from the image:
5895
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005896 tools/dumpimage -i image -T type -p position data_file
5897 -i ==> extract from the 'image' a specific 'data_file'
5898 -T ==> set image type to 'type'
5899 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005900
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk6c59edc2004-05-03 20:45:30 +00005902Installing a Linux Image:
5903-------------------------
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905To downloading a U-Boot image over the serial (console) interface,
5906you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005907
wdenk6c59edc2004-05-03 20:45:30 +00005908 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk6c59edc2004-05-03 20:45:30 +00005910The 'objcopy' does not understand the information in the U-Boot
5911image header, so the resulting S-Record file will be relative to
5912address 0x00000000. To load it to a given address, you need to
5913specify the target address as 'offset' parameter with the 'loads'
5914command.
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk6c59edc2004-05-03 20:45:30 +00005916Example: install the image to address 0x40100000 (which on the
5917TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk6c59edc2004-05-03 20:45:30 +00005919 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk6c59edc2004-05-03 20:45:30 +00005921 .......... done
5922 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924 => loads 40100000
5925 ## Ready for S-Record download ...
5926 ~>examples/image.srec
5927 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5928 ...
5929 15989 15990 15991 15992
5930 [file transfer complete]
5931 [connected]
5932 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005933
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005936this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005937corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk6c59edc2004-05-03 20:45:30 +00005939 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941 ## Checking Image at 40100000 ...
5942 Image Name: 2.2.13 for initrd on TQM850L
5943 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5944 Data Size: 335725 Bytes = 327 kB = 0 MB
5945 Load Address: 00000000
5946 Entry Point: 0000000c
5947 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005948
5949
wdenk6c59edc2004-05-03 20:45:30 +00005950Boot Linux:
5951-----------
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk6c59edc2004-05-03 20:45:30 +00005953The "bootm" command is used to boot an application that is stored in
5954memory (RAM or Flash). In case of a Linux kernel image, the contents
5955of the "bootargs" environment variable is passed to the kernel as
5956parameters. You can check and modify this variable using the
5957"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005958
wdenkc6097192002-11-03 00:24:07 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960 => printenv bootargs
5961 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963 => 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 +00005964
wdenk6c59edc2004-05-03 20:45:30 +00005965 => printenv bootargs
5966 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 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968 => bootm 40020000
5969 ## Booting Linux kernel at 40020000 ...
5970 Image Name: 2.2.13 for NFS on TQM850L
5971 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5972 Data Size: 381681 Bytes = 372 kB = 0 MB
5973 Load Address: 00000000
5974 Entry Point: 0000000c
5975 Verifying Checksum ... OK
5976 Uncompressing Kernel Image ... OK
5977 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
5978 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5979 time_init: decrementer frequency = 187500000/60
5980 Calibrating delay loop... 49.77 BogoMIPS
5981 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5982 ...
wdenkc6097192002-11-03 00:24:07 +00005983
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005984If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005985the memory addresses of both the kernel and the initrd image (PPBCOOT
5986format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005987
wdenk6c59edc2004-05-03 20:45:30 +00005988 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005989
wdenk6c59edc2004-05-03 20:45:30 +00005990 ## Checking Image at 40100000 ...
5991 Image Name: 2.2.13 for initrd on TQM850L
5992 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5993 Data Size: 335725 Bytes = 327 kB = 0 MB
5994 Load Address: 00000000
5995 Entry Point: 0000000c
5996 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk6c59edc2004-05-03 20:45:30 +00005998 ## Checking Image at 40200000 ...
5999 Image Name: Simple Ramdisk Image
6000 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6001 Data Size: 566530 Bytes = 553 kB = 0 MB
6002 Load Address: 00000000
6003 Entry Point: 00000000
6004 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006005
wdenk6c59edc2004-05-03 20:45:30 +00006006 => bootm 40100000 40200000
6007 ## Booting Linux kernel at 40100000 ...
6008 Image Name: 2.2.13 for initrd on TQM850L
6009 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6010 Data Size: 335725 Bytes = 327 kB = 0 MB
6011 Load Address: 00000000
6012 Entry Point: 0000000c
6013 Verifying Checksum ... OK
6014 Uncompressing Kernel Image ... OK
6015 ## Loading RAMDisk Image at 40200000 ...
6016 Image Name: Simple Ramdisk Image
6017 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6018 Data Size: 566530 Bytes = 553 kB = 0 MB
6019 Load Address: 00000000
6020 Entry Point: 00000000
6021 Verifying Checksum ... OK
6022 Loading Ramdisk ... OK
6023 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
6024 Boot arguments: root=/dev/ram
6025 time_init: decrementer frequency = 187500000/60
6026 Calibrating delay loop... 49.77 BogoMIPS
6027 ...
6028 RAMDISK: Compressed image found at block 0
6029 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006030
wdenk6c59edc2004-05-03 20:45:30 +00006031 bash#
wdenkc6097192002-11-03 00:24:07 +00006032
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006033Boot Linux and pass a flat device tree:
6034-----------
6035
6036First, U-Boot must be compiled with the appropriate defines. See the section
6037titled "Linux Kernel Interface" above for a more in depth explanation. The
6038following is an example of how to start a kernel and pass an updated
6039flat device tree:
6040
6041=> print oftaddr
6042oftaddr=0x300000
6043=> print oft
6044oft=oftrees/mpc8540ads.dtb
6045=> tftp $oftaddr $oft
6046Speed: 1000, full duplex
6047Using TSEC0 device
6048TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6049Filename 'oftrees/mpc8540ads.dtb'.
6050Load address: 0x300000
6051Loading: #
6052done
6053Bytes transferred = 4106 (100a hex)
6054=> tftp $loadaddr $bootfile
6055Speed: 1000, full duplex
6056Using TSEC0 device
6057TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6058Filename 'uImage'.
6059Load address: 0x200000
6060Loading:############
6061done
6062Bytes transferred = 1029407 (fb51f hex)
6063=> print loadaddr
6064loadaddr=200000
6065=> print oftaddr
6066oftaddr=0x300000
6067=> bootm $loadaddr - $oftaddr
6068## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006069 Image Name: Linux-2.6.17-dirty
6070 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6071 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006072 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006073 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006074 Verifying Checksum ... OK
6075 Uncompressing Kernel Image ... OK
6076Booting using flat device tree at 0x300000
6077Using MPC85xx ADS machine description
6078Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6079[snip]
6080
6081
wdenk6c59edc2004-05-03 20:45:30 +00006082More About U-Boot Image Types:
6083------------------------------
wdenkc6097192002-11-03 00:24:07 +00006084
wdenk6c59edc2004-05-03 20:45:30 +00006085U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk6c59edc2004-05-03 20:45:30 +00006087 "Standalone Programs" are directly runnable in the environment
6088 provided by U-Boot; it is expected that (if they behave
6089 well) you can continue to work in U-Boot after return from
6090 the Standalone Program.
6091 "OS Kernel Images" are usually images of some Embedded OS which
6092 will take over control completely. Usually these programs
6093 will install their own set of exception handlers, device
6094 drivers, set up the MMU, etc. - this means, that you cannot
6095 expect to re-enter U-Boot except by resetting the CPU.
6096 "RAMDisk Images" are more or less just data blocks, and their
6097 parameters (address, size) are passed to an OS kernel that is
6098 being started.
6099 "Multi-File Images" contain several images, typically an OS
6100 (Linux) kernel image and one or more data images like
6101 RAMDisks. This construct is useful for instance when you want
6102 to boot over the network using BOOTP etc., where the boot
6103 server provides just a single image file, but you want to get
6104 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk6c59edc2004-05-03 20:45:30 +00006106 "Multi-File Images" start with a list of image sizes, each
6107 image size (in bytes) specified by an "uint32_t" in network
6108 byte order. This list is terminated by an "(uint32_t)0".
6109 Immediately after the terminating 0 follow the images, one by
6110 one, all aligned on "uint32_t" boundaries (size rounded up to
6111 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006112
wdenk6c59edc2004-05-03 20:45:30 +00006113 "Firmware Images" are binary images containing firmware (like
6114 U-Boot or FPGA images) which usually will be programmed to
6115 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006116
wdenk6c59edc2004-05-03 20:45:30 +00006117 "Script files" are command sequences that will be executed by
6118 U-Boot's command interpreter; this feature is especially
6119 useful when you configure U-Boot to use a real shell (hush)
6120 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006121
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006122Booting the Linux zImage:
6123-------------------------
6124
6125On some platforms, it's possible to boot Linux zImage. This is done
6126using the "bootz" command. The syntax of "bootz" command is the same
6127as the syntax of "bootm" command.
6128
Tom Rini45f46d12013-05-16 11:40:11 -04006129Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006130kernel with raw initrd images. The syntax is slightly different, the
6131address of the initrd must be augmented by it's size, in the following
6132format: "<initrd addres>:<initrd size>".
6133
stroeseb9c17c52003-04-04 15:53:41 +00006134
wdenk6c59edc2004-05-03 20:45:30 +00006135Standalone HOWTO:
6136=================
stroeseb9c17c52003-04-04 15:53:41 +00006137
wdenk6c59edc2004-05-03 20:45:30 +00006138One of the features of U-Boot is that you can dynamically load and
6139run "standalone" applications, which can use some resources of
6140U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006141
wdenk6c59edc2004-05-03 20:45:30 +00006142Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006143
wdenk6c59edc2004-05-03 20:45:30 +00006144"Hello World" Demo:
6145-------------------
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk6c59edc2004-05-03 20:45:30 +00006147'examples/hello_world.c' contains a small "Hello World" Demo
6148application; it is automatically compiled when you build U-Boot.
6149It's configured to run at address 0x00040004, so you can play with it
6150like that:
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk6c59edc2004-05-03 20:45:30 +00006152 => loads
6153 ## Ready for S-Record download ...
6154 ~>examples/hello_world.srec
6155 1 2 3 4 5 6 7 8 9 10 11 ...
6156 [file transfer complete]
6157 [connected]
6158 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006159
wdenk6c59edc2004-05-03 20:45:30 +00006160 => go 40004 Hello World! This is a test.
6161 ## Starting application at 0x00040004 ...
6162 Hello World
6163 argc = 7
6164 argv[0] = "40004"
6165 argv[1] = "Hello"
6166 argv[2] = "World!"
6167 argv[3] = "This"
6168 argv[4] = "is"
6169 argv[5] = "a"
6170 argv[6] = "test."
6171 argv[7] = "<NULL>"
6172 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006173
wdenk6c59edc2004-05-03 20:45:30 +00006174 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006175
wdenk6c59edc2004-05-03 20:45:30 +00006176Another example, which demonstrates how to register a CPM interrupt
6177handler with the U-Boot code, can be found in 'examples/timer.c'.
6178Here, a CPM timer is set up to generate an interrupt every second.
6179The interrupt service routine is trivial, just printing a '.'
6180character, but this is just a demo program. The application can be
6181controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk6c59edc2004-05-03 20:45:30 +00006183 ? - print current values og the CPM Timer registers
6184 b - enable interrupts and start timer
6185 e - stop timer and disable interrupts
6186 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006187
wdenk6c59edc2004-05-03 20:45:30 +00006188 => loads
6189 ## Ready for S-Record download ...
6190 ~>examples/timer.srec
6191 1 2 3 4 5 6 7 8 9 10 11 ...
6192 [file transfer complete]
6193 [connected]
6194 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006195
wdenk6c59edc2004-05-03 20:45:30 +00006196 => go 40004
6197 ## Starting application at 0x00040004 ...
6198 TIMERS=0xfff00980
6199 Using timer 1
6200 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202Hit 'b':
6203 [q, b, e, ?] Set interval 1000000 us
6204 Enabling timer
6205Hit '?':
6206 [q, b, e, ?] ........
6207 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6208Hit '?':
6209 [q, b, e, ?] .
6210 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6211Hit '?':
6212 [q, b, e, ?] .
6213 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6214Hit '?':
6215 [q, b, e, ?] .
6216 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6217Hit 'e':
6218 [q, b, e, ?] ...Stopping timer
6219Hit 'q':
6220 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006221
wdenkc6097192002-11-03 00:24:07 +00006222
wdenk6c59edc2004-05-03 20:45:30 +00006223Minicom warning:
6224================
wdenkc6097192002-11-03 00:24:07 +00006225
wdenk6c59edc2004-05-03 20:45:30 +00006226Over time, many people have reported problems when trying to use the
6227"minicom" terminal emulation program for serial download. I (wd)
6228consider minicom to be broken, and recommend not to use it. Under
6229Unix, I recommend to use C-Kermit for general purpose use (and
6230especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006231use "cu" for S-Record download ("loads" command). See
6232http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6233for help with kermit.
6234
wdenkc6097192002-11-03 00:24:07 +00006235
wdenk6c59edc2004-05-03 20:45:30 +00006236Nevertheless, if you absolutely want to use it try adding this
6237configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk6c59edc2004-05-03 20:45:30 +00006239 Name Program Name U/D FullScr IO-Red. Multi
6240 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6241 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006242
wdenk8dba0502003-03-31 16:34:49 +00006243
wdenk6c59edc2004-05-03 20:45:30 +00006244NetBSD Notes:
6245=============
wdenkc6097192002-11-03 00:24:07 +00006246
wdenk6c59edc2004-05-03 20:45:30 +00006247Starting at version 0.9.2, U-Boot supports NetBSD both as host
6248(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250Building requires a cross environment; it is known to work on
6251NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6252need gmake since the Makefiles are not compatible with BSD make).
6253Note that the cross-powerpc package does not install include files;
6254attempting to build U-Boot will fail because <machine/ansi.h> is
6255missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257 # cd /usr/pkg/cross/powerpc-netbsd/include
6258 # mkdir powerpc
6259 # ln -s powerpc machine
6260 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6261 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006262
wdenk6c59edc2004-05-03 20:45:30 +00006263Native builds *don't* work due to incompatibilities between native
6264and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006265
wdenk6c59edc2004-05-03 20:45:30 +00006266Booting assumes that (the first part of) the image booted is a
6267stage-2 loader which in turn loads and then invokes the kernel
6268proper. Loader sources will eventually appear in the NetBSD source
6269tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006270meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006271
wdenkc6097192002-11-03 00:24:07 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273Implementation Internals:
6274=========================
wdenkc6097192002-11-03 00:24:07 +00006275
wdenk6c59edc2004-05-03 20:45:30 +00006276The following is not intended to be a complete description of every
6277implementation detail. However, it should help to understand the
6278inner workings of U-Boot and make it easier to port it to custom
6279hardware.
wdenkc6097192002-11-03 00:24:07 +00006280
wdenkc6097192002-11-03 00:24:07 +00006281
wdenk6c59edc2004-05-03 20:45:30 +00006282Initial Stack, Global Data:
6283---------------------------
wdenkc6097192002-11-03 00:24:07 +00006284
wdenk6c59edc2004-05-03 20:45:30 +00006285The implementation of U-Boot is complicated by the fact that U-Boot
6286starts running out of ROM (flash memory), usually without access to
6287system RAM (because the memory controller is not initialized yet).
6288This means that we don't have writable Data or BSS segments, and BSS
6289is not initialized as zero. To be able to get a C environment working
6290at all, we have to allocate at least a minimal stack. Implementation
6291options for this are defined and restricted by the CPU used: Some CPU
6292models provide on-chip memory (like the IMMR area on MPC8xx and
6293MPC826x processors), on others (parts of) the data cache can be
6294locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006295
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006296 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006297 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6300 From: "Chris Hallinan" <clh@net1plus.com>
6301 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6302 ...
wdenkc6097192002-11-03 00:24:07 +00006303
wdenk6c59edc2004-05-03 20:45:30 +00006304 Correct me if I'm wrong, folks, but the way I understand it
6305 is this: Using DCACHE as initial RAM for Stack, etc, does not
6306 require any physical RAM backing up the cache. The cleverness
6307 is that the cache is being used as a temporary supply of
6308 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006309 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006310 can see how this works by studying the cache architecture and
6311 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006312
wdenk6c59edc2004-05-03 20:45:30 +00006313 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6314 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006315 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006316 option should work for you. Using CS 4 should be fine if your
6317 board designers haven't used it for something that would
6318 cause you grief during the initial boot! It is frequently not
6319 used.
wdenkc6097192002-11-03 00:24:07 +00006320
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006321 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006322 with your processor/board/system design. The default value
6323 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006324 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006325 than your SDRAM module. If you have a 64MB SDRAM module, set
6326 it above 400_0000. Just make sure your board has no resources
6327 that are supposed to respond to that address! That code in
6328 start.S has been around a while and should work as is when
6329 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006330
wdenk6c59edc2004-05-03 20:45:30 +00006331 -Chris Hallinan
6332 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006333
wdenk6c59edc2004-05-03 20:45:30 +00006334It is essential to remember this, since it has some impact on the C
6335code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006336
wdenk6c59edc2004-05-03 20:45:30 +00006337* Initialized global data (data segment) is read-only. Do not attempt
6338 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006339
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006340* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006341 as zero data - BSS segment) at all - this is undefined, initiali-
6342 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006343
wdenk6c59edc2004-05-03 20:45:30 +00006344* Stack space is very limited. Avoid big data buffers or things like
6345 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006346
wdenk6c59edc2004-05-03 20:45:30 +00006347Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006348normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006349turned out that the implementation of U-Boot can be greatly
6350simplified by making a global data structure (gd_t) available to all
6351functions. We could pass a pointer to this data as argument to _all_
6352functions, but this would bloat the code. Instead we use a feature of
6353the GCC compiler (Global Register Variables) to share the data: we
6354place a pointer (gd) to the global data into a register which we
6355reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006356
wdenk6c59edc2004-05-03 20:45:30 +00006357When choosing a register for such a purpose we are restricted by the
6358relevant (E)ABI specifications for the current architecture, and by
6359GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk6c59edc2004-05-03 20:45:30 +00006361For PowerPC, the following registers have specific use:
6362 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006363 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006364 R3-R4: parameter passing and return values
6365 R5-R10: parameter passing
6366 R13: small data area pointer
6367 R30: GOT pointer
6368 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006369
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006370 (U-Boot also uses R12 as internal GOT pointer. r12
6371 is a volatile register so r12 needs to be reset when
6372 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006373
Wolfgang Denk69c09642008-02-14 22:43:22 +01006374 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006375
wdenk6c59edc2004-05-03 20:45:30 +00006376 Note: on PPC, we could use a static initializer (since the
6377 address of the global data structure is known at compile time),
6378 but it turned out that reserving a register results in somewhat
6379 smaller code - although the code savings are not that big (on
6380 average for all boards 752 bytes for the whole U-Boot image,
6381 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006382
Robin Getz2773d5f2009-08-17 15:23:02 +00006383On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006384 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6385
Robin Getz2773d5f2009-08-17 15:23:02 +00006386 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006387
wdenk6c59edc2004-05-03 20:45:30 +00006388On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006389
wdenk6c59edc2004-05-03 20:45:30 +00006390 R0: function argument word/integer result
6391 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006392 R9: platform specific
6393 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006394 R11: argument (frame) pointer
6395 R12: temporary workspace
6396 R13: stack pointer
6397 R14: link register
6398 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006399
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006400 ==> U-Boot will use R9 to hold a pointer to the global data
6401
6402 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006403
Thomas Chou8fa38582010-05-21 11:08:03 +08006404On Nios II, the ABI is documented here:
6405 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6406
6407 ==> U-Boot will use gp to hold a pointer to the global data
6408
6409 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6410 to access small data sections, so gp is free.
6411
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006412On NDS32, the following registers are used:
6413
6414 R0-R1: argument/return
6415 R2-R5: argument
6416 R15: temporary register for assembler
6417 R16: trampoline register
6418 R28: frame pointer (FP)
6419 R29: global pointer (GP)
6420 R30: link register (LP)
6421 R31: stack pointer (SP)
6422 PC: program counter (PC)
6423
6424 ==> U-Boot will use R10 to hold a pointer to the global data
6425
Wolfgang Denk6405a152006-03-31 18:32:53 +02006426NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6427or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006428
wdenk6c59edc2004-05-03 20:45:30 +00006429Memory Management:
6430------------------
wdenkc6097192002-11-03 00:24:07 +00006431
wdenk6c59edc2004-05-03 20:45:30 +00006432U-Boot runs in system state and uses physical addresses, i.e. the
6433MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006434
wdenk6c59edc2004-05-03 20:45:30 +00006435The available memory is mapped to fixed addresses using the memory
6436controller. In this process, a contiguous block is formed for each
6437memory type (Flash, SDRAM, SRAM), even when it consists of several
6438physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk6c59edc2004-05-03 20:45:30 +00006440U-Boot is installed in the first 128 kB of the first Flash bank (on
6441TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6442booting and sizing and initializing DRAM, the code relocates itself
6443to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006444memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006445configuration setting]. Below that, a structure with global Board
6446Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006447
wdenk6c59edc2004-05-03 20:45:30 +00006448Additionally, some exception handler code is copied to the low 8 kB
6449of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006450
wdenk6c59edc2004-05-03 20:45:30 +00006451So a typical memory configuration with 16 MB of DRAM could look like
6452this:
wdenkc6097192002-11-03 00:24:07 +00006453
wdenk6c59edc2004-05-03 20:45:30 +00006454 0x0000 0000 Exception Vector code
6455 :
6456 0x0000 1FFF
6457 0x0000 2000 Free for Application Use
6458 :
6459 :
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk6c59edc2004-05-03 20:45:30 +00006461 :
6462 :
6463 0x00FB FF20 Monitor Stack (Growing downward)
6464 0x00FB FFAC Board Info Data and permanent copy of global data
6465 0x00FC 0000 Malloc Arena
6466 :
6467 0x00FD FFFF
6468 0x00FE 0000 RAM Copy of Monitor Code
6469 ... eventually: LCD or video framebuffer
6470 ... eventually: pRAM (Protected RAM - unchanged by reset)
6471 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006472
wdenkc6097192002-11-03 00:24:07 +00006473
wdenk6c59edc2004-05-03 20:45:30 +00006474System Initialization:
6475----------------------
wdenkc6097192002-11-03 00:24:07 +00006476
wdenk6c59edc2004-05-03 20:45:30 +00006477In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006478(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006479configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006480To be able to re-map memory U-Boot then jumps to its link address.
6481To be able to implement the initialization code in C, a (small!)
6482initial stack is set up in the internal Dual Ported RAM (in case CPUs
6483which provide such a feature like MPC8xx or MPC8260), or in a locked
6484part of the data cache. After that, U-Boot initializes the CPU core,
6485the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006486
wdenk6c59edc2004-05-03 20:45:30 +00006487Next, all (potentially) available memory banks are mapped using a
6488preliminary mapping. For example, we put them on 512 MB boundaries
6489(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6490on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6491programmed for SDRAM access. Using the temporary configuration, a
6492simple memory test is run that determines the size of the SDRAM
6493banks.
wdenkc6097192002-11-03 00:24:07 +00006494
wdenk6c59edc2004-05-03 20:45:30 +00006495When there is more than one SDRAM bank, and the banks are of
6496different size, the largest is mapped first. For equal size, the first
6497bank (CS2#) is mapped first. The first mapping is always for address
64980x00000000, with any additional banks following immediately to create
6499contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006500
wdenk6c59edc2004-05-03 20:45:30 +00006501Then, the monitor installs itself at the upper end of the SDRAM area
6502and allocates memory for use by malloc() and for the global Board
6503Info data; also, the exception vector code is copied to the low RAM
6504pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk6c59edc2004-05-03 20:45:30 +00006506Only after this relocation will you have a "normal" C environment;
6507until that you are restricted in several ways, mostly because you are
6508running from ROM, and because the code will have to be relocated to a
6509new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006510
wdenkc6097192002-11-03 00:24:07 +00006511
wdenk6c59edc2004-05-03 20:45:30 +00006512U-Boot Porting Guide:
6513----------------------
wdenkc6097192002-11-03 00:24:07 +00006514
wdenk6c59edc2004-05-03 20:45:30 +00006515[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6516list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006517
wdenkc6097192002-11-03 00:24:07 +00006518
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006519int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006520{
6521 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006522
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006523 signal(SIGALRM, no_more_time);
6524 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006525
wdenk6c59edc2004-05-03 20:45:30 +00006526 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006527 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006528 return 0;
6529 }
wdenkc6097192002-11-03 00:24:07 +00006530
wdenk6c59edc2004-05-03 20:45:30 +00006531 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006532
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006533 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006534
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006535 if (clueless)
6536 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006537
wdenk6c59edc2004-05-03 20:45:30 +00006538 while (learning) {
6539 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006540 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6541 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006542 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006543 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006544 }
wdenkc6097192002-11-03 00:24:07 +00006545
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006546 if (available_money > toLocalCurrency ($2500))
6547 Buy a BDI3000;
6548 else
wdenk6c59edc2004-05-03 20:45:30 +00006549 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006550
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006551 if (a similar board exists) { /* hopefully... */
6552 cp -a board/<similar> board/<myboard>
6553 cp include/configs/<similar>.h include/configs/<myboard>.h
6554 } else {
6555 Create your own board support subdirectory;
6556 Create your own board include/configs/<myboard>.h file;
6557 }
6558 Edit new board/<myboard> files
6559 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006560
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006561 while (!accepted) {
6562 while (!running) {
6563 do {
6564 Add / modify source code;
6565 } until (compiles);
6566 Debug;
6567 if (clueless)
6568 email("Hi, I am having problems...");
6569 }
6570 Send patch file to the U-Boot email list;
6571 if (reasonable critiques)
6572 Incorporate improvements from email list code review;
6573 else
6574 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006575 }
wdenkc6097192002-11-03 00:24:07 +00006576
wdenk6c59edc2004-05-03 20:45:30 +00006577 return 0;
6578}
wdenkc6097192002-11-03 00:24:07 +00006579
wdenk6c59edc2004-05-03 20:45:30 +00006580void no_more_time (int sig)
6581{
6582 hire_a_guru();
6583}
wdenkc6097192002-11-03 00:24:07 +00006584
wdenkc6097192002-11-03 00:24:07 +00006585
wdenk6c59edc2004-05-03 20:45:30 +00006586Coding Standards:
6587-----------------
wdenkc6097192002-11-03 00:24:07 +00006588
wdenk6c59edc2004-05-03 20:45:30 +00006589All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006590coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006591"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006592
6593Source files originating from a different project (for example the
6594MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006595reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006596sources.
wdenkc6097192002-11-03 00:24:07 +00006597
Detlev Zundelaa63d482006-09-01 15:39:02 +02006598Please note that U-Boot is implemented in C (and to some small parts in
6599Assembler); no C++ is used, so please do not use C++ style comments (//)
6600in your code.
wdenkad276f22004-01-04 16:28:35 +00006601
wdenk6c59edc2004-05-03 20:45:30 +00006602Please also stick to the following formatting rules:
6603- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006604- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006605- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006606- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006607- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006608
wdenk6c59edc2004-05-03 20:45:30 +00006609Submissions which do not conform to the standards may be returned
6610with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006611
wdenkc6097192002-11-03 00:24:07 +00006612
wdenk6c59edc2004-05-03 20:45:30 +00006613Submitting Patches:
6614-------------------
wdenkc6097192002-11-03 00:24:07 +00006615
wdenk6c59edc2004-05-03 20:45:30 +00006616Since the number of patches for U-Boot is growing, we need to
6617establish some rules. Submissions which do not conform to these rules
6618may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006619
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006620Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006621
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006622Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6623see http://lists.denx.de/mailman/listinfo/u-boot
6624
wdenk6c59edc2004-05-03 20:45:30 +00006625When you send a patch, please include the following information with
6626it:
wdenkc6097192002-11-03 00:24:07 +00006627
wdenk6c59edc2004-05-03 20:45:30 +00006628* For bug fixes: a description of the bug and how your patch fixes
6629 this bug. Please try to include a way of demonstrating that the
6630 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006631
wdenk6c59edc2004-05-03 20:45:30 +00006632* For new features: a description of the feature and your
6633 implementation.
wdenkc6097192002-11-03 00:24:07 +00006634
wdenk6c59edc2004-05-03 20:45:30 +00006635* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006636
wdenk6c59edc2004-05-03 20:45:30 +00006637* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006638
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006639* When you add support for a new board, don't forget to add a
6640 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006641
wdenk6c59edc2004-05-03 20:45:30 +00006642* If your patch adds new configuration options, don't forget to
6643 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006644
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006645* The patch itself. If you are using git (which is *strongly*
6646 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006647 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006648 the U-Boot mailing list, you will avoid most of the common problems
6649 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006650
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006651 If you cannot use git, use "diff -purN OLD NEW". If your version of
6652 diff does not support these options, then get the latest version of
6653 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006654
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006655 The current directory when running this command shall be the parent
6656 directory of the U-Boot source tree (i. e. please make sure that
6657 your patch includes sufficient directory information for the
6658 affected files).
6659
6660 We prefer patches as plain text. MIME attachments are discouraged,
6661 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006662
wdenk6c59edc2004-05-03 20:45:30 +00006663* If one logical set of modifications affects or creates several
6664 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006665
wdenk6c59edc2004-05-03 20:45:30 +00006666* Changesets that contain different, unrelated modifications shall be
6667 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006668
wdenkc6097192002-11-03 00:24:07 +00006669
wdenk6c59edc2004-05-03 20:45:30 +00006670Notes:
wdenkc6097192002-11-03 00:24:07 +00006671
wdenk6c59edc2004-05-03 20:45:30 +00006672* Before sending the patch, run the MAKEALL script on your patched
6673 source tree and make sure that no errors or warnings are reported
6674 for any of the boards.
6675
6676* Keep your modifications to the necessary minimum: A patch
6677 containing several unrelated changes or arbitrary reformats will be
6678 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006679
wdenk6c59edc2004-05-03 20:45:30 +00006680* If you modify existing code, make sure that your new code does not
6681 add to the memory footprint of the code ;-) Small is beautiful!
6682 When adding new features, these should compile conditionally only
6683 (using #ifdef), and the resulting code with the new feature
6684 disabled must not need more memory than the old code without your
6685 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006686
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006687* Remember that there is a size limit of 100 kB per message on the
6688 u-boot mailing list. Bigger patches will be moderated. If they are
6689 reasonable and not too big, they will be acknowledged. But patches
6690 bigger than the size limit should be avoided.