blob: a70af9864676652bd127fc1cdb1dfc7739472e96 [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 Garg7f17aed2014-04-02 08:55:01 -0500684 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500685 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000686
687 If set, the workarounds for these ARM errata are applied early
688 during U-Boot startup. Note that these options force the
689 workarounds to be applied; no CPU-type/version detection
690 exists, unlike the similar options in the Linux kernel. Do not
691 set these options unless they apply!
692
York Sun77a10972015-03-20 19:28:08 -0700693 COUNTER_FREQUENCY
694 Generic timer clock source frequency.
695
696 COUNTER_FREQUENCY_REAL
697 Generic timer clock source frequency if the real clock is
698 different from COUNTER_FREQUENCY, and can only be determined
699 at run time.
700
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500701 NOTE: The following can be machine specific errata. These
702 do have ability to provide rudimentary version and machine
703 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500704 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500705 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500706 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500707 CONFIG_ARM_ERRATA_798870
708
Stephen Warren8d1fb312015-01-19 16:25:52 -0700709- Tegra SoC options:
710 CONFIG_TEGRA_SUPPORT_NON_SECURE
711
712 Support executing U-Boot in non-secure (NS) mode. Certain
713 impossible actions will be skipped if the CPU is in NS mode,
714 such as ARM architectural timer initialization.
715
wdenk9b7f3842003-10-09 20:09:04 +0000716- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000717 CONFIG_CLOCKS_IN_MHZ
718
719 U-Boot stores all clock information in Hz
720 internally. For binary compatibility with older Linux
721 kernels (which expect the clocks passed in the
722 bd_info data to be in MHz) the environment variable
723 "clocks_in_mhz" can be defined so that U-Boot
724 converts clock data to MHZ before passing it to the
725 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000726 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100727 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000728 default environment.
729
wdenk9b7f3842003-10-09 20:09:04 +0000730 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
731
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800732 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000733 expect it to be in bytes, others in MB.
734 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
735
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400736 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200737
738 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400739 passed using flattened device trees (based on open firmware
740 concepts).
741
742 CONFIG_OF_LIBFDT
743 * New libfdt-based support
744 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500745 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400746
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200747 OF_CPU - The proper name of the cpus node (only required for
748 MPC512X and MPC5xxx based boards).
749 OF_SOC - The proper name of the soc node (only required for
750 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200751 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600752 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200753
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200754 boards with QUICC Engines require OF_QE to set UCC MAC
755 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500756
Kumar Gala1e26aa52006-01-11 13:54:17 -0600757 CONFIG_OF_BOARD_SETUP
758
759 Board code has addition modification that it wants to make
760 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000761
Simon Glass6c0be912014-10-23 18:58:54 -0600762 CONFIG_OF_SYSTEM_SETUP
763
764 Other code has addition modification that it wants to make
765 to the flat device tree before handing it off to the kernel.
766 This causes ft_system_setup() to be called before booting
767 the kernel.
768
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500769 CONFIG_OF_BOOT_CPU
770
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200771 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500772 param header, the default value is zero if undefined.
773
Heiko Schocherffb293a2009-09-23 07:56:08 +0200774 CONFIG_OF_IDE_FIXUP
775
776 U-Boot can detect if an IDE device is present or not.
777 If not, and this new config option is activated, U-Boot
778 removes the ATA node from the DTS before booting Linux,
779 so the Linux IDE driver does not probe the device and
780 crash. This is needed for buggy hardware (uc101) where
781 no pull down resistor is connected to the signal IDE5V_DD7.
782
Igor Grinberg06890672011-07-14 05:45:07 +0000783 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
784
785 This setting is mandatory for all boards that have only one
786 machine type and must be used to specify the machine type
787 number as it appears in the ARM machine registry
788 (see http://www.arm.linux.org.uk/developer/machines/).
789 Only boards that have multiple machine types supported
790 in a single configuration file and the machine type is
791 runtime discoverable, do not have to use this setting.
792
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100793- vxWorks boot parameters:
794
795 bootvx constructs a valid bootline using the following
796 environments variables: bootfile, ipaddr, serverip, hostname.
797 It loads the vxWorks image pointed bootfile.
798
799 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
800 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
801 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
802 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
803
804 CONFIG_SYS_VXWORKS_ADD_PARAMS
805
806 Add it at the end of the bootline. E.g "u=username pw=secret"
807
808 Note: If a "bootargs" environment is defined, it will overwride
809 the defaults discussed just above.
810
Aneesh V960f5c02011-06-16 23:30:47 +0000811- Cache Configuration:
812 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
813 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
814 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
815
Aneesh V686a0752011-06-16 23:30:51 +0000816- Cache Configuration for ARM:
817 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
818 controller
819 CONFIG_SYS_PL310_BASE - Physical base address of PL310
820 controller register space
821
wdenkda04a8b2004-08-02 23:22:59 +0000822- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200823 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000824
825 Define this if you want support for Amba PrimeCell PL010 UARTs.
826
Andreas Engel0813b122008-09-08 14:30:53 +0200827 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000828
829 Define this if you want support for Amba PrimeCell PL011 UARTs.
830
831 CONFIG_PL011_CLOCK
832
833 If you have Amba PrimeCell PL011 UARTs, set this variable to
834 the clock speed of the UARTs.
835
836 CONFIG_PL01x_PORTS
837
838 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
839 define this to a list of base addresses for each (supported)
840 port. See e.g. include/configs/versatile.h
841
John Rigby34e21ee2011-04-19 10:42:39 +0000842 CONFIG_PL011_SERIAL_RLCR
843
844 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
845 have separate receive and transmit line control registers. Set
846 this variable to initialize the extra register.
847
848 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
849
850 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
851 boot loader that has already initialized the UART. Define this
852 variable to flush the UART at init time.
853
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400854 CONFIG_SERIAL_HW_FLOW_CONTROL
855
856 Define this variable to enable hw flow control in serial driver.
857 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000858
wdenkc6097192002-11-03 00:24:07 +0000859- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000860 Depending on board, define exactly one serial port
861 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
862 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
863 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000864
865 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
866 port routines must be defined elsewhere
867 (i.e. serial_init(), serial_getc(), ...)
868
869 CONFIG_CFB_CONSOLE
870 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000871 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000872 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
873 (default big endian)
874 VIDEO_HW_RECTFILL graphic chip supports
875 rectangle fill
876 (cf. smiLynxEM)
877 VIDEO_HW_BITBLT graphic chip supports
878 bit-blit (cf. smiLynxEM)
879 VIDEO_VISIBLE_COLS visible pixel columns
880 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000881 VIDEO_VISIBLE_ROWS visible pixel rows
882 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000883 VIDEO_DATA_FORMAT graphic data format
884 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000885 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000886 VIDEO_KBD_INIT_FCT keyboard int fct
887 (i.e. i8042_kbd_init())
888 VIDEO_TSTC_FCT test char fct
889 (i.e. i8042_tstc)
890 VIDEO_GETC_FCT get char fct
891 (i.e. i8042_getc)
892 CONFIG_CONSOLE_CURSOR cursor drawing on/off
893 (requires blink timer
894 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200895 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000896 CONFIG_CONSOLE_TIME display time/date info in
897 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500898 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000899 CONFIG_VIDEO_LOGO display Linux logo in
900 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000901 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
902 linux_logo.h for logo.
903 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000904 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200905 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000906 the logo
907
Pali Rohár4a57da32012-10-19 13:30:09 +0000908 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
909 a limited number of ANSI escape sequences (cursor control,
910 erase functions and limited graphics rendition control).
911
wdenk4a5c8a72003-03-06 00:02:04 +0000912 When CONFIG_CFB_CONSOLE is defined, video console is
913 default i/o. Serial console can be forced with
914 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000915
wdenk1ebf41e2004-01-02 14:00:00 +0000916 When CONFIG_SILENT_CONSOLE is defined, all console
917 messages (by U-Boot and Linux!) can be silenced with
918 the "silent" environment variable. See
919 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000920
Heiko Schocher62759562013-10-22 11:06:06 +0200921 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
922 is 0x00.
923 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
924 is 0xa0.
925
wdenkc6097192002-11-03 00:24:07 +0000926- Console Baudrate:
927 CONFIG_BAUDRATE - in bps
928 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200929 CONFIG_SYS_BAUDRATE_TABLE, see below.
930 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000931
Heiko Schocher327480a2009-01-30 12:55:38 +0100932- Console Rx buffer length
933 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
934 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100935 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100936 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
937 must be defined, to setup the maximum idle timeout for
938 the SMC.
939
Graeme Russ3c28f482011-09-01 00:48:27 +0000940- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200941 Prior to the console being initialised (i.e. serial UART
942 initialised etc) all console output is silently discarded.
943 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
944 buffer any console messages prior to the console being
945 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
946 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
947 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200948 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200949 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000950
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200951 'Sane' compilers will generate smaller code if
952 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000953
Sonny Raocd55bde2011-11-02 09:52:08 +0000954- Safe printf() functions
955 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
956 the printf() functions. These are defined in
957 include/vsprintf.h and include snprintf(), vsnprintf() and
958 so on. Code size increase is approximately 300-500 bytes.
959 If this option is not given then these functions will
960 silently discard their buffer size argument - this means
961 you are not getting any overflow checking in this case.
962
wdenkc6097192002-11-03 00:24:07 +0000963- Boot Delay: CONFIG_BOOTDELAY - in seconds
964 Delay before automatically booting the default image;
965 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000966 set to -2 to autoboot with no delay and not check for abort
967 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000968
969 See doc/README.autoboot for these options that
970 work with CONFIG_BOOTDELAY. None are required.
971 CONFIG_BOOT_RETRY_TIME
972 CONFIG_BOOT_RETRY_MIN
973 CONFIG_AUTOBOOT_KEYED
974 CONFIG_AUTOBOOT_PROMPT
975 CONFIG_AUTOBOOT_DELAY_STR
976 CONFIG_AUTOBOOT_STOP_STR
977 CONFIG_AUTOBOOT_DELAY_STR2
978 CONFIG_AUTOBOOT_STOP_STR2
979 CONFIG_ZERO_BOOTDELAY_CHECK
980 CONFIG_RESET_TO_RETRY
981
982- Autoboot Command:
983 CONFIG_BOOTCOMMAND
984 Only needed when CONFIG_BOOTDELAY is enabled;
985 define a command string that is automatically executed
986 when no character is read on the console interface
987 within "Boot Delay" after reset.
988
989 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000990 This can be used to pass arguments to the bootm
991 command. The value of CONFIG_BOOTARGS goes into the
992 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000993
994 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000995 The value of these goes into the environment as
996 "ramboot" and "nfsboot" respectively, and can be used
997 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200998 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000999
Heiko Schocher040c5c32013-11-04 14:04:59 +01001000- Bootcount:
1001 CONFIG_BOOTCOUNT_LIMIT
1002 Implements a mechanism for detecting a repeating reboot
1003 cycle, see:
1004 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1005
1006 CONFIG_BOOTCOUNT_ENV
1007 If no softreset save registers are found on the hardware
1008 "bootcount" is stored in the environment. To prevent a
1009 saveenv on all reboots, the environment variable
1010 "upgrade_available" is used. If "upgrade_available" is
1011 0, "bootcount" is always 0, if "upgrade_available" is
1012 1 "bootcount" is incremented in the environment.
1013 So the Userspace Applikation must set the "upgrade_available"
1014 and "bootcount" variable to 0, if a boot was successfully.
1015
wdenkc6097192002-11-03 00:24:07 +00001016- Pre-Boot Commands:
1017 CONFIG_PREBOOT
1018
1019 When this option is #defined, the existence of the
1020 environment variable "preboot" will be checked
1021 immediately before starting the CONFIG_BOOTDELAY
1022 countdown and/or running the auto-boot command resp.
1023 entering interactive mode.
1024
1025 This feature is especially useful when "preboot" is
1026 automatically generated or modified. For an example
1027 see the LWMON board specific code: here "preboot" is
1028 modified when the user holds down a certain
1029 combination of keys on the (special) keyboard when
1030 booting the systems
1031
1032- Serial Download Echo Mode:
1033 CONFIG_LOADS_ECHO
1034 If defined to 1, all characters received during a
1035 serial download (using the "loads" command) are
1036 echoed back. This might be needed by some terminal
1037 emulations (like "cu"), but may as well just take
1038 time on others. This setting #define's the initial
1039 value of the "loads_echo" environment variable.
1040
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001041- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001042 CONFIG_KGDB_BAUDRATE
1043 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001044 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001045
1046- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001047 Monitor commands can be included or excluded
1048 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001049 <config_cmd_all.h> and #undef'ing unwanted
1050 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001051 and augmenting with additional #define's
1052 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001053
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001054 The default command configuration includes all commands
1055 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001056
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001057 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001058 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001059 CONFIG_CMD_BDI bdinfo
1060 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1061 CONFIG_CMD_BMP * BMP support
1062 CONFIG_CMD_BSP * Board specific commands
1063 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001064 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001065 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001066 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001067 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001068 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 CONFIG_CMD_DATE * support for RTC, date/time...
1070 CONFIG_CMD_DHCP * DHCP support
1071 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001072 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1073 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1074 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1075 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001076 CONFIG_CMD_DTT * Digital Therm and Thermostat
1077 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001078 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001079 CONFIG_CMD_EEPROM * EEPROM read/write support
1080 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001081 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001082 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001083 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001084 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001085 CONFIG_CMD_EXT2 * ext2 command support
1086 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001087 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1088 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001089 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001090 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001091 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001092 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001093 CONFIG_CMD_FLASH flinfo, erase, protect
1094 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001095 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001096 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001097 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001098 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001099 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001100 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1101 CONFIG_CMD_I2C * I2C serial bus support
1102 CONFIG_CMD_IDE * IDE harddisk support
1103 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001104 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001105 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001106 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001107 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001108 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001109 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001110 CONFIG_CMD_IRQ * irqinfo
1111 CONFIG_CMD_ITEST Integer/string test of 2 values
1112 CONFIG_CMD_JFFS2 * JFFS2 Support
1113 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001114 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001115 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1116 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001117 CONFIG_CMD_LOADB loadb
1118 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001119 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001120 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001121 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001122 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001123 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001124 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001125 CONFIG_CMD_MISC Misc functions like sleep etc
1126 CONFIG_CMD_MMC * MMC memory mapped support
1127 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001128 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001129 CONFIG_CMD_NAND * NAND support
1130 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001131 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001132 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001133 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001134 CONFIG_CMD_PCI * pciinfo
1135 CONFIG_CMD_PCMCIA * PCMCIA support
1136 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1137 host
1138 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001139 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001140 CONFIG_CMD_REGINFO * Register dump
1141 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001142 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001143 CONFIG_CMD_SAVES * save S record dump
1144 CONFIG_CMD_SCSI * SCSI Support
1145 CONFIG_CMD_SDRAM * print SDRAM configuration information
1146 (requires CONFIG_CMD_I2C)
1147 CONFIG_CMD_SETGETDCR Support for DCR Register access
1148 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001149 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001150 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001151 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001152 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001153 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001154 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001155 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001156 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001157 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1158 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001159 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001160 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001161 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001162 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001163 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001164
1165 EXAMPLE: If you want all functions except of network
1166 support you can write:
1167
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001168 #include "config_cmd_all.h"
1169 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001170
Gerald Van Barend6abef42007-03-31 12:23:51 -04001171 Other Commands:
1172 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001173
1174 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001175 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001176 what you (and your U-Boot users) are doing. Data
1177 cache cannot be enabled on systems like the 8xx or
1178 8260 (where accesses to the IMMR region must be
1179 uncached), and it cannot be disabled on all other
1180 systems where we (mis-) use the data cache to hold an
1181 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001182
1183
1184 XXX - this list needs to get updated!
1185
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001186- Regular expression support:
1187 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001188 If this variable is defined, U-Boot is linked against
1189 the SLRE (Super Light Regular Expression) library,
1190 which adds regex support to some commands, as for
1191 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001192
Simon Glass3d686442011-10-15 05:48:20 +00001193- Device tree:
1194 CONFIG_OF_CONTROL
1195 If this variable is defined, U-Boot will use a device tree
1196 to configure its devices, instead of relying on statically
1197 compiled #defines in the board file. This option is
1198 experimental and only available on a few boards. The device
1199 tree is available in the global data as gd->fdt_blob.
1200
Simon Glass5cb34db2011-10-24 19:15:31 +00001201 U-Boot needs to get its device tree from somewhere. This can
1202 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001203
1204 CONFIG_OF_EMBED
1205 If this variable is defined, U-Boot will embed a device tree
1206 binary in its image. This device tree file should be in the
1207 board directory and called <soc>-<board>.dts. The binary file
1208 is then picked up in board_init_f() and made available through
1209 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001210
Simon Glass5cb34db2011-10-24 19:15:31 +00001211 CONFIG_OF_SEPARATE
1212 If this variable is defined, U-Boot will build a device tree
1213 binary. It will be called u-boot.dtb. Architecture-specific
1214 code will locate it at run-time. Generally this works by:
1215
1216 cat u-boot.bin u-boot.dtb >image.bin
1217
1218 and in fact, U-Boot does this for you, creating a file called
1219 u-boot-dtb.bin which is useful in the common case. You can
1220 still use the individual files if you need something more
1221 exotic.
1222
wdenkc6097192002-11-03 00:24:07 +00001223- Watchdog:
1224 CONFIG_WATCHDOG
1225 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001226 support for the SoC. There must be support in the SoC
1227 specific code for a watchdog. For the 8xx and 8260
1228 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1229 register. When supported for a specific SoC is
1230 available, then no further board specific code should
1231 be needed to use it.
1232
1233 CONFIG_HW_WATCHDOG
1234 When using a watchdog circuitry external to the used
1235 SoC, then define this variable and provide board
1236 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001237
Heiko Schocher735326c2015-01-21 08:38:22 +01001238 CONFIG_AT91_HW_WDT_TIMEOUT
1239 specify the timeout in seconds. default 2 seconds.
1240
stroeseb9c17c52003-04-04 15:53:41 +00001241- U-Boot Version:
1242 CONFIG_VERSION_VARIABLE
1243 If this variable is defined, an environment variable
1244 named "ver" is created by U-Boot showing the U-Boot
1245 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001246 Any change to this variable will be reverted at the
1247 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001248
wdenkc6097192002-11-03 00:24:07 +00001249- Real-Time Clock:
1250
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001251 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001252 has to be selected, too. Define exactly one of the
1253 following options:
1254
1255 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1256 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001257 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001258 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001259 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001260 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001261 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001262 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001263 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001264 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001265 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001266 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001267 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1268 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001269
wdenkb9bbd242003-06-30 16:24:52 +00001270 Note that if the RTC uses I2C, then the I2C interface
1271 must also be configured. See I2C Support, below.
1272
Peter Tyser9902e422008-12-17 16:36:21 -06001273- GPIO Support:
1274 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001275
Chris Packham9b383202010-12-19 10:12:13 +00001276 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1277 chip-ngpio pairs that tell the PCA953X driver the number of
1278 pins supported by a particular chip.
1279
Peter Tyser9902e422008-12-17 16:36:21 -06001280 Note that if the GPIO device uses I2C, then the I2C interface
1281 must also be configured. See I2C Support, below.
1282
Simon Glass4dc47ca2014-06-11 23:29:41 -06001283- I/O tracing:
1284 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1285 accesses and can checksum them or write a list of them out
1286 to memory. See the 'iotrace' command for details. This is
1287 useful for testing device drivers since it can confirm that
1288 the driver behaves the same way before and after a code
1289 change. Currently this is supported on sandbox and arm. To
1290 add support for your architecture, add '#include <iotrace.h>'
1291 to the bottom of arch/<arch>/include/asm/io.h and test.
1292
1293 Example output from the 'iotrace stats' command is below.
1294 Note that if the trace buffer is exhausted, the checksum will
1295 still continue to operate.
1296
1297 iotrace is enabled
1298 Start: 10000000 (buffer start address)
1299 Size: 00010000 (buffer size)
1300 Offset: 00000120 (current buffer offset)
1301 Output: 10000120 (start + offset)
1302 Count: 00000018 (number of trace records)
1303 CRC32: 9526fb66 (CRC32 of all trace records)
1304
wdenkc6097192002-11-03 00:24:07 +00001305- Timestamp Support:
1306
wdenk4a5c8a72003-03-06 00:02:04 +00001307 When CONFIG_TIMESTAMP is selected, the timestamp
1308 (date and time) of an image is printed by image
1309 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001310 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001311
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001312- Partition Labels (disklabels) Supported:
1313 Zero or more of the following:
1314 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1315 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1316 Intel architecture, USB sticks, etc.
1317 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1318 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1319 bootloader. Note 2TB partition limit; see
1320 disk/part_efi.c
1321 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001322
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001323 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1324 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001325 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001326
1327- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001328 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1329 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001330
wdenk369d43d2004-03-14 14:09:05 +00001331 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1332 be performed by calling the function
1333 ide_set_reset(int reset)
1334 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001335
1336- ATAPI Support:
1337 CONFIG_ATAPI
1338
1339 Set this to enable ATAPI support.
1340
wdenkf602aa02004-03-13 23:29:43 +00001341- LBA48 Support
1342 CONFIG_LBA48
1343
1344 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001345 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001346 Whithout these , LBA48 support uses 32bit variables and will 'only'
1347 support disks up to 2.1TB.
1348
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001349 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001350 When enabled, makes the IDE subsystem use 64bit sector addresses.
1351 Default is 32bit.
1352
wdenkc6097192002-11-03 00:24:07 +00001353- SCSI Support:
1354 At the moment only there is only support for the
1355 SYM53C8XX SCSI controller; define
1356 CONFIG_SCSI_SYM53C8XX to enable it.
1357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001358 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1359 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1360 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001361 maximum numbers of LUNs, SCSI ID's and target
1362 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001363 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001364
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001365 The environment variable 'scsidevs' is set to the number of
1366 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001367
wdenkc6097192002-11-03 00:24:07 +00001368- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001369 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001370 Support for Intel 8254x/8257x gigabit chips.
1371
1372 CONFIG_E1000_SPI
1373 Utility code for direct access to the SPI bus on Intel 8257x.
1374 This does not do anything useful unless you set at least one
1375 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1376
1377 CONFIG_E1000_SPI_GENERIC
1378 Allow generic access to the SPI bus on the Intel 8257x, for
1379 example with the "sspi" command.
1380
1381 CONFIG_CMD_E1000
1382 Management command for E1000 devices. When used on devices
1383 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001384
Andre Schwarz68c2a302008-03-06 16:45:44 +01001385 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001386 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001387
wdenkc6097192002-11-03 00:24:07 +00001388 CONFIG_EEPRO100
1389 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001390 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001391 write routine for first time initialisation.
1392
1393 CONFIG_TULIP
1394 Support for Digital 2114x chips.
1395 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1396 modem chip initialisation (KS8761/QS6611).
1397
1398 CONFIG_NATSEMI
1399 Support for National dp83815 chips.
1400
1401 CONFIG_NS8382X
1402 Support for National dp8382[01] gigabit chips.
1403
wdenkaa603362003-05-12 21:50:16 +00001404- NETWORK Support (other):
1405
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001406 CONFIG_DRIVER_AT91EMAC
1407 Support for AT91RM9200 EMAC.
1408
1409 CONFIG_RMII
1410 Define this to use reduced MII inteface
1411
1412 CONFIG_DRIVER_AT91EMAC_QUIET
1413 If this defined, the driver is quiet.
1414 The driver doen't show link status messages.
1415
Rob Herringc9830dc2011-12-15 11:15:49 +00001416 CONFIG_CALXEDA_XGMAC
1417 Support for the Calxeda XGMAC device
1418
Ashok93fb8722012-10-15 06:20:47 +00001419 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001420 Support for SMSC's LAN91C96 chips.
1421
1422 CONFIG_LAN91C96_BASE
1423 Define this to hold the physical address
1424 of the LAN91C96's I/O space
1425
1426 CONFIG_LAN91C96_USE_32_BIT
1427 Define this to enable 32 bit addressing
1428
Ashok93fb8722012-10-15 06:20:47 +00001429 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001430 Support for SMSC's LAN91C111 chip
1431
1432 CONFIG_SMC91111_BASE
1433 Define this to hold the physical address
1434 of the device (I/O space)
1435
1436 CONFIG_SMC_USE_32_BIT
1437 Define this if data bus is 32 bits
1438
1439 CONFIG_SMC_USE_IOFUNCS
1440 Define this to use i/o functions instead of macros
1441 (some hardware wont work with macros)
1442
Heiko Schocher7d037f72011-11-15 10:00:04 -05001443 CONFIG_DRIVER_TI_EMAC
1444 Support for davinci emac
1445
1446 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1447 Define this if you have more then 3 PHYs.
1448
Macpaul Lin199c6252010-12-21 16:59:46 +08001449 CONFIG_FTGMAC100
1450 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1451
1452 CONFIG_FTGMAC100_EGIGA
1453 Define this to use GE link update with gigabit PHY.
1454 Define this if FTGMAC100 is connected to gigabit PHY.
1455 If your system has 10/100 PHY only, it might not occur
1456 wrong behavior. Because PHY usually return timeout or
1457 useless data when polling gigabit status and gigabit
1458 control registers. This behavior won't affect the
1459 correctnessof 10/100 link speed update.
1460
Mike Rapoportf4761af2009-11-11 10:03:03 +02001461 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001462 Support for SMSC's LAN911x and LAN921x chips
1463
Mike Rapoportf4761af2009-11-11 10:03:03 +02001464 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001465 Define this to hold the physical address
1466 of the device (I/O space)
1467
Mike Rapoportf4761af2009-11-11 10:03:03 +02001468 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001469 Define this if data bus is 32 bits
1470
Mike Rapoportf4761af2009-11-11 10:03:03 +02001471 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001472 Define this if data bus is 16 bits. If your processor
1473 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001474 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001475
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001476 CONFIG_SH_ETHER
1477 Support for Renesas on-chip Ethernet controller
1478
1479 CONFIG_SH_ETHER_USE_PORT
1480 Define the number of ports to be used
1481
1482 CONFIG_SH_ETHER_PHY_ADDR
1483 Define the ETH PHY's address
1484
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001485 CONFIG_SH_ETHER_CACHE_WRITEBACK
1486 If this option is set, the driver enables cache flush.
1487
Heiko Schocher2b387762014-07-18 06:07:19 +02001488- PWM Support:
1489 CONFIG_PWM_IMX
1490 Support for PWM modul on the imx6.
1491
Vadim Bendeburydac69642011-10-17 08:36:14 +00001492- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001493 CONFIG_TPM
1494 Support TPM devices.
1495
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001496 CONFIG_TPM_TIS_I2C
1497 Support for i2c bus TPM devices. Only one device
1498 per system is supported at this time.
1499
1500 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1501 Define the the i2c bus number for the TPM device
1502
1503 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1504 Define the TPM's address on the i2c bus
1505
1506 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1507 Define the burst count bytes upper limit
1508
Dirk Eibach20489092013-06-26 15:55:15 +02001509 CONFIG_TPM_ATMEL_TWI
1510 Support for Atmel TWI TPM device. Requires I2C support.
1511
Che-liang Chiouacea5702013-04-12 11:04:34 +00001512 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001513 Support for generic parallel port TPM devices. Only one device
1514 per system is supported at this time.
1515
1516 CONFIG_TPM_TIS_BASE_ADDRESS
1517 Base address where the generic TPM device is mapped
1518 to. Contemporary x86 systems usually map it at
1519 0xfed40000.
1520
Reinhard Pfau4fece432013-06-26 15:55:13 +02001521 CONFIG_CMD_TPM
1522 Add tpm monitor functions.
1523 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1524 provides monitor access to authorized functions.
1525
1526 CONFIG_TPM
1527 Define this to enable the TPM support library which provides
1528 functional interfaces to some TPM commands.
1529 Requires support for a TPM device.
1530
1531 CONFIG_TPM_AUTH_SESSIONS
1532 Define this to enable authorized functions in the TPM library.
1533 Requires CONFIG_TPM and CONFIG_SHA1.
1534
wdenkc6097192002-11-03 00:24:07 +00001535- USB Support:
1536 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001537 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001538 CONFIG_USB_UHCI to enable it.
1539 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001540 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001541 storage devices.
1542 Note:
1543 Supported are USB Keyboards and USB Floppy drives
1544 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001545 MPC5200 USB requires additional defines:
1546 CONFIG_USB_CLOCK
1547 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001548 CONFIG_PSC3_USB
1549 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001550 CONFIG_USB_CONFIG
1551 for differential drivers: 0x00001000
1552 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001553 for differential drivers on PSC3: 0x00000100
1554 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001555 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001556 May be defined to allow interrupt polling
1557 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001558
Simon Glass5978cdb2012-02-27 10:52:47 +00001559 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1560 txfilltuning field in the EHCI controller on reset.
1561
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001562 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1563 HW module registers.
1564
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001565- USB Device:
1566 Define the below if you wish to use the USB console.
1567 Once firmware is rebuilt from a serial console issue the
1568 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001569 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001570 it has found a new device. The environment variable usbtty
1571 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001572 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001573 Common Device Class Abstract Control Model serial device.
1574 If you select usbtty = gserial you should be able to enumerate
1575 a Linux host by
1576 # modprobe usbserial vendor=0xVendorID product=0xProductID
1577 else if using cdc_acm, simply setting the environment
1578 variable usbtty to be cdc_acm should suffice. The following
1579 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001580
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001581 CONFIG_USB_DEVICE
1582 Define this to build a UDC device
1583
1584 CONFIG_USB_TTY
1585 Define this to have a tty type of device available to
1586 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001587
Vipin KUMARbdb17702012-03-26 15:38:06 +05301588 CONFIG_USBD_HS
1589 Define this to enable the high speed support for usb
1590 device and usbtty. If this feature is enabled, a routine
1591 int is_usbd_high_speed(void)
1592 also needs to be defined by the driver to dynamically poll
1593 whether the enumeration has succeded at high speed or full
1594 speed.
1595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001596 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001597 Define this if you want stdin, stdout &/or stderr to
1598 be set to usbtty.
1599
1600 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001601 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001602 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001603 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001605 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001606 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001607 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001608
Wolfgang Denke2601822006-06-14 18:14:56 +02001609 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001610 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001611 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001612 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1613 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1614 should pretend to be a Linux device to it's target host.
1615
1616 CONFIG_USBD_MANUFACTURER
1617 Define this string as the name of your company for
1618 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001619
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001620 CONFIG_USBD_PRODUCT_NAME
1621 Define this string as the name of your product
1622 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001623
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001624 CONFIG_USBD_VENDORID
1625 Define this as your assigned Vendor ID from the USB
1626 Implementors Forum. This *must* be a genuine Vendor ID
1627 to avoid polluting the USB namespace.
1628 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001629
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001630 CONFIG_USBD_PRODUCTID
1631 Define this as the unique Product ID
1632 for your device
1633 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001634
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001635- ULPI Layer Support:
1636 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1637 the generic ULPI layer. The generic layer accesses the ULPI PHY
1638 via the platform viewport, so you need both the genric layer and
1639 the viewport enabled. Currently only Chipidea/ARC based
1640 viewport is supported.
1641 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1642 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001643 If your ULPI phy needs a different reference clock than the
1644 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1645 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001646
wdenk7a428cc2003-06-15 22:40:42 +00001647- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001648 The MMC controller on the Intel PXA is supported. To
1649 enable this define CONFIG_MMC. The MMC can be
1650 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001651 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001652 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1653 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001654
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001655 CONFIG_SH_MMCIF
1656 Support for Renesas on-chip MMCIF controller
1657
1658 CONFIG_SH_MMCIF_ADDR
1659 Define the base address of MMCIF registers
1660
1661 CONFIG_SH_MMCIF_CLK
1662 Define the clock frequency for MMCIF
1663
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001664 CONFIG_GENERIC_MMC
1665 Enable the generic MMC driver
1666
1667 CONFIG_SUPPORT_EMMC_BOOT
1668 Enable some additional features of the eMMC boot partitions.
1669
1670 CONFIG_SUPPORT_EMMC_RPMB
1671 Enable the commands for reading, writing and programming the
1672 key for the Replay Protection Memory Block partition in eMMC.
1673
Tom Rini58a8d322013-03-14 05:32:47 +00001674- USB Device Firmware Update (DFU) class support:
1675 CONFIG_DFU_FUNCTION
1676 This enables the USB portion of the DFU USB class
1677
1678 CONFIG_CMD_DFU
1679 This enables the command "dfu" which is used to have
1680 U-Boot create a DFU class device via USB. This command
1681 requires that the "dfu_alt_info" environment variable be
1682 set and define the alt settings to expose to the host.
1683
1684 CONFIG_DFU_MMC
1685 This enables support for exposing (e)MMC devices via DFU.
1686
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001687 CONFIG_DFU_NAND
1688 This enables support for exposing NAND devices via DFU.
1689
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301690 CONFIG_DFU_RAM
1691 This enables support for exposing RAM via DFU.
1692 Note: DFU spec refer to non-volatile memory usage, but
1693 allow usages beyond the scope of spec - here RAM usage,
1694 one that would help mostly the developer.
1695
Heiko Schochera2f831e2013-06-12 06:05:51 +02001696 CONFIG_SYS_DFU_DATA_BUF_SIZE
1697 Dfu transfer uses a buffer before writing data to the
1698 raw storage device. Make the size (in bytes) of this buffer
1699 configurable. The size of this buffer is also configurable
1700 through the "dfu_bufsiz" environment variable.
1701
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001702 CONFIG_SYS_DFU_MAX_FILE_SIZE
1703 When updating files rather than the raw storage device,
1704 we use a static buffer to copy the file into and then write
1705 the buffer once we've been given the whole file. Define
1706 this to the maximum filesize (in bytes) for the buffer.
1707 Default is 4 MiB if undefined.
1708
Heiko Schochere1ba1512014-03-18 08:09:56 +01001709 DFU_DEFAULT_POLL_TIMEOUT
1710 Poll timeout [ms], is the timeout a device can send to the
1711 host. The host must wait for this timeout before sending
1712 a subsequent DFU_GET_STATUS request to the device.
1713
1714 DFU_MANIFEST_POLL_TIMEOUT
1715 Poll timeout [ms], which the device sends to the host when
1716 entering dfuMANIFEST state. Host waits this timeout, before
1717 sending again an USB request to the device.
1718
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001719- USB Device Android Fastboot support:
1720 CONFIG_CMD_FASTBOOT
1721 This enables the command "fastboot" which enables the Android
1722 fastboot mode for the platform's USB device. Fastboot is a USB
1723 protocol for downloading images, flashing and device control
1724 used on Android devices.
1725 See doc/README.android-fastboot for more information.
1726
1727 CONFIG_ANDROID_BOOT_IMAGE
1728 This enables support for booting images which use the Android
1729 image format header.
1730
1731 CONFIG_USB_FASTBOOT_BUF_ADDR
1732 The fastboot protocol requires a large memory buffer for
1733 downloads. Define this to the starting RAM address to use for
1734 downloaded images.
1735
1736 CONFIG_USB_FASTBOOT_BUF_SIZE
1737 The fastboot protocol requires a large memory buffer for
1738 downloads. This buffer should be as large as possible for a
1739 platform. Define this to the size available RAM for fastboot.
1740
Steve Raebfb9ba42014-08-26 11:47:28 -07001741 CONFIG_FASTBOOT_FLASH
1742 The fastboot protocol includes a "flash" command for writing
1743 the downloaded image to a non-volatile storage device. Define
1744 this to enable the "fastboot flash" command.
1745
1746 CONFIG_FASTBOOT_FLASH_MMC_DEV
1747 The fastboot "flash" command requires additional information
1748 regarding the non-volatile storage device. Define this to
1749 the eMMC device that fastboot should use to store the image.
1750
Steve Rae7d059342014-12-12 15:51:54 -08001751 CONFIG_FASTBOOT_GPT_NAME
1752 The fastboot "flash" command supports writing the downloaded
1753 image to the Protective MBR and the Primary GUID Partition
1754 Table. (Additionally, this downloaded image is post-processed
1755 to generate and write the Backup GUID Partition Table.)
1756 This occurs when the specified "partition name" on the
1757 "fastboot flash" command line matches this value.
1758 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1759
wdenkda04a8b2004-08-02 23:22:59 +00001760- Journaling Flash filesystem support:
1761 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1762 CONFIG_JFFS2_NAND_DEV
1763 Define these for a default partition on a NAND device
1764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001765 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1766 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001767 Define these for a default partition on a NOR device
1768
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001769 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001770 Define this to create an own partition. You have to provide a
1771 function struct part_info* jffs2_part_info(int part_num)
1772
1773 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001774 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001775 to disable the command chpart. This is the default when you
1776 have not defined a custom partition
1777
Donggeun Kim8f814002011-10-24 21:15:28 +00001778- FAT(File Allocation Table) filesystem write function support:
1779 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001780
1781 Define this to enable support for saving memory data as a
1782 file in FAT formatted partition.
1783
1784 This will also enable the command "fatwrite" enabling the
1785 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001786
Gabe Black7f8574c2012-10-12 14:26:11 +00001787CBFS (Coreboot Filesystem) support
1788 CONFIG_CMD_CBFS
1789
1790 Define this to enable support for reading from a Coreboot
1791 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1792 and cbfsload.
1793
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301794- FAT(File Allocation Table) filesystem cluster size:
1795 CONFIG_FS_FAT_MAX_CLUSTSIZE
1796
1797 Define the max cluster size for fat operations else
1798 a default value of 65536 will be defined.
1799
wdenkc6097192002-11-03 00:24:07 +00001800- Keyboard Support:
1801 CONFIG_ISA_KEYBOARD
1802
1803 Define this to enable standard (PC-Style) keyboard
1804 support
1805
1806 CONFIG_I8042_KBD
1807 Standard PC keyboard driver with US (is default) and
1808 GERMAN key layout (switch via environment 'keymap=de') support.
1809 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1810 for cfb_console. Supports cursor blinking.
1811
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001812 CONFIG_CROS_EC_KEYB
1813 Enables a Chrome OS keyboard using the CROS_EC interface.
1814 This uses CROS_EC to communicate with a second microcontroller
1815 which provides key scans on request.
1816
wdenkc6097192002-11-03 00:24:07 +00001817- Video support:
1818 CONFIG_VIDEO
1819
1820 Define this to enable video support (for output to
1821 video).
1822
1823 CONFIG_VIDEO_CT69000
1824
1825 Enable Chips & Technologies 69000 Video chip
1826
1827 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001828 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001829 video output is selected via environment 'videoout'
1830 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1831 assumed.
wdenkc6097192002-11-03 00:24:07 +00001832
wdenkd3602132004-03-25 15:14:43 +00001833 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001834 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001835 are possible:
1836 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001837 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001838
1839 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1840 -------------+---------------------------------------------
1841 8 bits | 0x301* 0x303 0x305 0x161 0x307
1842 15 bits | 0x310 0x313 0x316 0x162 0x319
1843 16 bits | 0x311 0x314 0x317 0x163 0x31A
1844 24 bits | 0x312 0x315 0x318 ? 0x31B
1845 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001846 (i.e. setenv videomode 317; saveenv; reset;)
1847
wdenkd3602132004-03-25 15:14:43 +00001848 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001849 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001850
1851
stroeseb9c17c52003-04-04 15:53:41 +00001852 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001853 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001854 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1855 or CONFIG_VIDEO_SED13806_16BPP
1856
Timur Tabi020edd22011-02-15 17:09:19 -06001857 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001858 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001859 SOCs that have a DIU should define this macro to enable DIU
1860 support, and should also define these other macros:
1861
1862 CONFIG_SYS_DIU_ADDR
1863 CONFIG_VIDEO
1864 CONFIG_CMD_BMP
1865 CONFIG_CFB_CONSOLE
1866 CONFIG_VIDEO_SW_CURSOR
1867 CONFIG_VGA_AS_SINGLE_DEVICE
1868 CONFIG_VIDEO_LOGO
1869 CONFIG_VIDEO_BMP_LOGO
1870
Timur Tabi32f709e2011-04-11 14:18:22 -05001871 The DIU driver will look for the 'video-mode' environment
1872 variable, and if defined, enable the DIU as a console during
1873 boot. See the documentation file README.video for a
1874 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001875
Simon Glass54df8ce2012-12-03 13:59:47 +00001876 CONFIG_VIDEO_VGA
1877
1878 Enable the VGA video / BIOS for x86. The alternative if you
1879 are using coreboot is to use the coreboot frame buffer
1880 driver.
1881
1882
wdenk4e112c12003-06-03 23:54:09 +00001883- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001884 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001885
wdenk57b2d802003-06-27 21:31:46 +00001886 Define this to enable a custom keyboard support.
1887 This simply calls drv_keyboard_init() which must be
1888 defined in your board-specific files.
1889 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001890
wdenkc6097192002-11-03 00:24:07 +00001891- LCD Support: CONFIG_LCD
1892
1893 Define this to enable LCD support (for output to LCD
1894 display); also select one of the supported displays
1895 by defining one of these:
1896
Stelian Popf6f86652008-05-09 21:57:18 +02001897 CONFIG_ATMEL_LCD:
1898
1899 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1900
wdenkc0d54ae2003-11-25 16:55:19 +00001901 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001902
wdenkc0d54ae2003-11-25 16:55:19 +00001903 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001904
wdenkc0d54ae2003-11-25 16:55:19 +00001905 CONFIG_NEC_NL6448BC20
1906
1907 NEC NL6448BC20-08. 6.5", 640x480.
1908 Active, color, single scan.
1909
1910 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001911
wdenkc0d54ae2003-11-25 16:55:19 +00001912 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001913 Active, color, single scan.
1914
1915 CONFIG_SHARP_16x9
1916
1917 Sharp 320x240. Active, color, single scan.
1918 It isn't 16x9, and I am not sure what it is.
1919
1920 CONFIG_SHARP_LQ64D341
1921
1922 Sharp LQ64D341 display, 640x480.
1923 Active, color, single scan.
1924
1925 CONFIG_HLD1045
1926
1927 HLD1045 display, 640x480.
1928 Active, color, single scan.
1929
1930 CONFIG_OPTREX_BW
1931
1932 Optrex CBL50840-2 NF-FW 99 22 M5
1933 or
1934 Hitachi LMG6912RPFC-00T
1935 or
1936 Hitachi SP14Q002
1937
1938 320x240. Black & white.
1939
1940 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001941 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001942
Simon Glass599a4df2012-10-17 13:24:54 +00001943 CONFIG_LCD_ALIGNMENT
1944
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001945 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001946 defined then the LCD will be aligned to this value instead.
1947 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1948 here, since it is cheaper to change data cache settings on
1949 a per-section basis.
1950
Simon Glassaf3e2802012-10-17 13:24:59 +00001951 CONFIG_CONSOLE_SCROLL_LINES
1952
1953 When the console need to be scrolled, this is the number of
1954 lines to scroll by. It defaults to 1. Increasing this makes
1955 the console jump but can help speed up operation when scrolling
1956 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001957
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001958 CONFIG_LCD_ROTATION
1959
1960 Sometimes, for example if the display is mounted in portrait
1961 mode or even if it's mounted landscape but rotated by 180degree,
1962 we need to rotate our content of the display relative to the
1963 framebuffer, so that user can read the messages which are
1964 printed out.
1965 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1966 initialized with a given rotation from "vl_rot" out of
1967 "vidinfo_t" which is provided by the board specific code.
1968 The value for vl_rot is coded as following (matching to
1969 fbcon=rotate:<n> linux-kernel commandline):
1970 0 = no rotation respectively 0 degree
1971 1 = 90 degree rotation
1972 2 = 180 degree rotation
1973 3 = 270 degree rotation
1974
1975 If CONFIG_LCD_ROTATION is not defined, the console will be
1976 initialized with 0degree rotation.
1977
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001978 CONFIG_LCD_BMP_RLE8
1979
1980 Support drawing of RLE8-compressed bitmaps on the LCD.
1981
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001982 CONFIG_I2C_EDID
1983
1984 Enables an 'i2c edid' command which can read EDID
1985 information over I2C from an attached LCD display.
1986
wdenkeb20ad32003-09-05 23:19:14 +00001987- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001988
wdenk57b2d802003-06-27 21:31:46 +00001989 If this option is set, the environment is checked for
1990 a variable "splashimage". If found, the usual display
1991 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001992 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001993 specified in "splashimage" is loaded instead. The
1994 console is redirected to the "nulldev", too. This
1995 allows for a "silent" boot where a splash screen is
1996 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001997
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001998 CONFIG_SPLASHIMAGE_GUARD
1999
2000 If this option is set, then U-Boot will prevent the environment
2001 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05002002 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002003 This option is useful for targets where, due to alignment
2004 restrictions, an improperly aligned BMP image will cause a data
2005 abort. If you think you will not have problems with unaligned
2006 accesses (for example because your toolchain prevents them)
2007 there is no need to set this option.
2008
Matthias Weisser53884182009-07-09 16:07:30 +02002009 CONFIG_SPLASH_SCREEN_ALIGN
2010
2011 If this option is set the splash image can be freely positioned
2012 on the screen. Environment variable "splashpos" specifies the
2013 position as "x,y". If a positive number is given it is used as
2014 number of pixel from left/top. If a negative number is given it
2015 is used as number of pixel from right/bottom. You can also
2016 specify 'm' for centering the image.
2017
2018 Example:
2019 setenv splashpos m,m
2020 => image at center of screen
2021
2022 setenv splashpos 30,20
2023 => image at x = 30 and y = 20
2024
2025 setenv splashpos -10,m
2026 => vertically centered image
2027 at x = dspWidth - bmpWidth - 9
2028
Stefan Roesed9d97742005-09-22 09:04:17 +02002029- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2030
2031 If this option is set, additionally to standard BMP
2032 images, gzipped BMP images can be displayed via the
2033 splashscreen support or the bmp command.
2034
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002035- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2036
2037 If this option is set, 8-bit RLE compressed BMP images
2038 can be displayed via the splashscreen support or the
2039 bmp command.
2040
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002041- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002042 CONFIG_CMD_ZIP
2043
2044 If this option is set, it would use zlib deflate method
2045 to compress the specified memory at its best effort.
2046
wdenk710e3502003-08-29 20:57:53 +00002047- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002048 CONFIG_GZIP
2049
2050 Enabled by default to support gzip compressed images.
2051
wdenk710e3502003-08-29 20:57:53 +00002052 CONFIG_BZIP2
2053
2054 If this option is set, support for bzip2 compressed
2055 images is included. If not, only uncompressed and gzip
2056 compressed images are supported.
2057
wdenk9c53f402003-10-15 23:53:47 +00002058 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002059 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002060 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002061
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002062 CONFIG_LZMA
2063
2064 If this option is set, support for lzma compressed
2065 images is included.
2066
2067 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2068 requires an amount of dynamic memory that is given by the
2069 formula:
2070
2071 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2072
2073 Where lc and lp stand for, respectively, Literal context bits
2074 and Literal pos bits.
2075
2076 This value is upper-bounded by 14MB in the worst case. Anyway,
2077 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2078 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2079 a very small buffer.
2080
2081 Use the lzmainfo tool to determinate the lc and lp values and
2082 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002083 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002084
Kees Cook5b06e642013-08-16 07:59:12 -07002085 CONFIG_LZO
2086
2087 If this option is set, support for LZO compressed images
2088 is included.
2089
wdenk0e2bd9c2004-06-06 21:51:03 +00002090- MII/PHY support:
2091 CONFIG_PHY_ADDR
2092
2093 The address of PHY on MII bus.
2094
2095 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2096
2097 The clock frequency of the MII bus
2098
2099 CONFIG_PHY_GIGE
2100
2101 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002102 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002103
2104 CONFIG_PHY_RESET_DELAY
2105
2106 Some PHY like Intel LXT971A need extra delay after
2107 reset before any MII register access is possible.
2108 For such PHY, set this option to the usec delay
2109 required. (minimum 300usec for LXT971A)
2110
2111 CONFIG_PHY_CMD_DELAY (ppc4xx)
2112
2113 Some PHY like Intel LXT971A need extra delay after
2114 command issued before MII status register can be read
2115
wdenkc6097192002-11-03 00:24:07 +00002116- Ethernet address:
2117 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002118 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002119 CONFIG_ETH2ADDR
2120 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002121 CONFIG_ETH4ADDR
2122 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002123
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002124 Define a default value for Ethernet address to use
2125 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002126 is not determined automatically.
2127
2128- IP address:
2129 CONFIG_IPADDR
2130
2131 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002132 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002133 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002134 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002135
2136- Server IP address:
2137 CONFIG_SERVERIP
2138
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002139 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002140 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002141 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002142
Robin Getz470a6d42009-07-21 12:15:28 -04002143 CONFIG_KEEP_SERVERADDR
2144
2145 Keeps the server's MAC address, in the env 'serveraddr'
2146 for passing to bootargs (like Linux's netconsole option)
2147
Wolfgang Denk26da2992011-10-26 10:21:22 +00002148- Gateway IP address:
2149 CONFIG_GATEWAYIP
2150
2151 Defines a default value for the IP address of the
2152 default router where packets to other networks are
2153 sent to.
2154 (Environment variable "gatewayip")
2155
2156- Subnet mask:
2157 CONFIG_NETMASK
2158
2159 Defines a default value for the subnet mask (or
2160 routing prefix) which is used to determine if an IP
2161 address belongs to the local subnet or needs to be
2162 forwarded through a router.
2163 (Environment variable "netmask")
2164
David Updegraff7280da72007-06-11 10:41:07 -05002165- Multicast TFTP Mode:
2166 CONFIG_MCAST_TFTP
2167
2168 Defines whether you want to support multicast TFTP as per
2169 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002170 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002171 driver in use must provide a function: mcast() to join/leave a
2172 multicast group.
2173
wdenkc6097192002-11-03 00:24:07 +00002174- BOOTP Recovery Mode:
2175 CONFIG_BOOTP_RANDOM_DELAY
2176
2177 If you have many targets in a network that try to
2178 boot using BOOTP, you may want to avoid that all
2179 systems send out BOOTP requests at precisely the same
2180 moment (which would happen for instance at recovery
2181 from a power failure, when all systems will try to
2182 boot, thus flooding the BOOTP server. Defining
2183 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2184 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002185 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002186
2187 1st BOOTP request: delay 0 ... 1 sec
2188 2nd BOOTP request: delay 0 ... 2 sec
2189 3rd BOOTP request: delay 0 ... 4 sec
2190 4th and following
2191 BOOTP requests: delay 0 ... 8 sec
2192
Thierry Reding8977cda2014-08-19 10:21:24 +02002193 CONFIG_BOOTP_ID_CACHE_SIZE
2194
2195 BOOTP packets are uniquely identified using a 32-bit ID. The
2196 server will copy the ID from client requests to responses and
2197 U-Boot will use this to determine if it is the destination of
2198 an incoming response. Some servers will check that addresses
2199 aren't in use before handing them out (usually using an ARP
2200 ping) and therefore take up to a few hundred milliseconds to
2201 respond. Network congestion may also influence the time it
2202 takes for a response to make it back to the client. If that
2203 time is too long, U-Boot will retransmit requests. In order
2204 to allow earlier responses to still be accepted after these
2205 retransmissions, U-Boot's BOOTP client keeps a small cache of
2206 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2207 cache. The default is to keep IDs for up to four outstanding
2208 requests. Increasing this will allow U-Boot to accept offers
2209 from a BOOTP client in networks with unusually high latency.
2210
stroesee0aadfb2003-08-28 14:17:32 +00002211- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002212 You can fine tune the DHCP functionality by defining
2213 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002214
Jon Loeliger5336a762007-07-09 22:08:34 -05002215 CONFIG_BOOTP_SUBNETMASK
2216 CONFIG_BOOTP_GATEWAY
2217 CONFIG_BOOTP_HOSTNAME
2218 CONFIG_BOOTP_NISDOMAIN
2219 CONFIG_BOOTP_BOOTPATH
2220 CONFIG_BOOTP_BOOTFILESIZE
2221 CONFIG_BOOTP_DNS
2222 CONFIG_BOOTP_DNS2
2223 CONFIG_BOOTP_SEND_HOSTNAME
2224 CONFIG_BOOTP_NTPSERVER
2225 CONFIG_BOOTP_TIMEOFFSET
2226 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002227 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002228
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002229 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2230 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002231
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002232 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2233 after the configured retry count, the call will fail
2234 instead of starting over. This can be used to fail over
2235 to Link-local IP address configuration if the DHCP server
2236 is not available.
2237
stroesee0aadfb2003-08-28 14:17:32 +00002238 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2239 serverip from a DHCP server, it is possible that more
2240 than one DNS serverip is offered to the client.
2241 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2242 serverip will be stored in the additional environment
2243 variable "dnsip2". The first DNS serverip is always
2244 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002245 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002246
2247 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2248 to do a dynamic update of a DNS server. To do this, they
2249 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002250 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002251 of the "hostname" environment variable is passed as
2252 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002253
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002254 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2255
2256 A 32bit value in microseconds for a delay between
2257 receiving a "DHCP Offer" and sending the "DHCP Request".
2258 This fixes a problem with certain DHCP servers that don't
2259 respond 100% of the time to a "DHCP request". E.g. On an
2260 AT91RM9200 processor running at 180MHz, this delay needed
2261 to be *at least* 15,000 usec before a Windows Server 2003
2262 DHCP server would reply 100% of the time. I recommend at
2263 least 50,000 usec to be safe. The alternative is to hope
2264 that one of the retries will be successful but note that
2265 the DHCP timeout and retry process takes a longer than
2266 this delay.
2267
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002268 - Link-local IP address negotiation:
2269 Negotiate with other link-local clients on the local network
2270 for an address that doesn't require explicit configuration.
2271 This is especially useful if a DHCP server cannot be guaranteed
2272 to exist in all environments that the device must operate.
2273
2274 See doc/README.link-local for more information.
2275
wdenk145d2c12004-04-15 21:48:45 +00002276 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002277 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002278
2279 The device id used in CDP trigger frames.
2280
2281 CONFIG_CDP_DEVICE_ID_PREFIX
2282
2283 A two character string which is prefixed to the MAC address
2284 of the device.
2285
2286 CONFIG_CDP_PORT_ID
2287
2288 A printf format string which contains the ascii name of
2289 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002290 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002291
2292 CONFIG_CDP_CAPABILITIES
2293
2294 A 32bit integer which indicates the device capabilities;
2295 0x00000010 for a normal host which does not forwards.
2296
2297 CONFIG_CDP_VERSION
2298
2299 An ascii string containing the version of the software.
2300
2301 CONFIG_CDP_PLATFORM
2302
2303 An ascii string containing the name of the platform.
2304
2305 CONFIG_CDP_TRIGGER
2306
2307 A 32bit integer sent on the trigger.
2308
2309 CONFIG_CDP_POWER_CONSUMPTION
2310
2311 A 16bit integer containing the power consumption of the
2312 device in .1 of milliwatts.
2313
2314 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2315
2316 A byte containing the id of the VLAN.
2317
wdenkc6097192002-11-03 00:24:07 +00002318- Status LED: CONFIG_STATUS_LED
2319
2320 Several configurations allow to display the current
2321 status using a LED. For instance, the LED will blink
2322 fast while running U-Boot code, stop blinking as
2323 soon as a reply to a BOOTP request was received, and
2324 start blinking slow once the Linux kernel is running
2325 (supported by a status LED driver in the Linux
2326 kernel). Defining CONFIG_STATUS_LED enables this
2327 feature in U-Boot.
2328
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002329 Additional options:
2330
2331 CONFIG_GPIO_LED
2332 The status LED can be connected to a GPIO pin.
2333 In such cases, the gpio_led driver can be used as a
2334 status LED backend implementation. Define CONFIG_GPIO_LED
2335 to include the gpio_led driver in the U-Boot binary.
2336
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002337 CONFIG_GPIO_LED_INVERTED_TABLE
2338 Some GPIO connected LEDs may have inverted polarity in which
2339 case the GPIO high value corresponds to LED off state and
2340 GPIO low value corresponds to LED on state.
2341 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2342 with a list of GPIO LEDs that have inverted polarity.
2343
wdenkc6097192002-11-03 00:24:07 +00002344- CAN Support: CONFIG_CAN_DRIVER
2345
2346 Defining CONFIG_CAN_DRIVER enables CAN driver support
2347 on those systems that support this (optional)
2348 feature, like the TQM8xxL modules.
2349
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002350- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002351
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002352 This enable the NEW i2c subsystem, and will allow you to use
2353 i2c commands at the u-boot command line (as long as you set
2354 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2355 based realtime clock chips or other i2c devices. See
2356 common/cmd_i2c.c for a description of the command line
2357 interface.
2358
2359 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002360 - drivers/i2c/soft_i2c.c:
2361 - activate first bus with CONFIG_SYS_I2C_SOFT define
2362 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2363 for defining speed and slave address
2364 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2365 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2366 for defining speed and slave address
2367 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2368 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2369 for defining speed and slave address
2370 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2371 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2372 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002373
Heiko Schocherf2850742012-10-24 13:48:22 +02002374 - drivers/i2c/fsl_i2c.c:
2375 - activate i2c driver with CONFIG_SYS_I2C_FSL
2376 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2377 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2378 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2379 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002380 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002381 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2382 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2383 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2384 second bus.
2385
Simon Glass026fefb2012-10-30 07:28:53 +00002386 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002387 - activate this driver with CONFIG_SYS_I2C_TEGRA
2388 - This driver adds 4 i2c buses with a fix speed from
2389 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002390
Dirk Eibach42b204f2013-04-25 02:40:01 +00002391 - drivers/i2c/ppc4xx_i2c.c
2392 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2393 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2394 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2395
trema49f40a2013-09-21 18:13:35 +02002396 - drivers/i2c/i2c_mxc.c
2397 - activate this driver with CONFIG_SYS_I2C_MXC
2398 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2399 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2400 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2401 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2402 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2403 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002404 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002405 for speed, and 0 for slave.
York Sunf1a52162015-03-20 10:20:40 -07002406 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2407 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002408
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002409 - drivers/i2c/rcar_i2c.c:
2410 - activate this driver with CONFIG_SYS_I2C_RCAR
2411 - This driver adds 4 i2c buses
2412
2413 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2414 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2415 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2416 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2417 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2418 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2419 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2420 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2421 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2422
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002423 - drivers/i2c/sh_i2c.c:
2424 - activate this driver with CONFIG_SYS_I2C_SH
2425 - This driver adds from 2 to 5 i2c buses
2426
2427 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2428 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2429 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2430 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2431 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2432 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2433 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2434 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2435 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2436 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2437 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2438 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002439 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002440
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002441 - drivers/i2c/omap24xx_i2c.c
2442 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2443 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2445 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2446 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2447 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2448 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2449 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2450 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2451 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2452 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2453
Heiko Schocher465819a2013-11-08 07:30:53 +01002454 - drivers/i2c/zynq_i2c.c
2455 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2456 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2457 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2458
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302459 - drivers/i2c/s3c24x0_i2c.c:
2460 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2461 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2462 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2463 with a fix speed from 100000 and the slave addr 0!
2464
Dirk Eibachb9577432014-07-03 09:28:18 +02002465 - drivers/i2c/ihs_i2c.c
2466 - activate this driver with CONFIG_SYS_I2C_IHS
2467 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2468 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2469 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2470 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2471 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2472 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2473 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2474 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2475 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2476 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2477 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2478 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2479
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002480 additional defines:
2481
2482 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002483 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002484 don't use/have i2c muxes on your i2c bus, this
2485 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2486 omit this define.
2487
2488 CONFIG_SYS_I2C_DIRECT_BUS
2489 define this, if you don't use i2c muxes on your hardware.
2490 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2491 omit this define.
2492
2493 CONFIG_SYS_I2C_MAX_HOPS
2494 define how many muxes are maximal consecutively connected
2495 on one i2c bus. If you not use i2c muxes, omit this
2496 define.
2497
2498 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002499 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002500 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2501 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2502 CONFIG_SYS_NUM_I2C_BUSES = 9:
2503
2504 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2505 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2506 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2507 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2508 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2509 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2510 {1, {I2C_NULL_HOP}}, \
2511 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2512 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2513 }
2514
2515 which defines
2516 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002517 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2518 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2519 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2520 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2521 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002522 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002523 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2524 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002525
2526 If you do not have i2c muxes on your board, omit this define.
2527
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002528- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002529
2530 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2531 provides the following compelling advantages:
2532
2533 - more than one i2c adapter is usable
2534 - approved multibus support
2535 - better i2c mux support
2536
2537 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002538
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002539 These enable legacy I2C serial bus commands. Defining
2540 CONFIG_HARD_I2C will include the appropriate I2C driver
2541 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002542
wdenk21136db2003-07-16 21:53:01 +00002543 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002544 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002545 CONFIG_COMMANDS) and communicate with i2c based realtime
2546 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002547 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002548
Ben Warren45657152006-09-07 16:50:54 -04002549 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002550
wdenk21136db2003-07-16 21:53:01 +00002551 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002552 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002554 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002555 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002556 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002557 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002558
Peter Tysere4d1abc2010-04-12 22:28:21 -05002559 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002560 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002561 and so its address should therefore be cleared to 0 (See,
2562 eg, MPC823e User's Manual p.16-473). So, set
2563 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002564
Eric Millbrandt12990a42009-09-03 08:09:44 -05002565 CONFIG_SYS_I2C_INIT_MPC5XXX
2566
2567 When a board is reset during an i2c bus transfer
2568 chips might think that the current transfer is still
2569 in progress. Reset the slave devices by sending start
2570 commands until the slave device responds.
2571
wdenk21136db2003-07-16 21:53:01 +00002572 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002573
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002574 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002575 then the following macros need to be defined (examples are
2576 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002577
2578 I2C_INIT
2579
wdenkb9bbd242003-06-30 16:24:52 +00002580 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002581 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk544e9732004-02-06 23:19:44 +00002583 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002584
wdenkc6097192002-11-03 00:24:07 +00002585 I2C_PORT
2586
wdenk4a5c8a72003-03-06 00:02:04 +00002587 (Only for MPC8260 CPU). The I/O port to use (the code
2588 assumes both bits are on the same port). Valid values
2589 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002590
2591 I2C_ACTIVE
2592
2593 The code necessary to make the I2C data line active
2594 (driven). If the data line is open collector, this
2595 define can be null.
2596
wdenkb9bbd242003-06-30 16:24:52 +00002597 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2598
wdenkc6097192002-11-03 00:24:07 +00002599 I2C_TRISTATE
2600
2601 The code necessary to make the I2C data line tri-stated
2602 (inactive). If the data line is open collector, this
2603 define can be null.
2604
wdenkb9bbd242003-06-30 16:24:52 +00002605 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2606
wdenkc6097192002-11-03 00:24:07 +00002607 I2C_READ
2608
York Sun4a598092013-04-01 11:29:11 -07002609 Code that returns true if the I2C data line is high,
2610 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002611
wdenkb9bbd242003-06-30 16:24:52 +00002612 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2613
wdenkc6097192002-11-03 00:24:07 +00002614 I2C_SDA(bit)
2615
York Sun4a598092013-04-01 11:29:11 -07002616 If <bit> is true, sets the I2C data line high. If it
2617 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002618
wdenkb9bbd242003-06-30 16:24:52 +00002619 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002620 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002621 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002622
wdenkc6097192002-11-03 00:24:07 +00002623 I2C_SCL(bit)
2624
York Sun4a598092013-04-01 11:29:11 -07002625 If <bit> is true, sets the I2C clock line high. If it
2626 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002627
wdenkb9bbd242003-06-30 16:24:52 +00002628 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002629 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002630 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002631
wdenkc6097192002-11-03 00:24:07 +00002632 I2C_DELAY
2633
2634 This delay is invoked four times per clock cycle so this
2635 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002636 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002637 like:
2638
wdenkb9bbd242003-06-30 16:24:52 +00002639 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002640
Mike Frysingeree12d542010-07-21 13:38:02 -04002641 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2642
2643 If your arch supports the generic GPIO framework (asm/gpio.h),
2644 then you may alternatively define the two GPIOs that are to be
2645 used as SCL / SDA. Any of the previous I2C_xxx macros will
2646 have GPIO-based defaults assigned to them as appropriate.
2647
2648 You should define these to the GPIO value as given directly to
2649 the generic GPIO functions.
2650
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002651 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002652
wdenk57b2d802003-06-27 21:31:46 +00002653 When a board is reset during an i2c bus transfer
2654 chips might think that the current transfer is still
2655 in progress. On some boards it is possible to access
2656 the i2c SCLK line directly, either by using the
2657 processor pin as a GPIO or by having a second pin
2658 connected to the bus. If this option is defined a
2659 custom i2c_init_board() routine in boards/xxx/board.c
2660 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002661
Richard Retanubundf0149c2010-04-12 15:08:17 -04002662 CONFIG_SYS_I2C_BOARD_LATE_INIT
2663
2664 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2665 defined a custom i2c_board_late_init() routine in
2666 boards/xxx/board.c is run AFTER the operations in i2c_init()
2667 is completed. This callpoint can be used to unreset i2c bus
2668 using CPU i2c controller register accesses for CPUs whose i2c
2669 controller provide such a method. It is called at the end of
2670 i2c_init() to allow i2c_init operations to setup the i2c bus
2671 controller on the CPU (e.g. setting bus speed & slave address).
2672
wdenk0e2bd9c2004-06-06 21:51:03 +00002673 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2674
2675 This option enables configuration of bi_iic_fast[] flags
2676 in u-boot bd_info structure based on u-boot environment
2677 variable "i2cfast". (see also i2cfast)
2678
Ben Warren45657152006-09-07 16:50:54 -04002679 CONFIG_I2C_MULTI_BUS
2680
2681 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002682 must have a controller. At any point in time, only one bus is
2683 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002684 Note that bus numbering is zero-based.
2685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002686 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002687
2688 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002689 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002690 is set, specify a list of bus-device pairs. Otherwise, specify
2691 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002692
2693 e.g.
2694 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002695 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002696
2697 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2698
Wolfgang Denk092ae952011-10-26 10:21:21 +00002699 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002700 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002701
2702 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002704 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002705
2706 If defined, then this indicates the I2C bus number for DDR SPD.
2707 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002709 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002710
2711 If defined, then this indicates the I2C bus number for the RTC.
2712 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002714 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002715
2716 If defined, then this indicates the I2C bus number for the DTT.
2717 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002719 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002720
2721 If defined, specifies the I2C address of the DTT device.
2722 If not defined, then U-Boot uses predefined value for
2723 specified DTT device.
2724
Andrew Dyer58c41f92008-12-29 17:36:01 -06002725 CONFIG_SOFT_I2C_READ_REPEATED_START
2726
2727 defining this will force the i2c_read() function in
2728 the soft_i2c driver to perform an I2C repeated start
2729 between writing the address pointer and reading the
2730 data. If this define is omitted the default behaviour
2731 of doing a stop-start sequence will be used. Most I2C
2732 devices can use either method, but some require one or
2733 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002734
wdenkc6097192002-11-03 00:24:07 +00002735- SPI Support: CONFIG_SPI
2736
2737 Enables SPI driver (so far only tested with
2738 SPI EEPROM, also an instance works with Crystal A/D and
2739 D/As on the SACSng board)
2740
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002741 CONFIG_SH_SPI
2742
2743 Enables the driver for SPI controller on SuperH. Currently
2744 only SH7757 is supported.
2745
wdenkc6097192002-11-03 00:24:07 +00002746 CONFIG_SPI_X
2747
2748 Enables extended (16-bit) SPI EEPROM addressing.
2749 (symmetrical to CONFIG_I2C_X)
2750
2751 CONFIG_SOFT_SPI
2752
wdenk4a5c8a72003-03-06 00:02:04 +00002753 Enables a software (bit-bang) SPI driver rather than
2754 using hardware support. This is a general purpose
2755 driver that only requires three general I/O port pins
2756 (two outputs, one input) to function. If this is
2757 defined, the board configuration must define several
2758 SPI configuration items (port pins to use, etc). For
2759 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002760
Ben Warren7efe9272008-01-16 22:37:35 -05002761 CONFIG_HARD_SPI
2762
2763 Enables a hardware SPI driver for general-purpose reads
2764 and writes. As with CONFIG_SOFT_SPI, the board configuration
2765 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002766 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002767 example, see include/configs/mpc8349emds.h.
2768
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002769 CONFIG_MXC_SPI
2770
2771 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002772 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002773
Heiko Schocherb77c8882014-07-14 10:22:11 +02002774 CONFIG_SYS_SPI_MXC_WAIT
2775 Timeout for waiting until spi transfer completed.
2776 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2777
Matthias Fuchsa4400872007-12-27 17:12:34 +01002778- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002779
Matthias Fuchsa4400872007-12-27 17:12:34 +01002780 Enables FPGA subsystem.
2781
2782 CONFIG_FPGA_<vendor>
2783
2784 Enables support for specific chip vendors.
2785 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002786
Matthias Fuchsa4400872007-12-27 17:12:34 +01002787 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002788
Matthias Fuchsa4400872007-12-27 17:12:34 +01002789 Enables support for FPGA family.
2790 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2791
2792 CONFIG_FPGA_COUNT
2793
2794 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002795
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302796 CONFIG_CMD_FPGA_LOADMK
2797
2798 Enable support for fpga loadmk command
2799
Michal Simek64c70982014-05-02 13:43:39 +02002800 CONFIG_CMD_FPGA_LOADP
2801
2802 Enable support for fpga loadp command - load partial bitstream
2803
2804 CONFIG_CMD_FPGA_LOADBP
2805
2806 Enable support for fpga loadbp command - load partial bitstream
2807 (Xilinx only)
2808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002809 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk57b2d802003-06-27 21:31:46 +00002811 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002813 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk4a5c8a72003-03-06 00:02:04 +00002815 Enable checks on FPGA configuration interface busy
2816 status by the configuration function. This option
2817 will require a board or device specific function to
2818 be written.
wdenkc6097192002-11-03 00:24:07 +00002819
2820 CONFIG_FPGA_DELAY
2821
2822 If defined, a function that provides delays in the FPGA
2823 configuration driver.
2824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002826 Allow Control-C to interrupt FPGA configuration
2827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002828 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk4a5c8a72003-03-06 00:02:04 +00002830 Check for configuration errors during FPGA bitfile
2831 loading. For example, abort during Virtex II
2832 configuration if the INIT_B line goes low (which
2833 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002835 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002836
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002837 Maximum time to wait for the INIT_B line to de-assert
2838 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002839 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002840 ms.
wdenkc6097192002-11-03 00:24:07 +00002841
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002842 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002843
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002844 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002845 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002847 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002848
wdenk4a5c8a72003-03-06 00:02:04 +00002849 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002850 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002851
2852- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002853 CONFIG_BUILD_TARGET
2854
2855 Some SoCs need special image types (e.g. U-Boot binary
2856 with a special header) as build targets. By defining
2857 CONFIG_BUILD_TARGET in the SoC / board header, this
2858 special image will be automatically built upon calling
2859 make / MAKEALL.
2860
wdenkc6097192002-11-03 00:24:07 +00002861 CONFIG_IDENT_STRING
2862
wdenk4a5c8a72003-03-06 00:02:04 +00002863 If defined, this string will be added to the U-Boot
2864 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002865
2866- Vendor Parameter Protection:
2867
wdenk4a5c8a72003-03-06 00:02:04 +00002868 U-Boot considers the values of the environment
2869 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002870 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002871 are set once by the board vendor / manufacturer, and
2872 protects these variables from casual modification by
2873 the user. Once set, these variables are read-only,
2874 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002875 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002876
2877 If CONFIG_ENV_OVERWRITE is #defined in your config
2878 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002879 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002880 these parameters.
2881
2882 Alternatively, if you #define _both_ CONFIG_ETHADDR
2883 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002884 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002885 which can be changed exactly ONCE by the user. [The
2886 serial# is unaffected by this, i. e. it remains
2887 read-only.]
2888
Joe Hershberger71497d02012-12-11 22:16:31 -06002889 The same can be accomplished in a more flexible way
2890 for any variable by configuring the type of access
2891 to allow for those variables in the ".flags" variable
2892 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2893
wdenkc6097192002-11-03 00:24:07 +00002894- Protected RAM:
2895 CONFIG_PRAM
2896
2897 Define this variable to enable the reservation of
2898 "protected RAM", i. e. RAM which is not overwritten
2899 by U-Boot. Define CONFIG_PRAM to hold the number of
2900 kB you want to reserve for pRAM. You can overwrite
2901 this default value by defining an environment
2902 variable "pram" to the number of kB you want to
2903 reserve. Note that the board info structure will
2904 still show the full amount of RAM. If pRAM is
2905 reserved, a new environment variable "mem" will
2906 automatically be defined to hold the amount of
2907 remaining RAM in a form that can be passed as boot
2908 argument to Linux, for instance like that:
2909
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002910 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002911 saveenv
2912
2913 This way you can tell Linux not to use this memory,
2914 either, which results in a memory region that will
2915 not be affected by reboots.
2916
2917 *WARNING* If your board configuration uses automatic
2918 detection of the RAM size, you must make sure that
2919 this memory test is non-destructive. So far, the
2920 following board configurations are known to be
2921 "pRAM-clean":
2922
Wolfgang Denk90326762012-10-24 02:36:15 +00002923 IVMS8, IVML24, SPD8xx, TQM8xxL,
2924 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002925 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002926
Gabe Blacka2f3a932012-12-02 04:55:18 +00002927- Access to physical memory region (> 4GB)
2928 Some basic support is provided for operations on memory not
2929 normally accessible to U-Boot - e.g. some architectures
2930 support access to more than 4GB of memory on 32-bit
2931 machines using physical address extension or similar.
2932 Define CONFIG_PHYSMEM to access this basic support, which
2933 currently only supports clearing the memory.
2934
wdenkc6097192002-11-03 00:24:07 +00002935- Error Recovery:
2936 CONFIG_PANIC_HANG
2937
2938 Define this variable to stop the system in case of a
2939 fatal error, so that you have to reset it manually.
2940 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002941 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002942 automatically as fast as possible, but it may be
2943 useful during development since you can try to debug
2944 the conditions that lead to the situation.
2945
2946 CONFIG_NET_RETRY_COUNT
2947
wdenk4a5c8a72003-03-06 00:02:04 +00002948 This variable defines the number of retries for
2949 network operations like ARP, RARP, TFTP, or BOOTP
2950 before giving up the operation. If not defined, a
2951 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002952
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002953 CONFIG_ARP_TIMEOUT
2954
2955 Timeout waiting for an ARP reply in milliseconds.
2956
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002957 CONFIG_NFS_TIMEOUT
2958
2959 Timeout in milliseconds used in NFS protocol.
2960 If you encounter "ERROR: Cannot umount" in nfs command,
2961 try longer timeout such as
2962 #define CONFIG_NFS_TIMEOUT 10000UL
2963
wdenkc6097192002-11-03 00:24:07 +00002964- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002965 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002966
2967 Enable auto completion of commands using TAB.
2968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002969 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002970
2971 This defines the secondary prompt string, which is
2972 printed when the command interpreter needs more input
2973 to complete a command. Usually "> ".
2974
2975 Note:
2976
wdenk57b2d802003-06-27 21:31:46 +00002977 In the current implementation, the local variables
2978 space and global environment variables space are
2979 separated. Local variables are those you define by
2980 simply typing `name=value'. To access a local
2981 variable later on, you have write `$name' or
2982 `${name}'; to execute the contents of a variable
2983 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk4a5c8a72003-03-06 00:02:04 +00002985 Global environment variables are those you use
2986 setenv/printenv to work with. To run a command stored
2987 in such a variable, you need to use the run command,
2988 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002989
2990 To store commands and special characters in a
2991 variable, please use double quotation marks
2992 surrounding the whole text of the variable, instead
2993 of the backslashes before semicolons and special
2994 symbols.
2995
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002996- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002997 CONFIG_CMDLINE_EDITING
2998
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002999 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003000 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02003001
wdenkc0aa5c52003-12-06 19:49:23 +00003002- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003003 CONFIG_EXTRA_ENV_SETTINGS
3004
wdenk4a5c8a72003-03-06 00:02:04 +00003005 Define this to contain any number of null terminated
3006 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00003007 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00003008
wdenk4a5c8a72003-03-06 00:02:04 +00003009 For example, place something like this in your
3010 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003011
3012 #define CONFIG_EXTRA_ENV_SETTINGS \
3013 "myvar1=value1\0" \
3014 "myvar2=value2\0"
3015
wdenk4a5c8a72003-03-06 00:02:04 +00003016 Warning: This method is based on knowledge about the
3017 internal format how the environment is stored by the
3018 U-Boot code. This is NOT an official, exported
3019 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003020 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003021 You better know what you are doing here.
3022
wdenk4a5c8a72003-03-06 00:02:04 +00003023 Note: overly (ab)use of the default environment is
3024 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003025 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003026 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003027
Stephen Warren1465d5f2012-05-22 09:21:54 +00003028 CONFIG_ENV_VARS_UBOOT_CONFIG
3029
3030 Define this in order to add variables describing the
3031 U-Boot build configuration to the default environment.
3032 These will be named arch, cpu, board, vendor, and soc.
3033
3034 Enabling this option will cause the following to be defined:
3035
3036 - CONFIG_SYS_ARCH
3037 - CONFIG_SYS_CPU
3038 - CONFIG_SYS_BOARD
3039 - CONFIG_SYS_VENDOR
3040 - CONFIG_SYS_SOC
3041
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003042 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3043
3044 Define this in order to add variables describing certain
3045 run-time determined information about the hardware to the
3046 environment. These will be named board_name, board_rev.
3047
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003048 CONFIG_DELAY_ENVIRONMENT
3049
3050 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003051 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003052 that so that the environment is not available until
3053 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3054 this is instead controlled by the value of
3055 /config/load-environment.
3056
wdenkc0aa5c52003-12-06 19:49:23 +00003057- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003058 CONFIG_HAS_DATAFLASH
3059
wdenk57b2d802003-06-27 21:31:46 +00003060 Defining this option enables DataFlash features and
3061 allows to read/write in Dataflash via the standard
3062 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003063
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003064- Serial Flash support
3065 CONFIG_CMD_SF
3066
3067 Defining this option enables SPI flash commands
3068 'sf probe/read/write/erase/update'.
3069
3070 Usage requires an initial 'probe' to define the serial
3071 flash parameters, followed by read/write/erase/update
3072 commands.
3073
3074 The following defaults may be provided by the platform
3075 to handle the common case when only a single serial
3076 flash is present on the system.
3077
3078 CONFIG_SF_DEFAULT_BUS Bus identifier
3079 CONFIG_SF_DEFAULT_CS Chip-select
3080 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3081 CONFIG_SF_DEFAULT_SPEED in Hz
3082
Simon Glass4b5545e2012-10-08 13:16:02 +00003083 CONFIG_CMD_SF_TEST
3084
3085 Define this option to include a destructive SPI flash
3086 test ('sf test').
3087
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303088 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3089
3090 Define this option to use the Bank addr/Extended addr
3091 support on SPI flashes which has size > 16Mbytes.
3092
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303093 CONFIG_SF_DUAL_FLASH Dual flash memories
3094
3095 Define this option to use dual flash support where two flash
3096 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003097 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303098
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02003099 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3100 enable the W#/Vpp signal to disable writing to the status
3101 register on ST MICRON flashes like the N25Q128.
3102 The status register write enable/disable bit, combined with
3103 the W#/VPP signal provides hardware data protection for the
3104 device as follows: When the enable/disable bit is set to 1,
3105 and the W#/VPP signal is driven LOW, the status register
3106 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3107 operation will not execute. The only way to exit this
3108 hardware-protected mode is to drive W#/VPP HIGH.
3109
wdenkef893942004-02-23 16:11:30 +00003110- SystemACE Support:
3111 CONFIG_SYSTEMACE
3112
3113 Adding this option adds support for Xilinx SystemACE
3114 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003115 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003117
3118 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003119 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003120
3121 When SystemACE support is added, the "ace" device type
3122 becomes available to the fat commands, i.e. fatls.
3123
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003124- TFTP Fixed UDP Port:
3125 CONFIG_TFTP_PORT
3126
Wolfgang Denk227b5192005-09-24 23:25:46 +02003127 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003128 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003129 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003130 number generator is used.
3131
Wolfgang Denk227b5192005-09-24 23:25:46 +02003132 Also, the environment variable tftpdstp is used to supply
3133 the TFTP UDP destination port value. If tftpdstp isn't
3134 defined, the normal port 69 is used.
3135
3136 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003137 blindly start the TFTP transfer using the pre-configured
3138 target IP address and UDP port. This has the effect of
3139 "punching through" the (Windows XP) firewall, allowing
3140 the remainder of the TFTP transfer to proceed normally.
3141 A better solution is to properly configure the firewall,
3142 but sometimes that is not allowed.
3143
Simon Glass058bb8d2012-12-05 14:46:38 +00003144- Hashing support:
3145 CONFIG_CMD_HASH
3146
3147 This enables a generic 'hash' command which can produce
3148 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3149
3150 CONFIG_HASH_VERIFY
3151
3152 Enable the hash verify command (hash -v). This adds to code
3153 size a little.
3154
gaurav ranaef201592015-02-20 12:51:46 +05303155 CONFIG_SHA1 - This option enables support of hashing using SHA1
3156 algorithm. The hash is calculated in software.
3157 CONFIG_SHA256 - This option enables support of hashing using
3158 SHA256 algorithm. The hash is calculated in software.
3159 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3160 for SHA1/SHA256 hashing.
3161 This affects the 'hash' command and also the
3162 hash_lookup_algo() function.
3163 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3164 hardware-acceleration for SHA1/SHA256 progressive hashing.
3165 Data can be streamed in a block at a time and the hashing
3166 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003167
3168 Note: There is also a sha1sum command, which should perhaps
3169 be deprecated in favour of 'hash sha1'.
3170
Robert Winkler765ccf42013-07-24 17:57:06 -07003171- Freescale i.MX specific commands:
3172 CONFIG_CMD_HDMIDETECT
3173 This enables 'hdmidet' command which returns true if an
3174 HDMI monitor is detected. This command is i.MX 6 specific.
3175
3176 CONFIG_CMD_BMODE
3177 This enables the 'bmode' (bootmode) command for forcing
3178 a boot from specific media.
3179
3180 This is useful for forcing the ROM's usb downloader to
3181 activate upon a watchdog reset which is nice when iterating
3182 on U-Boot. Using the reset button or running bmode normal
3183 will set it back to normal. This command currently
3184 supports i.MX53 and i.MX6.
3185
Simon Glass35191a32013-06-13 15:10:02 -07003186- Signing support:
3187 CONFIG_RSA
3188
3189 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003190 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003191
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303192 The Modular Exponentiation algorithm in RSA is implemented using
3193 driver model. So CONFIG_DM needs to be enabled by default for this
3194 library to function.
3195
Simon Glass35191a32013-06-13 15:10:02 -07003196 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303197 option. The software based modular exponentiation is built into
3198 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003199
Heiko Schocher443ca402014-01-25 07:27:13 +01003200- bootcount support:
3201 CONFIG_BOOTCOUNT_LIMIT
3202
3203 This enables the bootcounter support, see:
3204 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3205
3206 CONFIG_AT91SAM9XE
3207 enable special bootcounter support on at91sam9xe based boards.
3208 CONFIG_BLACKFIN
3209 enable special bootcounter support on blackfin based boards.
3210 CONFIG_SOC_DA8XX
3211 enable special bootcounter support on da850 based boards.
3212 CONFIG_BOOTCOUNT_RAM
3213 enable support for the bootcounter in RAM
3214 CONFIG_BOOTCOUNT_I2C
3215 enable support for the bootcounter on an i2c (like RTC) device.
3216 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3217 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3218 the bootcounter.
3219 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003220
wdenkc0aa5c52003-12-06 19:49:23 +00003221- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003222 CONFIG_SHOW_BOOT_PROGRESS
3223
wdenk4a5c8a72003-03-06 00:02:04 +00003224 Defining this option allows to add some board-
3225 specific code (calling a user-provided function
3226 "show_boot_progress(int)") that enables you to show
3227 the system's boot progress on some display (for
3228 example, some LED's) on your board. At the moment,
3229 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003230
Simon Glass0fa36a42012-09-28 08:56:37 +00003231
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003232Legacy uImage format:
3233
wdenkc6097192002-11-03 00:24:07 +00003234 Arg Where When
3235 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003236 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003237 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003238 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003239 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003240 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003241 4 common/cmd_bootm.c Image data has correct checksum
3242 -4 common/cmd_bootm.c Image is for unsupported architecture
3243 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003244 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003245 6 common/cmd_bootm.c Image Type check OK
3246 -6 common/cmd_bootm.c gunzip uncompression error
3247 -7 common/cmd_bootm.c Unimplemented compression type
3248 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003249 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003250 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003251
3252 9 common/image.c Start initial ramdisk verification
3253 -10 common/image.c Ramdisk header has bad magic number
3254 -11 common/image.c Ramdisk header has bad checksum
3255 10 common/image.c Ramdisk header is OK
3256 -12 common/image.c Ramdisk data has bad checksum
3257 11 common/image.c Ramdisk data has correct checksum
3258 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003259 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003260 13 common/image.c Start multifile image verification
3261 14 common/image.c No initial ramdisk, no multifile, continue.
3262
Wolfgang Denk092ae952011-10-26 10:21:21 +00003263 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003264
Stefan Roese88fbf932010-04-15 16:07:28 +02003265 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003266 -31 post/post.c POST test failed, detected by post_output_backlog()
3267 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003268
Heiko Schocher633e03a2007-06-22 19:11:54 +02003269 34 common/cmd_doc.c before loading a Image from a DOC device
3270 -35 common/cmd_doc.c Bad usage of "doc" command
3271 35 common/cmd_doc.c correct usage of "doc" command
3272 -36 common/cmd_doc.c No boot device
3273 36 common/cmd_doc.c correct boot device
3274 -37 common/cmd_doc.c Unknown Chip ID on boot device
3275 37 common/cmd_doc.c correct chip ID found, device available
3276 -38 common/cmd_doc.c Read Error on boot device
3277 38 common/cmd_doc.c reading Image header from DOC device OK
3278 -39 common/cmd_doc.c Image header has bad magic number
3279 39 common/cmd_doc.c Image header has correct magic number
3280 -40 common/cmd_doc.c Error reading Image from DOC device
3281 40 common/cmd_doc.c Image header has correct magic number
3282 41 common/cmd_ide.c before loading a Image from a IDE device
3283 -42 common/cmd_ide.c Bad usage of "ide" command
3284 42 common/cmd_ide.c correct usage of "ide" command
3285 -43 common/cmd_ide.c No boot device
3286 43 common/cmd_ide.c boot device found
3287 -44 common/cmd_ide.c Device not available
3288 44 common/cmd_ide.c Device available
3289 -45 common/cmd_ide.c wrong partition selected
3290 45 common/cmd_ide.c partition selected
3291 -46 common/cmd_ide.c Unknown partition table
3292 46 common/cmd_ide.c valid partition table found
3293 -47 common/cmd_ide.c Invalid partition type
3294 47 common/cmd_ide.c correct partition type
3295 -48 common/cmd_ide.c Error reading Image Header on boot device
3296 48 common/cmd_ide.c reading Image Header from IDE device OK
3297 -49 common/cmd_ide.c Image header has bad magic number
3298 49 common/cmd_ide.c Image header has correct magic number
3299 -50 common/cmd_ide.c Image header has bad checksum
3300 50 common/cmd_ide.c Image header has correct checksum
3301 -51 common/cmd_ide.c Error reading Image from IDE device
3302 51 common/cmd_ide.c reading Image from IDE device OK
3303 52 common/cmd_nand.c before loading a Image from a NAND device
3304 -53 common/cmd_nand.c Bad usage of "nand" command
3305 53 common/cmd_nand.c correct usage of "nand" command
3306 -54 common/cmd_nand.c No boot device
3307 54 common/cmd_nand.c boot device found
3308 -55 common/cmd_nand.c Unknown Chip ID on boot device
3309 55 common/cmd_nand.c correct chip ID found, device available
3310 -56 common/cmd_nand.c Error reading Image Header on boot device
3311 56 common/cmd_nand.c reading Image Header from NAND device OK
3312 -57 common/cmd_nand.c Image header has bad magic number
3313 57 common/cmd_nand.c Image header has correct magic number
3314 -58 common/cmd_nand.c Error reading Image from NAND device
3315 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003316
Heiko Schocher633e03a2007-06-22 19:11:54 +02003317 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003318
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003319 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003320 -64 net/eth.c no Ethernet found.
3321 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003322
Heiko Schocher633e03a2007-06-22 19:11:54 +02003323 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003324 80 common/cmd_net.c before calling net_loop()
3325 -81 common/cmd_net.c some error in net_loop() occurred
3326 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003327 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3328 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003329 83 common/cmd_net.c running "source" command
3330 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003331 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003332
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003333FIT uImage format:
3334
3335 Arg Where When
3336 100 common/cmd_bootm.c Kernel FIT Image has correct format
3337 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3338 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3339 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3340 102 common/cmd_bootm.c Kernel unit name specified
3341 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003342 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003343 104 common/cmd_bootm.c Got kernel subimage node offset
3344 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3345 105 common/cmd_bootm.c Kernel subimage hash verification OK
3346 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3347 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003348 -106 common/cmd_bootm.c Kernel subimage has wrong type
3349 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003350 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3351 108 common/cmd_bootm.c Got kernel subimage data/size
3352 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3353 -109 common/cmd_bootm.c Can't get kernel subimage type
3354 -110 common/cmd_bootm.c Can't get kernel subimage comp
3355 -111 common/cmd_bootm.c Can't get kernel subimage os
3356 -112 common/cmd_bootm.c Can't get kernel subimage load address
3357 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3358
3359 120 common/image.c Start initial ramdisk verification
3360 -120 common/image.c Ramdisk FIT image has incorrect format
3361 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003362 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003363 -122 common/image.c Can't get configuration for ramdisk subimage
3364 123 common/image.c Ramdisk unit name specified
3365 -124 common/image.c Can't get ramdisk subimage node offset
3366 125 common/image.c Got ramdisk subimage node offset
3367 -125 common/image.c Ramdisk subimage hash verification failed
3368 126 common/image.c Ramdisk subimage hash verification OK
3369 -126 common/image.c Ramdisk subimage for unsupported architecture
3370 127 common/image.c Architecture check OK
3371 -127 common/image.c Can't get ramdisk subimage data/size
3372 128 common/image.c Got ramdisk subimage data/size
3373 129 common/image.c Can't get ramdisk load address
3374 -129 common/image.c Got ramdisk load address
3375
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003376 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003377 131 common/cmd_doc.c FIT image format OK
3378
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003379 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003380 141 common/cmd_ide.c FIT image format OK
3381
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003382 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003383 151 common/cmd_nand.c FIT image format OK
3384
Heiko Schocher515eb122014-05-28 11:33:33 +02003385- legacy image format:
3386 CONFIG_IMAGE_FORMAT_LEGACY
3387 enables the legacy image format support in U-Boot.
3388
3389 Default:
3390 enabled if CONFIG_FIT_SIGNATURE is not defined.
3391
3392 CONFIG_DISABLE_IMAGE_LEGACY
3393 disable the legacy image format
3394
3395 This define is introduced, as the legacy image format is
3396 enabled per default for backward compatibility.
3397
Gabe Blackd572e162012-10-25 16:31:10 +00003398- FIT image support:
3399 CONFIG_FIT
3400 Enable support for the FIT uImage format.
3401
3402 CONFIG_FIT_BEST_MATCH
3403 When no configuration is explicitly selected, default to the
3404 one whose fdt's compatibility field best matches that of
3405 U-Boot itself. A match is considered "best" if it matches the
3406 most specific compatibility entry of U-Boot's fdt's root node.
3407 The order of entries in the configuration's fdt is ignored.
3408
Simon Glass58fe7e52013-06-13 15:10:00 -07003409 CONFIG_FIT_SIGNATURE
3410 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303411 using a hash signed and verified using RSA. If
3412 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3413 hashing is available using hardware, RSA library will use it.
3414 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003415
Heiko Schocher515eb122014-05-28 11:33:33 +02003416 WARNING: When relying on signed FIT images with required
3417 signature check the legacy image format is default
3418 disabled. If a board need legacy image format support
3419 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3420
Dirk Eibach88919ca2014-07-03 09:28:26 +02003421 CONFIG_FIT_DISABLE_SHA256
3422 Supporting SHA256 hashes has quite an impact on binary size.
3423 For constrained systems sha256 hash support can be disabled
3424 with this option.
3425
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003426- Standalone program support:
3427 CONFIG_STANDALONE_LOAD_ADDR
3428
Wolfgang Denk23f78482011-10-09 21:06:34 +02003429 This option defines a board specific value for the
3430 address where standalone program gets loaded, thus
3431 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003432 settings.
3433
3434- Frame Buffer Address:
3435 CONFIG_FB_ADDR
3436
3437 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003438 address for frame buffer. This is typically the case
3439 when using a graphics controller has separate video
3440 memory. U-Boot will then place the frame buffer at
3441 the given address instead of dynamically reserving it
3442 in system RAM by calling lcd_setmem(), which grabs
3443 the memory for the frame buffer depending on the
3444 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003445
3446 Please see board_init_f function.
3447
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003448- Automatic software updates via TFTP server
3449 CONFIG_UPDATE_TFTP
3450 CONFIG_UPDATE_TFTP_CNT_MAX
3451 CONFIG_UPDATE_TFTP_MSEC_MAX
3452
3453 These options enable and control the auto-update feature;
3454 for a more detailed description refer to doc/README.update.
3455
3456- MTD Support (mtdparts command, UBI support)
3457 CONFIG_MTD_DEVICE
3458
3459 Adds the MTD device infrastructure from the Linux kernel.
3460 Needed for mtdparts command support.
3461
3462 CONFIG_MTD_PARTITIONS
3463
3464 Adds the MTD partitioning infrastructure from the Linux
3465 kernel. Needed for UBI support.
3466
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003467- UBI support
3468 CONFIG_CMD_UBI
3469
3470 Adds commands for interacting with MTD partitions formatted
3471 with the UBI flash translation layer
3472
3473 Requires also defining CONFIG_RBTREE
3474
Joe Hershberger47550fc2013-04-08 10:32:49 +00003475 CONFIG_UBI_SILENCE_MSG
3476
3477 Make the verbose messages from UBI stop printing. This leaves
3478 warnings and errors enabled.
3479
Heiko Schocherf5895d12014-06-24 10:10:04 +02003480
3481 CONFIG_MTD_UBI_WL_THRESHOLD
3482 This parameter defines the maximum difference between the highest
3483 erase counter value and the lowest erase counter value of eraseblocks
3484 of UBI devices. When this threshold is exceeded, UBI starts performing
3485 wear leveling by means of moving data from eraseblock with low erase
3486 counter to eraseblocks with high erase counter.
3487
3488 The default value should be OK for SLC NAND flashes, NOR flashes and
3489 other flashes which have eraseblock life-cycle 100000 or more.
3490 However, in case of MLC NAND flashes which typically have eraseblock
3491 life-cycle less than 10000, the threshold should be lessened (e.g.,
3492 to 128 or 256, although it does not have to be power of 2).
3493
3494 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003495
Heiko Schocherf5895d12014-06-24 10:10:04 +02003496 CONFIG_MTD_UBI_BEB_LIMIT
3497 This option specifies the maximum bad physical eraseblocks UBI
3498 expects on the MTD device (per 1024 eraseblocks). If the
3499 underlying flash does not admit of bad eraseblocks (e.g. NOR
3500 flash), this value is ignored.
3501
3502 NAND datasheets often specify the minimum and maximum NVM
3503 (Number of Valid Blocks) for the flashes' endurance lifetime.
3504 The maximum expected bad eraseblocks per 1024 eraseblocks
3505 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3506 which gives 20 for most NANDs (MaxNVB is basically the total
3507 count of eraseblocks on the chip).
3508
3509 To put it differently, if this value is 20, UBI will try to
3510 reserve about 1.9% of physical eraseblocks for bad blocks
3511 handling. And that will be 1.9% of eraseblocks on the entire
3512 NAND chip, not just the MTD partition UBI attaches. This means
3513 that if you have, say, a NAND flash chip admits maximum 40 bad
3514 eraseblocks, and it is split on two MTD partitions of the same
3515 size, UBI will reserve 40 eraseblocks when attaching a
3516 partition.
3517
3518 default: 20
3519
3520 CONFIG_MTD_UBI_FASTMAP
3521 Fastmap is a mechanism which allows attaching an UBI device
3522 in nearly constant time. Instead of scanning the whole MTD device it
3523 only has to locate a checkpoint (called fastmap) on the device.
3524 The on-flash fastmap contains all information needed to attach
3525 the device. Using fastmap makes only sense on large devices where
3526 attaching by scanning takes long. UBI will not automatically install
3527 a fastmap on old images, but you can set the UBI parameter
3528 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3529 that fastmap-enabled images are still usable with UBI implementations
3530 without fastmap support. On typical flash devices the whole fastmap
3531 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3532
3533 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3534 Set this parameter to enable fastmap automatically on images
3535 without a fastmap.
3536 default: 0
3537
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003538- UBIFS support
3539 CONFIG_CMD_UBIFS
3540
3541 Adds commands for interacting with UBI volumes formatted as
3542 UBIFS. UBIFS is read-only in u-boot.
3543
3544 Requires UBI support as well as CONFIG_LZO
3545
Joe Hershberger47550fc2013-04-08 10:32:49 +00003546 CONFIG_UBIFS_SILENCE_MSG
3547
3548 Make the verbose messages from UBIFS stop printing. This leaves
3549 warnings and errors enabled.
3550
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003551- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003552 CONFIG_SPL
3553 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003554
Tom Rini36853852012-02-14 07:29:40 +00003555 CONFIG_SPL_LDSCRIPT
3556 LDSCRIPT for linking the SPL binary.
3557
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003558 CONFIG_SPL_MAX_FOOTPRINT
3559 Maximum size in memory allocated to the SPL, BSS included.
3560 When defined, the linker checks that the actual memory
3561 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003562 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003563 must not be both defined at the same time.
3564
Tom Rini36853852012-02-14 07:29:40 +00003565 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003566 Maximum size of the SPL image (text, data, rodata, and
3567 linker lists sections), BSS excluded.
3568 When defined, the linker checks that the actual size does
3569 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003570
Wolfgang Denk825223d2011-09-11 21:24:09 +02003571 CONFIG_SPL_TEXT_BASE
3572 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003573
Scott Woodc4f0d002012-09-20 19:05:12 -05003574 CONFIG_SPL_RELOC_TEXT_BASE
3575 Address to relocate to. If unspecified, this is equal to
3576 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3577
Tom Rini36853852012-02-14 07:29:40 +00003578 CONFIG_SPL_BSS_START_ADDR
3579 Link address for the BSS within the SPL binary.
3580
3581 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003582 Maximum size in memory allocated to the SPL BSS.
3583 When defined, the linker checks that the actual memory used
3584 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003585 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003586 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003587
3588 CONFIG_SPL_STACK
3589 Adress of the start of the stack SPL will use
3590
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003591 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3592 When defined, SPL will panic() if the image it has
3593 loaded does not have a signature.
3594 Defining this is useful when code which loads images
3595 in SPL cannot guarantee that absolutely all read errors
3596 will be caught.
3597 An example is the LPC32XX MLC NAND driver, which will
3598 consider that a completely unreadable NAND block is bad,
3599 and thus should be skipped silently.
3600
Scott Woodc4f0d002012-09-20 19:05:12 -05003601 CONFIG_SPL_RELOC_STACK
3602 Adress of the start of the stack SPL will use after
3603 relocation. If unspecified, this is equal to
3604 CONFIG_SPL_STACK.
3605
Tom Rini36853852012-02-14 07:29:40 +00003606 CONFIG_SYS_SPL_MALLOC_START
3607 Starting address of the malloc pool used in SPL.
3608
3609 CONFIG_SYS_SPL_MALLOC_SIZE
3610 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003611
Tom Rini28591df2012-08-13 12:03:19 -07003612 CONFIG_SPL_FRAMEWORK
3613 Enable the SPL framework under common/. This framework
3614 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3615 NAND loading of the Linux Kernel.
3616
Tom Rinic2b76002014-03-28 12:03:39 -04003617 CONFIG_SPL_OS_BOOT
3618 Enable booting directly to an OS from SPL.
3619 See also: doc/README.falcon
3620
Tom Rinife3b0c72012-08-13 11:37:56 -07003621 CONFIG_SPL_DISPLAY_PRINT
3622 For ARM, enable an optional function to print more information
3623 about the running system.
3624
Scott Wood7c810902012-09-20 16:35:21 -05003625 CONFIG_SPL_INIT_MINIMAL
3626 Arch init code should be built for a very small image
3627
Wolfgang Denk825223d2011-09-11 21:24:09 +02003628 CONFIG_SPL_LIBCOMMON_SUPPORT
3629 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003630
Wolfgang Denk825223d2011-09-11 21:24:09 +02003631 CONFIG_SPL_LIBDISK_SUPPORT
3632 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003633
Wolfgang Denk825223d2011-09-11 21:24:09 +02003634 CONFIG_SPL_I2C_SUPPORT
3635 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003636
Wolfgang Denk825223d2011-09-11 21:24:09 +02003637 CONFIG_SPL_GPIO_SUPPORT
3638 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003639
Wolfgang Denk825223d2011-09-11 21:24:09 +02003640 CONFIG_SPL_MMC_SUPPORT
3641 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003642
Tom Rini36853852012-02-14 07:29:40 +00003643 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3644 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003645 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003646 when the MMC is being used in raw mode.
3647
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003648 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3649 Partition on the MMC to load U-Boot from when the MMC is being
3650 used in raw mode
3651
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003652 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3653 Sector to load kernel uImage from when MMC is being
3654 used in raw mode (for Falcon mode)
3655
3656 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3657 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3658 Sector and number of sectors to load kernel argument
3659 parameters from when MMC is being used in raw mode
3660 (for falcon mode)
3661
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003662 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3663 Partition on the MMC to load U-Boot from when the MMC is being
3664 used in fs mode
3665
Tom Rini36853852012-02-14 07:29:40 +00003666 CONFIG_SPL_FAT_SUPPORT
3667 Support for fs/fat/libfat.o in SPL binary
3668
Guillaume GARDET5065b712014-10-15 17:53:13 +02003669 CONFIG_SPL_EXT_SUPPORT
3670 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003671
Guillaume GARDET5065b712014-10-15 17:53:13 +02003672 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3673 Filename to read to load U-Boot when reading from filesystem
3674
3675 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003676 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003677 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003678
Guillaume GARDET5065b712014-10-15 17:53:13 +02003679 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003680 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003681 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003682
Scott Wood2b36fbb2012-12-06 13:33:17 +00003683 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3684 Set this for NAND SPL on PPC mpc83xx targets, so that
3685 start.S waits for the rest of the SPL to load before
3686 continuing (the hardware starts execution after just
3687 loading the first page rather than the full 4K).
3688
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303689 CONFIG_SPL_SKIP_RELOCATE
3690 Avoid SPL relocation
3691
Scott Woodc352a0c2012-09-20 19:09:07 -05003692 CONFIG_SPL_NAND_BASE
3693 Include nand_base.c in the SPL. Requires
3694 CONFIG_SPL_NAND_DRIVERS.
3695
3696 CONFIG_SPL_NAND_DRIVERS
3697 SPL uses normal NAND drivers, not minimal drivers.
3698
3699 CONFIG_SPL_NAND_ECC
3700 Include standard software ECC in the SPL
3701
Tom Rini36853852012-02-14 07:29:40 +00003702 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003703 Support for NAND boot using simple NAND drivers that
3704 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003705
Tom Rini543c9f12014-03-28 12:03:36 -04003706 CONFIG_SPL_MTD_SUPPORT
3707 Support for the MTD subsystem within SPL. Useful for
3708 environment on NAND support within SPL.
3709
Heiko Schochercf000272014-10-31 08:31:00 +01003710 CONFIG_SPL_NAND_RAW_ONLY
3711 Support to boot only raw u-boot.bin images. Use this only
3712 if you need to save space.
3713
Ying Zhang9ff70262013-08-16 15:16:11 +08003714 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3715 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003716 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003717
Ying Zhangdfb2b152013-08-16 15:16:12 +08003718 CONFIG_SPL_COMMON_INIT_DDR
3719 Set for common ddr init with serial presence detect in
3720 SPL binary.
3721
Tom Rini36853852012-02-14 07:29:40 +00003722 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3723 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3724 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3725 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3726 CONFIG_SYS_NAND_ECCBYTES
3727 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003728 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003729
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303730 CONFIG_SPL_NAND_BOOT
3731 Add support NAND boot
3732
Tom Rini36853852012-02-14 07:29:40 +00003733 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003734 Location in NAND to read U-Boot from
3735
3736 CONFIG_SYS_NAND_U_BOOT_DST
3737 Location in memory to load U-Boot to
3738
3739 CONFIG_SYS_NAND_U_BOOT_SIZE
3740 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003741
3742 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003743 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003744
3745 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3746 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003747 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003748
3749 CONFIG_SPL_OMAP3_ID_NAND
3750 Support for an OMAP3-specific set of functions to return the
3751 ID and MFR of the first attached NAND chip, if present.
3752
Wolfgang Denk825223d2011-09-11 21:24:09 +02003753 CONFIG_SPL_SERIAL_SUPPORT
3754 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003755
Wolfgang Denk825223d2011-09-11 21:24:09 +02003756 CONFIG_SPL_SPI_FLASH_SUPPORT
3757 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003758
Wolfgang Denk825223d2011-09-11 21:24:09 +02003759 CONFIG_SPL_SPI_SUPPORT
3760 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003761
Pavel Machekde997252012-08-30 22:42:11 +02003762 CONFIG_SPL_RAM_DEVICE
3763 Support for running image already present in ram, in SPL binary
3764
Wolfgang Denk825223d2011-09-11 21:24:09 +02003765 CONFIG_SPL_LIBGENERIC_SUPPORT
3766 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003767
Ying Zhang602f7d32013-05-20 14:07:25 +08003768 CONFIG_SPL_ENV_SUPPORT
3769 Support for the environment operating in SPL binary
3770
3771 CONFIG_SPL_NET_SUPPORT
3772 Support for the net/libnet.o in SPL binary.
3773 It conflicts with SPL env from storage medium specified by
3774 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3775
Scott Woodeb7bd972012-12-06 13:33:16 +00003776 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003777 Image offset to which the SPL should be padded before appending
3778 the SPL payload. By default, this is defined as
3779 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3780 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3781 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003782
Scott Woodf147eb72012-09-21 16:27:32 -05003783 CONFIG_SPL_TARGET
3784 Final target image containing SPL and payload. Some SPLs
3785 use an arch-specific makefile fragment instead, for
3786 example if more than one image needs to be produced.
3787
Simon Glass82d94532013-05-08 08:05:59 +00003788 CONFIG_FIT_SPL_PRINT
3789 Printing information about a FIT image adds quite a bit of
3790 code to SPL. So this is normally disabled in SPL. Use this
3791 option to re-enable it. This will affect the output of the
3792 bootm command when booting a FIT image.
3793
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003794- TPL framework
3795 CONFIG_TPL
3796 Enable building of TPL globally.
3797
3798 CONFIG_TPL_PAD_TO
3799 Image offset to which the TPL should be padded before appending
3800 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003801 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3802 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3803 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003804
wdenkc6097192002-11-03 00:24:07 +00003805Modem Support:
3806--------------
3807
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003808[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003809
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003810- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003811 CONFIG_MODEM_SUPPORT
3812
3813- RTS/CTS Flow control enable:
3814 CONFIG_HWFLOW
3815
3816- Modem debug support:
3817 CONFIG_MODEM_SUPPORT_DEBUG
3818
wdenk4a5c8a72003-03-06 00:02:04 +00003819 Enables debugging stuff (char screen[1024], dbg())
3820 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003821
wdenkc0aa5c52003-12-06 19:49:23 +00003822- Interrupt support (PPC):
3823
wdenk1ebf41e2004-01-02 14:00:00 +00003824 There are common interrupt_init() and timer_interrupt()
3825 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003826 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003827 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003828 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003829 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003830 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003831 specific handling. If board has watchdog / status_led
3832 / other_activity_monitor it works automatically from
3833 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003834
wdenkc6097192002-11-03 00:24:07 +00003835- General:
3836
wdenk4a5c8a72003-03-06 00:02:04 +00003837 In the target system modem support is enabled when a
3838 specific key (key combination) is pressed during
3839 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003840 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003841 board_init(). Currently key_pressed() is a dummy
3842 function, returning 1 and thus enabling modem
3843 initialization.
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk4a5c8a72003-03-06 00:02:04 +00003845 If there are no modem init strings in the
3846 environment, U-Boot proceed to autoboot; the
3847 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003848 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003849
3850 See also: doc/README.Modem
3851
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003852Board initialization settings:
3853------------------------------
3854
3855During Initialization u-boot calls a number of board specific functions
3856to allow the preparation of board specific prerequisites, e.g. pin setup
3857before drivers are initialized. To enable these callbacks the
3858following configuration macros have to be defined. Currently this is
3859architecture specific, so please check arch/your_architecture/lib/board.c
3860typically in board_init_f() and board_init_r().
3861
3862- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3863- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3864- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3865- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003866
wdenkc6097192002-11-03 00:24:07 +00003867Configuration Settings:
3868-----------------------
3869
York Sun6c480012014-02-26 17:03:19 -08003870- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3871 Optionally it can be defined to support 64-bit memory commands.
3872
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003873- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003874 undefine this when you're short of memory.
3875
Peter Tyserdfb72b82009-01-27 18:03:12 -06003876- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3877 width of the commands listed in the 'help' command output.
3878
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003879- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003880 prompt for user input.
3881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003884- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003885
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003886- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003888- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003889 the application (usually a Linux kernel) when it is
3890 booted
3891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003893 List of legal baudrate settings for this board.
3894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003895- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003896 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003897
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003898- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003899 If the board specific function
3900 extern int overwrite_console (void);
3901 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003902 serial port, else the settings in the environment are used.
3903
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003904- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003905 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003907- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003908 Enable overwrite of previous console environment settings.
3909
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003910- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003911 Begin and End addresses of the area used by the
3912 simple memory test.
3913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003914- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003915 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003917- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003918 Scratch address used by the alternate memory test
3919 You only need to set this if address zero isn't writeable
3920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3922 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003923 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003924 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003925 fixing up gd->ram_size the Linux kernel should gets passed
3926 the now "corrected" memory size and won't touch it either.
3927 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003928 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003929 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003930 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003931
3932 This option can be used as a workaround for the 440EPx/GRx
3933 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3934 be touched.
3935
3936 WARNING: Please make sure that this value is a multiple of
3937 the Linux page size (normally 4k). If this is not the case,
3938 then the end address of the Linux memory will be located at a
3939 non page size aligned address and this could cause major
3940 problems.
3941
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003942- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003943 Enable temporary baudrate change while serial download
3944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003946 Physical start address of SDRAM. _Must_ be 0 here.
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003949 Physical start address of Motherboard I/O (if using a
3950 Cogent motherboard)
3951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003952- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003953 Physical start address of Flash memory.
3954
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003955- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003956 Physical start address of boot monitor code (set by
3957 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003958 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003959 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003962 Size of memory reserved for monitor code, used to
3963 determine _at_compile_time_ (!) if the environment is
3964 embedded within the U-Boot image, or in a separate
3965 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003966
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003967- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003968 Size of DRAM reserved for malloc() use.
3969
Simon Glass863e4042014-07-10 22:23:28 -06003970- CONFIG_SYS_MALLOC_F_LEN
3971 Size of the malloc() pool for use before relocation. If
3972 this is defined, then a very simple malloc() implementation
3973 will become available before relocation. The address is just
3974 below the global data, and the stack is moved down to make
3975 space.
3976
3977 This feature allocates regions with increasing addresses
3978 within the region. calloc() is supported, but realloc()
3979 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003980 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003981 U-Boot relocates itself.
3982
Simon Glasse997f752014-09-15 06:33:18 -06003983 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003984 at present but is fairly easy to enable for other archs.
3985
Simon Glass9fa901b2014-11-10 17:16:54 -07003986- CONFIG_SYS_MALLOC_SIMPLE
3987 Provides a simple and small malloc() and calloc() for those
3988 boards which do not use the full malloc in SPL (which is
3989 enabled with CONFIG_SYS_SPL_MALLOC_START).
3990
Thierry Redingc97d9742014-12-09 22:25:22 -07003991- CONFIG_SYS_NONCACHED_MEMORY:
3992 Size of non-cached memory area. This area of memory will be
3993 typically located right below the malloc() area and mapped
3994 uncached in the MMU. This is useful for drivers that would
3995 otherwise require a lot of explicit cache maintenance. For
3996 some drivers it's also impossible to properly maintain the
3997 cache. For example if the regions that need to be flushed
3998 are not a multiple of the cache-line size, *and* padding
3999 cannot be allocated between the regions to align them (i.e.
4000 if the HW requires a contiguous array of regions, and the
4001 size of each region is not cache-aligned), then a flush of
4002 one region may result in overwriting data that hardware has
4003 written to another region in the same cache-line. This can
4004 happen for example in network drivers where descriptors for
4005 buffers are typically smaller than the CPU cache-line (e.g.
4006 16 bytes vs. 32 or 64 bytes).
4007
4008 Non-cached memory is only supported on 32-bit ARM at present.
4009
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004010- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01004011 Normally compressed uImages are limited to an
4012 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004013 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004014 to adjust this setting to your needs.
4015
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004016- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004017 Maximum size of memory mapped by the startup code of
4018 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004019 the Linux kernel (bd_info, boot arguments, FDT blob if
4020 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004021 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004022 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004023 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004024 variable "bootm_mapsize" will override the value of
4025 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4026 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004027
John Rigbyeea8e692010-10-13 13:57:35 -06004028- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4029 Enable initrd_high functionality. If defined then the
4030 initrd_high feature is enabled and the bootm ramdisk subcommand
4031 is enabled.
4032
4033- CONFIG_SYS_BOOT_GET_CMDLINE:
4034 Enables allocating and saving kernel cmdline in space between
4035 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4036
4037- CONFIG_SYS_BOOT_GET_KBD:
4038 Enables allocating and saving a kernel copy of the bd_info in
4039 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4040
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004041- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004042 Max number of Flash memory banks
4043
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004044- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004045 Max number of sectors on a Flash chip
4046
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004047- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004048 Timeout for Flash erase operations (in ms)
4049
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004050- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004051 Timeout for Flash write operations (in ms)
4052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004053- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004054 Timeout for Flash set sector lock bit operation (in ms)
4055
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004056- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004057 Timeout for Flash clear lock bits operation (in ms)
4058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004059- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004060 If defined, hardware flash sectors protection is used
4061 instead of U-Boot software protection.
4062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004063- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004064
4065 Enable TFTP transfers directly to flash memory;
4066 without this option such a download has to be
4067 performed in two steps: (1) download to RAM, and (2)
4068 copy from RAM to flash.
4069
4070 The two-step approach is usually more reliable, since
4071 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004072 the flash, but in some situations (when system RAM is
4073 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004074 downloaded image) this option may be very useful.
4075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004076- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004077 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004078 common flash structure for storing flash geometry.
4079
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004080- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004081 This option also enables the building of the cfi_flash driver
4082 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004083
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004084- CONFIG_FLASH_CFI_MTD
4085 This option enables the building of the cfi_mtd driver
4086 in the drivers directory. The driver exports CFI flash
4087 to the MTD layer.
4088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004089- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004090 Use buffered writes to flash.
4091
4092- CONFIG_FLASH_SPANSION_S29WS_N
4093 s29ws-n MirrorBit flash has non-standard addresses for buffered
4094 write commands.
4095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004096- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004097 If this option is defined, the common CFI flash doesn't
4098 print it's warning upon not recognized FLASH banks. This
4099 is useful, if some of the configured banks are only
4100 optionally available.
4101
Jerry Van Barenaae73572008-03-08 13:48:01 -05004102- CONFIG_FLASH_SHOW_PROGRESS
4103 If defined (must be an integer), print out countdown
4104 digits and dots. Recommended value: 45 (9..1) for 80
4105 column displays, 15 (3..1) for 40 column displays.
4106
Stefan Roesed20cba52013-04-04 15:53:14 +02004107- CONFIG_FLASH_VERIFY
4108 If defined, the content of the flash (destination) is compared
4109 against the source after the write operation. An error message
4110 will be printed when the contents are not identical.
4111 Please note that this option is useless in nearly all cases,
4112 since such flash programming errors usually are detected earlier
4113 while unprotecting/erasing/programming. Please only enable
4114 this option if you really know what you are doing.
4115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004116- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004117 Defines the number of Ethernet receive buffers. On some
4118 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004119 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4120 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004121 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004122 Defaults to 4 if not defined.
4123
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004124- CONFIG_ENV_MAX_ENTRIES
4125
Wolfgang Denk1136f692010-10-27 22:48:30 +02004126 Maximum number of entries in the hash table that is used
4127 internally to store the environment settings. The default
4128 setting is supposed to be generous and should work in most
4129 cases. This setting can be used to tune behaviour; see
4130 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004131
Joe Hershberger71497d02012-12-11 22:16:31 -06004132- CONFIG_ENV_FLAGS_LIST_DEFAULT
4133- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004134 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004135 calling env set. Variables can be restricted to only decimal,
4136 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4137 the variables can also be restricted to IP address or MAC address.
4138
4139 The format of the list is:
4140 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004141 access_attribute = [a|r|o|c]
4142 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004143 entry = variable_name[:attributes]
4144 list = entry[,list]
4145
4146 The type attributes are:
4147 s - String (default)
4148 d - Decimal
4149 x - Hexadecimal
4150 b - Boolean ([1yYtT|0nNfF])
4151 i - IP address
4152 m - MAC address
4153
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004154 The access attributes are:
4155 a - Any (default)
4156 r - Read-only
4157 o - Write-once
4158 c - Change-default
4159
Joe Hershberger71497d02012-12-11 22:16:31 -06004160 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4161 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004162 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004163
4164 - CONFIG_ENV_FLAGS_LIST_STATIC
4165 Define this to a list (string) to define validation that
4166 should be done if an entry is not found in the ".flags"
4167 environment variable. To override a setting in the static
4168 list, simply add an entry for the same variable name to the
4169 ".flags" variable.
4170
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004171- CONFIG_ENV_ACCESS_IGNORE_FORCE
4172 If defined, don't allow the -f switch to env set override variable
4173 access flags.
4174
Simon Glass66828322013-03-08 13:45:27 +00004175- CONFIG_SYS_GENERIC_BOARD
4176 This selects the architecture-generic board system instead of the
4177 architecture-specific board files. It is intended to move boards
4178 to this new framework over time. Defining this will disable the
4179 arch/foo/lib/board.c file and use common/board_f.c and
4180 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004181 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4182 If you find problems enabling this option on your board please report
4183 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004184
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004185- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4186 This is set by OMAP boards for the max time that reset should
4187 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004188 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004189
Gabe Black3687fe42014-10-15 04:38:30 -06004190- CONFIG_USE_STDINT
4191 If stdint.h is available with your toolchain you can define this
4192 option to enable it. You can provide option 'USE_STDINT=1' when
4193 building U-Boot to enable this.
4194
wdenkc6097192002-11-03 00:24:07 +00004195The following definitions that deal with the placement and management
4196of environment data (variable area); in general, we support the
4197following configurations:
4198
Mike Frysinger63b8f122011-07-08 10:44:25 +00004199- CONFIG_BUILD_ENVCRC:
4200
4201 Builds up envcrc with the target environment so that external utils
4202 may easily extract it and embed it in final U-Boot images.
4203
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004204- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004205
4206 Define this if the environment is in flash memory.
4207
4208 a) The environment occupies one whole flash sector, which is
4209 "embedded" in the text segment with the U-Boot code. This
4210 happens usually with "bottom boot sector" or "top boot
4211 sector" type flash chips, which have several smaller
4212 sectors at the start or the end. For instance, such a
4213 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4214 such a case you would place the environment in one of the
4215 4 kB sectors - with U-Boot code before and after it. With
4216 "top boot sector" type flash chips, you would put the
4217 environment in one of the last sectors, leaving a gap
4218 between U-Boot and the environment.
4219
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004220 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004221
4222 Offset of environment data (variable area) to the
4223 beginning of flash memory; for instance, with bottom boot
4224 type flash chips the second sector can be used: the offset
4225 for this sector is given here.
4226
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004227 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004228
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004229 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004230
4231 This is just another way to specify the start address of
4232 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004233 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004234
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004235 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004236
4237 Size of the sector containing the environment.
4238
4239
4240 b) Sometimes flash chips have few, equal sized, BIG sectors.
4241 In such a case you don't want to spend a whole sector for
4242 the environment.
4243
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004244 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004245
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004246 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004247 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004248 of this flash sector for the environment. This saves
4249 memory for the RAM copy of the environment.
4250
4251 It may also save flash memory if you decide to use this
4252 when your environment is "embedded" within U-Boot code,
4253 since then the remainder of the flash sector could be used
4254 for U-Boot code. It should be pointed out that this is
4255 STRONGLY DISCOURAGED from a robustness point of view:
4256 updating the environment in flash makes it always
4257 necessary to erase the WHOLE sector. If something goes
4258 wrong before the contents has been restored from a copy in
4259 RAM, your target system will be dead.
4260
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004261 - CONFIG_ENV_ADDR_REDUND
4262 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk4a5c8a72003-03-06 00:02:04 +00004264 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004265 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004266 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004267 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004268
4269BE CAREFUL! Any changes to the flash layout, and some changes to the
4270source code will make it necessary to adapt <board>/u-boot.lds*
4271accordingly!
4272
4273
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004274- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004275
4276 Define this if you have some non-volatile memory device
4277 (NVRAM, battery buffered SRAM) which you want to use for the
4278 environment.
4279
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004280 - CONFIG_ENV_ADDR:
4281 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004282
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004283 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004284 want to use for environment. It is assumed that this memory
4285 can just be read and written to, without any special
4286 provision.
4287
4288BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004289in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004290console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004291U-Boot will hang.
4292
4293Please note that even with NVRAM we still use a copy of the
4294environment in RAM: we could work on NVRAM directly, but we want to
4295keep settings there always unmodified except somebody uses "saveenv"
4296to save the current settings.
4297
4298
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004299- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004300
4301 Use this if you have an EEPROM or similar serial access
4302 device and a driver for it.
4303
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004304 - CONFIG_ENV_OFFSET:
4305 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004306
4307 These two #defines specify the offset and size of the
4308 environment area within the total memory of your EEPROM.
4309
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004310 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004311 If defined, specified the chip address of the EEPROM device.
4312 The default address is zero.
4313
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004314 - CONFIG_SYS_I2C_EEPROM_BUS:
4315 If defined, specified the i2c bus of the EEPROM device.
4316
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004317 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004318 If defined, the number of bits used to address bytes in a
4319 single page in the EEPROM device. A 64 byte page, for example
4320 would require six bits.
4321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004322 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004323 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004324 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004326 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004327 The length in bytes of the EEPROM memory array address. Note
4328 that this is NOT the chip address length!
4329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004330 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004331 EEPROM chips that implement "address overflow" are ones
4332 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4333 address and the extra bits end up in the "chip address" bit
4334 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4335 byte chips.
4336
4337 Note that we consider the length of the address field to
4338 still be one byte because the extra address bits are hidden
4339 in the chip address.
4340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004341 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004342 The size in bytes of the EEPROM device.
4343
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004344 - CONFIG_ENV_EEPROM_IS_ON_I2C
4345 define this, if you have I2C and SPI activated, and your
4346 EEPROM, which holds the environment, is on the I2C bus.
4347
4348 - CONFIG_I2C_ENV_EEPROM_BUS
4349 if you have an Environment on an EEPROM reached over
4350 I2C muxes, you can define here, how to reach this
4351 EEPROM. For example:
4352
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004353 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004354
4355 EEPROM which holds the environment, is reached over
4356 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004357
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004358- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004359
wdenk1ebf41e2004-01-02 14:00:00 +00004360 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004361 want to use for the environment.
4362
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004363 - CONFIG_ENV_OFFSET:
4364 - CONFIG_ENV_ADDR:
4365 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004366
4367 These three #defines specify the offset and size of the
4368 environment area within the total memory of your DataFlash placed
4369 at the specified address.
4370
Wu, Josh76db7bf2014-07-01 19:30:13 +08004371- CONFIG_ENV_IS_IN_SPI_FLASH:
4372
4373 Define this if you have a SPI Flash memory device which you
4374 want to use for the environment.
4375
4376 - CONFIG_ENV_OFFSET:
4377 - CONFIG_ENV_SIZE:
4378
4379 These two #defines specify the offset and size of the
4380 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4381 aligned to an erase sector boundary.
4382
4383 - CONFIG_ENV_SECT_SIZE:
4384
4385 Define the SPI flash's sector size.
4386
4387 - CONFIG_ENV_OFFSET_REDUND (optional):
4388
4389 This setting describes a second storage area of CONFIG_ENV_SIZE
4390 size used to hold a redundant copy of the environment data, so
4391 that there is a valid backup copy in case there is a power failure
4392 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4393 aligned to an erase sector boundary.
4394
4395 - CONFIG_ENV_SPI_BUS (optional):
4396 - CONFIG_ENV_SPI_CS (optional):
4397
4398 Define the SPI bus and chip select. If not defined they will be 0.
4399
4400 - CONFIG_ENV_SPI_MAX_HZ (optional):
4401
4402 Define the SPI max work clock. If not defined then use 1MHz.
4403
4404 - CONFIG_ENV_SPI_MODE (optional):
4405
4406 Define the SPI work mode. If not defined then use SPI_MODE_3.
4407
Liu Gang85bcd732012-03-08 00:33:20 +00004408- CONFIG_ENV_IS_IN_REMOTE:
4409
4410 Define this if you have a remote memory space which you
4411 want to use for the local device's environment.
4412
4413 - CONFIG_ENV_ADDR:
4414 - CONFIG_ENV_SIZE:
4415
4416 These two #defines specify the address and size of the
4417 environment area within the remote memory space. The
4418 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004419 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004420
4421BE CAREFUL! For some special cases, the local device can not use
4422"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004423environment stored in a remote NOR flash by SRIO or PCIE link,
4424but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004425
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004426- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004427
4428 Define this if you have a NAND device which you want to use
4429 for the environment.
4430
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004431 - CONFIG_ENV_OFFSET:
4432 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004433
4434 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004435 area within the first NAND device. CONFIG_ENV_OFFSET must be
4436 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004437
Scott Wood08239322010-09-17 14:38:37 -05004438 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004439
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004440 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004441 size used to hold a redundant copy of the environment data, so
4442 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004443 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004444 aligned to an erase block boundary.
4445
4446 - CONFIG_ENV_RANGE (optional):
4447
4448 Specifies the length of the region in which the environment
4449 can be written. This should be a multiple of the NAND device's
4450 block size. Specifying a range with more erase blocks than
4451 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4452 the range to be avoided.
4453
4454 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004455
Scott Wood08239322010-09-17 14:38:37 -05004456 Enables support for dynamically retrieving the offset of the
4457 environment from block zero's out-of-band data. The
4458 "nand env.oob" command can be used to record this offset.
4459 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4460 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004461
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004462- CONFIG_NAND_ENV_DST
4463
4464 Defines address in RAM to which the nand_spl code should copy the
4465 environment. If redundant environment is used, it will be copied to
4466 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4467
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004468- CONFIG_ENV_IS_IN_UBI:
4469
4470 Define this if you have an UBI volume that you want to use for the
4471 environment. This has the benefit of wear-leveling the environment
4472 accesses, which is important on NAND.
4473
4474 - CONFIG_ENV_UBI_PART:
4475
4476 Define this to a string that is the mtd partition containing the UBI.
4477
4478 - CONFIG_ENV_UBI_VOLUME:
4479
4480 Define this to the name of the volume that you want to store the
4481 environment in.
4482
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004483 - CONFIG_ENV_UBI_VOLUME_REDUND:
4484
4485 Define this to the name of another volume to store a second copy of
4486 the environment in. This will enable redundant environments in UBI.
4487 It is assumed that both volumes are in the same MTD partition.
4488
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004489 - CONFIG_UBI_SILENCE_MSG
4490 - CONFIG_UBIFS_SILENCE_MSG
4491
4492 You will probably want to define these to avoid a really noisy system
4493 when storing the env in UBI.
4494
Wu, Josha7d0c872014-06-24 17:31:03 +08004495- CONFIG_ENV_IS_IN_FAT:
4496 Define this if you want to use the FAT file system for the environment.
4497
4498 - FAT_ENV_INTERFACE:
4499
4500 Define this to a string that is the name of the block device.
4501
4502 - FAT_ENV_DEV_AND_PART:
4503
4504 Define this to a string to specify the partition of the device. It can
4505 be as following:
4506
4507 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4508 - "D:P": device D partition P. Error occurs if device D has no
4509 partition table.
4510 - "D:0": device D.
4511 - "D" or "D:": device D partition 1 if device D has partition
4512 table, or the whole device D if has no partition
4513 table.
4514 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004515 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004516 partition table then means device D.
4517
4518 - FAT_ENV_FILE:
4519
4520 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004521 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004522
4523 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004524 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004525
Stephen Warreneedcacd2013-06-11 15:14:00 -06004526- CONFIG_ENV_IS_IN_MMC:
4527
4528 Define this if you have an MMC device which you want to use for the
4529 environment.
4530
4531 - CONFIG_SYS_MMC_ENV_DEV:
4532
4533 Specifies which MMC device the environment is stored in.
4534
4535 - CONFIG_SYS_MMC_ENV_PART (optional):
4536
4537 Specifies which MMC partition the environment is stored in. If not
4538 set, defaults to partition 0, the user area. Common values might be
4539 1 (first MMC boot partition), 2 (second MMC boot partition).
4540
4541 - CONFIG_ENV_OFFSET:
4542 - CONFIG_ENV_SIZE:
4543
4544 These two #defines specify the offset and size of the environment
4545 area within the specified MMC device.
4546
Stephen Warren24dc2032013-06-11 15:14:02 -06004547 If offset is positive (the usual case), it is treated as relative to
4548 the start of the MMC partition. If offset is negative, it is treated
4549 as relative to the end of the MMC partition. This can be useful if
4550 your board may be fitted with different MMC devices, which have
4551 different sizes for the MMC partitions, and you always want the
4552 environment placed at the very end of the partition, to leave the
4553 maximum possible space before it, to store other data.
4554
Stephen Warreneedcacd2013-06-11 15:14:00 -06004555 These two values are in units of bytes, but must be aligned to an
4556 MMC sector boundary.
4557
4558 - CONFIG_ENV_OFFSET_REDUND (optional):
4559
4560 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4561 hold a redundant copy of the environment data. This provides a
4562 valid backup copy in case the other copy is corrupted, e.g. due
4563 to a power failure during a "saveenv" operation.
4564
Stephen Warren24dc2032013-06-11 15:14:02 -06004565 This value may also be positive or negative; this is handled in the
4566 same way as CONFIG_ENV_OFFSET.
4567
Stephen Warreneedcacd2013-06-11 15:14:00 -06004568 This value is also in units of bytes, but must also be aligned to
4569 an MMC sector boundary.
4570
4571 - CONFIG_ENV_SIZE_REDUND (optional):
4572
4573 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4574 set. If this value is set, it must be set to the same value as
4575 CONFIG_ENV_SIZE.
4576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004577- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004578
4579 Defines offset to the initial SPI buffer area in DPRAM. The
4580 area is used at an early stage (ROM part) if the environment
4581 is configured to reside in the SPI EEPROM: We need a 520 byte
4582 scratch DPRAM area. It is used between the two initialization
4583 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4584 to be a good choice since it makes it far enough from the
4585 start of the data area as well as from the stack pointer.
4586
Bruce Adleredecc942007-11-02 13:15:42 -07004587Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004588has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004589created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004590until then to read environment variables.
4591
wdenk8dba0502003-03-31 16:34:49 +00004592The environment is protected by a CRC32 checksum. Before the monitor
4593is relocated into RAM, as a result of a bad CRC you will be working
4594with the compiled-in default environment - *silently*!!! [This is
4595necessary, because the first environment variable we need is the
4596"baudrate" setting for the console - if we have a bad CRC, we don't
4597have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004598
4599Note: once the monitor has been relocated, then it will complain if
4600the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004601use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004603- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004604 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004605
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004606 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004607 also needs to be defined.
4608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004609- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004610 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004611
Ron Madriddfa028a2009-02-18 14:30:44 -08004612- CONFIG_NS16550_MIN_FUNCTIONS:
4613 Define this if you desire to only have use of the NS16550_init
4614 and NS16550_putc functions for the serial driver located at
4615 drivers/serial/ns16550.c. This option is useful for saving
4616 space for already greatly restricted images, including but not
4617 limited to NAND_SPL configurations.
4618
Simon Glass28a9e332012-11-30 13:01:18 +00004619- CONFIG_DISPLAY_BOARDINFO
4620 Display information about the board that U-Boot is running on
4621 when U-Boot starts up. The board function checkboard() is called
4622 to do this.
4623
Simon Glasse8822012012-11-30 13:01:19 +00004624- CONFIG_DISPLAY_BOARDINFO_LATE
4625 Similar to the previous option, but display this information
4626 later, once stdio is running and output goes to the LCD, if
4627 present.
4628
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004629- CONFIG_BOARD_SIZE_LIMIT:
4630 Maximum size of the U-Boot image. When defined, the
4631 build system checks that the actual size does not
4632 exceed it.
4633
wdenkc6097192002-11-03 00:24:07 +00004634Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004635---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004637- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004638 Cache Line Size of the CPU.
4639
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004640- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004641 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004642
wdenk9c53f402003-10-15 23:53:47 +00004643 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4644 and RPXsuper) to be able to adjust the position of
4645 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004646
Timur Tabid8f341c2011-08-04 18:03:41 -05004647- CONFIG_SYS_CCSRBAR_DEFAULT:
4648 Default (power-on reset) physical address of CCSR on Freescale
4649 PowerPC SOCs.
4650
4651- CONFIG_SYS_CCSRBAR:
4652 Virtual address of CCSR. On a 32-bit build, this is typically
4653 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4654
4655 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4656 for cross-platform code that uses that macro instead.
4657
4658- CONFIG_SYS_CCSRBAR_PHYS:
4659 Physical address of CCSR. CCSR can be relocated to a new
4660 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004661 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004662 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4663 is typically relocated on 36-bit builds. It is recommended
4664 that this macro be defined via the _HIGH and _LOW macros:
4665
4666 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4667 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4668
4669- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004670 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4671 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004672 used in assembly code, so it must not contain typecasts or
4673 integer size suffixes (e.g. "ULL").
4674
4675- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4676 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4677 used in assembly code, so it must not contain typecasts or
4678 integer size suffixes (e.g. "ULL").
4679
4680- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4681 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4682 forced to a value that ensures that CCSR is not relocated.
4683
wdenk1272e232002-11-10 22:06:23 +00004684- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004685 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004686
4687 the default drive number (default value 0)
4688
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004689 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004690
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004691 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004692 (default value 1)
4693
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004694 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004695
wdenk4a5c8a72003-03-06 00:02:04 +00004696 defines the offset of register from address. It
4697 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004698 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004700 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4701 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004702 default value.
wdenk1272e232002-11-10 22:06:23 +00004703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004705 fdc_hw_init() is called at the beginning of the FDC
4706 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004707 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004708 initializations.
wdenk1272e232002-11-10 22:06:23 +00004709
Macpaul Lind1e49942011-04-11 20:45:32 +00004710- CONFIG_IDE_AHB:
4711 Most IDE controllers were designed to be connected with PCI
4712 interface. Only few of them were designed for AHB interface.
4713 When software is doing ATA command and data transfer to
4714 IDE devices through IDE-AHB controller, some additional
4715 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004716 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004718- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004719 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004720 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004722- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004723
wdenkeb20ad32003-09-05 23:19:14 +00004724 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004725 initial data and stack; please note that this must be
4726 writable memory that is working WITHOUT special
4727 initialization, i. e. you CANNOT use normal RAM which
4728 will become available only after programming the
4729 memory controller and running certain initialization
4730 sequences.
4731
4732 U-Boot uses the following memory types:
4733 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4734 - MPC824X: data cache
4735 - PPC4xx: data cache
4736
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004737- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004738
4739 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004740 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4741 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004742 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004743 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004744 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4745 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4746 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004747
4748 Note:
4749 On the MPC824X (or other systems that use the data
4750 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004751 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004752 point to an otherwise UNUSED address space between
4753 the top of RAM and the start of the PCI space.
4754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004755- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004757- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004758
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004759- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004761- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004762
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004763- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004765- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004767- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004768 SDRAM timing
4769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004770- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004771 periodic timer for refresh
4772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004773- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004774
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004775- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4776 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4777 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4778 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004779 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4780
4781- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004782 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4783 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004784 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004786- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4787 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004788 Machine Mode Register and Memory Periodic Timer
4789 Prescaler definitions (SDRAM timing)
4790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004791- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004792 enable I2C microcode relocation patch (MPC8xx);
4793 define relocation offset in DPRAM [DSP2]
4794
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004795- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004796 enable SMC microcode relocation patch (MPC8xx);
4797 define relocation offset in DPRAM [SMC1]
4798
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004799- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004800 enable SPI microcode relocation patch (MPC8xx);
4801 define relocation offset in DPRAM [SCC4]
4802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004803- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004804 Use OSCM clock mode on MBX8xx board. Be careful,
4805 wrong setting might damage your board. Read
4806 doc/README.MBX before setting this variable!
4807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004808- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004809 Offset of the bootmode word in DPRAM used by post
4810 (Power On Self Tests). This definition overrides
4811 #define'd default value in commproc.h resp.
4812 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004814- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4815 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4816 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4817 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4818 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4819 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4820 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4821 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004822 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004823
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004824- CONFIG_PCI_DISABLE_PCIE:
4825 Disable PCI-Express on systems where it is supported but not
4826 required.
4827
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004828- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004829 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004830 Don't do any setup work, presumably because someone or
4831 something has already done it, and we don't need to do it
4832 a second time. Useful for platforms that are pre-booted
4833 by coreboot or similar.
4834
Gabor Juhosb4458732013-05-30 07:06:12 +00004835- CONFIG_PCI_INDIRECT_BRIDGE:
4836 Enable support for indirect PCI bridges.
4837
Kumar Gala8975d7a2010-12-30 12:09:53 -06004838- CONFIG_SYS_SRIO:
4839 Chip has SRIO or not
4840
4841- CONFIG_SRIO1:
4842 Board has SRIO 1 port available
4843
4844- CONFIG_SRIO2:
4845 Board has SRIO 2 port available
4846
Liu Gang27afb9c2013-05-07 16:30:46 +08004847- CONFIG_SRIO_PCIE_BOOT_MASTER
4848 Board can support master function for Boot from SRIO and PCIE
4849
Kumar Gala8975d7a2010-12-30 12:09:53 -06004850- CONFIG_SYS_SRIOn_MEM_VIRT:
4851 Virtual Address of SRIO port 'n' memory region
4852
4853- CONFIG_SYS_SRIOn_MEM_PHYS:
4854 Physical Address of SRIO port 'n' memory region
4855
4856- CONFIG_SYS_SRIOn_MEM_SIZE:
4857 Size of SRIO port 'n' memory region
4858
Fabio Estevamf17e8782013-04-11 09:35:34 +00004859- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4860 Defined to tell the NAND controller that the NAND chip is using
4861 a 16 bit bus.
4862 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004863 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004864 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004865 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004866
4867- CONFIG_SYS_NDFC_EBC0_CFG
4868 Sets the EBC0_CFG register for the NDFC. If not defined
4869 a default value will be used.
4870
Ben Warren45657152006-09-07 16:50:54 -04004871- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004872 Get DDR timing information from an I2C EEPROM. Common
4873 with pluggable memory modules such as SODIMMs
4874
Ben Warren45657152006-09-07 16:50:54 -04004875 SPD_EEPROM_ADDRESS
4876 I2C address of the SPD EEPROM
4877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004878- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004879 If SPD EEPROM is on an I2C bus other than the first
4880 one, specify here. Note that the value must resolve
4881 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004882
York Sune73cc042011-06-07 09:42:16 +08004883- CONFIG_SYS_DDR_RAW_TIMING
4884 Get DDR timing information from other than SPD. Common with
4885 soldered DDR chips onboard without SPD. DDR raw timing
4886 parameters are extracted from datasheet and hard-coded into
4887 header files or board specific files.
4888
York Sunbd495cf2011-09-16 13:21:35 -07004889- CONFIG_FSL_DDR_INTERACTIVE
4890 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4891
York Sun8ced0502015-01-06 13:18:55 -08004892- CONFIG_FSL_DDR_SYNC_REFRESH
4893 Enable sync of refresh for multiple controllers.
4894
York Sunb6a35f82015-03-19 09:30:28 -07004895- CONFIG_FSL_DDR_BIST
4896 Enable built-in memory test for Freescale DDR controllers.
4897
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004898- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004899 Only for 83xx systems. If specified, then DDR should
4900 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004901
wdenk6203e402004-04-18 10:13:26 +00004902- CONFIG_ETHER_ON_FEC[12]
4903 Define to enable FEC[12] on a 8xx series processor.
4904
4905- CONFIG_FEC[12]_PHY
4906 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004907 to the given FEC; i. e.
4908 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004909 means that the PHY with address 4 is connected to FEC1
4910
4911 When set to -1, means to probe for first available.
4912
4913- CONFIG_FEC[12]_PHY_NORXERR
4914 The PHY does not have a RXERR line (RMII only).
4915 (so program the FEC to ignore it).
4916
4917- CONFIG_RMII
4918 Enable RMII mode for all FECs.
4919 Note that this is a global option, we can't
4920 have one FEC in standard MII mode and another in RMII mode.
4921
wdenk20c98a62004-04-23 20:32:05 +00004922- CONFIG_CRC32_VERIFY
4923 Add a verify option to the crc32 command.
4924 The syntax is:
4925
4926 => crc32 -v <address> <count> <crc32>
4927
4928 Where address/count indicate a memory area
4929 and crc32 is the correct crc32 which the
4930 area should have.
4931
wdenk64519362004-07-11 17:40:54 +00004932- CONFIG_LOOPW
4933 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004934 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004935
stroesecc3af832004-12-16 18:46:55 +00004936- CONFIG_MX_CYCLIC
4937 Add the "mdc" and "mwc" memory commands. These are cyclic
4938 "md/mw" commands.
4939 Examples:
4940
wdenk07d7e6b2004-12-16 21:44:03 +00004941 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004942 This command will print 4 bytes (10,11,12,13) each 500 ms.
4943
wdenk07d7e6b2004-12-16 21:44:03 +00004944 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004945 This command will write 12345678 to address 100 all 10 ms.
4946
wdenk07d7e6b2004-12-16 21:44:03 +00004947 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004948 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004949
wdenk3d3d99f2005-04-04 12:44:11 +00004950- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004951 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004952 low level initializations (like setting up the memory
4953 controller) are omitted and/or U-Boot does not
4954 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004955
Wolfgang Denk302141d2010-11-27 23:30:56 +01004956 Normally this variable MUST NOT be defined. The only
4957 exception is when U-Boot is loaded (to RAM) by some
4958 other boot loader or by a debugger which performs
4959 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004960
Aneesh V552a3192011-07-13 05:11:07 +00004961- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004962 Modifies the behaviour of start.S when compiling a loader
4963 that is executed before the actual U-Boot. E.g. when
4964 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004965
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004966- CONFIG_TPL_BUILD
4967 Modifies the behaviour of start.S when compiling a loader
4968 that is executed after the SPL and before the actual U-Boot.
4969 It is loaded by the SPL.
4970
Ying Zhang0d4f5442013-05-20 14:07:23 +08004971- CONFIG_SYS_MPC85XX_NO_RESETVEC
4972 Only for 85xx systems. If this variable is specified, the section
4973 .resetvec is not kept and the section .bootpg is placed in the
4974 previous 4k of the .text section.
4975
Simon Glass17dabf02013-02-24 17:33:14 +00004976- CONFIG_ARCH_MAP_SYSMEM
4977 Generally U-Boot (and in particular the md command) uses
4978 effective address. It is therefore not necessary to regard
4979 U-Boot address as virtual addresses that need to be translated
4980 to physical addresses. However, sandbox requires this, since
4981 it maintains its own little RAM buffer which contains all
4982 addressable memory. This option causes some memory accesses
4983 to be mapped through map_sysmem() / unmap_sysmem().
4984
Matthias Weisser93416c12011-03-10 21:36:32 +00004985- CONFIG_USE_ARCH_MEMCPY
4986 CONFIG_USE_ARCH_MEMSET
4987 If these options are used a optimized version of memcpy/memset will
4988 be used if available. These functions may be faster under some
4989 conditions but may increase the binary size.
4990
Simon Glassbfb59802013-02-14 04:18:54 +00004991- CONFIG_X86_RESET_VECTOR
4992 If defined, the x86 reset vector code is included. This is not
4993 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004994
Mark Jackson52b003c2013-03-04 01:27:20 +00004995- CONFIG_SYS_MPUCLK
4996 Defines the MPU clock speed (in MHz).
4997
4998 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004999
Heiko Schocher2233e462013-11-04 14:05:00 +01005000- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5001 Enables the RTC32K OSC on AM33xx based plattforms
5002
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04005003- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5004 Option to disable subpage write in NAND driver
5005 driver that uses this:
5006 drivers/mtd/nand/davinci_nand.c
5007
Timur Tabi275f4bb2011-11-22 09:21:25 -06005008Freescale QE/FMAN Firmware Support:
5009-----------------------------------
5010
5011The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5012loading of "firmware", which is encoded in the QE firmware binary format.
5013This firmware often needs to be loaded during U-Boot booting, so macros
5014are used to identify the storage device (NOR flash, SPI, etc) and the address
5015within that device.
5016
Zhao Qiang83a90842014-03-21 16:21:44 +08005017- CONFIG_SYS_FMAN_FW_ADDR
5018 The address in the storage device where the FMAN microcode is located. The
5019 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5020 is also specified.
5021
5022- CONFIG_SYS_QE_FW_ADDR
5023 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005024 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5025 is also specified.
5026
5027- CONFIG_SYS_QE_FMAN_FW_LENGTH
5028 The maximum possible size of the firmware. The firmware binary format
5029 has a field that specifies the actual size of the firmware, but it
5030 might not be possible to read any part of the firmware unless some
5031 local storage is allocated to hold the entire firmware first.
5032
5033- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5034 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5035 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5036 virtual address in NOR flash.
5037
5038- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5039 Specifies that QE/FMAN firmware is located in NAND flash.
5040 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5041
5042- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5043 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5044 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5045
5046- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5047 Specifies that QE/FMAN firmware is located on the primary SPI
5048 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5049
Liu Gang1e084582012-03-08 00:33:18 +00005050- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5051 Specifies that QE/FMAN firmware is located in the remote (master)
5052 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005053 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5054 window->master inbound window->master LAW->the ucode address in
5055 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005056
J. German Rivera8ff14b72014-06-23 15:15:55 -07005057Freescale Layerscape Management Complex Firmware Support:
5058---------------------------------------------------------
5059The Freescale Layerscape Management Complex (MC) supports the loading of
5060"firmware".
5061This firmware often needs to be loaded during U-Boot booting, so macros
5062are used to identify the storage device (NOR flash, SPI, etc) and the address
5063within that device.
5064
5065- CONFIG_FSL_MC_ENET
5066 Enable the MC driver for Layerscape SoCs.
5067
5068- CONFIG_SYS_LS_MC_FW_ADDR
5069 The address in the storage device where the firmware is located. The
5070 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5071 is also specified.
5072
5073- CONFIG_SYS_LS_MC_FW_LENGTH
5074 The maximum possible size of the firmware. The firmware binary format
5075 has a field that specifies the actual size of the firmware, but it
5076 might not be possible to read any part of the firmware unless some
5077 local storage is allocated to hold the entire firmware first.
5078
5079- CONFIG_SYS_LS_MC_FW_IN_NOR
5080 Specifies that MC firmware is located in NOR flash, mapped as
5081 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5082 virtual address in NOR flash.
5083
wdenkc6097192002-11-03 00:24:07 +00005084Building the Software:
5085======================
5086
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005087Building U-Boot has been tested in several native build environments
5088and in many different cross environments. Of course we cannot support
5089all possibly existing versions of cross development tools in all
5090(potentially obsolete) versions. In case of tool chain problems we
5091recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5092which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005093
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005094If you are not using a native environment, it is assumed that you
5095have GNU cross compiling tools available in your path. In this case,
5096you must set the environment variable CROSS_COMPILE in your shell.
5097Note that no changes to the Makefile or any other source files are
5098necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005099
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005100 $ CROSS_COMPILE=ppc_4xx-
5101 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005102
Peter Tyserb06976d2009-03-13 18:54:51 -05005103Note: If you wish to generate Windows versions of the utilities in
5104 the tools directory you can use the MinGW toolchain
5105 (http://www.mingw.org). Set your HOST tools to the MinGW
5106 toolchain and execute 'make tools'. For example:
5107
5108 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5109
5110 Binaries such as tools/mkimage.exe will be created which can
5111 be executed on computers running Windows.
5112
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005113U-Boot is intended to be simple to build. After installing the
5114sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005115is done by typing:
5116
Holger Freyther7ba4e572014-08-04 09:26:05 +02005117 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005118
Holger Freyther7ba4e572014-08-04 09:26:05 +02005119where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005120rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005121
wdenk6c59edc2004-05-03 20:45:30 +00005122Note: for some board special configuration names may exist; check if
5123 additional information is available from the board vendor; for
5124 instance, the TQM823L systems are available without (standard)
5125 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005126 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005127
Holger Freyther7ba4e572014-08-04 09:26:05 +02005128 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005129 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005130
Holger Freyther7ba4e572014-08-04 09:26:05 +02005131 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005132 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134 etc.
wdenkc6097192002-11-03 00:24:07 +00005135
wdenkc6097192002-11-03 00:24:07 +00005136
wdenk6c59edc2004-05-03 20:45:30 +00005137Finally, type "make all", and you should get some working U-Boot
5138images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140- "u-boot.bin" is a raw binary image
5141- "u-boot" is an image in ELF binary format
5142- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005143
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005144By default the build is performed locally and the objects are saved
5145in the source directory. One of the two methods can be used to change
5146this behavior and build U-Boot to some external directory:
5147
51481. Add O= to the make command line invocations:
5149
5150 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005151 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005152 make O=/tmp/build all
5153
Timo Ketolac8c67602014-11-06 14:39:05 +020051542. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005155
Timo Ketolac8c67602014-11-06 14:39:05 +02005156 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005157 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005158 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005159 make all
5160
Timo Ketolac8c67602014-11-06 14:39:05 +02005161Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005162variable.
5163
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165Please be aware that the Makefiles assume you are using GNU make, so
5166for instance on NetBSD you might need to use "gmake" instead of
5167native "make".
wdenkc6097192002-11-03 00:24:07 +00005168
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170If the system board that you have is not listed, then you will need
5171to port U-Boot to your hardware platform. To do this, follow these
5172steps:
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +000051741. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005175 "boards.cfg" file, using the existing entries as examples.
5176 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000051772. Create a new directory to hold your board specific code. Add any
5178 files you need. In your board directory, you will need at least
5179 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51803. Create a new configuration file "include/configs/<board>.h" for
5181 your board
51823. If you're porting U-Boot to a new CPU, then also create a new
5183 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051844. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051855. Type "make", and you should get a working "u-boot.srec" file
5186 to be installed on your target system.
51876. Debug and solve any problems that might arise.
5188 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005189
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5192==============================================================
wdenkc6097192002-11-03 00:24:07 +00005193
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005194If you have modified U-Boot sources (for instance added a new board
5195or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005196provide feedback to the other developers. The feedback normally takes
5197the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005198official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005199
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005200But before you submit such a patch, please verify that your modifi-
5201cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005202the supported boards compile WITHOUT ANY compiler warnings. To do so,
5203just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005204for ALL supported system. Be warned, this will take a while. You can
5205select which (cross) compiler to use by passing a `CROSS_COMPILE'
5206environment variable to the script, i. e. to use the ELDK cross tools
5207you can type
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005215When using the MAKEALL script, the default behaviour is to build
5216U-Boot in the source directory. This location can be changed by
5217setting the BUILD_DIR environment variable. Also, for each target
5218built, the MAKEALL script saves two log files (<target>.ERR and
5219<target>.MAKEALL) in the <source dir>/LOG directory. This default
5220location can be changed by setting the MAKEALL_LOGDIR environment
5221variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005222
5223 export BUILD_DIR=/tmp/build
5224 export MAKEALL_LOGDIR=/tmp/log
5225 CROSS_COMPILE=ppc_8xx- MAKEALL
5226
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005227With the above settings build objects are saved in the /tmp/build,
5228log files are saved in the /tmp/log and the source tree remains clean
5229during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005230
5231
wdenk6c59edc2004-05-03 20:45:30 +00005232See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005233
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk6c59edc2004-05-03 20:45:30 +00005235Monitor Commands - Overview:
5236============================
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238go - start application at address 'addr'
5239run - run commands in an environment variable
5240bootm - boot application image from memory
5241bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005242bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005243tftpboot- boot image via network using TFTP protocol
5244 and env variables "ipaddr" and "serverip"
5245 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005246tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005247rarpboot- boot image via network using RARP/TFTP protocol
5248diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5249loads - load S-Record file over serial line
5250loadb - load binary file over serial line (kermit mode)
5251md - memory display
5252mm - memory modify (auto-incrementing)
5253nm - memory modify (constant address)
5254mw - memory write (fill)
5255cp - memory copy
5256cmp - memory compare
5257crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005258i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005259sspi - SPI utility commands
5260base - print or set address offset
5261printenv- print environment variables
5262setenv - set environment variables
5263saveenv - save environment variables to persistent storage
5264protect - enable or disable FLASH write protection
5265erase - erase FLASH memory
5266flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005267nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005268bdinfo - print Board Info structure
5269iminfo - print header information for application image
5270coninfo - print console devices and informations
5271ide - IDE sub-system
5272loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005273loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005274mtest - simple RAM test
5275icache - enable or disable instruction cache
5276dcache - enable or disable data cache
5277reset - Perform RESET of the CPU
5278echo - echo args to console
5279version - print monitor version
5280help - print online help
5281? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005282
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284Monitor Commands - Detailed Description:
5285========================================
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287TODO.
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005290
5291
wdenk6c59edc2004-05-03 20:45:30 +00005292Environment Variables:
5293======================
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295U-Boot supports user configuration using Environment Variables which
5296can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk6c59edc2004-05-03 20:45:30 +00005298Environment Variables are set using "setenv", printed using
5299"printenv", and saved to Flash using "saveenv". Using "setenv"
5300without a value can be used to delete a variable from the
5301environment. As long as you don't save the environment you are
5302working with an in-memory copy. In case the Flash area containing the
5303environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005304
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005305Some configuration options can be set using Environment Variables.
5306
5307List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk6c59edc2004-05-03 20:45:30 +00005317 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005318
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005319 bootm_low - Memory range available for image processing in the bootm
5320 command can be restricted. This variable is given as
5321 a hexadecimal number and defines lowest address allowed
5322 for use by the bootm command. See also "bootm_size"
5323 environment variable. Address defined by "bootm_low" is
5324 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005325 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5326 bootm_mapsize.
5327
Wolfgang Denk092ae952011-10-26 10:21:21 +00005328 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005329 This variable is given as a hexadecimal number and it
5330 defines the size of the memory region starting at base
5331 address bootm_low that is accessible by the Linux kernel
5332 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5333 as the default value if it is defined, and bootm_size is
5334 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005335
5336 bootm_size - Memory range available for image processing in the bootm
5337 command can be restricted. This variable is given as
5338 a hexadecimal number and defines the size of the region
5339 allowed for use by the bootm command. See also "bootm_low"
5340 environment variable.
5341
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005342 updatefile - Location of the software update file on a TFTP server, used
5343 by the automatic software update feature. Please refer to
5344 documentation in doc/README.update for more details.
5345
wdenk6c59edc2004-05-03 20:45:30 +00005346 autoload - if set to "no" (any string beginning with 'n'),
5347 "bootp" will just load perform a lookup of the
5348 configuration from the BOOTP server, but not try to
5349 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 autostart - if set to "yes", an image loaded using the "bootp",
5352 "rarpboot", "tftpboot" or "diskboot" commands will
5353 be automatically started (by internally calling
5354 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356 If set to "no", a standalone image passed to the
5357 "bootm" command will be copied to the load address
5358 (and eventually uncompressed), but NOT be started.
5359 This can be used to load and uncompress arbitrary
5360 data.
wdenkc6097192002-11-03 00:24:07 +00005361
David A. Longd558a4e2011-07-09 16:40:19 -04005362 fdt_high - if set this restricts the maximum address that the
5363 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005364 For example, if you have a system with 1 GB memory
5365 at physical address 0x10000000, while Linux kernel
5366 only recognizes the first 704 MB as low memory, you
5367 may need to set fdt_high as 0x3C000000 to have the
5368 device tree blob be copied to the maximum address
5369 of the 704 MB low memory, so that Linux kernel can
5370 access it during the boot procedure.
5371
David A. Longd558a4e2011-07-09 16:40:19 -04005372 If this is set to the special value 0xFFFFFFFF then
5373 the fdt will not be copied at all on boot. For this
5374 to work it must reside in writable memory, have
5375 sufficient padding on the end of it for u-boot to
5376 add the information it needs into it, and the memory
5377 must be accessible by the kernel.
5378
Simon Glassdc6fa642011-10-24 19:15:34 +00005379 fdtcontroladdr- if set this is the address of the control flattened
5380 device tree used by U-Boot when CONFIG_OF_CONTROL is
5381 defined.
5382
wdenk0e2bd9c2004-06-06 21:51:03 +00005383 i2cfast - (PPC405GP|PPC405EP only)
5384 if set to 'y' configures Linux I2C driver for fast
5385 mode (400kHZ). This environment variable is used in
5386 initialization code. So, for changes to be effective
5387 it must be saved and board must be reset.
5388
wdenk6c59edc2004-05-03 20:45:30 +00005389 initrd_high - restrict positioning of initrd images:
5390 If this variable is not set, initrd images will be
5391 copied to the highest possible address in RAM; this
5392 is usually what you want since it allows for
5393 maximum initrd size. If for some reason you want to
5394 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005395 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005396 variable to a value of "no" or "off" or "0".
5397 Alternatively, you can set it to a maximum upper
5398 address to use (U-Boot will still check that it
5399 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401 For instance, when you have a system with 16 MB
5402 RAM, and want to reserve 4 MB from use by Linux,
5403 you can do this by adding "mem=12M" to the value of
5404 the "bootargs" variable. However, now you must make
5405 sure that the initrd image is placed in the first
5406 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk6c59edc2004-05-03 20:45:30 +00005408 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410 If you set initrd_high to 0xFFFFFFFF, this is an
5411 indication to U-Boot that all addresses are legal
5412 for the Linux kernel, including addresses in flash
5413 memory. In this case U-Boot will NOT COPY the
5414 ramdisk at all. This may be useful to reduce the
5415 boot time on your system, but requires that this
5416 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420 loadaddr - Default load address for commands like "bootp",
5421 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005424
wdenk6c59edc2004-05-03 20:45:30 +00005425 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005426
wdenk6c59edc2004-05-03 20:45:30 +00005427 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk6c59edc2004-05-03 20:45:30 +00005429 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005432
Mike Frysingera23230c2011-10-02 10:01:27 +00005433 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005434
Mike Frysingera23230c2011-10-02 10:01:27 +00005435 ethact - controls which interface is currently active.
5436 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005437
Heiko Schocherc5e84052010-07-20 17:45:02 +02005438 => setenv ethact FEC
5439 => ping 192.168.0.1 # traffic sent on FEC
5440 => setenv ethact SCC
5441 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005442
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005443 ethrotate - When set to "no" U-Boot does not go through all
5444 available network interfaces.
5445 It just stays at the currently selected interface.
5446
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005447 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005448 either succeed or fail without retrying.
5449 When set to "once" the network operation will
5450 fail when all the available network interfaces
5451 are tried once without success.
5452 Useful on scripts which control the retry operation
5453 themselves.
wdenkc6097192002-11-03 00:24:07 +00005454
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005455 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005456
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005457 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005458 changing the console to be empty. If "yes" it will be
5459 made silent. If "no" it will not be made silent. If
5460 unset, then it will be made silent if the U-Boot console
5461 is silent.
5462
Wolfgang Denk227b5192005-09-24 23:25:46 +02005463 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005464 UDP source port.
5465
Wolfgang Denk227b5192005-09-24 23:25:46 +02005466 tftpdstport - If this is set, the value is used for TFTP's UDP
5467 destination port instead of the Well Know Port 69.
5468
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005469 tftpblocksize - Block size to use for TFTP transfers; if not set,
5470 we use the TFTP server's default block size
5471
5472 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5473 seconds, minimum value is 1000 = 1 second). Defines
5474 when a packet is considered to be lost so it has to
5475 be retransmitted. The default is 5000 = 5 seconds.
5476 Lowering this value may make downloads succeed
5477 faster in networks with high packet loss rates or
5478 with unreliable TFTP servers.
5479
5480 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005481 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005482 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005483
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005484The following image location variables contain the location of images
5485used in booting. The "Image" column gives the role of the image and is
5486not an environment variable name. The other columns are environment
5487variable names. "File Name" gives the name of the file on a TFTP
5488server, "RAM Address" gives the location in RAM the image will be
5489loaded to, and "Flash Location" gives the image's address in NOR
5490flash or offset in NAND flash.
5491
5492*Note* - these variables don't have to be defined for all boards, some
5493boards currenlty use other variables for these purposes, and some
5494boards use these variables for other purposes.
5495
Wolfgang Denk092ae952011-10-26 10:21:21 +00005496Image File Name RAM Address Flash Location
5497----- --------- ----------- --------------
5498u-boot u-boot u-boot_addr_r u-boot_addr
5499Linux kernel bootfile kernel_addr_r kernel_addr
5500device tree blob fdtfile fdt_addr_r fdt_addr
5501ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005502
wdenk6c59edc2004-05-03 20:45:30 +00005503The following environment variables may be used and automatically
5504updated by the network boot commands ("bootp" and "rarpboot"),
5505depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507 bootfile - see above
5508 dnsip - IP address of your Domain Name Server
5509 dnsip2 - IP address of your secondary Domain Name Server
5510 gatewayip - IP address of the Gateway (Router) to use
5511 hostname - Target hostname
5512 ipaddr - see above
5513 netmask - Subnet Mask
5514 rootpath - Pathname of the root filesystem on the NFS server
5515 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005516
wdenk145d2c12004-04-15 21:48:45 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520 serial# - contains hardware identification information such
5521 as type string and/or serial number
5522 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005523
wdenk6c59edc2004-05-03 20:45:30 +00005524These variables can be set only once (usually during manufacturing of
5525the board). U-Boot refuses to delete or overwrite these variables
5526once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005527
5528
wdenk6c59edc2004-05-03 20:45:30 +00005529Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531 ver - Contains the U-Boot version string as printed
5532 with the "version" command. This variable is
5533 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005534
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk6c59edc2004-05-03 20:45:30 +00005536Please note that changes to some configuration parameters may take
5537only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005538
stroeseb9c17c52003-04-04 15:53:41 +00005539
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005540Callback functions for environment variables:
5541---------------------------------------------
5542
5543For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005544when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005545be associated with arbitrary variables. On creation, overwrite, or
5546deletion, the callback will provide the opportunity for some side
5547effect to happen or for the change to be rejected.
5548
5549The callbacks are named and associated with a function using the
5550U_BOOT_ENV_CALLBACK macro in your board or driver code.
5551
5552These callbacks are associated with variables in one of two ways. The
5553static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5554in the board configuration to a string that defines a list of
5555associations. The list must be in the following format:
5556
5557 entry = variable_name[:callback_name]
5558 list = entry[,list]
5559
5560If the callback name is not specified, then the callback is deleted.
5561Spaces are also allowed anywhere in the list.
5562
5563Callbacks can also be associated by defining the ".callbacks" variable
5564with the same list format above. Any association in ".callbacks" will
5565override any association in the static list. You can define
5566CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005567".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005568
5569
wdenk6c59edc2004-05-03 20:45:30 +00005570Command Line Parsing:
5571=====================
stroeseb9c17c52003-04-04 15:53:41 +00005572
wdenk6c59edc2004-05-03 20:45:30 +00005573There are two different command line parsers available with U-Boot:
5574the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576Old, simple command line parser:
5577--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579- supports environment variables (through setenv / saveenv commands)
5580- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005581- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005582- special characters ('$', ';') can be escaped by prefixing with '\',
5583 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005584 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005585- You can also escape text by enclosing in single apostrophes, for example:
5586 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005587
wdenk6c59edc2004-05-03 20:45:30 +00005588Hush shell:
5589-----------
wdenkf4688a22003-05-28 08:06:31 +00005590
wdenk6c59edc2004-05-03 20:45:30 +00005591- similar to Bourne shell, with control structures like
5592 if...then...else...fi, for...do...done; while...do...done,
5593 until...do...done, ...
5594- supports environment ("global") variables (through setenv / saveenv
5595 commands) and local shell variables (through standard shell syntax
5596 "name=value"); only environment variables can be used with "run"
5597 command
wdenkf4688a22003-05-28 08:06:31 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599General rules:
5600--------------
wdenkf4688a22003-05-28 08:06:31 +00005601
wdenk6c59edc2004-05-03 20:45:30 +00005602(1) If a command line (or an environment variable executed by a "run"
5603 command) contains several commands separated by semicolon, and
5604 one of these commands fails, then the remaining commands will be
5605 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005608 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005609 command will cause "run" to terminate, i. e. the remaining
5610 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612Note for Redundant Ethernet Interfaces:
5613=======================================
wdenkf4688a22003-05-28 08:06:31 +00005614
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005615Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005616such configurations and is capable of automatic selection of a
5617"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005618
wdenk6c59edc2004-05-03 20:45:30 +00005619Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5620MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5621"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623If the network interface stores some valid MAC address (for instance
5624in SROM), this is used as default address if there is NO correspon-
5625ding setting in the environment; if the corresponding environment
5626variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628o If the SROM has a valid MAC address, and there is no address in the
5629 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631o If there is no valid address in the SROM, and a definition in the
5632 environment exists, then the value from the environment variable is
5633 used.
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk6c59edc2004-05-03 20:45:30 +00005635o If both the SROM and the environment contain a MAC address, and
5636 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638o If both the SROM and the environment contain a MAC address, and the
5639 addresses differ, the value from the environment is used and a
5640 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642o If neither SROM nor the environment contain a MAC address, an error
5643 is raised.
wdenkc6097192002-11-03 00:24:07 +00005644
Ben Warren6db991a2010-04-26 11:11:46 -07005645If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005646will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005647may be skipped by setting the appropriate 'ethmacskip' environment variable.
5648The naming convention is as follows:
5649"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005650
wdenk6c59edc2004-05-03 20:45:30 +00005651Image Formats:
5652==============
wdenkc6097192002-11-03 00:24:07 +00005653
Marian Balakowicz18710b82008-03-12 12:13:13 +01005654U-Boot is capable of booting (and performing other auxiliary operations on)
5655images in two formats:
5656
5657New uImage format (FIT)
5658-----------------------
5659
5660Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5661to Flattened Device Tree). It allows the use of images with multiple
5662components (several kernels, ramdisks, etc.), with contents protected by
5663SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5664
5665
5666Old uImage format
5667-----------------
5668
5669Old image format is based on binary files which can be basically anything,
5670preceded by a special header; see the definitions in include/image.h for
5671details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005672
wdenk6c59edc2004-05-03 20:45:30 +00005673* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5674 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005675 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5676 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5677 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005678* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005679 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5680 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005681* Compression Type (uncompressed, gzip, bzip2)
5682* Load Address
5683* Entry Point
5684* Image Name
5685* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687The header is marked by a special Magic Number, and both the header
5688and the data portions of the image are secured against corruption by
5689CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005690
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692Linux Support:
5693==============
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695Although U-Boot should support any OS or standalone application
5696easily, the main focus has always been on Linux during the design of
5697U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005698
wdenk6c59edc2004-05-03 20:45:30 +00005699U-Boot includes many features that so far have been part of some
5700special "boot loader" code within the Linux kernel. Also, any
5701"initrd" images to be used are no longer part of one big Linux image;
5702instead, kernel and "initrd" are separate images. This implementation
5703serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705- the same features can be used for other OS or standalone
5706 applications (for instance: using compressed images to reduce the
5707 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709- it becomes much easier to port new Linux kernel versions because
5710 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk6c59edc2004-05-03 20:45:30 +00005712- the same Linux kernel image can now be used with different "initrd"
5713 images; of course this also means that different kernel images can
5714 be run with the same "initrd". This makes testing easier (you don't
5715 have to build a new "zImage.initrd" Linux image when you just
5716 change a file in your "initrd"). Also, a field-upgrade of the
5717 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005718
wdenkc6097192002-11-03 00:24:07 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720Linux HOWTO:
5721============
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk6c59edc2004-05-03 20:45:30 +00005723Porting Linux to U-Boot based systems:
5724---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005725
wdenk6c59edc2004-05-03 20:45:30 +00005726U-Boot cannot save you from doing all the necessary modifications to
5727configure the Linux device drivers for use with your target hardware
5728(no, we don't intend to provide a full virtual machine interface to
5729Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005730
Stefan Roese88fbf932010-04-15 16:07:28 +02005731But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733Just make sure your machine specific header file (for instance
5734include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005735Information structure as we define in include/asm-<arch>/u-boot.h,
5736and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005737as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005738
Simon Glassd097e592014-06-11 23:29:46 -06005739Note that U-Boot now has a driver model, a unified model for drivers.
5740If you are adding a new driver, plumb it into driver model. If there
5741is no uclass available, you are encouraged to create one. See
5742doc/driver-model.
5743
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745Configuring the Linux kernel:
5746-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748No specific requirements for U-Boot. Make sure you have some root
5749device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005750
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk6c59edc2004-05-03 20:45:30 +00005752Building a Linux Image:
5753-----------------------
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5756not used. If you use recent kernel source, a new build target
5757"uImage" will exist which automatically builds an image usable by
5758U-Boot. Most older kernels also have support for a "pImage" target,
5759which was introduced for our predecessor project PPCBoot and uses a
5760100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762Example:
wdenkc6097192002-11-03 00:24:07 +00005763
Holger Freyther7ba4e572014-08-04 09:26:05 +02005764 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005765 make oldconfig
5766 make dep
5767 make uImage
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769The "uImage" build target uses a special tool (in 'tools/mkimage') to
5770encapsulate a compressed Linux kernel image with header information,
5771CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005774
wdenk6c59edc2004-05-03 20:45:30 +00005775* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005776
wdenk6c59edc2004-05-03 20:45:30 +00005777 ${CROSS_COMPILE}-objcopy -O binary \
5778 -R .note -R .comment \
5779 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005780
wdenk6c59edc2004-05-03 20:45:30 +00005781* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787 mkimage -A ppc -O linux -T kernel -C gzip \
5788 -a 0 -e 0 -n "Linux Kernel Image" \
5789 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005790
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792The "mkimage" tool can also be used to create ramdisk images for use
5793with U-Boot, either separated from the Linux kernel image, or
5794combined into one file. "mkimage" encapsulates the images with a 64
5795byte header containing information about target architecture,
5796operating system, image type, compression method, entry points, time
5797stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005798
wdenk6c59edc2004-05-03 20:45:30 +00005799"mkimage" can be called in two ways: to verify existing images and
5800print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005801
wdenk6c59edc2004-05-03 20:45:30 +00005802In the first form (with "-l" option) mkimage lists the information
5803contained in the header of an existing U-Boot image; this includes
5804checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806 tools/mkimage -l image
5807 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809The second form (with "-d" option) is used to build a U-Boot image
5810from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005811
wdenk6c59edc2004-05-03 20:45:30 +00005812 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5813 -n name -d data_file image
5814 -A ==> set architecture to 'arch'
5815 -O ==> set operating system to 'os'
5816 -T ==> set image type to 'type'
5817 -C ==> set compression type 'comp'
5818 -a ==> set load address to 'addr' (hex)
5819 -e ==> set entry point to 'ep' (hex)
5820 -n ==> set image name to 'name'
5821 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005822
wdenkcd914452004-05-29 16:53:29 +00005823Right now, all Linux kernels for PowerPC systems use the same load
5824address (0x00000000), but the entry point address depends on the
5825kernel version:
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827- 2.2.x kernels have the entry point at 0x0000000C,
5828- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk6c59edc2004-05-03 20:45:30 +00005830So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5833 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005834 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005835 > examples/uImage.TQM850L
5836 Image Name: 2.4.4 kernel for TQM850L
5837 Created: Wed Jul 19 02:34:59 2000
5838 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5839 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5840 Load Address: 0x00000000
5841 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk6c59edc2004-05-03 20:45:30 +00005843To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845 -> tools/mkimage -l examples/uImage.TQM850L
5846 Image Name: 2.4.4 kernel for TQM850L
5847 Created: Wed Jul 19 02:34:59 2000
5848 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5849 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5850 Load Address: 0x00000000
5851 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853NOTE: for embedded systems where boot time is critical you can trade
5854speed for memory and install an UNCOMPRESSED image instead: this
5855needs more space in Flash, but boots much faster since it does not
5856need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005857
Stefan Roese88fbf932010-04-15 16:07:28 +02005858 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005859 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5860 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005861 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005862 > examples/uImage.TQM850L-uncompressed
5863 Image Name: 2.4.4 kernel for TQM850L
5864 Created: Wed Jul 19 02:34:59 2000
5865 Image Type: PowerPC Linux Kernel Image (uncompressed)
5866 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5867 Load Address: 0x00000000
5868 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005869
wdenkc6097192002-11-03 00:24:07 +00005870
wdenk6c59edc2004-05-03 20:45:30 +00005871Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5872when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk6c59edc2004-05-03 20:45:30 +00005874 -> tools/mkimage -n 'Simple Ramdisk Image' \
5875 > -A ppc -O linux -T ramdisk -C gzip \
5876 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5877 Image Name: Simple Ramdisk Image
5878 Created: Wed Jan 12 14:01:50 2000
5879 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5880 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5881 Load Address: 0x00000000
5882 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005883
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005884The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5885option performs the converse operation of the mkimage's second form (the "-d"
5886option). Given an image built by mkimage, the dumpimage extracts a "data file"
5887from the image:
5888
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005889 tools/dumpimage -i image -T type -p position data_file
5890 -i ==> extract from the 'image' a specific 'data_file'
5891 -T ==> set image type to 'type'
5892 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005893
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk6c59edc2004-05-03 20:45:30 +00005895Installing a Linux Image:
5896-------------------------
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk6c59edc2004-05-03 20:45:30 +00005898To downloading a U-Boot image over the serial (console) interface,
5899you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005900
wdenk6c59edc2004-05-03 20:45:30 +00005901 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903The 'objcopy' does not understand the information in the U-Boot
5904image header, so the resulting S-Record file will be relative to
5905address 0x00000000. To load it to a given address, you need to
5906specify the target address as 'offset' parameter with the 'loads'
5907command.
wdenkc6097192002-11-03 00:24:07 +00005908
wdenk6c59edc2004-05-03 20:45:30 +00005909Example: install the image to address 0x40100000 (which on the
5910TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005911
wdenk6c59edc2004-05-03 20:45:30 +00005912 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914 .......... done
5915 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005916
wdenk6c59edc2004-05-03 20:45:30 +00005917 => loads 40100000
5918 ## Ready for S-Record download ...
5919 ~>examples/image.srec
5920 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5921 ...
5922 15989 15990 15991 15992
5923 [file transfer complete]
5924 [connected]
5925 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005926
wdenkc6097192002-11-03 00:24:07 +00005927
wdenk6c59edc2004-05-03 20:45:30 +00005928You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005929this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005930corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk6c59edc2004-05-03 20:45:30 +00005934 ## Checking Image at 40100000 ...
5935 Image Name: 2.2.13 for initrd on TQM850L
5936 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5937 Data Size: 335725 Bytes = 327 kB = 0 MB
5938 Load Address: 00000000
5939 Entry Point: 0000000c
5940 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005941
5942
wdenk6c59edc2004-05-03 20:45:30 +00005943Boot Linux:
5944-----------
wdenkc6097192002-11-03 00:24:07 +00005945
wdenk6c59edc2004-05-03 20:45:30 +00005946The "bootm" command is used to boot an application that is stored in
5947memory (RAM or Flash). In case of a Linux kernel image, the contents
5948of the "bootargs" environment variable is passed to the kernel as
5949parameters. You can check and modify this variable using the
5950"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005951
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk6c59edc2004-05-03 20:45:30 +00005953 => printenv bootargs
5954 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005955
wdenk6c59edc2004-05-03 20:45:30 +00005956 => 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 +00005957
wdenk6c59edc2004-05-03 20:45:30 +00005958 => printenv bootargs
5959 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 +00005960
wdenk6c59edc2004-05-03 20:45:30 +00005961 => bootm 40020000
5962 ## Booting Linux kernel at 40020000 ...
5963 Image Name: 2.2.13 for NFS on TQM850L
5964 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5965 Data Size: 381681 Bytes = 372 kB = 0 MB
5966 Load Address: 00000000
5967 Entry Point: 0000000c
5968 Verifying Checksum ... OK
5969 Uncompressing Kernel Image ... OK
5970 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
5971 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5972 time_init: decrementer frequency = 187500000/60
5973 Calibrating delay loop... 49.77 BogoMIPS
5974 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5975 ...
wdenkc6097192002-11-03 00:24:07 +00005976
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005977If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005978the memory addresses of both the kernel and the initrd image (PPBCOOT
5979format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005980
wdenk6c59edc2004-05-03 20:45:30 +00005981 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005982
wdenk6c59edc2004-05-03 20:45:30 +00005983 ## Checking Image at 40100000 ...
5984 Image Name: 2.2.13 for initrd on TQM850L
5985 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5986 Data Size: 335725 Bytes = 327 kB = 0 MB
5987 Load Address: 00000000
5988 Entry Point: 0000000c
5989 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005990
wdenk6c59edc2004-05-03 20:45:30 +00005991 ## Checking Image at 40200000 ...
5992 Image Name: Simple Ramdisk Image
5993 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5994 Data Size: 566530 Bytes = 553 kB = 0 MB
5995 Load Address: 00000000
5996 Entry Point: 00000000
5997 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk6c59edc2004-05-03 20:45:30 +00005999 => bootm 40100000 40200000
6000 ## Booting Linux kernel at 40100000 ...
6001 Image Name: 2.2.13 for initrd on TQM850L
6002 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6003 Data Size: 335725 Bytes = 327 kB = 0 MB
6004 Load Address: 00000000
6005 Entry Point: 0000000c
6006 Verifying Checksum ... OK
6007 Uncompressing Kernel Image ... OK
6008 ## Loading RAMDisk Image at 40200000 ...
6009 Image Name: Simple Ramdisk Image
6010 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6011 Data Size: 566530 Bytes = 553 kB = 0 MB
6012 Load Address: 00000000
6013 Entry Point: 00000000
6014 Verifying Checksum ... OK
6015 Loading Ramdisk ... OK
6016 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
6017 Boot arguments: root=/dev/ram
6018 time_init: decrementer frequency = 187500000/60
6019 Calibrating delay loop... 49.77 BogoMIPS
6020 ...
6021 RAMDISK: Compressed image found at block 0
6022 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006023
wdenk6c59edc2004-05-03 20:45:30 +00006024 bash#
wdenkc6097192002-11-03 00:24:07 +00006025
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006026Boot Linux and pass a flat device tree:
6027-----------
6028
6029First, U-Boot must be compiled with the appropriate defines. See the section
6030titled "Linux Kernel Interface" above for a more in depth explanation. The
6031following is an example of how to start a kernel and pass an updated
6032flat device tree:
6033
6034=> print oftaddr
6035oftaddr=0x300000
6036=> print oft
6037oft=oftrees/mpc8540ads.dtb
6038=> tftp $oftaddr $oft
6039Speed: 1000, full duplex
6040Using TSEC0 device
6041TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6042Filename 'oftrees/mpc8540ads.dtb'.
6043Load address: 0x300000
6044Loading: #
6045done
6046Bytes transferred = 4106 (100a hex)
6047=> tftp $loadaddr $bootfile
6048Speed: 1000, full duplex
6049Using TSEC0 device
6050TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6051Filename 'uImage'.
6052Load address: 0x200000
6053Loading:############
6054done
6055Bytes transferred = 1029407 (fb51f hex)
6056=> print loadaddr
6057loadaddr=200000
6058=> print oftaddr
6059oftaddr=0x300000
6060=> bootm $loadaddr - $oftaddr
6061## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006062 Image Name: Linux-2.6.17-dirty
6063 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6064 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006065 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006066 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006067 Verifying Checksum ... OK
6068 Uncompressing Kernel Image ... OK
6069Booting using flat device tree at 0x300000
6070Using MPC85xx ADS machine description
6071Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6072[snip]
6073
6074
wdenk6c59edc2004-05-03 20:45:30 +00006075More About U-Boot Image Types:
6076------------------------------
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006079
wdenk6c59edc2004-05-03 20:45:30 +00006080 "Standalone Programs" are directly runnable in the environment
6081 provided by U-Boot; it is expected that (if they behave
6082 well) you can continue to work in U-Boot after return from
6083 the Standalone Program.
6084 "OS Kernel Images" are usually images of some Embedded OS which
6085 will take over control completely. Usually these programs
6086 will install their own set of exception handlers, device
6087 drivers, set up the MMU, etc. - this means, that you cannot
6088 expect to re-enter U-Boot except by resetting the CPU.
6089 "RAMDisk Images" are more or less just data blocks, and their
6090 parameters (address, size) are passed to an OS kernel that is
6091 being started.
6092 "Multi-File Images" contain several images, typically an OS
6093 (Linux) kernel image and one or more data images like
6094 RAMDisks. This construct is useful for instance when you want
6095 to boot over the network using BOOTP etc., where the boot
6096 server provides just a single image file, but you want to get
6097 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006098
wdenk6c59edc2004-05-03 20:45:30 +00006099 "Multi-File Images" start with a list of image sizes, each
6100 image size (in bytes) specified by an "uint32_t" in network
6101 byte order. This list is terminated by an "(uint32_t)0".
6102 Immediately after the terminating 0 follow the images, one by
6103 one, all aligned on "uint32_t" boundaries (size rounded up to
6104 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk6c59edc2004-05-03 20:45:30 +00006106 "Firmware Images" are binary images containing firmware (like
6107 U-Boot or FPGA images) which usually will be programmed to
6108 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006109
wdenk6c59edc2004-05-03 20:45:30 +00006110 "Script files" are command sequences that will be executed by
6111 U-Boot's command interpreter; this feature is especially
6112 useful when you configure U-Boot to use a real shell (hush)
6113 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006114
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006115Booting the Linux zImage:
6116-------------------------
6117
6118On some platforms, it's possible to boot Linux zImage. This is done
6119using the "bootz" command. The syntax of "bootz" command is the same
6120as the syntax of "bootm" command.
6121
Tom Rini45f46d12013-05-16 11:40:11 -04006122Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006123kernel with raw initrd images. The syntax is slightly different, the
6124address of the initrd must be augmented by it's size, in the following
6125format: "<initrd addres>:<initrd size>".
6126
stroeseb9c17c52003-04-04 15:53:41 +00006127
wdenk6c59edc2004-05-03 20:45:30 +00006128Standalone HOWTO:
6129=================
stroeseb9c17c52003-04-04 15:53:41 +00006130
wdenk6c59edc2004-05-03 20:45:30 +00006131One of the features of U-Boot is that you can dynamically load and
6132run "standalone" applications, which can use some resources of
6133U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006134
wdenk6c59edc2004-05-03 20:45:30 +00006135Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137"Hello World" Demo:
6138-------------------
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk6c59edc2004-05-03 20:45:30 +00006140'examples/hello_world.c' contains a small "Hello World" Demo
6141application; it is automatically compiled when you build U-Boot.
6142It's configured to run at address 0x00040004, so you can play with it
6143like that:
wdenkc6097192002-11-03 00:24:07 +00006144
wdenk6c59edc2004-05-03 20:45:30 +00006145 => loads
6146 ## Ready for S-Record download ...
6147 ~>examples/hello_world.srec
6148 1 2 3 4 5 6 7 8 9 10 11 ...
6149 [file transfer complete]
6150 [connected]
6151 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006152
wdenk6c59edc2004-05-03 20:45:30 +00006153 => go 40004 Hello World! This is a test.
6154 ## Starting application at 0x00040004 ...
6155 Hello World
6156 argc = 7
6157 argv[0] = "40004"
6158 argv[1] = "Hello"
6159 argv[2] = "World!"
6160 argv[3] = "This"
6161 argv[4] = "is"
6162 argv[5] = "a"
6163 argv[6] = "test."
6164 argv[7] = "<NULL>"
6165 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006166
wdenk6c59edc2004-05-03 20:45:30 +00006167 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006168
wdenk6c59edc2004-05-03 20:45:30 +00006169Another example, which demonstrates how to register a CPM interrupt
6170handler with the U-Boot code, can be found in 'examples/timer.c'.
6171Here, a CPM timer is set up to generate an interrupt every second.
6172The interrupt service routine is trivial, just printing a '.'
6173character, but this is just a demo program. The application can be
6174controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006175
wdenk6c59edc2004-05-03 20:45:30 +00006176 ? - print current values og the CPM Timer registers
6177 b - enable interrupts and start timer
6178 e - stop timer and disable interrupts
6179 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk6c59edc2004-05-03 20:45:30 +00006181 => loads
6182 ## Ready for S-Record download ...
6183 ~>examples/timer.srec
6184 1 2 3 4 5 6 7 8 9 10 11 ...
6185 [file transfer complete]
6186 [connected]
6187 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006188
wdenk6c59edc2004-05-03 20:45:30 +00006189 => go 40004
6190 ## Starting application at 0x00040004 ...
6191 TIMERS=0xfff00980
6192 Using timer 1
6193 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195Hit 'b':
6196 [q, b, e, ?] Set interval 1000000 us
6197 Enabling timer
6198Hit '?':
6199 [q, b, e, ?] ........
6200 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6201Hit '?':
6202 [q, b, e, ?] .
6203 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6204Hit '?':
6205 [q, b, e, ?] .
6206 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6207Hit '?':
6208 [q, b, e, ?] .
6209 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6210Hit 'e':
6211 [q, b, e, ?] ...Stopping timer
6212Hit 'q':
6213 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006214
wdenkc6097192002-11-03 00:24:07 +00006215
wdenk6c59edc2004-05-03 20:45:30 +00006216Minicom warning:
6217================
wdenkc6097192002-11-03 00:24:07 +00006218
wdenk6c59edc2004-05-03 20:45:30 +00006219Over time, many people have reported problems when trying to use the
6220"minicom" terminal emulation program for serial download. I (wd)
6221consider minicom to be broken, and recommend not to use it. Under
6222Unix, I recommend to use C-Kermit for general purpose use (and
6223especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006224use "cu" for S-Record download ("loads" command). See
6225http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6226for help with kermit.
6227
wdenkc6097192002-11-03 00:24:07 +00006228
wdenk6c59edc2004-05-03 20:45:30 +00006229Nevertheless, if you absolutely want to use it try adding this
6230configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006231
wdenk6c59edc2004-05-03 20:45:30 +00006232 Name Program Name U/D FullScr IO-Red. Multi
6233 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6234 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006235
wdenk8dba0502003-03-31 16:34:49 +00006236
wdenk6c59edc2004-05-03 20:45:30 +00006237NetBSD Notes:
6238=============
wdenkc6097192002-11-03 00:24:07 +00006239
wdenk6c59edc2004-05-03 20:45:30 +00006240Starting at version 0.9.2, U-Boot supports NetBSD both as host
6241(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006242
wdenk6c59edc2004-05-03 20:45:30 +00006243Building requires a cross environment; it is known to work on
6244NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6245need gmake since the Makefiles are not compatible with BSD make).
6246Note that the cross-powerpc package does not install include files;
6247attempting to build U-Boot will fail because <machine/ansi.h> is
6248missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250 # cd /usr/pkg/cross/powerpc-netbsd/include
6251 # mkdir powerpc
6252 # ln -s powerpc machine
6253 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6254 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006255
wdenk6c59edc2004-05-03 20:45:30 +00006256Native builds *don't* work due to incompatibilities between native
6257and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006258
wdenk6c59edc2004-05-03 20:45:30 +00006259Booting assumes that (the first part of) the image booted is a
6260stage-2 loader which in turn loads and then invokes the kernel
6261proper. Loader sources will eventually appear in the NetBSD source
6262tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006263meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006264
wdenkc6097192002-11-03 00:24:07 +00006265
wdenk6c59edc2004-05-03 20:45:30 +00006266Implementation Internals:
6267=========================
wdenkc6097192002-11-03 00:24:07 +00006268
wdenk6c59edc2004-05-03 20:45:30 +00006269The following is not intended to be a complete description of every
6270implementation detail. However, it should help to understand the
6271inner workings of U-Boot and make it easier to port it to custom
6272hardware.
wdenkc6097192002-11-03 00:24:07 +00006273
wdenkc6097192002-11-03 00:24:07 +00006274
wdenk6c59edc2004-05-03 20:45:30 +00006275Initial Stack, Global Data:
6276---------------------------
wdenkc6097192002-11-03 00:24:07 +00006277
wdenk6c59edc2004-05-03 20:45:30 +00006278The implementation of U-Boot is complicated by the fact that U-Boot
6279starts running out of ROM (flash memory), usually without access to
6280system RAM (because the memory controller is not initialized yet).
6281This means that we don't have writable Data or BSS segments, and BSS
6282is not initialized as zero. To be able to get a C environment working
6283at all, we have to allocate at least a minimal stack. Implementation
6284options for this are defined and restricted by the CPU used: Some CPU
6285models provide on-chip memory (like the IMMR area on MPC8xx and
6286MPC826x processors), on others (parts of) the data cache can be
6287locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006288
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006289 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006290 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006291
wdenk6c59edc2004-05-03 20:45:30 +00006292 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6293 From: "Chris Hallinan" <clh@net1plus.com>
6294 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6295 ...
wdenkc6097192002-11-03 00:24:07 +00006296
wdenk6c59edc2004-05-03 20:45:30 +00006297 Correct me if I'm wrong, folks, but the way I understand it
6298 is this: Using DCACHE as initial RAM for Stack, etc, does not
6299 require any physical RAM backing up the cache. The cleverness
6300 is that the cache is being used as a temporary supply of
6301 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006302 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006303 can see how this works by studying the cache architecture and
6304 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006305
wdenk6c59edc2004-05-03 20:45:30 +00006306 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6307 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006308 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006309 option should work for you. Using CS 4 should be fine if your
6310 board designers haven't used it for something that would
6311 cause you grief during the initial boot! It is frequently not
6312 used.
wdenkc6097192002-11-03 00:24:07 +00006313
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006314 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006315 with your processor/board/system design. The default value
6316 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006317 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006318 than your SDRAM module. If you have a 64MB SDRAM module, set
6319 it above 400_0000. Just make sure your board has no resources
6320 that are supposed to respond to that address! That code in
6321 start.S has been around a while and should work as is when
6322 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006323
wdenk6c59edc2004-05-03 20:45:30 +00006324 -Chris Hallinan
6325 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006326
wdenk6c59edc2004-05-03 20:45:30 +00006327It is essential to remember this, since it has some impact on the C
6328code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006329
wdenk6c59edc2004-05-03 20:45:30 +00006330* Initialized global data (data segment) is read-only. Do not attempt
6331 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006332
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006333* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006334 as zero data - BSS segment) at all - this is undefined, initiali-
6335 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006336
wdenk6c59edc2004-05-03 20:45:30 +00006337* Stack space is very limited. Avoid big data buffers or things like
6338 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006339
wdenk6c59edc2004-05-03 20:45:30 +00006340Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006341normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006342turned out that the implementation of U-Boot can be greatly
6343simplified by making a global data structure (gd_t) available to all
6344functions. We could pass a pointer to this data as argument to _all_
6345functions, but this would bloat the code. Instead we use a feature of
6346the GCC compiler (Global Register Variables) to share the data: we
6347place a pointer (gd) to the global data into a register which we
6348reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006349
wdenk6c59edc2004-05-03 20:45:30 +00006350When choosing a register for such a purpose we are restricted by the
6351relevant (E)ABI specifications for the current architecture, and by
6352GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006353
wdenk6c59edc2004-05-03 20:45:30 +00006354For PowerPC, the following registers have specific use:
6355 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006356 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006357 R3-R4: parameter passing and return values
6358 R5-R10: parameter passing
6359 R13: small data area pointer
6360 R30: GOT pointer
6361 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006362
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006363 (U-Boot also uses R12 as internal GOT pointer. r12
6364 is a volatile register so r12 needs to be reset when
6365 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006366
Wolfgang Denk69c09642008-02-14 22:43:22 +01006367 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006368
wdenk6c59edc2004-05-03 20:45:30 +00006369 Note: on PPC, we could use a static initializer (since the
6370 address of the global data structure is known at compile time),
6371 but it turned out that reserving a register results in somewhat
6372 smaller code - although the code savings are not that big (on
6373 average for all boards 752 bytes for the whole U-Boot image,
6374 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006375
Robin Getz2773d5f2009-08-17 15:23:02 +00006376On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006377 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6378
Robin Getz2773d5f2009-08-17 15:23:02 +00006379 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006380
wdenk6c59edc2004-05-03 20:45:30 +00006381On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006382
wdenk6c59edc2004-05-03 20:45:30 +00006383 R0: function argument word/integer result
6384 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006385 R9: platform specific
6386 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006387 R11: argument (frame) pointer
6388 R12: temporary workspace
6389 R13: stack pointer
6390 R14: link register
6391 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006392
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006393 ==> U-Boot will use R9 to hold a pointer to the global data
6394
6395 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006396
Thomas Chou8fa38582010-05-21 11:08:03 +08006397On Nios II, the ABI is documented here:
6398 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6399
6400 ==> U-Boot will use gp to hold a pointer to the global data
6401
6402 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6403 to access small data sections, so gp is free.
6404
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006405On NDS32, the following registers are used:
6406
6407 R0-R1: argument/return
6408 R2-R5: argument
6409 R15: temporary register for assembler
6410 R16: trampoline register
6411 R28: frame pointer (FP)
6412 R29: global pointer (GP)
6413 R30: link register (LP)
6414 R31: stack pointer (SP)
6415 PC: program counter (PC)
6416
6417 ==> U-Boot will use R10 to hold a pointer to the global data
6418
Wolfgang Denk6405a152006-03-31 18:32:53 +02006419NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6420or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006421
wdenk6c59edc2004-05-03 20:45:30 +00006422Memory Management:
6423------------------
wdenkc6097192002-11-03 00:24:07 +00006424
wdenk6c59edc2004-05-03 20:45:30 +00006425U-Boot runs in system state and uses physical addresses, i.e. the
6426MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006427
wdenk6c59edc2004-05-03 20:45:30 +00006428The available memory is mapped to fixed addresses using the memory
6429controller. In this process, a contiguous block is formed for each
6430memory type (Flash, SDRAM, SRAM), even when it consists of several
6431physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk6c59edc2004-05-03 20:45:30 +00006433U-Boot is installed in the first 128 kB of the first Flash bank (on
6434TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6435booting and sizing and initializing DRAM, the code relocates itself
6436to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006437memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006438configuration setting]. Below that, a structure with global Board
6439Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk6c59edc2004-05-03 20:45:30 +00006441Additionally, some exception handler code is copied to the low 8 kB
6442of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006443
wdenk6c59edc2004-05-03 20:45:30 +00006444So a typical memory configuration with 16 MB of DRAM could look like
6445this:
wdenkc6097192002-11-03 00:24:07 +00006446
wdenk6c59edc2004-05-03 20:45:30 +00006447 0x0000 0000 Exception Vector code
6448 :
6449 0x0000 1FFF
6450 0x0000 2000 Free for Application Use
6451 :
6452 :
wdenkc6097192002-11-03 00:24:07 +00006453
wdenk6c59edc2004-05-03 20:45:30 +00006454 :
6455 :
6456 0x00FB FF20 Monitor Stack (Growing downward)
6457 0x00FB FFAC Board Info Data and permanent copy of global data
6458 0x00FC 0000 Malloc Arena
6459 :
6460 0x00FD FFFF
6461 0x00FE 0000 RAM Copy of Monitor Code
6462 ... eventually: LCD or video framebuffer
6463 ... eventually: pRAM (Protected RAM - unchanged by reset)
6464 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006465
wdenkc6097192002-11-03 00:24:07 +00006466
wdenk6c59edc2004-05-03 20:45:30 +00006467System Initialization:
6468----------------------
wdenkc6097192002-11-03 00:24:07 +00006469
wdenk6c59edc2004-05-03 20:45:30 +00006470In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006471(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006472configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006473To be able to re-map memory U-Boot then jumps to its link address.
6474To be able to implement the initialization code in C, a (small!)
6475initial stack is set up in the internal Dual Ported RAM (in case CPUs
6476which provide such a feature like MPC8xx or MPC8260), or in a locked
6477part of the data cache. After that, U-Boot initializes the CPU core,
6478the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006479
wdenk6c59edc2004-05-03 20:45:30 +00006480Next, all (potentially) available memory banks are mapped using a
6481preliminary mapping. For example, we put them on 512 MB boundaries
6482(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6483on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6484programmed for SDRAM access. Using the temporary configuration, a
6485simple memory test is run that determines the size of the SDRAM
6486banks.
wdenkc6097192002-11-03 00:24:07 +00006487
wdenk6c59edc2004-05-03 20:45:30 +00006488When there is more than one SDRAM bank, and the banks are of
6489different size, the largest is mapped first. For equal size, the first
6490bank (CS2#) is mapped first. The first mapping is always for address
64910x00000000, with any additional banks following immediately to create
6492contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006493
wdenk6c59edc2004-05-03 20:45:30 +00006494Then, the monitor installs itself at the upper end of the SDRAM area
6495and allocates memory for use by malloc() and for the global Board
6496Info data; also, the exception vector code is copied to the low RAM
6497pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006498
wdenk6c59edc2004-05-03 20:45:30 +00006499Only after this relocation will you have a "normal" C environment;
6500until that you are restricted in several ways, mostly because you are
6501running from ROM, and because the code will have to be relocated to a
6502new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006503
wdenkc6097192002-11-03 00:24:07 +00006504
wdenk6c59edc2004-05-03 20:45:30 +00006505U-Boot Porting Guide:
6506----------------------
wdenkc6097192002-11-03 00:24:07 +00006507
wdenk6c59edc2004-05-03 20:45:30 +00006508[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6509list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006510
wdenkc6097192002-11-03 00:24:07 +00006511
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006512int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006513{
6514 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006515
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006516 signal(SIGALRM, no_more_time);
6517 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006518
wdenk6c59edc2004-05-03 20:45:30 +00006519 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006520 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006521 return 0;
6522 }
wdenkc6097192002-11-03 00:24:07 +00006523
wdenk6c59edc2004-05-03 20:45:30 +00006524 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006525
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006526 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006527
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006528 if (clueless)
6529 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006530
wdenk6c59edc2004-05-03 20:45:30 +00006531 while (learning) {
6532 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006533 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6534 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006535 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006536 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006537 }
wdenkc6097192002-11-03 00:24:07 +00006538
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006539 if (available_money > toLocalCurrency ($2500))
6540 Buy a BDI3000;
6541 else
wdenk6c59edc2004-05-03 20:45:30 +00006542 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006543
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006544 if (a similar board exists) { /* hopefully... */
6545 cp -a board/<similar> board/<myboard>
6546 cp include/configs/<similar>.h include/configs/<myboard>.h
6547 } else {
6548 Create your own board support subdirectory;
6549 Create your own board include/configs/<myboard>.h file;
6550 }
6551 Edit new board/<myboard> files
6552 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006553
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006554 while (!accepted) {
6555 while (!running) {
6556 do {
6557 Add / modify source code;
6558 } until (compiles);
6559 Debug;
6560 if (clueless)
6561 email("Hi, I am having problems...");
6562 }
6563 Send patch file to the U-Boot email list;
6564 if (reasonable critiques)
6565 Incorporate improvements from email list code review;
6566 else
6567 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006568 }
wdenkc6097192002-11-03 00:24:07 +00006569
wdenk6c59edc2004-05-03 20:45:30 +00006570 return 0;
6571}
wdenkc6097192002-11-03 00:24:07 +00006572
wdenk6c59edc2004-05-03 20:45:30 +00006573void no_more_time (int sig)
6574{
6575 hire_a_guru();
6576}
wdenkc6097192002-11-03 00:24:07 +00006577
wdenkc6097192002-11-03 00:24:07 +00006578
wdenk6c59edc2004-05-03 20:45:30 +00006579Coding Standards:
6580-----------------
wdenkc6097192002-11-03 00:24:07 +00006581
wdenk6c59edc2004-05-03 20:45:30 +00006582All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006583coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006584"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006585
6586Source files originating from a different project (for example the
6587MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006588reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006589sources.
wdenkc6097192002-11-03 00:24:07 +00006590
Detlev Zundelaa63d482006-09-01 15:39:02 +02006591Please note that U-Boot is implemented in C (and to some small parts in
6592Assembler); no C++ is used, so please do not use C++ style comments (//)
6593in your code.
wdenkad276f22004-01-04 16:28:35 +00006594
wdenk6c59edc2004-05-03 20:45:30 +00006595Please also stick to the following formatting rules:
6596- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006597- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006598- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006599- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006600- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006601
wdenk6c59edc2004-05-03 20:45:30 +00006602Submissions which do not conform to the standards may be returned
6603with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006604
wdenkc6097192002-11-03 00:24:07 +00006605
wdenk6c59edc2004-05-03 20:45:30 +00006606Submitting Patches:
6607-------------------
wdenkc6097192002-11-03 00:24:07 +00006608
wdenk6c59edc2004-05-03 20:45:30 +00006609Since the number of patches for U-Boot is growing, we need to
6610establish some rules. Submissions which do not conform to these rules
6611may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006612
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006613Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006614
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006615Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6616see http://lists.denx.de/mailman/listinfo/u-boot
6617
wdenk6c59edc2004-05-03 20:45:30 +00006618When you send a patch, please include the following information with
6619it:
wdenkc6097192002-11-03 00:24:07 +00006620
wdenk6c59edc2004-05-03 20:45:30 +00006621* For bug fixes: a description of the bug and how your patch fixes
6622 this bug. Please try to include a way of demonstrating that the
6623 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006624
wdenk6c59edc2004-05-03 20:45:30 +00006625* For new features: a description of the feature and your
6626 implementation.
wdenkc6097192002-11-03 00:24:07 +00006627
wdenk6c59edc2004-05-03 20:45:30 +00006628* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006629
wdenk6c59edc2004-05-03 20:45:30 +00006630* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006631
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006632* When you add support for a new board, don't forget to add a
6633 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006634
wdenk6c59edc2004-05-03 20:45:30 +00006635* If your patch adds new configuration options, don't forget to
6636 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006637
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006638* The patch itself. If you are using git (which is *strongly*
6639 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006640 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006641 the U-Boot mailing list, you will avoid most of the common problems
6642 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006643
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006644 If you cannot use git, use "diff -purN OLD NEW". If your version of
6645 diff does not support these options, then get the latest version of
6646 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006647
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006648 The current directory when running this command shall be the parent
6649 directory of the U-Boot source tree (i. e. please make sure that
6650 your patch includes sufficient directory information for the
6651 affected files).
6652
6653 We prefer patches as plain text. MIME attachments are discouraged,
6654 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006655
wdenk6c59edc2004-05-03 20:45:30 +00006656* If one logical set of modifications affects or creates several
6657 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006658
wdenk6c59edc2004-05-03 20:45:30 +00006659* Changesets that contain different, unrelated modifications shall be
6660 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006661
wdenkc6097192002-11-03 00:24:07 +00006662
wdenk6c59edc2004-05-03 20:45:30 +00006663Notes:
wdenkc6097192002-11-03 00:24:07 +00006664
wdenk6c59edc2004-05-03 20:45:30 +00006665* Before sending the patch, run the MAKEALL script on your patched
6666 source tree and make sure that no errors or warnings are reported
6667 for any of the boards.
6668
6669* Keep your modifications to the necessary minimum: A patch
6670 containing several unrelated changes or arbitrary reformats will be
6671 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006672
wdenk6c59edc2004-05-03 20:45:30 +00006673* If you modify existing code, make sure that your new code does not
6674 add to the memory footprint of the code ;-) Small is beautiful!
6675 When adding new features, these should compile conditionally only
6676 (using #ifdef), and the resulting code with the new feature
6677 disabled must not need more memory than the old code without your
6678 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006679
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006680* Remember that there is a size limit of 100 kB per message on the
6681 u-boot mailing list. Bigger patches will be moderated. If they are
6682 reasonable and not too big, they will be acknowledged. But patches
6683 bigger than the size limit should be avoided.